imported>Dawning: 1 revision imported

2025-09-02T23:12:11Z

1 revision imported

← Older revision	Revision as of 23:12, 2 September 2025
(No difference)

imported>Westgrass: 1 revision imported: update ranger

2025-08-23T02:20:28Z

1 revision imported: update ranger

Show changes

imported>RheingoldRiver: Adding default set of pages

2024-06-12T08:41:09Z

Adding default set of pages

New page

{{UsesLua|Navbox}}
This template allows a navigational template to be set up relatively quickly by supplying it with one or more lists of links. Using this template is highly recommended for standardization of navigational templates, and for ease of use.

== Usage ==
Please remove the parameters that are left blank.

<syntaxhighlight lang="wikitext" style="overflow: auto;">{{Navbox
| name = {{subst:PAGENAME}}
| title =
| listclass = hlist
| state = {{{state|}}}

| above =
| image =

| group1 =
| list1 =

| group2 =
| list2 =

| group3 =
| list3 =



| below =
}}
</syntaxhighlight>

== Parameter list ==
{{Navbox
| name = Navbox/doc
| state = uncollapsed
| title = {{{title}}}
| above = {{{above}}}
| image = {{{image}}}
| group1 = {{{group1}}}
| list1 = {{{list1}}}
| group2 = {{{group2}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| list4 = {{{list4}}}
| below = {{{below}}}
}}

The navbox uses lowercase parameter names, as shown in the box (''above''). The required ''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".
{{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.
: <code>title</code> – text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>.
: <code>class</code> - an optional CSS class for the entire navbox, to enable custom styling.
: <code>listclass</code> – a CSS class for the list cells, usually <code>hlist</code> for horizontal lists.
: <code>state</code> – controls when a navbox is expanded or collapsed.
: <code>above</code> – text to appear above the group/list section (could be a list of overall wikilinks).
: <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>imageleft</code> – an optional left-side image (code the same as the "image" parameter).
: <code>groupn</code> – the left-side text before list-n (if group-n omitted, list-n starts at left of box).
: <code>listn</code> – text listing wikilinks using a [[wikipedia:Help:Lists|wikilist]] format.
: <code>below</code> – optional text to appear below the group/list section.

== Parameter descriptions ==
The following is a complete list of parameters for using {{tlx|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>.

=== Setup parameters ===
:; ''name''
:: The name of the template, which is needed for the "V • T • E" ("View • Talk • 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, and the <code>navbar</code> parameter is not used to disable the navbar.
:; ''state'' [<code>autocollapse, collapsed, expanded, plain, off</code>]
:* 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.
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>expanded</code>, the navbox will always start out in an expanded 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 V • T • E 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.
: To show the box when standalone (non-included) but then auto-hide contents when in an article, put "expanded" inside <code><noinclude|></code>...<code></noinclude|></code> tags. This setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article:
:: <code><nowiki>| state = </nowiki></code><code><noinclude|></code>expanded<code></noinclude|></code>
: 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 <code><includeonly></code><code>|</code> will make the template expanded when viewing the template page by itself.
:; ''navbar''
:: If set to <code>plain</code>, the V • T • E links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the V • T • E links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.

: ''See later section on [[#Child navboxes|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):
:<pre>{{Navbox|child|...}}</pre>

=== Cells ===
; ''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>{{-}}</nowiki></code> to ensure proper centering. This parameter is technically not mandatory, but using {{tl|Navbox}} is rather pointless without a title.
; ''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.
; ''groupn''*
: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header cell displayed to the left of ''listn''. If omitted, ''listn'' uses the full width of the table.
; ''listn''*
: (i.e. ''list1'', ''list2'', etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <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 ''listn'' may be preceded by a corresponding ''groupn'' parameter, if provided (see below).
:Entries should be separated using a newline and an asterisk (*). If instead two asterisks are used, it provides [[wikipedia:Nesting (computing)|nesting]] within the previous entry by enclosing the entry with brackets. Increasing the number of asterisks used increases the number of brackets around entries.
; ''imageleft''*
: An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, the ''list1'' parameter must be specified and no groups can be specified. It accepts the same sort of parameter that ''image'' accepts.
; ''below''*
: A full-width cell displayed ''below'' the template's body (groups, lists and image).

== Layout of table ==
===Without image, above and below===
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters:

{{Navbox
| name = Navbox/doc
| state = uncollapsed
| title = {{{title}}}
| group1 = {{{group1}}}
| list1 = {{{list1}}}
| group2 = {{{group2}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| list4 = {{{list4}}}
}}

===With image, above and below===
Table generated by {{tl|Navbox}} '''with''' ''image'', ''above'' and ''below'' parameters:

{{Navbox
| name = Navbox/doc
| state = uncollapsed
| image = {{{image}}}
| title = {{{title}}}
| above = {{{above}}}
| group1 = {{{group1}}}
| list1 = {{{list1}}}
| group2 = {{{group2}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}} ''without {{{group3}}}''
| group4 = {{{group4}}}
| list4 = {{{list4}}}
| below = {{{below}}}
}}

===With image and without groups===
Table generated by {{tl|Navbox}} '''with''' ''image'', ''imageleft'', ''lists'', and '''without''' ''groups'', ''above'', ''below'':

{{Navbox
| name = Navbox/doc
| state = uncollapsed
| image = {{{image}}}
| imageleft = {{{imageleft}}}
| title = {{{title}}}
| list1 = {{{list1}}}
| list2 = {{{list2}}}
| list3 = {{{list3}}}
| list4 = {{{list4}}}
}}

== Examples ==

== TemplateData ==
<templatedata>
{
"params": {
"state": {
"label": "State",
"description": "Controls when a navbox is expanded or collapsed",
"example": "autocollapse",
"suggestedvalues": [
"autocollapse",
"collapsed",
"expanded",
"plain",
"off"
],
"default": "autocollapse",
"suggested": true
},
"title": {
"label": "Title",
"description": "Text in the title bar; centered in the top row of the table. Usually the template's topic.",
"example": "[[Template:Navbox]]",
"suggested": true
},
"above": {
"label": "Above",
"description": "Full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image)",
"type": "string",
"suggested": true
},
"image": {
"label": "Image",
"description": "Image to be displayed in a cell below the title and to the right of the body",
"example": "[[File:XX.jpg | 80px | link= | alt= ]]",
"type": "wiki-file-name",
"suggested": true
},
"group1": {
"label": "Group 1",
"description": "If specified, text appears in a header cell displayed to the left of list 1. If omitted, list 1 uses the full width of the table.",
"suggested": true
},
"list1": {
"label": "List 1",
"description": "Body of the template; usually a list of links. Format is inline. 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.\nEntries should be separated using a newline and an asterisk. If two asterisks are used, it provides nesting within the previous entry with brackets.",
"required": true,
"suggested": true
},
"group2": {
"suggested": true
},
"list2": {
"suggested": true
},
"list3": {
"suggested": true
},
"group3": {
"suggested": true
},
"group4": {},
"list4": {},
"below": {
"label": "Below",
"description": "Full-width cell displayed below the template's body.",
"suggested": true
},
"imageleft": {
"label": "Image left",
"description": "Image to be displayed in a cell below the title and to the left of the body. For the image to display properly, list1 parameter must be specified and no groups can be specified.",
"example": "[[File:XX.jpg | 80px | link= | alt= ]]",
"type": "wiki-file-name"
},
"name": {
"label": "Name",
"description": "The name of the template. Needed for \"View • Talk • Edit\" links to work properly.",
"type": "string",
"default": "{{subst:PAGENAME}}",
"suggested": true
},
"class": {
"label": "Navbox class",
"description": "CSS class for the navbox.",
"example": "navbox-items",
"type": "string"
},
"listclass": {
"label": "List class",
"description": "CSS class for the list cells, usually hlist for horizontal lists.",
"example": "hlist",
"type": "string"
},
"navbar": {
"label": "Navbar status",
"example": "plain, off",
"type": "string"
},
"border": {
"label": "Border status",
"example": "child, subgroup, none",
"type": "string"
},
"evenodd": {
"suggestedvalues": [
"swap",
"even",
"odd",
"off"
]
}
},
"description": "Creates a navigational box for links to other pages.",
"paramOrder": [
"name",
"title",
"class",
"group1",
"list1",
"listclass",
"state",
"above",
"below",
"image",
"group2",
"list2",
"group3",
"list3",
"group4",
"list4",
"imageleft",
"navbar",
"border",
"evenodd"
]
}
</templatedata>
<noinclude>[[Category:Template documentation]]</noinclude>

Template:Navbox/doc - Revision history

imported>Dawning: 1 revision imported

imported>Westgrass: 1 revision imported: update ranger

imported>RheingoldRiver: Adding default set of pages