John James: Created page with "{{Documentation subpage}}
Template intended to simplify adding a standardized and formatted caption be..."

2011-05-22T21:33:11Z

Created page with "{{Documentation subpage}}  Template intended to simplify adding a standardized and formatted caption be..."

New page

{{Documentation subpage}}

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 (see Parameters) of reasonable length, a width of typically (minimally) 250px (without extra padding or margins) should be available.

===Parameters===
{| class="wikitable" style="font-size:95%;"
!colspan="3" style="padding-left:64px;text-align:left;"| Parameter !! Default
|-
|width="60" style="vertical-align:top;"| (optional) ||width="100" style="vertical-align:top;"| ''countryprefix'' ||Neither linked nor styled prefix e.g. "the" (for articles named e.g. "United Kingdom", "Czech Republic", "Netherlands") || align="center" style="vertical-align:top;"| –
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''country'' || Only if the country name at the map should not be identical to the article name (e.g. "Metropolitan France") <nowiki>Template sets [[...]]</nowiki>, thus if identical to article name (default) in article shown in bold instead of linked ||style="vertical-align:top;"| <''article name''>
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''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 ||align="center" style="vertical-align:top;"| –
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''location_color'' || Only if above description is not used: Colour identifying ''country'''s location; "none" suppresses showing the default. ||align="center" style="vertical-align:top;"| orange
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''region'' || Name (or equally extremely short description) for approximately the entire area depicted by the map. special: "<nowiki>[[</nowiki>Europe<nowiki>]]</nowiki>" shown as "on the [[Europe|European continent]]", special: "<nowiki>[[</nowiki>Antarctica<nowiki>]]</nowiki>" shown as "on [[Antarctica]]", special: "<nowiki>[[</nowiki>Middle East<nowiki>]]</nowiki>", "<nowiki>[[</nowiki>Arctic Circle<nowiki>]]</nowiki>" or "<nowiki>[[</nowiki>Pacific Ocean<nowiki>]]</nowiki>" shown as "in the ...", special: versus any other: shown as "in ...", e.g. "<nowiki>[[</nowiki>Africa<nowiki>]]</nowiki>" shown as "in [[Africa]]" ||align="center" style="vertical-align:top;"| –
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''region_color'' || Colour identifying ''region''; "none" suppresses showing the default. ||align="center" style="vertical-align:top;"| white
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''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''. special: "<nowiki>[[</nowiki>EU<nowiki>]]</nowiki>" or "<nowiki>[[</nowiki>European Union<nowiki>]]</nowiki>" shown as "in the [[European Union]]", special: versus any other: shown as "in ...", e.g. "the <nowiki>[[</nowiki>Caucasus<nowiki>]]</nowiki>" shown as "in the [[Caucasus]]" ||align="center" style="vertical-align:top;"| –
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''subregion_color'' || Colour identifying ''subregion''; "none" suppresses showing the default. ||align="center" style="vertical-align:top;"| camel
|-
|style="vertical-align:top;"| (optional) ||style="vertical-align:top;"| ''legend'' || Filename of image providing a map legend ||align="center" style="vertical-align:top;"| –
|-
!colspan="4" style="text-align:left;"| 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 <nowiki>[[...]]</nowiki> 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 <nowiki>[[...|...]]</nowiki>.
|}

===Examples===
{|width="100%" border="0" style="border:1px solid #a0a0a0;background-color:#f8f8ff;"
|- valign="top" style="text-align:left;"
|width="50%" style="font-size:110%;font-weight:700;"| Code || Raw result (in unformatted box, compare to handling in Infobox)
|- valign="top"
|colspan="2" style="padding-top:.5em; font-size:87%;"|<code style="color:#705000;"><nowiki>{{map caption}}</nowiki></code>
|-
| ||
{|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;"
|-
|style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption}}
|}
|- valign="top"
|colspan="2" style="padding-top:1.5em; font-size:87%;"|<code style="color:#705000;"><nowiki>{{map caption |region=[[Europe]] |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;"
|-
|style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |region=[[Europe]] |legend=European location legend en.png}}
|}
|- valign="top"
|colspan="2" style="padding-top:1.5em; font-size:87%;"| <code style="color:#705000;"><nowiki>{{map caption |countryprefix=the |region=[[Europe]] |subregion=the [[European Union]] |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;"
|-
|style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |countryprefix=the |region=[[Europe]] |subregion=the [[European Union]] |legend=European location legend en.png}}
|}
|- valign="top"
|colspan="2" style="padding-top:1.5em; font-size:87%;"| '' Typical sample for an article on a European Union member that needs no "the" before its name, for otherwise identical output:'' <code style="color:#705000;"><nowiki>{{map caption |region=Europe |subregion=EU |legend=European location legend en.png}}</nowiki></code>
|-
| ||
{|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;"
|-
|style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |region=Europe |subregion=EU |legend=European location legend en.png}}
|}
|}

{| width="100%" xclass="toccolours" style="margin-top:.5em;border:1px solid #a0a0a0;background-color:#f8f8ff;" 
|- style="text-align:left;"
|'''Infobox usage of code (as intended)''' — wherein 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''' 
<code><nowiki>
{{Infobox Country or territory|</nowiki> 
<nowiki> |common_name = Armenia</nowiki> 
<nowiki> |image_map = Europe location ARM.png</nowiki> 
<nowiki> |map_caption = </nowiki><nowiki>{{map caption}}</nowiki> 
''<nowiki> |(other for the Infobox required parameters omitted from sample)</nowiki>'' 
<nowiki>}}</nowiki></code> '''Sample for article named 'Belarus', about a non-member of the EU''' 
<code><nowiki>
{{Infobox Country or territory|</nowiki> 
<nowiki> |common_name = Belarus</nowiki> 
<nowiki> |image_map = Europe location BLR.png</nowiki> 
<nowiki> |map_caption = </nowiki><nowiki>{{map caption |region=[[Europe]] |legend=European location legend en.png}}</nowiki> 
''<nowiki> |(other for the Infobox required parameters omitted from sample)</nowiki>'' 
<nowiki>}}</nowiki></code> 
'''Sample for article named 'Netherlands', about a member of the EU''' 
<code><nowiki>
{{Infobox Country or territory|</nowiki> 
<nowiki> |common_name = the Netherlands</nowiki> 
<nowiki> |image_map = EU location NED.png</nowiki> 
<nowiki> |map_caption = </nowiki><nowiki>{{map caption |countryprefix=the |region=[[Europe]] |subregion=the [[European Union]] |legend=European location legend en.png}}</nowiki> 
''<nowiki> |(other for the Infobox required parameters omitted from sample)</nowiki>'' 
<nowiki>}}</nowiki></code>
|-
|
{| style="background-color:#f8f8ff;"
|-
|colspan="3" |'''Net result''' — The three simplified samples above, shown here side by side '''Net result''' — (called here not from countries' page and without country parameter):
|- valign="top"
|{{Infobox Country or territory|
|common_name = Armenia
|image_map = Europe location ARM.png
|map_caption = {{map caption}}
|capital = x
|government_type = x
|official_languages = x
|area_km2 = 0
|area_sq_mi = 0
|population_density_km2 = 0
|population_density_rank = 0
|population_density_sq_mi = 0
|time_zone = x
|utc_offset = 0
|cctld = x
|currency = x
|currency_code = x
|calling_code = 0
|footnotes =
}}
|{{Infobox Country or territory|
|common_name = Belarus
|image_map = Europe location BLR.png
|map_caption = {{map caption |region=[[Europe]] |legend=European location legend en.png}}
|capital = x
|government_type = x
|official_languages = x
|area_km2 = 0
|area_sq_mi = 0
|population_density_km2 = 0
|population_density_rank = 0
|population_density_sq_mi = 0
|time_zone = x
|utc_offset = 0
|cctld = x
|currency = x
|currency_code = x
|calling_code = 0
|footnotes =
}}
|{{Infobox Country or territory|
|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 = x
|government_type = x
|official_languages = x
|area_km2 = 0
|area_sq_mi = 0
|population_density_km2 = 0
|population_density_rank = 0
|population_density_sq_mi = 0
|time_zone = x
|utc_offset = 0
|cctld = x
|currency = x
|currency_code = x
|calling_code = 0
|footnotes =
}}
|}
|}

<includeonly>

{{DEFAULTSORT:{{PAGENAME}}}}
[[Category:Mapping templates]]


</includeonly>

Template:Map caption/doc - Revision history

John James: Created page with "{{Documentation subpage}} Template intended to simplify adding a standardized and formatted caption be..."

John James: Created page with "{{Documentation subpage}}
Template intended to simplify adding a standardized and formatted caption be..."