Difference between revisions of "Module:Navbar/doc"
Jump to navigation
Jump to search
test>WOSlinker m (update transculsion count) |
test>LukeShu (→Optional parameters: document <tt>mini</tt> option) |
||
| Line 29: | Line 29: | ||
|- | |- | ||
| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}} | | No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}} | ||
| + | |- | ||
| + | | Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}} | ||
|- | |- | ||
| Good for "blending" into text. || <code><nowiki>{{navbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/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>{{navbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/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 |
| + | |- | ||
| + | |Blended, short version. || <code><nowiki>{{navbar|Template Name|mini=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|mini=1|nodiv=1}} Ipsum | ||
|- | |- | ||
| For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/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 22:16, 15 November 2009
| This is a documentation subpage for Module:Navbar. It contains usage information, categories and other content that is not part of the original module page. |
| This Lua module is used on 14,900,000+ pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
Contents
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:
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 | {{navbar|Template Name}} |
|
| No "This box:" text. | {{navbar|Template Name|plain=1}} |
|
| Short version. | {{navbar|Template Name|mini=1}} |
|
| Good for "blending" into text. | {{navbar|Template Name|nodiv=1}} |
Lorem Ipsum |
| Blended, no "This box:" text. | {{navbar|Template Name|plain=1|nodiv=1}} |
Lorem Ipsum |
| Blended, short version. | {{navbar|Template Name|mini=1|nodiv=1}} |
Lorem Ipsum |
| For a color option. | {{navbar|Template Name|fontstyle=color:green}} |
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
- {{Codifiednavbar}}
- {{Edit templates}}
Template:Navigational templates