Template:Navbox/doc: Difference between revisions
m (vertical -> horizontal. Duh.) |
(expanded parameter changed; under construction, more later) |
||
Line 1: | Line 1: | ||
{{UnderConstruction|Jovenan}} | |||
This template creates a collapsible horizontal navigation box, i.e. a box containing links to articles related to the subject. Alternatively, the template can be used for any content, such as text or images. The template can be used as a basis of other templates or on its own on an article. | This template creates a collapsible horizontal navigation box, i.e. a box containing links to articles related to the subject. Alternatively, the template can be used for any content, such as text or images. The template can be used as a basis of other templates or on its own on an article. | ||
Line 25: | Line 26: | ||
|Contents}}</pre> | |Contents}}</pre> | ||
'''EXPANDED''' determines if the navigation box is expanded or collapsed (open or closed) when the page is opened. | '''EXPANDED''' determines if the navigation box is expanded or collapsed (open or closed) when the page is opened. Any text (such as "yes", "true", "1") causes the box to be initially opened. Leave empty if that is not desired. | ||
'''WIDTH''' determines the width of the navigation box. Enter the width in pixels (e.g. 150px), as percentage of the width of the article (e.g. 80%) or in other supported measures. Defaults to full width. | '''WIDTH''' determines the width of the navigation box. Enter the width in pixels (e.g. 150px), as percentage of the width of the article (e.g. 80%) or in other supported measures. Defaults to full width. | ||
Line 104: | Line 105: | ||
}, | }, | ||
"EXPANDED": { | "EXPANDED": { | ||
"description": "If | "description": "If not empty, the box will be expanded when the page is accessed.", | ||
"default": "empty" | |||
"default": " | |||
}, | }, | ||
"WIDTH": { | "WIDTH": { |
Revision as of 10:39, 9 January 2024
This notice was placed here by Jovenan, so go bug her to finish the page if nothing's happening.
This template creates a collapsible horizontal navigation box, i.e. a box containing links to articles related to the subject. Alternatively, the template can be used for any content, such as text or images. The template can be used as a basis of other templates or on its own on an article.
Note that the collapsibility does not work in mobile view. The box will still appear.
Usage
Minimal use:
{{Navbox|TITLE=Title|Contents}}
The text within the template without parameter creates the contents of the navigation box.
Enter the parameter TITLE for the title of the navigation box.
Other parameters are optional.
Full use:
{{Navbox |EXPANDED=Expanded |WIDTH=Width |TEXTCOLOR=Text color |TITLEBACKGROUND=Title background |BACKGROUND=Background |ALIGN=Align |TITLE=Title |Contents}}
EXPANDED determines if the navigation box is expanded or collapsed (open or closed) when the page is opened. Any text (such as "yes", "true", "1") causes the box to be initially opened. Leave empty if that is not desired.
WIDTH determines the width of the navigation box. Enter the width in pixels (e.g. 150px), as percentage of the width of the article (e.g. 80%) or in other supported measures. Defaults to full width.
TEXTCOLOR determines the color of the title. Enter the color in HTML names (e.g. white) or in hex code (e.g. #FEF7FC). Defaults to the black.
COLOR determines the background color of the title. Enter the color in HTML names (e.g. black) or in hex code (e.g. #B57EDC). Defaults to #efefef, which is a shade of light grey.
BACKGROUND determines the background color of the content. Enter the color in HTML names (e.g. black) or in hex code (e.g. #B57EDC). Defaults to white.
ALIGN determines the alignment of the contents. Defaults to left.
Examples
{{Navbox |ALIGN=center |TITLE=Species of the [[Borderlands]] |[[Klingon]]s • [[Son'a]] • [[Suliban]] • [[Da'al]] • Thama • Nascaik • Demesians}}
{{Navbox |EXPANDED=yes |WIDTH=400px |ALIGN=center |COLOR=#996633 |TEXTCOLOR=white |TITLE=Species of the [[Borderlands]] |[[Klingon]]s • [[Son'a]] • [[Suliban]] • [[Da'al]] • Thama • Nascaik • Demesians}}
Alternate use
{{Navbox |COLOR={{Color|Blue}} |TEXTCOLOR=white |WIDTH=80% |TITLE=Shoreleave |[[File:Classo.jpg|thumb|Rura Penthe is Class D, such as the moon above.]] After the mission in the Muppetverse, the crew of the USS ''Diana'' went to a shore leave on Rura Pethe. Exhausted by the events of the previous mission, Jo Venan decided to use the opportunity for relaxation, as opposed to joining the other officers in exploring their holiday destination. As such, she remained mostly onboard the ship. Later on the shoreleave, Jo visited Doctor Kila for her annual medical check. The Doctor was concerned of Jo's elevated heart rate, deciding to order her to go through some extra tests. Eventually, they found out Jo had an unusually large and warm heart, and no further operations were required.}}
After the mission in the Muppetverse, the crew of the USS Diana went to a shore leave on Rura Pethe. Exhausted by the events of the previous mission, Jo Venan decided to use the opportunity for relaxation, as opposed to joining the other officers in exploring their holiday destination. As such, she remained mostly onboard the ship.
Later on the shoreleave, Jo visited Doctor Kila for her annual medical check. The Doctor was concerned of Jo's elevated heart rate, deciding to order her to go through some extra tests. Eventually, they found out Jo had an unusually large and warm heart, and no further operations were required.
Template data
Creates collapsible navigation box
Parameter | Description | Type | Status | |
---|---|---|---|---|
Contents | 1 | Contents of the box | Unknown | suggested |
TITLE | TITLE | Title of the box | Unknown | required |
EXPANDED | EXPANDED | If not empty, the box will be expanded when the page is accessed.
| Unknown | optional |
WIDTH | WIDTH | Width of the box.
| Unknown | optional |
BACKGROUND | BACKGROUND | Background color of the contents.
| Unknown | optional |
TEXTCOLOR | TEXTCOLOR | Title text color
| Unknown | optional |
COLOR | COLOR | Background color of the title
| Unknown | optional |
ALIGN | ALIGN | Alignment of the text in contents
| Unknown | optional |