×
Create a new article
Write your page title here:
We currently have 2,525 articles on Polcompball Wiki. Type your article name above or click on one of the titles below and start writing!



Polcompball Wiki

Template:Navbox/doc: Difference between revisions

(leave -> left)
No edit summary
Line 1: Line 1:
{{documentation subpage}}
<includeonly>{{Intricate template}}</includeonly>
This template allows a [[Wikipedia:Navigational templates|navigational template]] to be set up relatively quickly by supplying it one or more lists of links. It is similar to {{Tl|Navbox generic}} in appearance, with some default styles that should work for most navigational templates. It is not recommended that one modifies the default styles but it is possible if one wishes to do so.
== Usage ==
Please remove the parameters that are left blank.
<pre>{{Navbox
|name    = {{subst:PAGENAME}}
|state  =
|title  =
|image  =
|above  =
|group1  =
|list1  =
|group2  =
|list2  =
...
|group20 =
|list20  =
|below  =
}}</pre>
==Parameters==
===Mandatory===
:; ''name''
:: The name of the template, which is needed for the "v{{·}} d{{·}} e" ("view{{·}} discuss{{·}} 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.
:; ''title''
:: Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use <code><nowiki>{{-}}</nowiki></code> to ensure proper centering.
: '''''list<sub>n</sub>''''' ('''''body''''' may be used in place of '''''list1''''') 
::  (i.e. ''list1'', ''list2'', etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <code><nowiki><div> </div></nowiki></code>.  At least one ''list'' parameter is required; each additional ''list'' is displayed in a separate row of the table. Each ''list<sub>n</sub>'' may be preceded by a corresponding ''group<sub>n</sub>'' parameter, if provided (see below).
===Optional===
====Cells====
:; ''group<sub>n</sub>''
:: (i.e. ''group1'', ''group2'', etc.) If specified, text appears in a header cell displayed to the left of ''list<sub>n</sub>''. If omitted, ''list<sub>n</sub>'' uses the full width of the table.
:; ''image''
:: An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the ''list1'' parameter must be specified. The ''image'' parameter accepts standard wikicode for displaying an image, i.e.
::: <code><nowiki>[[Image:Example.jpg|100px]]</nowiki><code>
:; ''imageleft''
:: An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, the ''list1'' parameter must be specified and no groups can be specified. The ''imageleft'' parameter accepts standard wikicode for displaying an image, i.e.
::: <code><nowiki>[[Image:Example.jpg|100px]]</nowiki><code>
:; ''above''
:: A full-width cell displayed between the titlebar and first group/list, i.e. ''above'' the template's body (groups, lists and image). In a template without an image, ''above'' behaves in the same way as the ''list1'' parameter without the ''group1'' parameter.
:; ''below''
:: A full-width cell displayed ''below'' the template's body (groups, lists and image). In a template without an image, ''below'' behaves in the same way as the template's final ''list<sub>n</sub>'' parameter without a ''group<sub>n</sub>'' parameter. For an example of the ''below'' parameter in use, see {{tl|Lists of the provinces and territories of Canada}}.
====Styles (NOT RECOMMENDED)====
Styles are not recommended as to maintain consistency among templates and pages in Wikipedia.  However, the option to modify styles is given in case it is necessary.
:; ''titlestyle''
:: [[Cascading Style Sheets|CSS]] styles to apply to ''title'', most often the titlebar's background color:
::: <code><nowiki>titlestyle = background:</nowiki>''#nnnnnn'';</code>
::: <code><nowiki>titlestyle = background:</nowiki>''name'';</code>
:; ''bodystyle''
:: Specifies [[Cascading Style Sheets|CSS]] styles to apply to the template body. The shorter name ''style'' may be used when no other style parameters are specified. This option should be used sparingly as it can lead to visual inconsistencies. Examples:
::: <code>background:#''nnnnnn'';</code>
::: <code>width:''N''&nbsp;[em/%/px or width:auto];</code>
::: <code>float:[''left/right/none''];</code>
::: <code>clear:[''right/left/both/none''];</code>
:; ''groupstyle''
:: CSS styles to apply to the ''groupN'' cells. This option overrides any styles that are applied to the entire table. Examples:
::: <code>background:#''nnnnnn'';</code>
::: <code>text-align:[''left/center/right''];</code>
::: <code>vertical-align:[''top/middle/bottom''];</code>
:; ''liststyle''
:: CSS styles to apply to all lists. Overruled by the ''oddstyle'' and ''evenstyle'' parameters (if specified) below.
:; ''oddstyle''
:; ''evenstyle''
::Applies to odd/even list numbers.  Overrules styles defined by ''liststyle''.  The default behavior is to add striped colors (white and gray) to odd/even rows, respectively, in order to improve readability.  These should not be changed except in extraordinary circumstances.
:; ''abovestyle''
:; ''belowstyle''
:: CSS styles to apply to the top cell (specified via the ''above'' parameter) and bottom cell (specified via the ''below'' parameter). Typically used to set background color or text alignment:
::: <code>background:#''nnnnnn'';</code>
::: <code>text-align:[''left/center/right''];</code>
===== Default styles =====
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.
:<code>titlestyle  = background:#ccccff;</code>
:<code>bodystyle    = background:white; width:100%; vertical-align:middle;</code>
:<code>abovestyle  = background:#ddddff; text-align:center;</code>
:<code>belowstyle  = background:#ddddff; text-align:center;</code>
:<code>groupstyle  = background:#ddddff; text-align:right;</code>
:<code>liststyle    = background:transparent; text-align:left/center;</code>
:<code>oddstyle    = background:transparent;</code>
:<code>evenstyle    = background:#f7f7f7;</code>
Since ''liststyle'' and ''oddstyle'' are transparent odd lists have the color of the ''bodystyle'', which defaults to white. A list has <code>text-align:left;</code> if it has a group, if not it has <code>text-align:center;</code>. Since only ''bodystyle'' has a vertical-align all the others inherit its <code>vertical-align:middle;</code>.
====Other====
:; ''state''
:: Defaults to <code>autocollapse</code>. If set to <code>collapsed</code>, the navbox will always start out in a collapsed state. If set to blank or anything other than <code>autocollapse</code> or <code>collapsed</code>, the navbox will always start out in an expanded state. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use <tt>collapsible</tt>. For the technically minded, see [[MediaWiki:Common.js]].
:: Often times, editors will want a default initial state for a nav box, 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
::<tt><nowiki>| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}</nowiki></tt>
::Example: {{tl|peso}} with autocollapse as the default initial state. [[Bolivian peso]] transcludes it and has only one nav box. So the peso nav box shows. [[Chilean peso]] has two nav boxes. So the peso nav box collapses.
::Example: {{tl|Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.
::The <nowiki><includeonly>|</nowiki> will make the template expanded when viewing the template page by itself.
:; ''navbar''
:: Defaults to <code>Tnavbar</code>. If set to <code>plain</code>, the {{Tnavbar|Navbox|mini=1}} links on the left side of the titlebar will not be displayed.
== Layout of table ==
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters (borders added for illustration only):
{{Navbox
|name = Navbox/doc
|state = uncollapsed
|groupstyle = border-style:inset; border-width:2px;
|liststyle = border-style:inset; border-width:2px;
|titlestyle = border-style:inset; border-width:2px;
|title = {{{title}}}
|group1 = {{{group1}}}
|list1 = {{{list1}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''without {{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
}}




Line 165: Line 22:
|below = {{{below}}}
|below = {{{below}}}
}}
}}
Table generated by {{tl|Navbox}} '''with''' ''image'', ''imageleft'', ''lists'', and '''without''' ''groups'', ''above'', ''below'':
{{Navbox
|name = Navbox/doc
|state = uncollapsed
|liststyle = border-style:inset; border-width:2px;
|titlestyle = border-style:inset; border-width:2px;
|image = {{{image}}}
|imageleft = {{{imageleft}}}
|title = {{{title}}}
|list1 = {{{list1}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}}
|list4 = {{{list4}}}
}}
== Examples ==
=== No image ===
<pre>
{{Navbox
|name  = Navbox/doc
|title  = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]] 
}}
</pre>
{{Navbox
|name  = Navbox/doc
|state  = uncollapsed
|title  = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]] 
}}
=== With image, without groups ===
<pre>
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|list1  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
}}
</pre>
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|list1  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
}}
=== With two images, without groups, multiple lists ===
<pre>
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|imageleft = [[Image:Flag of Malaysia.svg|80px]]
|list1  = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]
|list2  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|list3  = [[EGovernment]]{{·}} [[MyKad]]
|list4  = [[Klang Valley]]
}}
</pre>
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|imageleft = [[Image:Flag of Malaysia.svg|80px]]
|list1  = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]
|list2  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|list3  = [[EGovernment]]{{·}} [[MyKad]]
|list4  = [[Klang Valley]]
}}
=== With image, groups, above, below ===
<pre>
{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|above = Above text goes here
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]]
|below  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}
</pre>
{{Navbox
|name  = Navbox/doc
|state = uncollapsed
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|above = Above text goes here
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}}
[[Kuala Lumpur Tower]]{{·}}
[[Kuala Lumpur Sentral]]{{·}}
[[Technology Park Malaysia]]{{·}}
[[Putrajaya]]{{·}}
[[Cyberjaya]]{{·}}
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]]
|below  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}
== See also ==
* {{tn|·}} and {{tn|•}} - The dots and bullets usually used in the link lists in the navboxes.
* {{tl|Navbox generic subgroup}} - Allows the creation of subgroups within {{tl|Navbox}}.
{{Navigational templates}}
<includeonly>
<!--Categories-->
[[Category:Navigational templates| ]]
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]
<!--Other languages-->
[[sl:Predloga:Navpolje]]
</includeonly>

Revision as of 16:52, 5 November 2007


Table generated by Template:Tl with image, above and below parameters (borders added for illustration only):