Template:Navbar/doc: Difference between revisions
m 305 revisions imported |
m Fix typo Tag: 2017 source edit |
||
(One intermediate revision by the same user not shown) | |||
Line 1: | Line 1: | ||
{{ | {{Documentation subpage}} | ||
{{ | {{Lua|Module:Navbar}} | ||
{{ | The {{Template link general|brace=on|plaincode=on|Navbar}} template provides a small navigation bar with links to perform the "view '''·''' talk '''·''' edit" actions on the content transcluding it. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easier both to recognize and edit {{Lang|la|in situ}} where it was found, without having to track it down through examining transclusion code. The high use rate for {{Template link general|nolink=on|plaincode=on|Navbar}} is because it is integrated as a feature into numerous [[wikipedia:Wikipedia:Navigation template|navigation box]] and [[wikipedia:Wikipedia:Manual of Style/Infoboxes|infobox]] templates present on many articles. It is also a regular feature of many internal-use templates and tables in the Zoophilia Wiki, Help and Template [[mediawikiwiki:Help:Namespaces|namespaces]]. | ||
== Usage == | |||
=== General === | |||
When one of the following examples is placed inside a given [[wikipedia:Wikipedia:Navigation templates|navigation template]] (or block of content used for [[wikipedia:Wikipedia:Transclusion#Selective transclusion|selective transclusion]]), it adds basic navbar functionality: | |||
:<code><nowiki>{{Navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code> | |||
:<code><nowiki>{{Navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code> | |||
:<code><nowiki>{{Navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}</nowiki></code> | |||
The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be [[wikipedia:Wikipedia:Substitution|substituted]] with the page name of the real location of the content when parsed by the server. For example, <code><nowiki>{{Navbar|Navbar/doc}}</nowiki></code> gives:<br /> | |||
{{Navbar|Navbar/doc}} | |||
:<code><nowiki>{{ | |||
:< | |||
When used in content that is selectively transcluded, but which is also used as-is in its original location, this template should be wrapped in {{Xtag|includeonly|p}} markup, so that it only appears when transcluded. | |||
=== Font size and weight === | |||
The standard font size is 88% (14pt) when used in a topical navbar template or in plain text, and 100% (16pt) when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the parent element's style definitions, not that of the root page). The {{Para|fontstyle}} parameter can be used to adjust font size as needed (for example, to reduce the font size even more when the template is used inside a block element with already enlarged fonts). Do not abuse this to make excessively small text (a reasonable floor is anything 80% of the normal page text), since that causes accessibility problems for many readers, especially those using accessibility tools to overcome other hindrances they have with technology. | |||
In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. Note that the middot bullets are bold for better visibility. | |||
== Examples == | |||
=== Required parameters === | |||
* <code><nowiki>{{Navbar|Template name}}</nowiki></code> – The template name. ''(required)'' | |||
=== Optional parameters === | |||
===Optional parameters=== | |||
{| class="wikitable" | {| class="wikitable" | ||
! Options ! | ! scope="col" | Options | ||
|- | ! scope="col" | Parameters | ||
| Basic | ! scope="col" | Produces… | ||
|- | ! scope="col" | "Shortcut" template | ||
| Different text | |- | ||
|- | | Basic | ||
| Without "This box:" text | | <code><nowiki>{{Navbar|Template name}}</nowiki></code> | ||
|- | | {{Navbar|Navbar/doc}} | ||
| Short version | | | ||
|- | |- | ||
| With brackets | | Different text | ||
|- | | <code><nowiki>{{Navbar|Template name|</nowiki>'''text'''<nowiki>=This template:}}</nowiki></code> | ||
| With font styling examples ([[Span and div|span]]) | | {{Navbar|Navbar/doc|text=This template:}} | ||
|- | | | ||
| With whole-template styling examples ([[Span and div|div]]) | |- | ||
| Without "This box:" text | |||
| <code><nowiki>{{Navbar|Template name|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> | |||
| {{Navbar|Navbar/doc|plain=y}} | |||
| {{Template link general|View}} | |||
|- | |||
| Short version | |||
| <code><nowiki>{{Navbar|Template name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> | |||
| {{Navbar|Navbar/doc|mini=y}} | |||
| {{Template link general|V}} | |||
|- | |||
| With brackets | |||
| <code><nowiki>{{Navbar|Template name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> | |||
| {{Navbar|Navbar/doc|brackets=y}} | |||
| | |||
|- | |||
| With font styling examples ([[wikipedia: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 ([[wikipedia:Span and div|div]]) | |||
| <code><nowiki>{{Navbar|Template name|</nowiki>'''style'''<nowiki>=background-color: beige; border-style: solid; border-width: 1px; float: right; padding: 5px;}}</nowiki></code> | |||
| {{Navbar|Navbar/doc|style=background-color: beige; border-style: solid; border-width: 1px; float: right; padding: 5px;}} | |||
| | |||
|} | |} | ||
===Shortcut templates === | === Shortcut templates === | ||
The | The {{Para|mini|y}} and {{Para|plain|y}} parameters can be avoided by using the {{Template link general|V}} or {{Template link general|View}} templates, respectively, instead. | ||
{{ | {{Template link general|View}} and {{Template link general|V}} also support changing the shown links, for example only 'view' and 'edit', or only 'view' and 'talk': | ||
{| class="wikitable" | {| class="wikitable" | ||
! Code | |||
! Code | ! Result | ||
! Result | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{View|template=view/doc}}</nowiki>}} | ||
|{{ | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{View|template=view/doc|talk}}</nowiki>}} | ||
|{{ | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{View|template=view/doc|talk|edit}}</nowiki>}} | ||
|{{ | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{V|template=v/doc}}</nowiki>}} | ||
|{{ | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{V|template=v/doc|t}}</nowiki>}} | ||
|{{ | |- | ||
|- | | {{Demo|br=<td>|<nowiki>{{V|template=v/doc|t|e}}</nowiki>}} | ||
|{{ | |||
|} | |} | ||
==Notes== | == Notes == | ||
Navbar is contained within | Navbar is contained within {{Tag|div}} tags in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside {{Tag|span}} tags or any other inline elements, because the [[wikipedia:HTML Tidy|HTML Tidy]] extension will try to automatically "fix" situations where it finds block elements nested inside of inline ones. | ||
==Prepackaged== | == Prepackaged == | ||
;{{ | ; {{Template link general|Navbar-header}} : Positions {{Navbar|Navbar/doc|mini=1}} on the right edge of the line, often used in non-collapsible navbox headings. | ||
;{{ | ; {{Template link general|Navbar-navframe}} : For use in conjunction with [[wikipedia:Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], positions {{Navbar|Navbar/doc|mini=1}} opposite the [hide]/[show] feature. | ||
;{{ | ; {{Template link general|Navbar-collapsible}} : For use in conjunction with [[wikipedia:Wikipedia:NavFrame#Collapsible tables|collapsible tables]]; floats {{Navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature. | ||
==See also== | == TemplateData == | ||
{{TemplateData header}} | |||
<templatedata>{ | |||
"description": "When placed inside a given template, it adds navbar navigational functionality", | |||
"format": "inline", | |||
"paramOrder": [ | |||
"1", | |||
"text", | |||
"plain", | |||
"mini", | |||
"brackets", | |||
"fontstyle", | |||
"style" | |||
], | |||
"params": { | |||
"1": { | |||
"label": "Template name", | |||
"description": "The name of the template, so links work correctly", | |||
"type": "wiki-template-name", | |||
"default": "{{PAGENAME}}", | |||
"required": true | |||
}, | |||
"text": { | |||
"label": "Custom text", | |||
"description": "Replaces the default 'This box' output with the value assigned here", | |||
"type": "line", | |||
"default": "This box", | |||
"required": false | |||
}, | |||
"plain": { | |||
"label": "Simple appearance", | |||
"description": "Removes 'This box' from the output", | |||
"type": "number", | |||
"suggestedvalues": [ | |||
"0", | |||
"1" | |||
], | |||
"default": "0", | |||
"required": false | |||
}, | |||
"mini": { | |||
"label": "Initialized links", | |||
"description": "Shortens links to 'V' 'T' 'E'", | |||
"type": "number", | |||
"suggestedvalues": [ | |||
"0", | |||
"1" | |||
], | |||
"autovalue": "0", | |||
"default": "0", | |||
"required": false | |||
}, | |||
"brackets": { | |||
"label": "Add brackets", | |||
"description": "Encloses the links in square brackets", | |||
"type": "number", | |||
"suggestedvalues": [ | |||
"0", | |||
"1" | |||
], | |||
"default": "0", | |||
"required": false | |||
}, | |||
"fontstyle": { | |||
"label": "Custom font style", | |||
"description": "Add custom CSS declarations to the text output; e.g. to change the color of the font: 'color: green;'", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"style": { | |||
"label": "Custom styling", | |||
"description": "Add custom CSS declarations; e.g. to float to the opposite side: 'float: right;'", | |||
"type": "string", | |||
"default": "float: left;", | |||
"required": false | |||
} | |||
} | |||
}</templatedata> | |||
== See also == | |||
{{Edit templates}} | {{Edit templates}} | ||
Other [[:Category:Internal link templates|internal link templates]], including: | Other [[:Category:Internal link templates|internal link templates]], including: | ||
*{{ | * {{Template link general|Talk}} – basic 'talk' link | ||
*{{ | * {{Template link general|Watch}} – a plain link that adds the page to your [[wikipedia:Help:Watchlist|watchlist]]. | ||
*[[:Category:Internal template-link templates]] | * [[:Category:Internal template-link templates|Internal template-link templates]] category | ||
{{Navigation templates}}<includeonly>{{Sandbox other|| | |||
<!-- Place categories below this line, please. --> | |||
} | |||
< | |||
[[Category:Internal link templates]] | [[Category:Internal link templates]] | ||
}}</includeonly> | }}</includeonly> |
Latest revision as of 23:05, 27 September 2024
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 uses Lua: |
The {{Navbar}}
template provides a small navigation bar with links to perform the "view · talk · edit" actions on the content transcluding it. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easier both to recognize and edit in situ where it was found, without having to track it down through examining transclusion code. The high use rate for {{Navbar}}
is because it is integrated as a feature into numerous navigation box and infobox templates present on many articles. It is also a regular feature of many internal-use templates and tables in the Zoophilia Wiki, Help and Template namespaces.
Usage
General
When one of the following examples is placed inside a given navigation template (or block of content used for selective transclusion), it adds basic navbar 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 page name of the real location of the content when parsed by the server. For example, {{Navbar|Navbar/doc}}
gives:
When used in content that is selectively transcluded, but which is also used as-is in its original location, this template should be wrapped in <includeonly>…</includeonly>
markup, so that it only appears when transcluded.
Font size and weight
The standard font size is 88% (14pt) when used in a topical navbar template or in plain text, and 100% (16pt) when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the parent element's style definitions, not that of the root page). The |fontstyle=
parameter can be used to adjust font size as needed (for example, to reduce the font size even more when the template is used inside a block element with already enlarged fonts). Do not abuse this to make excessively small text (a reasonable floor is anything 80% of the normal page text), since that causes accessibility problems for many readers, especially those using accessibility tools to overcome other hindrances they have with technology.
In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. Note that the middot bullets are bold for better visibility.
Examples
Required parameters
{{Navbar|Template name}}
– The template name. (required)
Optional parameters
Options | Parameters | Produces… | "Shortcut" template |
---|---|---|---|
Basic | {{Navbar|Template name}}
|
||
Different text | {{Navbar|Template name|text=This template:}}
|
||
Without "This box:" text | {{Navbar|Template name|plain=y}}
|
{{View}} | |
Short version | {{Navbar|Template name|mini=y}}
|
{{V}} | |
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=background-color: beige; border-style: solid; border-width: 1px; float: right; padding: 5px;}}
|
Shortcut templates
The |mini=y
and |plain=y
parameters can be avoided by using the {{V}} or {{View}} templates, respectively, instead.
{{View}} and {{V}} also support changing the shown links, for example only 'view' and 'edit', or only 'view' and 'talk':
Code | Result |
---|---|
{{View|template=view/doc}} | |
{{View|template=view/doc|talk}} | |
{{View|template=view/doc|talk|edit}} | |
{{V|template=v/doc}} | |
{{V|template=v/doc|t}} | |
{{V|template=v/doc|t|e}} |
Notes
Navbar is contained within <div>...</div>
tags in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside <span>...</span>
tags or any other inline elements, because the HTML Tidy extension will try to automatically "fix" situations where it finds block elements nested inside of inline ones.
Prepackaged
- {{Navbar-header}}
- Positions on the right edge of the line, often used in non-collapsible navbox headings.
- {{Navbar-navframe}}
- For use in conjunction with NavFrame divs, positions opposite the [hide]/[show] feature.
- {{Navbar-collapsible}}
- For use in conjunction with collapsible tables; floats opposite of the [hide]/[show] feature.
TemplateData
TemplateData for Navbar
When placed inside a given template, it adds navbar navigational functionality
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template name | 1 | The name of the template, so links work correctly
| Template | required |
Custom text | text | Replaces the default 'This box' output with the value assigned here
| Line | optional |
Simple appearance | plain | Removes 'This box' from the output
| Number | optional |
Initialized links | mini | Shortens links to 'V' 'T' 'E'
| Number | optional |
Add brackets | brackets | Encloses the links in square brackets
| Number | optional |
Custom font style | fontstyle | Add custom CSS declarations to the text output; e.g. to change the color of the font: 'color: green;' | String | optional |
Custom styling | style | Add custom CSS declarations; e.g. to float to the opposite side: 'float: right;'
| String | optional |
See also
- {{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
Other internal link templates, including:
- {{Talk}} – basic 'talk' link
- {{Watch}} – a plain link that adds the page to your watchlist.
- Internal template-link templates category
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 |