Template:CoordDec/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Salix alba
(excess precision)
m (9 revisions imported)
 
(6 intermediate revisions by 5 users not shown)
Line 1: Line 1:
A version of the {{t1|coord}} template where the latitude and longitude are specified by signed decimal numbers.
{{Documentation subpage}}
{{lua|Module:Coordinates|Module:String}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
A version of the {{tl|Coord}} template where the latitude and longitude are specified by signed decimal numbers. It has been designed to work well with the [[WP:VE/TD|Visual Editor/TemplateData]] system.
 
== Usage ==
== Usage ==
<code><nowiki>{{CoordDec| ''decimal latitude'' | ''decimal longitude'' | display=inline,title}}</nowiki></code>


'''Usage'''
;Example
<code><nowiki>{{coordDec| ''decimal latitude'' | ''decimal longitude'' | display=inline,title}}</nowiki></code>
<code><nowiki>{{CoordDec| -41.289 | 174.777 | display=inline}}</nowiki></code> gives {{CoordDec| -41.289 | 174.777 | display=inline}}


'''Example'''
No alternate set of parameter are available for this template. See {{tl|CoordDMS}} for angles specified in degrees minutes and seconds, and {{tl|CoordDM}} for when just degrees and minutes are specified.
<code><nowiki>{{coordDec| -41.289 | 174.777 | display=inline}}</nowiki></code> gives {{coordDec| -41.289 | 174.777|display=inline}}
 
No alternate set of parameter are available for this template. See {{tl|coordDMS}} for angles specified in degrees minutes and seconds, and {{tl|coordDM}} for when just degrees and minutes are 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]].
Line 16: Line 19:
* Latitude (N/S) must appear before longitude (E/W).
* Latitude (N/S) must appear before longitude (E/W).


Optional parameters the are all named parameters in the form <code>name=value</code>
Optional parameters are all named parameters in the form <code>name=value</code>
*'''display'''
*'''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,
Line 23: Line 26:
*'''name'''
*'''name'''
*: {{Para|name|X}} to label the place on maps (default is [[mw:Help:Magic words#Page names|PAGENAME]])
*: {{Para|name|X}} to label the place on maps (default is [[mw:Help:Magic words#Page names|PAGENAME]])
*'''Notes'''
*'''notes'''
*: {{Para|notes}} text displayed immediately following the coordinates,
*: {{Para|notes}} text displayed immediately following the coordinates,
*'''format''' How the coordinates are displayed
*'''format''' How the coordinates are displayed
*:{{Para|format|dec}} decimal format
*: {{Para|format|dec}} decimal format
*:{{Para|format|dms}} degrees minutes and seconds format
*: {{Para|format|dms}} degrees minutes and seconds format


Optional geodata coordinates parameters, the old geohack format with colon and underscore is not supported
Optional geodata coordinates parameters, the old geohack format with colon and underscore is not supported
Line 41: Line 44:
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 [[Wikipedia:Persondata|Persondata]] or [[Help:Category#Default sort key|Defaultsort]] templates, or [[Wikipedia:Categorization|Categories]].
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 {{tl|Coord/doc}}.
* 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]]


 
=== Template Data ===
===Template Data===
<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 120: Line 122:


== See also ==
== See also ==
*{{t1|coord}} the base template has more details on some of the parameters
*{{tl|Coord}} the base template has more details on some of the parameters
*{{t1|coordDMS}}  an alternative version where degrees, minutes and seconds are specified
*{{tl|CoordDMS}}  an alternative version where degrees, minutes and seconds are specified
*{{t1|coordDM}}  an alternative version where just degrees and minutes are specified
*{{tl|CoordDM}}  an alternative version where just degrees and minutes are specified
 


<includeonly>
<includeonly>{{Sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Coordinates templates]]
[[Category:Coordinates templates]]
</includeonly>
}}</includeonly>

Latest revision as of 12:59, 3 September 2020

A version of the {{Coord}} template where the latitude and longitude are specified by signed decimal numbers. It has been designed to work well with the Visual Editor/TemplateData system.

Usage

{{CoordDec| ''decimal latitude'' | ''decimal longitude'' | display=inline,title}}

Example

{{CoordDec| -41.289 | 174.777 | display=inline}} gives Lua error: callParserFunction: function "#coordinates" was not found.{{#coordinates: -41.289 | 174.777 |dim=|globe=|scale=|region=|type= | |name= }}

No alternate set of parameter are available for this template. See {{CoordDMS}} for angles specified in degrees minutes and seconds, and {{CoordDM}} for when just degrees and minutes are 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: {{CoordDec | -41.289 | 174.777 | 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.

Template Data

Encodes the latitude and longitude coordinates of a location specified in degrees and minutes, provides a link to map of the location.

Template parameters

ParameterDescriptionTypeStatus
Latitude1

The latitude in decimal format with negative for south eg -79.38. Avoid excessive precision, 0.01° is approximately 1k m and 0.0001° is approximately 10 m

Numberrequired
Longitude2

The longitude in decimal format, negative for west eg -79.38. Avoid excessive precision, 0.01° is approximately 1k m and 0.0001° is approximately 10 m

Numberrequired
Displaydisplay

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

Stringoptional
Namename

a label to place on maps (default is PAGENAME)

Stringoptional
Notesnotes

text displayed immediately following the coordinates

Stringoptional
Formatformat

How the coordinates are displayed, either 'dec' or 'dms'

Stringoptional
Dimdim

approximate size of the object, used to scale the map to fit.

Stringoptional
Scalescale

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.

Stringoptional
Globeglobe

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

Stringoptional
Regionregion

[[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.

Stringoptional
Typetype

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.

Stringoptional

See also

  • {{Coord}} the base template has more details on some of the parameters
  • {{CoordDMS}} an alternative version where degrees, minutes and seconds are specified
  • {{CoordDM}} an alternative version where just degrees and minutes are specified