View source for Template:United States topic/doc

{{Documentation subpage}}
<!---PLEASE ADD METADATA (categories, interwikis) TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE. EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE--->
{{High-use| 4628 }}
{{Distinguish|Template:United States topics}}
This template allows for the quick creation of a [[WP:Navigation template|navigational template]] for any group of articles which contains the names of the [[U.S. state]]s. It uses {{tlx|Navbox}} to create the navigation box.

This template is intended for use only in Template space. It works differently from {{tl|Asia topic}} and {{tl|North America topic}}, despite the similar names. 

==Blank syntax==
<syntaxhighlight lang="wikitext">
{{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 =
}}
</syntaxhighlight>

==Parameters==
===Mandatory===
; ''name''
: Mandatory when creating a new template (i.e. [[Template:Hospitals in the United States]]), otherwise the "view{{·}} talk{{·}} edit" links will connect to [[Template:United States topic]]. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut.

''One of the following combinations is needed to create the links:''
; ''prefix''
: Text to be placed before the U.S. state name. The prefix text is always followed by a space. For example: '''<code><span style="white-space:nowrap;">prefix = List of airports in</span></code>''' 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: '''<code><span style="white-space:nowrap;">suffix = _National Guard</span></code>''' would create a title [[United States National Guard]] and a body containing state names linked to [[Alabama National Guard]], [[Arizona National Guard]], etc.
: Note: An [[underscore]] is used in place of the leading space in the suffix. This is done to allow the use of suffixes without a leading space, as in the following example. A title should be specified to avoid the underscore appearing in the title.

; ''prefix'' {{nobold|and}} ''suffix''
: Places text before and after the U.S. state name. For example: '''<code><span style="white-space:nowrap;">prefix = Index of</span></code>''' and '''<code><span style="white-space:nowrap;">suffix = -related articles</span></code>''' would create a title [[Index of United States-related articles]] and a body containing state names linked to [[Index of Alabama-related articles]], [[Index of Alaska-related articles]], etc.

===Optional===
; ''state''
: {{collapsible option}}

; ''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 [[wikitext|wiki-link]]ed. For example: <code><span style="white-space:nowrap;"><nowiki>title = [[List of rivers of the United States|Rivers in the United States]]</nowiki></span></code> generates the title '''[[List of rivers of the United States|Rivers in the United States]]'''.

; ''navbar''<nowiki>*</nowiki>
: Defaults to <code>Tnavbar</code>. If set to <code>plain</code>, the <small>v • d • e</small> links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use <code>off</code> to remove the <small>v • d • e</small> links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). Note that it is highly recommended that one does not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.

====Excluding groups====
In some instances the District of Columbia, U.S. Territories (Insular Areas) or U.S. Minor Outlying Islands may not be relevant to or have their own articles on a particular topic. To disable their inclusion in the template and avoid unnecessary [[WP:Red link|red link]]s, 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. '''Note:''' even if ''exclude-isl'' is '''not''' set, links will not appear for pages that do not exist. If none of the pages in this group exist, the heading for the group will not appear either.

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

; ''group5''
: Header text displayed in cell to left of text specified in ''list5''.

; ''list5''
: Text or a list of links that is displayed below the state and territory links.

; ''group6''
: Header text displayed in cell to left of text specified in ''list6''.

; ''list6''
: Text or a list of links that is displayed below the state and territory links.

; ''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====
By default this template uses "[[Georgia (U.S. state)]]" for the state of Georgia, "[[New York (state)]]" for the state of New York, and "[[Washington (state)]]" for the state of Washington. Links for the District of Columbia use "[[Washington, D.C.]]"

The following parameters allow for substitution where the article name does not use the default.

; ''GA''
: Replace "Georgia (U.S. state)" in links with specified text, i.e. "Georgia".
:: <code>|GA = Georgia</code>

; ''NY''
: Replace "New York (state)" in links with specified text, i.e. "New York".
:: <code>|NY = New York</code>

; ''WA''
: Replace "Washington (state)" in links with specified text, i.e. "Washington".
:: <code>|WA = Washington</code>

; ''DC''
: Replace "Washington, D.C." in links with specified text, i.e. "District of Columbia" or "the District of Columbia".
:: <code>|DC = District of Columbia</code>

; ''DC-text''
: Replace "Washington, D.C." in the displayed text but not in the link.
:: <code>|DC-text = District of Columbia</code>
:<code>DC-text</code> can be combined with <code>DC</code> to change both link and text, for example:
:<code>|DC = District of Columbia |DC-text = District of Columbia</code>

====Styles====
; ''titlestyle''
: Specifies [[Cascading Style Sheets|CSS]] values to apply to the title. One use of this is to set the background color of the title:
:: <code>titlestyle = background: #0000FF;</code>
:: <code>titlestyle = background: blue;</code>
:Default is: <code><span style="background: #ccccff;">background: #ccccff;</span></code>

