Difference between revisions of "Template:Navbar/doc"

From BESA® Wiki
Jump to: navigation, search
(+see also)
(Added Navigation template series and sort documentation options)
Line 34: Line 34:
 
=== Optional parameters ===
 
=== Optional parameters ===
 
{| class="wikitable"
 
{| class="wikitable"
! Optional parameter !!  !! colspan=2 | Produces...
+
! Optional parameter !!  !! Produces...
 
|-
 
|-
|Makes Tnavbar display in a mini version: <code><nowiki>{{Tnavbar|Template Name|mini=1}}</nowiki></code> like so. || → || Makes Tnavbar display in a mini version: {{Tnavbar|Tnavbar/doc|mini=1}} like so.
+
|No "This box:" text. <code><nowiki>{{Tnavbar|Template Name|plain=1}}</nowiki></code> || → ||No "This box:" text. {{Tnavbar|Tnavbar/doc|plain=1}}
 
|-
 
|-
 
|<code><nowiki>{{Tnavbar|Template Name|nodiv=1}}</nowiki></code> Good for "blending" into text. || → || {{Tnavbar|Tnavbar/doc|nodiv=1}} Good for "blending" into text.
 
|<code><nowiki>{{Tnavbar|Template Name|nodiv=1}}</nowiki></code> Good for "blending" into text. || → || {{Tnavbar|Tnavbar/doc|nodiv=1}} Good for "blending" into text.
 
|-
 
|-
|<code><nowiki>{{Tnavbar|Template Name|mini=1|nodiv=1}}</nowiki></code> Good for "blending" into text. || → || {{Tnavbar|Tnavbar/doc|mini=1|nodiv=1}} Good for "blending" into text.
+
|Blended no "This box:" text. <code><nowiki>{{Tnavbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || → ||Blended no "This box:" text. {{Tnavbar|Tnavbar/doc|plain=1|nodiv=1}}
 
|-
 
|-
|No "This box:" text. <code><nowiki>{{Tnavbar|Template Name|plain=1}}</nowiki></code> || → ||No "This box:" text. {{Tnavbar|Tnavbar/doc|plain=1}}
+
| colspan="3"|
 
|-
 
|-
|Blended no "This box:" text. <code><nowiki>{{Tnavbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || → ||Blended no "This box:" text. {{Tnavbar|Tnavbar/doc|plain=1|nodiv=1}}
+
|Makes Tnavbar display in a mini version: <code><nowiki>{{Tnavbar|Template Name|mini=1}}</nowiki></code> like so. Also, set the <tt>plain=1</tt> parameter. || → || Makes Tnavbar display in a mini version: {{Tnavbar|Tnavbar/doc|mini=1}} like so.
 
|-
 
|-
|For a simpler access option. <code><nowiki>{{Tnavbar|Template Name|miniv=1}}</nowiki></code> || → ||For a simpler access option. {{Tnavbar|Tnavbar/doc|miniv=1}}
+
|<code><nowiki>{{Tnavbar|Template Name|mini=1|nodiv=1}}</nowiki></code> Good for "blending" into text. || → || {{Tnavbar|Tnavbar/doc|mini=1|nodiv=1}} Good for "blending" into text.
 +
|-
 +
| colspan="3"|
 
|-
 
|-
 
|For a fuller simpler access option. <code><nowiki>{{Tnavbar|Template Name|viewplain=1}}</nowiki></code> || → ||For a fuller simpler access option. {{Tnavbar|Tnavbar/doc|viewplain=1}}
 
|For a fuller simpler access option. <code><nowiki>{{Tnavbar|Template Name|viewplain=1}}</nowiki></code> || → ||For a fuller simpler access option. {{Tnavbar|Tnavbar/doc|viewplain=1}}
 
|-
 
|-
 +
|For a simpler access option. <code><nowiki>{{Tnavbar|Template Name|miniv=1}}</nowiki></code> || → ||For a simpler access option. {{Tnavbar|Tnavbar/doc|miniv=1}}
 
|}
 
|}
  
== See also ==
+
== Prepackaged ==
* {{tl|tnavbar-header}}
+
;{{tl|tnavbar-header}}: Floats tnavbar right, useful is a navbox heading.
 +
 
 +
The following is a list of meta-template the can be used in place of custom navbox code
 +
{{Navigational templates}}
  
 
<includeonly>
 
<includeonly>

Revision as of 21:36, 31 December 2006

Template:Template doc page viewed directly


Tnavbar : Template navigation bar



Usage

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

{{Tnavbar|{{subst:PAGENAME}}|mini=1}}
{{Tnavbar|{{subst:PAGENAME}}|plain=1}}
{{Tnavbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}
{{Tnavbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}
{{Tnavbar|{{subst:PAGENAME}}|miniv=1}}
{{Tnavbar|{{subst:PAGENAME}}|viewplain=1}}
{{Tnavbar|{{subst:PAGENAME}}|miniv=1|nodiv=1}}
{{Tnavbar|{{subst:PAGENAME}}|viewplain=1|nodiv=1}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{Tnavbar|Tnavbar/doc}} gives: Template:Tnavbar

Note to editors

This template is represented across thousands of pages please tread lightly when editing here. Conducting sufficient sandbox testing to establish the validity of edits relative to Tnavbar is strongly encouraged prior to attempting to integrate changes.

Examples

{{Tnavbar|Name of Template|mini= |nodiv= }}

Required parameters

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

Optional parameters

Optional parameter Produces...
No "This box:" text. {{Tnavbar|Template Name|plain=1}} No "This box:" text. Template:Tnavbar
{{Tnavbar|Template Name|nodiv=1}} Good for "blending" into text. Template:Tnavbar Good for "blending" into text.
Blended no "This box:" text. {{Tnavbar|Template Name|plain=1|nodiv=1}} Blended no "This box:" text. Template:Tnavbar
Makes Tnavbar display in a mini version: {{Tnavbar|Template Name|mini=1}} like so. Also, set the plain=1 parameter. Makes Tnavbar display in a mini version: Template:Tnavbar like so.
{{Tnavbar|Template Name|mini=1|nodiv=1}} Good for "blending" into text. Template:Tnavbar Good for "blending" into text.
For a fuller simpler access option. {{Tnavbar|Template Name|viewplain=1}} For a fuller simpler access option. Template:Tnavbar
For a simpler access option. {{Tnavbar|Template Name|miniv=1}} For a simpler access option. Template:Tnavbar

Prepackaged

{{tnavbar-header}}
Floats tnavbar right, useful is a navbox heading.

The following is a list of meta-template the can be used in place of custom navbox code Template:Navigational templates