Template:Navbox/doc: Difference between revisions
Jump to navigation
Jump to search
initially made the navbox based off of rswiki's navbox due to nesting, but since wikipedia's own navbox supports nesting also, specifying the difference is not needed |
No edit summary |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{dochead}}{{wikipedia | {{dochead|header=metatemplate}}{{wikipedia}} | ||
'''Template:Navbox''' is intended as a meta-template (a template used to construct other templates), used to build {{w|WP:NAV|navigational templates}}. This can be used directly, or by using its corresponding module, [[Module:Navbox]]. | |||
== Parameters == | |||
; <code> | ; <code>Title</code> (recommended; default <code>Navbox Title</code>) | ||
: | : The title text. | ||
; <code>Header Row</code> (optional) and <code>Footer Row</code> (optional) | |||
: Text for a navbox's header and footer rows, respectively. | |||
; <code>Header ''N''</code> (recommended) and <code>Data ''N''</code> (recommended) | |||
: Text for a row's header cell and data cell. A row's header cell may be omitted for simple navboxes. Up to 30 rows are supported using the template. | |||
; <code>Is Data ''N'' Navbox</code> (optional; default <code>false</code>) | |||
: Denotes whether the text for a row is another navbox. Setting it to <code>true</code> removes that row's padding so nested navboxes appear without a surrounding space. | |||
; <code>Is Collapsible</code> (optional; default <code>true</code>) | |||
: Denotes whether the navbox is collapsible. | |||
; <code>Is Collapsed</code> (optional; default <code>false</code>) | |||
: Denotes whether the displayed navbox is collapsed when the page is loaded. | |||
; <code>Navbox Type</code> (optional; default <code>Normal</code>) | |||
: Denotes what type the navbox is. <code>Normal</code> is a normal or top-level navbox; <code>Nested</code> denotes a nested navbox, with the same options as the top-level navbox; <code>Subheader</code> denotes a navbox whose use is to serve as subcategories (sub-rows) for one row. | |||
; <code>name</code> (optional) | |||
: The template's name, needed to create its view/talk/edit links. | |||
=== See also === | === See also === | ||
* [[:Category:Navboxes]] – templates that use this template. | * [[:Category:Navboxes]] – templates that use this template. | ||
Latest revision as of 06:34, 31 October 2025
- This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module Module:Navbox.
- This template invokes the following functions: navbox from Navbox.
Template:Navbox is intended as a meta-template (a template used to construct other templates), used to build navigational templates. This can be used directly, or by using its corresponding module, Module:Navbox.
Parameters
Title(recommended; defaultNavbox Title)- The title text.
Header Row(optional) andFooter Row(optional)- Text for a navbox's header and footer rows, respectively.
Header N(recommended) andData N(recommended)- Text for a row's header cell and data cell. A row's header cell may be omitted for simple navboxes. Up to 30 rows are supported using the template.
Is Data N Navbox(optional; defaultfalse)- Denotes whether the text for a row is another navbox. Setting it to
trueremoves that row's padding so nested navboxes appear without a surrounding space.
Is Collapsible(optional; defaulttrue)- Denotes whether the navbox is collapsible.
Is Collapsed(optional; defaultfalse)- Denotes whether the displayed navbox is collapsed when the page is loaded.
Navbox Type(optional; defaultNormal)- Denotes what type the navbox is.
Normalis a normal or top-level navbox;Nesteddenotes a nested navbox, with the same options as the top-level navbox;Subheaderdenotes a navbox whose use is to serve as subcategories (sub-rows) for one row.
name(optional)- The template's name, needed to create its view/talk/edit links.
See also
- Category:Navboxes – templates that use this template.
