Safer nicotine wiki

Template:Navbar/doc: Difference between revisions

< Template:Navbar
VisualWikitext
Mediawiki >Wladek92
(correct)
 
imported>Thiemo Kreuz (WMDE)
m (Fix mistake in TemplateData documentation)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{#ifeq:{{BASEPAGENAME}}|Navbar|{{used in system}}}}
{{TemplateData header|editlinks=1|docpage=Navbar/doc}}
{{lua|Module:Navbar}}{{#ifeq:{{BASEPAGENAME}}|VTE|{{tsh|V}}}}
 
{{tlx|Navbar}} provides a small "view&nbsp;'''&middot;'''&nbsp;talk&nbsp;'''&middot;'''&nbsp;edit" navigation bar. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easily editable {{lang|la|in situ}} where it was found, without having track it down through examining transclusion code.  {{tnull|Navbar}}'s extremely high use rate and consequent protection level are because it is integrated as a feature into numerous [[WP:NAVBOX|navigation box]] and [[WP:INFOBOX|infobox]] templates used in millions of articles. It is also a regular feature of many internal-use templates and tables of the Wikipedia, Help, and Template [[WP:NAMESPACE|namespaces]].
 
==Usage==
===General===
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]] (or block of content used for [[Wikipedia:Transclusion#Selective transclusion|selective transclusion]]), it adds basic navbar navigational 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 [[WP:SUBST|substituted]] with the page name of the real location of the content when parsed by the servers. For example, <code><nowiki>{{navbar|Navbar/doc}}</nowiki></code> gives:<br />{{navbar|Navbar/doc}}
 
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 ===
Font-size is 88% when used in a topical navbar template or in plain text, and 100% when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the surrounding template's own content, not that of the entire page). 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). Do not abuse this to make excessively small text (i.e. less than 85% of the normal page text), since that causes [[MOS:SMALLTEXT|accessibility problems]] for many readers.
 
In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. The middot bullets are bold for better visibility. 
 
=== Block level element ===
The template generates block-level markup with {{tag|div}} tags, and therefore, any surrounding markup cannot include {{tag|span}} tags, which would cause a [[Special:LintErrors/misc-tidy-replacement-issues|div-span-flip]] lint error.
 
==Examples==
===Required parameters===
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.
 
===Optional parameters===
{| class="wikitable"
! Options !! Parameters !! Produces... !! "Shortcut" template
|-
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}} ||
|-
| 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|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}} || {{tl|view}}
|-
| Short version || <code><nowiki>{{navbar|Template Name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}} || {{tl|v}}
|-
| With brackets || <code><nowiki>{{navbar|Template Name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}} ||
|-
| 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;}} ||
|-
| History, move, and watchlist links || <code><nowiki>{{navbar|template=Template Name|e|t|h|m|w}}</nowiki></code> || {{navbar|template=Navbar/doc|e|t|h|m|w}}
|}
Note that to show the history, move, and watchlist links, {{para|template}} needs to be set to the template value specifically. Individual values can be left out of this list, e.g. <code><nowiki>{{navbar|template=Template Name|h|m|w}}</nowiki></code> will only show the view, history, move, and watchlist links.
 
===Shortcut templates ===
The <code>mini=y</code> and <code>plain=y</code> parameters can be avoided by using the {{tlx|v}} or {{tlx|view}} templates, respectively, instead.
 
{{tl|view}} and {{tl|v}} also support changing the shown links, for example only view and edit, or only view and talk:
 
