View source for Template:About continent and region topic templates

== General documentation on continent-topic templates ==
<includeonly>{{Hatnote|This documentation is transcluded from [[Template:About continent and region topic templates]].}}</includeonly>
The continent/region-topic templates allow quick creation of a [[Wikipedia:Navigation template|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 <code><nowiki>{{</nowiki>''Continent/region'' topic |''Topic'' [of/in]}}</code>, 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, <code><nowiki>{{Africa topic |Geography of}}</nowiki></code> generates a navigation box titled "Geography of Africa" with a list of country names linked to articles such as [[Geography of Angola]], etc.
;Code
<syntaxhighlight lang="wikitext">{{Africa topic |Geography of}}</syntaxhighlight>
;Result
{{Africa topic |Geography of}}
<br />

The named parameter ''prefix'' can be used in place of the unnamed 1st parameter.
;Code
<syntaxhighlight lang="wikitext">{{Asia topic |prefix=Geography of}}</syntaxhighlight>
;Result
{{Asia topic |prefix=Geography of}}
<br />

====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
<syntaxhighlight lang="wikitext">{{Europe topic |List of |-related topics}}</syntaxhighlight>
;Result
{{Europe topic |List of |-related topics}}
<br />

An underscore can be used to place a space between the country name and the text:
;Code
<syntaxhighlight lang="wikitext">{{North America topic |List of basic | topics}}</syntaxhighlight>
;Result
{{North America topic |List of basic | topics}}
<br />

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
<syntaxhighlight lang="wikitext">{{South America topic |prefix=List of basic |suffix=topics}}</syntaxhighlight>
;Result
{{South America topic |prefix=List of basic |suffix=topics}}
<br />

====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-link]]ed, 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
<syntaxhighlight lang="wikitext">{{Oceania topic |Flag of |title=[[Flags of Oceania]]}}</syntaxhighlight>
;Result
{{Oceania topic |Flag of |title=[[Flags of Oceania]]}}
<br />

====Displaying template in ''show'' mode====
These navigation boxes are set to <code>autocollapse</code> when there is more than one on a page. To force it into collapsed or expanded mode use the ''state'' parameter. If set to <code>collapsed</code>, the navbox will always start out in a collapsed state. If set to blank or anything other than <code>autocollapse</code> or <code>collapsed</code>, the navbox will always start out in an expanded state.
;Code
<syntaxhighlight lang="wikitext">{{Africa topic |prefix=Geography of |state=expand}}</syntaxhighlight>
;Result
{{Africa topic |prefix=Geography of |state=expand}}
<br />

====Disabling dependencies and other territories====
Not all [[Dependent territory|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 [[Wikipedia:Red link|red link]]s), include the parameter "countries_only=yes".
;Code
<syntaxhighlight lang="wikitext">{{Europe topic |prefix=Islam in |state=expanded |countries_only=yes}}</syntaxhighlight>
;Result
{{Europe topic |prefix=Islam in |state=expanded |countries_only=yes}}
<br />

====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]].

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

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

{{Flags of Europe |state=expanded}}
<br />

=== 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 <nowiki>{{Africa topic |Culture of}} or {{North America topic |List of airports in}}</nowiki>, 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 <nowiki>{{North America topic |Maya in}}, where articles could only be written for a small number of nations and {{Oceania topic |Music of}}</nowiki>, 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.<noinclude>
{{DEFAULTSORT:About Continent And Region Topic Templates}}
[[Category:Configurable area-topic templates| ]]
[[Category:Documentation see also templates]]
</noinclude>