Difference between revisions of "Template:Navbar"
| Line 24: | Line 24: | ||
--></span></includeonly><noinclude> | --></span></includeonly><noinclude> | ||
</noinclude> | </noinclude> | ||
| + | |||
| + | <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE---> | ||
| + | |||
| + | == Usage == | ||
| + | ===General=== | ||
| + | Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] adds navbar navigational functionality: | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt> | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt> | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt> | ||
| + | |||
| + | The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers. | ||
| + | <nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}} | ||
| + | |||
| + | == Examples == | ||
| + | ===Required parameters=== | ||
| + | *<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required. | ||
| + | |||
| + | ===Optional parameters=== | ||
| + | {| class="wikitable" | ||
| + | ! Options !! Parameters !! Produces... | ||
| + | |- | ||
| + | | Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}} | ||
| + | |- | ||
| + | | Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|navbar/doc|text=This template:}} | ||
| + | |- | ||
| + | | No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}} | ||
| + | |- | ||
| + | | Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}} | ||
| + | |- | ||
| + | | For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}} | ||
| + | |- | ||
| + | | With brackets. | ||
| + | | <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> | ||
| + | | {{navbar|navbar/doc|brackets=1}} | ||
| + | |} | ||
| + | |||
| + | ===Deprecated parameters=== | ||
| + | The <tt>miniv=1</tt>, <tt>viewplain=1</tt>, <tt>nodiv=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. | ||
| + | |||
| + | == Prepackaged == | ||
| + | ;{{tl|Tnavbar-header}}: Positions <small>v{{·}}d{{·}}e</small> on the right edge of the line, often used in non-collapsible navbox heading. | ||
| + | ;{{tl|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe div]]s, positions <small>v{{·}}d{{·}}e</small> opposite of the [hide]/[show] feature. | ||
| + | ;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]],floats <small>v{{·}}d{{·}}e</small> opposite of the [hide]/[show] feature. | ||
Revision as of 11:58, 17 June 2011
Usage
General
Copyable examples when inside a given template adds navbar navigational functionality:
- {{navbar|{{subst:PAGENAME}}|mini=1}}
- {{navbar|{{subst:PAGENAME}}|plain=1}}
- {{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{navbar|navbar/doc}} gives:
Usage
General
Copyable examples when inside a given template adds navbar navigational functionality:
- {{navbar|{{subst:PAGENAME}}|mini=1}}
- {{navbar|{{subst:PAGENAME}}|plain=1}}
- {{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar
Examples
Required parameters
{{navbar|Name of Template}}the template name is required.
Optional parameters
| Options | Parameters | Produces... |
|---|---|---|
| Normal | {{navbar|Template Name}} |
Template loop detected: Template:Navbar |
| Different text | {{navbar|Template Name|text=This template:}} |
Template loop detected: Template:Navbar |
| No "This box:" text. | {{navbar|Template Name|plain=1}} |
Template loop detected: Template:Navbar |
| Short version. | {{navbar|Template Name|mini=1}} |
Template loop detected: Template:Navbar |
| For a color option. | {{navbar|Template Name|fontstyle=color:green}} |
Template loop detected: Template:Navbar |
| With brackets. | {{navbar|Template Name|brackets=1}}
|
Template loop detected: Template:Navbar |
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead.
Prepackaged
- Template:Tl
- Positions vTemplate:·dTemplate:·e on the right edge of the line, often used in non-collapsible navbox heading.
- Template:Tl
- For use in conjunction with Navframe divs, positions vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.
- Template:Tl
- For use in conjunction with Collapsible tables,floats vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.
Examples
Required parameters
{{navbar|Name of Template}}the template name is required.
Optional parameters
| Options | Parameters | Produces... | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Normal | {{navbar|Template Name}} |
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
| |||||||||||||||||||||
| Different text | {{navbar|Template Name|text=This template:}} |
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
| |||||||||||||||||||||
| No "This box:" text. | {{navbar|Template Name|plain=1}} |
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
| |||||||||||||||||||||
| Short version. | {{navbar|Template Name|mini=1}} |
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
| |||||||||||||||||||||
| For a color option. | {{navbar|Template Name|fontstyle=color:green}} |
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
| |||||||||||||||||||||
| With brackets. | {{navbar|Template Name|brackets=1}}
|
UsageGeneralCopyable examples when inside a given template adds navbar navigational functionality:
The ExamplesRequired parameters
Optional parameters
Deprecated parametersThe miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead. Prepackaged
|
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the Template:Tlx or Template:Tlx templates instead.
Prepackaged
- Template:Tl
- Positions vTemplate:·dTemplate:·e on the right edge of the line, often used in non-collapsible navbox heading.
- Template:Tl
- For use in conjunction with Navframe divs, positions vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.
- Template:Tl
- For use in conjunction with Collapsible tables,floats vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.