Module:Location map/data/USA Alabama/doc: Difference between revisions

Content deleted Content added
Examples: tidied up
update formatting
Line 1:
{{Documentation subpage}}
The locator map definition, '''Template:Location_map_USA_Alabama''', is intended for overlaying markers and labels on similar maps of [[Alabama]].
<!-- Categories and interwikis go at the bottom of this page. -->
[[File:Map of Alabama NA.png|thumb|400px|Map of Alabama (click on map to see larger image)]]
 
'''Template:Location map USA Alabama''' is a ___location map definition used to overlay markers and labels on an [[equirectangular projection]] map of [[Alabama]]. The markers are placed by [[latitude]] and [[longitude]] coordinates on the default map or a similar map image.
Some of the related mapping procedures are:
 
== Usage ==
* [[Template:Location_map]] - puts 1 symbol/label on the map image;
These definitions are used by the following templates when invoked with parameter "USA Alabama":
* [[Template:Location_map_many]] - puts multiple symbols/labels on the map image.
* {{tlx|Location map | USA Alabama&nbsp;| ...}}
* {{tlx|Location map many | USA Alabama&nbsp;| ...}}
* {{tlx|Location map+ | USA Alabama&nbsp;| ...}}
* {{tlx|Location map~ | USA Alabama&nbsp;| ...}}
 
== Map definition ==
This template uses the mapping procedure "[[Template:Location_map]]" which must be invoked with parameter "Alabama" to process the options before it uses the template. Specify each of the individual parameters by using vertical bars: <nowiki>{{Location map | Alabama | ...}}</nowiki>.
* <tt>'''name''' = {{{{BASEPAGENAME}}|name}}</tt>
*: Name used in the default map caption
 
* <tt>'''image''' = [[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>
For map width, omit "px" (width=160) or else map might expand and throw marker across page: the "px" cannot be detected in advance.
*: The default map image, without "Image:" or "File:"
{{#if:{{{{BASEPAGENAME}}|image1}}|
 
* <tt>'''image1''' = [[:File:{{{{BASEPAGENAME}}|image1}}|{{{{BASEPAGENAME}}|image1}}]]</tt>
See: {{tl|Location map}} for description of parameters, or Examples below.
*: 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>
[[Image:{{Location map Alabama|image}}|left|thumb|200px|{{Location map Alabama|image}}]]
*: A second alternative map image, can be displayed via the ''AlternativeMap'' parameter only
}}{{#if:{{{{BASEPAGENAME}}|mark}}|
 
* <tt>'''mark''' = [[:File:{{{{BASEPAGENAME}}|mark}}]] ( [[File:{{{{BASEPAGENAME}}|mark}}|8px]] )</tt>
{| class="wikitable"
*: A ___location marker image to be used for this map, in place of the default image <tt>[[:File:Red pog.svg]] ( [[File:Red pog.svg|8px]] )</tt>
! Parameter !! style="text-align:left" | Setting !! style="text-align:left" | Description
}}{{#if:{{{{BASEPAGENAME}}|top}}{{{{BASEPAGENAME}}|bottom}}{{{{BASEPAGENAME}}|left}}{{{{BASEPAGENAME}}|right}}|
|-
 
| name || {{Location map USA Alabama|name}} || name of ___location
* <tt>'''top''' = {{{{BASEPAGENAME}}|top}}</tt>
|-
*: [[Latitude]] at top edge of map, in [[decimal degrees]]
| image || {{Location map USA Alabama|image}} || name of map image
 
|-
* <tt>'''bottom''' = {{{{BASEPAGENAME}}|bottom}}</tt>
| top || {{Location map USA Alabama|top}} || latitude at top of map
*: Latitude at bottom edge of map, in decimal degrees
|-
 
| bottom || {{Location map USA Alabama|bottom}} || latitude at bottom of map
* <tt>'''left''' = {{{{BASEPAGENAME}}|left}}</tt>
|-
*: [[Longitude]] at left edge of map, in decimal degrees
| left || {{Location map USA Alabama|left}} || longitude at map left edge
 
|-
|* <tt>'''right''' ||= {{Location map USA Alabama{{BASEPAGENAME}}|right}} || longitude at map right edge</tt>
*: Longitude at right edge of map, in decimal degrees
|}
}}{{#if:{{{{BASEPAGENAME}}|x}}{{{{BASEPAGENAME}}|y}}|
{{-}}<!-- force separation break -->
 
* <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}}|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 ==
 
==Examples==
{{Location map
| USA Alabama
Line 92 ⟶ 125:
| label_size = 90 <!-- percent 0-900% -->
| caption = Show "left edge" on map
| lat = 31.101
| long = -88.647
| background = #33DD44 <!--green-->
| float = right
Line 105 ⟶ 138:
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
:<nowiki>| caption = Show "left edge" on map</nowiki>
:<nowiki>| lat = 31.101</nowiki>
:<nowiki>| long = -88.647</nowiki>
:<nowiki>| background = #33DD44 <!--green--></nowiki>
:<nowiki>| float = right</nowiki>
Line 118 ⟶ 151:
| label_size = 90 <!-- percent 0-900% -->
| caption = Show map "right edge"
| lat = 31.101
| long = -84.857
| background = #33DD44 <!--green-->
| float = right
Line 131 ⟶ 164:
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
:<nowiki>| caption = Show map "right edge"</nowiki>
:<nowiki>| lat = 31.101</nowiki>
:<nowiki>| long = -84.857</nowiki>
:<nowiki>| background = #33DD44 <!--green--></nowiki>
:<nowiki>| float = right</nowiki>
:<nowiki>| width = 160</nowiki>
:<nowiki>}}</nowiki></code>
 
== 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: -->
 
[[de:Vorlage:Positionskarte USA Alabama]]
<!-- [[ru:Шаблон:ПозКарта США алабаmа]] -->
 
</noinclude>
</includeonly>