View source for Template:Map caption/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

<p style="width:100%;">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 [[Template:Countries of Europe|European countries]]). For a complete set of elements of reasonable length, a width of (minimally) 250px (without extra padding or margins) should be available.</p>

===Parameters===
Required parameters shown in '''''bold italics'''''
{{Aligned table
 |cols=3 |class=wikitable |style=font-size:95%; |colstyle=padding-left:0.5em;padding-right:0.5em;
 |col1style=font-style:italic;  |col3align=center
 |row1header=on| Parameter | Description | Default

 | countryprefix | {{plainlist|1=
* Neither linked nor styled prefix e.g. "the" (for articles named e.g. "United Kingdom", "Czech Republic", "Netherlands").
}}
 | &ndash;

 | country |{{plainlist|1=
* Only if the country name at the map should not be identical to the article name (e.g. "Metropolitan France").
* <nowiki>Template sets [[...]]</nowiki> (if article or redirect exists).
}}
 | &lt;{{tsp|''article&nbsp;name''}}&gt;

 | location |{{plainlist|1=
* Description identifying ''country''{{'}}s location (e.g. "circled in inset") if default value of ''location_color'' is not appropriate.
* If passed, ''location_color'' is suppressed; a value of "none" suppresses both.
}}
 | &ndash;

 | location_color |{{plainlist|1=
* Only if ''location'' is not used: Colour identifying ''country''{{'}}s location; "none" suppresses the default.
}}
 | orange

 | region |{{plainlist|1=
* Name (or equally extremely short description) for approximately the entire area depicted by the map.
* <span style{{=}}"visibility:hidden;">special:&nbsp;</span>"<nowiki>[[</nowiki>Antarctica<nowiki>]]</nowiki>" shown as "on [[Antarctica]]",
* <span style{{=}}"visibility:hidden;">special:&nbsp;</span>"<nowiki>[[</nowiki>Middle East<nowiki>]]</nowiki>", "<nowiki>[[</nowiki>Arctic Circle<nowiki>]]</nowiki>" or "<nowiki>[[</nowiki>Pacific Ocean<nowiki>]]</nowiki>" shown as "in the ...",
* <span style{{=}}"visibility:hidden;">special:&nbsp;</span>versus any other: shown as "in ...", e.g. "<nowiki>[[</nowiki>Africa<nowiki>]]</nowiki>" shown as "in Africa"
}}
 | &ndash;

 | region_color |{{plainlist|1=
* Colour identifying ''region''; "none" suppresses the default.
}}
 | white

 | subregion |{{plainlist|1=
* Subregion indicated within region <span style{{=}}"font-size:87%;">(only if used: aligning both region and subregion lines to the left, else single region line centered as top line)</span>
* Must not occur without parameter ''region''.
* <span style{{=}}"visibility:hidden;">special:&nbsp;</span>"<nowiki>[[</nowiki>EU<nowiki>]]</nowiki>" or "<nowiki>[[</nowiki>European Union<nowiki>]]</nowiki>" shown as "in the [[European Union]]",
* <span style{{=}}"visibility:hidden;">special:&nbsp;</span>versus any other: shown as "in ...", e.g. "the <nowiki>[[</nowiki>Caucasus<nowiki>]]</nowiki>" shown as "in the [[Caucasus]]"
}}
 | &ndash;

 | subregion_color |{{plainlist|1=
* Colour identifying ''subregion''; "none" suppresses showing the default.
}}
 | tan

 | legend |{{plainlist|1=
* Filename of image providing a map legend.
}}
 | &ndash;
}}<!--(end Aligned table)-->
; Note : <div style="font-size:95%;line-height:1.35em;font-weight:400;"> If ''country'', ''region'' or ''subregion'' is exactly the name of a page in article space, the template automatically creates a link to it. You can still put a link here manually, using the usual syntax.</div>

===Examples===
{| style="width:100%; border:1px solid #a0a0a0; background-color:#f8f8ff;"<!-- no class formatting other than article space: mustnot show result in any different style here -->
|- style="vertical-align:top;text-align:left;"
|style="width:50%; font-size:110%;font-weight:bold;"| Code || <span style="font-size:110%;font-weight:bold;">Raw result</span> (in unformatted box, compare to handling in Infobox)
|- style="vertical-align:top;"
|colspan="2" style="padding-top:.5em; font-size:87%;"|<code style="color:#705000;"><nowiki>{{map caption}}</nowiki></code>
|-
| ||
{|style="border:1px solid #000000;"
|-
|style="padding:0;"|{{map caption}}
|}
|- style="vertical-align:top;"
|colspan="2" style="padding-top:1.5em; font-size:87%; color:#705000;"|<code><nowiki>{{map caption |region=Europe |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|style="border:1px solid #000000;"
|-
|style="padding:0;"|{{map caption |region=Europe |legend=European location legend en.png}}
|}
|- style="vertical-align:top;"
|colspan="2" style="padding-top:1.5em; font-size:87%; color:#705000;"| <code><nowiki>{{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|style="border:1px solid #000000;"
|-
|style="padding:0;"|{{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}}
|}
|- style="vertical-align:top;"
|colspan="2" style="padding-top:1.5em; font-size:87%;"| ''&nbsp;Typical sample for an article on a European Union member that needs no "the" before its name, for otherwise identical output:''<br /><code style="color:#705000;"><nowiki>{{map caption |region=Europe |subregion=EU |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|style="border:1px solid #000000;"
|-
|style="padding:0;|{{map caption |region=Europe |subregion=EU |legend=European location legend en.png}}
|}
|}

{| xclass="toccolours" style="width:100%; margin-top:.5em;border:1px solid #a0a0a0;background-color:#f8f8ff;" <!-- no class formatting other than article space -->
|- style="text-align:left;"
|'''<span style="font-size:110%;">Infobox usage of code</span> (as intended)''' — in which the alignment, the padding/margins, and font are rendered differently (''this'' template adjusts for ''that'' infobox):
|- style="text-align:left;line-height:1.4em;font-size:87%;"
|style="white-space:normal;"|'''Sample for article named 'Armenia', about a non-European country'''<br />
<code><nowiki>
{{Infobox Country or territory|</nowiki><br />
<nowiki>  |common_name             = Armenia</nowiki><br />
<nowiki>  |image_map               = Europe location ARM.png</nowiki><br />
<nowiki>  |map_caption             = </nowiki><span style="color:#705000;"><nowiki>{{map caption}}</nowiki></span><br />
''<nowiki>  |(some required infobox parameters omitted from sample)</nowiki>''<br />
<nowiki>}}</nowiki></code><span style="line-height:.9em;"><br /><br /></span>'''Sample for article named 'Belarus', about a non-member of the EU'''<br />
<code><nowiki>
{{Infobox Country or territory|</nowiki><br />
<nowiki>  |common_name             = Belarus</nowiki><br />
<nowiki>  |image_map               = Europe location BLR.png</nowiki><br />
<nowiki>  |map_caption             = </nowiki><span style="color:#705000;"><nowiki>{{map caption |region=Europe |legend=European location legend en.png}}</nowiki></span><br />
''<nowiki>  |(some required infobox parameters omitted from sample)</nowiki>''<br />
<nowiki>}}</nowiki></code><span style="line-height:.9em;"><br /><br /></span>
'''Sample for article named 'Netherlands', about a member of the EU'''<br />
<code><nowiki>
{{Infobox Country or territory|</nowiki><br />
<nowiki>  |common_name             = the Netherlands</nowiki><br />
<nowiki>  |image_map               = EU location NED.png</nowiki><br />
<nowiki>  |map_caption             = </nowiki><span style="color:#705000;"><nowiki>{{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}}</nowiki></span><br />
''<nowiki>  |(some required infobox parameters omitted from sample)</nowiki>''<br />
<nowiki>}}</nowiki></code>
|-
|
{| style="background-color:#f8f8ff;"
|-
|colspan="3" |<span style="font-size:110%;">'''Net result'''</span> — The three simplified samples above, shown here side by side<br /><span style="font-size:110%;visibility:hidden;">'''Net result''' —&nbsp;</span><span style="font-size:87%;">(called here without country parameter, and with placeholder values for population to prevent error messages)</span>:
|- style="vertical-align:top;"
|{{Infobox country|
   |common_name             = Armenia
   |image_map               = Europe location ARM.png 
   |map_caption             = {{map caption}}
   |capital                 = <span style="display:none">x</span>
   |government_type         = <span style="display:none">x</span>
   |official_languages      = <span style="display:none">x</span>
   |area_km2                    = 10
   |area_sq_mi                 = <span style="display:none">0</span>
   |population_density_km2      = 10
   |population_density_rank = <span style="display:none">0</span>
   |population_density_sq_mi   = <span style="display:none">0</span>
   |time_zone               = <span style="display:none">x</span>
   |utc_offset              = <span style="display:none">0</span>
   |cctld                   = <span style="display:none">x</span>
   |currency                = <span style="display:none">x</span>
   |currency_code           = <span style="display:none">x</span>
   |calling_code            = <span style="display:none">0</span>
   |footnotes               = 
 }}
|{{Infobox country|
   |common_name             = Belarus
   |image_map               = Europe location BLR.png 
   |map_caption             = {{map caption |region=Europe |legend=European location legend en.png}}
   |capital                 = <span style="display:none">x</span>
   |government_type         = <span style="display:none">x</span>
   |official_languages      = <span style="display:none">x</span>
   |area_km2                    = 10
   |area_sq_mi                 = <span style="display:none">0</span>
   |population_density_km2      = 10
   |population_density_rank = <span style="display:none">0</span>
   |population_density_sq_mi   = <span style="display:none">0</span>
   |time_zone               = <span style="display:none">x</span>
   |utc_offset              = <span style="display:none">0</span>
   |cctld                   = <span style="display:none">x</span>
   |currency                = <span style="display:none">x</span>
   |currency_code           = <span style="display:none">x</span>
   |calling_code            = <span style="display:none">0</span>
   |footnotes               = 
 }}
|{{Infobox country|
   |common_name             = the Netherlands
   |image_map               = EU location NED.png
   |map_caption             = {{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}}
   |capital                 = <span style="display:none">x</span>
   |government_type         = <span style="display:none">x</span>
   |official_languages      = <span style="display:none">x</span>
   |area_km2                    = 10
   |area_sq_mi                 = <span style="display:none">0</span>
   |population_density_km2      = 10
   |population_density_rank = <span style="display:none">0</span>
   |population_density_sq_mi   = <span style="display:none">0</span>
   |time_zone               = <span style="display:none">x</span>
   |utc_offset              = <span style="display:none">0</span>
   |cctld                   = <span style="display:none">x</span>
   |currency                = <span style="display:none">x</span>
   |currency_code           = <span style="display:none">x</span>
   |calling_code            = <span style="display:none">0</span>
   |footnotes               = 
 }}
|}
|}

<includeonly>{{Sandbox other|
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:Map formatting and function templates]]

}}</includeonly>