View source for Template:Navbox/doc/standard

<noinclude>{{Documentationpage|type=standard}}</noinclude>
This is a [[:Category:Navbox templates|navbox]], a grouping of links used in multiple related articles to facilitate navigation between those articles. 

Based on {{tl|Navbox}}.

==Usage==
===Displaying the navbox===
Insert the following at the bottom of the article to display the navbox:
{{pre fake|<nowiki>{{</nowiki>{{BASEPAGENAME}}<nowiki>}}</nowiki>}}

===Editing the navbox===
The most frequently used parameters for editing the navbox are listed below. For full documentation, please see {{tl|Navbox}}.

{{Docparam|name=<unnamed 1>|req=yes|default=|desc=
This parameter should always be set to <nowiki>{{{1|}}}</nowiki> (see the example under "Usage"). It allows the layout of the navbox to be changed so it fits inside another navbox, if the parameter is set to "nested" from within the other navbox.
}}

{{Docparam|name=blockA >> blockH|req=no|default=|desc=
Content of block cells. <code>blockA</code> appears left of the <code>groupA</code> parameters and so forth. If no <code>group</code> or <code>content</code> fields in this block have been specified, the block is not displayed either.
}}

{{Docparam|name=contentA1 >> contentH8|req=no|default=|desc=
Lists of links. Make sure that links point directly to the intended pages (i.e. not to redirects) so the current page is properly marked in the template. It is recommended to sort links in each cell alphabetically for reader convenience.

For standard (horizontal) rows, separate individual links with {{tl|dot}}. For columns, use [[Help:Formatting|unnumbered lists]] (inserted with <code><nowiki>*</nowiki></code>).
}}

{{Docparam|name=editlink|req=semi|default=|desc=
The name of the template page; used to generate the "view"/"edit"/"discuss" links. You can use <nowiki>{{subst:PAGENAME}}</nowiki> when creating the template. If no editlink is specified, the "view"/"edit"/"discuss" links will not be displayed.
}}

{{Docparam|name=footer|req=no|default=|desc=
Text of the footer, i.e. a row at the very bottom of the navbox.
}}

{{Docparam|name=groupA1 >> groupH8|req=no|default=|desc=
Content of group cells. <code>groupA1</code> appears to the left of <code>contentA1</code> (or above it when in column mode) and so forth. If a <code>group</code> field has been specified, the corresponding <code>content</code> becomes mandatory. For example, if <code>groupD3</code> has been set, you need to set <code>contentD3</code> as well.
}}

{{Docparam|name=headerA >> headerH|req=no|default=|desc=
Content of header rows. <code>headerA</code> appears above <code>contentA1</code>, <code>headerB</code> appears above <code>contentB1</code> and so forth. If the block is collapsible, this becomes mandatory as it is the text which remains visible when collapsed.
}}

{{Docparam|name=image ++ imageleft|req=no|default=|desc=
Allows to specify images which should be displayed to the right (<code>image</code>) or left (<code>imageleft</code>) of the whole navbox content. Simply enter the file name without "File:". If the blocks in the navbox are collapsible, these images will remain visible even if all blocks are collapsed (but will not be visible if the navbox itself is collapsed). Be careful not to make the images too large or you risk visual oddities.
}}

{{Docparam|name=options|req=no|default=|desc=
This parameter allows to specify options which apply to the navbox itself or all blocks inside. Multiple options can be specified at once; simply separate them with commas (<code>,</code>).

Commonly used choices:
* ''collapsiblegroups'': This makes all blocks within the navbox collapsible and collapsed on page load. Can be overriden for individual blocks by setting the block-specific <code>option</code> parameter (see below) to "uncollapsed".
* ''columns'': This turns all blocks into column-type blocks, i.e. blocks where the links are listed from top to bottom instead of from left to right.
* ''uncollapsedgroups'': This makes all block within the navbox collapsible and uncollapsed on page load. Can be overriden for individual blocks by setting the block-specific <code>option</code> parameter (see below) to "collapsed".
}}

{{Docparam|name=position|req=no|default=bottom|desc=
Intended positioning of the navbox in article pages. Also influences default <code>width</code> and collapse behaviour.

Available options:
*''bottom'': The navbox is supposed to be put at the end of articles; full width, collapses.
*''left'': The navbox is supposed to be put on the left side of articles with text flowing around it; thin navbox, not collapsible.
*''right'': The navbox is supposed to be put on the right side of articles with text flowing around it; thin navbox, not collapsible.
}}

{{Docparam|name=title|req=yes|default=|desc=
The title or caption of the navbox.
}}