Template:Navbox/doc: Difference between revisions

From 2d4chan
Jump to navigation Jump to search
← Older edit
VisualWikitext
imported>Administrator
m 1 revision imported
m 1 revision imported
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{documentation subpage}}
'''{{tl|Navbox}}''' allows a {{W|Navigation templates|navigational template}} to be set up relatively quickly by supplying it with one or more lists of links. Using this template or {{tl|Navbox with collapsible groups}} is highly recommended for standardization of navigational templates, and for ease of use.
<includeonly>{{high-risk|1,700,000+}}</includeonly>
 
{{Navbox suite}}
 
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 ==
Line 10: Line 5:
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
| name      = {{subst:PAGENAME}}
| name      = {{subst:PAGENAME}}
| listclass  = hlist
| title      =  
| state     = {{{state|}}}
| image     =  
| above      =


| title      =
| group1  =  
| above      =
| list1  =  
| image      =


| group1    =
...
| list1      =


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


| below     =
| below =  
}}
}}
</pre>
</pre>
Line 37: Line 29:
| name  = Navbox/doc
| name  = Navbox/doc
| state  = uncollapsed
| state  = uncollapsed
| image  = {{{image}}}
| title  = {{{title}}}
| title  = {{{title}}}
| above  = {{{above}}}
| above  = {{{above}}}
| image  = {{{image}}}
 
