More actions
Removed tlx |
update documentation of parameter requirements. |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
===General=== | ===General=== | ||
Copy one of the following examples. When it 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}}|mini=1}}</nowiki></tt> | ||
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt> | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt> | ||
| Line 17: | Line 17: | ||
== 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 and it should include the template-space identifier (or other wikispace as appropriate). It may be automatically filled as in the Usage section for convenience. | ||
===Optional parameters=== | ===Optional parameters=== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Options !! Parameters !! Produces... | ! Options !! Parameters !! Produces... (this page) | ||
|- | |- | ||
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}} | | 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:}} | | 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}} | | 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}} | | 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 a color option || <code><nowiki>{{navbar|Template: Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}} | ||
|- | |- | ||
| With brackets | | With brackets | ||
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> | | <code><nowiki>{{navbar|Template: Name|brackets=1}}</nowiki></code> | ||
| {{navbar|navbar/doc|brackets=1}} | | {{navbar|navbar/doc|brackets=1}} | ||
|} | |} | ||