[edit] [purge] Template documentation
The template documentation below is transcluded from Template:United States topic/doc [edit]
Information icon.svg This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

This template allows quick creation of navigational template for groups of articles containing names of U.S. states. It uses Template:Navbox to create the navigation box.

Blank syntax

{{United States topic
<!--passed through to Template:Navbox-->
| name       =
| state      = 
| title      = 
| titlestyle =
| bodystyle  = 
| groupstyle = 
<!--specific to Template:United States topic-->
| prefix =
| suffix =
| exclude-wdc =
| exclude-ter =
| exclude-isl =
}}

Parameters

Mandatory

name
Mandatory when creating a new template (i.e. Template:Hospitals in the United States), otherwise the the "view · talk · edit" links will connect to Template:United States topic. You can enter {{subst:PAGENAME}} for this value as a shortcut.

One of the following combinations is needed to create the links:

prefix
Places text before the U.S. state name. For example: |prefix = List of airports in would create a title List of airports in the United States and a body containing state names linked to List of airports in Alabama, List of airports in Alaska, etc.
Note: in instances when only prefix is specified, the template inserts "the" between the prefix text and "United States", creating the title List of airports in the United States instead of List of airports in United States. In the body it does the same for the Northern Mariana Islands and the United States Virgin Islands.
suffix
Places text after the U.S. state name. For example: |suffix = National Guard would create a title United States National Guard and a body containing state names linked to Alabama National Guard, Alaska National Guard, etc.
prefix and suffix
Places text before and after the U.S. state name. For example: |prefix = List of and |suffix = rivers would create a title List of United States rivers and a body containing state names linked to List of Alabama rivers, List of Alaska rivers, etc.
Note: The title in this example should be replaced by using the title parameter described below.

Optional

state
A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use collapsible. If set to collapsed, the navbox will always start out in a collapsed state. If set to blank or anything other than autocollapse or collapsed, the navbox will always start out in an expanded state.
Default is: autocollapse.
title
Text that appears centered in the titlebar (the top bar). This is optional because the use of either prefix, suffix or both will automatically generate a title if the title parameter is not supplied. This parameter is not automatically wiki-linked. For example: title = [[List of rivers in the United States|Rivers in the United States]] generates the title Rivers in the United States.

Excluding groups

In some instances the District of Columbia, U.S. Territories (Insular Areas) or U.S. Minor Outlying Islands may not have their own articles on particular topics. To disable their inclusion in the template and avoid unnecessary red links, add any or all of the following parameters:

exclude-wdc
Set to any value this excludes display of the group named Federal District which links to Washington, D.C..
exclude-ter
Set to any value this excludes display of the group named Territories (Insular Areas) which links to American Samoa, Guam, etc.
exclude-isl
Set to any value this excludes display of the group named Outlying Islands which links to Baker Island, Howland Island, etc.

Adding groups and lists

Some templates may require a list of links not already included in the template. These can be specified as follows:

list5
Text or a list of links that is displayed below the state and territory links.
group5
Header text displayed in cell to left of text specified in list5.
above
A full-width cell (no group header) displayed above the template's body (between the title and U.S. state links).
below
A full-width cell (no group header) displayed below the template's body.

Change state name used in link

The link for the District of Columbia uses "Washington, D.C." and for the state of Georgia it is "Georgia (U.S. state)". The following parameters allow for substitution where the article name does not use the default

DC
Replace "Washington, D.C." in links with specified text, i.e. "District of Columbia" or "the District of Columbia".
| DC = District of Columbia
GA
Replace "Georgia (U.S. state)" in links with specified text, i.e. "Georgia".
| GA = Georgia

Styles