| group1 = {{{group1}}}
| group1 = {{{group1}}}
| list1  = {{{list1}}}
| list1  = {{{list1}}}
| group2 = {{{group2}}}
| group2 = {{{group2}}}
| list2  = {{{list2}}}
| list2  = {{{list2}}}
| list3  = {{{list3}}} ''without {{{group3}}}''
| list3  = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| group4 = {{{group4}}}
| list4  = {{{list4}}}
| list4  = {{{list4}}}
| below  = {{{below}}} <br /> See alternate navbox formats under: [[#Layout of table|''Layout of table'']]
 
| below  = {{{below}}}<br/>See alternate navbox formats under: [[#Layout of table|''Layout of table'']]
}}
}}


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.
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".
Notice "group1" (etc.) is optional, as are sections named "above/below".
{{clear}}
The basic and most common parameters are as follows (see [[#Parameter descriptions|below]] for the full list):


: <code>name – </code>the name of the template.
The basic and most common parameters are as follows (see below for the full list):
: <code>title – </code>text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
: <code>listclass – </code>a CSS class for the list cells, usually <code>hlist</code> for horizontal lists. Alternatively, use bodyclass for the whole box.
: <code>state – </code>controls when a navbox is expanded or collapsed.


: <code>titlestyle – </code>a CSS style for the title-bar, such as: <code>background: gray;</code>
:<code>name -</code> the name of the template.
: <code>groupstyle – </code>a CSS style for the group-cells, such as: <code>background: #eee;</code>
:<code>title -</code> text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
:<code>state - off, uncollapsed (default), collapsed</code>: the status of box expansion, where "off" hides collapser completely.


: <code>above – </code>text to appear above the group/list section (could be a list of overall wikilinks).
:<code>groupBackground - </code>a CSS color for the group-cells, such as: <code>#eee;</code>


: <code>image – </code>an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>.
:<code>image - </code>an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>.
: <code>imageleft – </code>an optional left-side image (code the same as the "image" parameter).


: <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>above - </code>text to appear above the group/list section (could be a list of overall wikilinks).
: <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>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>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 section [[#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 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 (*) are common to all three master templates.
{{tl|Navbox}} shares numerous common parameter names as its sister template {{tl|Navbox with collapsible groups}} for consistency and ease of use. Parameters marked with an asterisk <nowiki>*</nowiki> are common to all templates.


=== Setup parameters ===
=== Setup parameters ===


:; ''name''*
; ''name''<nowiki>*</nowiki>
:: The name of the template, which is needed for the "V&nbsp;• T&nbsp;• E" ("View&nbsp;• Talk&nbsp;• Edit") links to work properly on all pages where the template is used. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut. The name parameter is only mandatory if a <code>title</code> is specified, and the <code>border</code> parameter is not set.
: The name of the template, which is needed for the view, discuss, and edit icon links to work properly on all pages where the template is used. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut. The name parameter is only mandatory if a <code>title</code> is specified and the <code>border</code> parameter is not set.


:; ''state''* <span style="font-weight:normal;">[<code>autocollapse, uncollapsed, collapsed, plain, off</code>]</span>
; ''state''<nowiki>*</nowiki> <span style="font-weight:normal;">[<code>uncollapsed, collapsed, off</code>]</span>
:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> 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]].
:* Defaults to <code>uncollapsed</code>.
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>plain</code>, 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 <small>V&nbsp;• T&nbsp;• E</small> links).
:* If set to <code>off</code>, the navbox will always be expanded with no [hide] link on the right.
:* If set to <code>off</code>, 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 <code>collapsed</code>, or <code>off</code> (such as <code>uncollapsed</code>), the navbox will always start out in an expanded state, but have the "hide" button.
:* If set to anything other than <code>autocollapse</code>, <code>collapsed</code>, <code>plain</code>, or <code>off</code> (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 &lt;noinclude> tags:
:* <code>state = </code><nowiki><noinclude>uncollapsed</noinclude></nowiki>
:* 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:
:* <code><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></code>
:* 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. [[Catalan peseta]] transcludes it and has only one navbox. So the peso navbox shows. [[Chilean peso]] has two navboxes. So the peso navbox collapses.
: To define a default initial state for a navbox that can be overridden in an article:
::* 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.


:* The template {{tl|Collapsible option}} can be added to a <nowiki><noinclude></nowiki> section after the template definition to explain how to use the <code>state</code> parameter.
:* In your intermediate template, create a parameter also named "state" as a pass-through:
 
:: <tt><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></tt>
:; ''navbar''*
:* The <nowiki><includeonly>|</nowiki> will expand the template when viewing the template page by itself.
:: If set to <code>plain</code>, the <span style="font-size: 88%;">V&nbsp;• T&nbsp;• 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&nbsp;• T&nbsp;• 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''*
:: ''See section hereafter on using navboxes within one another for examples and a more complete description.'' If set to <code>child</code> or <code>subgroup</code>, then the navbox can be used as a borderless child that fits snugly 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 <code>none</code>, 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 <code>none</code> option inside of another navbox; similarly, only use the <code>child</code>/<code>subgroup</code> 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):
::: <code><nowiki>{{Navbox|child</nowiki></code>
:::: <code>...
::: <code><nowiki>}}</nowiki></code>


: Example: {{tl|Absalom navbox}} with autocollapse as the default initial state. [[The Docks]] transcludes it and has only one navbox, so the Absalom navbox shows. [[Absalom]] has two navboxes, so the Absalom navbox collapses.
<!-- No PFW navboxes use expanded as the default
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.
-->
=== Cells ===
=== Cells ===


:; ''title''*
; ''title''<nowiki>*</nowiki>
:: 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 <code><nowiki>{{-}}</nowiki></code> to ensure proper centering. This parameter is technically not mandatory, but using {{tl|Navbox}} is rather pointless without a 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 <code><nowiki>&middot;</nowiki></code> to ensure proper centering. This parameter is technically not mandatory, but using {{tl|Navbox}} is rather pointless without a title.


:; ''above''*
; ''group<sub>n</sub>''<nowiki>*</nowiki>
:: 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.
: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header cell displayed to the left of ''list<sub>n</sub>''. If omitted, ''list<sub>n</sub>'' uses the full width of the table.


:; ''group<sub>n</sub>''*
; ''groupBackground''<nowiki>*</nowiki>
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header cell displayed to the left of ''list<sub>n</sub>''. If omitted, ''list<sub>n</sub>'' uses the full width of the table.
: If specified, changes the background color of the groups of this Navbox and all contained Navboxes.


:; ''list<sub>n</sub>''*
; ''groupColor''<nowiki>*</nowiki>
::  (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 <code><nowiki><div> </div></nowiki></code>.  At least one ''list'' parameter is required; each additional ''list'' is displayed in a separate row of the table.  Each ''list<sub>n</sub>'' may be preceded by a corresponding ''group<sub>n</sub>'' parameter, if provided (see below).
: If specified, changes the text color of the groups of this Navbox and all contained Navboxes.


:; ''image''*
; ''list<sub>n</sub>''<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.'':
: (i.e. ''list1'', ''list2'', etc.) The body of the template, usually a bulleted list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <code><nowiki><div> </div></nowiki></code>.  At least one ''list'' parameter is required; each additional ''list'' is displayed in a separate row of the table. Each ''list<sub>n</sub>'' may be preceded by a corresponding ''group<sub>n</sub>'' parameter, if provided (see below).
::: <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>
::: nb: including "|right" will produced the usual left margin to provide separation from the list items and [[zebra striping]].


:; ''imageleft''*
; ''image''<nowiki>*</nowiki>
:: 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.
: 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>[[File:</nowiki><var>XX</var><nowiki>.jpg|90px|link=|alt=]]</nowiki></code>


:; ''below''*
; ''above''<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 {{oldid|Main Page|352612160|this}} version of {{tl|Lists of the provinces and territories of Canada}}.
: 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.


=== Style parameters ===
; ''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}}. -->


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


:; ''style''*
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'', and ''below'' parameters (gray list background color added for illustration only):
:: Specifies [[Cascading Style Sheets|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:
::: <code>style = background: #''nnnnnn'';</code>
::: <code>style = width: ''N''&nbsp;[em/%/px or width: auto];</code>
::: <code>style = float: [''left/right/none''];</code>
::: <code>style = clear: [''right/left/both/none''];</code>


:; ''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:
::: <code>basestyle = background: lightskyblue;</code>
:; ''titlestyle''*
:: [[Cascading Style Sheets|CSS]] styles to apply to ''title'', most often the titlebar's background color:
::: <code>titlestyle = background: ''#nnnnnn'';</code>
::: <code>titlestyle = background: ''name'';</code>
:; ''groupstyle''*
:: CSS styles to apply to the ''groupN'' cells. This option overrides any styles that are applied to the entire table. Examples:
::: <code>groupstyle = background: #''nnnnnn'';</code>
::: <code>groupstyle = text-align: [''left/center/right''];</code>
::: <code>groupstyle = vertical-align: [''top/middle/bottom''];</code>
:; ''group<sub>n</sub>style''*
:: 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>
:; ''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''*
:: CSS styles to apply to all lists. Overruled by the ''oddstyle'' and ''evenstyle'' parameters (if specified) hereafter. When using backgound colors in the navbox, see the [[#Intricacies|note hereafter]].
:; ''list<sub>n</sub>style''*
:: 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:
::: <code>list5style = background: #ddddff;</code>
:; ''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 0 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:
::: <code>listpadding = 0.5em 0;</code> (sets 0.5em padding for the left/right, and 0 padding for the top/bottom.)
::: <code>listpadding = 0;</code> (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'' <span style="font-weight: normal;"><code>[swap, even, odd, off]</code></span>
:: If set to <code>swap</code>, 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 <code>even</code> or <code>odd</code> sets all rows to have that striping color. Setting to <code>off</code> 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:
::: <code>abovestyle = background: #''nnnnnn'';</code>
::: <code>abovestyle = text-align: [''left/center/right''];</code>
::: <code>belowstyle = background: #''nnnnnn'';</code>
::: <code>belowstyle = text-align: [''left/center/right''];</code>
:; ''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:
::: <code>imagestyle = width:5em;</code>
===== Default styles =====
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]].
: <code>bodystyle  = background: #fdfdfd; width: 100%; vertical-align: middle;</code>
: <code>titlestyle = background: #ccccff; padding-left: 1em; padding-right: 1em; text-align: center;</code>
: <code>abovestyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;</code>
: <code>belowstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;</code>
: <code>groupstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: right;</code>
: <code>liststyle  = background: transparent; text-align: left/center;</code>
: <code>oddstyle  = background: transparent;</code>
: <code>evenstyle  = background: #f7f7f7;</code>
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 <code>text-align: left;</code> if it has a group, if not it defaults to <code>text-align: center;</code>. Since only ''bodystyle'' has a vertical-align all the others inherit its <code>vertical-align: middle;</code>.
=== Advanced parameters ===
:; ''bodyclass''
:; ''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 <code>hlist</code> 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''
:: 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''
:: 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.
==== Microformats ====
:; ''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:
<pre>
| bodyclass = vcard
</pre>
''and''
<pre>
| titleclass = fn
</pre>
''or'' (for example):
<pre><nowiki>
| title = The books of <span class="fn">[[Iain Banks]]</span>
</nowiki></pre>
...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 ==
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Navbox/doc
| state = uncollapsed
| state = uncollapsed
| liststyle = background: silver;
| title  = {{{title}}}
| title  = {{{title}}}
| group1 = {{{group1}}}
| group1 = {{{group1}}}
| list1  = {{{list1}}}
| list1  = {{{list1}}}
| group2 = {{{group2}}}
| group2 = {{{group2}}}
| list2  = {{{list2}}}
| list2  = {{{list2}}}
| list3  = {{{list3}}} ''without {{{group3}}}''
| list3  = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| group4 = {{{group4}}}
| list4  = {{{list4}}}
| list4  = {{{list4}}}
}}
}}


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


