Template:Navbox/doc: Difference between revisions

From Homecoming Wiki
Jump to navigation Jump to search
imported>Sekoia (historical)
No edit summary
 
(37 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}


This template allows a [[wikipedia:Wikipedia:Navigational 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 is highly recommended for standardization of navigational templates, and for ease of use.
This template allows a [[wikipedia:Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it with navigational content, such as 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 is recommended to standardize navigational templates, and for ease of use.


== Usage ==
== Usage ==
Line 9: Line 9:
|name    = {{subst:PAGENAME}}
|name    = {{subst:PAGENAME}}
|title  =  
|title  =  
|image  =
|above  =  
|above  =  
|body    =


|group1  =  
|group1  =  
Line 18: Line 19:
|list2  =  
|list2  =  
  ...
  ...
|group20 =  
|group10  =  
|list20  =  
|list10  =  


|below  =  
|below  =  
Line 28: Line 29:
|name = Navbox/doc
|name = Navbox/doc
|state = uncollapsed
|state = uncollapsed
|image = {{{image}}}
|title = {{{title}}}
|title = {{{title}}}
|above = {{{above}}}
|above = {{{above}}}
|body = {{{body}}}
|group1 = {{{group1}}}
|group1 = {{{group1}}}
|list1 = {{{list1}}}
|list1 = {{{list1}}}
|group2 = {{{group2}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''without {{{group3}}}''
|below = {{{below}}}<br />See alternate navbox formats under: [[#Layout overview|''Layout overview'']] and [[#Examples|''Examples'']]
|group4 = {{{group4}}}
|list4 = {{{list4}}}
|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.
<br/>
<br />


Notice "group1" (etc.) is optional, as are sections named "above/below".
Notice "group1" (etc.) is optional, as are sections named "above/below".
Line 47: Line 45:
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 below for the full list):


:<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 - autocollapse, uncollapsed, collapsed</code>: the status of box expansion, where "autocollapse" hides stacked navboxes automatically.
;<code>body</code>: content to appear in the body section, a simplified alternative to group/list pairs (could be a list of overall wikilinks).
 
;<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>titlestyle - </code>a CSS style for the title-bar, such as: <code>background:gray;</code>
;<code>list<sub>n</sub></code>: text listing wikilinks, often separated by middot templates, such as: [<nowiki />[A]]<code>{<nowiki />{·}}</code> [<nowiki />[B]]
:<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 tag: <nowiki>[[Image:XX.jpg|90px]]</nowiki> ).
:<code>imageleft - </code>an optional left-side image (code the same was as the "image" parameter).
 
:<code>above - </code>text to appear above the group/list section (could be a list of overall wikilinks).
 
:<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: [[#Layout of table|''Layout of table'']].
Further details are explained below under section ''[[#Parameter descriptions|Parameter descriptions]]''. See some alternate navbox formats under: [[#Layout overview|''Layout overview'']] and [[#Examples|''Examples'']].


==Parameter descriptions==
==Parameter descriptions==
The following is a complete list of parameters for using {{t1|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 either <code>body</code> or <code>group1</code>.
 
{{t1|Navbox}} shares numerous common parameter names as its sister templates {{t1|Navbox with columns}} and {{t1|Navbox with collapsible groups}} for consistency and ease of use.  Parameters marked with a cross<sup><span style="font-weight:bold;">†</span></sup> are common to all three master templates.


===Setup parameters===
===Setup parameters===
:; ''name''<sup>†</sup>
; ''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 <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 "v • d • e" ("view • discuss • 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.
 
; ''state'' <span style="font-weight:normal;">[<code>collapsed</code>]</span>
:; ''state''<sup>†</sup> <span style="font-weight:normal;">[<code>autocollapse, uncollapsed, collapsed, plain, off</code>]</span>
: Defaults to <code>uncollapsed</code>. A navbox with <code>collapsed</code> will start out collapsed. Otherwise, the navbox will be expanded. 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: <tt><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></tt>.
:* 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]].
:* 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 • d • e</small> links).
:* 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>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:
:*<tt><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></tt>
:*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|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''<sup>†</sup>
:: 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.
 
:; ''border''<sup>†</sup>
:: ''See section below 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 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 <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>
 
===Cells===
:; ''title''<sup>†</sup>
:: 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 {{t1|Navbox}} is rather pointless without a title.
 
:; ''group<sub>n</sub>''<sup>†</sup>
:: (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.
 
:; ''list<sub>n</sub>''<sup>†</sup>
::  (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).
 
:; ''image''<sup>†</sup>
:: 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, i.e.
::: <code><nowiki>image = [[Image:Example.jpg|100px]]</nowiki></code>
 
:; ''imageleft''<sup>†</sup>
:: 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. The ''imageleft'' parameter accepts standard wikicode for displaying an image, i.e.
::: <code><nowiki>imageleft = [[Image:Example.jpg|100px]]</nowiki></code>
 
:; ''above''<sup>†</sup>
:: 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''<sup>†</sup>
===Content===
:: 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}}.
; ''title''
: Text that appears centered at the top of the navbox. 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.
; ''body''
: If specified, text appears in the body of the navbox. Usually a list of links. A simplified alternative to ''group1'', ''list1'', etc. pairs.
; ''group<sub>n</sub>''
: (i.e. ''group1'', ''group2'', etc.) If specified, text appears on the left side of the body of the navbox.
; ''list<sub>n</sub>''
:  (i.e. ''list1'', ''list2'', etc.) If specified, text appears to the right of the corresponding ''group<sub>n</sub>'' parameter. Usually a list of links.
; ''above''
: Text displayed below the title and above the body.
; ''below''
: Text displayed below the body (groups, lists and image).


===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 not recommended as to maintain consistency among templates and pages in Wikipedia.  However, the option to modify styles is given.


:; ''style''<sup>†</sup>
; ''style''
:: Specifies [[Cascading Style Sheets|CSS]] styles to apply to the template body. The parameter ''bodystyle'' also does the example 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:
: Specifies [[wikipedia:Cascading Style Sheets|CSS]] styles to apply to the outer container.
::: <code>style = background:#''nnnnnn'';</code>
; ''basestyle''
::: <code>style = width:''N''&nbsp;[em/%/px or width:auto];</code>
: 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.
::: <code>style = float:[''left/right/none''];</code>
; ''titlestyle''
::: <code>style = clear:[''right/left/both/none''];</code>
: Styles to apply to ''title'', such as the titlebar's background color.
 
; ''bodystyle''
:; ''basestyle''<sup>†</sup>
: Styles to apply to ''body'', or to the container around ''group'' and ''list'' content.
:: CSS styles to apply to the ''title'', ''above'', ''below'', and ''group'' cells all at once.  The style 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:
; ''groupstyle''
::: <code>basestyle = background:lightskyblue;</code>
: CSS styles to apply to the ''groupN'' cells.
 
; ''group<sub>n</sub>style''
:; ''titlestyle''<sup>†</sup>
: CSS styles to apply to a specific group, in addition to any styles specified by the ''groupstyle'' parameter.
:: [[Cascading Style Sheets|CSS]] styles to apply to ''title'', most often the titlebar's background color:
; ''liststyle''
::: <code><nowiki>titlestyle = background:</nowiki>''#nnnnnn'';</code>
: CSS styles to apply to all lists. Overruled by the ''oddstyle'' and ''evenstyle'' parameters (if specified) below.
::: <code><nowiki>titlestyle = background:</nowiki>''name'';</code>
; ''list<sub>n</sub>style''
 
: CSS styles to apply to a specific group, in addition to any styles specified by the ''liststyle'' parameter.
:; ''groupstyle''<sup>†</sup>
; ''listpadding''
:: CSS styles to apply to the ''groupN'' cells. This option overrides any styles that are applied to the entire table. Examples:
: A number and unit specifying the padding around each ''list''. Default is padding of 0.25em on the left and right, and 0em on the top and bottom.
::: <code>groupstyle = background:#''nnnnnn'';</code>
; ''oddstyle'', ''evenstyle''
::: <code>groupstyle = text-align:[''left/center/right''];</code>
: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 lists, respectively, in order to improve readability.
::: <code>groupstyle = vertical-align:[''top/middle/bottom''];</code>
; ''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.
:; ''group<sub>n</sub>style''<sup>†</sup>
; ''abovestyle'', ''belowstyle''
:: 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 the content specified via the ''above'' or ''below'' parameters.
::: <code>group3style = background:red;color:white;</code>
 
:; ''liststyle''<sup>†</sup>
:: CSS styles to apply to all lists. Overruled by the ''oddstyle'' and ''evenstyle'' parameters (if specified) below.
 
:; ''list<sub>n</sub>style''<sup>†</sup>
:: 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>list5style = background:#ddddff;</code>
 
:; ''listpadding''<sup>†</sup>
:: 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:
::: <code>listpadding = 0.5em 0em; </code> (sets 0.5em padding for the left/right, and 0em padding for the top/bottom.)
::: <code>listpadding = 0em; </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''<sup>†</sup>
:; ''belowstyle''<sup>†</sup>
:: 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>
 
:; ''imagestyle''<sup>†</sup>
:; ''imageleftstyle''<sup>†</sup>
:: 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 =====
===== 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]].
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>style = background:#fdfdfd; text-align: center;</code>
:<code>titlestyle = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;</code>
:<code>titlestyle = background:#ccccff; padding-left:6em; padding-right:6em;</code>
:<code>abovestyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;</code>
:<code>abovestyle = background:#ddddff; padding-left:1em; padding-right:1em;</code>
:<code>belowstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;</code>
:<code>belowstyle = background:#ddddff; padding-left:1em; padding-right:1em;</code>
:<code>groupstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;</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>liststyle  = text-align:left;</code>
:<code>oddstyle  = background:transparent;</code>
:<code>evenstyle  = background:#f7f7f7;</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 has <code>text-align:left;</code> if it has a group, if not it has <code>text-align:center;</code>. Since only ''bodystyle'' has a vertical-align all the others inherit its <code>vertical-align:middle;</code>.
Since ''liststyle'' and ''oddstyle'' are transparent odd lists have the color of the main ''style'', which defaults to #fdfdfd (white with a hint of gray). A list has <code>text-align:left;</code> if it has a group, if not it has <code>text-align:center;</code>. Since only ''bodystyle'' has a vertical-align all the others inherit its <code>vertical-align:middle;</code>.
 
 
===Advanced parameters===
:; ''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 {{t1|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.


== Layout of table ==
== Layout overview ==
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
Layout generated by {{tl|Navbox}} with ''group'' and ''list'' pairs, and without ''above'' and ''below'' parameters (gray list background color added for illustration only):
{{Navbox
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
Line 222: Line 128:
|group2 = {{{group2}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''without {{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
}}
}}


 
Layout generated by {{tl|Navbox}} with ''body'', ''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}}}
|title = {{{title}}}
|title = {{{title}}}
|above = {{{above}}}
|above = {{{above}}}
|group1 = {{{group1}}}
|bodystyle = background:silver;
|list1 = {{{list1}}}
|body = {{{body}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''without {{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
|below = {{{below}}}
|below = {{{below}}}
}}
}}


== Examples ==


Table generated by {{tl|Navbox}} '''with''' ''image'', ''imageleft'', ''lists'', and '''without''' ''groups'', ''above'', ''below'' (gray list background color added for illustration only):
<pre>
{{Navbox
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
|state = uncollapsed
|title = [[Archetypes]]
|liststyle = background:silver;
|body = [[Blaster]]{{dot}} [[Brute]]{{dot}} [[Controller]]{{dot}} [[Corruptor]]{{dot}} [[Defender]]{{dot}} [[Dominator]]{{dot}} [[Mastermind]]{{dot}} [[Scrapper]]{{dot}} [[Sentinel]]{{dot}} [[Stalker]]{{dot}} [[Tanker]]{{dot}} [[Arachnos Soldier]]{{dot}} [[Arachnos Widow]]{{dot}} [[Peacebringer]]{{dot}} [[Warshade]]
|image = {{{image}}}
|imageleft = {{{imageleft}}}
|title = {{{title}}}
|list1 = {{{list1}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}}
|list4 = {{{list4}}}
}}
 
== Examples ==
<!--Please don't encourage folks to use <div>s within Navboxes as (unless handled carefully) they can negate liststyles/groupstyles/etc settings.-->
 
=== No image ===
<pre style="overflow:scroll;">
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''
 
|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
|name  = Navbox/doc
|state  = uncollapsed
|title  = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''
|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 ===
<pre style="overflow:scroll;">
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|list1 = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]{{·}} [[Technology Park Malaysia]]{{·}} [[Putrajaya]]{{·}} [[Cyberjaya]]{{·}} [[Kuala Lumpur International Airport]]
}}
</pre>
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|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 ===
<pre style="overflow:scroll;">
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|imageleft = [[Image: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 = [[Klang Valley]]
}}
</pre>
 
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|imageleft = [[Image: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 = [[Klang Valley]]
}}
 
 
=== With image, groups, above, below ===
<pre style="overflow:scroll;">
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
 
|above = Above text goes here
 
|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]]
 
|below  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}
</pre>
 
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|above = Above text goes here
|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]]
|below  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}
 
 
==Child navboxes==
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:scroll;">
{{Navbox
|name = {{subst:PAGENAME}}
|title = Title
 
|group1 = [optional]
|list1 = {{Navbox|child
  ...child navbox parameters...
}}
 
...
}}
}}
</pre>
</pre>
===Subgroups example===
{{main|Template:Navbox subgroup}}
This example shows how subgroups can be used.  It is recommended that one uses {{t1|Navbox subgroup}}, but the same result can be reached by using {{t1|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.


{{Navbox
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
|image = [[Image:Flag of the United States.svg|100px]]
|title = [[Archetypes]]
|state = uncollapsed
|body = [[Blaster]]{{dot}} [[Brute]]{{dot}} [[Controller]]{{dot}} [[Corruptor]]{{dot}} [[Defender]]{{dot}} [[Dominator]]{{dot}} [[Mastermind]]{{dot}} [[Scrapper]]{{dot}} [[Sentinel]]{{dot}} [[Stalker]]{{dot}} [[Tanker]]{{dot}} [[Arachnos Soldier]]{{dot}} [[Arachnos Widow]]{{dot}} [[Peacebringer]]{{dot}} [[Warshade]]
|title = Multiple Subgroup Example
|above = Above
|below = Below
 
|group1 = Group1
|list1 = List1
|group2 = Group2
|list2 =
{{Navbox|child
  |evenodd = swap
  |group1 = Group2.1
  |list1 = List1
  |group2 = Group2.2
  |list2 = List2
  |group3 = Group2.3
  |list3 = List3
}}
 
|group3 = Group3
|list3 = List3
 
|group4 = Group4
|list4 =
{{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===
<pre>
{{main|Template:Navbox with collapsible groups}}
{{navbox|
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).
| name  = Navbox/doc
| title = [[Issues|Issue Releases]]


{{Navbox
| group1 = [[Cryptic Studios]]
|name = Navbox/doc
| list1  = [[Issue 1]]{{dot}} [[Issue 2]]{{dot}} [[Issue 3]]{{dot}} [[Issue 4]]{{dot}} [[Issue 5]]{{dot}} [[Issue 6]]{{dot}} [[Issue 7]]{{dot}} [[Issue 8]]{{dot}} [[Issue 9]]{{dot}} [[Issue 10]]
|title = [[Image:Blason France moderne.svg|15px]] {{flagicon|FRA}} [[French colonial empires|Former French overseas empire]]
|state = uncollapsed
|list1 = {{Navbox|child
|name      = Former French colonies in Africa and the Indian Ocean
|title      = [[French colonial empires|Former French colonies]] in [[Africa]] and the [[Indian Ocean]]
|groupstyle = background:lavender;


|group1 = [[Mahgreb]]
| group2 = [[Paragon Studios]]
|list1 = [[French rule in Algeria|Algeria]]{{·}} [[French Morocco|Morocco]]&nbsp;<small>([[Arguin|Arguin Island]])</small>{{·}} [[History of Tunisia|Tunisia]]
| list2 = [[Issue 11]]{{dot}} [[Issue 12]]{{dot}} [[Issue 13]]{{dot}} [[Issue 14]]{{dot}} [[Issue 15]]{{dot}} [[Issue 16]]{{dot}} [[Issue 17]]{{dot}} [[Issue 18]]{{dot}} [[Issue 19]]{{dot}} [[Strike Pack|Issue 19.5]]{{dot}} [[Issue 20]]{{dot}} [[Incarnates Ascend|Issue 20.5]]{{dot}} [[Issue 21]]{{dot}} [[Media Blitz|Issue 21.5]]{{dot}} [[Issue 22]]{{dot}} [[Issue 23]]{{dot}} [[Issue 24]]{{dot}} [[Issue 25 (Paragon Studios)]]


|group2 = [[French West Africa]]
| group3 = [[Homecoming Team]]
|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]]
| list3 = [[Issue 25]]{{dot}} [[Issue 26]]{{dot}} [[Issue 27]]


|group3 = &nbsp;
}}</pre>
|list3  = [[French Togoland]]{{·}} [[James Island (The Gambia)|James Island]]
 
|group4 = [[French Equatorial Africa]]
|list4  = [[Colonial Chad|Chad]]{{·}} [[History of Gabon|Gabon]]{{·}} [[History of the Republic of the Congo|Middle Congo]]{{·}} [[Oubangui-Chari]]
 
|group5 = [[Comoros]]
|list5  = [[Anjouan]]{{·}} [[Grande Comore]]{{·}} [[Mohéli]]
 
|group6 = &nbsp;
|list6  = [[History of Djibouti#French Interest|French Somaliland (Djibouti)]]{{·}} [[History of Madagascar#French Control|Madagascar]]{{·}} [[Mauritius|Ile de France]]{{·}} [[Seychelles]]
}}
 
|list2 = {{Navbox|child
|name      = Former French colonies in the Americas
|titlestyle =
|title      = [[French colonial empires|Former French colonies]] in the [[Americas]]
|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>
 
|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]]}}
 
|belowstyle =
|below      = [[French West India Company]]
}}
 
|list3 = {{Navbox|child
|name      = Former French colonies in Asia and Oceania
|title      = [[French colonial empires|Former French colonies]] in [[Asia]] and [[Oceania]]
|groupstyle =


|group1 = [[French India]]
{{navbox|
|list1 = [[Chandernagor]]{{·}} [[Coromandel Coast]]{{·}} [[History of Chennai|Madras]]{{·}} [[Malabar]]{{·}} [[Mahé, India|Mahé]]{{·}} [[History of Puducherry|Pondichéry]]{{·}} [[Karaikal]]{{·}} [[Yanam (India)|Yanaon]]
| name = Navbox/doc
| title = [[Issues|Issue Releases]]


|group2 = [[French Indochina]]
| group1 = [[Cryptic Studios]]
|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>
| list1 = [[Issue 1]]{{dot}} [[Issue 2]]{{dot}} [[Issue 3]]{{dot}} [[Issue 4]]{{dot}} [[Issue 5]]{{dot}} [[Issue 6]]{{dot}} [[Issue 7]]{{dot}} [[Issue 8]]{{dot}} [[Issue 9]]{{dot}} [[Issue 10]]


|group3 = Other Asian
| group2 = [[Paragon Studios]]
|list3 = [[Alawite State|Alaouites]]{{·}} [[Republic of Hatay|Alexandretta-Hatay]]{{·}} [[Sri Lanka|Ceylon]]{{·}} [[Kwangchowan]]
| list2 = [[Issue 11]]{{dot}} [[Issue 12]]{{dot}} [[Issue 13]]{{dot}} [[Issue 14]]{{dot}} [[Issue 15]]{{dot}} [[Issue 16]]{{dot}} [[Issue 17]]{{dot}} [[Issue 18]]{{dot}} [[Issue 19]]{{dot}} [[Strike Pack|Issue 19.5]]{{dot}} [[Issue 20]]{{dot}} [[Incarnates Ascend|Issue 20.5]]{{dot}} [[Issue 21]]{{dot}} [[Media Blitz|Issue 21.5]]{{dot}} [[Issue 22]]{{dot}} [[Issue 23]]{{dot}} [[Issue 24]]{{dot}} [[Issue 25 (Paragon Studios)]]


|group4 = [[Oceania]]
| group3 = [[Homecoming Team]]
|list4 = [[New Hebrides|New Hebrides]] [[History of Vanuatu|(Vanuatu)]]
| list3 = [[Issue 25]]{{dot}} [[Issue 26]]{{dot}} [[Issue 27]]


|belowstyle =
|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==
This navbox template is specifically designed to work in conjunction two other sister templates: {{t1|Navbox with columns}} and {{t1|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]].


== 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.
 
*For more technical details see the [[{{TALKPAGENAME}}|talk page]], the CSS classes in [[MediaWiki:common.css]], and [[mw:Manual:Collapsible elements|collapsible elements]] in MediaWiki.
*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 IE6, 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:0em;</code>
 
== See also ==
* {{t1|Navbox with columns}} &ndash; Allows columns instead of groups/lists
* {{t1|Navbox with collapsible groups}} &ndash; Another variation.
* [[Wikipedia:Line break handling]] &ndash; 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.
* {{t1|Nowrap begin}} &ndash; The recommended format for adding bullets, pipes, or dashes between list items.  The page describes how to go about using them with proper wrapping.
* {{t1|Nobold}} &ndash; 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|•}} &ndash; The dot and bullet commonly used to separate items in Navbox lists.
 
{{Navigation templates}}


<includeonly>
<includeonly>
<!--Categories-->
<!--Categories-->
[[Category:Navbox (navigational) templates| ]]
[[Category:Navigation Templates| ]]
</includeonly>
</includeonly>

Latest revision as of 10:37, 2 November 2022

This is a documentation subpage for Template:Navbox (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

This template allows a navigational template to be set up relatively quickly by supplying it with navigational content, such as 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 is recommended to standardize navigational templates, and for ease of use.

Usage

Please remove the parameters that are left blank. 

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

|body    = 

|group1  = 
|list1   = 

|group2  = 
|list2   = 
 ...
|group10  = 
|list10   = 

|below   = 
}}

Parameter list

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]].
body
content to appear in the body section, a simplified alternative to group/list pairs (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]]

Further details are explained below under section Parameter descriptions. See some alternate navbox formats under: Layout overview and Examples.

Parameter descriptions

The following is a complete list of parameters for using {{Navbox}}. In most cases, the only required parameters are name, title, and either body or group1.

Setup parameters

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.
state [collapsed]
Defaults to uncollapsed. A navbox with collapsed will start out collapsed. Otherwise, the navbox will be expanded. 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>}}}.

