imported>AesBot: /* Examples */Old Navbox Sunsetting

2021-06-11T02:46:50Z

Examples: Old Navbox Sunsetting

New page

==Usage==
This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see [[Template:Fire Starting]]). This template should not be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

==Syntax==
<pre>
{{Navbox
|state = uncollapsed, collapsed, plain, autocollapse (default)
|name = mandatory - name of the template
|style = optional - style for the whole table
|title = mandatory - navbox header
|gtitleN = optional - title of N-th group of items
|gNcatP = optional - categories to add to each item in the group
|styleN = optional - style for groupN; i.e. text-align
|groupN = mandatory - list of groups of items
|fstyle = optional - style for footer ; i.e. text-align
|footer = optional - navbox footer
}}
</pre>

* '''Groups:''' Currently there is no technical limit to the maximum number of groups.
** Groups of items can be added as parameters: ''group1'', ''group2'', ''group3'', ... up to ''groupN''.
* '''Group title:''' Each group has its own title parameter: ''gtitle1'', ''gtitle2'', ''gtitle3'', ... up to ''gtitleN''. Note that the default width for the first column is 15%.
* '''Group category:''' Each group can have a category parameter: ''g1cat1'', ''g1cat2'', ''g1cat3'', ... up to ''g1catP''. Each parameter can have multiple category names delimited by comma.
* '''Group style:''' Style may also be customised to each group in: ''style1'', ''style2'', ''style3'', ... up to ''styleN''.
** Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
* '''Line breaks:''' Line-breaks (<code><nowiki><br></nowiki></code>) are '''unnecessary''', as text wrapping is done automatically by the template. This also includes links and text in ''gtitleN'' and ''groupN''.
* '''Bullets:''' Create unordered lists with lines beginning with *. The use of [[Template:*]] is deprecated

==States==
* '''Uncollapsed:''' Forces the navbox to be displayed.
** All of the navboxes in this documentation are in the ''uncollapsed'' state.
* '''Collapsed:''' The reverse of ''uncollapsed''. Forces the navbox to be hidden instead.
* '''Plain:''' Removes the "show/hide" link.

==Sub-groups==
* For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see [[#Collapsible sub-groups|Collapsible sub-groups]].
* To create sub-groups within <code><nowiki>{{Navbox}}</nowiki></code>, certain parameters are to be included:
** The parent navbox group (i.e. ''group2'' in the example below) requires the type parameter (''gtype2 = subgroup'').
** The nested navbox (sub-group) requires the inclusion of the sub-group parameter (''subgroup = yes''). This enables the template to differentiate between the sub-group and the parent navbox.

<pre>{{Navbox
|name =
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|gtype2 = subgroup (mandatory)
|group2 =
{{Navbox
|subgroup = yes (mandatory)
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}</pre>

==Collapsible sub-groups==
* For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
* To create collapsible sub-groups within <code><nowiki>{{Navbox}}</nowiki></code>, these parameters need to be included:
** The parent navbox is almost always uncollapsed (''state=uncollapsed'').
** The parent navbox group (i.e. ''group1'' in the example below) requires the type parameter (''gtype1 = subgroup'').
** The nested collapsible navbox requires the inclusion of the collapsible parameter (''collapsible = yes''). This enables the template to differentiate between the collapsible navbox and the parent navbox.
** The nested collapsible navbox is forcefully collapsed (''state=collapsed'').

<pre>{{Navbox
|state = uncollapsed
|name =
|gtype1 = subgroup
|group1 =
{{Navbox
|collapsible = yes
|state = collapsed
|title =
|gtitle1 =
|group1 =
|gtitle2 =
|group2 =
}}
}}</pre>

==Use of images==
* The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
* Please use {{t|Pic link}} to create links with images. Use {{t|Iconlink}} for any case where the picture is an icon.
<pre>{{Pic link|Item}}</pre>

File name differs from the link
<pre>{{Pic link|Item|pic=File}}</pre>

Link and file share the same name, but different text is desired to display
<pre>{{Pic link|Item|txt=Text}}</pre>

File name differs from the link and different text is desired to display
<pre>{{Pic link|Item|pic=File|txt=Text}}</pre>

==Examples==
{{#ifeq:{{BASEPAGENAME}}|Navbox|{{Navbox
|title = [[Clothing#Legs|Pants]]
|gtitle1 = Inner Layer
|group1 =
* {{Iconlink|Thermal Underwear}}
* {{Iconlink|Wool Longjohns}}
|gtitle2 = Outer Layer
|gtype2 = subgroup
|group2 = {{Navbox
|subgroup = yes
|gtitle1 = Standard
|group1 =
* {{Iconlink|Cargo Pants}}
* {{Iconlink|Combat Pants}}
* {{Iconlink|Jeans}}
* {{Iconlink|Snow Pants}}
* {{Iconlink|Work Pants}}
|gtitle2 = Craftable
|group2 =
* {{Iconlink|Deerskin Pants}}
|gtitle3 = Wintermute
|group3 =
* {{Iconlink|Astrid's Jeans}}
* {{Iconlink|Mackenzie's Pants}}
}}
}}
}}

<pre>{{Navbox
|title = [[Clothing#Legs|Pants]]
|gtitle1 = Inner Layer
|group1 =
* {{Iconlink|Thermal Underwear}}
* {{Iconlink|Wool Longjohns}}
|gtitle2 = Outer Layer
|gtype2 = subgroup
|group2 = {{Navbox
|subgroup = yes
|gtitle1 = Standard
|group1 =
* {{Iconlink|Cargo Pants}}
* {{Iconlink|Combat Pants}}
* {{Iconlink|Jeans}}
* {{Iconlink|Snow Pants}}
* {{Iconlink|Work Pants}}
|gtitle2 = Craftable
|group2 =
* {{Iconlink|Deerskin Pants}}
|gtitle3 = Wintermute
|group3 =
* {{Iconlink|Astrid's Jeans}}
* {{Iconlink|Mackenzie's Pants}}
}}
}}</pre>

==Preventing unwanted documentation==
The [[Template:Navbox/doc|Navbox template's documentation]] is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (''subgroup= yes'' or ''collapsible=yes'').

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter ''doc=no'' on the template. In most cases, the doc parameter is not used and the parameter is removed completely.

On a similar note, the automatically-added category [[:Category:Navigational templates]] can be suppressed by adding ''hidecat=yes''.

<noinclude>[[Category:Navigational templates|*{{PAGENAME}}]]</noinclude>
<includeonly>[[Category:Navigational templates|*]]
{{#ifeq:{{PAGENAME}}|Navbox|[[Category:Lua-based templates]]}}
</includeonly>

Template:Navbox/doc - Revision history

imported>AesBot: /* Examples */Old Navbox Sunsetting