This site is the archived OWASP Foundation Wiki and is no longer accepting Account Requests.
To view the new OWASP Foundation website, please visit https://owasp.org
Difference between revisions of "Template:Navbar"
Chris White (talk | contribs) (Created page with "<span class="noprint plainlinks navbar" style="{{{style|}}}"><!-- -->{{#if:{{{mini|}}}{{{plain|}}}|<!--nothing-->|<!--else: --><span style="{{{fontstyle|}}}">{{{text|This box...") |
(Including documentation from MediaWiki) |
||
| Line 1: | Line 1: | ||
| − | <span class="noprint plainlinks navbar" style="{{{style|}}}"><!-- | + | <includeonly><span class="noprint plainlinks navbar" style="{{{style|}}}"><small><!-- |
-->{{#if:{{{mini|}}}{{{plain|}}}|<!--nothing-->|<!--else: | -->{{#if:{{{mini|}}}{{{plain|}}}|<!--nothing-->|<!--else: | ||
| Line 22: | Line 22: | ||
-->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">]</span>}}<!-- | -->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">]</span>}}<!-- | ||
| − | --></span> | + | --></small></span></includeonly><noinclude>== 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=== | ||
| + | {| class="wikitable" | ||
| + | ! Options !! Parameters !! Produces... | ||
| + | |- | ||
| + | | Basic || <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:}} | ||
| + | |- | ||
| + | | Without "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}} | ||
| + | |- | ||
| + | | With 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 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 accomodate 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. | ||
| + | |||
| + | Navbar template based on [http://www.mediawiki.org/wiki/Template:Navbar MediaWiki]</noinclude> | ||
Latest revision as of 06:16, 3 February 2012
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}}
The {{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 Template:Tlx or Template:Tlx templates instead.
Notes
Navbar is contained within a Template:Tag in order to accomodate 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.
Navbar template based on MediaWiki
