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

From blackwiki
Jump to navigation Jump to search
blackwiki>Zyxw
(add document subpage formatting, remove undisplayed copy of old map values, update examples)
blackwiki>Zyxw
(update documentation and add example using Template:Location map+)
Line 2: Line 2:
 
<!-- Categories and interwikis go at the bottom of this page. -->
 
<!-- Categories and interwikis go at the bottom of this page. -->
  
The map definition, [[Template:Location map Egypt]], is intended for overlaying markers/labels on similar maps of [[Egypt]], using coordinates of 20.8 to 32.8 for [[latitude]] and 25.3 to 35.8 for [[longitude]].
+
'''Template:Location map Egypt''' is a location map definition used to overlay markers and labels on an [[equirectangular projection]] map of [[Egypt]]. The markers are placed by [[latitude]] and [[longitude]] coordinates on the default map or a similar map image.  
 
 
[[File:Egypt-region-map-cities-2.gif|left|thumb|210px|Map for Egypt]]
 
{| class="wikitable" width="320"
 
|-
 
| align=center colspan="3" style="background-color:#DDD; color:#000" | '''Map parameters'''
 
|-
 
| top    || {{Location map Egypt|top}}
 
| latitude at top of map
 
|-
 
| bottom || {{Location map Egypt|bottom}}
 
| latitude at bottom of map
 
|-
 
| left  || {{Location map Egypt|left}}
 
| longitude at map left edge
 
|-
 
| right || {{Location map Egypt|right}}
 
| longitude at map right edge
 
|-
 
| skew  || {{Location map Egypt|skew}}
 
| skew to narrow longitudes
 
|-
 
| lat_skew || {{Location map Egypt|lat_skew}}
 
| skew to arc latitudes at edges
 
|}
 
See {{tl|Location map}} for description of the parameters.
 
{{-}}<!-- force separation break -->
 
  
 
== Usage ==
 
== Usage ==
Some of the related mapping templates are:
+
These definitions are used by the following templates when invoked with parameter "Egypt":
* [[Template:Location map]] - places a marker symbol/label on an image;
+
* {{tlx|Location map | Egypt&nbsp;| ...}}
* [[Template:Location map many]] - places multiple marker symbols/labels on an image;
+
* {{tlx|Location map many | Egypt&nbsp;| ...}}
* [[Template:Location map skew]] - puts symbols/labels on an image with converging longitudes.
+
* {{tlx|Location map+ | Egypt&nbsp;| ...}}
 +
* {{tlx|Location map~ | Egypt&nbsp;| ...}}
  
All mapping templates use similar parameters (see ''[[#Examples|Examples]]''):
+
== Map definition ==
<code>
+
; name
:''Map settings''
+
: used in default map caption (<tt>{{{{BASEPAGENAME}}|name}}</tt>)
:* Egypt          - the first parameter is always the map name
+
; image
:* AlternativeMap - name of image (omit "Image:")
+
: the default map image, without "Image:" or "File:" (<tt>[[:File:{{{{BASEPAGENAME}}|image}}|{{{{BASEPAGENAME}}|image}}]]</tt>)
:* width=250      - for image width (omit "px")
+
; image1
:* float=right (left, center) - position of map formatted on page
+
: an alternative map image, usually a relief map (<tt>[[:File:{{{{BASEPAGENAME}}|image1}}|{{{{BASEPAGENAME}}|image1}}]]</tt>)
:* caption=text  - caption text along bottom of image
+
; top
:''Label settings''
+
: [[latitude]] at top edge of map, in [[decimal degrees]] (<tt>{{{{BASEPAGENAME}}|top}}</tt>)
:* lat=26.25      - for latitude 20.8-32.8 (higher towards top)
+
; bottom
:* long=31.92    - for longitude 25.3-35.8 (higher towards right)
+
: latitude at bottom edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|bottom}}</tt>)
:* label=xxx      - movable label (can be padded "&amp;nbsp;XX&amp;nbsp;YY&amp;nbsp;")
+
; left
:* label_size    - percent from 0-200 (default: 95)
+
: [[longitude]] at left edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|left}}</tt>)
:* position=right - (or left, top, bottom) position of label at marker
+
; right
:* mark          - name of image for marker symbol (omit "Image:")
+
: longitude at right edge of map, in decimal degrees (<tt>{{{{BASEPAGENAME}}|right}}</tt>)
:* marksize      - size (in pixels) of marker-symbol (default: 8, 1=none)
 
