3,699
edits
Changes
Template:Navigation Template/doc (view source)
Revision as of 12:22, 5 December 2006
, 12:22, 5 December 2006no edit summary
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<code>{{[[Template:{{PAGENAME}}|{{PAGENAME}}]]}}</code> is a generic [[Wikipedia:Navigational templates|navigational template]].
=== Usage ===
----
To apply this template, you can start by copy-and-pasting the following code and then provide arguments:
==== Blank ====
<pre>{{Navigation
| name = {{subst:PAGENAME}}
| title =
| body =
}}
</pre>
==== Parameters ====
----
===== ''Mandatory'' =====
; name : (or "templateName") The name of the template, which is needed for the "view{{·}} talk{{·}} edit" links to work properly on all of the pages where the template is used on. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut.
; title : (or "header") Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the ''body'' parameter's contents.
; body : The material contained by the template, usually a list or list of links. Format is inline.
===== ''Optional'' =====
; color : Background color of the titlebar. NB Care/consensus needed when using this parameter as multiple navigational templates on one page using different titlebar colors is likely to look unpleasant.
; cat : (or "category") The category or categories to which a page sporting the template will become a member.
<!--; state : Defaults to <code>autocollapse</code>. If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.-->
=== Example ===
----
==== Code ====
<pre>{{Navigation
| name = {{subst:PAGENAME}}
| title = [[Countries of the world|Countries]] of [[Central Asia]]
| cat = [[Category:Central Asian countries]]<noinclude>[[Category:Asian navigational boxes| {{PAGENAME}}]] [[Category:Continental navigation templates|{{PAGENAME}}]]</noinclude>
| body =
[[Afghanistan]]{{·}}
[[Kazakhstan]]{{·}}
[[Kyrgyzstan]]{{·}}
[[Mongolia]]{{·}}
[[Russia]]{{·}}
[[Tajikistan]]{{·}}
[[Turkmenistan]]{{·}}
[[Uzbekistan]]
}}
</pre>
==== Result ====
{{msg:{{BASEPAGENAME}}
| name = Countries of Central Asia
| title = [[Countries of the world|Countries]] of [[Central Asia]]
| body =
[[Afghanistan]]{{·}}
[[Kazakhstan]]{{·}}
[[Kyrgyzstan]]{{·}}
[[Mongolia]]{{·}}
[[Russia]]{{·}}
[[Tajikistan]]{{·}}
[[Turkmenistan]]{{·}}
[[Uzbekistan]]
}}
=== See also ===
----
;{{lts|{{BASEPAGENAME}}}}<!--self-listing for quick access on edit history-->
:Navigationbox with v-d-e and hide/show.
;{{lts|Navigation with image}}
:Navigationbox with v-d-e, hide/show and optional image.
;{{lts|Navbox generic}}
:Navigationbox containing several lists.
;{{lts|NavigationBox}}
:Navigationbox with image on the right; no v-d-e nor hide/show.<br/><small>(Image breaks titlebar; template deprecated? [[User:David Kernow|David Kernow]] <span style="font-size:90%;">[[User talk:David Kernow|(talk)]]</span> 02:23, 29 November 2006 (UTC))</small>
;{{lts|Dynamic navigation box}}
:Navigationbox with hide/show. Allows width to be specified (but that can lead to visual inconsistency).
;{{lts|Dynamic navigation box with image}}
:Navigationbox with image on the left and hide/show, but no v-d-e.
<includeonly>
<!--Categories-->
[[Category:Navigational templates| ]]
</includeonly>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
<code>{{[[Template:{{PAGENAME}}|{{PAGENAME}}]]}}</code> is a generic [[Wikipedia:Navigational templates|navigational template]].
=== Usage ===
----
To apply this template, you can start by copy-and-pasting the following code and then provide arguments:
==== Blank ====
<pre>{{Navigation
| name = {{subst:PAGENAME}}
| title =
| body =
}}
</pre>
==== Parameters ====
----
===== ''Mandatory'' =====
; name : (or "templateName") The name of the template, which is needed for the "view{{·}} talk{{·}} edit" links to work properly on all of the pages where the template is used on. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut.
; title : (or "header") Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the ''body'' parameter's contents.
; body : The material contained by the template, usually a list or list of links. Format is inline.
===== ''Optional'' =====
; color : Background color of the titlebar. NB Care/consensus needed when using this parameter as multiple navigational templates on one page using different titlebar colors is likely to look unpleasant.
; cat : (or "category") The category or categories to which a page sporting the template will become a member.
<!--; state : Defaults to <code>autocollapse</code>. If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.-->
=== Example ===
----
==== Code ====
<pre>{{Navigation
| name = {{subst:PAGENAME}}
| title = [[Countries of the world|Countries]] of [[Central Asia]]
| cat = [[Category:Central Asian countries]]<noinclude>[[Category:Asian navigational boxes| {{PAGENAME}}]] [[Category:Continental navigation templates|{{PAGENAME}}]]</noinclude>
| body =
[[Afghanistan]]{{·}}
[[Kazakhstan]]{{·}}
[[Kyrgyzstan]]{{·}}
[[Mongolia]]{{·}}
[[Russia]]{{·}}
[[Tajikistan]]{{·}}
[[Turkmenistan]]{{·}}
[[Uzbekistan]]
}}
</pre>
==== Result ====
{{msg:{{BASEPAGENAME}}
| name = Countries of Central Asia
| title = [[Countries of the world|Countries]] of [[Central Asia]]
| body =
[[Afghanistan]]{{·}}
[[Kazakhstan]]{{·}}
[[Kyrgyzstan]]{{·}}
[[Mongolia]]{{·}}
[[Russia]]{{·}}
[[Tajikistan]]{{·}}
[[Turkmenistan]]{{·}}
[[Uzbekistan]]
}}
=== See also ===
----
;{{lts|{{BASEPAGENAME}}}}<!--self-listing for quick access on edit history-->
:Navigationbox with v-d-e and hide/show.
;{{lts|Navigation with image}}
:Navigationbox with v-d-e, hide/show and optional image.
;{{lts|Navbox generic}}
:Navigationbox containing several lists.
;{{lts|NavigationBox}}
:Navigationbox with image on the right; no v-d-e nor hide/show.<br/><small>(Image breaks titlebar; template deprecated? [[User:David Kernow|David Kernow]] <span style="font-size:90%;">[[User talk:David Kernow|(talk)]]</span> 02:23, 29 November 2006 (UTC))</small>
;{{lts|Dynamic navigation box}}
:Navigationbox with hide/show. Allows width to be specified (but that can lead to visual inconsistency).
;{{lts|Dynamic navigation box with image}}
:Navigationbox with image on the left and hide/show, but no v-d-e.
<includeonly>
<!--Categories-->
[[Category:Navigational templates| ]]
</includeonly>