Template:United States topic

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

This template allows for the quick creation of a navigational template for any group of articles which contains the names of the U.S. states. It uses {{Navbox}} to create the navigation box.

Blank syntax[edit]

{{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[edit]

Mandatory[edit]

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 {{subst:PAGENAME}} 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: 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, 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 and suffix
Places text before and after the U.S. state name. For example: prefix = Index of and suffix = -related articles 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[edit]

state
How to manage this template's initial visibility

To manage this template's visibility when it first appears, add the parameter:

|state=collapsed to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g. {{United States topic |state=collapsed}};
|state=expanded to show the template in its expanded state, i.e. fully visible – e.g. {{United States topic |state=expanded}};
|state=autocollapse to show the template in its collapsed state but only if there is another template of the same type on the page – e.g. {{United States topic |state=autocollapse}}.

Unless set otherwise (see the state parameter in the template's code), the template's default state 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 of the United States|Rivers in the United States]] generates the title Rivers in the United States.
navbar*
Defaults to Tnavbar. If set to plain, the v • d • e links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use off to remove the v • d • e 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[edit]

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 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. 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[edit]

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[edit]

By default this template uses "Georgia (U.S. state)" for the state of Georgia, "New York" 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".
| GA = Georgia
NY
Replace "New York" in links with specified text, i.e. "New York State".
| NY = New York State
WA
Replace "Washington (state)" in links with specified text, i.e. "Washington".
| WA = Washington
DC
Replace "Washington, D.C." in links with specified text, i.e. "District of Columbia" or "the District of Columbia".
| DC = District of Columbia

Styles[edit]

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[edit]

Changing the navbox title[edit]

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

Excluding display of federal district and minor outlying islands[edit]

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  = [[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
| WA = Washington
| exclude-wdc = y
| exclude-isl = y
}}

Adding suffix without leading space[edit]

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".

{{United States topic
| liststyle = padding: 5px 10px 5px 10px;
| group1 =
| prefix = Index of
| suffix = -related articles
| WA = Washington
| exclude-wdc = y
| exclude-ter = y
| exclude-isl = y
}}

Adding suffix with leading space[edit]

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  = [[List of rivers of the United States|Rivers in the United States]]
| prefix = List of
| suffix = _rivers
| DC = District of Columbia
| WA = Washington
| exclude-isl = y
}}

Using a suffix without a prefix[edit]

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   = [[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. Virgin Islands]]
<!-- specific to Template: United States topic -->
| suffix  = _National Guard
| GA = Georgia
| WA = Washington
| exclude-wdc = y
| exclude-ter = y
| exclude-isl = y

Creating a new template[edit]

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
| WA = Washington
| exclude-ter = y
| exclude-isl = y
}}<noinclude>
[[Category:United States topic navigational boxes]]
</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:

Templates implemented with United States topic[edit]

  1. Template: Alcohol laws in the United States
  2. Template: Alcohol Policy in the United States
  3. Template: American wine
  4. Template: CAP
  5. Template: ClimateUS
  6. Template: Constitutions of the United States
  7. Template: CrimeUS
  8. Template: Flora of the United States by political division
  9. Template: FrogsAndToadsByState
  10. Template: Geology of the United States by political division
  11. Template: Governments of the United States
  12. Template: Grand Lodges in the United States
  13. Template: High schools in the United States
  14. Template: History of slavery in the United States
  15. Template: Hospitals in the United States
  16. Template: Judiciaries of the United States
  17. Template: Lakes in the United States
  18. Template: Law of the United States by state
  19. Template: LawByState
  20. Template: Legal codes of the United States by U.S. state
  21. Template: LGBT history in the United States
  22. Template: Lists of amphibians by U.S. state
  23. Template: Lists of casinos by U.S. state
  24. Template: Lists of colleges and universities in the United States
  25. Template: Lists of companies by U.S. state
  26. Template: Lists of festivals by U.S. state
  27. Template: Lists of fossiliferous stratigraphic units in the United States
  28. Template: Lists of ghost towns by U.S. state
  29. Template: Lists of islands by U.S. state
  30. Template: Lists of lieutenant governors by U.S. state
  31. Template: Lists of mammals by U.S. state
  32. Template: Lists of mines in the United States
  33. Template: Lists of museums in the United States
  34. Template: Lists of people by U.S. state
  35. Template: Lists of professional sports teams by U.S. state
  36. Template: Lists of reptiles by U.S. state
  37. Template: Lists of shopping malls by U.S. state
  38. Template: Lists of state forests by U.S. state
  39. Template: Lists of state parks by U.S. state
  40. Template: Lists of United States airports
  41. Template: Lists of United States breweries
  42. Template: Lists of unused highways by U.S. state
  43. Template: Lists of US state agencies
  44. Template: Mountains of U.S. political divisions
  45. Template: Newspapers in the United States
  46. Template: Paleontology in the United States
  47. Template: Political party strength in U.S. states
  48. Template: Politics in the United States
  49. Template: Politics of the United States sidebar templates
  50. Template: Protected Areas of the United States
  51. Template: Rivers in the United States
  52. Template: Scouting in the United States
  53. Template: Superfund sites in the United States
  54. Template: Time in the United States
  55. Template: U.S. Counties
  56. Template: U.S. political divisions county courthouses
  57. Template: U.S. political divisions drug policy
  58. Template: U.S. political divisions education
  59. Template: U.S. political divisions electoral reform
  60. Template: U.S. political divisions geographies
  61. Template: U.S. political divisions governments
  62. Template: U.S. political divisions histories
  63. Template: U.S. political divisions transportation
  64. Template: U.S. state templates
  65. Template: US canals
  66. Template: US indexes
  67. Template: US outlines
  68. Template: US state flags
  69. Template: US state seals
  70. Template: United States political divisions
  71. Template: United States school districts
  72. Template: Vehicle registration plates of the United States
Formerly implemented with United States topic
  1. Template: All-US-interest
  2. Template: LGBT rights in the United States
  3. Template: Lighthouses in the United States
  4. Template: Lists of cities by U.S. state
  5. Template: NGbystate
  6. Template: US ANG by state
  7. Template: US ARNG by state

See also[edit]