Difference between revisions of "Template:NavigationBar"
| Line 1: | Line 1: | ||
| − | < | + | <noinclude> |
| − | {{{ | + | <languages/> |
| − | </ | + | </noinclude>{{#switch:<translate></translate> |
| + | | = | ||
| + | <span class="noprint plainlinks navbar" style="{{{style|}}}"><small><!-- | ||
| + | |||
| + | -->{{#if:{{{mini|}}}{{{plain|}}}|<!--nothing-->|<!--else: | ||
| + | --><span style="{{{fontstyle|}}}">{{#if:{{{text|}}}|{{{text}}}|<translate><!--T:1--> This box:</translate>}} </span>}}<!-- | ||
| + | |||
| + | -->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">[</span>}}<!-- | ||
| + | |||
| + | --><span style="white-space:nowrap;word-spacing:-.12em;"><!-- | ||
| + | -->[[{{ns:10}}:{{{1}}}|<span style="{{{fontstyle|}}}" title="<translate><!--T:2--> View this template</translate>"><!-- | ||
| + | -->{{#if:{{{mini|}}}|<translate><!--T:3--> v</translate>|<translate><!--T:4--> view</translate>}}</span>]]<!-- | ||
| + | |||
| + | --><span style="{{{fontstyle|}}}"> <b>·</b> </span><!-- | ||
| + | -->[[{{ns:11}}:{{{1}}}|<span style="{{{fontstyle|}}}" title="<translate><!--T:9--> Discuss this template</translate>"><!-- | ||
| + | -->{{#if:{{{mini|}}}|<translate><!--T:5--> d</translate>|<translate><!--T:6--> talk</translate>}}</span>]]<!-- | ||
| + | |||
| + | -->{{#if:{{{noedit|}}}|<!--nothing-->|<!--else: | ||
| + | --><span style="{{{fontstyle|}}}"> <b>·</b> </span><!-- | ||
| + | -->[{{fullurl:{{ns:10}}:{{{1}}}|action=edit}} <span style="{{{fontstyle|}}}" title="<translate><!--T:10--> Edit this template</translate>"><!-- | ||
| + | -->{{#if:{{{mini|}}}|<translate><!--T:7--> e</translate>|<translate><!--T:8--> edit</translate>}}</span>]}}<!-- | ||
| + | --></span><!-- | ||
| + | |||
| + | -->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">]</span>}}<!-- | ||
| + | |||
| + | --></small></span> | ||
| + | | #default= | ||
| + | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Navbar|noshift=1}} | ||
| + | }}<noinclude> | ||
| + | {{documentation|content= | ||
| + | |||
| + | == Usage == | ||
| + | |||
| + | ===General=== | ||
| + | |||
| + | When one of the following examples is placed inside a given [[Help:templates|template]], it 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. For example, <code><nowiki>{{navbar|navbar/doc}}</nowiki></code> gives:<br> {{navbar|navbar/doc}} | ||
| + | |||
| + | ===Font-size=== | ||
| + | |||
| + | Font-size is 88% when used in a navbar, and 100% when nested in a navbox. | ||
| + | In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold. | ||
| + | |||
| + | == Examples == | ||
| + | |||
| + | ===Required parameters=== | ||
| + | |||
| + | *<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required. | ||
| + | |||
| + | ===Optional parameters=== | ||
| + | |||
| + | <table class="wikitable"> | ||
| + | <tr> | ||
| + | <th>Options</th><th>Parameters</th><th>Produces...</th> | ||
| + | </tr><tr> | ||
| + | <td>Basic</td><td><code><nowiki>{{navbar|Template Name}}</nowiki></code></td><td>{{navbar|navbar/doc}}</td> | ||
| + | </tr><tr> | ||
| + | <td>Different text</td><td><code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code></td><td>{{navbar|navbar/doc|text=This template:}}</td> | ||
| + | </tr><tr> | ||
| + | <td>Without "This box:" text</td><td><code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code></td><td>{{navbar|navbar/doc|plain=1}}</td> | ||
| + | </tr><tr> | ||
| + | <td>Short version</td><td><code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code></td><td>{{navbar|navbar/doc|mini=1}}</td> | ||
| + | </tr><tr> | ||
| + | <td>With a color option</td><td><code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code></td><td>{{navbar|navbar/doc|fontstyle=color:green}}</td> | ||
| + | </tr><tr> | ||
| + | <td>With brackets</td> | ||
| + | <td><code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code></td> | ||
| + | <td>{{navbar|navbar/doc|brackets=1}}</td> | ||
| + | </tr> | ||
| + | </table> | ||
| + | |||
| + | ===Deprecated parameters=== | ||
| + | |||
| + | The <tt>miniv=1</tt>, <tt>viewplain=1</tt>, <tt>nodiv=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. | ||
| + | |||
| + | == Notes == | ||
| + | |||
| + | Navbar is contained within a {{tag|div}} in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a {{tag|span}} or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements. | ||
| + | |||
| + | == 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 divs]], 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. | ||
| + | |||
| + | <!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE ---> | ||
| + | <includeonly> | ||
| + | [[Category:Formatting templates{{#translation:}}]] | ||
| + | </includeonly> | ||
| + | |||
| + | }} | ||
| + | </noinclude> | ||
Revision as of 06:08, 27 April 2019
<languages/>
Template documentationContents
Usage
General
When one of the following examples is placed inside a given template, it adds navbar navigational functionality:
- {{navbar|{{subst:PAGENAME}}|mini=1}}
- {{navbar|{{subst:PAGENAME}}|plain=1}}
- {{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
{{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, {{navbar|navbar/doc}} gives:Font-size
Font-size is 88% when used in a navbar, and 100% when nested in a navbox. In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold.
Examples
Required parameters
{{navbar|Template Name}}– the template name is required.
Optional parameters
| Options | Parameters | Produces... |
|---|---|---|
| Basic | {{navbar|Template Name}} | |
| Different text | {{navbar|Template Name|text=This template:}} | |
| Without "This box:" text | {{navbar|Template Name|plain=1}} | |
| Short version | {{navbar|Template Name|mini=1}} | |
| With a color option | {{navbar|Template Name|fontstyle=color:green}} | |
| With brackets | {{navbar|Template Name|brackets=1}} |
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To implement the view-only version, use the {{v}} or {{view}} templates instead.
Notes
Navbar is contained within a Template:Tag in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a Template:Tag or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements.
Prepackaged
- {{Tnavbar-header}}
- Positions v · d · e on the right edge of the line, often used in non-collapsible navbox heading.
- {{Tnavbar-navframe}}
- For use in conjunction with Navframe divs, positions v · d · e opposite of the [hide]/[show] feature.
- {{Tnavbar-collapsible}}
- For use in conjunction with Collapsible tables, floats v · d · e opposite of the [hide]/[show] feature.
| Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |
