Difference between revisions of "Template:Navbar/doc"

From BESA® Wiki
Jump to: navigation, search
(→‎Deprecated parameters: fodder)
m (copy-edit)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
−
<includeonly>{{high-risk| 800,000+ }}
+
{{high-risk| 800,000+ }}
−
{{mbox|type=content|text='''Please make any changes in the /sandbox first.''' Editing this template will slow down Wikipedia; having to correct your mistake even more so. Combined small changes should be done in one edit.}}</includeonly>
+
−
 
+
 
<!---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===
 
Copyable examples when inside a given [[Wikipedia:Navigational templates|template]] adds navbar navigational functionality:
 
Copyable examples when inside a given [[Wikipedia:Navigational templates|template]] adds navbar navigational functionality:
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
Line 18: Line 16:
  
 
=== 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.
−
 
−
== 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: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>{{navbar|Name of Template}}</nowiki></code> the template name is required.
 
*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
Line 47: Line 39:
 
|}
 
|}
  
−
== Prepackaged ==
+
===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-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-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.
 
;{{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.
−
 
−
<br/>A list of meta-templates that may be used in place of custom navbox code follows.
 
  
 
== See also ==
 
== See also ==
−
{{[[Template:Codifiednavbar|Codifiednavbar]]}}
+
* {{tl|Codifiednavbar}}
 +
* {{tl|Edit templates}}
 
{{Navigational templates}}
 
{{Navigational templates}}
  
 +
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<includeonly>
 
<includeonly>
 
[[Category:Internal link templates|{{PAGENAME}}]]
 
[[Category:Internal link templates|{{PAGENAME}}]]

Revision as of 19:33, 18 May 2009

Script error

Usage

General

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.

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.

See also

Template:Navigational templates


Retrieved from "https://wiki.besa.de/index.php?title=Template:Navbar/doc&oldid=1165"