Template:Navbar/doc: Difference between revisions

Revision as of 11:03, 2 February 2018

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

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
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 1: / Line 1: @@
-{{documentation subpage}}
+{{TemplateBox
-<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
+  |1        = 1
+  |1label   = name
+  |1d-en    = Name of the template
+  |1aliases = <!-- List of aliases, separated by / (a slash) -->
+  |1type    = string/wiki-template-name
+  |1def     = <!-- default value for the parameter -->
+  |1stat    = required
-== Usage ==
+  |2        = plain
-===General===
+  |2label   = plain version
+  |2d-en    = Hide the “This box:” text
+  |2aliases =
+  |2type    =
+  |2def     =
+  |2stat    = optional-
+  |3        = mini
+  |3label   = short version
+  |3d-en    = Use one-letter links instead of whole words
+  |3aliases =
+  |3type    =
+  |3def     =
+  |3stat    = optional-
+  |4        = nodiv
+  |4label   = inline version
+  |4d-en    = Use &lt;bdi&gt; instead of &lt;div&gt; so that the template won’t have its own line in the text
+  |4aliases =
+  |4type    =
+  |4def     =
+  |4stat    = optional-
+  |5        = style
+  |5label   = box style
+  |5d-en    = CSS style for the whole box
+  |5aliases =
+  |5type    = string/line
+  |5def     =
+  |5stat    = optional-
+  |6        = fontstyle
+  |6label   = font style
+  |6d-en    = CSS style for the text, also applied to the links. Useful for setting font color as that would be overridden by default link color.
+  |6aliases =
+  |6type    = string/line
+  |6def     =
+  |6stat    = optional-
+  |7        = brackets
+  |7label   = brackets
+  |7d-en    = Put [brackets] around the links
+  |7aliases =
+  |7type    =
+  |7def     =
+  |7stat    = optional-
+  |8        = uselang
+  |8label   = language
+  |8d-en    = Set the template’s language. Not used if the template is transcluded on pages translated with the Translate extension.
+  |8aliases =
+  |8type    = string/line
+  |8def     =
+  |8stat    = optional-
+  |9        = miniv
+  |9label   =
+  |9d-en    =
+  |9d-td    =
+  |9aliases =
+  |9type    =
+  |9def     =
+  |9stat    = deprecated
+  |10        = viewplain
+  |10label   =
+  |10d-en    =
+  |10d-td    =
+  |10aliases =
+  |10type    =
+  |10def     =
+  |10stat    = deprecated
+  |11        = fontcolor
+  |11label   = font color
+  |11d-en    = Set the font color. Deprecated, use <nowiki>|fontstyle = color:<color></nowiki> instead.
+  |11aliases =
+  |11type    = string/line
+  |11def     =
+  |11stat    = deprecated
+  |name               = navbar
+  |desc               =
+  |namespace          =
+  |usergroup          =
+  |placement          =
+  |example-value      =
+  |mustbesubst        =
+  |relieson           =
+  |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>
@@ Line 11: / Line 106: @@
 :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt>
-:The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers.
+:The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template’s name when parsed by the servers.
-:<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}
-=== Deprecated parameters ===
 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.
+  |shorthand          =
+  |setscats           =
+  |example            = navbar/doc
+  |seealso            =
+* {{tl|Tnavbar-collapsible}}: For use in conjunction with [[w:Wikipedia:NavFrame#Collapsible tables|Collapsible tables]], floats <small>v • d • e</small> opposite of the [hide]/[show] feature.
+<!-- * {{tl|Codifiednavbar}}    -->
+<!-- * {{tl|Edit templates}}    -->
+<!-- {{Navigational templates}} -->
+  |type               =
+  |i18n-method        = ext.translate
+  |print              =
+}}
 == Examples ==
-===Required parameters===
-*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
-===Optional parameters===
 {| class="wikitable"
 ! Options !! Parameters !! Produces...
@@ Line 39: / Line 140: @@
 | For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
 |}
-===Prepackaged===
-;{{tl|Tnavbar-header}}: Positions <small>v • d • e</small> on the right edge of the line, often used in non-collapsible navbox heading.
-;{{tl|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe div]]s, positions <small>v • d • e</small> opposite of the [hide]/[show] feature.
-;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]],floats <small>v • d • e</small> opposite of the [hide]/[show] feature.
-== See also ==
-* [[Template:Navbar/i18n]] — for translate of this template
-<!-- * {{tl|Codifiednavbar}}    -->
-<!-- * {{tl|Edit templates}}    -->
-<!-- {{Navigational templates}} -->
 <!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 <includeonly>{{#if:{{#translation:}}||
-[[Category:Internal link templates|{{PAGENAME}}]]
+[[Category:Internal link templates]]
 }}
 </includeonly>

commons>Tacsipacsi