Template:Foo–Bar relations category/doc
This is a documentation subpage for Template:Foo–Bar relations category. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on many 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. |
This creates a category page for the category of bilateral relations between two countries named "Foo" and "Bar."
The page name must take the form "Category:Foo–Bar relations", with an endash between the two country names. The template will report an error if the title does not take this form.
Note that using "Category:Foo-Bar relations" will be treated as an error because it uses a dash rather than an endash.
Usage
change{{Foo–Bar relations category}}
Two optional parameters are available:
main=
, which sets the name of the "main article" link in the category header. The default is the category title, but in some cases, this may not be appropriate:map=
, which sets the filename of the map displayed in the category header. The default is derived from the category title, but in some cases, this may be inappropriate or unavailable
{{Foo–Bar relations category|main=Some article|map=somefile}}
Output
changeMost countries
change[[File:Foo Bar Locator.png]]
{{Cat main}}
[[Category:Bilateral relations of Foo|Bar]]
[[Category:Bilateral relations of Bar|Foo]]
"The" Country
changeThis template uses {{CountryPrefixThe}} to intelligently handle countries whose name is prefixed by "the" in running text. e.g. "the United States" or "the Soviet Union"
Example: Category:Comoros–Ghana relations
{{Cat main}}
[[Category:Bilateral relations of Ghana|Comoros]]
[[Category:Bilateral relations of the Comoros|Ghana]]
Exceptions
changeIn some cases, the parent Category:Bilateral relations of SomeCountry
may use a different name to that used in "Category:SomeCountry–OtherCountry relations" categories. In such cases, a sub-template Template:Foo–Bar relations category/fixcountryname handles the correction. As of December 2018, its only entry is Palestine/State of Palestine: e.g. Category:Ireland–State of Palestine relations is a subcat of Category:Bilateral relations of the State of Palestine.
Location map
changeUnless a |map=
parameter is supplied, the sub-template {{Foo–Bar relations category/mapname}} looks for a map, and displays it if found.
There is a large collection of bilateral maps at Commons:Category:Bilateral maps.
For an example Category:Foo–Bar relations, the template looks in the following order:
- File:Foo Bar Locator.png
- File:Foo Bar Locator.svg
- File:Bar Foo Locator.png
- File:Bar Foo Locator.svg
If no file is found with those titles, the search is repeated using a lower "locator".
Tracking categories
changeUsed on a non-category page
- Category:Template Foo–Bar relations on non-category page (population: 0)
Used on category page with an invalid title
"main=" has a non-nil value
"main=" has a non-nil value, but the page specified does not exist
- Category:Template Foo–Bar relations category with non-existent specified main article (population: 0)
A location map is generated
- Category:Template Foo–Bar relations category with a locator map (population: 0)
No location map is generated
- Category:Template Foo–Bar relations category with no locator map (population: 0)
"map=" has a non-nil value
- Category:Template Foo–Bar relations category with specified map (population: 0)
"map=" has a non-nil value, but the page specified does not exist
See also
change