Template:Navbox/doc: Difference between revisions
Jump to navigation
Jump to search
rewrite to match infobox documentation |
No edit summary |
||
| Line 3: | Line 3: | ||
=== Parameters === | === Parameters === | ||
; <code>name</code> ( | ; <code>name</code> (recommended) | ||
: | : The template's name, needed to create its view/talk/edit links. | ||
; <code>Title</code> (recommended) | |||
: 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. | |||
=== See also === | === See also === | ||
* [[:Category:Navboxes]] – templates that use this template. | * [[:Category:Navboxes]] – templates that use this template. | ||
Revision as of 07:55, 10 October 2025
- This template is implemented by the Lua module Module:Navbox.
- This template invokes the following functions: navbox from Navbox.
| This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection. |
| This template uses Lua: |
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
name(recommended)- The template's name, needed to create its view/talk/edit links.
Title(recommended)- 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.
See also
- Category:Navboxes – templates that use this template.
