Template:Navbar: Difference between revisions
Closed |
m 1 revision imported |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
< | <noinclude> | ||
{{ | <languages/> | ||
</noinclude><templatestyles src="Module:Navbar/styles.css"/><span class="noprint plainlinks navbar" style="{{{style|}}}"><small><!-- | |||
-->{{#if:{{{mini|}}}{{{plain|}}}|<!--nothing-->|<!--else: | |||
--><span style="{{{fontstyle|}}}">{{#if:{{{text|}}}|{{{text}}}|This box:}} </span>}}<!-- | |||
-->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">[</span>}}<!-- | |||
--><span style="white-space:nowrap;word-spacing:-.12em;"><!-- | |||
-->[[{{transclude|{{{1}}}}}|<span style="{{{fontstyle|}}}" title="View this template"><!-- | |||
-->{{#if:{{{mini|}}}|v|view}}</span>]]<!-- | |||
--><span style="{{{fontstyle|}}}"> <b>·</b> </span><!-- | |||
-->[{{fullurl:{{<noinclude><nowiki/></noinclude>TALKPAGENAME:{{transclude|{{{1}}}}}}}}} <span style="{{{fontstyle|}}}" title="Discuss this template"><!-- | |||
-->{{#if:{{{mini|}}}|d|talk}}</span>]<!-- | |||
-->{{#if:{{{noedit|}}}|<!--nothing-->|<!--else: | |||
--><span style="{{{fontstyle|}}}"> <b>·</b> </span><!-- | |||
-->[{{fullurl:{{transclude|{{{1}}}}}|action=edit}} <span style="{{{fontstyle|}}}" title="Edit this template"><!-- | |||
-->{{#if:{{{mini|}}}|e|edit}}</span>]}}<!-- | |||
--></span><!-- | |||
-->{{#if:{{{brackets|}}}|<span style="{{{fontstyle|}}}">]</span>}}<!-- | |||
--></small></span><noinclude> | |||
{{Documentation|content= | |||
{{Uses TemplateStyles|Module:Navbar/styles.css}} | |||
== Usage == | |||
=== General === | |||
When one of the following examples is placed inside a given [[Help:Templates|template]], it adds navbar navigational functionality: | |||
: {{tlx|Navbar|Navbar|mini{{=}}1}} | |||
: {{tlx|Navbar|Navbar|plain{{=}}1}} | |||
: {{tlx|Navbar|Navbar|fontstyle{{=}}color:green}} | |||
The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers. For example, {{tlx|Navbar|navbar/doc}} gives: | |||
{{Navbar|navbar/doc}} | |||
=== Font-size === | |||
Font-size is <code>88%</code> when used in a navbar, and <code>100%</code> when nested in a navbox. In the navbar, the weight is "<code>normal</code>"; when nested in navbox, it takes on the outer setting. The middot is bold. | |||
== Examples == | |||
=== Required parameters === | |||
* {{tlx|Navbar|''template name''}} — the template name is required. | |||
=== Optional parameters === | |||
{{(}}{{!}} class="wikitable" | |||
! Options | |||
! Parameters | |||
! Produces... | |||
{{!}}- | |||
{{!}} Basic | |||
{{!}} {{tlx|Navbar|2=''template name''}} | |||
{{!}} {{navbar|navbar/doc}} | |||
{{!}}- | |||
{{!}} Different text | |||
{{!}} {{tlx|Navbar|2=''template name''|3=text{{=}}This template:}} | |||
{{!}} {{navbar|navbar/doc|text=This template:}} | |||
{{!}}- | |||
{{!}} Without "This box:" text | |||
{{!}} {{tlx|Navbar|2=''template name''|3=plain{{=}}1}} | |||
{{!}} {{navbar|navbar/doc|plain=1}} | |||
{{!}}- | |||
{{!}} Short version | |||
{{!}} {{tlx|Navbar|2=''template name''|3=mini{{=}}1}} | |||
{{!}} {{navbar|navbar/doc|mini=1}} | |||
{{!}}- | |||
{{!}} With a color option | |||
{{!}} {{tlx|Navbar|2=''template name''|3=fontstyle{{=}}color:green}} | |||
{{!}} {{navbar|navbar/doc|fontstyle=color:green}} | |||
{{!}}- | |||
{{!}} With brackets | |||
{{!}} {{tlx|Navbar|2=''template name''|3=brackets{{=}}1}} | |||
{{!}} {{navbar|navbar/doc|brackets=1}} | |||
{{!}}- | |||
{{!}} Custom namespace | |||
{{!}} {{tlx|Navbar|2=''namespaced template name''|3=plain{{=}}1|4=brackets{{=}}1}} | |||
{{!}} {{navbar|User:Example|plain=1|brackets=1}} | |||
{{!}}{{)}} | |||
== TemplateData == | |||
{{Navbar/doc}} | |||
== 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. | |||
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE ---> | |||
<includeonly> | |||
[[Category:Formatting templates]] | |||
</includeonly> | |||
}} | |||
</noinclude> | </noinclude> | ||
Latest revision as of 00:51, 4 November 2021
<languages/>
Lua error: callParserFunction: function "#translation" was not found.
Usage
General
When one of the following examples is placed inside a given template, it adds navbar navigational functionality:
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, 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
- — the template name is required.
Optional parameters
| Options | Parameters | Produces... |
|---|---|---|
| Basic | ||
| Different text | ||
| Without "This box:" text | ||
| Short version | ||
| With a color option | ||
| With brackets | ||
| Custom namespace |
TemplateData
 | This is a documentation subpage for Template:Navbar. It contains usage information, categories and other content that is not part of the original Template page. |
Adds edit links to navboxes and other templates
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Template name | 1 | The template for which to create navbar links
| Template | required |
| Text | text | Custom leading text
| Line | optional |
| Mini? | mini | Only emit “v · d · e” | Boolean | optional |
| Plain? | plain | Omit leading text
| Boolean | optional |
| Brackets? | brackets | Surround links with brackets | Boolean | optional |
| No Edit | noedit | Omit the “Edit” link | Boolean | optional |
| Style | style | The CSS style attribute | String | optional |
| Font Style | fontstyle | The CSS style attribute for text | String | optional |
[[Category:Formatting templates{{#translation:}}]]
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.