Difference between revisions of "Template:Navbar/en"
Jump to navigation
Jump to search
(Updating to match new version of source page) |
(Updating to match new version of source page) |
||
Line 30: | Line 30: | ||
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Navbar|noshift=1}} | {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Navbar|noshift=1}} | ||
}}<noinclude> | }}<noinclude> | ||
− | {{documentation}} | + | {{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> | </noinclude> |
Revision as of 01:22, 18 November 2018
<languages/> Script error: No such module "documentation".[[Category:Template documentation pages{{#translation:}}]]