Template: Location map/doc: Difference between revisions
From A Wiki of Ice and Fire
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
<noinclude>{{note|This is a documentation subpage for [[Template: | <noinclude>{{note|This is a documentation subpage for [[Template:Location map]]}}<hr></noinclude> | ||
This template generates a location map as a composite image consisting of a map and a location mark. Optionally a label and caption can be added. | This template generates a location map as a composite image consisting of a map and a location mark. Optionally a label and caption can be added. | ||
| Line 11: | Line 11: | ||
</pre> | </pre> | ||
Where RegionName is one of the bellow: | |||
;General: | |||
* World (not yet set up) | * World (not yet set up) | ||
* Westeros (not yet set up) | * Westeros (not yet set up) | ||
| Line 17: | Line 18: | ||
* Sothoros (not yet set up) | * Sothoros (not yet set up) | ||
In Westeros: | ;In Westeros: | ||
* The North | * The North | ||
* The Westerlands | * The Westerlands | ||
| Line 28: | Line 29: | ||
* Dorne | * Dorne | ||
In Essos | ;In Essos | ||
* Free Cities (not yet set up) | * Free Cities (not yet set up) | ||
* Slavers Bay (not yet set up) | * Slavers Bay (not yet set up) | ||
* Valyrian Peninsula (not yet set up) | * Valyrian Peninsula (not yet set up) | ||
==Additional Options== | ==Additional Options== | ||
{| class="wikitable" style="width:100%;" | |||
! colspan="2" | Additional Map display parameters | |||
|- | |||
! Parameter | |||
! Description | |||
|- | |||
| <code>width</code> | |||
| Determines the width of the map in pixels. The default is 350. Do not include <code>px</code>, for example: <code>width=300</code>, not <code>width=300px</code>. | |||
|- | |||
| <code>caption</code> | |||
| The text of a caption to be displayed below the map. Specifying a caption will cause the map to be displayed with a frame. If <code>caption</code> is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If <code>caption</code> is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the <code>label</code> parameter (or the current page name if label not defined) and the <code>name</code> parameter from map definition template. See the [[#Examples|examples]] below. | |||
|- | |||
| <code>alt</code> | |||
| Alt text for map; shown on mouse hover. | |||
|- | |||
| <code>position</code> | |||
| The position of the label relative to the mark. Valid values are <code>left</code>, <code>right</code>, <code>top</code> and <code>bottom</code>. The default is <code>right</code>''. | |||
|- | |||
| <code>mark</code> | |||
| The name of an image to display as the mark. The default is [[:File:Red pog.png|Red pog.png]] ([[File:Red pog.png|8px]]). See examples at [[:Category:Location markers]]. | |||
|- | |||
| <code>link</code> | |||
| Specifies a wiki link which will be followed if the reader clicks on the mark. The name of the linked article is displayed when the mouse pointer hovers over the mark. | |||
|} | |||
==References== | |||
{{EnWP|Template:Location map|small=yes}} | |||
<noinclude>[[Category:Location map| ]]</noinclude> | <noinclude>[[Category:Location map| ]]</noinclude> | ||
Revision as of 21:19, 18 May 2012
This template generates a location map as a composite image consisting of a map and a location mark. Optionally a label and caption can be added. Note: The template was copied whole from Wikipedia:Template:Location map, while we don't use all of its functionality, it was left intact to ease the process of future integration.
Basic Usage
Simple syntax versions
{{Location map| RegionName | long=XX |lat=YY }}
{{Location map| RegionName | long=XX |lat=YY | label= LocationName }}
Where RegionName is one of the bellow:
- General
- World (not yet set up)
- Westeros (not yet set up)
- Essos (not yet set up)
- Sothoros (not yet set up)
- In Westeros
- The North
- The Westerlands
- The Iron Islands
- The Vale
- The Riverlands
- The Reach
- The Stormlands
- Crownlands
- Dorne
- In Essos
- Free Cities (not yet set up)
- Slavers Bay (not yet set up)
- Valyrian Peninsula (not yet set up)
Additional Options
| Additional Map display parameters | |
|---|---|
| Parameter | Description |
width
|
Determines the width of the map in pixels. The default is 350. Do not include px, for example: width=300, not width=300px.
|
caption
|
The text of a caption to be displayed below the map. Specifying a caption will cause the map to be displayed with a frame. If caption is defined but is not assigned a value, the map will not be framed and no caption will be displayed. If caption is not defined, the map will not be framed and a default caption will be generated. The default caption is created from the label parameter (or the current page name if label not defined) and the name parameter from map definition template. See the examples below.
|
alt
|
Alt text for map; shown on mouse hover. |
position
|
The position of the label relative to the mark. Valid values are left, right, top and bottom. The default is right.
|
mark
|
The name of an image to display as the mark. The default is Red pog.png ( ). See examples at Category:Location markers.
|
link
|
Specifies a wiki link which will be followed if the reader clicks on the mark. The name of the linked article is displayed when the mouse pointer hovers over the mark. |
References
This page uses content from the English Wikipedia. The original content was at Template:Location map. The list of authors can be seen in the page history of Template:Location map. As with A Wiki of Ice and Fire, the content of Wikipedia is available under the Creative Commons Attribution-ShareAlike License.