Template:Citations
Footnote-style |
| ||||
---|---|---|---|---|---|
Other |
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:Rune equipment). 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.
Syntax
{{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 |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 }}
- 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.
- Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Superscript: It is preferred to use superscript (
<sup>
) to denote variants of items that are already contained in the navbox. - Bullets: Create unordered lists with lines beginning with *.
States
- Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Gadget-autocollapse.js.
- Currently, the autocollapse allocation is 2. This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
- Uncollapsed: Forces the navbox to be displayed.
- Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Gadget-autocollapse.js.
- 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.
- To create sub-groups within
{{Navbox}}
, 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.
{{Navbox |name = |title = |gtitle1 = |group1 = |gtitle2 = |gtype2 = subgroup (mandatory) |group2 = {{Navbox |subgroup = yes (mandatory) |gtitle1 = |group1 = |gtitle2 = |group2 = }} }}
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
{{Navbox}}
, 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).
{{Navbox |state = uncollapsed |name = |gtype1 = subgroup |group1 = {{Navbox |collapsible = yes |state = collapsed |title = |gtitle1 = |group1 = |gtitle2 = |group2 = }} }}
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.
- Use
{{plink}}
to create links with images. - Use
{{plinkp}}
for any case where text is not desired after the link. - Use
{{chatl}}
to link chatheads. - Use
{{Emote link}}
to link emote icons.
- Use
- Avoid using images in the main header of the navbox.
Link and file share the same name
{{plink|Item}}
File name differs from the link
{{plink|Item|pic=File}}
Link and file share the same name, but different text is desired to display
{{plink|Item|txt=Text}}
File name differs from the link and different text is desired to display
{{plink|Item|pic=File|txt=Text}}
Code | Standard syntax |
---|---|
{{plink|Abyssal whip}}
|
[[File:Abyssal whip.png|link=Abyssal whip]] [[Abyssal whip]]
|
{{plink|Granite maul|pic=Abyssal whip}}
|
[[File:Abyssal whip.png|link=Granite maul]] [[Granite maul]]
|
{{plink|Abyssal whip|txt=Whip}}
|
[[File:Abyssal whip.png|link=Abyssal whip]] [[Abyssal whip|Whip]]
|
{{plink|Granite maul|pic=Abyssal whip|txt=Whip}}
|
[[File:Abyssal whip.png|link=Granite maul]] [[Granite maul|Whip]]
|
{{plinkp|Abyssal whip}}
|
[[File:Abyssal whip.png|link=Abyssal whip]]
|
{{plinkp|Granite maul|pic=Abyssal whip}}
|
[[File:Abyssal whip.png|link=Granite maul]]
|
Categorising
Navboxes are useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:Rune equipment transcludes Category:Rune onto every page that uses it.
There are 2 methods of categorising pages with navboxes:
The preferred method is to use {{Ctg}}
. This has the most simple rules but is the easiest to use.
The other method is to use {{Mainonly|rules}}
and provide more complex rules with parser functions. Template:Potions is an example of this:
{{mainonly|{{#ifeq:{{lc:{{#sub:{{PAGENAME}}|-3}}}}|mix|[[Category:Barbarian mixes]]}}}}
This code tells the template to add Category:Barbarian mixes to pages only if their title ends with the string "mix". {{ctg|Barbarian mixes::ifmatches[mix]}}
would not work here, because several pages include the substring "mix" in other locations, and they would be improperly categorised.
Categorisation should only be used on a template for large-scale addition. For small numbers of pages it is simpler to directly add the category to each page.
Examples
To see the following navboxes in action, see Template:Navbox.
{{Navbox |name = |title = |style1 = text-align:center |group1 = }}
{{Navbox |name = |title = |gtitle1 = |group1 = |footer = Centered footer }}
{{Navbox |name = |title = |gtitle1 = |group1 = |fstyle = text-align:right |footer = Right-aligned footer }}
{{Navbox |name = |title = |gtitle1 = Group title 1 |group1 = |gtitle2 = Group title 2 |group2 = |gtitle3 = Group title 3 |group3 = }}
{{Navbox |state = collapsed |name = |title = |style1 = text-align:center |group1 = }}
{{Navbox |state = plain |name = |title = |style1 = text-align:center |group1 = }}
{{Navbox |state = plain |title = |style1 = text-align:center |group1 = }}
{{Navbox |state = uncollapsed |name = |title = |gtitle1 = Level 1 Title 1 |group1 = |gtitle2 = Level 1 Title 2 |group2 = |gtitle3 = Level 1 Title 3 |group3 = |gtitle4 = Level 1 Title 4 |group4 = |gtitle5 = Level 1 Title 5 |gtype5 = subgroup |group5 = {{Navbox |subgroup = yes |gtitle1 = Level 2 Title 1 |group1 = |gtitle2 = Level 2 Title 2 |group2 = |gtitle3 = Level 2 Title 3 |gtype3 = subgroup |group3 = {{Navbox |subgroup = yes |gtitle1 = Level 3 Title 1 |group1 = |gtitle2 = Level 3 Title 2 |group2 = }} |gtitle4 = Level 2 Title 4 |group4 = }} |gtitle6 = Level 1 Title 6 |group6 = |gtitle7 = Level 1 Title 7 |group7 = |fstyle = |footer = }}
Preventing unwanted documentation
The 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:Navbox templates can be suppressed by adding hidecat=yes.