Template:Navbox/doc: Difference between revisions
SlyAceZeta (talk | contribs) (remaking documentation, based off of Acepedia's (acecombat.fandom.com/wiki/Template:Navbox), for the new Lua module) |
SlyAceZeta (talk | contribs) (adding category) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
;title: The main title of the navbox |
;title: The main title of the navbox |
||
;template: The name of the template, which will be used to generate [[:Template:Vdelinks|view/discuss/edit links]] |
|||
;state: The <code>state</code> parameter controls the collapsing of the navbox itself. |
;state: The <code>state</code> parameter controls the collapsing of the navbox itself. |
||
:*<code>expanded</code> (default) sets the navbox to be expanded when the page is loaded, but it can then be collapsed by the user. |
:*<code>expanded</code> (default) sets the navbox to be expanded when the page is loaded, but it can then be collapsed by the user. |
||
| Line 21: | Line 22: | ||
<pre><nowiki>{{Navbox |
<pre><nowiki>{{Navbox |
||
| title = |
| title = |
||
| template = |
|||
| state = collapsed |
| state = collapsed |
||
| above = |
| above = |
||
| Line 27: | Line 29: | ||
| list1 = |
| list1 = |
||
| below = |
| below = |
||
}}</nowiki></pre><includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
}}</nowiki></pre><includeonly>[[Category:Templates|{{PAGENAME}}]][[Category:Navbox templates| ]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
Latest revision as of 00:18, 7 April 2022
Description
This template is used as a base for other navbox templates. It invokes Module:Navbox and supports unlimited data sets.
Parameters
More parameters than the ones listed below are supported in the Module; for more information, see Dev Wiki's documentation. The documentation presented here is intended to be simplified for use on Subnautica Wiki.
parametern (for example, headern) allows the use of any number in place of n. For example, the first header will use the parameter header1, the second header2, and so on.
- title
- The main title of the navbox
- template
- The name of the template, which will be used to generate view/discuss/edit links
- state
- The
stateparameter controls the collapsing of the navbox itself.expanded(default) sets the navbox to be expanded when the page is loaded, but it can then be collapsed by the user.collapsedsets the navbox to be collapsed when the page is loaded, but it can then be expanded by the user. This is the standard behavior for navboxes on Subnautica Wiki.plainsets the navbox to be expanded at all times without the ability to collapse it.
- above
- Adds a row that appears above all other rows and below the title
- headern
- Used to add subheaders to the navbox. Headers are hidden by default unless there are any list rows under them.
- groupn
- Contains the group label for a row. If not present, the corresponding list will expand to fill the gap.
- listn
- The actual list for the row
- below
- Adds a row that appears below all other rows
Boilerplate
{{Navbox
| title =
| template =
| state = collapsed
| above =
| header1 =
| group1 =
| list1 =
| below =
}}