Difference between revisions of "Template:Navbar/doc"

From Yugipedia
Jump to: navigation, search
m (1 revision imported: update Module:Navbox and whatnot from Wikipedia)
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 +
{{#ifeq:{{BASEPAGENAME}}|Navbar|{{high-use| 8100000 |all-pages = yes}}}}
 +
{{lua|Module:Navbar}}
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
  
−
== Usage ==
+
==Usage==
 
===General===
 
===General===
−
Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] adds navbar navigational functionality:
+
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality:
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code>
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code>
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>
+
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}</nowiki></code>
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>
 
−
:<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. For example, <code><nowiki>{{navbar|Navbar/doc}}</nowiki></code> gives:<br />{{navbar|Navbar/doc}}
−
:<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}
 
  
−
=== Deprecated parameters ===
+
===Font-size===
−
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.
+
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.  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).
  
−
== Examples ==
+
==Examples==
 
===Required parameters===
 
===Required parameters===
−
*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
+
*<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... !! "Shortcut" template
 
|-
 
|-
−
| Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
+
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}} ||
 
|-
 
|-
−
| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
+
| Different text || <code><nowiki>{{navbar|Template Name|</nowiki>'''text'''<nowiki>=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}} ||
 
|-
 
|-
−
| Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
+
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}} || {{tl|view}}
 
|-
 
|-
−
| Good for "blending" into text. || <code><nowiki>{{navbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|nodiv=1}} Ipsum
+
| Short version || <code><nowiki>{{navbar|Template Name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}} || {{tl|v}}
 
|-
 
|-
−
|Blended, no "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|plain=1|nodiv=1}} Ipsum
+
| With brackets || <code><nowiki>{{navbar|Template Name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}} ||
 
|-
 
|-
−
|Blended, short version. || <code><nowiki>{{navbar|Template Name|mini=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|mini=1|nodiv=1}} Ipsum
+
| 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;}} ||
 
|-
 
|-
−
| For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
+
| 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;}} ||
 +
|}
 +
 
 +
===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
 
|-
 
|-
−
| With brackets.
+
|{{demo|br=<td>|<nowiki>{{view|template=view/doc|edit}}</nowiki>}}
−
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
+
|-
−
| {{navbar|navbar/doc|brackets=1}}
+
|{{demo|br=<td>|<nowiki>{{v|template=v/doc|t}}</nowiki>}}
 
|}
 
|}
  
−
===Prepackaged===
+
==Notes==
−
;{{tl|Tnavbar-header}}: Positions <small>v • d • e</small> on the right edge of the line, often used in non-collapsible navbox heading.
+
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.
−
;{{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.
+
==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-navframe}}: For use in conjunction with [[Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], positions {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature.
 +
;{{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia:NavFrame#Collapsible tables|collapsible tables]], floats {{navbar|Navbar/doc|mini=1}} opposite of the [hide]/[show] feature.
 +
 
 +
==See also==
 +
{{Edit templates}}
 +
*{{tl|Watch}}
 +
{{Navigation templates}}
 +
 
 +
== TemplateData ==
 +
{{TemplateData header}}
 +
<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
  
−
== See also ==
+
                },
−
* {{tl|Codifiednavbar}}
+
                "mini": {
−
* {{tl|Edit templates}}
+
                        "label": "Short Version",
−
{{Navigational templates}}
+
                        "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
  
−
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
+
                }
−
<includeonly>
+
        }
−
[[Category:Internal link templates|{{PAGENAME}}]]
+
}
−
</includeonly>
+
</templatedata><!---
 +
  PLEASE ADD METADATA TO THE <includeonly> SECTION HERE
 +
---><includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 +
[[Category:Internal link templates]]
 +
}}</includeonly>

Revision as of 03:16, 15 January 2019

Usage

General

When one of the following examples is placed inside a given template, it adds 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 template's name when parsed by the servers. For example, {{navbar|Navbar/doc}} gives:

This box:

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. 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).

Examples

Required parameters

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

Optional parameters

Options Parameters Produces... "Shortcut" template
Basic {{navbar|Template Name}}
This box:
Different text {{navbar|Template Name|text=This template:}}
This template:
Without "This box:" text {{navbar|Template Name|plain=y}}
{{view}}
Short version {{navbar|Template Name|mini=y}}
{{v}}
With brackets {{navbar|Template Name|brackets=y}}
This box:
With font styling examples (span) {{navbar|Template Name|fontstyle=color: green; font-style: italic;}}
This box:
With whole-template styling examples (div) {{navbar|Template Name|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}
This box:

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

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
on the right edge of the line, often used in non-collapsible navbox heading.
{{Navbar-navframe}}
For use in conjunction with NavFrame divs, positions
opposite of the [hide]/[show] feature.
{{Navbar-collapsible}}
For use in conjunction with collapsible tables, floats
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
  • {{Watch}}

Navigation templates comparison

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 for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Navbar

<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>

Retrieved from "https://yugipedia.com/index.php?title=Template:Navbar/doc&oldid=4014533"