FANDOM


(rm redundant sortkey(s), deploy {{For}})
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
<noinclude>{{Wikipedia}}
  +
  +
</noinclude>{{documentation subpage}}
 
{{Navbox suite}}
 
{{Navbox suite}}
This template allows a [[Wikipedia:Navigation templates|navigational template]] to be set up relatively quickly by supplying it one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.
+
This template allows a [[Wikipedia:Navigation templates|navigational template]] to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.
   
 
== Usage ==
 
== Usage ==
 
 
Please remove the parameters that are left blank.
 
Please remove the parameters that are left blank.
   
 
<pre style="overflow:auto;">{{Navbox
 
<pre style="overflow:auto;">{{Navbox
|bodyclass =
 
 
|name = {{subst:PAGENAME}}
 
|name = {{subst:PAGENAME}}
 
|title =
 
|title =
|titleclass =
 
 
|image =
 
|image =
 
|above =
 
|above =
  +
|state =
  +
|listclass = hlist
   
 
|group1 =
 
|group1 =
Line 25: Line 24:
   
 
|below =
 
|below =
}}</pre>
+
}}
  +
</pre>
   
 
== Parameter list ==
 
== Parameter list ==
Line 48: Line 47:
 
Notice "group1" (etc.) is optional, as are sections named "above/below".
 
Notice "group1" (etc.) is optional, as are sections named "above/below".
 
{{-}}
 
