Difference between revisions of "Template:Navbar/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Import from Wikipedia (CC BY-SA license), with changes.)
 
m (Add {{high-risk}})
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 +
<includeonly>{{high-risk}}</includeonly>
 +
{{En-WP attribution notice}}
  
 
<!---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--->
Line 5: Line 7:
 
==Usage==
 
==Usage==
 
===General===
 
===General===
−
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality:
+
When one of the following examples is placed inside a given [[Project:Navigation templates|template]], it adds navbar navigational functionality:
 
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code>
 
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code>
 
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></code>
 
:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></code>
Line 34: Line 36:
 
| With brackets || <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> || {{navbar|Navbar/doc|brackets=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}}
+
| With a color option ([[w: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}}
+
| To float to the side ([[w:Span and div|div]]) || <code><nowiki>{{navbar|Template Name|style=float:right}}</nowiki></code> || {{navbar|Navbar/doc|style=float:right}}
 
|}
 
|}
  
Line 43: Line 45:
  
 
==Notes==
 
==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 the [[HTML Tidy]] extension will 'fix' situations where it finds block elements inside inline elements.
+
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 [[w:HTML Tidy|HTML Tidy]] extension will 'fix' situations where it finds block elements inside inline elements.
  
 
==See also==
 
==See also==

Latest revision as of 20:44, 7 June 2015


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

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Basic {{navbar|Template Name}}
This box:
Different text {{navbar|Template Name|text=This template:}}
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}}
This box: []
With a color option (span) {{navbar|Template Name|fontstyle=color:green}}
This box:
To float to the side (div) {{navbar|Template Name|style=float:right}}
This box:

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 in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a span or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

See also

Template:Edit templates

Navigation templates comparison
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
Collapsible attributes
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


<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://wiki.kerbalspaceprogram.com/index.php?title=Template:Navbar/doc&oldid=64397"