Vorlage:Navbar/Doku: Unterschied zwischen den Versionen
imported>Davidgothberg (Changed {{esoteric}} to {{high-use| 700,000+ }} and modernised /doc page header.) |
K (274 Versionen von wikivoyage:Vorlage:Navbar/Doku importiert) |
||
(137 dazwischenliegende Versionen von 62 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
{{ | {{Dokumentation Unterseite}} | ||
{{high-risk}} | |||
<!-- | {{Lua|Modul:Navbar}} | ||
{{Benutzt Templatestyles|Module:Navbar/styles.css}} | |||
<!-- Kategorien bitte an das Ende der Seite, Interwiki-Links bitte nach Wikidata. Danke! --> | |||
< | == Usage == | ||
===General=== | |||
When one of the following examples is placed inside a given [[w:en:Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | |||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code> | |||
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</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|navbar/doc}}</nowiki></code> gives:<br> {{navbar|navbar/doc}} | |||
:< | |||
===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=== | |||
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required. | |||
===Optional parameters=== | |||
=== Optional parameters === | |||
{| class="wikitable" | {| class="wikitable" | ||
! Options !! Parameters !! Produces... | ! Options !! Parameters !! Produces... | ||
|- | |- | ||
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}} | |||
|- | |- | ||
| | | 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|navbar/doc|plain=1}} | ||
|- | |- | ||
| | | Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}} | ||
|- | |- | ||
| | | With brackets | ||
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> | |||
| {{navbar|navbar/doc|brackets=1}} | |||
|- | |- | ||
| 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|navbar/doc|style=float:right}} | ||
| | |||
|} | |} | ||
===Deprecated parameters=== | |||
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 == | |||
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 Tidy will 'fix' situations where it finds block elements inside inline elements. | |||
== Prepackaged == | == Prepackaged == | ||
;{{tl| | ;{{tl|Navbar-header}}: Positions {{navbar|navbar/doc|mini=1}} on the right edge of the line, often used in non-collapsible navbox heading. | ||
== See also == | == See also == | ||
{{ | {{Edit templates}} | ||
{{Navigation templates}} | |||
<includeonly> | <includeonly> | ||
<!-- | <!-- Kategorien bitte hier, Interwiki-Links bitte nach Wikidata. Danke! --> | ||
[[Kategorie:Vorlagen:Formatierungshilfe]] | |||
[[ | |||
</includeonly> | </includeonly> | ||
<templatedata> | |||
{ | |||
"description": "When placed inside a given template, it adds navbar navigational functionality", | |||
"params": { | |||
"": { | |||
"label": "Template Name", | |||
"description": "The name of the template, so links work correctly", | |||
"type": "string", | |||
"default": "", | |||
"required": true | |||
}, | |||
"text": { | |||
"label": "Different text", | |||
"description": "Allows custom text to replace the default 'this box'", | |||
"type": "string", | |||
"default": "This box", | |||
"required": false | |||
}, | |||
"plain": { | |||
"label": "Without 'This box:' text", | |||
"description": "Removes 'This box'", | |||
"type": "number", | |||
"default": "0", | |||
"required": false | |||
}, | |||
"mini": { | |||
"label": "Short Version", | |||
"description": "Shortens text to V T E", | |||
"type": "number", | |||
"default": "0", | |||
"required": false | |||
}, | |||
"brackets": { | |||
"label": "with brackets", | |||
"description": "adds brackets before and after the links", | |||
"type": "number", | |||
"default": "0", | |||
"required": false | |||
}, | |||
"fontstyle": { | |||
"label": "Font color", | |||
"description": "Allows you to change the color of the font (in the format color:green)", | |||
"type": "string", | |||
"default": "", | |||
"required": false | |||
}, | |||
"style": { | |||
"label": "To float to the side", | |||
"description": "Allows the template to float to the side (format=float:right)", | |||
"type": "string", | |||
"default": "float:left", | |||
"required": false | |||
} | |||
} | |||
} | |||
</templatedata> | |||
<includeonly><!-- Kategorien bitte hier, Interwiki-Links bitte nach Wikidata --> | |||
{{#ifeq:{{PAGENAME}}|{{BASEPAGENAME}}| | |||
[[Kategorie:Vorlagen:Naviboxen|Navbar]] | |||
}}</includeonly> |
Aktuelle Version vom 27. Januar 2023, 07:22 Uhr
![]() | Dies ist eine nachgeordnete Seite der Dokumentation von Vorlage:Navbar. Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Vorlage-Seite ist. |
![]() | Diese Vorlage benutzt Modul:Navbar, Skripte geschrieben in der Programmiersprache Lua. Bitte informiere dich dort, wenn du mehr über die Sprache und ihren Einsatz erfahren willst. Diese Vorlagen sollte im Regelfall nicht ersetzt werden. |
![]() | Diese Vorlage verwendet TemplateStyles. Die Stilvorlagen sind in den folgenden Dateien notiert: |
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 Tidy 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.
See also
- {{Ed}} – navbar style edit link
- {{Ed right}} – navbar style edit link aligned to right of page
- {{Edit}} – plain edit link
- {{Edit section}} – edit link aligned to right of page
- {{Navbar}} – with additional links
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 | |
{{Navbox years}} | collapsible | navbox | No | No | No |
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 |
When placed inside a given template, it adds navbar navigational functionality
Parameter | Beschreibung | Typ | Status | |
---|---|---|---|---|
Template Name |
| The name of the template, so links work correctly
| Zeichenfolge | erforderlich |
Different text | text | Allows custom text to replace the default 'this box'
| Zeichenfolge | optional |
Without 'This box:' text | plain | Removes 'This box'
| Nummer | optional |
Short Version | mini | Shortens text to V T E
| Nummer | optional |
with brackets | brackets | adds brackets before and after the links
| Nummer | optional |
Font color | fontstyle | Allows you to change the color of the font (in the format color:green)
| Zeichenfolge | optional |
To float to the side | style | Allows the template to float to the side (format=float:right)
| Zeichenfolge | optional |