Template:Navbox: Difference between revisions
m (changed class parameter to theme) |
m (changed navbox businesses to locations) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
{{Documentation/sandbox|doc = | {{Documentation/sandbox|doc = | ||
{{Protection|This template is considered '''High Risk''' as it is used on multiple pages.}} | |||
This is a metatemplate used to quickly create a navigational template in a standardized style. | |||
Navboxes are used to provide a convenient way to navigate between related articles. They are not always related to the article directly, but are instead related to the overarching topic. E.g., [[Template:Navbox weapons]], or [[Template:Navbox locations]]. They will usually be placed at the bottom of an article in the "see also" section. | |||
==Usage== | ==Usage== | ||
Line 17: | Line 20: | ||
:Title. | :Title. | ||
;<code>content</code> {{sup|required}} | ;<code>content</code> {{sup|required}} | ||
:Container for the | :Container for the content. {{tll|Navbox/row}} will usually be here. | ||
;<code>id</code> {{sup|required}} | ;<code>id</code> {{sup|required}} | ||
:The unique ID for the navbox. | :The unique ID for the navbox. | ||
Line 28: | Line 31: | ||
;<code>theme</code> | ;<code>theme</code> | ||
:Color of the navbox, can be <code>blue</code> or <code>red</code>. Default is <code>red</code>. | :Color of the navbox, can be <code>blue</code> or <code>red</code>. Default is <code>red</code>. | ||
;<code>collapsed</code> | |||
:Initial state of the content. Will be collapsed by default (<code>true</code>). Set to <code>false</code> to start expanded. | |||
'''''The following are from {{tll|Navbox/row}}.''''' | '''''The following are from {{tll|Navbox/row}}.''''' | ||
Line 38: | Line 43: | ||
{{Navbox | {{Navbox | ||
| title = Example | | title = Example | ||
| collapsed = false | |||
| above = above | | above = above | ||
| below = below | | below = below | ||
| content = {{Navbox | | content = {{Navbox | ||
| title = Sub-title | | title = Sub-title | ||
| collapsed = false | |||
| above = above | | above = above | ||
| content = {{Navbox/row | | content = {{Navbox/row | ||
Line 55: | Line 62: | ||
| id = sub | | id = sub | ||
| image = [[File:Image.png|80px]] | | image = [[File:Image.png|80px]] | ||
| | | theme = blue | ||
}} | }} | ||
| image = [[File:Image.png|100px]] | | image = [[File:Image.png|100px]] | ||
Line 68: | Line 75: | ||
{{ll|Category:Navbox}} | {{ll|Category:Navbox}} | ||
</noinclude><includeonly><div class="navbox theme-{{#switch:{{{theme|}}}|blue=blue|#default=red}}"> | </noinclude><includeonly><div class="navbox theme-{{#switch:{{{theme|}}}|blue=blue|#default=red}}" style="clear: both;"> | ||
<div>{{#if:{{{title|}}}|{{{title}}}|Title}}</div> | <div>{{#if:{{{title|}}}|{{{title}}}|Title}}<!--## Start temporary show/hide ## | ||
<div class="mw-collapsible" id="mw-customcollapsible-navbox-{{{id|[[Category:Incorrect template usage]]}}}"> | --><span class="mw-customtoggle-navbox-{{{id|}}}" title="{{int:show}} / {{int:hide}}" style="float:right; padding-right:30px; padding-top:4px; font-size:0.7em; font-weight:normal;">{{int:show}} / {{int:hide}}</span><!-- | ||
## End temporary show/hide ## --></div> | |||
<div class="mw-collapsible {{yesno|{{{collapsed|yes}}}|yes=mw-collapsed}}" id="mw-customcollapsible-navbox-{{{id|[[Category:Incorrect template usage]]}}}"> | |||
{{#if:{{{above|}}}|<div class="navbox-row">{{{above}}}</div>}} | {{#if:{{{above|}}}|<div class="navbox-row">{{{above}}}</div>}} | ||
<div class="navbox-section"> | <div class="navbox-section"> | ||
Line 78: | Line 87: | ||
{{#if:{{{below|}}}|<div class="navbox-row">{{{below}}}</div>}} | {{#if:{{{below|}}}|<div class="navbox-row">{{{below}}}</div>}} | ||
</div> | </div> | ||
<div class="toggle mw-customtoggle-navbox-{{{id|}}}"></div> | <div class="toggle mw-customtoggle-navbox-{{{id|}}}" title="{{int:show}} / {{int:hide}}"></div> | ||
</div></includeonly> | </div></includeonly> |
Latest revision as of 09:04, 6 March 2024
This is a metatemplate used to quickly create a navigational template in a standardized style.
Navboxes are used to provide a convenient way to navigate between related articles. They are not always related to the article directly, but are instead related to the overarching topic. E.g., Template:Navbox weapons, or Template:Navbox locations. They will usually be placed at the bottom of an article in the "see also" section.
Usage
{{Navbox | title = Example | content = {{Navbox/row | group = group1 | list = list, list, list, list, list, list, list, list, list, list, list, list, }} | id = example }}
Parameters
title
Required- Title.
content
Required- Container for the content.
{{Navbox/row}}
will usually be here. id
Required- The unique ID for the navbox.
image
- Image to be displayed beneath the title and next to the content.
above
- Displayed beneath the title but below the content.
below
- Displayed beneath the content.
theme
- Color of the navbox, can be
blue
orred
. Default isred
. collapsed
- Initial state of the content. Will be collapsed by default (
true
). Set tofalse
to start expanded.
The following are from {{Navbox/row}}
.
group
- Group name. Used from
{{Navbox/row}}
list
- List of articles to be linked to. Usually separated with a bullet point
•
or•
Examples
How to translate
This template doesn't need to/shouldn't be translated, but you can translate the documentation of this template with the following steps:
- Create a subpage of this template with the language code of the language you want to translate to.
- Copy the code wrapped in the
<noinclude>
tag in this template into the page you created.{{Translation guide}}
template should be removed from the translated documentation.
- Translate the page according to the translation requirements of normal pages.