Template:North America topic/sandbox

This is the template sandbox page for Template:North America topic (diff).

Template documentation

This template uses Lua:

This template is used on approximately 3,700 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.

Preview message: Transclusion count updated automatically (see documentation).

General documentation on continent-topic templates

The continent/region-topic templates allow quick creation of a navigational template for groups of articles about a common topic in different countries of a continent/region. It uses Template:Navbox to create the navigation box.

The lists of countries included in the "Continent topic" templates are broadly those found in the "Countries of" templates. Discussions on which countries to include are best conducted on the talk pages of these latter templates.

For example, Oceania generally includes Australia and the nations of the Pacific and islands in the Pacific Ocean that have closer ties to Asia or the Americas are usually grouped accordingly.

Usage

1st parameter (prefix)

The most basic usage of template is with a single unnamed parameter in the format {{Continent/region topic |Topic [of/in]}}, replacing Continent/region with the name of a continent or region and Topic with the name of a topic followed by "of" or "in". For example, {{Africa topic |Geography of}} generates a navigation box titled "Geography of Africa" with a list of country names linked to articles such as Geography of Angola, etc.

Code

{{Africa topic |Geography of}}

Result

The named parameter prefix can be used in place of the unnamed 1st parameter.

Code

{{Asia topic |prefix=Geography of}}

Result

2nd parameter (suffix)

The template accepts a second unnamed parameter for text to be placed after the country name. There is no space between the country name and the suffix, to allow for links to articles such as List of Spain-related topics.

Code

{{Europe topic |List of |-related topics}}

Result

An underscore can be used to place a space between the country name and the text:

Code

{{North America topic |List of basic | topics}}

Result

Note that in the above example the links work but the underscore is displayed in the title. This can be fixed by specifying a title (see next section) or by using the named parameter suffix which always places a space between the country name and text.

Code

{{South America topic |prefix=List of basic |suffix=topics}}

Result

Changing the title

The title parameter is used to specify text which appears in the title bar at the top of the navigation box. This is optional because the use of prefix, suffix or both will automatically generate a title, as shown in the previous examples. This title is not automatically wiki-linked, so add brackets as needed.

The following shows a navigation box with links to articles such as Flag of Australia, but replaces the default title "Flag of Oceania" with the specified title "Flags of Oceania".

Code

{{Oceania topic |Flag of |title=[[Flags of Oceania]]}}

Result

Displaying template in show mode

These navigation boxes are set to autocollapse when there is more than one on a page. To force it into collapsed or expanded mode use the state parameter. 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.

Code

{{Africa topic |prefix=Geography of |state=expand}}

Result

Disabling dependencies and other territories

Not all dependencies or similar territories have their own articles on particular topics. To disable the inclusion of such territories in a template (that would otherwise appear as red links), include the parameter "countries_only=yes".

Code

{{Europe topic |prefix=Islam in |state=expanded |countries_only=yes}}

Result

Creating a new template

Although these templates can be used in an article, they can also be used to create a new template. The name parameter is mandatory when creating a new template, because it allows the "V T E" links to work properly. The following example shows code that could be used to create Template:Flags of Europe.

{{Europe topic
 | name = Flags of Europe
 | state = {{{state|{{{1|}}}}}}
 | title = [[Flags of Europe]]
 | prefix = Flag of
}}<noinclude>
[[Category:Europe templates]]
</noinclude>

The template can then be added to articles using {{Flags of Europe}} or {{Flags of Europe |state=expand}}.

When to use the templates

Before implementing these templates in a topic, check for red links. If there are several red links, consider whether a separate article in the topic for each country is warranted.
Some topics may use a different navigational scheme. In general, don't use this template if there are already navigational templates in several of the articles of a topic.

Examples of appropriate articles for these templates are {{Africa topic |Culture of}} or {{North America topic |List of airports in}}, both of which have a number of blue links, and where the majority of red links could have a reasonable article written about them.

Examples of inappropriate articles for these templates are {{North America topic |Maya in}}, where articles could only be written for a small number of nations and {{Oceania topic |Music of}}, where articles already have templates which use a different navigational scheme.

Redirects

When there are a small number of links for which an article is not appropriate, consider making a redirect to the broader article in which the topic is included. For example, Hinduism in Cambodia redirects to Hinduism in Southeast Asia and Geography of Christmas Island redirects to Christmas Island#Geography.

Notes

Navigational templates are usually placed at the end of an article.

List of wrapper templates using Template:North America topic

