Misplaced Pages

Template:Navigation/doc: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
< Template:Navigation Browse history interactively← Previous editNext edit →Content deleted Content addedVisualWikitext
Revision as of 21:28, 5 November 2006 editRuud Koot (talk | contribs)31,416 editsm →''Optional'': typo← Previous edit Revision as of 00:35, 7 November 2006 edit undoDavid Kernow (talk | contribs)40,997 edits rephrasing, code examplesNext edit →
Line 5: Line 5:
===Usage=== ===Usage===
<hr/> <hr/>
To apply this template you can start by copy-and-pasting the following code and then provide arguments: To apply this template, you can start by copy-and-pasting the following code and then provide arguments:


====Blank==== ====Blank====
Line 12: Line 12:
| name = {{subst:PAGENAME}} | name = {{subst:PAGENAME}}
| header = | header =
⚫ | body =
| category = <noinclude>]</noinclude> | category = <noinclude>]</noinclude>
| state =
⚫ | body =
}} }}
</pre> </pre>


====Parameters==== ====Parameters====
<hr /> <hr/>
=====''Mandatory''===== =====''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. ; 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.
; header : Text that appears on the top bar; usually, the topic of the template. ; 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.
; body : List(s) of concording articles, inline-format


=====''Optional''===== =====''Optional''=====
; color : Background color of the top bar (use of this parameter is discouraged as it looks unpleant if multiple navigational boxes on a single article use different colors.) ; 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.
; 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. ; state : Defaults to <code>autocollapse</code>. If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
; category : Template categories


===Example=== ===Example===
<hr /> <hr/>
====Code==== ====Code====
<pre> <pre>
Line 36: Line 37:
| name = {{subst:PAGENAME}} | name = {{subst:PAGENAME}}
| header = ] of ] | header = ] of ]
⚫ | body = ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]
| category = ]<noinclude>] ]</noinclude> | category = ]<noinclude>] ]</noinclude>
| state = collapsed
⚫ | body = ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]
}} }}
</pre> </pre>
Line 43: Line 45:
====Result==== ====Result====
{{msg:{{BASEPAGENAME}} {{msg:{{BASEPAGENAME}}
| templateName = Countries of Central Asia | name = Countries of Central Asia
| header = ] of ] | header = ] of ]
| state = collapsed
| body = ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ] | body = ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]
}} }}


===See also=== ===See also===
<hr /> <hr/>
;{{lts|{{BASEPAGENAME}}}}<!-- self-listing for quick access on edit history --> ;{{lts|{{BASEPAGENAME}}}}<!-- self-listing for quick access on edit history -->
:Navigationbox with v-d-e and hide/show; no image yet. :Navigationbox with v-d-e and hide/show; no image yet.

Revision as of 00:35, 7 November 2006

{{Navigation/doc}} is a generic navigational template. The KISS principle was observed.

Usage

To apply this template, you can start by copy-and-pasting the following code and then provide arguments:

Blank

{{Navigation
| name     = {{subst:PAGENAME}}
| header   = 
| category = <noinclude>]</noinclude>
| state    =
| body     = 
}}

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 {{subst:PAGENAME}} for this value as a shortcut.
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.
category
The category or categories to which a page sporting the template will become a member.
state
Defaults to autocollapse. If set to collapsed, the navbox will always start out in a collapsed state.

Example

Code

{{Navigation
| name     = {{subst:PAGENAME}}
| header   = ] of ]
| category = ]<noinclude>] ]</noinclude>
| state    = collapsed
| body     = ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]{{·}} ]
}}

Result

See also

Template:Navigation(edit talk links history)
Navigationbox with v-d-e and hide/show; no image yet.
Template:Navbox generic(edit talk links history)
Navigationbox containing several lists; no v-d-e nor hide/show.
Template:NavigationBox(edit talk links history)
Navigationbox with image on the right; no v-d-e nor hide/show.
Template:Dynamic navigation box(edit talk links history)
Navigationbox with hide/show, but no v-d-e. Allows width to be specified (but that can lead to visual inconsistency).
Template:Dynamic navigation box with image(edit talk links history)
Navigationbox with image on the left and hide/show, but no v-d-e.