The Petit Planet Wiki

Template:Navbox/doc: Difference between revisions

Browse history interactively

Stevium (talk | contribs)

2 user groups
927 edits
undo
VisualWikitext
Created page with "{{Documentation/Header}} {{CSS|Navbox|Colors}} Base template for all Navboxes. ==Syntax== {|class="article-table" style="width:100%;" |- !Parameter(s) !Usage !style="width:10%;" | Default value(s) |- |{{{name}}} |Should be identical to the template's name without namespace. |{{{name}}} |- |{{{title}}} |Sets the title used at the top of the navbox. |{{{title}}} |- |{{{state}}} |Allows you to change the collapsing state of the table. mw:Manual:Collapsible elements#Commo..."
 
Standardizing parameter naming convention to snake_case
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation/Header}}
{{Documentation/Header}}
{{CSS|Navbox|Colors}}
{{Lua|Navbox}}
Base template for all Navboxes.
{{CSS|Gadget-Navbox}}
Template that creates a standard navigation box.
 
* For full documentation: [https://support.wiki.gg/wiki/RANGER_navboxes RANGER navboxes]
* For the full list of supported parameters: [https://support.wiki.gg/wiki/RANGER_navboxes Template:Navbox]


==Syntax==
==Syntax==
{|class="article-table" style="width:100%;"
<syntaxhighlight lang="wikitext" copy>
|-
{{Navbox
!Parameter(s)
|title =
!Usage
|striped = even
!style="width:10%;" | Default value(s)
|edit_link = off
|-
|group1 =
|{{{name}}}
|list1 =
|Should be identical to the template's name without namespace.
|group2 =  
|{{{name}}}
|list2 =
|-
}}
|{{{title}}}
</syntaxhighlight>
|Sets the title used at the top of the navbox.
|{{{title}}}
|-
|{{{state}}}
|Allows you to change the collapsing state of the table. [[mw:Manual:Collapsible elements#Common.js script (Before 1.18)|More info]]. Collapsed is removed while on pages in the Template namespace, to make editing easier.
|collapsible
|-
|{{{titleclass}}}
|Set the css class used for the title area.
|''None''
|-
|{{{titlestyle}}}
|Allows custom styling for the title area.
|''None''
|-
|{{{bodyclass}}}
|Set the css class used for the body area.
|''None''
|-
|{{{bodystyle}}}
|Allows custom styling for the body area.
|''None''
|-
|{{{groupclass}}}
|Set the css class used for the group area.
|''None''
|-
|{{{groupstyle}}}
|Allows custom styling for the group area.
|''None''
|-
|{{{listclass}}}
|Set the css class used for the list area.
|''None''
|-
|{{{liststyle}}}
|Allows custom styling for the list area.
|''None''
|-
|{{{evenodd}}}
|Can be set to "swap" to reverse the order of styling among lists (starts with even by default).
|''None''
|-
|{{{1}}}
|Can be set to "child" or "subgroup" to use styling intended for nested navboxes.
|''None''
|-
|{{{group1-20}}}
|Adds the heading for the group number specified.
|{{{group1}}} = {{{group1}}}<br />{{{group2-20}}} = ''None''
|-
|{{{list1-20}}}
|Adds text for the list number specified.
|{{{list1}}} = {{{list1}}}<br />{{{list2-20}}} = ''None''
|}


==Sample output==
==Examples==
<pre>
===Multiple subgroups===
{{Example|<nowiki>
{{Navbox
{{Navbox
|name      = Navbox
|title = Items
|title    = Navbox
|striped = even
|bodyclass = hlist
|edit_link = off
|above = Some items are restricted to specific classes; see Classes for more information.
|below = Update 1.2
|below_class = align-right


|group1   = Group 1
|group1 = Consumables
|list1     = List 1
|list1 =
* Health Potion
* Mana Potion


|group2   = Group 2
|group2 = Weapons
|list2    =  
|group2.1 = Swords
  {{Navbox|child
|list2.1 =
  |evenodd = swap
* Wooden Sword
  |group1  = Group 2.1
* Rusted Sword
  |list1  = List 2.1
* Steel Sword
  |group2 = Group 2.2
|group2.2 = Bows
  |list2   = List 2.2
|list2.2 =
  |group3  = Group 2.3
* Shortbow
  |list3  = List 2.3
* Crossbow
  }}
* Longbow
}}
</nowiki>}}


|group3    = Group 3
===Multiple expands/collapses in a single container===
|list3    =
{{Example|<nowiki>
* List 3
* List
* List
}}
</pre>
{{Navbox
{{Navbox
|name      = Navbox
|title = Items
|title    = Navbox
|striped = even
|bodyclass = hlist
|edit_link = off


|group1   = Group 1
|header1 = Consumables
|list1     = List 1
|header1.1 = Potions
|list1.1 =
* Revitalizing Potion
* Teleport Potion
|group1.1.1 = Health
|list1.1.1 =
* Health Potion
* Large Health Potion
* Elixir of Healing
|group1.1.2 = Mana
|list1.1.2 =
* Mana Potion
* Large Mana Potion
* Elixir of Magic
|header1.2 = Scrolls
|list1.2 =
* Scroll of Poison


|group2    = Group 2
|header3 = Weapons
|list2    =  
|state3 = collapsed
  {{Navbox|child
|group3 = Swords
  |evenodd = swap
|list3 =
  |group1  = Group 2.1
* Wooden Sword
  |list1  = List 2.1
* Rusted Sword
  |group2  = Group 2.2
* Steel Sword
  |list2  = List 2.2
|group4 = Bows
  |group3  = Group 2.3
|list4 =
  |list3  = List 2.3
* Shortbow
  }}
* Crossbow
* Longbow
|group5 = Staves
|list5 =
* Basic Staff
* Wizard's Staff
}}
</nowiki>}}


|group3   = Group 3
==Template Data==
|list3     =
<templatedata>
* List 3
{
* List
"params": {
* List
"title": {
}}
"label": "Title",
"description": "Text that appears at the top of the navbox.",
"type": "string",
"suggested": true
},
"striped": {
"label": "Striped",
"description": "Controls if the navbox rows should have zebra striping on even or odd rows, making it easier for users to distinguish two rows apart from each other. If sections are used, each section resets the even/odd counter.",
"example": "on, yes, striped, even, odd, swap",
"type": "string",
"suggested": true
},
"edit_link": {
"label": "Edit link",
"description": "Controls if an edit icon should be displayed at the top-left of the navbox, making it easier for users to interact with the template itself.",
"example": "off, no",
"type": "string",
"default": "on"
},
"state": {
"aliases": [
"collapsible"
],
"label": "State",
"description": "Controls if a navbox should be expanded or collapsed when the page loads. This only affects the whole navbox; if sections are used, they are treated differently.",
"example": "expanded, collapsed, off, no, plain",
"type": "string",
"default": "expanded"
},
"headern": {
"aliases": [
"header1",
"header2",
"header3"
],
"label": "Header n",
"description": "Text that appears at the top of the section, where n is any positive integer.",
"type": "string"
},
"groupn": {
"aliases": [
"group1",
"group2",
"group3"
],
"label": "Group n",
"description": "Text label for a list, which appears on the left on desktop or at the top on mobile, where n is any positive integer.",
"type": "string"
},
"listn": {
"aliases": [
"list1",
"list2",
"list3"
],
"label": "List n",
"description": "A wikitext list, where n is any positive integer.",
"type": "content"
},
"groupn.x": {
"aliases": [
"group1.1",
"group1.2",
"group2.1.1"
],
"label": "Group n.x",
"description": "Text label for sub-lists that appear under groupn, groupn.x, etc.",
"type": "string"
},
"listn.x": {
"aliases": [
"list1.1",
"list1.2",
"list2.1.1"
],
"label": "List n.x",
"description": "Wikitext sub-lists.",
"type": "content"
}
},
"description": "Template that creates a standard navigation box.",
"format": "block",
"paramOrder": [
"title",
"striped",
"edit_link",
"state",
"headern",
"groupn",
"listn",
"groupn.x",
"listn.x"
]
}
</templatedata>
Retrieved from "https://petitplanet.wiki/Template:Navbox/doc"