(One intermediate revision by the same user not shown) | |||
Line 596: | Line 596: | ||
Note that using this template on other wikis requires [[Manual:$wgUseTidy|HTML Tidy]] to be turned on. A version that does not require Tidy can be found at [[wikipedia:Wikipedia:WikiProject Transwiki/Template:Navbox|Wikipedia:WikiProject Transwiki/Template:Navbox]]. More detailed information on copying {{tl|Navbox}} to other wikis can be found on this template's [[wikipedia:Template talk:Navbox|talk page on Wikipedia]]. | Note that using this template on other wikis requires [[Manual:$wgUseTidy|HTML Tidy]] to be turned on. A version that does not require Tidy can be found at [[wikipedia:Wikipedia:WikiProject Transwiki/Template:Navbox|Wikipedia:WikiProject Transwiki/Template:Navbox]]. More detailed information on copying {{tl|Navbox}} to other wikis can be found on this template's [[wikipedia:Template talk:Navbox|talk page on Wikipedia]]. | ||
</noinclude> | </noinclude> | ||
+ | |||
+ | [[Category:Templates]] |
This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.
Please remove the parameters that are left blank.
{{Navbox |bodyclass = |name = {{subst:PAGENAME}} |title = |titlestyle = |image = |above = |group1 = |list1 = |group2 = |list2 = ... |group20 = |list20 = |below = }}
{{{Title}}} | ||
---|---|---|
|
The navbox uses lowercase parameter names, as shown in the box (at right). The mandatory 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):
bodyclass -
applies an HTML class
attribute to the entire navbox.name -
the name of the template.title -
text in the title bar, such as: [[Widget stuff]].titleclass -
applies an HTML class
attribute to the title bar.state - autocollapse, uncollapsed, collapsed
: the status of box expansion, where "autocollapse" hides stacked navboxes automatically.titlestyle -
a CSS style for the title-bar, such as: background:gray;
groupstyle -
a CSS style for the group-cells, such as: background:#eee;
image -
an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as [[Image:XX.jpg|90px|link=|alt=]]
.imageleft -
an optional left-side image (code the same as the "image" parameter).above -
text to appear above the group/list section (could be a list of overall wikilinks).groupn -
the left-side text before list-n (if group-n omitted, list-n starts at left of box).listn -
text listing wikilinks, often separated by middot templates, such as: [<font/>[A]]{<font/>{·}}
[<font/>[B]]below -
optional text to appear below the group/list section.Further details, and complex restrictions, are explained below under section Parameter descriptions. See some alternate navbox formats under: Layout of table.
The following is a complete list of parameters for using {{Navbox}}
. In most cases, the only required parameters are name
, title
, and list1
, though child navboxes do not even require those to be set.
{{Navbox}}
shares numerous common parameter names as its sister templates {{Navbox with columns}}
and {{Navbox with collapsible groups}}
for consistency and ease of use. Parameters marked with an asterisk * are common to all three master templates.
{{subst:PAGENAME}}
for this value as a shortcut. The name parameter is only mandatory if a title
is specified, and the border
parameter is not set.autocollapse, uncollapsed, collapsed, plain, off
]autocollapse
. A navbox with autocollapse
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. For the technically minded, see MediaWiki:Common.js.collapsed
, the navbox will always start out in a collapsed state.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 • d • e links).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.autocollapse
, collapsed
, plain
, or off
(such as "uncollapsed"), the navbox will always start out in an expanded state, but have the "hide" button.state =
<noinclude>uncollapsed</noinclude>Tnavbar
. If set to plain
, the v • d • e links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use off
to remove the v • d • 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). Note that it is highly recommended that one does not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.child
or subgroup
, then the navbox can be used as a borderless child that fits snuggly in another navbox. The border is hidden and there is no padding on the sides of the table, so it fits into the list area of its parent navbox. If set to none
, then the border is hidden and padding is removed, and the navbox may be used as a child of another container (do not use the none
option inside of another navbox; similarly, only use the child
/subgroup
option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the named border parameter):
{{Navbox|child
...
{{-}}
to ensure proper centering. This parameter is technically not mandatory, but using {{Navbox}}
is rather pointless without a title.<div> </div>
. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter, if provided (see below).[[Image:XX.jpg|90px|link=|alt=]]
Styles are generally not recommended as to maintain consistency among templates and pages in Wikipedia. However, the option to modify styles is given.
style = background:#nnnnnn;
style = width:N [em/%/px or width:auto];
style = float:[left/right/none];
style = clear:[right/left/both/none];
basestyle = background:lightskyblue;
titlestyle = background:#nnnnnn;
titlestyle = background:name;
groupstyle = background:#nnnnnn;
groupstyle = text-align:[left/center/right];
groupstyle = vertical-align:[top/middle/bottom];
group3style = background:red;color:white;
list5style = background:#ddddff;
listpadding = 0.5em 0em;
(sets 0.5em padding for the left/right, and 0em padding for the top/bottom.)listpadding = 0em;
(removes all list padding.)[swap, even, odd, off]
swap
, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to even
or odd
sets all rows to have that striping color. Setting to off
disables automatic row striping. This advanced parameter should only be used to fix problems when the navbox is being used as a child of another navbox and the stripes do not match up. Examples and a further description can be found in the section on child navboxes below.abovestyle = background:#nnnnnn;
abovestyle = text-align:[left/center/right];
imagestyle = width:5em;
The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple. Most styles are set in MediaWiki:Common.css.
bodystyle = background:#fdfdfd; width:100%; vertical-align:middle;
titlestyle = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;
abovestyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
belowstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
groupstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
liststyle = background:transparent; text-align:left/center;
oddstyle = background:transparent;
evenstyle = background:#f7f7f7;
Since liststyle and oddstyle are transparent odd lists have the color of the bodystyle, which defaults to #fdfdfd (white with a hint of gray). A list has text-align:left;
if it has a group, if not it has text-align:center;
. Since only bodystyle has a vertical-align all the others inherit its vertical-align:middle;
.
{{Navbox}}
; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containing hCard information about a person, for example, add the following parameter:
|bodyclass = vcard
and
|titleclass = fn
or (for example):
|title = The books of <span class="fn">[[Iain Banks]]</span>
...and so forth.
Table generated by {{Navbox}}
without image, above and below parameters (gray list background color added for illustration only):
{{{Title}}} | ||
---|---|---|
|
Table generated by {{Navbox}}
with image, above and below parameters (gray list background color added for illustration only):
{{{Title}}} | ||
---|---|---|
|
Table generated by {{Navbox}}
with image, imageleft, lists, and without groups, above, below (gray list background color added for illustration only):
{{{Title}}} | ||
---|---|---|
|
bodystyle = background:purple;
), then you'll need to make the border-left-color match the background color (i.e. liststyle = border-left-color:purple;
). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.groupstyle = width:10em;
liststyle = width:auto;
style/bodystyle
, then this will not work.style = width:22em;float:right;margin-left:1em;margin-right:0em;
Note that using this template on other wikis requires HTML Tidy to be turned on. A version that does not require Tidy can be found at Wikipedia:WikiProject Transwiki/Template:Navbox. More detailed information on copying {{Navbox}}
to other wikis can be found on this template's talk page on Wikipedia.