Difference between revisions of "Template:Navbar/doc"

From BESA® Wiki
Jump to: navigation, search
m
(updte, ce)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
{{high-risk|6,600,000+}}
+
{{high-risk|6,700,000+}}
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
  
 
== 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}}|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}}
+
  
 
===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|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 24:
 
! 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}}
 
|-
 
|-
 
| 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:}}
 
|-
 
|-
| No "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}}
 
|-
 
|-
| For 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}}
Line 41: Line 40:
  
 
===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 use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
+
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.
  
 
== Prepackaged ==
 
== Prepackaged ==
Line 54: Line 53:
 
<!--- 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]]
  
 
[[af:Sjabloon:Tnavbar]]
 
[[af:Sjabloon:Tnavbar]]
Line 76: Line 75:
 
[[dsb:Pśedłoga:Tnavbar]]
 
[[dsb:Pśedłoga:Tnavbar]]
 
[[dv:Template:Tnavbar]]
 
[[dv:Template:Tnavbar]]
<!-- [[en:Template:Navbar]] -->
 
 
[[et:Mall:Navbar]]
 
[[et:Mall:Navbar]]
 
[[el:Πρότυπο:Tnavbar]]
 
[[el:Πρότυπο:Tnavbar]]

Revision as of 18:51, 12 October 2011

Script error

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:
Script error

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}} Script error
Different text {{navbar|Template Name|text=This template:}} Script error
Without "This box:" text {{navbar|Template Name|plain=1}} Script error
Short version {{navbar|Template Name|mini=1}} Script error
With a color option {{navbar|Template Name|fontstyle=color:green}} Script error
With brackets {{navbar|Template Name|brackets=1}} Script error

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.

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.

See also

Script error

  • {{Ed}} – navbar style edit link
  • {{Ed right}} – navbar style edit link aligned to right of page
  • {{Edit}} – plain edit link
  • {{Edit section}} – edit link aligned to right of page
  • {{Navbar}} – with additional links
  • {{Vedit}} – edit with the Visual Editor

Template:Navigational templates