Template:Navbar/doc: Difference between revisions
From Zoophilia Wiki
Jump to navigationJump to search
meta>Gadget850 (update obsolete HTML) |
meta>Jdaloner (Adjusted table formatting (using same for each row). Adjusted link in "Prepackaged" section. Modified <includeonly> section so that "/sandbox" subpage doesn't appear in categories.) |
||
| Line 3: | Line 3: | ||
<!---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=== | ===General=== | ||
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | ||
| Line 10: | Line 10: | ||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></code> | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</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| | 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}} | ||
===Font-size=== | ===Font-size=== | ||
| Line 16: | Line 16: | ||
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. | ||
== 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. | ||
| Line 24: | Line 24: | ||
! Options !! Parameters !! Produces... | ! Options !! Parameters !! Produces... | ||
|- | |- | ||
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar| | | Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}} | ||
|- | |- | ||
| Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar| | | Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}} | ||
|- | |- | ||
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar| | | Without "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| | | Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|Navbar/doc|mini=1}} | ||
|- | |- | ||
| With brackets | | With brackets || <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> || {{navbar|Navbar/doc|brackets=1}} | ||
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> | |||
| {{navbar| | |||
|- | |- | ||
| With a color option ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar| | | With a color option ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|Navbar/doc|fontstyle=color:green}} | ||
|- | |- | ||
| To float to the side ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|style=float:right}}</nowiki></code> || {{navbar| | | To float to the side ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|style=float:right}}</nowiki></code> || {{navbar|Navbar/doc|style=float:right}} | ||
|} | |} | ||
| Line 44: | Line 42: | ||
The <code>miniv=1</code>, <code>viewplain=1</code>, <code>nodiv=1</code> and <code>fontcolor=</code> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. | The <code>miniv=1</code>, <code>viewplain=1</code>, <code>nodiv=1</code> and <code>fontcolor=</code> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. | ||
== Notes == | ==Notes== | ||
Navbar is contained within a {{tag|div}} in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a {{tag|span}} or other inline element, because the [[HTML Tidy]] extension will 'fix' situations where it finds block elements inside inline elements. | Navbar is contained within a {{tag|div}} in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a {{tag|span}} or other inline element, because the [[HTML Tidy]] extension will 'fix' situations where it finds block elements inside inline elements. | ||
== Prepackaged == | ==Prepackaged== | ||
;{{tl|Navbar-header}}: Positions {{navbar| | ;{{tl|Navbar-header}}: Positions {{navbar|Navbar/doc|mini=1}} on the right edge of the line, often used in non-collapsible navbox heading. | ||
;{{tl|Navbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame| | ;{{tl|Navbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], positions {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature. | ||
;{{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables| | ;{{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia:NavFrame#Collapsible tables|collapsible tables]], floats {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature. | ||
== See also == | ==See also== | ||
{{Edit templates}} | {{Edit templates}} | ||
{{ | {{Navigation templates}} | ||
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE ---> | <!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE ---> | ||
<includeonly> | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
[[Category:Internal link templates]] | [[Category:Internal link templates]] | ||
</includeonly> | }}</includeonly> | ||
<templatedata> | <templatedata> | ||
{ | { | ||
Revision as of 05:57, 3 February 2015
 | 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 138366% 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. |
Usage
General
When one of the following examples is placed inside a given 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|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.
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=1}} |
|
| Short version | {{navbar|Template Name|mini=1}} |
|
| With brackets | {{navbar|Template Name|brackets=1}} |
|
| With a color option (span) | {{navbar|Template Name|fontstyle=color:green}} |
|
| To float to the side (div) | {{navbar|Template Name|style=float:right}} |
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 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 |
