Difference between revisions of "Template:Navbox"
Jump to navigation
Jump to search
Pepperonipi (talk | contribs) (It all works! Let's get this documentation moving!) |
Pepperonipi (talk | contribs) (Added basic documentation) |
||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
{{TemplateDocStart}} | {{TemplateDocStart}} | ||
+ | ::''Parts of this page were taken from the [https://en.wikipedia.org/wiki/Template:Navbox/doc The English Wikipedia's documentation on the Navbox template]. | ||
+ | |||
+ | This navigational template creates a box with a long list of organized links, so that a user can move between similar pages quickly. The template has default CSS styling, which can be changed as needed, although this is not recommended. This template should be used in a variety of places throughout the wiki because of its ease of use and standardization. | ||
+ | |||
+ | == Parameters == | ||
+ | : <code>name</code> – The name of the Navbox | ||
+ | : <code>title</code> – The title of the Navbox (shown at the top) | ||
+ | : <code>titlestyle</code> – A CSS style for the title-bar, such as: <code>background: aqua;</code> | ||
+ | : <code>groupstyle</code> – A CSS style for the group-cells, such as: <code>background: #f516db;</code> | ||
+ | : <code>above</code> – Text to appear above the group/list section | ||
+ | : <code>image</code> – An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as <code><nowiki>[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]</nowiki></code>. | ||
+ | : <code>imageleft</code> – An optional left-side image (code the same as the "image" parameter). | ||
+ | : <code>group<sub>n</sub></code> – The left-side text before list-n (if group-n omitted, list-n extends to the left edge of the box, and defaults to <code>text-align:center</code> styling). | ||
+ | : <code>list<sub>n</sub></code> – Text listing wikilinks using a <code>hlist</code> format (where the wikilinks are styled as a horizontal list). | ||
+ | : <code>below</code> – Optional text to appear below the group/list section. | ||
+ | |||
+ | == Examples == | ||
+ | === A Simple Navbox Showing Layout === | ||
+ | <pre lang="moin" style="overflow: auto;"> | ||
+ | <nowiki> | ||
+ | {{Navbox | ||
+ | | name = Navbox/doc | ||
+ | | title = Title | ||
+ | |||
+ | | group1 = Group1 | ||
+ | | list1 = List1 | ||
+ | |||
+ | | group2 = Group2 | ||
+ | | list2 = | ||
+ | * List 1 | ||
+ | * List 2 | ||
+ | |||
+ | | group3 = Group3 | ||
+ | | list3 = | ||
+ | * List 1 | ||
+ | * List 2 | ||
+ | * List 3 | ||
+ | |||
+ | | group4 = Group4 | ||
+ | | list4 = | ||
+ | * List 1 | ||
+ | * List 2 | ||
+ | * List 3 | ||
+ | * List 4 | ||
+ | |||
+ | | group5 = Group5 | ||
+ | | list5 = | ||
+ | * List 1 | ||
+ | * List 2 | ||
+ | * List 3 | ||
+ | * List 4 | ||
+ | * List 5 | ||
+ | |||
+ | }} | ||
+ | </nowiki> | ||
+ | </pre> | ||
+ | |||
+ | {{Navbox | ||
+ | | name = Navbox/doc | ||
+ | | title = Title | ||
+ | |||
+ | | group1 = Group1 | ||
+ | | list1 = List1 | ||
+ | |||
+ | | group2 = Group2 | ||
+ | | list2 = * List 1 * List 2 | ||
+ | |||
+ | | group3 = Group3 | ||
+ | | list3 = * List 1 * List 2 * List 3 | ||
+ | |||
+ | | group4 = Group4 | ||
+ | | list4 = * List 1 * List 2 * List 3 * List 4 | ||
+ | |||
+ | | group5 = Group5 | ||
+ | | list5 = * List 1 * List 2 * List 3 * List 4 * List 5 | ||
+ | }} | ||
+ | |||
</noinclude> | </noinclude> | ||
Revision as of 16:08, 29 September 2019
- Parts of this page were taken from the The English Wikipedia's documentation on the Navbox template.
This navigational template creates a box with a long list of organized links, so that a user can move between similar pages quickly. The template has default CSS styling, which can be changed as needed, although this is not recommended. This template should be used in a variety of places throughout the wiki because of its ease of use and standardization.
Parameters
name
– The name of the Navboxtitle
– The title of the Navbox (shown at the top)titlestyle
– A CSS style for the title-bar, such as:background: aqua;
groupstyle
– A CSS style for the group-cells, such as:background: #f516db;
above
– Text to appear above the group/list sectionimage
– An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as[[File:XX.jpg|80px|link=|alt=]]
.imageleft
– An optional left-side image (code the same as the "image" parameter).groupn
– The left-side text before list-n (if group-n omitted, list-n extends to the left edge of the box, and defaults totext-align:center
styling).listn
– Text listing wikilinks using ahlist
format (where the wikilinks are styled as a horizontal list).below
– Optional text to appear below the group/list section.
Examples
{{Navbox
| name = Navbox/doc
| title = Title
| group1 = Group1
| list1 = List1
| group2 = Group2
| list2 =
* List 1
* List 2
| group3 = Group3
| list3 =
* List 1
* List 2
* List 3
| group4 = Group4
| list4 =
* List 1
* List 2
* List 3
* List 4
| group5 = Group5
| list5 =
* List 1
* List 2
* List 3
* List 4
* List 5
}}
|
|