Template:CoordDM/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

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.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:CoordDM in articles based on its TemplateData.

TemplateData for CoordDM

<templatedata>{ "description": "Encodes the latitude and longitude coordinates of a location specified in degrees and minutes, provides a link to map of the location.", "params": {

 "1": {
   "label": "Latitude degrees",
   "description": "The degrees part of the latitude, a positive whole number.",
   "type": "number",
   "required": true
 },
 "2": {
   "label": "Latitude minutes",
   "description": "The minutes part of the latitude. Do not be overly precise, 1' is approximately 1.5km.",
   "type": "number",
   "required": true
 },
 "3": {
   "label": "Latitude direction",
   "description": "Direction part of latitude: N or S.",
   "type": "string",  
   "required": true
 },
 "4": {
   "label": "Longitude degrees",
   "description": "The degrees part of the longitude, a positive whole number.",
   "type": "number",
   "required": true
 },
 "5": {
   "label": "Longitude minutes",
   "description": "The minutes part of the longitude. Do not be overly precise 1' is approximately 1.5km.",
   "type": "number",
   "required": true
 },
 "6": {
   "label": "Longitude direction",
   "description": "Direction part of longitude: E or W. Not used if decimal degrees are specified.",
   "type": "string",  
   "required": true
 },
 "display": {
   "label": "Display",
   "description": "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",
   "type": "string",  
   "required": false
 },
 "name": {
   "label": "Name",
   "description": "a label to place on maps (default is PAGENAME)",
   "type": "string",  
   "required": false
 },
 "notes": {
   "label": "Notes",
   "description": "text displayed immediately following the coordinates",
   "type": "string",  
   "required": false
 },
 "format": {
   "label": "Format",
   "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",  
   "required": false
 }

}}</templatedata>

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