Content

title
Text that appears centered at the top of the navbox. 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.
body
If specified, text appears in the body of the navbox. Usually a list of links. A simplified alternative to group1, list1, etc. pairs.
groupn
(i.e. group1, group2, etc.) If specified, text appears on the left side of the body of the navbox.
listn
(i.e. list1, list2, etc.) If specified, text appears to the right of the corresponding groupn parameter. Usually a list of links.
above
Text displayed below the title and above the body.
below
Text displayed below the body (groups, lists and image).

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.

style
Specifies CSS styles to apply to the outer container.
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.
titlestyle
Styles to apply to title, such as the titlebar's background color.
bodystyle
Styles to apply to body, or to the container around group and list content.
groupstyle
CSS styles to apply to the groupN cells.
groupnstyle
CSS styles to apply to a specific group, in addition to any styles specified by the groupstyle parameter.
liststyle
CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) below.
listnstyle
CSS styles to apply to a specific group, in addition to any styles specified by the liststyle parameter.
listpadding
A number and unit specifying the padding around each list. Default is padding of 0.25em on the left and right, and 0em on the top and bottom.
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 lists, respectively, in order to improve readability.
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.
abovestyle, belowstyle
CSS styles to apply to the content specified via the above or below parameters.
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.

style = background:#fdfdfd; text-align: center;
titlestyle = background:#ccccff; padding-left:6em; padding-right:6em;
abovestyle = background:#ddddff; padding-left:1em; padding-right:1em;
belowstyle = background:#ddddff; padding-left:1em; padding-right:1em;
groupstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
liststyle = text-align:left;
evenstyle = background:#f7f7f7;

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

