Template:Navbar/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>SMcCandlish we're human, not computers |
meta>SMcCandlish illustrate CSS usage more clearly; boldface the parameters in the code so people who aren't nerds can make it out |
||
| Line 9: | Line 9: | ||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code> | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code> | ||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code> | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code> | ||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></code> | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}</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|Navbar/doc}}</nowiki></code> gives:<br />{{navbar|Navbar/doc}} | 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> gives:<br />{{navbar|Navbar/doc}} | ||
| Line 15: | Line 15: | ||
===Font-size=== | ===Font-size=== | ||
Font-size is 88% when used in a navbar, and 100% when nested in a navbox. | 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. | In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold. The {{para|fontstyle}} parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size). | ||
==Examples== | ==Examples== | ||
| Line 27: | Line 27: | ||
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}} | | Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}} | ||
|- | |- | ||
| Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}} | | Different text || <code><nowiki>{{navbar|Template Name|</nowiki>'''text'''<nowiki>=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}} | ||
|- | |- | ||
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|plain=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}} | | Without "This box:" text || <code><nowiki>{{navbar|Template Name|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}} | ||
|- | |- | ||
| Short version || <code><nowiki>{{navbar|Template Name|mini=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}} | | Short version || <code><nowiki>{{navbar|Template Name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}} | ||
|- | |- | ||
| With brackets || <code><nowiki>{{navbar|Template Name|brackets=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}} | | With brackets || <code><nowiki>{{navbar|Template Name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}} | ||
|- | |- | ||
| With | | With font styling examples ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''fontstyle'''<nowiki>=color: green; font-style: italic;}}</nowiki></code> || {{navbar|Navbar/doc|fontstyle=color: green; font-style: italic;}} | ||
|- | |- | ||
| | | With whole-template styling examples ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''style'''<nowiki>=float:right; background: Beige; padding: 5px; border: 1px solid;}}</nowiki></code> || {{navbar|Navbar/doc|style=float:right; background: Beige; padding: 5px; border: 1px solid;}} | ||
|} | |} | ||
Revision as of 13:00, 4 February 2016
 | This is a documentation subpage for Template:Navbar. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on 9,110,000+ pages, or roughly 132336% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template uses Lua: |
Usage
General
When one of the following examples is placed inside a given template, it adds navbar navigational functionality:
{{navbar|{{subst:PAGENAME}}|mini=y}}{{navbar|{{subst:PAGENAME}}|plain=y}}{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, {{navbar|Navbar/doc}} gives:
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. The |fontstyle= parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).
Examples
Required parameters
{{navbar|Template Name}}– the template name is required.
Optional parameters
| Options | Parameters | Produces... |
|---|---|---|
| Basic | {{navbar|Template Name}} |
|
| Different text | {{navbar|Template Name|text=This template:}} |
|
| Without "This box:" text | {{navbar|Template Name|plain=y}} |
|
| Short version | {{navbar|Template Name|mini=y}} |
|
| With brackets | {{navbar|Template Name|brackets=y}} |
|
| With font styling examples (span) | {{navbar|Template Name|fontstyle=color: green; font-style: italic;}} |
|
| With whole-template styling examples (div) | {{navbar|Template Name|style=float:right; background: Beige; padding: 5px; border: 1px solid;}} |
Deprecated parameters
The miniv=y, viewplain=y, nodiv=y 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 accommodate a horizontal unnumbered list. This means it cannot be placed inside a <span>...</span> or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.
Prepackaged
- {{Navbar-header}}
- Positions on the right edge of the line, often used in non-collapsible navbox heading.
- {{Navbar-navframe}}
- For use in conjunction with NavFrame divs, positions opposite of the [hide]/[show] feature.
- {{Navbar-collapsible}}
- For use in conjunction with collapsible tables, floats opposite of the [hide]/[show] feature.
See also
[] Compare different edit templates:
- {{Ed}} —– plain-style edit link surrounded by <small> tags, specifically for templates only
- {{Ed right}} —– plain-style edit link surrounded by <small> tags and aligned to right of page, specifically for templates only
- {{Edit}} —– plain-style edit link, applicable to all Wikipedia namespaces
- {{Edit section}} —– edit link surrounded by <div> tags by default which can specify which section to edit on a page, applicable to all Wikipedia namespaces
- {{Edit sup}} —– plain-style edit link surrounded by <sup> tags, applicable to all Wikipedia namespaces
- {{Edit sub}} —– plain-style edit link surrounded by <sub> tags, applicable to all Wikipedia namespaces
- {{Vedit}} —– plain-style edit link which edit with the Wikipedia:VisualEditor, applicable to all Wikipedia namespaces
Templates with view, talk and edit links:
- {{Navbar}} —– navigation bar with configurable caption and view·talk·edit links, specifically for templates only
- {{View}} —– navbar-style view·talk·edit links, specifically for templates only
- {{VTE}} & {{V}} —– navbar-style V·T·E links (i.e. view·talk·edit links in short forms), specifically for templates only
| Collapsible | Header color | Image | Groups | Style (body) parameter/s |
Examples | |
|---|---|---|---|---|---|---|
| {{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes | |
| {{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes |
|
| {{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes |
| Type | CSS classes | JavaScript | Collapses when | Custom initial state |
Nesting |
|---|---|---|---|---|---|
| Collapsible tables | collapsible | Defined in Common.js | 2 or more autocollapse on page | Yes | Yes |
TemplateData
This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
TemplateData for Navbar
TemplateData for Navbar
