Difference between revisions of "Template:Navbar/doc"

From Yugipedia
Jump to: navigation, search
(update from wikipedia:Template:Navbar/doc, minus some parts we don't need)
Line 4: Line 4:
 
== Usage ==
 
== Usage ==
 
===General===
 
===General===
Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] 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>  
 
:<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>  
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>
 
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</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.
+
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}}
:<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}
 
  
=== Deprecated parameters ===
+
===Font-size===
The <tt>miniv=1</tt>, <tt>viewplain=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
+
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 ==
 
== Examples ==
 
===Required parameters===
 
===Required parameters===
*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
+
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> the template name is required.
  
 
===Optional parameters===
 
===Optional parameters===
Line 25: Line 23:
 
! Options !! Parameters !! Produces...
 
! Options !! Parameters !! Produces...
 
|-
 
|-
| Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
+
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
 
|-
 
|-
| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
+
| Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|navbar/doc|text=This template:}}
 
|-
 
|-
| Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
+
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
 
|-
 
|-
| Good for "blending" into text. || <code><nowiki>{{navbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|nodiv=1}} Ipsum
+
| Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
 
|-
 
|-
|Blended, no "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|plain=1|nodiv=1}} Ipsum
+
| With a color option || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
 
|-
 
|-
|Blended, short version. || <code><nowiki>{{navbar|Template Name|mini=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|mini=1|nodiv=1}} Ipsum
+
| With brackets
|-
 
| For 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>
 
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
 
| {{navbar|navbar/doc|brackets=1}}
 
| {{navbar|navbar/doc|brackets=1}}
 
|}
 
|}
 
===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 div]]s, 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.
 
  
 
== See also ==
 
== See also ==
* {{tl|Codifiednavbar}}
+
{{Edit templates}}
* {{tl|Edit templates}}
 
 
{{Navigational templates}}
 
{{Navigational templates}}
  
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<includeonly>
 
<includeonly>
[[Category:Internal link templates|{{PAGENAME}}]]
+
[[Category:Internal link templates]]
 
</includeonly>
 
</includeonly>

Revision as of 01:58, 23 October 2011

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}}

See also

[] Compare different edit templates:
  • {{Ed}} — plain-style edit link surrounded by <small> tags, specifically for templates only
  • {{Ed right}} — plain-style edit link surrounded by <small> tags and aligned to right of page, specifically for templates only
  • {{Edit}} — plain-style edit link, applicable to all Wikipedia namespaces
  • {{Edit section}} — edit link surrounded by <div> tags by default which can specify which section to edit on a page, applicable to all Wikipedia namespaces
  • {{Vedit}} — plain-style edit link which edit with the Wikipedia:VisualEditor, applicable to all Wikipedia namespaces

Templates with view, talk and edit links:

  • {{Navbar}} — navigation bar with configurable caption and view·talk·edit links, specifically for templates only
  • {{View}} — navbar-style view·talk·edit links, specifically for templates only
  • {{VTE}} & {{V}} — navbar-style V·T·E links (i.e. view·talk·edit links in short forms), specifically for templates only

Template:Navigational templates