Difference between revisions of "Template:Navbar/doc"

From BESA® Wiki
Jump to: navigation, search
m
(update after move)
Line 5: Line 5:
 
== Usage ==
 
== Usage ==
  
Copyable examples when inside a given [[Wikipedia:Navigational templates|template]] adds Tnavbar navigational functionality:
+
Copyable examples when inside a given [[Wikipedia:Navigational templates|template]] adds navbar navigational functionality:
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{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.
:<nowiki>{{Tnavbar|Tnavbar/doc}}</nowiki> gives: {{Tnavbar|Tnavbar/doc}}
+
:<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}
  
 
=== Deprecated parameters ===
 
=== Deprecated parameters ===
  
 
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.
 
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.
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|miniv=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|miniv=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|viewplain=1}}</nowiki></tt>
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|viewplain=1}}</nowiki></tt>
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|miniv=1|nodiv=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|miniv=1|nodiv=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|viewplain=1|nodiv=1}}</nowiki></tt>  
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|viewplain=1|nodiv=1}}</nowiki></tt>  
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|fontcolor=green}}</nowiki></tt>
+
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontcolor=green}}</nowiki></tt>
  
 
== Note to editors with edit access to this template ==
 
== Note to editors with edit access to this template ==
  
This template is represented across [[Special:MostLinkedTemplates|hundreds of thousands of pages]], so please tread lightly when editing here.  Conducting sufficient [[Template:Template sandbox|sandbox testing]] ([[Template:Tnavbar/Sandbox|Tnavbar specific]]) to establish the validity of edits relative to Tnavbar is '''strongly''' encouraged prior to attempting to integrate changes.
+
This template is represented across [[Special:MostLinkedTemplates|hundreds of thousands of pages]], so please tread lightly when editing here.  Conducting sufficient [[Template:Template sandbox|sandbox testing]] ([[Template:navbar/Sandbox|navbar specific]]) to establish the validity of edits relative to navbar is '''strongly''' encouraged prior to attempting to integrate changes.
  
 
== Examples ==
 
== Examples ==
  
 
===Required parameters===
 
===Required parameters===
*<code><nowiki>{{Tnavbar|Name of Template}}</nowiki></code> the template name is required.
+
*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
  
 
===Optional parameters===
 
===Optional parameters===
Line 39: Line 39:
 
!colspan="3"| Normal
 
!colspan="3"| Normal
 
|-
 
|-
| Normal || <code><nowiki>{{tnavbar|Template Name}}</nowiki></code> || {{tnavbar|Tnavbar/doc}}
+
| Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
 
|-
 
|-
| No "This box:" text. || <code><nowiki>{{tnavbar|Template Name|plain=1}}</nowiki></code> || {{tnavbar|Tnavbar/doc|plain=1}}
+
| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
 
|-
 
|-
| Good for "blending" into text. || <code><nowiki>{{tnavbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{tnavbar|Tnavbar/doc|nodiv=1}} Ipsum
+
| Good for "blending" into text. || <code><nowiki>{{navbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|nodiv=1}} Ipsum
 
|-
 
|-
|Blended no "This box:" text. || <code><nowiki>{{tnavbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || Lorem {{tnavbar|Tnavbar/doc|plain=1|nodiv=1}} Ipsum
+
|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
 
|-
 
|-
| For a color option. || <code><nowiki>{{tnavbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{tnavbar|Tnavbar/doc|fontstyle=color:green}}
+
| For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
 
|}
 
|}
  

Revision as of 20:58, 21 April 2009


Usage

Copyable examples when inside a given template adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=1}}
{{navbar|{{subst:PAGENAME}}|plain=1}}
{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{navbar|navbar/doc}} gives: Script error

Deprecated parameters

The miniv=1, viewplain=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the {{v}} or {{view}} templates instead.

{{navbar|{{subst:PAGENAME}}|miniv=1}}
{{navbar|{{subst:PAGENAME}}|viewplain=1}}
{{navbar|{{subst:PAGENAME}}|miniv=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|viewplain=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|fontcolor=green}}

Note to editors with edit access to this template

This template is represented across hundreds of thousands of pages, so please tread lightly when editing here. Conducting sufficient sandbox testing (navbar specific) to establish the validity of edits relative to navbar is strongly encouraged prior to attempting to integrate changes.

Examples

Required parameters

  • {{navbar|Name of Template}} the template name is required.

Optional parameters

Options Parameters Produces...
Normal
Normal {{navbar|Template Name}} Script error
No "This box:" text. {{navbar|Template Name|plain=1}} Script error
Good for "blending" into text. {{navbar|Template Name|nodiv=1}} Lorem Script error Ipsum
Blended no "This box:" text. {{navbar|Template Name|plain=1|nodiv=1}} Lorem Script error Ipsum
For a color option. {{navbar|Template Name|fontstyle=color:green}} Script error

Prepackaged

{{Tnavbar-header}}
Positions v • d • 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 v • d • e opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}
For use in conjunction with Collapsible tables,floats v • d • e opposite of the [hide]/[show] feature.


A list of meta-templates that may be used in place of custom navbox code follows.

See also

{{Codifiednavbar}} Template:Navigational templates