Template:CoordDMS/doc: Difference between revisions
meta>Salix alba tidy |
meta>Salix alba update doc |
||
Line 18: | Line 18: | ||
* Latitude (N/S) must appear before longitude (E/W). | * Latitude (N/S) must appear before longitude (E/W). | ||
Optional | Optional parameters the are all named parameters in the form <code>name=value</code> | ||
*'''display''' | |||
* | |||
*: {{Para|display|inline}} (the default) to display in the body of the article only, | *: {{Para|display|inline}} (the default) to display in the body of the article only, | ||
*: {{Para|display|title}} to display at the top of the article only, or | *: {{Para|display|title}} to display at the top of the article only, or | ||
*: {{Para|display|inline,title}} to display in both places. | *: {{Para|display|inline,title}} to display in both places. | ||
* | *'''name''' | ||
*: | *: {{Para|name|X}} to label the place on maps (default is [[mw:Help:Magic words#Page names|PAGENAME]]) | ||
Thus: '''<code><nowiki>{{ | *'''Notes''' | ||
*: {{Para|notes}} text displayed immediately following the coordinates, | |||
*'''format''' How the coordinates are displayed | |||
*:{{Para|format|dec}} decimal format | |||
*:{{Para|format|dms}} degrees minutes and seconds format | |||
Optional geodata coordinates parameters, the old geohack format with colon and underscore is not supported | |||
* '''dim''': approximate size of the object, used to scale the map to fit. | |||
* '''scale''': Scale of map display for this object, e.g. scale of 300 is 1:300. Gets converted into ''dim'' internally using formula ''dim = scale / 10''. If both scale and dim are set, dim has precedence. | |||
* '''globe''': earth by default, can be one of earth, mercury, venus, moon, mars, phobos, deimos, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton and pluto | |||
* '''name''': name of this point, up to 255 bytes (UTF-8). | |||
* '''region''': [[ISO 3166-1 alpha-2]] country code (e.g. ''US'' or ''RU'') or an [[ISO 3166-2]] region code (e.g. ''US-FL'' or ''RU-MOS''). This parameter is always capitalised internally. | |||
* '''type''': type of object with these coordinates, can be one of the following: country, satellite, state, adm1st, adm2nd, adm3rd, city, isle, mountain, river, waterbody, event, forest, glacier, airport, railwaystation, edu, pass, camera, landmark. | |||
Thus: '''<code><nowiki>{{CoordDM|57|18|22|N|4|27|42|W| dim=30 | region=US-WI | type=event | display=inline,title | name=accident site}}</nowiki></code>''' | |||
Use {{Para|display|title}} (or {{Para|display|inline,title}}) once per article, for the subject of the article, where appropriate. | Use {{Para|display|title}} (or {{Para|display|inline,title}}) once per article, for the subject of the article, where appropriate. | ||
Line 91: | Line 99: | ||
"type": "string", | "type": "string", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 120: | Line 122: | ||
"label": "Format", | "label": "Format", | ||
"description": "How the coordinates are displayed, either 'dec' or 'dms'", | "description": "How the coordinates are displayed, either 'dec' or 'dms'", | ||
"type": "string", | |||
"required": false | |||
}, | |||
"dim": { | |||
"label": "Dim", | |||
"description": "approximate size of the object, used to scale the map to fit.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"scale": { | |||
"label": "Scale", | |||
"description": "Scale of map display for this object, e.g. scale of 300 is 1:300. Gets converted into ''dim'' internally using formula ''dim = scale / 10''. If both scale and dim are set, dim has precedence.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"globe": { | |||
"label": "Globe", | |||
"description": "earth by default, can be one of earth, mercury, venus, moon, mars, phobos, deimos, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton and pluto", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"region": { | |||
"label": "Region", | |||
"description": "[[ISO 3166-1 alpha-2]] country code (e.g. ''US'' or ''RU'') or an [[ISO 3166-2]] region code (e.g. ''US-FL'' or ''RU-MOS''). This parameter is always capitalised internally.", | |||
"type": "string", | |||
"required": false | |||
}, | |||
"type": { | |||
"label": "Type", | |||
"description": "type of object with these coordinates, can be one of the following: country, satellite, state, adm1st, adm2nd, adm3rd, city, isle, mountain, river, waterbody, event, forest, glacier, airport, railwaystation, edu, pass, camera, landmark.", | |||
"type": "string", | "type": "string", | ||
"required": false | "required": false | ||
} | } | ||
}}</templatedata> | }}</templatedata> | ||
Revision as of 15:36, 16 July 2013
This is a documentation subpage for Template:CoordDMS. It may contain usage information, categories and other content that is not part of the original template page. |
A version of the Template:T1 template where degrees, minutes and seconds are specified.
Usage
To add Lua error: callParserFunction: function "#coordinates" was not found.{{#coordinates:57|18|22|N|4|27|32|W|dim=|globe=|scale=|region=|type= | |name= }} to the top of an article, use {{CoordDMS}}, thus:
{{CoordDMS|57|18|22|N|4|27|32|W|display=title}}
No alternate set of parameter are available for this template. See {{coordDec}} for angles specified as signed decimal degrees, and {{coordDM}} for when just degrees and minutes are specified.
These coordinates are in degrees, minutes, and seconds of arc.
- Degrees, minutes and seconds must be separated by a pipe ("|").
- Map datum must be WGS84 (except for off-earth bodies).
- Avoid excessive precision (0.0001° is <11 m, 1″ is <31 m).
- Latitude (N/S) must appear before longitude (E/W).
Optional parameters the are all named parameters in the form name=value
- display
|display=inline
(the default) to display in the body of the article only,|display=title
to display at the top of the article only, or|display=inline,title
to display in both places.
- name
|name=X
to label the place on maps (default is PAGENAME)
- Notes
|notes=
text displayed immediately following the coordinates,
- format How the coordinates are displayed
|format=dec
decimal format|format=dms
degrees minutes and seconds format
Optional geodata coordinates parameters, the old geohack format with colon and underscore is not supported
- dim: approximate size of the object, used to scale the map to fit.
- scale: Scale of map display for this object, e.g. scale of 300 is 1:300. Gets converted into dim internally using formula dim = scale / 10. If both scale and dim are set, dim has precedence.
- globe: earth by default, can be one of earth, mercury, venus, moon, mars, phobos, deimos, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton and pluto
- name: name of this point, up to 255 bytes (UTF-8).
- region: ISO 3166-1 alpha-2 country code (e.g. US or RU) or an ISO 3166-2 region code (e.g. US-FL or RU-MOS). This parameter is always capitalised internally.
- type: type of object with these coordinates, can be one of the following: country, satellite, state, adm1st, adm2nd, adm3rd, city, isle, mountain, river, waterbody, event, forest, glacier, airport, railwaystation, edu, pass, camera, landmark.
Thus: {{CoordDM|57|18|22|N|4|27|42|W| dim=30 | region=US-WI | type=event | display=inline,title | name=accident site}}
Use |display=title
(or |display=inline,title
) once per article, for the subject of the article, where appropriate.
- Per WP:ORDER, the template is placed in articles after any navigation templates, but before any Persondata or Defaultsort templates, or Categories.
- For full details, refer to {{Coord/doc}}.
- Additional guidance is available: obtaining coordinates, converting coordinates
Template Data
Encodes the latitude and longitude coordinates of a location as degrees, minutes and seconds. Displays the coordinates and provides a link to map of the location.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Latitude degrees | 1 | The degrees part of the latitude, a positive whole number. | Number | required |
Latitude minutes | 2 | The minutes part of the latitude. Do not be overly precise, 1' is approximately 1.5km. | Number | required |
Latitude seconds | 3 | The minutes part of the latitude. Do not be overly precise, 1" is approximately 30m. | Number | required |
Latitude direction | 4 | Direction part of latitude: N or S. | String | required |
Longitude degrees | 5 | The degrees part of the longitude, a positive whole number. | Number | required |
Longitude minutes | 6 | The minutes part of the longitude. Do not be overly precise 1' is approximately 1.5km. | Number | required |
Longitude seconds | 7 | The minutes part of the longitude. Do not be overly precise 1" is approximately 30m. | Number | required |
Longitude direction | 8 | Direction part of longitude: E or W. | String | required |
Display | display | Where it is displayed. Can be one of: 'inline' in the body of the article (default), 'title' at the top of the article or 'inline,title' both | String | optional |
Name | name | a label to place on maps (default is PAGENAME) | String | optional |
Notes | notes | text displayed immediately following the coordinates | String | optional |
Format | format | How the coordinates are displayed, either 'dec' or 'dms' | String | optional |
Dim | dim | approximate size of the object, used to scale the map to fit. | String | optional |
Scale | scale | Scale of map display for this object, e.g. scale of 300 is 1:300. Gets converted into ''dim'' internally using formula ''dim = scale / 10''. If both scale and dim are set, dim has precedence. | String | optional |
Globe | globe | earth by default, can be one of earth, mercury, venus, moon, mars, phobos, deimos, ganymede, callisto, io, europa, mimas, enceladus, tethys, dione, rhea, titan, hyperion, iapetus, phoebe, miranda, ariel, umbriel, titania, oberon, triton and pluto | String | optional |
Region | region | [[ISO 3166-1 alpha-2]] country code (e.g. ''US'' or ''RU'') or an [[ISO 3166-2]] region code (e.g. ''US-FL'' or ''RU-MOS''). This parameter is always capitalised internally. | String | optional |
Type | type | type of object with these coordinates, can be one of the following: country, satellite, state, adm1st, adm2nd, adm3rd, city, isle, mountain, river, waterbody, event, forest, glacier, airport, railwaystation, edu, pass, camera, landmark. | String | optional |
See also
- Template:T1 the base template has more details on some of the parameters
- Template:T1 an alternative version where signed decimal degrees are specified
- Template:T1 an alternative version just degrees and minutes are specified