{| class="wikitable"
|-
! Code
! 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==
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==
;{{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-collapsible}}: For use in conjunction with [[Help:Collapsing|collapsible tables]], floats {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature.
 
==See also==
{{Edit templates}}
 
Other [[:Category:Internal link templates|internal link templates]], including:
*{{tl|Talk}} – plain talk link
*{{tl|Watch}} – plain link that adds the page to your [[Help:Watchlist|watchlist]]
*[[:Category:Internal template-link templates]]
 
{{Navigation templates}}
 
== TemplateData ==
{{TemplateData header}}
<templatedata>
<templatedata>
{
{
"description": {
        "description": "When placed inside a given template, it adds navbar navigational functionality",
"en": "Adds edit links to navboxes and other templates",
        "params": {
"tr": "Gezinti kutularına ve diğer şablonlara düzenleme bağlantıları ekler",
                "1": {
"fr": "Ajoute des liens de modification aux boîtes de navigation et aux autres modèles"
                        "label": "Template Name",
},
                        "description": "The name of the template, so links work correctly",
"format": "inline",
                        "type": "string",
"params": {
                        "default": "",
"1": {
                        "required": true
"label": {
                },
"en": "Template name",
                "text": {
"tr": "Şablon adı",
                        "label": "Different text",
"fr": "Nom du modèle"
                        "description": "Allows custom text to replace the default 'this box'",
},
                        "type": "string",
"description": {
                        "default": "This box",
"en": "The template for which to create navbar links",
                        "required": false
"tr": "Gezinti çubuğu bağlantılarının oluşturulacağı şablon",
                            },
"fr": "Modèle pour lequel les liens de la barre de navigation seront créés."
                "plain": {
},
                        "label": "Without 'This box:' text",
"autovalue": "{{subst:PAGENAME}}",
                        "description": "Removes 'This box'",
"required": true,
                        "type": "number",
"type": "wiki-template-name"
                        "default": "0",
},
                        "required": false
"text": {
 
"label": {
                },
"en": "Text",
                "mini": {
"tr": "Metin",
                        "label": "Short Version",
"fr": "Texte"
                        "description": "Shortens text to V T E",
},
                        "type": "number",
"description": {
                        "default": "0",
"en": "Custom leading text",
                        "required": false
"tr": "Özel satır aralığı metni",
                },
"fr": "Texte principal personnalisé."
                "brackets": {
},
                        "label": "with brackets",
"default": {
                        "description": "adds brackets before and after the links",
"en": "This box:",
                        "type": "number",
"tr": "Bu kutu:"
                        "default": "0",
},
                        "required": false
"type": "line"
                },
},
                "fontstyle": {
"mini": {
                        "label": "Font color",
"label": {
                        "description": "Allows you to change the color of the font (in the format color:green)",
"en": "Mini?",
                        "type": "string",
"tr": "Mini mi?",
                        "default": "",
"fr": "Minimal"
                        "required": false
},
                },
"description": {
                "style": {
"en": "Only emit “v · d · e”",
                        "label": "To float to the side",
"tr": "Yalnızca “g · t · d” yayınlar",
                        "description": "Allows the template to float to the side (format=float:right)",
"fr": "Affichage restreint “v · d · e”"
                        "type": "string",
},
                        "default": "float:left",
"type": "boolean"
                        "required": false
},
 
"plain": {
                }
"label": {
        }
"en": "Plain?",
"tr": "Düz mü?",
"fr": "Brut"
},
"description": {
"en": "Omit leading text",
"tr": "Baştaki metni çıkar",
"fr": "Affichage sans texte principal."
},
"default": "{{{mini}}}",
"type": "boolean"
},
"brackets": {
"label": {
"en": "Brackets?",
"tr": "Parantezler mi?",
"fr": "Crochets"
},
"description": {
"en": "Surround links with brackets",
"tr": "Parantezli çevre bağlantıları",
"fr": "Les liens seront entre crochets [ ]"
},
"type": "boolean"
},
"noedit": {
"label": {
"en": "No Edit",
"tr": "Düzenleme Yok",
"fr": "Sans édition"
},
"description": {
"en": "Omit the “Edit” link",
"tr": "“Düzenle” bağlantısını atlayın",
"fr": "Le lien pour modifier n'est pas affiché."
},
"type": "boolean"
},
"style": {
"label": {
"en": "Style",
"tr": "Stil",
"fr": "Style"
},
"description": {
"en": "The CSS style attribute",
"tr": "CSS stil özelliği",
"fr": "Attribut du style CSS."
},
"type": "string"
},
"fontstyle": {
"label": {
"en": "Font Style",
"tr": "Yazı Tipi Stili",
"fr": "Style de fonte"
},
"description": {
"en": "The CSS style attribute for text",
"tr": "Metin için CSS stil niteliği",
"fr": "Attribut CSS de style pour le texte."
},
"type": "string"
}
}
}
}
</templatedata>
</templatedata><!---
<includeonly>{{Sandbox other||
  PLEASE ADD METADATA TO THE <includeonly> SECTION HERE
<!-- Categories below this line; interwikis at Wikidata -->
---><includeonly>{{Sandbox other||
[[Category:Formatting templates{{#translation:}}]]
[[Category:Internal link templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 17:39, 11 April 2023

{{Navbar}} provides a small "view · talk · edit" navigation bar. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easily editable

in situ

where it was found, without having track it down through examining transclusion code. {{Navbar}}'s extremely high use rate and consequent protection level are because it is integrated as a feature into numerous navigation box and infobox templates used in millions of articles. It is also a regular feature of many internal-use templates and tables of the Wikipedia, Help, and Template namespaces.

Usage

General

When one of the following examples is placed inside a given template (or block of content used for selective transclusion), it adds basic 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 page name of the real location of the content when parsed by the servers. For example, {{navbar|Navbar/doc}} gives:
<translate> This box:</translate> <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

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

Font-size is 88% when used in a topical navbar template or in plain text, and 100% when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the surrounding template's own content, not that of the entire page). 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). Do not abuse this to make excessively small text (i.e. less than 85% of the normal page text), since that causes accessibility problems for many readers.

In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. The middot bullets are bold for better visibility.

Block level element

The template generates block-level markup with ‎<div>...‎</div> tags, and therefore, any surrounding markup cannot include ‎<span>...‎</span> tags, which would cause a div-span-flip lint error.

Examples

Required parameters

  • {{navbar|Template Name}} – the template name is required.

Optional parameters

Options Parameters Produces... "Shortcut" template
Basic {{navbar|Template Name}} <translate> This box:</translate> <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>
Different text {{navbar|Template Name|text=This template:}} This template: <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>
Without "This box:" text {{navbar|Template Name|plain=y}} <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate> {{view}}
Short version {{navbar|Template Name|mini=y}} <span style="" title="<translate nowrap> View this template</translate>"><translate> v</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> d</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> e</translate> {{v}}
With brackets {{navbar|Template Name|brackets=y}} <translate> This box:</translate> [<span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>]
With font styling examples (span) {{navbar|Template Name|fontstyle=color: green; font-style: italic;}} <translate> This box:</translate> <span style="color: green; font-style: italic;" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="color: green; font-style: italic;" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="color: green; font-style: italic;" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>
With whole-template styling examples (div) {{navbar|Template Name|style=float:right; background: Beige; padding: 5px; border: 1px solid;}} <translate> This box:</translate> <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>
History, move, and watchlist links {{navbar|template=Template Name|e|t|h|m|w}} <translate> This box:</translate> <span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>

Note that to show the history, move, and watchlist links, |template= needs to be set to the template value specifically. Individual values can be left out of this list, e.g. {{navbar|template=Template Name|h|m|w}} will only show the view, history, move, and watchlist links.

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
template=view/doc}}
template=view/doc|talk}}
template=view/doc|talk|edit}}
template=v/doc}}
template=v/doc|t}}
template=v/doc|t|e}}

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 <span style="" title="<translate nowrap> View this template</translate>"><translate> v</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> d</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> e</translate> on the right edge of the line, often used in non-collapsible navbox heading.
{{Navbar-collapsible}}
For use in conjunction with collapsible tables, floats <span style="" title="<translate nowrap> View this template</translate>"><translate> v</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> d</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> e</translate> 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
  • {{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:

Navigation templates comparison [<span style="" title="<translate nowrap> View this template</translate>"><translate> view</translate> · <span style="" title="<translate nowrap> Discuss this template</translate>"><translate> talk</translate> · <span style="" title="<translate nowrap> Edit this template</translate>"><translate> edit</translate>]
Template Collapsible Header color Image Groups Style (body)
parameter/s
{{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
Collapsible attributes
Type CSS classes JavaScript Collapses when Custom
initial state		 Nesting
Collapsible tables mw-collapsible Defined in Common.js 2 or more autocollapse on page Yes Yes

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Navbar

When placed inside a given template, it adds navbar navigational functionality

Template parameters

ParameterDescriptionTypeStatus
Template Name1

The name of the template, so links work correctly

Default
Stringrequired
Different texttext

Allows custom text to replace the default 'this box'

Default
This box
Stringoptional
Without 'This box:' textplain

Removes 'This box'

Default
0
Numberoptional
Short Versionmini

Shortens text to V T E

Default
0
Numberoptional
with bracketsbrackets

adds brackets before and after the links

Default
0
Numberoptional
Font colorfontstyle

Allows you to change the color of the font (in the format color:green)

Default
Stringoptional
To float to the sidestyle

Allows the template to float to the side (format=float:right)

Default
float:left
Stringoptional
Retrieved from ‘https://safernicotine.wiki/mediawiki/index.php?title=Template:Navbar/doc&oldid=39015’