Template:Navbox/doc
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=
|width=
|textcolor=
|color=
|background=
|align=
|title=
|bstyle=
|tstyle=
|cstyle=
|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.
Bstyle, tstyle and cstyle allow changes to the CSS styling of the template main box, title box and contents, respectively. These parameters can override all other styling to their respective objects. These are advanced parameters that can cause the template to work incorrectly if entered wrong.
Different capitalisations of the parameter names ("title", "Title", "TITLE") are accepted. Please only use one style per parameter name.
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 shown in the box | Content | suggested |
| Title | title Title TITLE | Title of the box | String | required |
| Width | width Width WIDTH | Width of the box. Use CSS measure units, e.g. pixels (px), em, %.
| Line | optional |
| Color | color Color COLOR | Background color of the title. Use any color naming system recognized in CSS, e.g. HTLM names or HEX
| Line | optional |
| Background color | background Background BACKGROUND | Background color of the contents. Use any color naming system recognized in CSS, e.g. HTLM names or HEX.
| Line | optional |
| Title text color | textcolor Textcolor TEXTCOLOR | Title text color. Use any color naming system recognized in CSS, e.g. HTLM names or HEX.
| Line | optional |
| Text alignment | align Align ALIGN | Alignment of the text in contents, left, right, center, justify
| Line | optional |
| Expanded | expanded Expanded EXPANDED | If not empty, the box will appear expanded (open) when the page is opened. Leave empty if you want the box to be closed when the page is opened. | String | optional |
| Box CSS Style | bstyle Bstyle BSTYLE | Open CSS styling for the template main box, supersedes other template main box style options | String | optional |
| Title CSS Style | tstyle Tstyle TSTYLE | Open CSS styling for the title box, supersedes other title box style options | String | optional |
| Content CSS Style | cstyle Cstyle CSTYLE | Open CSS styling for the content box, supersedes other content box style options | String | optional |