Template:Tnavbar/doc: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(New page: <includeonly>{{esoteric}}{{template doc page transcluded}}</includeonly><noinclude>{{Template:Documentation subpage}}</noinclude> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> <br/>...)
 
Line 4: Line 4:


==Usage==
==Usage==
Copyable examples when inside a given [[Wikipedia:Navigational templates|template]] adds Tnavbar navigational functionality:
Copyable examples when inside a given template adds Tnavbar navigational functionality:
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>
:<tt><nowiki>{{Tnavbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>

Revision as of 19:40, 25 April 2013

This is a documentation subpage for Template:Tnavbar (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.


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}}
{{Tnavbar|{{subst:PAGENAME}}|fontcolor=green}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{Tnavbar|Tnavbar/doc}} gives:
This box: view  edit

Note to editors with edit access to this template

This template is represented across tens of thousands of pages, so please tread lightly when editing here. Conducting sufficient sandbox testing (Tnavbar specific) 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= |fontcolor= }}

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal
Normal {{tnavbar|Template Name}}
This box: view  edit
No "This box:" text. {{tnavbar|Template Name|plain=1}}
view  edit
Good for "blending" into text. {{tnavbar|Template Name|nodiv=1}} Lorem  This box: view  edit  Ipsum
Blended no "This box:" text. {{tnavbar|Template Name|plain=1|nodiv=1}} Lorem  view  edit  Ipsum
For a color option. {{tnavbar|Template Name|fontcolor=color}}
This box: view  edit
Mini
Makes Tnavbar display in a mini version: {{tnavbar|Template Name|mini=1}}
v  e
Good for "blending" into text. {{tnavbar|Template Name|mini=1|nodiv=1}} Lorem  v  e  Ipsum
View only
For a simpler access option. {{tnavbar|Template Name|miniv=1}}
For a full simpler access option. {{tnavbar|Template Name|viewplain=1}}

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

Navigation template comparison
view  edit
collapsible Header color Image Groups Style (body)
parameter/s
Examples
{{Navbox}}


collapsible navbox Left/right of body Yes style="background:#90ff90; color:black;" class="table-yes" | Yes {{USCongress}}

, {{Apollo program}}


{{Navbox with columns}}


collapsible navbox Left/right of columns No Yes {{Current U.S. Senators}}

, {{UK subdivisions}}


The background color for the header or title is inherited from the class listed below. The templates have titlestyle parameters that can be used to override the default.
Collapsible attributes
Type CSS classes Collapses when Custom
initial state
Nesting Default
header color
Font size
Collapsible tables collapsible 2 or more autocollapse on page Yes style="background:#90ff90; color:black;" class="table-yes" | Yes


#ccf 90%