note that it is supposed to be cut off at the bottom
| This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the or your user space before changing anything here.
Template intended to simplify adding a standardized and formatted caption below a map indicating the location of something (e.g. a country), possibly referring to the map's main region and optionally also to a shown subregion. Original use within infoboxes (e.g. see articles on European countries). For a complete set of elements (see Parameters) of reasonable length, a width of typically (minimally) 250px (without extra padding or margins) should be available.
|(optional)||countryprefix||Neither linked nor styled prefix e.g. "the" (for articles named e.g. "United Kingdom", "Czech Republic", "Netherlands")||–|
|(optional)||country||Only if the country name at the map should not be identical to the article name (e.g. "Metropolitan France")
Template sets [[...]], thus if identical to article name (default) in article shown in bold instead of linked
|(optional)||location||Only if hereunder colour is not used and its default not appropriate: Description identifying country's location (e.g. "circled in inset")
This parameter must never be empty; "none" suppresses it. If passed, location_color cannot be shown
|(optional)||location_color||Only if above description is not used: Colour identifying country's location; "none" suppresses showing the default.||orange|
|(optional)||region||Name (or equally extremely short description) for approximately the entire area depicted by the map.
"[[Europe]]" shown as "on the European continent",
"[[Antarctica]]" shown as "on Antarctica",
"[[Middle East]]", "[[Arctic Circle]]" or "[[Pacific Ocean]]" shown as "in the ...",
versus any other: shown as "in ...", e.g. "[[Africa]]" shown as "in Africa"
|(optional)||region_color||Colour identifying region; "none" suppresses showing the default.||white|
|(optional)||subregion||Subregion indicated within region (only if used: aligning both region and subregion lines to the left, else single region line centered as top line)
Must not occur without parameter region.
"[[EU]]" or "[[European Union]]" shown as "in the European Union",
versus any other: shown as "in ...", e.g. "the [[Caucasus]]" shown as "in the Caucasus"
|(optional)||subregion_color||Colour identifying subregion; "none" suppresses showing the default.||camel|
|(optional)||legend||Filename of image providing a map legend||–|
|Note: In case the name of any article or redirect page on this Wikipedia is given for a country, region or subregion (without other characters in the parameter), the template automatically creates a link. It is nevertheless possible to pass a parameter between linking brackets [[...]] and such is required in case only a part of the parameter should be linked or in case a link should reach an article by another name using syntax [[...|...]].|
|Code||Raw result (in unformatted box, compare to handling in Infobox)|
| Typical sample for an article on a European Union member that needs no "the" before its name, for otherwise identical output:|
|Infobox usage of code (as intended) — wherein the alignment, the padding/margins, and font are rendered differently (this template adjusts for that infobox):|
|Sample for article named 'Armenia', about a non-European country|
|The above documentation is transcluded from ទំព័រគំរូ:Map caption/doc. (edit | history)|
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.