titlestyle
Specifies CSS values to apply to the title. One use of this is to set the background color of the title:
titlestyle = background: #0000FF;
titlestyle = background: blue;
Default is: background: #ccccff;
bodystyle
Specifies CSS values to apply to the entire template. This will not override the following {{Navbox}} default styles:
abovestyle = background:#ddddff;
belowstyle = background:#ddddff;
groupstyle = background:#ddddff; text-align:right; white-space:nowrap;
liststyle = width:100%; font-size:95%;
abovestyle
belowstyle
Specifies CSS values to apply to the cell specified via the above and below parameters. For instance:
belowstyle = border-top: #ccccff 1px solid;
Default is: background: #ddddff;
groupstyle
Specifies CSS values to apply to the cells specified via the groupn cells. This option overrides any styles that are applied to the entire table. Example:
groupstyle = background:#6AFB92; vertical-align:top;
Default is: background: #ddddff; text-align:right; white-space:nowrap;
liststyle
Specifies CSS values to apply to the cells specified via the listn cells. This option overrides any styles that are applied to the entire table. Examples:
liststyle = padding: 5px 10px 5px 10px;
Default is: width:100%; font-size:95%;

Examples

Changing the navigation box title

{{United States topic
| title  = [[History of the United States]] by political division
| prefix = History of
}}


Excluding display of federal district and minor outlying islands

This example also shows the use of the titlestyle to change the background color and the groupstyle parameters to change the background color and vertical alignment of text.

{{United States topic
| title  = [[Airports in the United States]]
| titlestyle = background: #64E986;
| groupstyle = background: #6AFB92; vertical-align: top;
| prefix = List of airports in
| exclude-wdc = y
| exclude-isl = y
}}


Adding suffix without leading space

This example also shows the use of the liststyle parameter to add some extra padding around the list, the group1 parameter to remove the "States" heading, and the GA parameter to change link from "Georgia (U.S. state)" to "Georgia".

{{United States topic
| liststyle = padding: 5px 10px 5px 10px;
| group1 =
| prefix = List of
| suffix = -related topics
| GA = Georgia
| exclude-wdc = y
| exclude-ter = y
| exclude-isl = y
}}


Adding suffix with leading space

Note the use of an underscore in place of the leading space in the suffix. This is done to accommodate the use of suffixes without a leading space, as in the previous example. A title should be specified to avoid the underscore appearing in the title. This example also uses the DC parameter to change link from "Washington, D.C." to "District of Columbia".

{{United States topic
| title  = [[Rivers in the United States]] 
| prefix = List of
| suffix = _rivers
| DC = District of Columbia
| exclude-isl = y
}}


Using a suffix without a prefix

This example also shows use of the group5 and list5 parameters to add a group and list.

{{United States topic
<!--passed through to Template: Navbox -->
| title   = [[United States National Guard|National Guard]] in the [[United States]]
| group5  = {{nowrap|[[Federal district]]<br/>and [[insular area|territories]]}}
| list5   = [[District of Columbia National Guard|District of Columbia]]{{·}} [[Puerto Rico National Guard|Puerto Rico]]{{·}} [[Virgin Islands National Guard|U.S. Virgin Islands]] 
<!-- specific to Template: United States topic -->
| suffix  = _National Guard
| GA = Georgia
| exclude-wdc = y
| exclude-ter = y
| exclude-isl = y


Creating a new template

Code used to create Template:Hospitals in the United States:

{{United States topic
<!--passed through to Template:Navbox-->
| name  = {{subst:PAGENAME}}
| title = [[List of hospitals in the United States|Hospitals in the United States]]
<!--specific to Template:United States topic-->
| prefix = List of hospitals in
| exclude-ter = y
| exclude-isl = y
}}<noinclude>
[[Category:United States topic navigational boxes|{{PAGENAME}}]]
</noinclude>

Note: {{subst:PAGENAME}} in the above example would be replaced by Hospitals in the United States when this code is saved in Template:Hospitals in the United States.

Result:

This page uses content from the English language Wikipedia. The original content was at Template:United States topic. The list of authors can be seen in the page history. As with this Familypedia wiki, the content of Wikipedia is available under the Creative Commons License.


Community content is available under CC-BY-SA unless otherwise noted.