Table generated by {{tl|Navbox}} '''with''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Navbox/doc
| state = uncollapsed
| state = uncollapsed
| liststyle = background: silver;
| image  = {{{image}}}
| image  = {{{image}}}
| title  = {{{title}}}
| title  = {{{title}}}
| above  = {{{above}}}
| above  = {{{above}}}
| group1 = {{{group1}}}
| group1 = {{{group1}}}
| list1  = {{{list1}}}
| list1  = {{{list1}}}
| group2 = {{{group2}}}
| group2 = {{{group2}}}
| list2  = {{{list2}}}
| list2  = {{{list2}}}
| list3  = {{{list3}}} ''without {{{group3}}}''
| list3  = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| group4 = {{{group4}}}
| list4  = {{{list4}}}
| list4  = {{{list4}}}
| below  = {{{below}}}
| below  = {{{below}}}
}}
}}


 
Table generated by {{tl|Navbox}} '''with''' ''image'', ''lists'', and '''without''' ''groups'', ''above'', ''below'' (gray list background color added for illustration only):
Table generated by {{tl|Navbox}} '''with''' ''image'', ''imageleft'', ''lists'', and '''without''' ''groups'', ''above'', ''below'' (gray list background color added for illustration only):
{{Navbox
| name = Navbox/doc
| state = uncollapsed
| liststyle = background: silver;
| image = {{{image}}}
| imageleft = {{{imageleft}}}
| title = {{{title}}}
| list1 = {{{list1}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}}
| list4 = {{{list4}}}
}}
 
== Examples ==
 
<!-- Please do not encourage folks to use <div> within Navboxes as (unless handled carefully) they can negate liststyles/groupstyles/etc. settings. -->
 
=== No image ===
 
<pre style="overflow: auto;">
{{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]]
}}
</pre>


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


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


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


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


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


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


=== With image, without groups ===
=== No image ===


<pre style="overflow: auto;">
<pre style="overflow:auto;">
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| title = The Seven Realms of [[Thassilon]]
| listclass = hlist
| image =  
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]


| list1 =
| list1 =  
* [[Petronas Twin Towers]]
* [[Bakrakhan]], realm of Wrath
* [[Kuala Lumpur Tower]]
* [[Cyrusian]], realm of Pride
* [[Kuala Lumpur Sentral]]
* [[Edasseril]], realm of Envy
* [[Technology Park Malaysia]]
* [[Eurythnia]], realm of Lust
* [[Putrajaya]]
* [[Gastash]], realm of Gluttony
* [[Cyberjaya]]
* [[Haruka]], realm of Sloth
* [[Kuala Lumpur International Airport]]
* [[Shalast]], realm of Greed
}}
}}
</pre>
</pre>
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| title = The Seven Realms of [[Thassilon]]
| listclass = hlist
| image =  
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]


| list1 =
| list1 =  
* [[Petronas Twin Towers]]
* [[Bakrakhan]], realm of Wrath
* [[Kuala Lumpur Tower]]
* [[Cyrusian]], realm of Pride
* [[Kuala Lumpur Sentral]]
* [[Edasseril]], realm of Envy
* [[Technology Park Malaysia]]
* [[Eurythnia]], realm of Lust
* [[Putrajaya]]
* [[Gastash]], realm of Gluttony
* [[Cyberjaya]]
* [[Haruka]], realm of Sloth
* [[Kuala Lumpur International Airport]]
* [[Shalast]], realm of Greed
}}
}}


=== With two images, without groups, multiple lists ===
=== With image, without groups ===


<pre style="overflow: auto;">
<pre style="overflow:auto;">
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| title = The Seven Realms of [[Thassilon]]
| listclass = hlist
| image = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[File:Flag of Malaysia.svg|80px]]
 
| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
 
| list2 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]


| list3 =
| list1  =  
* [[EGovernment]]
* [[Bakrakhan]], realm of Wrath
* [[MyKad]]
* [[Cyrusian]], realm of Pride
 
* [[Edasseril]], realm of Envy
| list4 =
* [[Eurythnia]], realm of Lust
* [[Klang Valley]]
* [[Gastash]], realm of Gluttony
* [[Haruka]], realm of Sloth
* [[Shalast]], realm of Greed
}}
}}
</pre>
</pre>


{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| title = The Seven Realms of [[Thassilon]]
| listclass = hlist
| image = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[File:Flag of Malaysia.svg|80px]]
 
| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
 
| list2 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]
 
| list3 =
* [[EGovernment]]
* [[MyKad]]


| list4 =
| list1  =  
* [[Klang Valley]]
* [[Bakrakhan]], realm of Wrath
* [[Cyrusian]], realm of Pride
* [[Edasseril]], realm of Envy
* [[Eurythnia]], realm of Lust
* [[Gastash]], realm of Gluttony
* [[Haruka]], realm of Sloth
* [[Shalast]], realm of Greed
}}
}}


=== With image, groups, above, below ===
=== With image, groups, above, below ===


<pre style="overflow: auto;">
<pre style="overflow:auto;">
{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| title = The Seven Realms of [[Thassilon]]
| listclass = hlist
| image = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]
| above = Above text goes here
| above  = Listed with their associated sin
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]


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


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


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


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


| group5 = Prime applications
| group5 = Gluttony
| list5  =
| list5  =
* [[EGovernment]]
* [[Gastash]]
* [[MyKad]]
 
| group6 = Sloth
| list6  =
* [[Haruka]]
 
| group7 = Greed
| list7  =
* [[Shalast]]


| below  = Website: {{URL|http://www.msc.com.my/}}
| below  = '''See also''': [[Runelords]]
}}
}}
</pre>
</pre>


{{Navbox
{{Navbox
| name = Navbox/doc
| name   = Thassilon navbox
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| image  = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]
| listclass = hlist
| title      = The Seven Realms of [[Thassilon]]
| above = Above text goes here
| above = Listed with their associated sin
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]


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


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


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


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


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


| below  = Website: {{URL|http://www.msc.com.my/}}
| group6 = Sloth
| list6  =
* [[Haruka]]
 
| group7 = Greed
| list7  =
* [[Shalast]]
 
| below  = '''See also''': [[Runelords]]
}}
}}


== 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
| name = {{subst:PAGENAME}}
| name = {{subst:PAGENAME}}
| title = Title
| title = Title


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


...
...
Line 581: Line 349:
</pre>
</pre>


=== Subgroups example ===
You can nest several levels of navbox to add subgroups to a group:
 
{{main|Template:Navbox subgroup}}


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.
<pre style="overflow:auto;">


{{Navbox
{{Navbox
| name = Navbox/doc
| name = {{subst:PAGENAME}}
| image = [[File:Flag of the United States.svg|100px|link=|alt=]]
| title = Title
| state = uncollapsed
| title = Multiple subgroup example
| above = Above
| below = Below


| group1 = Group1
| group1 = [primary]
| list1  = List1
| list1  = {{Navbox  
| group2 = Group2
| list2  =
{{Navbox|child
  | evenodd = swap
  | group1 = Group2.1
  | list1  = List1
  | group2 = Group2.2
  | list2  = List2
  | group3 = Group2.3
  | list3  = List3
}}


| group3 = Group3
  | group1 = [secondary]
| list3 = List3
  | list1  = {{Navbox


| group4 = Group4
    | group1 = [tertiary]
| list4 =
    | list1  = ...
{{Navbox|child
  | evenodd = swap
  | group1 = Group4.1
  | list1  = List1
  | group2 = Group4.2
  | list2  = List2
  | group3 = Group4.3
  | list3  = List3
}}
}}


=== Multiple show/hides in a single container ===
    }}


{{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>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).
...
}}
</pre>


{{Navbox
{{Navbox
| name = Navbox/doc
| name = Navbox/doc
| title = [[File:Blason France moderne.svg|x17px|link=|alt=]] [[File:Flag of France.svg|x17px|link=|alt=]] [[French colonial empire|Former French overseas empire]]
| title = Title
| state = uncollapsed
| list1 = {{Navbox|child
| navbar    = plain
| title    = [[French colonial empire|Former French colonies]] in [[Africa]] and the [[Indian Ocean]]
| listclass = hlist


| group1 = [[Mahgreb]]
| group1 = [primary]
| list1  =
| list1  = {{Navbox
* [[French rule in Algeria|Algeria]]
* [[French Morocco|Morocco]] <small>([[Arguin|Arguin Island]])</small>
* [[History of Tunisia|Tunisia]]


| group2 = [[French West Africa]]
  | group1 = [secondary]
| list2 =
  | list1 = {{Navbox
* [[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 = [[French Equatorial Africa]]
    | group1 = [tertiary]
| list3 =
    | list1 = ...
* [[Colonial Chad|Chad]]
* [[History of Gabon|Gabon]]
* [[History of the Republic of the Congo|Middle Congo]]
* [[Oubangui-Chari]]


| group4 = [[Comoros]]
    }}
| list4  =
* [[Anjouan]]
* [[Grande Comore]]
* [[Mohéli]]
* [[History of Djibouti#French Interest|French Somaliland (Djibouti)]]
* [[History of Madagascar#French control|Madagascar]]
* [[Mauritius|Ile de France]]
* [[Seychelles]]
}}


| list2 = {{Navbox|child
  ...
| navbar    = plain
  }}
| title    = [[French colonial empire|Former French colonies]] in the [[Americas]]
| listclass = hlist


| 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]]
* <small>[[Haiti]]</small>
* [[Tobago]]
* [[History of the British Virgin Islands|Virgin Islands]]
* [[France Antarctique]]
* [[France Équinoxiale]]
 
| below      = [[French West India Company]]
}}
}}


| list3 = {{Navbox|child
=== Multiple show/hides in a single container ===
| navbar    = plain
| title      = [[French colonial empire|Former French colonies]] in [[Asia]] and [[Oceania]]
| listclass  = hlist
 
| group1 = [[French India]]
| list1  =
* [[Chandernagor]]
* [[Coromandel Coast]]
* [[History of Chennai|Madras]]
* [[Mahé, India|Mahé]]
* [[History of Pondicherry|Pondichéry]]
* [[Karaikal]]
* [[Yanam (India)|Yanaon]]


| group2 = [[French Indochina]]
Use {{tl|Navbox with collapsible groups}}.
| 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
| list3  =
* [[Alawite State|Alaouites]]
* [[Republic of Hatay|Alexandretta-Hatay]]
* [[Sri Lanka|Ceylon]]
* [[Kwangchowan]]
 
| group4 = [[Oceania]]
| list4  =
* [[New Hebrides]]
** [[History of Vanuatu|Vanuatu]]
 
| below      = [[French East India Company]]
}}
}}


== Relationship with other Navbox templates ==
== Relationship with other Navbox templates ==


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 (*) in the [[#Parameter descriptions|parameter descriptions]] list hereinbefore). 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>.
This navbox template is specifically designed to work in conjunction with {{tl|Navbox with collapsible groups}}. Both 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 of these templates can each be used as children of one another.
 
== Technical details ==
 
* 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.
* For more technical details see the [[{{TALKPAGENAME}}|talk page]], the CSS classes in [[MediaWiki:Common.css]] and the collapsible table used to hide the box in [[MediaWiki:Common.js]].
 
=== 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 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:
:: <code>groupstyle = width: 10em;</code>
:: <code>liststyle = width: auto;</code>
* Adjacent navboxes have only a 1 pixel border between them (except in IE 6, which doesn't support the necessary CSS). If you set the top or bottom margin of <code>style/bodystyle</code>, 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:
::<code>style = width: 22em; float: right; margin-left: 1em; margin-right: 0;</code>
 
=== 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]].
 
=== 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"}}.
# In Internet Explorer 8 and 9, there is a bug when using <code>hlist</code>; navbox will fail to wrap the list to the next line if the list items start with an image, causing navbox to extend its width outside the screen. This can be fixed by adding <code>&amp;nbsp;</code> in front of the images.
# 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.
 
== See also ==


* {{tl|Navbar}} – Used for the navigation links in navbox.
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
* {{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.
* {{tl|Sidebar}} – Vertically-aligned navigation (navbox) templates.
* [[Template:Navbox/testcases]] – For additional examples of template code.
* [[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}}, {{tl|·}} and {{tl|•}} are '''deprecated''' in favor of the <code>hlist</code> class for formatting lists. See [[Template:Flatlist#Technical details|Flatlist]] for a technical explanation of how <code>hlist</code> works.

Latest revision as of 01:11, 14 February 2025

Template:Tl allows a Template:W to be set up relatively quickly by supplying it with one or more lists of links. Using this template or Template:Tl is highly recommended for standardization of navigational templates, and for ease of use.

Usage[edit source]

Please remove the parameters that are left blank. 

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

| group1  = 
| list1   = 

...

| group20 = 
| list20  = 

| below = 
}}

Parameter list[edit source]

• •
{{{title}}}
{{#widget:Collapser|state=uncollapsed|prefix=navbox|id=0.7749420044827}}
{{{above}}}
{{{image}}}

{{{group1}}}

{{{list1}}}

{{{group2}}}

{{{list2}}}

{{{list3}}} without {{{group3}}}

{{{group4}}}

{{{list4}}}

{{{below}}}
See alternate navbox formats under: Layout of table

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 - off, uncollapsed (default), collapsed: the status of box expansion, where "off" hides collapser completely.
groupBackground - a CSS color for the group-cells, such as: #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|90px|link=|alt=]].
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, often separated by middot templates, such as: [[A]]{{·}} [[B]]
below - optional text to appear below the group/list section.

Further details, and complex restrictions, are explained below under section Parameter descriptions. See some alternate navbox formats under section Layout of table.

Parameter descriptions[edit source]

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

Template:Tl shares numerous common parameter names as its sister template Template:Tl for consistency and ease of use. Parameters marked with an asterisk * are common to all templates.

Setup parameters[edit source]

name*
The name of the template, which is needed for the view, discuss, and edit icon 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* [uncollapsed, collapsed, off]
  • Defaults to uncollapsed.
  • If set to collapsed, the navbox will always start out in a collapsed state.
  • If set to off, the navbox will always be expanded with no [hide] link on the right.
  • If set to anything other than collapsed, or off (such as uncollapsed), the navbox will always start out in an expanded state, but have the "hide" button.
To define a default initial state for a navbox that can be overridden in an article:
  • In your intermediate template, create a parameter also named "state" as a pass-through:
| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}
  • The <includeonly>| will expand the template when viewing the template page by itself.
Example: Template:Tl with autocollapse as the default initial state. The Docks transcludes it and has only one navbox, so the Absalom navbox shows. Absalom has two navboxes, so the Absalom navbox collapses.

Cells[edit source]

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 Template:Tl 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.
groupBackground*
If specified, changes the background color of the groups of this Navbox and all contained Navboxes.
groupColor*
If specified, changes the text color of the groups of this Navbox and all contained Navboxes.
listn*
(i.e. list1, list2, etc.) The body of the template, usually a bulleted 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|90px|link=|alt=]]
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.

Layout of table[edit source]

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

• •
{{{title}}}
{{#widget:Collapser|state=uncollapsed|prefix=navbox|id=0.13038829673565}}

{{{group1}}}

{{{list1}}}

{{{group2}}}

{{{list2}}}

{{{list3}}} without {{{group3}}}

{{{group4}}}

{{{list4}}}

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

• •
{{{title}}}
{{#widget:Collapser|state=uncollapsed|prefix=navbox|id=0.39564502304217}}
{{{above}}}
{{{image}}}

{{{group1}}}

{{{list1}}}

{{{group2}}}

{{{list2}}}

{{{list3}}} without {{{group3}}}

{{{group4}}}

{{{list4}}}

{{{below}}}

Table generated by Template:Tl with image, lists, and without groups, above, below (gray list background color added for illustration only):

• •
{{{title}}}
{{#widget:Collapser|state=uncollapsed|prefix=navbox|id=0.65485740436933}}
{{{image}}}

{{{list1}}}

{{{list2}}}

{{{list3}}}

{{{list4}}}

Examples[edit source]

No image[edit source]

{{Navbox
| name   = Thassilon navbox
| title  = The Seven Realms of [[Thassilon]]
| image  = 

| list1  = 
* [[Bakrakhan]], realm of Wrath
* [[Cyrusian]], realm of Pride
* [[Edasseril]], realm of Envy
* [[Eurythnia]], realm of Lust
* [[Gastash]], realm of Gluttony
* [[Haruka]], realm of Sloth
* [[Shalast]], realm of Greed
}}
• •
The Seven Realms of Thassilon
{{#widget:Collapser|state=|prefix=navbox|id=0.10417975955837}}

With image, without groups[edit source]

{{Navbox
| name   = Thassilon navbox
| title  = The Seven Realms of [[Thassilon]]
| image  = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]

| list1  = 
* [[Bakrakhan]], realm of Wrath
* [[Cyrusian]], realm of Pride
* [[Edasseril]], realm of Envy
* [[Eurythnia]], realm of Lust
* [[Gastash]], realm of Gluttony
* [[Haruka]], realm of Sloth
* [[Shalast]], realm of Greed
}}
• •
The Seven Realms of Thassilon
{{#widget:Collapser|state=|prefix=navbox|id=0.52969304636572}}
The Sihedron Rune

With image, groups, above, below[edit source]

{{Navbox
| name   = Thassilon navbox
| title  = The Seven Realms of [[Thassilon]]
| image  = [[File:Sihedron Rune.jpg|75px|The Sihedron Rune]]
| above  = Listed with their associated sin

| group1 = Wrath
| list1  = 
* [[Bakrakhan]]

| group2 = Pride
| list2  =
* [[Cyrusian]]

| group3 = Envy
| list3  =
* [[Edasseril]]

| group4 = Lust
| list4  =
* [[Eurythnia]]

| group5 = Gluttony
| list5  =
* [[Gastash]]

| group6 = Sloth
| list6  =
* [[Haruka]]

| group7 = Greed
| list7  =
* [[Shalast]]

| below  = '''See also''': [[Runelords]]
}}
• •
The Seven Realms of Thassilon
{{#widget:Collapser|state=|prefix=navbox|id=0.74888800911088}}
Listed with their associated sin
The Sihedron Rune

Wrath

Pride

Envy

Lust

Gluttony

Sloth

Greed

See also: Runelords

Child navboxes[edit source]

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 navbox parameters...
  }}

...
}}

You can nest several levels of navbox to add subgroups to a group: 


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

| group1 = [primary]
| list1  = {{Navbox 

  | group1 = [secondary]
  | list1  = {{Navbox 

    | group1 = [tertiary]
    | list1  = ...

    }}

  ...
  }}

...
}}
• •
Title
{{#widget:Collapser|state=|prefix=navbox|id=0.62779916619314}}

[primary]

[secondary]

[tertiary]

... 

 ...

...

Multiple show/hides in a single container[edit source]

Use Template:Tl.

Relationship with other Navbox templates[edit source]

This navbox template is specifically designed to work in conjunction with Template:Tl. Both templates share common parameters for consistency and ease of use (such parameters are marked with a † in the complete parameter list above). Most importantly, all of these templates can each be used as children of one another.

Retrieved from "http://2d4chan.org/mediawiki/index.php?title=Template:Navbox/doc&oldid=1003009"