Template:CoordDM/doc: Difference between revisions
meta>Salix alba more |
m 9 revisions imported |
||
(7 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- | {{lua|Module:Coordinates|Module:string}} | ||
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | |||
A version of the {{ | A version of the {{tl|Coord}} template where just degrees and minutes and are specified. | ||
== Usage == | == Usage == | ||
To add {{CoordDM|57|18|N|4|27|W}} to the top of an article, use {{tl|CoordDM}}, thus: | |||
To add {{CoordDM|57|18|N|4|27|W}} to the top of an article, use {{ | |||
:'''<code><nowiki>{{CoordDM|57|18|N|4|27|W|display=title}}</nowiki></code>''' | :'''<code><nowiki>{{CoordDM|57|18|N|4|27|W|display=title}}</nowiki></code>''' | ||
No alternate set of parameter are available for this template. See {{tl| | No alternate set of parameter are available for this template. See {{tl|CoordDec}} for angles specified as signed decimal degrees, and {{tl|CoordDMS}} for when degrees, minutes and seconds are all specified. | ||
These [[Geographic coordinate system|coordinates]] are in [[Degree (angle)|degrees]] and [[Minute of arc|minutes]]. | These [[Geographic coordinate system|coordinates]] are in [[Degree (angle)|degrees]] and [[Minute of arc|minutes]]. | ||
* [[Geodetic system|Map datum]] must be WGS84 (except for off-earth bodies). | * [[Geodetic system|Map datum]] must be WGS84 (except for off-earth bodies). | ||
* Avoid [[Wikipedia:WikiProject Geographical coordinates#Precision|excessive precision]] (0.0001° is <11 m, 1″ is <31 m). | * Avoid [[Wikipedia:WikiProject Geographical coordinates#Precision|excessive precision]] (0.0001° is <11 m, 1″ is <31 m). | ||
* Latitude (N/S) must appear before longitude (E/W). | * Latitude (N/S) must appear before longitude (E/W). | ||
Optional | Optional parameters 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>{{CoordDM|57|18|N|4|27|W|dim | *'''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|N|4|27|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. | ||
Per [[WP:ORDER]], the template is placed in articles after any [[Wikipedia:Navigation templates|navigation templates]], but before any [[Help:Category#Default sort key|Defaultsort]] templates, or [[Wikipedia:Categorization|Categories]]. | |||
* For full details, refer to | * For full details, refer to [[Template:Coord/doc]]. | ||
* Additional guidance is available: [[Wikipedia:Obtaining geographic coordinates|obtaining coordinates]], [[Geographic coordinate conversion|converting coordinates]] | * Additional guidance is available: [[Wikipedia:Obtaining geographic coordinates|obtaining coordinates]], [[Geographic coordinate conversion|converting coordinates]] | ||
==TemplateData== | |||
== | {{TemplateData header}} | ||
<templatedata>{ | <templatedata>{ | ||
"description": "Encodes the latitude and longitude coordinates of a location specified in degrees and minutes, provides a link to map of the location.", | "description": "Encodes the latitude and longitude coordinates of a location specified in degrees and minutes, provides a link to map of the location.", | ||
Line 79: | Line 86: | ||
"type": "string", | "type": "string", | ||
"required": true | "required": true | ||
}, | }, | ||
Line 108: | Line 109: | ||
"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 | ||
Line 114: | Line 145: | ||
== See also == | == See also == | ||
*{{ | * {{tl|Coord}} the base template has more details on some of the parameters | ||
*{{ | * {{tl|CoordDec}} an alternative version where signed decimal degrees are specified | ||
*{{ | * {{tl|CoordDMS}} an alternative version where degrees, minutes and seconds are specified | ||
<includeonly> | <includeonly>{{Sandbox other|| | ||
<!-- Categories | <!-- Categories below this line, please; interwikis at Wikidata --> | ||
[[Category:Coordinates templates]] | [[Category:Coordinates templates]] | ||
</includeonly> | }}</includeonly> |
Latest revision as of 13:00, 3 September 2020
This is a documentation subpage for Template:CoordDM. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
A version of the {{Coord}} template where just degrees and minutes and are specified.
Usage
To add Lua error: callParserFunction: function "#coordinates" was not found.{{#coordinates:57|18|N|4|27|W|dim=|globe=|scale=|region=|type={{{type}}} | |name= }} to the top of an article, use {{CoordDM}}, thus:
{{CoordDM|57|18|N|4|27|W|display=title}}
No alternate set of parameter are available for this template. See {{CoordDec}} for angles specified as signed decimal degrees, and {{CoordDMS}} for when degrees, minutes and seconds are all specified.
These coordinates are in degrees and minutes.
- 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 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|N|4|27|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 Defaultsort templates, or Categories.
- For full details, refer to Template:Coord/doc.
- Additional guidance is available: obtaining coordinates, converting coordinates
TemplateData
TemplateData for CoordDM
Encodes the latitude and longitude coordinates of a location specified in degrees and minutes, 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 direction | 3 | Direction part of latitude: N or S. | String | required |
Longitude degrees | 4 | The degrees part of the longitude, a positive whole number. | Number | required |
Longitude minutes | 5 | The minutes part of the longitude. Do not be overly precise 1' is approximately 1.5km. | Number | required |
Longitude direction | 6 | Direction part of longitude: E or W. Not used if decimal degrees are specified. | 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
- {{Coord}} the base template has more details on some of the parameters
- {{CoordDec}} an alternative version where signed decimal degrees are specified
- {{CoordDMS}} an alternative version where degrees, minutes and seconds are specified