{{-}}
The basic and most common parameters are as follows (see below for the full list):
+
The basic and most common parameters are as follows (see [[#Parameter descriptions|below]] for the full list):
   
:<code>bodyclass -</code> applies an HTML <code>class</code> attribute to the entire navbox.
+
:<code>name - </code>the name of the template.
:<code>name -</code> the name of the template.
+
:<code>title - </code>text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
:<code>title -</code> text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
+
:<code>state - </code>controls when a navbox is expanded or collapsed.
:<code>titleclass -</code> applies an HTML <code>class</code> attribute to the title bar.
 
:<code>state - autocollapse, uncollapsed, collapsed</code>: the status of box expansion, where "autocollapse" hides stacked navboxes automatically.
 
   
  +
:<code>listclass - </code>a CSS class for the list cells, usually <tt>hlist</tt> for horizontal lists.
 
:<code>titlestyle - </code>a CSS style for the title-bar, such as: <code>background:gray;</code>
 
:<code>titlestyle - </code>a CSS style for the title-bar, such as: <code>background:gray;</code>
 
:<code>groupstyle - </code>a CSS style for the group-cells, such as: <code>background:#eee;</code>
 
:<code>groupstyle - </code>a CSS style for the group-cells, such as: <code>background:#eee;</code>
   
:<code>image - </code>an optional right-side image, coded as the whole image. Typically it is [[WP:ALT#Purely decorative images|purely decorative]], so it should be coded as <code><nowiki>[[Image:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>.
+
:<code>image - </code>an optional right-side image, coded as the whole image. Typically it is [[WP:ALT#Purely decorative images|purely decorative]], so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>.
 
:<code>imageleft - </code>an optional left-side image (code the same as the "image" parameter).
 
:<code>imageleft - </code>an optional left-side image (code the same as the "image" parameter).
   
Line 63: Line 63:
   
 
:<code>group<sub>n</sub> - </code>the left-side text before list-n (if group-n omitted, list-n starts at left of box).
 
:<code>group<sub>n</sub> - </code>the left-side text before list-n (if group-n omitted, list-n starts at left of box).
:<code>list<sub>n</sub> - </code>text listing wikilinks, often separated by middot templates, such as: [<font/>[A]]<code>{<font/>{·}}</code> [<font/>[B]]
+
:<code>list<sub>n</sub> - </code>text listing wikilinks using a wikilist format.
 
:<code>below - </code>optional text to appear below the group/list section.
 
:<code>below - </code>optional text to appear below the group/list section.
 
Further details, and complex restrictions, are explained below under section ''[[#Parameter descriptions|Parameter descriptions]]''. See some alternate navbox formats under: [[#Layout of table|''Layout of table'']].
 
   
 
== Parameter descriptions ==
 
== Parameter descriptions ==
 
The following is a complete list of parameters for using {{tl|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>, though [[Template:Navbox/doc#Child navboxes|child navboxes]] do not even require those to be set.
 
The following is a complete list of parameters for using {{tl|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>, though [[Template:Navbox/doc#Child navboxes|child navboxes]] do not even require those to be set.
   
{{tl|Navbox}} shares numerous common parameter names as its sister templates {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}} for consistency and ease of use. Parameters marked with an asterisk <nowiki>*</nowiki> are common to all three master templates.
+
{{tl|Navbox}} shares numerous common parameter names with its sister templates, {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}}, for consistency and ease of use. Parameters marked with an asterisk <nowiki>(*)</nowiki> are common to all three master templates.
   
 
=== Setup parameters ===
 
=== Setup parameters ===
Line 93: Line 91:
 
:*The <nowiki><includeonly>|</nowiki> will make the template expanded when viewing the template page by itself.
 
:*The <nowiki><includeonly>|</nowiki> will make the template expanded when viewing the template page by itself.
   
::*Example: {{tl|peso}} with autocollapse as the default initial state. [[Bolivian peso]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has two navboxes. So the peso navbox collapses.
+
::*Example: {{tl|peso}} with autocollapse as the default initial state. [[Catalan peseta]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has two navboxes. So the peso navbox collapses.
 
::*Example: {{tl|Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.
 
::*Example: {{tl|Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.
   
 
:; ''navbar''<nowiki>*</nowiki>
 
:; ''navbar''<nowiki>*</nowiki>
:: Defaults to <code>Tnavbar</code>. If set to <code>plain</code>, the <small>v • d • e</small> links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the <small>v • d • e</small> links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). Note that it is highly recommended that one does not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.
+
:: If set to <code>plain</code>, the <span style="font-size:88%;">v • d • e</span> links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the <span style="font-size:88%;">v • d • e</span> links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.
   
 
:; ''border''<nowiki>*</nowiki>
 
:; ''border''<nowiki>*</nowiki>
Line 117: Line 115:
 
:; ''image''<nowiki>*</nowiki>
 
:; ''image''<nowiki>*</nowiki>
 
:: An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the ''list1'' parameter must be specified. The ''image'' parameter accepts standard wikicode for displaying an image, ''e.g.'':
 
:: An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the ''list1'' parameter must be specified. The ''image'' parameter accepts standard wikicode for displaying an image, ''e.g.'':
::: <code><nowiki>[[Image:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>
+
::: <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>
   
 
:; ''imageleft''<nowiki>*</nowiki>
 
:; ''imageleft''<nowiki>*</nowiki>
Line 126: Line 124:
   
 
:; ''below''<nowiki>*</nowiki>
 
:; ''below''<nowiki>*</nowiki>
:: A full-width cell displayed ''below'' the template's body (groups, lists and image). In a template without an image, ''below'' behaves in the same way as the template's final ''list<sub>n</sub>'' parameter without a ''group<sub>n</sub>'' parameter. For an example of the ''below'' parameter in use, see {{tl|Lists of the provinces and territories of Canada}}.
+
:: A full-width cell displayed ''below'' the template's body (groups, lists and image). In a template without an image, ''below'' behaves in the same way as the template's final ''list<sub>n</sub>'' parameter without a ''group<sub>n</sub>'' parameter. For an example of the ''below'' parameter in use, see {{oldid|Main Page|352612160|this}} version of {{tl|Lists of the provinces and territories of Canada}}.
   
 
=== Style parameters ===
 
=== Style parameters ===
Styles are generally not recommended as to maintain consistency among templates and pages in Wikipedia. However, the option to modify styles is given.
+
Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.
   
 
:; ''style''<nowiki>*</nowiki>
 
:; ''style''<nowiki>*</nowiki>
Line 156: Line 154:
 
:: CSS styles to apply to a specific group, in addition to any styles specified by the ''groupstyle'' parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
 
:: CSS styles to apply to a specific group, in addition to any styles specified by the ''groupstyle'' parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
 
::: <code>group3style = background:red;color:white;</code>
 
::: <code>group3style = background:red;color:white;</code>
  +
  +
:; ''groupwidth''
  +
:: A number and unit specifying a uniform width for the group cells, in cases where little content in the list cells may cause group cells to be too wide. No default. However, may be overridden by the ''group(n)style'' parameter. Examples:
  +
::: <code>groupwidth = 9em</code>
   
 
:; ''liststyle''<nowiki>*</nowiki>
 
:; ''liststyle''<nowiki>*</nowiki>
Line 202: Line 204:
   
 
=== Advanced parameters ===
 
=== Advanced parameters ===
  +
:; ''aboveclass''
  +
:; ''groupclass''
  +
:; ''listclass''
  +
:; ''belowclass''
  +
:: This enables attaching a CSS class to group or list cells. The most common use for ''listclass'' is to give it the <tt>hlist</tt> class that will cause lists to render horizontally. All these parameters accept the <code>hlist</code> class, but if more than one parameter is used for <code>hlist</code>, use {{para|bodyclass|hlist}} instead.
  +
 
:; ''titlegroup''
 
:; ''titlegroup''
:: This puts a group in the title area, with the same default styles as ''group<sub>n</sub>''. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{tl|Navbox}}; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.
+
:: This puts a group in the title area, with the same default styles as ''group<sub>n</sub>''. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{tl|Navbox}}; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.
   
 
:; ''titlegroupstyle''
 
:; ''titlegroupstyle''
Line 209: Line 217:
   
 
:; ''innerstyle''
 
:; ''innerstyle''
:: A very advanced parameter to be used ''only'' for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). The ''style''/''bodystyle'' parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.
+
:: A very advanced parameter to be used ''only'' for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). The ''style''/''bodystyle'' parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.
   
 
====Microformats====
 
====Microformats====
;bodyclass : This parameter is inserted into the "class" attribute for the infobox as a whole.
+
:; ''bodyclass''
;titleclass : This parameter is inserted into the "class" attribute for the infobox's title caption.
+
:: This parameter is inserted into the "class" attribute for the navbox as a whole.
  +
  +
:; ''titleclass''
  +
:: This parameter is inserted into the "class" attribute for the navbox's title caption.
   
 
This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containing [[hCard]] information about a person, for example, add the following parameter:
 
This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containing [[hCard]] information about a person, for example, add the following parameter:
Line 288: Line 296:
   
 
== Examples ==
 
== Examples ==
<!--Please don't encourage folks to use <div>s within Navboxes as (unless handled carefully) they can negate liststyles/groupstyles/etc settings.-->
+
<!--Please do not encourage folks to use <div>s within Navboxes as (unless handled carefully) they can negate liststyles/groupstyles/etc settings.-->
   
 
=== No image ===
 
=== No image ===
Line 295: Line 303:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
  +
| listclass = hlist
  +
 
| group1 = Centre
 
| group1 = Centre
| list1 = [[Cyberjaya]]
+
| list1 =
  +
* [[Cyberjaya]]
   
 
| group2 = Area
 
| group2 = Area
| list2 = [[Klang Valley]]
+
| list2 =
  +
* [[Klang Valley]]
   
 
| group3 = Major landmarks
 
| group3 = Major landmarks
| list3 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}}
+
| list3 =
[[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}}
+
* [[Petronas Twin Towers]]
[[Putrajaya]]{{·}} [[Cyberjaya]]{{·}}
+
* [[Kuala Lumpur Tower]]
[[Kuala Lumpur International Airport]]
+
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
  +
* [[Kuala Lumpur International Airport]]
   
 
| group4 = Infrastructure
 
| group4 = Infrastructure
| list4 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list4 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
   
 
| group5 = Prime applications
 
| group5 = Prime applications
| list5 = [[EGovernment]]{{·}} [[MyKad]]
+
| list5 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
 
}}
 
}}
 
</pre>
 
</pre>
Line 319: Line 329:
 
| state = uncollapsed
 
| state = uncollapsed
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
  +
| listclass = hlist
  +
 
| group1 = Centre
 
| group1 = Centre
| list1 = [[Cyberjaya]]
+
| list1 =
  +
* [[Cyberjaya]]
  +
 
| group2 = Area
 
| group2 = Area
| list2 = [[Klang Valley]]
+
| list2 =
  +
* [[Klang Valley]]
  +
 
| group3 = Major landmarks
 
| group3 = Major landmarks
| list3 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}} [[Putrajaya]]{{·}} [[Cyberjaya]]{{·}} [[Kuala Lumpur International Airport]]
+
| list3 =
  +
* [[Petronas Twin Towers]]
  +
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
  +
* [[Kuala Lumpur International Airport]]
  +
 
| group4 = Infrastructure
 
| group4 = Infrastructure
| list4 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list4 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
  +
 
| group5 = Prime applications
 
| group5 = Prime applications
| list5 = [[EGovernment]]{{·}} [[MyKad]]
+
| list5 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
 
}}
 
}}
   
Line 336: Line 348:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| list1 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}}
+
| listclass = hlist
[[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}}
+
[[Putrajaya]]{{·}} [[Cyberjaya]]{{·}}
+
| list1 =
[[Kuala Lumpur International Airport]]
+
* [[Petronas Twin Towers]]
  +
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
  +
* [[Kuala Lumpur International Airport]]
 
}}
 
}}
 
