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

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(update documentation and add example using Template:Location map+)
blackwiki>Michael!
(updated documentation)
Line 2: Line 2:
 
<!-- Categories and interwikis go at the bottom of this page. -->
 
<!-- Categories and interwikis go at the bottom of this page. -->
  
'''Template:Location map USA''' is a location map definition used to overlay markers and labels on an [[equirectangular projection]] map of the [[United States]]. The markers are placed by [[latitude]] and [[longitude]] coordinates on the default map or a similar map image.  
+
'''Template:Location map USA''' is a location map definition used to overlay markers and labels on an [[equidistant conic projection]] map of the [[United States]]. The markers are placed by [[latitude]] and [[longitude]] coordinates on the default map or a similar map image.  
  
 
== Usage ==
 
== Usage ==
Line 12: Line 12:
  
 
== Map definition ==
 
== Map definition ==
; name
+
* <tt>'''name''' = {{{{BASEPAGENAME}}|name}}</tt>
: used in default map caption (<tt>{{{{BASEPAGENAME}}|name}}</tt>)
+
*: Name used in the default map caption
; image
 
: the default map image, without "Image:" or "File:" (<tt>[[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>)
 
; top
 
: [[latitude]] at top edge of map, in [[decimal degrees]] (<tt>{{{{BASEPAGENAME}}|top}}</tt>)
 
; bottom
 
: latitude at bottom edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|bottom}}</tt>)
 
; left
 
: [[longitude]] at left edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|left}}</tt>)
 
; right
 
: longitude at right edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|right}}</tt>)
 
  
== Examples ==
+
* <tt>'''image''' = [[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>
=== Location map ===
+
*: The default map image, without "Image:" or "File:"
 +
 
 +
* <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
 +
}}
 +
 
 +
== 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 | USA
 
{{Location map | USA
| width = 250
+
| width   = 250
| lat   = 38.895
+
| label   = Washington, D.C.
| long  = -77.037
+
| lat_deg = 38.89
| label = Washington, D.C.
+
| lon_deg = -77.04
 
}}
 
}}
 
<pre style="width:30em">
 
<pre style="width:30em">
 
{{Location map | USA
 
{{Location map | USA
| width = 250
+
| width   = 250
| lat   = 38.895
+
| label   = Washington, D.C.
| long  = -77.037
+
| lat_deg = 38.89
| label = Washington, D.C.
+
| lon_deg = -77.04
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Location map many ===
+
=== Location map many, using relief map (image1) ===
 
{{Location map many | USA
 
{{Location map many | USA
| caption = Two locations in the USA
+
| relief  = yes
| width   = 250
+
| width    = 250
| lat    = 38.89
+
| caption = Two locations in the USA
| long    = -77.04
+
| label1   = Washington, D.C.
| label   = Washington, D.C.
+
| lat1_deg = 38.89
| lat2    = 47.61
+
| lon1_deg = -77.04
| long2  = -122.33
+
| label2   = Seattle
| label2  = Seattle
+
| lat2_deg = 47.61
 +
| lon2_deg = -122.33
 
}}
 
}}
 
<pre style="width:30em">
 
<pre style="width:30em">
 
{{Location map many | USA
 
{{Location map many | USA
| caption = Two locations in the USA
+
| relief  = yes
| width   = 250
+
| width    = 250
| lat    = 38.89
+
| caption = Two locations in the USA
| long    = -77.04
+
| label1   = Washington, D.C.
| label   = Washington, D.C.
+
| lat1_deg = 38.89
| lat2    = 47.61
+
| lon1_deg = -77.04
| long2  = -122.33
+
| label2   = Seattle
| label2  = Seattle
+
| lat2_deg = 47.61
 +
| lon2_deg = -122.33
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Location map+ ===
+
=== Location map+, using AlternativeMap ===
 
{{Location map+ | USA
 
{{Location map+ | USA
 +
| AlternativeMap = Usa edcp relief location map.png
 
| caption = Two locations in the USA
 
| caption = Two locations in the USA
 
| width  = 250
 
| width  = 250
 
| places  =
 
| places  =
 
   {{Location map~ | USA
 
   {{Location map~ | USA
   | lat   = 38.89
+
   | label   = Washington, D.C.
   | long  = -77.04
+
  | lat_deg = 38.89
  | label = Washington, D.C.
+
   | lon_deg = -77.04
 
   }}
 
   }}
 
   {{Location map~ | USA
 
   {{Location map~ | USA
   | lat   = 47.61
+
   | label  = Seattle
   | long  = -122.33
+
   | lat_deg = 47.61
  | label = Seattle
+
   | lon_deg = -122.33
 
   }}
 
   }}
 
}}
 
}}
<pre style="width:30em">
+
<pre style="width:35em">
 
{{Location map+ | USA
 
{{Location map+ | USA
 +
| AlternativeMap = Usa edcp relief location map.png
 
| caption = Two locations in the USA
 
| caption = Two locations in the USA
 
| width  = 250
 
| width  = 250
 
| places  =
 
| places  =
 
   {{Location map~ | USA
 
   {{Location map~ | USA
   | lat   = 38.89
+
   | label   = Washington, D.C.
   | long  = -77.04
+
  | lat_deg = 38.89
  | label = Washington, D.C.
+
   | lon_deg = -77.04
 
   }}
 
   }}
 
   {{Location map~ | USA
 
   {{Location map~ | USA
   | lat   = 47.61
+
   | label  = Seattle
   | long  = -122.33
+
   | lat_deg = 47.61
  | label = Seattle
+
   | lon_deg = -122.33
 
   }}
 
   }}
 
}}
 
}}
Line 104: Line 137:
  
 
== See also ==
 
== See also ==
* [[Template:Location map]]
+
 
* [[Template:Location map+]]
+
; Location map templates
* [[Template:Location map many]]
+
* [[Template:Location map]], to display one mark and label using latitude and longitude
* [[Template:Location map USA2]]
+
* [[Template:Location map many]], to display up to nine marks and labels
* [[Template:Location map USA relief]]
+
* [[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>
 
<includeonly>
 
<!-- Categories and interwikis go here: -->
 
<!-- Categories and interwikis go here: -->
  
 
</includeonly>
 
</includeonly>

Revision as of 16:19, 30 April 2013

Template:Location map USA is a location map definition used to overlay markers and labels on an equidistant conic projection map of the United States. 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":

Map definition

Alternative map

The map defined as image1 (Template:Location map/data/USA) 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) 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

Location map, using default map (image)

Washington, D.C. (the United States)
{{Location map | USA
| width   = 250
| label   = Washington, D.C.
| lat_deg = 38.89
| lon_deg = -77.04
}}

Location map many, using relief map (image1)

{{Location map many | USA
| relief   = yes
| width    = 250
| caption  = Two locations in the USA
| label1   = Washington, D.C.
| lat1_deg = 38.89
| lon1_deg = -77.04
| label2   = Seattle
| lat2_deg = 47.61
| lon2_deg = -122.33
}}

Location map+, using AlternativeMap

{{Location map+ | USA
| AlternativeMap = Usa edcp relief location map.png
| caption = Two locations in the USA
| width   = 250
| places  =
  {{Location map~ | USA
  | label   = Washington, D.C.
  | lat_deg = 38.89
  | lon_deg = -77.04
  }}
  {{Location map~ | USA
  | label   = Seattle
  | lat_deg = 47.61
  | lon_deg = -122.33
  }}
}}

See also

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