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

From blackwiki
Jump to navigation Jump to search
blackwiki>Droll
(→‎Examples: tidied up)
blackwiki>Zyxw
(update formatting)
Line 1: Line 1:
The locator map definition, '''Template:Location_map_USA_Alabama''', is intended for overlaying markers and labels on similar maps of [[Alabama]].
+
{{Documentation subpage}}
 +
<!-- 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)]]
  
Some of the related mapping procedures are:
+
'''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.
  
* [[Template:Location_map]] - puts 1 symbol/label on the map image;
+
== Usage ==
* [[Template:Location_map_many]] - puts multiple symbols/labels on the map image.
+
These definitions are used by the following templates when invoked with parameter "USA Alabama":
 +
* {{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;| ...}}
  
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>.
+
== Map definition ==
 +
* <tt>'''name''' = {{{{BASEPAGENAME}}|name}}</tt>
 +
*: Name used in the default map caption
  
For map width, omit "px" (width=160) or else map might expand and throw marker across page: the "px" cannot be detected in advance.
+
* <tt>'''image''' = [[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>
 +
*: The default map image, without "Image:" or "File:"
 +
{{#if:{{{{BASEPAGENAME}}|image1}}|
  
See: {{tl|Location map}} for description of parameters, or Examples below.
+
* <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}}|
  
[[Image:{{Location map Alabama|image}}|left|thumb|200px|{{Location map Alabama|image}}]]
+
* <tt>'''image2''' = [[:File:{{{{BASEPAGENAME}}|image2}}|{{{{BASEPAGENAME}}|image2}}]]</tt>
 +
*: A second alternative map image, can be displayed via the ''AlternativeMap'' parameter only
 +
}}{{#if:{{{{BASEPAGENAME}}|mark}}|
  
{| class="wikitable"
+
* <tt>'''mark''' = [[:File:{{{{BASEPAGENAME}}|mark}}]] ( [[File:{{{{BASEPAGENAME}}|mark}}|8px]] )</tt>
! Parameter !! style="text-align:left" | Setting !! style="text-align:left" | Description
+
*: 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>
|-
+
}}{{#if:{{{{BASEPAGENAME}}|top}}{{{{BASEPAGENAME}}|bottom}}{{{{BASEPAGENAME}}|left}}{{{{BASEPAGENAME}}|right}}|
| name || {{Location map USA Alabama|name}} || name of location
+
 
|-
+
* <tt>'''top''' = {{{{BASEPAGENAME}}|top}}</tt>
| image || {{Location map USA Alabama|image}} || name of map image
+
*: [[Latitude]] at top edge of map, in [[decimal degrees]]
|-
+
 
| top || {{Location map USA Alabama|top}} || latitude at top of map
+
* <tt>'''bottom''' = {{{{BASEPAGENAME}}|bottom}}</tt>
|-
+
*: 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>
| left || {{Location map USA Alabama|left}} || longitude at map left edge
+
*: [[Longitude]] at left edge of map, in decimal degrees
|-
+
 
| right || {{Location map USA Alabama|right}} || longitude at map right edge
+
* <tt>'''right''' = {{{{BASEPAGENAME}}|right}}</tt>
|}
+
*: Longitude at right edge of map, in decimal degrees
{{-}}<!-- force separation break -->
+
}}{{#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}}|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
 
{{Location map
 
| USA Alabama
 
| USA Alabama
Line 92: Line 125:
 
| label_size = 90 <!-- percent 0-900% -->
 
| label_size = 90 <!-- percent 0-900% -->
 
| caption = Show "left edge" on map
 
| caption = Show "left edge" on map
| lat = 31.10
+
| lat = 31.1
| long = -88.64
+
| long = -88.7
 
| background = #33DD44 <!--green-->
 
| background = #33DD44 <!--green-->
 
| float = right
 
| float = right
Line 105: Line 138:
 
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
 
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
 
:<nowiki>| caption = Show "left edge" on map</nowiki>
 
:<nowiki>| caption = Show "left edge" on map</nowiki>
:<nowiki>| lat = 31.10</nowiki>
+
:<nowiki>| lat = 31.1</nowiki>
:<nowiki>| long = -88.64</nowiki>
+
:<nowiki>| long = -88.7</nowiki>
 
:<nowiki>| background = #33DD44 <!--green--></nowiki>
 
:<nowiki>| background = #33DD44 <!--green--></nowiki>
 
:<nowiki>| float = right</nowiki>
 
:<nowiki>| float = right</nowiki>
Line 118: Line 151:
 
| label_size = 90 <!-- percent 0-900% -->
 
| label_size = 90 <!-- percent 0-900% -->
 
| caption = Show map "right edge"
 
| caption = Show map "right edge"
| lat = 31.10
+
| lat = 31.1
| long = -84.85
+
| long = -84.7
 
| background = #33DD44 <!--green-->
 
| background = #33DD44 <!--green-->
 
| float = right
 
| float = right
Line 131: Line 164:
 
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
 
:<nowiki>| label_size = 90 <--percent 0-900%--></nowiki>
 
:<nowiki>| caption = Show map "right edge"</nowiki>
 
:<nowiki>| caption = Show map "right edge"</nowiki>
:<nowiki>| lat = 31.10</nowiki>
+
:<nowiki>| lat = 31.1</nowiki>
:<nowiki>| long = -84.85</nowiki>
+
:<nowiki>| long = -84.7</nowiki>
 
:<nowiki>| background = #33DD44 <!--green--></nowiki>
 
:<nowiki>| background = #33DD44 <!--green--></nowiki>
 
:<nowiki>| float = right</nowiki>
 
:<nowiki>| float = right</nowiki>
 
:<nowiki>| width = 160</nowiki>
 
:<nowiki>| width = 160</nowiki>
 
:<nowiki>}}</nowiki></code>
 
:<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]]
 
[[de:Vorlage:Positionskarte USA Alabama]]
 
<!-- [[ru:Шаблон:ПозКарта США алабаmа]] -->
 
<!-- [[ru:Шаблон:ПозКарта США алабаmа]] -->
</noinclude>
+
 
 +
</includeonly>

Revision as of 19:03, 23 August 2012

File:Map of Alabama NA.png
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.

Usage

These definitions are used by the following templates when invoked with parameter "USA Alabama":

Map definition

Alternative map

The map defined as image1 (Template:Location map/data/USA Alabama) can be displayed by using the relief or AlternativeMap parameters in {{Location map}}, {{Location map many}} and {{Location map+}}. The map defined as image2 (Template:Location map/data/USA Alabama) 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:

Examples using location map templates

Show "Huntsville" on map

Example labeling "Huntsville":

{{Location map
| USA Alabama
| label = Huntsville | position = left
| label_size = 90 <!--percent 0-900%-->
| caption = Show "Huntsville" on map
| lat_deg = 34  | lat_min = 42.8 | lat_dir = N
| lon_deg = 86 | lon_min = 35.2 | lon_dir = W
| background = #FFFF99
| float = right
| width = 160 <!--DON'T add "px"-->
}}
Note that both lon_deg and lon_min are negative numbers, for the Western Hemisphere.
Show "Mobile" on map

Example for orange "Mobile" at bottom:

{{Location map
| USA Alabama
| label = Mobile | position = top
| label_size = 90 <!-- 0-900%-->
| caption = Show "Mobile" on map
| lat_deg = 30  | lat_min = 40.8 | lat_dir = N
| lon_deg = 88 | lon_min = 6.2 | lon_dir = W
| background = #FFCC66 <!--orange-->
| float = right
| width = 160 <!--DON'T add "px"-->
| AlternativeMap = <!-- none (default)-->
}}
Show "left edge" on map

Example for green "left edge" at side:

{{Location map
| USA Alabama
| label = left edge | position = right
| label_size = 90 <--percent 0-900%-->
| caption = Show "left edge" on map
| lat = 31.1
| long = -88.7
| background = #33DD44 <!--green-->
| float = right
| width = 160
}}
Show map "right edge"

Example for green "right edge" at side:

{{Location map
| USA Alabama
| label = right edge | position = left
| label_size = 90 <--percent 0-900%-->
| caption = Show map "right edge"
| lat = 31.1
| long = -84.7
| background = #33DD44 <!--green-->
| float = right
| width = 160
}}

See also

Location map templates
Infobox templates incorporating (passing values to) the Location map template
List