Template:Navbox/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
ArrowHead294 (talk | contribs)
mNo edit summary
Ganaram inukshuk (talk | contribs)
No edit summary
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{dochead}}
{{dochead|header=metatemplate}}{{wikipedia}}
{{todo|inline=1| Documentation }}
'''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>name</code> '''(required)'''
== Parameters ==
: This argument is required, and it must be equal to the name of the template. For example, on [[Template:Notation navbox]], the value of this argument is <code>Notation navbox</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 ===
* {{modlink}}
* [[: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.
English Wikipedia has an article on:

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; default Navbox Title)
The title text.
Header Row (optional) and Footer Row (optional)
Text for a navbox's header and footer rows, respectively.
Header N (recommended) and Data 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; default false)
Denotes whether the text for a row is another navbox. Setting it to true removes that row's padding so nested navboxes appear without a surrounding space.
Is Collapsible (optional; default true)
Denotes whether the navbox is collapsible.
Is Collapsed (optional; default false)
Denotes whether the displayed navbox is collapsed when the page is loaded.
Navbox Type (optional; default Normal)
Denotes what type the navbox is. Normal is a normal or top-level navbox; Nested denotes a nested navbox, with the same options as the top-level navbox; Subheader denotes 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