</pre>
 
</pre>
Line 346: Line 358:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| list1 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}} [[Putrajaya]]{{·}} [[Cyberjaya]]{{·}} [[Kuala Lumpur International Airport]]
+
| listclass = hlist
  +
  +
| list1 =
  +
* [[Petronas Twin Towers]]
  +
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
  +
* [[Kuala Lumpur International Airport]]
 
}}
 
}}
   
Line 355: Line 367:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[Image:Flag of Malaysia.svg|80px]]
+
| imageleft = [[File:Flag of Malaysia.svg|80px]]
| list1 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}}
+
| listclass = hlist
[[Kuala Lumpur Sentral]]
+
| list2 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list1 =
| list3 = [[EGovernment]]{{·}} [[MyKad]]
+
* [[Petronas Twin Towers]]
| list4 = [[Klang Valley]]
+
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
  +
| list2 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
  +
  +
| list3 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
  +
  +
| list4 =
  +
* [[Klang Valley]]
 
}}
 
}}
 
</pre>
 
</pre>
Line 368: Line 380:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[Image:Flag of Malaysia.svg|80px]]
+
| imageleft = [[File:Flag of Malaysia.svg|80px]]
| list1 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}}
+
| listclass = hlist
[[Kuala Lumpur Sentral]]
+
| list2 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list1 =
| list3 = [[EGovernment]]{{·}} [[MyKad]]
+
* [[Petronas Twin Towers]]
| list4 = [[Klang Valley]]
+
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
  +
| list2 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
  +
  +
| list3 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
  +
  +
| list4 =
  +
* [[Klang Valley]]
 
}}
 
}}
   
Line 382: Line 394:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
 
 
| above = Above text goes here
 
| above = Above text goes here
  +
| listclass = hlist
   
 
| group1 = Centre
 
| group1 = Centre
| list1 = [[Cyberjaya]]
+
| list1 =
  +
* [[Cyberjaya]]
   
 
| group2 = Area
 
| group2 = Area
| list2 = [[Klang Valley]]
+
| list2 =
  +
* [[Klang Valley]]
   
 
| group3 = Major landmarks
 
| group3 = Major landmarks
| list3 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}}
+
| list3 =
[[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}}
+
* [[Petronas Twin Towers]]
[[Putrajaya]]{{·}} [[Cyberjaya]]
+
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
   
 
| group4 = Infrastructure
 
| group4 = Infrastructure
| list4 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list4 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
   
 
| group5 = Prime applications
 
| group5 = Prime applications
| list5 = [[EGovernment]]{{·}} [[MyKad]]
+
| list5 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
   
| below = Website: [http://www.msc.com.my/ www.msc.com.my]
+
| below = Website: {{URL|http://www.msc.com.my/}}
 
}}
 
}}
 
</pre>
 
</pre>
Line 409: Line 422:
 
| name = Navbox/doc
 
| name = Navbox/doc
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
 
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[Image:Flag of Malaysia.svg|80px|link=|alt=]]
+
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
 
 
| above = Above text goes here
 
| above = Above text goes here
  +
| listclass = hlist
   
 
| group1 = Centre
 
| group1 = Centre
| list1 = [[Cyberjaya]]
+
| list1 =
  +
* [[Cyberjaya]]
   
 
| group2 = Area
 
| group2 = Area
| list2 = [[Klang Valley]]
+
| list2 =
  +
* [[Klang Valley]]
   
 
| group3 = Major landmarks
 
| group3 = Major landmarks
| list3 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}} [[Putrajaya]]{{·}} [[Cyberjaya]]
+
| list3 =
  +
* [[Petronas Twin Towers]]
  +
* [[Kuala Lumpur Tower]]
  +
* [[Kuala Lumpur Sentral]]
  +
* [[Technology Park Malaysia]]
  +
* [[Putrajaya]]
  +
* [[Cyberjaya]]
   
 
| group4 = Infrastructure
 
| group4 = Infrastructure
| list4 = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
+
| list4 =
  +
* [[Express Rail Link]]
  +
* [[KL-KLIA Dedicated Expressway]]
   
 
| group5 = Prime applications
 
| group5 = Prime applications
| list5 = [[EGovernment]]{{·}} [[MyKad]]
+
| list5 =
  +
* [[EGovernment]]
  +
* [[MyKad]]
   
| below = Website: [http://www.msc.com.my/ www.msc.com.my]
+
| below = Website: {{URL|http://www.msc.com.my/}}
 
}}
 
}}
   
 
== Child navboxes ==
 
== Child navboxes ==
  +
{{Selfref|For additional examples, see the [[Template:Navbox/testcases|Navbox testcases page]].}}
 
It is possible to place multiple navboxes within a single border with the use of the ''border'' parameter, or by specifying the first parameter to be "child". The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
 
It is possible to place multiple navboxes within a single border with the use of the ''border'' parameter, or by specifying the first parameter to be "child". The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
  +
 
<pre style="overflow:auto;">
 
<pre style="overflow:auto;">
 
