Template:Navbox/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
No edit summary
Ganaram inukshuk (talk | contribs)
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{dochead}}{{wikipedia}}{{lua}}
{{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]].
'''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 ==
== Parameters ==
; <code>name</code> (optional)
: The template's name, needed to create its view/talk/edit links.
; <code>Title</code> (recommended; default <code>Navbox Title</code>)
; <code>Title</code> (recommended; default <code>Navbox Title</code>)
: The title text.
: The title text.
Line 12: Line 9:
: Text for a navbox's header and footer rows, respectively.
: Text for a navbox's header and footer rows, respectively.


; <code>Header N</code> (recommended) and <code>Data N</code> (recommended)
; <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.
: 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>)
; <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.
: 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.


Line 26: Line 23:
; <code>Navbox Type</code> (optional; default <code>Normal</code>)
; <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.
: 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.