Difference between revisions of "Template:Navbar"

From Polyphasic Sleep Wiki
(Closed)
 
MediaWiki>Shirayuki
(nowrap)
Line 1: Line 1:
<includeonly>{{#invoke:Navbar|navbar}}</includeonly><noinclude>
+
<noinclude>
{{documentation}}
+
<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|}}}">&#91;</span>}}<!--
 +
 
 +
--><span style="white-space:nowrap;word-spacing:-.12em;"><!--
 +
-->[[{{ns:10}}:{{{1}}}|<span style="{{{fontstyle|}}}" title="<translate nowrap><!--T:2--> View this template</translate>"><!--
 +
-->{{#if:{{{mini|}}}|<translate><!--T:3--> v</translate>|<translate><!--T:4--> view</translate>}}</span>]]<!--
 +
 
 +
--><span style="{{{fontstyle|}}}">&#32;<b>&middot;</b>&#32;</span><!--
 +
-->[{{fullurl:{{ns:11}}:{{{1}}}}} <span style="{{{fontstyle|}}}" title="<translate nowrap><!--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|}}}">&#32;<b>&middot;</b>&#32;</span><!--
 +
-->[{{fullurl:{{ns:10}}:{{{1}}}|action=edit}} <span style="{{{fontstyle|}}}" title="<translate nowrap><!--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|}}}">&#93;</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 [[Special:MyLanguage/Help:Templates|template]], it adds navbar navigational functionality:
 +
 
 +
: {{tlx|Navbar|Navbar|mini{{=}}1}}
 +
: {{tlx|Navbar|Navbar|plain{{=}}1}}
 +
: {{tlx|Navbar|Navbar|fontstyle{{=}}color:green}}
 +
 
 +
The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers. For example, {{tlx|Navbar|navbar/doc}} gives:
 +
 
 +
{{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===
 +
 
 +
* {{tlx|Navbar|Template Name}} – the template name is required.
 +
 
 +
===Optional parameters===
 +
 
 +
{{(}}{{!}} class="wikitable"
 +
! Options !! Parameters !! Produces...
 +
{{!}}-
 +
{{!}} Basic {{!}}{{!}} {{tlx|Navbar|Template Name}} {{!}}{{!}} {{navbar|navbar/doc}}
 +
{{!}}-
 +
{{!}} Different text {{!}}{{!}} {{tlx|Navbar|Template Name|text{{=}}This template:}} {{!}}{{!}} {{navbar|navbar/doc|text=This template:}}
 +
{{!}}-
 +
{{!}} Without "This box:" text {{!}}{{!}} {{tlx|Navbar|Template Name|plain{{=}}1}} {{!}}{{!}} {{navbar|navbar/doc|plain=1}}
 +
{{!}}-
 +
{{!}} Short version {{!}}{{!}} {{tlx|Navbar|Template Name|mini{{=}}1}} {{!}}{{!}} {{navbar|navbar/doc|mini=1}}
 +
{{!}}-
 +
{{!}} With a color option {{!}}{{!}} {{tlx|Navbar|Template Name|fontstyle{{=}}color:green}} {{!}}{{!}} {{navbar|navbar/doc|fontstyle=color:green}}
 +
{{!}}-
 +
{{!}} With brackets
 +
{{!}} {{tlx|Navbar|Template Name|brackets{{=}}1}}
 +
{{!}} {{navbar|navbar/doc|brackets=1}}
 +
{{!}}{{)}}
 +
 
 +
===Deprecated parameters===
 +
 
 +
The <code>miniv=1</code>, <code>viewplain=1</code>, <code>nodiv=1</code> and <code>fontcolor=</code> 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 03:45, 20 September 2020


This box: [[Template:{{{1}}}|view]] · [{{fullurl:Template talk:{{{1}}}}} talk] · [{{fullurl:Template:{{{1}}}|action=edit}} edit]

50px Template documentation

Usage

General

When one of the following examples is placed inside a given template, it adds navbar navigational functionality:

{{Navbar|Navbar|mini=1}}
{{Navbar|Navbar|plain=1}}
{{Navbar|Navbar|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, {{Navbar|navbar/doc}} gives:

This box: view · talk · edit

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}} This box: view · talk · edit
Different text {{Navbar|Template Name|text=This template:}} This template: view · talk · edit
Without "This box:" text {{Navbar|Template Name|plain=1}} view · talk · edit
Short version {{Navbar|Template Name|mini=1}} v · d · e
With a color option {{Navbar|Template Name|fontstyle=color:green}} This box: view · talk · edit
With brackets {{Navbar|Template Name|brackets=1}} This box: [view · talk · edit]

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 <div>...</div> in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a <span>...</span> or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements.

Prepackaged

{{Tnavbar-header}}
Positions vTemplate:·dTemplate:·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 vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}
For use in conjunction with Collapsible tables, floats vTemplate:·dTemplate:·e opposite of the [hide]/[show] feature.