:* background    - color of label (such as: darkorange or #4499DD)
 
::Some common label background colors are:
 
::* <small>#</small>CCCC55 for <font color=#CCCC55>'''dim yellow'''</font>,
 
::* <small>#</small>44EE44 for <font color=#44EE44>'''lime green'''</font>, <small>#</small>BBBBBB for <font color=#BBBBBB>'''gray'''</font>,
 
::* <small>#</small>44CCDD for <font color=#44CCDD>'''light aqua'''</font>, <small>#</small>DDDDDD for <font color=#DDDDDD>'''light gray'''</font> (almost white),
 
::* PaleGreen for <font color=PaleGreen>'''pale green'''</font>, <font color=PaleTurquoise>'''PaleTurquoise'''</font>, <font color=DarkOrange>'''DarkOrange'''</font>, etc.
 
::* By default, the label is ''transparent'' overwriting the image.
 
</code>
 
  
For small lettering use label_size=80, for tiny words use 55.  Note that the words in the label will wrap unless using "nbsp": <small>DO&amp;nbsp;NOT&amp;nbsp;WRAP</small>.
+
== Alternative map ==
 
+
The map shown above as '''image1''' (<tt>{{{{BASEPAGENAME}}|image1}}</tt>) can be displayed by using the ''AlternativeMap'' or ''relief'' parameters in {{tl|Location map}}, {{tl|Location map many}} and {{tl|Location map+}}. Further instructions can be found at [[Template:Location map#Using Alternative Map]] and [[Template:Location map#Relief]], or see the examples below.
When specifying image "width=270" be sure to ''OMIT'' "px" (which causes the image to span the width of the screen) because "px" cannot (yet) be detected by the (new) MediaWiki language which processes those mapping templates.
 
 
 
See each specific mapping template for other parameters to pass.
 
 
 
== How to use an alternative map ==
 
This template normally displays the map shown above as '''image''':
 
*<tt>{{{{BASEPAGENAME}}|image}}</tt>.
 
The ''AlternativeMap'' or ''relief'' parameters in {{tl|Location map}} can be used to display the map shown above as '''image1''':
 
*<tt>{{{{BASEPAGENAME}}|image1}}</tt>.
 
Further instructions and examples can be found at [[Template:Location map#Using Alternative Map]] and [[Template:Location map#Relief]].
 
  
 
== Examples ==
 
== Examples ==
=== Location map, using default map image ===
+
=== Location map, using default map (image) ===
 
{{Location map | Egypt
 
{{Location map | Egypt
| width = 210 <!--omit "px"-->
+
| width = 200 <!--omit "px"-->
 
| label = Abydos
 
| label = Abydos
 
| lat  = 26.18
 
| lat  = 26.18
 
| long  = 31.92
 
| long  = 31.92
 
}}
 
}}
<pre style="width:37em">
+
<pre style="width:35em">
 
{{Location map | Egypt
 
{{Location map | Egypt
| width = 210 <!--omit "px"-->
+
| width = 200 <!--omit "px"-->
 
| label = Abydos
 
| label = Abydos
 
| lat  = 26.18
 
| lat  = 26.18
Line 92: Line 48:
 
{{clear}}
 
{{clear}}
  
=== Location map, using relief parameter ===
+
=== Location map, using relief map (image1) ===
 
{{Location map | Egypt
 
{{Location map | Egypt
 
| relief    = yes
 
| relief    = yes
| float    = right <!--position (or: left/center)-->
+
| float    = right <!--or left/center)-->
| width    = 210
+
| width    = 200
 
| caption  = Berenice on Red Sea
 
| caption  = Berenice on Red Sea
 +
| lat      = 23.92
 +
| long      = 35.45
 
| label    = Berenice
 
| label    = Berenice
 
| label_size= 70
 
| label_size= 70
 
| background= #44CCDD <!--aqua-->
 
| background= #44CCDD <!--aqua-->
 
| position  = left <!--or right/top/bottom -->
 
| position  = left <!--or right/top/bottom -->
| lat      = 23.92
 
| long      = 35.45
 
 
| mark      = Green_pog.svg <!--marker image-->
 
| mark      = Green_pog.svg <!--marker image-->
| marksize  = 10 <!--marker size (default: 8, 1=none)-->
+
| marksize  = 10 <!--default: 8, 1=none -->
 
}}
 
}}
<pre style="width:37em">
+
<pre style="width:35em">
 
{{Location map | Egypt
 
{{Location map | Egypt
 
| relief    = yes
 
| relief    = yes
| float    = right <!--position (or: left/center)-->
+
| float    = right <!--or left/center)-->
| width    = 210
+
| width    = 200
 
| caption  = Berenice on Red Sea
 
| caption  = Berenice on Red Sea
 +
| lat      = 23.92
 +
| long      = 35.45
 
| label    = Berenice
 
| label    = Berenice
 
| label_size= 70
 
| label_size= 70
 
| background= #44CCDD <!--aqua-->
 
| background= #44CCDD <!--aqua-->
 
| position  = left <!--or right/top/bottom -->
 
| position  = left <!--or right/top/bottom -->
| lat      = 23.92
 
| long      = 35.45
 
 
| mark      = Green_pog.svg <!--marker image-->
 
| mark      = Green_pog.svg <!--marker image-->
| marksize  = 10 <!--marker size (default: 8, 1=none)-->
+
| marksize  = 10 <!--default: 8, 1=none -->
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
=== Location map many, using AlternativeMap parameter ===
+
=== Location map many, using default map ===
 
{{Location map many | Egypt
 
{{Location map many | Egypt
 
| <!--map settings-->
 
| <!--map settings-->
| AlternativeMap = Egypt relief location map.jpg
+
| width       = 200
| width   = 210 <!--omit "px"-->
+
| float       = right
| float   = right <!--position (or: left/center)-->
+
| caption     = Sallum north, Abu Simbel in south
| caption = Sallum north, Abu Simbel in south
 
 
| <!--1st label settings-->
 
| <!--1st label settings-->
 +
| lat        = 31.61
 +
| long        = 25.92
 
| label      = Sallum  
 
| label      = Sallum  
 
| label_size  = 70
 
| label_size  = 70
 
| background  = #DDDD44
 
| background  = #DDDD44
| position    = right <!--or: left/top/bottom-->
+
| position    = right
| lat        = 31.61
+
| mark        = Blue pog.svg
| long        = 25.92
+
| marksize    = 10
| mark        = Blue_pog.svg <!--marker image-->
 
| marksize    = 10 <!--marker size (default: 8)-->
 
 
| <!--2nd label settings-->
 
| <!--2nd label settings-->
 +
| lat2        = 22.34
 +
| long2      = 31.37
 
| label2      = Abu&nbsp;Simbel
 
| label2      = Abu&nbsp;Simbel
 
| label2_size = 70
 
| label2_size = 70
 
| background2 = DarkOrange
 
| background2 = DarkOrange
| position2  = top <!--or: left/right/bottom -->
+
| position2  = top
| lat2        = 22.34
+
| mark2      = Blue pog.svg
| long2      = 31.37
+
| mark2size  = 10
| mark2      = Blue_pog.svg <!--marker image-->
 
| mark2size  = 10 <!--marker size (default: 8)-->
 
 
}}
 
}}
<pre style="width:37em">
+
<pre style="width:35em">
 
{{Location map many | Egypt
 
{{Location map many | Egypt
 
| <!--map settings-->
 
| <!--map settings-->
| AlternativeMap = Egypt relief location map.jpg
+
| width       = 200
| width   = 210 <!--omit "px"-->
+
| float       = right
| float   = right <!--position (or: left/center)-->
+
| caption     = Sallum north, Abu Simbel in south
| caption = Sallum north, Abu Simbel in south
 
 
| <!--1st label settings-->
 
| <!--1st label settings-->
 +
| lat        = 31.61
 +
| long        = 25.92
 
| label      = Sallum  
 
| label      = Sallum  
 
| label_size  = 70
 
| label_size  = 70
 
| background  = #DDDD44
 
| background  = #DDDD44
| position    = right <!--or: left/top/bottom-->
+
| position    = right
| lat        = 31.61
+
| mark        = Blue pog.svg
| long        = 25.92
+
| marksize    = 10
| mark        = Blue_pog.svg <!--marker image-->
 
| marksize    = 10 <!--marker size (default: 8)-->
 
 
| <!--2nd label settings-->
 
| <!--2nd label settings-->
 +
| lat2        = 22.34
 +
| long2      = 31.37
 
| label2      = Abu&nbsp;Simbel
 
| label2      = Abu&nbsp;Simbel
 
| label2_size = 70
 
| label2_size = 70
 
| background2 = DarkOrange
 
| background2 = DarkOrange
| position2  = top <!--or: left/right/bottom -->
+
| position2  = top
| lat2        = 22.34
+
| mark2      = Blue pog.svg
| long2      = 31.37
+
| mark2size  = 10
| mark2      = Blue_pog.svg <!--marker image-->
+
}}
| mark2size   = 10 <!--marker size (default: 8)-->
+
</pre>
 +
{{clear}}
 +
 
 +
=== Location map+, using AlternativeMap ===
 +
{{Location map+ | Egypt
 +
| AlternativeMap = Egypt relief location map.jpg
 +
| width  = 200
 +
| caption = Two locations in Egypt
 +
| places  =
 +
  {{Location map~ | Egypt
 +
  | lat  = 31.61
 +
  | long  = 25.92
 +
  | label = Sallum
 +
  }}
 +
  {{Location map~ | Egypt
 +
  | lat  = 22.34
 +
  | long  = 31.37
 +
  | label = Abu Simbel
 +
  }}
 +
}}
 +
<pre style="width:35em">
 +
{{Location map+ | Egypt
 +
| AlternativeMap = Egypt relief location map.jpg
 +
| width  = 200
 +
| caption = Two locations in Egypt
 +
| places  =
 +
  {{Location map~ | Egypt
 +
  | lat  = 31.61
 +
  | long  = 25.92
 +
  | label = Sallum
 +
  }}
 +
  {{Location map~ | Egypt
 +
  | lat  = 22.34
 +
  | long  = 31.37
 +
   | label = Abu Simbel
 +
  }}
 
}}
 
}}
 
</pre>
 
</pre>
 
{{clear}}
 
{{clear}}
  
==Other options==
+
== Other options ==
 
It is possible to place markers/labels outside a map, by specifying latitude outside 20.5-32.8 or longitude coordinates beyond 25.5-35.8:
 
It is possible to place markers/labels outside a map, by specifying latitude outside 20.5-32.8 or longitude coordinates beyond 25.5-35.8:
 
:* Over longitude=35.8 will push a label off-map to the right;
 
:* Over longitude=35.8 will push a label off-map to the right;
Line 187: Line 178:
 
For templates that restrict coordinates, expand the ''minutes'' field: lat_deg=32.0 but lat_min=120 yielding a combined 34 degrees (60 minutes = 1 degree).
 
For templates that restrict coordinates, expand the ''minutes'' field: lat_deg=32.0 but lat_min=120 yielding a combined 34 degrees (60 minutes = 1 degree).
  
==See also==
+
== See also ==
* [[Template:Superimpose]] - to label an image without a border box
+
* [[Template:Location map]]
* [[Template:Location map USA]] - for mapping the "lower 48" states
+
* [[Template:Location map+]]
 +
* [[Template:Location map many]]
 
* [[Template:Location map Egypt relief]]
 
* [[Template:Location map Egypt relief]]
 
<includeonly>
 
<includeonly>

Revision as of 10:54, 11 August 2011

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

Map definition

name
used in default map caption (Template:Location map/data/Egypt)
image
the default map image, without "Image:" or "File:" ([[:File:Template:Location map/data/Egypt|Template:Location map/data/Egypt]])
image1
an alternative map image, usually a relief map ([[:File:Template:Location map/data/Egypt|Template:Location map/data/Egypt]])
top
latitude at top edge of map, in decimal degrees (Template:Location map/data/Egypt)
bottom
latitude at bottom edge of map, in decimal degrees (Template:Location map/data/Egypt)
left
longitude at left edge of map, in decimal degrees (Template:Location map/data/Egypt)
right
longitude at right edge of map, in decimal degrees (Template:Location map/data/Egypt)

Alternative map

The map shown above as image1 (Template:Location map/data/Egypt) can be displayed by using the AlternativeMap or relief parameters in {{Location map}}, {{Location map many}} and {{Location map+}}. Further instructions can be found at Template:Location map#Using Alternative Map and Template:Location map#Relief, or see the examples below.

Examples

Location map, using default map (image)

{{Location map | Egypt
| width = 200 <!--omit "px"-->
| label = Abydos
| lat   = 26.18
| long  = 31.92
}}

Location map, using relief map (image1)

Berenice on Red Sea
{{Location map | Egypt
| relief    = yes
| float     = right <!--or left/center)-->
| width     = 200
| caption   = Berenice on Red Sea
| lat       = 23.92
| long      = 35.45
| label     = Berenice
| label_size= 70
| background= #44CCDD <!--aqua-->
| position  = left <!--or right/top/bottom -->
| mark      = Green_pog.svg <!--marker image-->
| marksize  = 10 <!--default: 8, 1=none -->
}}

Location map many, using default map

Sallum north, Abu Simbel in south
{{Location map many | Egypt
| <!--map settings-->
| width       = 200
| float       = right
| caption     = Sallum north, Abu Simbel in south
| <!--1st label settings-->
| lat         = 31.61
| long        = 25.92
| label       = Sallum 
| label_size  = 70
| background  = #DDDD44
| position    = right
| mark        = Blue pog.svg
| marksize    = 10
| <!--2nd label settings-->
| lat2        = 22.34
| long2       = 31.37
| label2      = Abu Simbel
| label2_size = 70
| background2 = DarkOrange
| position2   = top
| mark2       = Blue pog.svg
| mark2size   = 10
}}

Location map+, using AlternativeMap

{{Location map+ | Egypt
| AlternativeMap = Egypt relief location map.jpg
| width   = 200
| caption = Two locations in Egypt
| places  =
  {{Location map~ | Egypt
  | lat   = 31.61
  | long  = 25.92
  | label = Sallum 
  }}
  {{Location map~ | Egypt
  | lat   = 22.34
  | long  = 31.37
  | label = Abu Simbel
  }}
}}

Other options

It is possible to place markers/labels outside a map, by specifying latitude outside 20.5-32.8 or longitude coordinates beyond 25.5-35.8:

  • Over longitude=35.8 will push a label off-map to the right;
  • Under longitude= 20.5 will push a label off-map to the left;
  • Over latitude= 32.8 will push a label off-map to the top.

For templates that restrict coordinates, expand the minutes field: lat_deg=32.0 but lat_min=120 yielding a combined 34 degrees (60 minutes = 1 degree).

See also