{{Abortion in North America}}
{{Association football in North America}}
{{Capitals in North America}}
{{Coats of arms of North America}}
{{Culture of North America templates}}
{{Education in North America}}
{{Flags of North America}}
{{Geography of North America}}
{{History of North America by country}}
{{History of North America templates}}
{{Judiciaries of North America}}
{{Lists of schools in North America}}
{{Mountain peaks of North America}}
{{Politics of North America templates}}
{{Sport deaths in North America (category)}}
{{Television in North America}}
{{Tourism in North America}}
{{Women in North America}}
{{Women's association football in North America}}

Data table

Code	Display name [link name]	Switch	Hidden?
	Sovereign states
AG	Antigua and Barbuda
BS	Bahamas [the]
BB	Barbados
BZ	Belize
CA	Canada
CR	Costa Rica
CU	Cuba
DM	Dominica
DO	Dominican Republic [the]
SV	El Salvador
GD	Grenada
GT	Guatemala
HT	Haiti
HN	Honduras
JM	Jamaica
MX	Mexico
NI	Nicaragua
PA	Panama
KN	Saint Kitts and Nevis
LC	Saint Lucia
VC	Saint Vincent and the Grenadines
TT	Trinidad and Tobago
US	United States [the]
	Dependencies and other territories	countries_only
AI	Anguilla
AW	Aruba
BM	Bermuda
XBO	Bonaire
VG	British Virgin Islands [the]
KY	Cayman Islands [the]
CW	Curaçao
GL	Greenland
GP	Guadeloupe
MQ	Martinique
MS	Montserrat
XNV	Navassa Island		Depends on existence
PR	Puerto Rico
BL	Saint Barthélemy
MF	Saint Martin [the Collectivity of Saint Martin]
PM	Saint Pierre and Miquelon
XSA	Saba
XSE	Sint Eustatius
SX	Sint Maarten
TC	Turks and Caicos Islands [the]
VI	United States Virgin Islands [the]

The above documentation is transcluded from Template:North America topic/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

v t e North America
Sovereign states	Antigua and Barbuda Bahamas Barbados Belize Canada Costa Rica Cuba Dominica Dominican Republic El Salvador Grenada Guatemala Haiti Honduras Jamaica Mexico Nicaragua Panama Saint Kitts and Nevis Saint Lucia Saint Vincent and the Grenadines Trinidad and Tobago United States
Dependencies and other territories	Anguilla Aruba Bermuda Bonaire British Virgin Islands Cayman Islands Curaçao Greenland Guadeloupe Martinique Montserrat Navassa Island Puerto Rico Saba Saint Barthélemy Saint Martin Saint Pierre and Miquelon Sint Eustatius Sint Maarten Turks and Caicos Islands United States Virgin Islands

v t e Geography of Africa
Sovereign states	Algeria Angola Benin Botswana Burkina Faso Burundi Cameroon Cape Verde Central African Republic Chad Comoros Democratic Republic of the Congo Republic of the Congo Djibouti Egypt Equatorial Guinea Eritrea Eswatini Ethiopia Gabon The Gambia Ghana Guinea Guinea-Bissau Ivory Coast Kenya Lesotho Liberia Libya Madagascar Malawi Mali Mauritania Mauritius Morocco Mozambique Namibia Niger Nigeria Rwanda São Tomé and Príncipe Senegal Seychelles Sierra Leone Somalia South Africa South Sudan Sudan Tanzania Togo Tunisia Uganda Zambia Zimbabwe
States with limited recognition	Sahrawi Arab Democratic Republic Somaliland
Dependencies and other territories	Canary Islands / Ceuta / Melilla (Spain) Madeira (Portugal) Mayotte / Réunion (France) Saint Helena / Ascension Island / Tristan da Cunha (United Kingdom) Western Sahara

v t e Geography of Asia
Sovereign states	Afghanistan Armenia Azerbaijan Bahrain Bangladesh Bhutan Brunei Cambodia China Cyprus East Timor (Timor-Leste) Egypt Georgia India Indonesia Iran Iraq Israel Japan Jordan Kazakhstan North Korea South Korea Kuwait Kyrgyzstan Laos Lebanon Malaysia Maldives Mongolia Myanmar Nepal Oman Pakistan Philippines Qatar Russia Saudi Arabia Singapore Sri Lanka Syria Tajikistan Thailand Turkey Turkmenistan United Arab Emirates Uzbekistan Vietnam Yemen
States with limited recognition	Abkhazia Northern Cyprus Palestine South Ossetia Taiwan
Dependencies and other territories	British Indian Ocean Territory Christmas Island Cocos (Keeling) Islands Hong Kong Macau
Category Asia portal

v t e List of Europe-related topics
Sovereign states	Albania Andorra Armenia Austria Azerbaijan Belarus Belgium Bosnia and Herzegovina Bulgaria Croatia Cyprus Czech Republic Denmark Estonia Finland France Georgia Germany Greece Hungary Iceland Ireland Italy Kazakhstan Latvia Liechtenstein Lithuania Luxembourg Malta Moldova Monaco Montenegro Netherlands North Macedonia Norway Poland Portugal Romania Russia San Marino Serbia Slovakia Slovenia Spain Sweden Switzerland Turkey Ukraine United Kingdom Vatican City
States with limited recognition	Abkhazia Kosovo Northern Cyprus South Ossetia Transnistria
Dependencies and other entities	Åland Faroe Islands Gibraltar Guernsey Isle of Man Jersey Svalbard

v t e List of basic North America topics
Sovereign states	Antigua and Barbuda Bahamas Barbados Belize Canada Costa Rica Cuba Dominica Dominican Republic El Salvador Grenada Guatemala Haiti Honduras Jamaica Mexico Nicaragua Panama Saint Kitts and Nevis Saint Lucia Saint Vincent and the Grenadines Trinidad and Tobago United States
Dependencies and other territories	Anguilla Aruba Bermuda Bonaire British Virgin Islands Cayman Islands Curaçao Greenland Guadeloupe Martinique Montserrat Puerto Rico Saint Barthélemy Saint Martin Saint Pierre and Miquelon Saba Sint Eustatius Sint Maarten Turks and Caicos Islands United States Virgin Islands

v t e List of basic South America topics
Sovereign states	Argentina Bolivia Brazil Chile Colombia Ecuador Guyana Paraguay Peru Suriname Uruguay Venezuela
Dependencies and other territories	Falkland Islands French Guiana South Georgia and the South Sandwich Islands

v t e Flags of Oceania
Sovereign states	Australia Federated States of Micronesia Fiji Kiribati Marshall Islands Nauru New Zealand Palau Papua New Guinea Samoa Solomon Islands Tonga Tuvalu Vanuatu
Associated states of New Zealand	Cook Islands Niue
Dependencies and other territories	American Samoa Christmas Island Cocos (Keeling) Islands Easter Island French Polynesia Guam Hawaii New Caledonia Norfolk Island Northern Mariana Islands Pitcairn Islands Tokelau Wallis and Futuna