Template:US state navigation box/doc
Kaonekelo
This is a documentation subpage for Template:US state navigation box. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 16,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{US state navigation box/doc}} is a meta-template used for each U.S. state, territory, and the District of Columbia navbox.
Usage
[kulemba source]{{US state navigation box | template_name = {{subst:PAGENAME}} <!-- required --> | title = <!-- required --> | state = | color = | text_color = | capital = | seat = | subtitle = | image = | group1 = <!-- required, can use up to |group9= --> | body1 = <!-- required, can use up to |body9= --> }}
Parameters
[kulemba source]Mandatory
[kulemba source]- template_name
- The name of the template, which is needed for the "view • talk • edit" links to work properly on all of the pages where the template is used on. You can enter
{{subst:PAGENAME}}
for this value as a shortcut.
- title
- Combines the {{{type}}} and {{{name}}} parameters.
- groupn
- Subtitle to appear at the left of each bodyn
- bodyn
- There are a total of 9 group/list pairs, so you can use up to
group9
andlist9
. Additional items can easily be added to the template if needed.
Optional
[kulemba source]- state
[autocollapse, expanded, collapsed]
autocollapse
: (default) the navigation box will start out expanded unless there are two or more collapsible tables on the same page.expanded
: always starts out in an uncollapsed state.collapsed
: the navigation box will always start out in a collapsed state.
- state
- color
- Changes the default background color for the main title and sidebar titles, i.e.
color = #2e8b57
- Working examples: {{California}}, {{Maryland}}, and {{Pennsylvania}}.
- text_color
- Changes the default text color for the main title and sidebar titles. Note that you will still need to manually change the color of any wikilinks using a span tag, i.e.
[[List of Nevada counties|<span style="color :#ffd700;">Counties</span>]]
- Working examples: {{Nevada}}, {{Maine}}, and {{Hawaii}}.
- capital
- Lists the capital below the state
- seat
- Used for the seat of government for {{American Samoa}}.
- subtitle
- Used only on {{District of Columbia}} to say "Capital of the United States" since D.C. has no capital.
- image
- Adds an image to the right of the body area. Use only if there is a lot of extra whitespace at the right side of the body area. It is recommended to use a map to fill the space, similar to Template:US county navigation box. Example:
image = [[Image:example.jpg|250px]]
Example
[kulemba source]Code
[kulemba source]{{US state navigation box | template_name = {{subst:PAGENAME}} | title = [[U.S. state|State]] of [[New York (state)|New York]] | state = {{{state<includeonly>|uncollapsed</includeonly>}}} | capital = [[Albany, New York|Albany]] | listclass = hlist | group1 = [[:Category:New York (state)|Topics]] | body1 = * [[History of New York (state)|History]] * [[List of colleges and universities in New York|Education]] * [[Politics of New York|Politics]] * ... | group2 = [[List of regions of the United States#New York|Regions]] | body2 = * [[Adirondack Mountains]] * [[Capital District, New York|Capital District]] * [[Catskill Mountains]] * ... | group3 = [[List of cities in New York|Metro areas]] | body3 = * [[Albany, New York|Albany]]/[[Schenectady, New York|Schenectady]]/[[Troy, New York|Troy]] * [[Binghamton, New York|Binghamton]] * [[Buffalo, New York|Buffalo]]/[[Niagara Falls, New York|Niagara Falls]] * ... }}
Result
[kulemba source]See also
[kulemba source]Template | Collapsible | Header color | Image | Groups | Style (body) parameter/s |
---|---|---|---|---|---|
{{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 |
Type | CSS classes | JavaScript | Collapses when | Custom initial state |
Nesting |
---|---|---|---|---|---|
Collapsible tables | mw-collapsible | Defined in Common.js | 2 or more autocollapse on page | Yes | Yes |