{{Navbox
 
{{Navbox
Line 448: Line 464:
 
=== Subgroups example ===
 
=== Subgroups example ===
 
{{main|Template:Navbox subgroup}}
 
{{main|Template:Navbox subgroup}}
This example shows how subgroups can be used. It is recommended that one uses {{tl|Navbox subgroup}}, but the same result can be reached by using {{tl|Navbox}} with <code>border = child</code> or the first unnamed parameter set to <code>child</code>. Note that the ''evenodd'' parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. If you wish to remove the striping altogether, you can set <code>liststyle = background:transparent;</code> in each of the navboxes.
+
This example shows how subgroups can be used. It is recommended that one use {{tl|Navbox subgroup}}, but the same result can be reached by using {{tl|Navbox}} with <code>border = child</code> or the first unnamed parameter set to <code>child</code>. The ''evenodd'' parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. To remove the striping altogether, you can set <code>liststyle = background:transparent;</code> in each of the navboxes.
   
 
{{Navbox
 
{{Navbox
 
|name = Navbox/doc
 
|name = Navbox/doc
|image = [[Image:Flag of the United States.svg|100px|link=|alt=]]
+
|image = [[File:Flag of the United States.svg|100px|link=|alt=]]
 
|state = uncollapsed
 
|state = uncollapsed
 
|title = Multiple Subgroup Example
 
|title = Multiple Subgroup Example
Line 490: Line 506:
 
=== Multiple show/hides in a single container ===
 
=== Multiple show/hides in a single container ===
 
{{main|Template:Navbox with collapsible groups}}
 
{{main|Template:Navbox with collapsible groups}}
The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another navbox, with <code>border = child</code> set. Note that each of the child navboxes has its own VDE navbar; these could be hidden using <code>navbar = plain</code> for each of them, or by just leaving out the ''name'' parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).
+
The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another navbox, with <code>1 = child</code> set. The view (v), discuss (d), edit (e) navbar links are hidden using <code>navbar = plain</code> for each of them, or could be suppresed by just leaving out the ''name'' parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).
   
 
{{Navbox
 
{{Navbox
 
|name = Navbox/doc
 
|name = Navbox/doc
|title = [[Image:Blason France moderne.svg|x17px|link=|alt=]] [[Image:Flag of France.svg|x17px|link=|alt=]] [[French colonial empires|Former French overseas empire]]
+
|title = [[File:Blason France moderne.svg|x17px|link=|alt=]] [[File:Flag of France.svg|x17px|link=|alt=]] [[French colonial empire|Former French overseas empire]]
 
|state = uncollapsed
 
|state = uncollapsed
 
|list1 = {{Navbox|child
 
|list1 = {{Navbox|child
|name = Former French colonies in Africa and the Indian Ocean
+
|navbar = plain
|title = [[French colonial empires|Former French colonies]] in [[Africa]] and the [[Indian Ocean]]
+
|title = [[French colonial empire|Former French colonies]] in [[Africa]] and the [[Indian Ocean]]
|groupstyle = background:lavender;
+
|listclass = hlist
   
 
|group1 = [[Mahgreb]]
 
|group1 = [[Mahgreb]]
|list1 = [[French rule in Algeria|Algeria]]{{·}} [[French Morocco|Morocco]]&nbsp;<small>([[Arguin|Arguin Island]])</small>{{·}} [[History of Tunisia|Tunisia]]
+
|list1 =
  +
* [[French rule in Algeria|Algeria]]
  +
* [[French Morocco|Morocco]] <small>([[Arguin|Arguin Island]])</small>
  +
* [[History of Tunisia|Tunisia]]
   
 
|group2 = [[French West Africa]]
 
|group2 = [[French West Africa]]
|list2 = [[History of Côte d'Ivoire#French Period|Côte d'Ivoire]]{{·}} [[French Dahomey|Dahomey]]{{·}} [[French Sudan]]{{·}} [[French Guinea|Guinea]]{{·}} [[History of Mauritania#French colonization and post-colonial history|Mauritania]]{{·}} [[History of Niger#Colonization|Niger]]{{·}} [[History of Senegal|Senegal]]{{·}} [[French Upper Volta|Upper Volta]]
+
|list2 =
  +
* [[History of Côte d'Ivoire#French Period|Côte d'Ivoire]]
  +
* [[French Dahomey|Dahomey]]
  +
* [[French Sudan]]
  +
* [[French Guinea|Guinea]]
  +
* [[History of Mauritania#French colonization and post-colonial history|Mauritania]]
  +
* [[History of Niger#Colonization|Niger]]
  +
* [[History of Senegal|Senegal]]
  +
* [[French Upper Volta|Upper Volta]]
  +
* [[French Togoland]]
  +
* [[James Island (The Gambia)|James Island]]
   
|group3 = &nbsp;
+
|group3 = [[French Equatorial Africa]]
|list3 = [[French Togoland]]{{·}} [[James Island (The Gambia)|James Island]]
+
|list3 =
  +
* [[Colonial Chad|Chad]]
  +
* [[History of Gabon|Gabon]]
  +
* [[History of the Republic of the Congo|Middle Congo]]
  +
* [[Oubangui-Chari]]
   
|group4 = [[French Equatorial Africa]]
+
|group4 = [[Comoros]]
|list4 = [[Colonial Chad|Chad]]{{·}} [[History of Gabon|Gabon]]{{·}} [[History of the Republic of the Congo|Middle Congo]]{{·}} [[Oubangui-Chari]]
+
|list4 =
+
* [[Anjouan]]
|group5 = [[Comoros]]
+
* [[Grande Comore]]
|list5 = [[Anjouan]]{{·}} [[Grande Comore]]{{·}} [[Mohéli]]
+
* [[Mohéli]]
+
* [[History of Djibouti#French Interest|French Somaliland (Djibouti)]]
|group6 = &nbsp;
+
* [[History of Madagascar#French control|Madagascar]]
|list6 = [[History of Djibouti#French Interest|French Somaliland (Djibouti)]]{{·}} [[History of Madagascar#French control|Madagascar]]{{·}} [[Mauritius|Ile de France]]{{·}} [[Seychelles]]
+
* [[Mauritius|Ile de France]]
  +
* [[Seychelles]]
 
}}
 
}}
   
 
|list2 = {{Navbox|child
 
|list2 = {{Navbox|child
|name = Former French colonies in the Americas
+
|navbar = plain
|titlestyle =
+
|title = [[French colonial empire|Former French colonies]] in the [[Americas]]
|title = [[French colonial empires|Former French colonies]] in the [[Americas]]
+
|listclass = hlist
|groupstyle =
+
|list1 = [[New France]]{{spaces|2}}<small>([[Acadia]]&nbsp;• [[Louisiana (New France)|Louisiana]]&nbsp;• [[Canada, New France|Canada]]&nbsp;• [[Newfoundland (island)|Terre&nbsp;Neuve]]) 1655 – 1763 </small>
+
|list1 =
  +
* [[New France]]{{spaces|2}}<small>([[Acadia]], [[Louisiana (New France)|Louisiana]], [[Canada, New France|Canada]], [[Newfoundland (island)|Terre Neuve]]) 1655–1763 </small>
   
|list2 = [[Inini]]{{·}} [[Berbice]]{{·}} [[Saint-Domingue]]&nbsp;<small>([[Haiti]])</small>{{·}} [[Tobago]]{{·}} [[History of the British Virgin Islands|Virgin&nbsp;Islands]]{{·}} {{nowrap|[[France Antarctique]]}}{{·}} {{nowrap|[[France Équinoxiale]]}}
+
|list2 =
  +
* [[Inini]]
  +
* [[Berbice]]
  +
* [[Saint-Domingue]] <small>([[Haiti]])</small>
  +
* [[Tobago]]
  +
* [[History of the British Virgin Islands|Virgin Islands]]
  +
* [[France Antarctique]]
  +
* [[France Équinoxiale]]
   
|belowstyle =
 
 
|below = [[French West India Company]]
 
|below = [[French West India Company]]
 
}}
 
}}
   
 
|list3 = {{Navbox|child
 
|list3 = {{Navbox|child
|name = Former French colonies in Asia and Oceania
+
|navbar = plain
|title = [[French colonial empires|Former French colonies]] in [[Asia]] and [[Oceania]]
+
|title = [[French colonial empire|Former French colonies]] in [[Asia]] and [[Oceania]]
|groupstyle =
+
|listclass = hlist
   
 
|group1 = [[French India]]
 
|group1 = [[French India]]
|list1 = [[Chandernagor]]{{·}} [[Coromandel Coast]]{{·}} [[History of Chennai|Madras]]{{·}} [[Malabar]]{{·}} [[Mahé, India|Mahé]]{{·}} [[History of Puducherry|Pondichéry]]{{·}} [[Karaikal]]{{·}} [[Yanam (India)|Yanaon]]
+
|list1 =
  +
* [[Chandernagor]]
  +
* [[Coromandel Coast]]
  +
* [[History of Chennai|Madras]]
  +
* [[Mahé, India|Mahé]]
  +
* [[History of Pondicherry|Pondichéry]]
  +
* [[Karaikal]]
  +
* [[Yanam (India)|Yanaon]]
   
 
|group2 = [[French Indochina]]
 
|group2 = [[French Indochina]]
|list2 = [[Colonial Cambodia|Cambodia]]{{·}} [[History of Laos to 1945#French Laos|Laos]]{{·}} [[French Indochina|Vietnam]]&nbsp;<small>([[Annam (French colony)|Annam]]&nbsp;• [[Cochinchina]]&nbsp;• [[Tonkin]])</small>
+
|list2 =
  +
* [[Colonial Cambodia|Cambodia]]
  +
* [[History of Laos to 1945#French Laos|Laos]]
  +
* [[French Indochina|Vietnam]] <small>([[Annam (French colony)|Annam]], [[Cochinchina]], [[Tonkin]])</small>
   
 
|group3 = Other Asian
 
|group3 = Other Asian
|list3 = [[Alawite State|Alaouites]]{{·}} [[Republic of Hatay|Alexandretta-Hatay]]{{·}} [[Sri Lanka|Ceylon]]{{·}} [[Kwangchowan]]
+
|list3 =
  +
* [[Alawite State|Alaouites]]
  +
* [[Republic of Hatay|Alexandretta-Hatay]]
  +
* [[Sri Lanka|Ceylon]]
  +
* [[Kwangchowan]]
   
 
|group4 = [[Oceania]]
 
|group4 = [[Oceania]]
|list4 = [[New Hebrides]] [[History of Vanuatu|(Vanuatu)]]
+
|list4 =
  +
* [[New Hebrides]] [[History of Vanuatu|(Vanuatu)]]
   
|belowstyle =
 
 
|below = [[French East India Company]]
 
|below = [[French East India Company]]
 
}}
 
}}
 
}}
 
}}
 
=== Additional examples ===
 
You may find additional examples of complex subgroups and child navboxes at the [[Template:Navbox/doc/Advanced examples|advanced navbox examples page]] and the [[Template:Navbox/testcases|Navbox code test page]].
 
   
 
== Relationship with other Navbox templates ==
 
== Relationship with other Navbox templates ==
This navbox template is specifically designed to work in conjunction two other sister templates: {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with a <sup>'''†'''</sup> in the complete parameter list above). Most importantly, all three of these templates can each be used as children of one another (by using the <code>border = child</code> parameter, or by specifying the first unnamed parameter to be <code>child</code> (i.e. use <code><nowiki>{{Navbox|child</nowiki></code>, <code><nowiki>{{Navbox with columns|child</nowiki></code>, or <code><nowiki>{{Navbox with collapsible groups|child</nowiki></code>). For examples on how this is done, see the page on [[Template:Navbox/doc/Advanced examples|advanced navbox examples]].
+
This navbox template is specifically designed to work in conjunction with two other sister templates: {{tl|Navbox with columns}} and {{tl|Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk <nowiki>(*)</nowiki> in the [[#Parameter descriptions|parameter descriptions]] list above). Most importantly, each template can be used as a child of one another (by using the {{para|border|child}} parameter, or by specifying the first unnamed parameter to be <code>child</code>. For example: <code><nowiki>{{Navbox|child ...}}</nowiki></code>, <code><nowiki>{{Navbox with columns|child ...}}</nowiki></code> or <code><nowiki>{{Navbox with collapsible groups|child ...}}</nowiki></code>.
   
 
== Technical details ==
 
== Technical details ==
 
 
*This template uses CSS classes for most of its looks, thus it is fully skinnable.
 
*This template uses CSS classes for most of its looks, thus it is fully skinnable.
 
*Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.
 
*Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and special characters in parameters.
Line 568: Line 578:
   
 
=== Intricacies ===
 
=== Intricacies ===
 
 
*The 2px wide border between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for example <code>bodystyle = background:purple;</code>), then you'll need to make the border-left-color match the background color (i.e. <code>liststyle = border-left-color:purple;</code>). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
 
*The 2px wide border between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for example <code>bodystyle = background:purple;</code>), then you'll need to make the border-left-color match the background color (i.e. <code>liststyle = border-left-color:purple;</code>). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
 
*The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the liststyle to have width:auto. If you wish to set the group width and use images, it's up to you to figure out the CSS in the groupstyle, liststyle, imagestyle, and imageleftstyle parameters to get everything to work correctly. Example of setting group width:
 
*The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the liststyle to have width:auto. If you wish to set the group width and use images, it's up to you to figure out the CSS in the groupstyle, liststyle, imagestyle, and imageleftstyle parameters to get everything to work correctly. Example of setting group width:
Line 578: Line 587:
   
 
=== Copying to other projects or wikis? ===
 
=== Copying to other projects or wikis? ===
  +
Using this template on other wikis requires [[HTML Tidy]] to be turned on. A version that does not require Tidy can be found at [[Wikipedia:WikiProject Transwiki/Template:Navbox]]. (That version generally shouldn't be used here on the English Wikipedia.) More detailed information on copying {{tlf|Navbox}} to other wikis can be found on the [[Template talk:Navbox|talk page]].
   
Note that using this template on other wikis requires [[HTML Tidy]] to be turned on. A version that does not require Tidy can be found at [[Wikipedia:WikiProject Transwiki/Template:Navbox]]. (That version generally shouldn't be used here on the English Wikipedia.) More detailed information on copying {{tlf|Navbox}} to other wikis can be found on the [[Template talk:Navbox|talk page]].
+
===Known issues===
+
#If the heading of the navbox spans more than one line, the second line will be displayed to the right of center. This can be avoided by hard-coding linebreaks with {{tag|br|single|params=clear="all"}}.
===Known bugs===
+
#Excessive use of the '''unsubstituted''' {{tlx|•}} template as a delimiter, can in extreme cases cause the wiki page rendering to fail&nbsp;– there is a limit to the number of templates that can be used on a page (example [[Ketamine]] where the inclusion of eleven Navboxes with hundreds of bullets caused the page load not to complete, only the substitution of the bullets in those navboxes cured the problem). Use of the <code>hlist</code> class avoids the delimiter transclusion issue altogether, as the delimiters are rendered via CSS.
 
If the heading of the navbox spans more than one line, the second line will be displayed to the right of center. This can be avoided by hard-coding linebreaks with {{nowrap|<code><nowiki><br clear=all></nowiki></code>.}}
 
   
 
== See also ==
 
== See also ==
+
* {{tl|Navbar}} – Used for the navigation links in navbox.
* {{tl|Navbox subgroup}}Allows for subgroups within a Navbox.
+
* [[wikipedia:Wikipedia:Line break handling]]The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.
* {{tl|Navbox subgroup long}} &ndash; expanded version of {{tl|Navbox subgroup}} allowing up to 38 subgroups
 
* {{tl|Navbox with columns}} – Allows columns instead of groups/lists.
 
* {{tl|Navbox with collapsible groups}} – Another variation.
 
* {{tl|Navboxes}} – Group several navigation boxes together
 
* [[Wikipedia:Line break handling]] – The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.
 
* {{tl|Nowrap begin}} – The recommended format for adding bullets, pipes, or dashes between list items. The page describes how to go about using them with proper wrapping.
 
* {{tl|Nobold}} – To display text at normal font-weight within a context where the default font-weight is bold, e.g. header cells in tables.
 
* {{tn|·}} and {{tn|•}} – The dot and bullet commonly used to separate items in Navbox lists.
 
* {{tl|Flatlist}} - An accessible and semantically-valid (using an HTML list) method of separating items in Navbox lists.
 
   
 
{{Navigation templates}}
 
{{Navigation templates}}
Line 591: Line 601:
 
<includeonly>
 
<includeonly>
 
<!--Categories-->
 
<!--Categories-->
[[Category:Navbox (navigational) templates| {{PAGENAME}}]]
+
[[Category:Navboxes| ]]
[[Category:Templates generating microformats|{{PAGENAME}}]]
+
[[Category:Templates generating microformats]]
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
+
[[Category:Exclude in print]]
[[Category:Exclude in print|{{PAGENAME}}]]
 
 
</includeonly>
 
</includeonly>

Latest revision as of 15:45, February 15, 2015

Template:Navbox suite

This template allows a navigational template to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.

Usage Edit

Please remove the parameters that are left blank.

{{Navbox
|name       = {{subst:PAGENAME}}
|title      = 
|image      = 
|above      = 
|state      = 
|listclass  = hlist

|group1     = 
|list1      = 

|group2     = 
|list2      = 
 ...
|group20    = 
|list20     = 

|below      = 
}}

Parameter list Edit

The navbox uses lowercase parameter names, as shown in the box (at right). The mandatory name and title will create a one-line box if other parameters are omitted.

Notice "group1" (etc.) is optional, as are sections named "above/below".

The basic and most common parameters are as follows (see below for the full list):

name - the name of the template.
title - text in the title bar, such as: [[Widget stuff]].
state - controls when a navbox is expanded or collapsed.
listclass - a CSS class for the list cells, usually hlist for horizontal lists.
titlestyle - a CSS style for the title-bar, such as: background:gray;
groupstyle - a CSS style for the group-cells, such as: background:#eee;
image - an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as [[File:XX.jpg|80px|link=|alt=]].
imageleft - an optional left-side image (code the same as the "image" parameter).
above - text to appear above the group/list section (could be a list of overall wikilinks).
groupn - the left-side text before list-n (if group-n omitted, list-n starts at left of box).
listn - text listing wikilinks using a wikilist format.
below - optional text to appear below the group/list section.

Parameter descriptions Edit

The following is a complete list of parameters for using {{Navbox}}. In most cases, the only required parameters are name, title, and list1, though child navboxes do not even require those to be set.

{{Navbox}} shares numerous common parameter names with its sister templates, {{Navbox with columns}} and {{Navbox with collapsible groups}}, for consistency and ease of use. Parameters marked with an asterisk (*) are common to all three master templates.

Setup parameters Edit

name*
The name of the template, which is needed for the "v · d · e" ("view · discuss · edit") links to work properly on all pages where the template is used. You can enter {{subst:PAGENAME}} for this value as a shortcut. The name parameter is only mandatory if a title is specified, and the border parameter is not set.
state* [autocollapse, uncollapsed, collapsed, plain, off]
  • Defaults to autocollapse. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see MediaWiki:Common.js.
  • If set to collapsed, the navbox will always start out in a collapsed state.
  • If set to plain, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the v • d • e links).
  • If set to off, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
  • If set to anything other than autocollapse, collapsed, plain, or off (such as "uncollapsed"), the navbox will always start out in an expanded state, but have the "hide" button.
To show the box when standalone (non-included) but then auto-hide contents when in an article, put "uncollapsed" inside <noinclude> tags:
  • state = <noinclude>uncollapsed</noinclude>
  • That setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]" but then auto-collapse the box when stacked inside an article.
Often times, editors will want a default initial state for a navbox, which may be overridden in an article. Here is the trick to do this:
  • In your intermediate template, create a parameter also named "state" as a pass-through like this:
  • | state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}
  • The <includeonly>| will make the template expanded when viewing the template page by itself.
  • Example: {{peso}} with autocollapse as the default initial state. Catalan peseta transcludes it and has only one navbox. So the peso navbox shows. Chilean peso has two navboxes. So the peso navbox collapses.
  • Example: {{Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.
navbar*
If set to plain, the v • d • e links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use off to remove the v • d • e links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.
border*
See section below on using navboxes within one another for examples and a more complete description. If set to child or subgroup, then the navbox can be used as a borderless child that fits snuggly in another navbox. The border is hidden and there is no padding on the sides of the table, so it fits into the list area of its parent navbox. If set to none, then the border is hidden and padding is removed, and the navbox may be used as a child of another container (do not use the none option inside of another navbox; similarly, only use the child/subgroup option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the named border parameter):
{{Navbox|child
...
<code>}}

Cells Edit

title*
Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use {{-}} to ensure proper centering. This parameter is technically not mandatory, but using {{Navbox}} is rather pointless without a title.
groupn*
(i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of listn. If omitted, listn uses the full width of the table.
listn*
(i.e. list1, list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <div> </div>. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter, if provided (see below).
image*
An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the list1 parameter must be specified. The image parameter accepts standard wikicode for displaying an image, e.g.:
[[File:XX.jpg|80px|link=|alt=]]
imageleft*
An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, the list1 parameter must be specified and no groups can be specified. It accepts the same sort of parameter that image accepts.
above*
A full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image). In a template without an image, above behaves in the same way as the list1 parameter without the group1 parameter.
below*
A full-width cell displayed below the template's body (groups, lists and image). In a template without an image, below behaves in the same way as the template's final listn parameter without a groupn parameter. For an example of the below parameter in use, see Template:Oldid version of {{Lists of the provinces and territories of Canada}}.

Style parameters Edit

Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.

style*
Specifies CSS styles to apply to the template body. The parameter bodystyle also does the exact same thing and can be used in place of this style parameter. This option should be used sparingly as it can lead to visual inconsistencies. Examples:
style = background:#nnnnnn;
style = width:N [em/%/px or width:auto];
style = float:[left/right/none];
style = clear:[right/left/both/none];
basestyle*
CSS styles to apply to the title, above, below, and group cells all at once. The styles are not applied to list cells. This is convenient for easily changing the basic color of the navbox without having to repeat the style specifications for the different parts of the navbox. Examples:
basestyle = background:lightskyblue;
titlestyle*
CSS styles to apply to title, most often the titlebar's background color:
titlestyle = background:#nnnnnn;
titlestyle = background:name;
groupstyle*
CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:
groupstyle = background:#nnnnnn;
groupstyle = text-align:[left/center/right];
groupstyle = vertical-align:[top/middle/bottom];
groupnstyle*
CSS styles to apply to a specific group, in addition to any styles specified by the groupstyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
group3style = background:red;color:white;
groupwidth
A number and unit specifying a uniform width for the group cells, in cases where little content in the list cells may cause group cells to be too wide. No default. However, may be overridden by the group(n)style parameter. Examples:
groupwidth = 9em
liststyle*
CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) below. When using backgound colors in the navbox, see the note below.
listnstyle*
CSS styles to apply to a specific list, in addition to any styles specified by the liststyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
list5style = background:#ddddff;
listpadding*
A number and unit specifying the padding in each list cell. The list cells come equipped with a default padding of 0.25em on the left and right, and 0em on the top and bottom. Due to complex technical reasons, simply setting "liststyle=padding:0.5em;" (or any other padding setting) will not work. Examples:
listpadding = 0.5em 0em; (sets 0.5em padding for the left/right, and 0em padding for the top/bottom.)
listpadding = 0em; (removes all list padding.)
oddstyle
evenstyle
Applies to odd/even list numbers. Overrules styles defined by liststyle. The default behavior is to add striped colors (white and gray) to odd/even rows, respectively, in order to improve readability. These should not be changed except in extraordinary circumstances.
evenodd [swap, even, odd, off]
If set to swap, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to even or odd sets all rows to have that striping color. Setting to off disables automatic row striping. This advanced parameter should only be used to fix problems when the navbox is being used as a child of another navbox and the stripes do not match up. Examples and a further description can be found in the section on child navboxes below.
abovestyle*
belowstyle*
CSS styles to apply to the top cell (specified via the above parameter) and bottom cell (specified via the below parameter). Typically used to set background color or text alignment:
abovestyle = background:#nnnnnn;
abovestyle = text-align:[left/center/right];
imagestyle*
imageleftstyle*
CSS styles to apply to the cells where the image/imageleft sits. These styles should only be used in exceptional circumstances, usually to fix width problems if the width of groups is set and the width of the image cell grows too large. Examples:
imagestyle = width:5em;
Default styles Edit

The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple. Most styles are set in MediaWiki:Common.css.

bodystyle = background:#fdfdfd; width:100%; vertical-align:middle;
titlestyle = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;
abovestyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
belowstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
groupstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
liststyle = background:transparent; text-align:left/center;
oddstyle = background:transparent;
evenstyle = background:#f7f7f7;

Since liststyle and oddstyle are transparent, odd lists have the color of the bodystyle, which defaults to #fdfdfd (white with a hint of gray). A list defaults to text-align:left; if it has a group, if not it defaults to text-align:center;. Since only bodystyle has a vertical-align all the others inherit its vertical-align:middle;.

Advanced parameters Edit

aboveclass
groupclass
listclass
belowclass
This enables attaching a CSS class to group or list cells. The most common use for listclass is to give it the hlist class that will cause lists to render horizontally. All these parameters accept the hlist class, but if more than one parameter is used for hlist, use |bodyclass=hlist instead.
titlegroup
This puts a group in the title area, with the same default styles as groupn. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{Navbox}}; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.
titlegroupstyle
The styles for the titlegroup cell.
innerstyle
A very advanced parameter to be used only for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). The style/bodystyle parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.

MicroformatsEdit

bodyclass
This parameter is inserted into the "class" attribute for the navbox as a whole.
titleclass
This parameter is inserted into the "class" attribute for the navbox's title caption.

This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containing hCard information about a person, for example, add the following parameter:

|bodyclass = vcard

and

|titleclass = fn

or (for example):

|title = The books of <span class="fn">[[Iain Banks]]</span>

...and so forth.

See Wikipedia:WikiProject Microformats for more information on adding microformat information to Wikipedia, and microformat for more information on microformats in general.

Layout of table Edit

Table generated by {{Navbox}} without image, above and below parameters (gray list background color added for illustration only):


Table generated by {{Navbox}} with image, above and below parameters (gray list background color added for illustration only):


Table generated by {{Navbox}} with image, imageleft, lists, and without groups, above, below (gray list background color added for illustration only):

Examples Edit

No image Edit

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist

| group1 = Centre
| list1  = 
* [[Cyberjaya]]

| group2 = Area
| list2  = 
* [[Klang Valley]]

| group3 = Major landmarks
| list3  = 
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]

| group4 = Infrastructure
| list4  = 
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Prime applications
| list5  = 
* [[EGovernment]]
* [[MyKad]]
}}

With image, without groups Edit

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| listclass = hlist

| list1 = 
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]
}}

With two images, without groups, multiple lists Edit

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[File:Flag of Malaysia.svg|80px]]
| listclass = hlist

| list1 = 
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]

| list2 = 
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| list3 = 
* [[EGovernment]]
* [[MyKad]]

| list4 = 
* [[Klang Valley]]
}}

With image, groups, above, below Edit

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| above = Above text goes here
| listclass = hlist

| group1 = Centre
| list1  = 
* [[Cyberjaya]]

| group2 = Area
| list2  = 
* [[Klang Valley]]

| group3 = Major landmarks
| list3  = 
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]

| group4 = Infrastructure
| list4  = 
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Prime applications
| list5  = 
* [[EGovernment]]
* [[MyKad]]

| below  = Website: {{URL|http://www.msc.com.my/}}
}}

Child navboxes Edit

Template:Selfref It is possible to place multiple navboxes within a single border with the use of the border parameter, or by specifying the first parameter to be "child". The basic code for doing this is as follows (which adds a subgroup for the first group/list area):

{{Navbox
|name = {{subst:PAGENAME}}
|title = Title

|group1 = [optional]
|list1 = {{Navbox|child
   ...child navbox parameters...
 }}

...
}}

Subgroups example Edit

This example shows how subgroups can be used. It is recommended that one use {{Navbox subgroup}}, but the same result can be reached by using {{Navbox}} with border = child or the first unnamed parameter set to child. The evenodd parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. To remove the striping altogether, you can set liststyle = background:transparent; in each of the navboxes.

Multiple show/hides in a single container Edit

The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another navbox, with 1 = child set. The view (v), discuss (d), edit (e) navbar links are hidden using navbar = plain for each of them, or could be suppresed by just leaving out the name parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).

Relationship with other Navbox templates Edit

This navbox template is specifically designed to work in conjunction with two other sister templates: {{Navbox with columns}} and {{Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in the parameter descriptions list above). Most importantly, each template can be used as a child of one another (by using the |border=child parameter, or by specifying the first unnamed parameter to be child. For example: {{Navbox|child ...}}, {{Navbox with columns|child ...}} or {{Navbox with collapsible groups|child ...}}.

Technical details Edit

  • This template uses CSS classes for most of its looks, thus it is fully skinnable.
  • Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.
  • For more technical details see the talk page, the CSS classes in MediaWiki:common.css and the collapsible table used to hide the box in MediaWiki:common.js.

Intricacies Edit

  • The 2px wide border between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for example bodystyle = background:purple;), then you'll need to make the border-left-color match the background color (i.e. liststyle = border-left-color:purple;). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
  • The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the liststyle to have width:auto. If you wish to set the group width and use images, it's up to you to figure out the CSS in the groupstyle, liststyle, imagestyle, and imageleftstyle parameters to get everything to work correctly. Example of setting group width:
groupstyle = width:10em;
liststyle = width:auto;
  • Adjacent navboxes have only a 1 pixel border between them (except in IE6, which doesn't support the necessary CSS). If you set the top or bottom margin of style/bodystyle, then this will not work.
  • The default margin-left and margin-right of the outer navbox table are set to "auto;". If you wish to use navbox as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option. For example, add the following code to use the navbox as a float:
style = width:22em;float:right;margin-left:1em;margin-right:0em;

Copying to other projects or wikis? Edit

Using this template on other wikis requires HTML Tidy to be turned on. A version that does not require Tidy can be found at Wikipedia:WikiProject Transwiki/Template:Navbox. (That version generally shouldn't be used here on the English Wikipedia.) More detailed information on copying {{Navbox}} to other wikis can be found on the talk page.

Known issuesEdit

  1. If the heading of the navbox spans more than one line, the second line will be displayed to the right of center. This can be avoided by hard-coding linebreaks with <br clear="all" />.
  2. Excessive use of the unsubstituted {{}} template as a delimiter, can in extreme cases cause the wiki page rendering to fail – there is a limit to the number of templates that can be used on a page (example Ketamine where the inclusion of eleven Navboxes with hundreds of bullets caused the page load not to complete, only the substitution of the bullets in those navboxes cured the problem). Use of the hlist class avoids the delimiter transclusion issue altogether, as the delimiters are rendered via CSS.

See also Edit

  • {{Navbar}} – Used for the navigation links in navbox.
  • wikipedia:Wikipedia:Line break handling – The how-to guide about how to handle word wraps (line breaks) on Wikipedia, such as the wrapping of the link lists used in navboxes.

Template:Navigation templates


*Disclosure: Some of the links above are affiliate links, meaning, at no additional cost to you, Fandom will earn a commission if you click through and make a purchase. Community content is available under CC-BY-SA unless otherwise noted.