Difference between revisions of "Template:Navbox/doc"

Latest revision as of 18:59, 22 December 2010

This is the documentation page of Template:Navbox. Please add the documentation for this Template below.

This template is mainly to be used in Navigation templates. It is also possible to use it directly on a page though.

Parameters

Title = Title of the box, the only part that will not be hidden. (default = "Navigation")
Collapse = Should the box collapse by default?
- Yes = Collapsed by default.
- No = Open by default.
- Auto = Collapse if there are other NavBoxes on the page. (default setting)
- Disable = Hide the [show/hide] button, preventing collapsing.
Above = Text to appear on the top.
Group1 = Title of Group 1.
List1 = List of Group 1.
Group2 = Title of Group 2.
List2 = List of Group 2.
...
Group7 = Title of Group 7.
List7 = List of Group 7.
Image = Image to appear on the right. List1 must be included for this to work! You don't need to add the [[ ]].
Imagewidth = Possibility to change the width of the image (default 100px).
Below = Text to appear on the bottom.

Notes

If you include a list without a group, the list will take the full width and have centered text.
If you include a group without a list, the row won't appear at all.
You don't need to add the groups in order, though this is recommended.

Example

{{NavBox
|title = Click show on the right
|collapse = Auto <!-- To see this in effect, see the difference between the Template page and the /doc subpage -->
|above = Top text
|group1 = First
|list1 = Test
|group4 = Second?
|list4 = [[Main Page]]
|list3 = ''List can go before the group''
|group3 = Third?
|list5 = This list has no group, so is centered.
|group7 = This group has no list, so doesn't show.
|image = Image:Ak22.jpg
|imagewidth = 70px
|below = '''Bottom text'''}}

The text above produces:

@@ Line 6: / Line 6: @@
 * Title = Title of the box, the only part that will not be hidden. (default = "Navigation")
 * Collapse = Should the box collapse by default?
-** Yes = Collapsed by default (default setting)
+** Yes = Collapsed by default.
-** No = Open by default
+** No = Open by default.
-** Auto = Collapse if there are other NavBoxes on the page.
+** Auto = Collapse if there are other NavBoxes on the page. (default setting)
-* Above = Text to appear on the top
+** Disable = Hide the [show/hide] button, preventing collapsing.
-* Group1 = Title of Group 1
+* Above = Text to appear on the top.
-* List1 = List of Group 1
+* Group1 = Title of Group 1.
-* Group2 = Title of Group 2
+* List1 = List of Group 1.
-* List2 = List of Group 2
+* Group2 = Title of Group 2.
+* List2 = List of Group 2.
 * ...
-* Group5 = Title of Group 5
+* Group7 = Title of Group 7.
-* List5 = List of Group 5
+* List7 = List of Group 7.
 * Image = Image to appear on the right. '''List1 must be included for this to work!''' You don't need to add the [[ ]].
 * Imagewidth = Possibility to change the width of the image (default 100px).
-* Below = Text to appear on the bottom
+* Below = Text to appear on the bottom.
 ==Notes==
@@ Line 37: / Line 38: @@
 |list3 = ''List can go before the group''
 |group3 = Third?
-|list5 = This list has no group.
+|list5 = This list has no group, so is centered.
+|group7 = This group has no list, so doesn't show.
 |image = Image:Ak22.jpg
 |imagewidth = 70px
@@ Line 53: / Line 55: @@
 |list3 = ''List can go before the group''
 |group3 = Third?
-|list5 = This list has no group.
+|list5 = This list has no group, so is centered.
+|group7 = This group has no list, so doesn't show.
 |image = Image:Ak22.jpg
 |imagewidth = 70px
 |below = '''Bottom text'''}}

Click hide on the right
Top text
First	Test
Third?	List can go before the group
Second?	Main Page
This list has no group, so is centered.
Bottom text