Difference between revisions of "Template:Navigation"

From CDOT Wiki
Jump to: navigation, search
m
m
 
Line 11: Line 11:
 
<!---end_NavFrame:---></div></includeonly><noinclude>
 
<!---end_NavFrame:---></div></includeonly><noinclude>
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 +
{{tlx|{{PAGENAME}}}} is a generic Navigational template.
 +
 +
==Blank syntax (basic)==
 +
<pre>{{Navigation
 +
|title =
 +
|body  =
 +
}}
 +
</pre>
 +
 +
== Parameters ==
 +
 +
===Mandatory===
 +
; ''title'' : 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 contents.
 +
 +
; ''body''  : The material contained by the template, usually a list or list of links. <!--Pipe character not the only way to separate links: "Use &amp;#124; to separate links. It is not possible to directly include a pipe ("|") in the contents as this symbol is used to separate parameters. &amp;#124; or {{tl|!}} can be used in the body to produce a pipe symbol."--> Format is inline.
 +
 +
===Optional===
 +
; ''navbar'' : Whether to include navigation links. Includes when set to yes, otherwise does not.
 +
 +
; ''navtitle'' : What name to use for the navigation links. Defaults to the current page name.
 +
 +
; ''style'' : Any CSS styling to apply to the whole navigation;
 +
 +
; ''titlestyle'' : Any CSS styling to apply to the titlebar; usually a background color (i.e.&nbsp;<code>titlestyle = background:''color''</code>).
 +
 +
; ''bodystyle'' : Any CSS styling to add to the body, e.g. "text-align:center;" to center the body's content in place of its default left alignment.
 +
 +
; ''category''  : The category or categories to which a page transcluding the template will become a member. Place <code><nowiki>&lt;includeonly&gt;</nowiki></code> ...... <code><nowiki>&lt;/includeonly&gt;</nowiki></code> either side of the category or categories to ensure the template itself isn't made a member. Use of this parameter is discouraged; when editing a page on which the template is transcluded, no mention of the category or categories  added by this parameter is apparent.
 +
 +
; ''show''' : Whether to expand the body by default. Expands when set to yes, otherwise not. In the example, below, the third box specifies "show = yes", forcing the third box to expand.
 +
 +
==Example==
 +
===Code===
 +
 +
<pre>
 +
{{Navigation
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
}}
 +
 +
{{Navigation
 +
|navbar = yes
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
}}
 +
 +
{{Navigation
 +
|navbar = yes
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
|show = yes
 +
}}
 +
</pre>
 +
 +
===Result===
 +
{{msg:{{BASEPAGENAME}}
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
}}
 +
 +
{{msg:{{BASEPAGENAME}}
 +
|navbar = yes
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
}}
 +
 +
{{Navigation
 +
|navbar = yes
 +
|title = Countries of Central Asia
 +
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
 +
|show = yes
 +
}}
 +
 +
[[Category:Navigational templates]]
 +
</noinclude>

Latest revision as of 09:52, 5 December 2010

{{Navigation}} is a generic Navigational template.

Blank syntax (basic)

{{Navigation
|title =
|body  =
}}

Parameters

Mandatory

title 
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 contents.
body  
The material contained by the template, usually a list or list of links. Format is inline.

Optional

navbar 
Whether to include navigation links. Includes when set to yes, otherwise does not.
navtitle 
What name to use for the navigation links. Defaults to the current page name.
style 
Any CSS styling to apply to the whole navigation;
titlestyle 
Any CSS styling to apply to the titlebar; usually a background color (i.e. titlestyle = background:color).
bodystyle 
Any CSS styling to add to the body, e.g. "text-align:center;" to center the body's content in place of its default left alignment.
category  
The category or categories to which a page transcluding the template will become a member. Place <includeonly> ...... </includeonly> either side of the category or categories to ensure the template itself isn't made a member. Use of this parameter is discouraged; when editing a page on which the template is transcluded, no mention of the category or categories added by this parameter is apparent.
show' 
Whether to expand the body by default. Expands when set to yes, otherwise not. In the example, below, the third box specifies "show = yes", forcing the third box to expand.

Example

Code

{{Navigation
|title = Countries of Central Asia
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
}}

{{Navigation
|navbar = yes
|title = Countries of Central Asia
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
}}

{{Navigation
|navbar = yes
|title = Countries of Central Asia
|body  = Afghanistan{{·}} Kazakhstan{{·}} Kyrgyzstan{{·}} Mongolia{{·}} Russia{{·}} Tajikistan{{·}} Turkmenistan{{·}} Uzbekistan
|show = yes
}}

Result

Countries of Central Asia

Afghanistan   · Kazakhstan   · Kyrgyzstan   · Mongolia   · Russia   · Tajikistan   · Turkmenistan   · Uzbekistan

v • d • e
Countries of Central Asia

Afghanistan   · Kazakhstan   · Kyrgyzstan   · Mongolia   · Russia   · Tajikistan   · Turkmenistan   · Uzbekistan

v • d • e
Countries of Central Asia

Afghanistan   · Kazakhstan   · Kyrgyzstan   · Mongolia   · Russia   · Tajikistan   · Turkmenistan   · Uzbekistan

Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=Template:Navigation&oldid=51611"