Template:Navbox/doc: Difference between revisions

(9 intermediate revisions by the same user not shown)

Line 1:

~~This~~ template ~~allows~~ a {{w|WP:NAV|navigational ~~template~~}} to be ~~set up relatively quickly~~ by ~~supplying it with one or more lists of links~~.

'''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> (~~required~~)

; <code>Title</code> (recommended; default <code>Navbox Title</code>)

: ~~This argument must~~ be ~~equal~~ to the ~~name of~~ the ~~template~~. ~~For example, on [[Template~~:Navbox ~~notation]]~~, the ~~value of this argument~~ is <code>~~Navbox notation~~</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 ===

* [[:Category:Navboxes]] – templates that use this template.

@@ Line 1: / Line 1: @@
-{{dochead}}{{wikipedia}}{{lua}}
+{{dochead|header=metatemplate}}{{wikipedia}}
-This template allows a {{w|WP:NAV|navigational template}} to be set up relatively quickly by supplying it with one or more lists of links.
+'''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> (required)
+; <code>Title</code> (recommended; default <code>Navbox Title</code>)
-: This argument must be equal to the name of the template. For example, on [[Template:Navbox notation]], the value of this argument is <code>Navbox notation</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 ===
 * [[:Category:Navboxes]] – templates that use this template.