; ''bodystyle''
: Specifies CSS values to apply to the entire template. This will not override the following {{tl|Navbox}} default styles:
:: <code>abovestyle = background:#ddddff;</code>
:: <code>belowstyle = background:#ddddff;</code>
:: <code>groupstyle = background:#ddddff; text-align:right; white-space:nowrap;</code>
:: <code>liststyle  = width:100%; font-size:95%;</code>

; ''abovestyle''
; ''belowstyle''
: Specifies CSS values to apply to the cell specified via the ''above'' and ''below'' parameters. For instance:
:: <code>belowstyle = border-top: #ccccff 1px solid;</code>
:Default is: <code><span style="background: #ddddff;">background: #ddddff;</span></code>

; ''groupstyle''
: Specifies CSS values to apply to the cells specified via the ''group<sub>n</sub>'' cells. This option overrides any styles that are applied to the entire table. Example:
:: <code>groupstyle = background:#6AFB92; vertical-align:top;</code>
:Default is: <code><span style="background: #ddddff;">background: #ddddff;</span> text-align:right; white-space:nowrap;</code>

; ''liststyle''
: Specifies CSS values to apply to the cells specified via the ''list<sub>n</sub>'' cells. This option overrides any styles that are applied to the entire table. Examples:
:: <code>liststyle = padding: 5px 10px 5px 10px;</code>
:Default is: <code>width:100%; font-size:95%;</code>

==Examples==
===Changing the navbox title===
<syntaxhighlight lang="wikitext">
{{United States topic
|title  = [[History of the United States]] by polity
|prefix = History of
|NY = New York
}}
</syntaxhighlight>
{{United States topic
|state  = uncollapsed
|title  = [[History of the United States]] by polity
|prefix = History of
|NY = New York
}}

