Module:Location map/data/Alps/doc: Difference between revisions

Content deleted Content added
create documentation
 
More specific category
 
(6 intermediate revisions by 3 users not shown)
Line 1:
{{Documentation subpage}}
<!-- Categories and interwikis go at the bottom of this page. -->
{{Module:Location map/data/doc|image=[[File:Alps with borders.jpg|thumb|300px|Map of the Alps]]|name=the [[Alps]]
|examples=
 
'''Template:Location map Alps''' is a ___location map definition used to overlay markers and labels on an [[equirectangular projection]] map of the [[Alps]]. 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 "Alps":
* {{tlx|Location map | Alps&nbsp;| ...}}
* {{tlx|Location map many | Alps&nbsp;| ...}}
* {{tlx|Location map+ | Alps&nbsp;| ...}}
* {{tlx|Location map~ | Alps&nbsp;| ...}}
 
== Map definition ==
* <tt>'''name''' = {{{{BASEPAGENAME}}|name}}</tt>
*: Name used in the default map caption
 
* <tt>'''image''' = [[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>
*: The default map image, without "Image:" or "File:"
{{#if:{{{{BASEPAGENAME}}|image1}}|
 
* <tt>'''image1''' = [[:File:{{{{BASEPAGENAME}}|image1}}|{{{{BASEPAGENAME}}|image1}}]]</tt>
*: An alternative map image, usually a relief map, can be displayed via the ''relief'' or ''AlternativeMap'' parameters
}}{{#if:{{{{BASEPAGENAME}}|image2}}|
 
* <tt>'''image2''' = [[:File:{{{{BASEPAGENAME}}|image2}}|{{{{BASEPAGENAME}}|image2}}]]</tt>
*: A second alternative map image, can be displayed via the ''AlternativeMap'' parameter only
}}{{#if:{{{{BASEPAGENAME}}|top}}{{{{BASEPAGENAME}}|bottom}}{{{{BASEPAGENAME}}|left}}{{{{BASEPAGENAME}}|right}}|
 
* <tt>'''top''' = {{{{BASEPAGENAME}}|top}}</tt>
*: [[Latitude]] at top edge of map, in [[decimal degrees]]
 
* <tt>'''bottom''' = {{{{BASEPAGENAME}}|bottom}}</tt>
*: Latitude at bottom edge of map, in decimal degrees
 
* <tt>'''left''' = {{{{BASEPAGENAME}}|left}}</tt>
*: [[Longitude]] at left edge of map, in decimal degrees
 
* <tt>'''right''' = {{{{BASEPAGENAME}}|right}}</tt>
*: Longitude at right edge of map, in decimal degrees
}}{{#if:{{{{BASEPAGENAME}}|x}}{{{{BASEPAGENAME}}|y}}|
 
* <tt>'''x''' = {{{{BASEPAGENAME}}|x}}</tt>
*: 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
 
* <tt>'''y''' = {{{{BASEPAGENAME}}|y}}</tt>
*: 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:{{{{BASEPAGENAME}}|mark}}|
 
* <tt>'''mark''' = [[:File:{{{{BASEPAGENAME}}|mark}}|{{{{BASEPAGENAME}}|mark}}]] ([[File:{{{{BASEPAGENAME}}|mark}}|{{{{BASEPAGENAME}}|mark}}|8px]])</tt>
*: The default mark image to display with this map. This can be overridden by the <code>mark</code> parameter in [[Template:Location map]], which would otherwise default to [[:File:Red pog.svg|Red pog.svg]] ([[File:Red pog.svg|8px]]).
}}{{#if:{{{{BASEPAGENAME}}|marksize}}|
 
* <tt>'''marksize''' = {{{{BASEPAGENAME}}|marksize}}</tt>
*: The default mark size (in [[pixel]]s) for the mark image displayed with this map (should not include <code>px</code>, for example <code>marksize={{{{BASEPAGENAME}}|marksize}}</code>, not <code>marksize={{{{BASEPAGENAME}}|marksize}}px</code>). This can be overridden by the <code>marksize</code> parameter in [[Template:Location map]], which would otherwise default to 8.
}}
{{#if:{{{{BASEPAGENAME}}|image1}}|
== Alternative map ==
The map defined as '''image1''' (<tt>{{{{BASEPAGENAME}}|image1}}</tt>) can be displayed by using the ''relief'' or ''AlternativeMap'' parameters in {{tl|Location map}}, {{tl|Location map many}} and {{tl|Location map+}}. {{#if:{{{{BASEPAGENAME}}|image2}}| The map defined as '''image2''' (<tt>{{{{BASEPAGENAME}}|image2}}</tt>) can only be displayed by using the ''AlternativeMap'' parameter.}} The use of these two parameters is shown in the examples below. Additional examples can be found at:
{{{!}}
{{!}}
* [[Template:Location map#Relief parameter]]
* [[Template:Location map#AlternativeMap parameter]]
{{!}}
* [[Template:Location map+/relief]]
* [[Template:Location map+/AlternativeMap]]
{{!}}}
}}
== Examples using ___location map templates ==
 
=== Location map, using default map (image) ===
{{Location map | Alps
Line 164 ⟶ 97:
}}
</pre>
{{clear}}
 
== 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
 
; Infobox templates incorporating (passing values to) the Location map template
{{Location map/doc/See also infobox templates}}
<includeonly>
<!-- Categories and interwikis go here: -->
[[Category:Europe ___location map modules‎|Alps]]
 
</includeonly>