Template:Navbar/doc: Difference between revisions

From Dolphin Emulator Wiki
Jump to navigation Jump to search
(Borrowed from Wikipedia and removed functions not available in this wiki...)
 
No edit summary
(One intermediate revision by the same user not shown)
Line 1: Line 1:
== Usage ==
== Usage ==
===General===
=== General ===
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality:
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality:
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code>  
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></code>  
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt>  
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></code>  


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}}
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:
{{navbar|navbar/doc}}


===Font-size===
 
=== Font-size ===
Font-size is 88% when used in a navbar, and 100% when nested in a navbox.
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.
In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold.


== Examples ==
== Examples ==
===Required parameters===
=== Required parameters ===
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.


===Optional parameters===
=== Optional parameters ===
{| class="wikitable"
{| class="wikitable"
! Options !! Parameters !! Produces...
! Options !! Parameters !! Produces...
Line 37: Line 39:
|}
|}


===Deprecated parameters===
=== 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.
The <var>miniv=1</var>, <var>viewplain=1</var>, <var>nodiv=1</var> and <var>fontcolor=</var> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.


== Notes ==
== 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.
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.

Revision as of 03:53, 15 June 2015

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 brackets {{navbar|Template Name|brackets=1}}
With a color option (span) {{navbar|Template Name|fontstyle=color:green}}
To float to the side (div) {{navbar|Template Name|style=float:right}}

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.