Template:Navbar/doc: Difference between revisions

Latest revision as of 17:35, 11 November 2022

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Navbar.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

No description yet available.

Usage

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.

The miniv=1, viewplain=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the {{v}} or {{view}} templates instead.

Template parameters

Parameter	Description		Default	Status
`1`	name	Name of the template	empty	required
`plain`	plain version	Hide the “This box:” text	empty	optional
`mini`	short version	Use one-letter links instead of whole words	empty	optional
`nodiv`	inline version	Use <bdi> instead of <div> so that the template won’t have its own line in the text	empty	optional
`style`	box style	CSS style for the whole box	empty	optional
`fontstyle`	font style	CSS style for the text, also applied to the links. Useful for setting font color as that would be overridden by default link color.	empty	optional
`brackets`	brackets	Put [brackets] around the links	empty	optional
`uselang`	language	Set the template’s language. Not used if the template is transcluded on pages translated with the Translate extension.	empty	optional
`miniv`			empty	deprecated
`viewplain`			empty	deprecated
`fontcolor`	font color	Set the font color. Deprecated, use \|fontstyle = color:⧼color⧽ instead.	empty	deprecated
`thisbox`	Text	Custom leading text	This box	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
name	`1`	Name of the template	Template	required
brackets	`brackets`	Put [brackets] around the links	Unknown	optional
font color	`fontcolor`	Set the font color. Deprecated, use \|fontstyle = color:⧼color⧽ instead.	Line	deprecated
font style	`fontstyle`	CSS style for the text, also applied to the links. Useful for setting font color as that would be overridden by default link color.	Line	optional
short version	`mini`	Use one-letter links instead of whole words	Unknown	optional
	`miniv`		Unknown	deprecated
inline version	`nodiv`	Use <bdi> instead of <div> so that the template won’t have its own line in the text	Unknown	optional
plain version	`plain`	Hide the “This box:” text	Unknown	optional
box style	`style`	CSS style for the whole box	Line	optional
Text	`thisbox`	Custom leading text Default This box	Line	optional
language	`uselang`	Set the template’s language. Not used if the template is transcluded on pages translated with the Translate extension.	Line	optional
	`viewplain`		Unknown	deprecated

Additional information

The template is intended to be used in the following namespaces: no namespace specified

The template is intended to be used by the following user groups: no user group specified

Example

{{navbar|navbar/doc}}

renders as:

Localization

العربية ∙ বাংলা ∙ dansk ∙ Deutsch ∙ Deutsch (Sie-Form) ∙ English ∙ Esperanto ∙ español ∙ français ∙ ગુજરાતી ∙ עברית ∙ हिन्दी ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ 한국어 ∙ македонски ∙ Nederlands ∙ polski ∙ português ∙ русский ∙ svenska ∙ Türkçe ∙ українська ∙ Tiếng Việt ∙ 中文

This template makes use of {{Autotranslate}} and the translate extension. The layout of the template can be found under Template:navbar/layout.

Translate this template now!

Administrate translations.

Examples

Options	Parameters	Produces...
Normal	`{{navbar\|Template Name}}`	This box: view • talk • edit
Different text	`{{Navbar\|Template Name\|thisbox=This template}}`	This template: view • talk • edit
No "This box:" text.	`{{navbar\|Template Name\|plain=1}}`	view • talk • edit
Short version.	`{{navbar\|Template Name\|mini=1}}`	v • d • e
Good for "blending" into text.	`{{navbar\|Template Name\|nodiv=1}}`	Lorem This box: view • talk • edit Ipsum
Blended, no "This box:" text.	`{{navbar\|Template Name\|plain=1\|nodiv=1}}`	Lorem view • talk • edit Ipsum
Blended, short version.	`{{navbar\|Template Name\|mini=1\|nodiv=1}}`	Lorem v • d • e Ipsum
For a color option.	`{{navbar\|Template Name\|fontstyle=color:green}}`	This box: view • talk • edit

@@ Line 87: / Line 87: @@
    |11        = fontcolor
    |11label   = font color
-   |11d-en    = Set the font color. Deprecated, use <nowiki>|fontstyle = color:<color></nowiki> instead.
+   |11d-en    = Set the font color. Deprecated, use <nowiki>|fontstyle = color:⧼color⧽</nowiki> instead.
-  <!-- Using {{^(}} and {{)^}} is necessary, because TemplateData shows
-    -- “<nowiki><color></nowiki>” as “&lt;color&gt;” rather than as “<color>” -->
-  |11d-td-en = Set the font color. Deprecated, use <nowiki>|fontstyle = color:</nowiki>{{^(}}color{{)^}} instead.
    |11aliases =
    |11type    = string/line
    |11def     =
    |11stat    = deprecated
+| 12      = thisbox
+| 12label = Text
+| 12d     = Custom leading text
+| 12def   = This box
+| 12type  = string/line
+| 12stat  = optional
    |name               = navbar
@@ Line 106: / Line 110: @@
    |usage-notes        =
 Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] adds navbar navigational functionality:
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt>
+:<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.
-The <tt>miniv=1</tt>, <tt>viewplain=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
+The <code>miniv=1</code>, <code>viewplain=1</code> and <code>fontcolor=</code> parameters have been deprecated. To use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
    |shorthand          =
    |setscats           =
@@ Line 134: / Line 138: @@
 |-
 | Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
+|-
+| Different text
+| <code>{{tlx|Navbar|''Template Name''|3=thisbox{{=}}This template}}</code>
+| {{Navbar/i18n/en|navbar/doc|thisbox=This template}}
 |-
 | No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}