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

From blackwiki
Jump to navigation Jump to search
blackwiki>Jackmcbarn
m (Jackmcbarn moved page Template:Location map Israel/doc to Module:Location map/data/Israel/doc without leaving a redirect)
blackwiki>Jackmcbarn
m (convert to module-style doc)
Line 1: Line 1:
{{Documentation subpage}}
 
 
<!-- Categories and interwikis go at the bottom of this page. -->
 
<!-- Categories and interwikis go at the bottom of this page. -->
[[File:Is-map.PNG|thumb|220px|Map of Israel]]
+
{{Module:Location map/data/doc|image=[[File:Is-map.PNG|thumb|220px|Map of Israel]]
 
+
|examples=
'''Template:Location map Israel''' is a location map definition used to overlay markers and labels on an [[equirectangular projection]] map of [[Israel]]. 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 "Israel":
 
* {{tlx|Location map | Israel&nbsp;| ...}}
 
* {{tlx|Location map many | Israel&nbsp;| ...}}
 
* {{tlx|Location map+ | Israel&nbsp;| ...}}
 
* {{tlx|Location map~ | Israel&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, using default map (image) ===
 
{{Location map | Israel
 
{{Location map | Israel
Line 164: Line 97:
 
}}
 
}}
 
</pre>
 
</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>
 
<includeonly>
 
<!-- Categories and interwikis go here: -->
 
<!-- Categories and interwikis go here: -->
  
 
</includeonly>
 
</includeonly>

Revision as of 16:48, 19 June 2015


Location map of Israel
name Israel
border
coordinates
33.5
33.7 ←↕→ 36.3
29.3
map center Lua error: callParserFunction: function "#coordinates" was not found.
image Israel location map with stripes.svg
400x400px
image1 Israel relief location map.jpg
400x400px
image2 Israel relief location map-blank.jpg
400x400px
image3 Israel fullyeco location map.svg
400x400px
File:Is-map.PNG
Map of Israel

Module:Location map/data/Israel is a location map definition used to overlay markers and labels on an equirectangular projection map of Israel. 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 "Israel":

Map definition

  • name = Israel
    Name used in the default map caption
  • bottom = 29.3
    Latitude at bottom edge of map, in decimal degrees
  • left = 33.7
    Longitude at left edge of map, in decimal degrees
  • right = 36.3
    Longitude at right edge of map, in decimal degrees

Alternative map

The {{Location map}}, {{Location map many}}, and {{Location map+}} templates have parameters to specify an alternative map image. The map displayed as image1 can be used with the relief or AlternativeMap parameters. The maps displayed as image2 / image3 can be used with the AlternativeMap parameter. Examples may be found below or in the following:

Precision

Longitude: from West to East this map definition covers 2.6 degrees.

  • At an image width of 200 pixels, that is 0.013 degrees per pixel.
  • At an image width of 1000 pixels, that is 0.0026 degrees per pixel.

Latitude: from North to South this map definition covers 4.2 degrees.

  • At an image height of 200 pixels, that is 0.021 degrees per pixel.
  • At an image height of 1000 pixels, that is 0.0042 degrees per pixel.

Examples using location map templates

Location map, using default map (image)

Jerusalem (Israel)
{{Location map | Israel
| width   = 180
| lat_deg = 31.78
| lon_deg = 35.22
| label   = Jerusalem
}}

Location map many, using relief map (image1)

{{Location map many | Israel
| relief   = yes
| width    = 180
| caption  = Three locations in Israel
| lat1_deg = 31.78
| lon1_deg = 35.22
| label1   = Jerusalem
| lat2_deg = 32.82
| lon2_deg = 34.98
| label2   = Haifa
| lat3_deg = 29.55
| lon3_deg = 34.95
| label3   = Eilat
}}

Location map+, using AlternativeMap

{{Location map+ | Israel
| AlternativeMap = Israel relief location map-blank.jpg
| width   = 180
| caption = Three locations in Israel
| places  =
  {{Location map~ | Israel
  | lat_deg = 31.78
  | lon_deg = 35.22
  | label   = Jerusalem
  }}
  {{Location map~ | Israel
  | lat_deg = 32.82
  | lon_deg = 34.98
  | label   = Haifa
  }}
  {{Location map~ | Israel
  | lat_deg = 29.55
  | lon_deg = 34.95
  | label   = Eilat
  }}
}}

See also

Location map templates

Creating new map definitions