Module:Location map/data/doc
&lt;includeonly&gt;__NOEDITSECTION__{{#invoke:Location map/info|main}}
 {{{image|}}}
 
 '''{{#titleparts:{{FULLPAGENAME}}|3}}''' is a location map definition used to overlay markers and labels on {{{projection|an [[equirectangular projection]]}}} map of {{{name|[[{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|name}}]]}}}. The markers are placed by [[latitude]] and [[longitude]] coordinates on the default map or a similar map image.
 
 == Usage ==
 These definitions are used by the following templates when invoked with parameter &quot;{{#titleparts:{{FULLPAGENAME}}|1|3}}&quot;:
 * {{tlx|Location map | {{#titleparts:{{FULLPAGENAME}}|1|3}}&amp;nbsp;| ...}}
 * {{tlx|Location map many | {{#titleparts:{{FULLPAGENAME}}|1|3}}&amp;nbsp;| ...}}
 * {{tlx|Location map+ | {{#titleparts:{{FULLPAGENAME}}|1|3}}&amp;nbsp;| ...}}
 * {{tlx|Location map~ | {{#titleparts:{{FULLPAGENAME}}|1|3}}&amp;nbsp;| ...}}
 
 == Map definition ==
 * &lt;code&gt;'''name''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|name}}&lt;/code&gt;
 *: Name used in the default map caption
 
 * &lt;code&gt;'''image''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image}}]]&lt;/code&gt;
 *: The default map image, without &quot;Image:&quot; or &quot;File:&quot;
 {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}|
 
 * &lt;code&gt;'''image1''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}]]&lt;/code&gt;
 *: An alternative map image, usually a relief map, which can be displayed via the ''relief'' or ''AlternativeMap'' parameters
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image2}}|
 
 * &lt;code&gt;'''image2''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image2}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image2}}]]&lt;/code&gt;{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}|
 
 * &lt;code&gt;'''image3''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}]]&lt;/code&gt;
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image4}}|
 
 * &lt;code&gt;'''image4''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image4}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image4}}]]&lt;/code&gt;
 }}
 *: Alternative map image{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}|s}} which can be displayed via the ''AlternativeMap'' parameter
 
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}}|
 
 * &lt;code&gt;'''top''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}}&lt;/code&gt;
 *: [[Latitude]] at top edge of map, in [[decimal degrees]]
 
 * &lt;code&gt;'''bottom''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}}&lt;/code&gt;
 *: Latitude at bottom edge of map, in decimal degrees
 
 * &lt;code&gt;'''left''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}}&lt;/code&gt;
 *: [[Longitude]] at left edge of map, in decimal degrees
 
 * &lt;code&gt;'''right''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}}&lt;/code&gt;
 *: Longitude at right edge of map, in decimal degrees
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|x}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|y}}|
 
 * &lt;code&gt;'''x''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|x}}&lt;/code&gt;
 *: An expression to calculate a location on the map via its [[longitude]]; evaluates as 0 along the left edge and 100 along the right edge
 
 * &lt;code&gt;'''y''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|y}}&lt;/code&gt;
 *: An expression to calculate a location on the map via its [[latitude]]; evaluates as 0 along the top edge and 100 along the bottom edge
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|mark}}|
 
 * &lt;code&gt;'''mark''' = [[:File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|mark}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|mark}}]] ([[File:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|mark}}|{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|mark}}|8px]])&lt;/code&gt;
 *: The default mark image to display with this map. This can be overridden by the &lt;code&gt;mark&lt;/code&gt; parameter in [[Template:Location map]], which would otherwise default to [[:File:Red pog.svg|Red pog.svg]] ([[File:Red pog.svg|8px]]).
 }}{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|marksize}}|
 
 * &lt;code&gt;'''marksize''' = {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|marksize}}&lt;/code&gt;
 *: The default mark size (in [[pixel]]s) for the mark image displayed with this map (should not include &lt;code&gt;px&lt;/code&gt;, for example &lt;code&gt;marksize={{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|marksize}}&lt;/code&gt;, not &lt;code&gt;marksize={{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|marksize}}px&lt;/code&gt;). This can be overridden by the &lt;code&gt;marksize&lt;/code&gt; parameter in [[Template:Location map]], which would otherwise default to 8.
 }}
 {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image2}}|
 == Alternative map ==
 The {{tl|Location map}}, {{tl|Location map many}}, and {{tl|Location map+}} templates have parameters to specify an alternative map image. {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}
 | The map displayed as '''image1''' can be used with the ''relief'' or ''AlternativeMap'' parameters.
 }} {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image2}}
 | The map{{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}|s}} displayed as '''image2''' {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image3}}|/ '''image3'''}} {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image4}}|/ '''image4'''}} can be used with the ''AlternativeMap'' parameter.
 }} Examples may be found below or in the following:
 {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|image1}}|
 * [[Template:Location map#Relief parameter]]
 * [[Template:Location map+/relief]]
 }}
 * [[Template:Location map#AlternativeMap parameter]]
 * [[Template:Location map+/AlternativeMap]]
 }}
 {{#if:{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}}{{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}}|
 == Precision ==
 {{#if:{{{precision|}}}|{{{precision}}}|
 [[Longitude]]: from West to East this map definition covers {{#expr: ( {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}} + 360 ) fmod 360 round 4}} degrees.
 * At an image width of 200 [[pixel]]s, that is {{#expr: ( {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}} + 360 ) fmod 360 / 200 round 4}} degrees per pixel.
 * At an image width of 1000 pixels, that is {{#expr: ( {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|right}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|left}} + 360 ) fmod 360 / 1000 round 4}} degrees per pixel.
 
 [[Latitude]]: from North to South this map definition covers {{#expr: {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}} round 4}} degrees.
 * At an image height of 200 pixels, that is {{#expr: ( {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}} ) / 200 round 4}} degrees per pixel.
 * At an image height of 1000 pixels, that is {{#expr: ( {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|top}} - {{#invoke:Location map|data|{{#titleparts:{{FULLPAGENAME}}|1|3}}|bottom}} ) / 1000 round 4}} degrees per pixel.
 }}}}
 {{#if:{{{examples|}}}|
 == Examples using location map templates ==
 
 {{{examples}}}
 
 {{clear}}
 }}
 
 == See also ==
 {{{see also|}}}
 
 === Location map templates ===
 * [[Template:Location map]], to display one mark and label using latitude and longitude
 * [[Template:Location map many]], to display up to nine marks and labels
 * [[Template:Location map+]], to display an unlimited number of marks and labels
 
 === Creating new map definitions ===
 * [[Template:Location map/Creating a new map definition]]&lt;/includeonly&gt;&lt;noinclude&gt;
 {{Documentation}}