Template:Navbox/doc: Difference between revisions
Content added Content deleted
m (→Usage) |
mNo edit summary |
||
Line 1: | Line 1: | ||
{{doc/start}} |
{{doc/start}} |
||
== Usage == |
|||
Meta-template for building navboxes. A navbox is a grouping of links used in multiple related articles to facilitate navigation between those articles. |
|||
Please remove the parameters that are left blank. |
|||
<pre style="overflow: auto;">{{Navbox |
|||
Based on [[wikipedia:Template:Navbox]], see documentation there. |
|||
| name = {{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}} |
|||
| title = |
|||
| listclass = hlist |
|||
| state = {{{state|}}} |
|||
| above = |
|||
==Usage== |
|||
| image = |
|||
Blank template with commonly use options: |
|||
<pre style=display:table> |
|||
| group1 = |
|||
{{Navbox |
|||
| list1 = |
|||
| name = Navbox/doc |
|||
| state = uncollapsed |
|||
| |
| group2 = |
||
| |
| list2 = |
||
<!-- ... --> |
|||
| list1 = List1 |
|||
| |
| group20 = |
||
| |
| list20 = |
||
| group3 = Group3 |
|||
| |
| below = |
||
| group4 = Group4 |
|||
| list4 = List4 |
|||
}} |
}} |
||
</pre> |
</pre> |
||
== Parameter list == |
|||
==Parameters== |
|||
{{Navbox |
|||
; name: Template name. |
|||
| name = Navbox/doc |
|||
; title: text in the title bar. |
|||
| state = uncollapsed |
|||
; state: controls when a navbox is expanded or collapsed. (use "mw-collapsed" to set the navbox to collapsed) |
|||
| title = {{{title}}} |
|||
; above/below: optional text to appear above or below the group/list section. |
|||
| above = {{{above}}} |
|||
; group(n): |
|||
| image = {{{image}}} |
|||
; listn(n): |
|||
| group1 = {{{group1}}} |
|||
| list1 = {{{list1}}} |
|||
| group2 = {{{group2}}} |
|||
| list2 = {{{list2}}} |
|||
| list3 = {{{list3}}} ''without {{{group3}}}'' |
|||
| group4 = {{{group4}}} |
|||
| list4 = {{{list4}}} |
|||
| below = {{{below}}} |
|||
}} |
|||
The navbox uses lowercase parameter names, as shown in the box (''above''). The required ''name'' and ''title'' will create a one-line box if other parameters are omitted. |
|||
==Styles== |
|||
Styles are generally advised against, to maintain consistency among templates([[MediaWiki:Hydradark.css]] should be used instead or applied general here); but the option to modify styles parameters are given given below, for specific customization or testing purposes: |
|||
Notice "group1" (etc.) is optional, as are sections named "above/below". |
|||
{{cols|3| |
|||
{{clear}} |
|||
*style |
|||
The basic and most common parameters are as follows (see [[#Parameter descriptions|below]] for the full list): |
|||
*basestyle |
|||
*titlestylex |
|||
: <code>name</code> – the name of the template. |
|||
*groupstyle |
|||
: <code>title</code> – text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>. |
|||
*groupnstyle |
|||
: <code>listclass</code> – a CSS class for the list cells, usually <code>hlist</code> for horizontal lists. Alternatively, use bodyclass for the whole box. |
|||
*liststyle |
|||
: <code>state</code> – controls when a navbox is expanded or collapsed. |
|||
*listnstyle |
|||
: <code>titlestyle</code> – a CSS style for the title-bar, such as: <code>background: gray;</code> |
|||
*listpadding |
|||
: <code>groupstyle</code> – a CSS style for the group-cells, such as: <code>background: #eee;</code> |
|||
*oddstyle |
|||
: <code>above</code> – text to appear above the group/list section (could be a list of overall wikilinks). |
|||
*evenstyle |
|||
: <code>image</code> – an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>. |
|||
*abovestyle |
|||
: <code>imageleft</code> – an optional left-side image (code the same as the "image" parameter). |
|||
*belowstyle |
|||
: <code>group<sub>n</sub></code> – the left-side text before list-n (if group-n omitted, list-n starts at left of box). |
|||
*imagestyle |
|||
: <code>list<sub>n</sub></code> – text listing wikilinks using a [[wikipedia:Help:Lists|wikilist]] format. |
|||
*imageleftstyle |
|||
: <code>below</code> – optional text to appear below the group/list section. |
|||
}} |
|||
== Parameter descriptions == |
|||
The following is a complete list of parameters for using {{tlx|Navbox}}. In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>. |
|||
=== Setup parameters === |
|||
:; ''name'' |
|||
:: The name of the template, which is needed for the "V • T • E" ("View • Talk • Edit") links to work properly on all pages where the template is used. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut. The name parameter is only mandatory if a <code>title</code> is specified, and the <code>border</code> parameter is not set, and the <code>navbar</code> parameter is not used to disable the navbar. |
|||
:; ''state'' <span style="font-weight:normal;">[<code>autocollapse, collapsed, expanded, plain, off</code>]</span> |
|||
:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. |
|||
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state. |
|||
:* If set to <code>expanded</code>, the navbox will always start out in an expanded state. |
|||
:* If set to <code>plain</code>, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the <small>V • T • E</small> links). |
|||
:* If set to <code>off</code>, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden. |
|||
: To show the box when standalone (non-included) but then auto-hide contents when in an article, put "expanded" inside <code><noinclude|></code>...<code></noinclude|></code> tags. This setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article: |
|||
:: <code><nowiki>| state = </nowiki></code><code><noinclude|></code>expanded<code></noinclude|></code> |
|||
: Often times, editors will want a default initial state for a navbox, which may be overridden in an article. Here is the trick to do this: |
|||
:* In your intermediate template, create a parameter also named "state" as a pass-through like this: |
|||
:: <code><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></code> |
|||
:* The <code><includeonly></code><code>|</code> will make the template expanded when viewing the template page by itself. |
|||
:; ''navbar'' |
|||
:: If set to <code>plain</code>, the <span style="font-size: 88%;">V • T • E</span> links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the <span style="font-size: 88%;">V • T • E</span> links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages. |
|||
:; ''border'' |
|||
{{doc/end}} |
{{doc/end}} |
Revision as of 23:49, 12 December 2019
Usage
Please remove the parameters that are left blank.
{{Navbox | name = {{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}} | title = | listclass = hlist | state = {{{state|}}} | above = | image = | group1 = | list1 = | group2 = | list2 = <!-- ... --> | group20 = | list20 = | below = }}
Parameter list
|
The navbox uses lowercase parameter names, as shown in the box (above). The required name and title will create a one-line box if other parameters are omitted.
Notice "group1" (etc.) is optional, as are sections named "above/below".
The basic and most common parameters are as follows (see below for the full list):
name
– the name of the template.title
– text in the title bar, such as: [[Widget stuff]].listclass
– a CSS class for the list cells, usuallyhlist
for horizontal lists. Alternatively, use bodyclass for the whole box.state
– controls when a navbox is expanded or collapsed.titlestyle
– a CSS style for the title-bar, such as:background: gray;
groupstyle
– a CSS style for the group-cells, such as:background: #eee;
above
– text to appear above the group/list section (could be a list of overall wikilinks).image
– an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as[[File:XX.jpg|80px|link=|alt=]]
.imageleft
– an optional left-side image (code the same as the "image" parameter).groupn
– the left-side text before list-n (if group-n omitted, list-n starts at left of box).listn
– text listing wikilinks using a wikilist format.below
– optional text to appear below the group/list section.
Parameter descriptions
The following is a complete list of parameters for using {{Navbox}}
. In most cases, the only required parameters are name
, title
, and list1
.
Setup parameters
- name
- The name of the template, which is needed for the "V • T • E" ("View • Talk • Edit") links to work properly on all pages where the template is used. You can enter
{{subst:PAGENAME}}
for this value as a shortcut. The name parameter is only mandatory if atitle
is specified, and theborder
parameter is not set, and thenavbar
parameter is not used to disable the navbar. - state [
autocollapse, collapsed, expanded, plain, off
]
- Defaults to
autocollapse
. A navbox withautocollapse
will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. - If set to
collapsed
, the navbox will always start out in a collapsed state. - If set to
expanded
, the navbox will always start out in an expanded state. - If set to
plain
, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the V • T • E links). - If set to
off
, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
- To show the box when standalone (non-included) but then auto-hide contents when in an article, put "expanded" inside
<noinclude|>
...</noinclude|>
tags. This setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article:| state =
<noinclude|>
expanded</noinclude|>
- Often times, editors will want a default initial state for a navbox, which may be overridden in an article. Here is the trick to do this:
- In your intermediate template, create a parameter also named "state" as a pass-through like this:
| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}
- The
<includeonly>
|
will make the template expanded when viewing the template page by itself.
- navbar
- If set to
plain
, the V • T • E links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Useoff
to remove the V • T • E links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages. - border