Layout overview

Layout generated by {{Navbox}} with group and list pairs, and without above and below parameters (gray list background color added for illustration only):

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

Examples

{{Navbox
|name = Navbox/doc
|title = [[Archetypes]]
|body = [[Blaster]]{{dot}} [[Brute]]{{dot}} [[Controller]]{{dot}} [[Corruptor]]{{dot}} [[Defender]]{{dot}} [[Dominator]]{{dot}} [[Mastermind]]{{dot}} [[Scrapper]]{{dot}} [[Sentinel]]{{dot}} [[Stalker]]{{dot}} [[Tanker]]{{dot}} [[Arachnos Soldier]]{{dot}} [[Arachnos Widow]]{{dot}} [[Peacebringer]]{{dot}} [[Warshade]]
}}

{{navbox|
| name  = Navbox/doc
| title = [[Issues|Issue Releases]]

| group1 = [[Cryptic Studios]]
| list1  = [[Issue 1]]{{dot}} [[Issue 2]]{{dot}} [[Issue 3]]{{dot}} [[Issue 4]]{{dot}} [[Issue 5]]{{dot}} [[Issue 6]]{{dot}} [[Issue 7]]{{dot}} [[Issue 8]]{{dot}} [[Issue 9]]{{dot}} [[Issue 10]]

| group2 = [[Paragon Studios]]
| list2  = [[Issue 11]]{{dot}} [[Issue 12]]{{dot}} [[Issue 13]]{{dot}} [[Issue 14]]{{dot}} [[Issue 15]]{{dot}} [[Issue 16]]{{dot}} [[Issue 17]]{{dot}} [[Issue 18]]{{dot}} [[Issue 19]]{{dot}} [[Strike Pack|Issue 19.5]]{{dot}} [[Issue 20]]{{dot}} [[Incarnates Ascend|Issue 20.5]]{{dot}} [[Issue 21]]{{dot}} [[Media Blitz|Issue 21.5]]{{dot}} [[Issue 22]]{{dot}} [[Issue 23]]{{dot}} [[Issue 24]]{{dot}} [[Issue 25 (Paragon Studios)]]

| group3 = [[Homecoming Team]]
| list3  = [[Issue 25]]{{dot}} [[Issue 26]]{{dot}} [[Issue 27]]

}}

Technical details


Retrieved from "http://wiki.homecomingservers.com/w/index.php?title=Template:Navbox/doc&oldid=308616"