Difference between revisions of "Template:Map caption/doc"
imported>Hairy Dude (correct documentation error: now says just "in Europe") |
imported>Trialpears m (Removing unnecessary Template:Intricate template per Template talk:Intricate template#Change to editnotice? (via WP:JWB)) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- 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> | <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> | ||
| Line 18: | Line 17: | ||
| country | | | country | | ||
* Only if the country name at the map should not be identical to the article name (e.g. "Metropolitan France"). | * Only if the country name at the map should not be identical to the article name (e.g. "Metropolitan France"). | ||
| − | * <nowiki>Template sets [[...]]</nowiki> | + | * <nowiki>Template sets [[...]]</nowiki> (if article or redirect exists). |
| <{{tsp|''article name''}}> | | <{{tsp|''article name''}}> | ||
| location | | | location | | ||
| − | * Only if ''colour' is not used and its default is | + | * Only if ''colour'' is not used and its default is 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. | * This parameter must never be empty; "none" suppresses it. If passed, ''location_color'' cannot be shown. | ||
| – | | – | ||
| location_color | | | location_color | | ||
| − | * Only if ''description'' is not used: Colour identifying ''country'''s location; "none" suppresses the default. | + | * Only if ''description'' is not used: Colour identifying ''country''{{'}}s location; "none" suppresses the default. |
| orange | | orange | ||
| Line 34: | Line 33: | ||
* <span style{{=}}"visibility:hidden;">special: </span>"<nowiki>[[</nowiki>Antarctica<nowiki>]]</nowiki>" shown as "on [[Antarctica]]", | * <span style{{=}}"visibility:hidden;">special: </span>"<nowiki>[[</nowiki>Antarctica<nowiki>]]</nowiki>" shown as "on [[Antarctica]]", | ||
* <span style{{=}}"visibility:hidden;">special: </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: </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: </span>versus any other: shown as "in ...", e.g. "<nowiki>[[</nowiki>Africa<nowiki>]]</nowiki>" shown as "in | + | * <span style{{=}}"visibility:hidden;">special: </span>versus any other: shown as "in ...", e.g. "<nowiki>[[</nowiki>Africa<nowiki>]]</nowiki>" shown as "in Africa" |
| – | | – | ||
| Line 71: | Line 70: | ||
|} | |} | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| − | |colspan="2" style="padding-top:1.5em; font-size:87%;"|<code style="color:#705000;"><nowiki>{{map caption |region= | + | |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;" | {|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;" | ||
|- | |- | ||
| − | |style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |region= | + | |style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |region=Europe |legend=European location legend en.png}} |
|} | |} | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| − | |colspan="2" style="padding-top:1.5em; font-size:87%;"| <code style="color:#705000;"><nowiki>{{map caption |countryprefix=the |region= | + | |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;" | {|cellspacing="0" border="1" style="margins:0px;padding:0px;borders:0px none;" | ||
|- | |- | ||
| − | |style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |countryprefix=the |region= | + | |style="padding:0px;borders:1px solid #c0c0c0;"|{{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}} |
|} | |} | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
| Line 112: | Line 111: | ||
<nowiki> |common_name = Belarus</nowiki><br /> | <nowiki> |common_name = Belarus</nowiki><br /> | ||
<nowiki> |image_map = Europe location BLR.png</nowiki><br /> | <nowiki> |image_map = Europe location BLR.png</nowiki><br /> | ||
| − | <nowiki> |map_caption = </nowiki><span style="color:#705000;"><nowiki>{{map caption |region= | + | <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> |(some required infobox parameters omitted from sample)</nowiki>''<br /> | ||
<nowiki>}}</nowiki></code><span style="line-height:.9em;"><br /><br /></span> | <nowiki>}}</nowiki></code><span style="line-height:.9em;"><br /><br /></span> | ||
| Line 120: | Line 119: | ||
<nowiki> |common_name = the Netherlands</nowiki><br /> | <nowiki> |common_name = the Netherlands</nowiki><br /> | ||
<nowiki> |image_map = EU location NED.png</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= | + | <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> |(some required infobox parameters omitted from sample)</nowiki>''<br /> | ||
<nowiki>}}</nowiki></code> | <nowiki>}}</nowiki></code> | ||
| Line 127: | Line 126: | ||
{| style="background-color:#f8f8ff;" | {| 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''' — </span><span style="font-size:87%;">(called here | + | |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''' — </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;" | |- style="vertical-align:top;" | ||
|{{Infobox Country or territory| | |{{Infobox Country or territory| | ||
| Line 136: | Line 135: | ||
|government_type = <span style="display:none">x</span> | |government_type = <span style="display:none">x</span> | ||
|official_languages = <span style="display:none">x</span> | |official_languages = <span style="display:none">x</span> | ||
| − | |area_km2 = | + | |area_km2 = 10 |
|area_sq_mi = <span style="display:none">0</span> | |area_sq_mi = <span style="display:none">0</span> | ||
| − | |population_density_km2 = | + | |population_density_km2 = 10 |
|population_density_rank = <span style="display:none">0</span> | |population_density_rank = <span style="display:none">0</span> | ||
|population_density_sq_mi = <span style="display:none">0</span> | |population_density_sq_mi = <span style="display:none">0</span> | ||
| Line 152: | Line 151: | ||
|common_name = Belarus | |common_name = Belarus | ||
|image_map = Europe location BLR.png | |image_map = Europe location BLR.png | ||
| − | |map_caption = {{map caption |region= | + | |map_caption = {{map caption |region=Europe |legend=European location legend en.png}} |
|capital = <span style="display:none">x</span> | |capital = <span style="display:none">x</span> | ||
|government_type = <span style="display:none">x</span> | |government_type = <span style="display:none">x</span> | ||
|official_languages = <span style="display:none">x</span> | |official_languages = <span style="display:none">x</span> | ||
| − | |area_km2 = | + | |area_km2 = 10 |
|area_sq_mi = <span style="display:none">0</span> | |area_sq_mi = <span style="display:none">0</span> | ||
| − | |population_density_km2 = | + | |population_density_km2 = 10 |
|population_density_rank = <span style="display:none">0</span> | |population_density_rank = <span style="display:none">0</span> | ||
|population_density_sq_mi = <span style="display:none">0</span> | |population_density_sq_mi = <span style="display:none">0</span> | ||
| Line 172: | Line 171: | ||
|common_name = the Netherlands | |common_name = the Netherlands | ||
|image_map = EU location NED.png | |image_map = EU location NED.png | ||
| − | |map_caption = {{map caption |countryprefix=the |region= | + | |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> | |capital = <span style="display:none">x</span> | ||
|government_type = <span style="display:none">x</span> | |government_type = <span style="display:none">x</span> | ||
|official_languages = <span style="display:none">x</span> | |official_languages = <span style="display:none">x</span> | ||
| − | |area_km2 = | + | |area_km2 = 10 |
|area_sq_mi = <span style="display:none">0</span> | |area_sq_mi = <span style="display:none">0</span> | ||
| − | |population_density_km2 = | + | |population_density_km2 = 10 |
|population_density_rank = <span style="display:none">0</span> | |population_density_rank = <span style="display:none">0</span> | ||
|population_density_sq_mi = <span style="display:none">0</span> | |population_density_sq_mi = <span style="display:none">0</span> | ||
| Line 192: | Line 191: | ||
|} | |} | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other| |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> | | <!-- CATEGORIES BELOW THIS LINE, PLEASE: --> | ||
[[Category:Map formatting and function templates]] | [[Category:Map formatting and function templates]] | ||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 22:25, 9 July 2020
| 40px | This is a documentation subpage for Template:Map caption. It contains usage information, categories and other content that is not part of the original template page. |
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 of reasonable length, a width of (minimally) 250px (without extra padding or margins) should be available.
Parameters
Required parameters shown in bold italics Script error: No such module "aligned table".
- Note
- 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.
Examples
| Code | Raw result (in unformatted box, compare to handling in Infobox) | |
{{map caption}}
| ||
| ||
{{map caption |region=Europe |legend=European location legend en.png}}
| ||
|
| ||
{{map caption |countryprefix=the |region=Europe |subregion=the [[European Union]] |legend=European location legend en.png}}
| ||
| ||
Typical sample for an article on a European Union member that needs no "the" before its name, for otherwise identical output:{{map caption |region=Europe |subregion=EU |legend=European location legend en.png}}
| ||
| ||
| Infobox usage of code (as intended) — in which 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||