===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.
<syntaxhighlight lang="wikitext">
{{United States topic
|title = [[List of airports in the United States|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
|NY = New York
|WA = Washington
}}
</syntaxhighlight>
{{United States topic
|state = uncollapsed
|title = [[List of airports in the United States|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
|WA = Washington
|NY = New York
}}

===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 '''WA''' parameter to change link from "Washington (state)" to "Washington".
<syntaxhighlight lang="wikitext">
{{United States topic
|liststyle = padding: 5px 10px 5px 10px;
|group1 =
|prefix = Index of
|suffix = -related articles
|exclude-wdc = y
|exclude-ter = y
|exclude-isl = y
|NY = New York
|WA = Washington
}}
</syntaxhighlight>
{{United States topic
|state = uncollapsed
|liststyle = padding: 5px 10px 5px 10px;
|group1 =
|prefix = Index of
|suffix = -related articles
|exclude-wdc = y
|exclude-ter = y
|exclude-isl = y
|NY = New York
|WA = Washington
}}

===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".<!-- This is a bad example, as there is no article called "List of X rivers" for any of the 50 states; the lists all have a title of the form "List of rivers of X", and don't use the suffix parameter. As a result, this example has links to redirects instead of articles. -->
<syntaxhighlight lang="wikitext">
{{United States topic
|title  = [[List of rivers of the United States|Rivers in the United States]]
|prefix = List of
|suffix = _rivers
|exclude-isl = y
|DC = District of Columbia
|NY = New York
|WA = Washington
}}
</syntaxhighlight>
{{United States topic
|state  = uncollapsed
|title  = [[List of rivers of the United States|Rivers in the United States]]
|prefix = List of
|suffix = _rivers
|exclude-isl = y
|DC = District of Columbia
|NY = New York
|WA = Washington
}}

===Using a suffix without a prefix===
This example also shows use of the '''group5''' and '''list5''' parameters to add a group and list.
<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{United States topic
<!--passed through to Template: Navbox -->
|title  = [[National Guard of the United States]]
|group5 = Other
|list5  =
*[[District of Columbia National Guard|District of Columbia]]
*[[Puerto Rico National Guard|Puerto Rico]]
*[[Virgin Islands National Guard|U.S.&nbsp;Virgin&nbsp;Islands]]
<!-- specific to Template: United States topic -->
|suffix = _National Guard
|exclude-wdc = y
|exclude-ter = y
|exclude-isl = y
|GA = Georgia
|NY = New York
|WA = Washington
}}
</syntaxhighlight>
{{United States topic
<!--passed through to Template: Navbox -->
|state  = uncollapsed
|title  = [[National Guard of the United States|National Guard]] in the [[United States]]
|group5 = Other
|list5  =
*[[District of Columbia National Guard|District of Columbia]]
*[[Puerto Rico National Guard|Puerto Rico]]
*[[Virgin Islands National Guard|U.S.&nbsp;Virgin&nbsp;Islands]]
<!-- specific to Template: United States topic -->
|suffix  = _National Guard
|exclude-wdc = y
|exclude-ter = y
|exclude-isl = y
|GA = Georgia
|NY = New York
|WA = Washington
}}

===Creating a new template===
Code used to create [[Template:Hospitals in the United States]]:
<syntaxhighlight lang="wikitext">
{{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
|NY = New York
|WA = Washington
}}<noinclude>
[[Category:United States topic navigational boxes]]
</noinclude>
</syntaxhighlight>
Note: '''<nowiki>{{subst:PAGENAME}}</nowiki>''' 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:
{{United States topic
|name   = Hospitals in the United States
|title  = [[List of hospitals in the United States|Hospitals in the United States]]
|state  = uncollapsed
|prefix = List of hospitals in
|exclude-ter = y
|exclude-isl = y
|NY = New York
|WA = Washington
}}

==Templates implemented with United States topic==
# [[Template:Alcohol laws of the United States]]
# [[Template:American wine]]
# [[Template:CAP]]
# [[Template:ClimateUS]]
# [[Template:Constitutions of the United States]]
# [[Template:CrimeUS]]
# [[Template:Flora of the United States by political division]]
# [[Template:Geology of the United States by political division]]
# [[Template:Governments of the United States]]
# [[Template:Grand Lodges in the United States]]
# [[Template:High schools in the United States]]
# [[Template:History of slavery in the United States]]
# [[Template:Hospitals in the United States]]
# [[Template:Judiciaries of the United States]]
# [[Template:Lakes in the United States]]
# [[Template:Law enforcement agencies of the United States by state]]
# [[Template:Law of the United States by state]]
# [[Template:LGBT history in the United States]]
# [[Template:Lists of amphibians by U.S. state]]
# [[Template:Lists of casinos by U.S. state]]
# [[Template:Lists of colleges and universities in the United States]]
# [[Template:Lists of companies by U.S. state]]
# [[Template:Lists of festivals by U.S. state]]
# [[Template:Lists of fossiliferous stratigraphic units in the United States]]
# [[Template:Lists of ghost towns by U.S. state]]
# [[Template:Lists of islands by U.S. state]]
# [[Template:Lists of lieutenant governors by U.S. state]]
# [[Template:Lists of mammals by U.S. state]]
# [[Template:Lists of mines in the United States]]
# [[Template:Lists of people by U.S. state]]
# [[Template:Lists of professional sports teams by U.S. state]]
# [[Template:Lists of reptiles by U.S. state]]
# [[Template:Lists of shopping malls by U.S. state]]
# [[Template:Lists of state forests by U.S. state]]
# [[Template:Lists of state parks by U.S. state]]
# [[Template:Lists of United States airports]]
# [[Template:Lists of United States breweries]]
# [[Template:Lists of US state agencies]]
# [[Template:Mountains of U.S. political divisions]]
# [[Template:Newspapers in the United States]]
# [[Template:Paleontology in the United States]]
# [[Template:Political party strength in U.S. states]]
# [[Template:Politics in the United States]]
# [[Template:Politics of the United States sidebar templates]]
# [[Template:Protected areas of the United States]]
# [[Template:Rivers in the United States]]
# [[Template:Scouting in the United States]]
# [[Template:Statutory codes of the United States by U.S. state]]
# [[Template:Superfund sites in the United States]]
# [[Template:Time in the United States]]
# [[Template:U.S. Counties]]
# [[Template:U.S. political divisions county courthouses]]
# [[Template:U.S. political divisions drug policy]]
# [[Template:U.S. political divisions education]]
# [[Template:U.S. political divisions electoral reform]]
# [[Template:U.S. political divisions geographies]]
# [[Template:U.S. political divisions histories]]
# [[Template:U.S. political divisions transportation]]
# [[Template:U.S. state templates]]
# [[Template:United States political divisions]]
# [[Template:United States school districts]]
# [[Template:US canals]]
# [[Template:US indexes]]
# [[Template:US outlines]]
# [[Template:US state flags]]
# [[Template:US state seals]]
# [[Template:Vehicle registration plates of the United States]]

; Formerly implemented with United States topic
# [[Template:LGBT rights in the United States]]
# [[Template:Lighthouses in the United States]]
# [[Template:Museums in the US]]
# [[Template:Lists of settlements by U.S. state]]
# [[Template:Air National Guard]]
# [[Template:US National Guard by state]]

==See also==
{{Continent-based templates|state=expanded}}

<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:United States topic navigational boxes| ]]
[[Category:Configurable area-topic templates]]
[[Category:Country subdivision navboxes]]
}}</includeonly>