Difference between revisions of "Template:Map caption/doc"
imported>Zyxw (remove old interwiki links) |
imported>Hairy Dude (rewrite some sentences that were unreasonably hard to understand / had bad grammar) |
||
| Line 22: | Line 22: | ||
| location | | | location | | ||
| − | * Only if | + | * Only if ''colour' is not used and its default is not 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 | + | * Only if ''description'' is not used: Colour identifying ''country'''s location; "none" suppresses the default. |
| orange | | orange | ||
| Line 57: | Line 57: | ||
| – | | – | ||
}}<!--(end Aligned table)--> | }}<!--(end Aligned table)--> | ||
| − | ; Note : <div style="font-size:95%;line-height:1.35em;font-weight:400;"> | + | ; 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=== | ===Examples=== | ||
| Line 99: | Line 99: | ||
{| width="100%" xclass="toccolours" style="margin-top:.5em;border:1px solid #a0a0a0;background-color:#f8f8ff;" <!-- no class formatting other than article space --> | {| width="100%" xclass="toccolours" style="margin-top:.5em;border:1px solid #a0a0a0;background-color:#f8f8ff;" <!-- no class formatting other than article space --> | ||
|- style="text-align:left;" | |- style="text-align:left;" | ||
| − | |'''<span style="font-size:110%;">Infobox usage of code</span> (as intended)''' — | + | |'''<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="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 /> | |style="white-space:normal;"|'''Sample for article named 'Armenia', about a non-European country'''<br /> | ||
| Line 107: | Line 107: | ||
<nowiki> |image_map = Europe location ARM.png</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> |map_caption = </nowiki><span style="color:#705000;"><nowiki>{{map caption}}</nowiki></span><br /> | ||
| − | ''<nowiki> |( | + | ''<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 /> | <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> | <code><nowiki> | ||
| Line 114: | Line 114: | ||
<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=[[Europe]] |legend=European location legend en.png}}</nowiki></span><br /> | <nowiki> |map_caption = </nowiki><span style="color:#705000;"><nowiki>{{map caption |region=[[Europe]] |legend=European location legend en.png}}</nowiki></span><br /> | ||
| − | ''<nowiki> |( | + | ''<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> | ||
'''Sample for article named 'Netherlands', about a member of the EU'''<br /> | '''Sample for article named 'Netherlands', about a member of the EU'''<br /> | ||
| Line 122: | Line 122: | ||
<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=[[Europe]] |subregion=the [[European Union]] |legend=European location legend en.png}}</nowiki></span><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> |( | + | ''<nowiki> |(some required infobox parameters omitted from sample)</nowiki>''<br /> |
<nowiki>}}</nowiki></code> | <nowiki>}}</nowiki></code> | ||
|- | |- | ||
Revision as of 11:38, 28 January 2017
| 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. |
| 40x40px | 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. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, 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 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
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||