Difference between revisions of "Template:Navbar/doc"
(update documentation of parameter requirements.) |
(clarify parameters because I got it wrong last time and broke it) |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
===General=== | ===General=== | ||
| − | Copy one of the following examples. When it is placed inside a given [[Help:templates|template]], it adds navbar navigational functionality: | + | Copy one of the following examples. When it is placed inside a given [[Help:templates|template]], and only a 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. For example, <code><nowiki>{{navbar|navbar/doc}}</nowiki></code> | + | 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|{{subst:PAGENAME}}}}</nowiki></code> gives: <code><nowiki>{{navbar|navbar/doc}}</nowiki></code> – note that the wikispace, while nominally in the URL, is not included in the substituted pagename. And thus, the final output is:{{navbar|navbar/doc}} |
===Font-size=== | ===Font-size=== | ||
| Line 17: | Line 17: | ||
== Examples == | == Examples == | ||
===Required parameters=== | ===Required parameters=== | ||
| − | *<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required | + | *<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required. ''It must '''not include''' the template-space identifier and it will not work for other wikispaces''. It may be automatically filled as in the Usage section for convenience. |
===Optional parameters=== | ===Optional parameters=== | ||
Revision as of 03:33, 2 September 2015
Usage
General
Copy one of the following examples. When it is placed inside a given template, and only a 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|{{subst:PAGENAME}}}} gives: {{navbar|navbar/doc}} – note that the wikispace, while nominally in the URL, is not included in the substituted pagename. And thus, the final output is:
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. It must not include the template-space identifier and it will not work for other wikispaces. It may be automatically filled as in the Usage section for convenience.
Optional parameters
| Options | Parameters | Produces... (this page) |
|---|---|---|
| Basic | {{navbar|Template: Name}} |
|
| Different text | {{navbar|Template: Name|text=This template:}} |
|
| Without "This box:" text | {{navbar|Template: Name|plain=1}} |
|
| Short version | {{navbar|Template: Name|mini=1}} |
|
| With a color option | {{navbar|Template: Name|fontstyle=color:green}} |
|
| With brackets | {{navbar|Template: Name|brackets=1}}
|
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.
Notes
Navbar is contained within a <div>...</div> in order to accomodate a horizontal unnumbered list. This means it cannot be placed inside a <span>...</span> or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements.
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.
