Template:Coord/doc: Difference between revisions
meta>Cenarium |
meta>Docu desc |
||
Line 201: | Line 201: | ||
| creates output to display coordinates inline and above the article | | creates output to display coordinates inline and above the article | ||
|} | |} | ||
== Coordinates in PDF == | |||
For the generation of the PDF version, printed books and Open Office export format, two templates are [[Help:Books/for_experts#Improving_the_book_layout|substituted for the regular templates]]: | |||
*[[Template:Coord/display/title/Print]] for {{tl|Coord/display/title}} | |||
*[[Template:Coord/link/Print]] for {{tl|Coord/link}} | |||
Samples are available at: | |||
*[[Help:Books/Feedback/Tests/coord 1]] | |||
*[[Help:Books/Feedback/Tests/coord 2]] | |||
==Class names== | ==Class names== |
Revision as of 11:18, 6 March 2009
Quick guide
To add Lua error: callParserFunction: function "#coordinates" was not found. to the top of an article, use {{Coord}}, thus:
{{Coord|57|18|22|N|4|27|32|W|display=title}}
These coordinates are in degrees, minutes, and seconds of arc.
"title" means that the coordinates will be displayed next to the article's title at the top of the page and before any other text or images.
To add Lua error: callParserFunction: function "#coordinates" was not found. to the top of an article, use either
{{Coord|44.1124|N|87.9130|W|display=title}}
(which does not require minutes or seconds but does require the user to specify north/ south and east/west) or
{{Coord|44.1124|-87.9130|display=title}}
(in which the north and east are presumed by positive values while the south and west are negative ones) These coordinates are in decimal degrees.
- Degrees, minutes and seconds, when used, must each 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).
- Maintain consistency of decimal places or minutes/seconds between latitude and longitude.
- Latitude (N/S) must appear before longitude (E/W).
Optional coordinate parameters follow the longitude and are separated by an underscore ("_"):
- dim:
dim:
N (viewing diameter in metres) - region:
region:
R (ISO 3166-1 alpha-2 or ISO 3166-2 code) - type:
type:
T (landmark
orcity(30,000)
, for example)
Other optional parameters are separated by a pipe ("|"):
- 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)
Thus: {{Coord|44.1172|-87.9135|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 all Categories, including the {{DEFAULTSORT}} template.
- For full details, refer to {{Coord/doc}}.
- Additional guidance is available: obtaining coordinates, converting coordinates
Purpose
This template, {{coord}}, produces a link to a list of map sources, based on the geographical coordinates and other parameters, and provides a standardized notation for the coordinates.
The template is for WGS84 geographical coordinates (latitude;longitude) on Earth, which can be entered in either decimal notation, or degrees/minutes/seconds parameters, with the appropriate precision.
It links to Template:Coor URL, then displays the coordinates. Clicking the blue globe activates the WikiMiniAtlas (needs Javascript).
The template outputs data in:
- Degree/minutes/seconds ("DMS", precision is degrees, or degrees/minutes, or degrees/minutes/seconds, based on input). Some conversions from decimal degrees to dms need fixing (see talk)
- Decimal (precision by number of decimal places, based on input)
- Geo microformat.
{{coord}} is used by tools which parse the raw Wikipedia database dumps, such as Google Earth. To ensure that the coordinates are parsed correctly display=title must be used. See How do I get my Wikipedia article to show up in the Google Earth Geographic Web layer?. The template must not be modified without prior discussion.
For articles which have no coordinates, but need them, use {{coord missing}}.
See also Wikipedia:WikiProject Geographical coordinates.
Superseded templates
This single template supersedes {{coor d}}, {{coor dm}}, {{coor dms}}, {{coor at d}}, {{coor at dm}}, {{coor at dms}}, {{coor title d}}, {{coor title dm}}, {{coor title dms}}, and the Geolinks and Mapit templates. All parameters can be used as before - see Usage.
Examples:
{{coord|12|N|45|W|display=title}} | Replaces {{coor title d|12|N|45|W}} |
{{coord|12|34|N|45|33|W|display=title}} | Replaces {{coor title dm|12|34|N|45|33|W}} |
{{coord|12|34|56|N|45|33|22|W|display=title}} | Replaces {{coor title dms|12|34|56|N|45|33|8|W}} |
{{coord|12|34|12|N|45|33|45|W|display=inline,title}} | Replaces {{coor at dms|12|34|12|N|45|33|45|W}} |
{{coord|10.2|-20.3|display=inline}} or {{coord|10.2|-20.3}} | Replaces {{coor d|10.2|N|-20.3|E}} |
{{coord|44.4|-111.1|type:city_region:US|display=inline,title}} | Replaces {{Geolinks-US-cityscale|44.4|-111.1}} |
{{coord|51.01234|-1.56789|type:landmark_region:GB|display=inline,title}} | Replaces {{Geolinks-UK-buildingscale|51.01234|-1.56789}} |
{{coord|-35.5|150.1|type:landmark_region:AU|display=inline,title}} | Replaces {{Mapit-AUS-suburbscale|lat=-35.5|long=150.1}} |
{{coord|12|34|12|N|45|33|45|W|display=title}} | Replaces {{CoorHeader|12|34|12|N|45|33|45|W}} |
Usage
{{coord|latitude|longitude|coordinate parameters|template parameters}} {{coord|dd|N/S|dd|E/W|coordinate parameters|template parameters}} {{coord|dd|mm|N/S|dd|mm|E/W|coordinate parameters|template parameters}} {{coord|dd|mm|ss|N/S|dd|mm|ss|E/W|coordinate parameters|template parameters}}
There are two kinds of parameters, all optional:
- Coordinate parameters: Recognised by the map server, given in the format parameter:value and separated from each other with the underscore character '_'. Common coordinate parameters include type, region, and scale. See coordinate parameters for a comprehensive list.
- Template parameters: Used by the template itself, given in the format parameter=value and separated from each other with the pipe character '|'. The supported template parameters are display, name and format.
- display can be one of the following:
display=inline
- Display the coordinate inline (default)display=title
- Display the coordinate by the article title (replaces {{coor title dms}} family), shortcut:display=t
display=inline,title
- Display the coordinate both inline and at title (replaces {{coor at dms}} family)
Note: using thetitle
attribute indicates that the coordinates apply to the article, and not just one of (perhaps many) places mentioned in it — so it should only be omitted in the latter case.display=title,inline
works also. Shortcut:display=it
- format can be used to force dec or dms coordinate display for all readers
- name can be used to annotate inline coordinates for display in map services and other external use. It should not be used with coordinates in the article title or within an infobox, as in those cases the name is implicit from the article title.
- display can be one of the following:
Examples
{{coord|43.651234|-79.383333}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - Fully decimal - N & W |
{{coord|43.65|-79.38}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - less precise |
{{coord|43.6500|-79.3800}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - medium precision with trailing zeroes |
{{coord|43.651234|N|79.383333|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - decimal with Northing & Westing |
{{coord|43|29|N|79|23|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - degrees & minutes |
{{coord|43|29|4|N|79|23|0|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - degrees, minutes & seconds |
{{coord|43|29|4.5|N|79|23|0.5|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Toronto - degrees, minutes, seconds & fractions of seconds |
{{coord|55.752222|N|37.615556|E}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Moscow - N & E |
{{coord|55.752222|N|37.615556|E|format=dms}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Convert to dms format |
{{coord|39.098095|-94.587307|format=dms}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Decimal conversion without N/S/E/W |
{{coord|55.752222|N|37.615556|E|format=dec|name=Moscow}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Convert to decimal and label on some maps |
{{coord|33|55|S|18|25|E}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Cape Town - S & E |
{{coord|35|00|N|105|00|E}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | China, People's Republic of |
{{coord|22|54|30|S|43|14|37|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Rio - S & W |
{{coord|22|S|43|W}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | A degree confluence |
{{coord|52|28|59|N|1|53|37|W|display=inline,title|region:GB_type:city}}
|
Lua error: callParserFunction: function "#coordinates" was not found. | Birmingham - with display and parameter settings; note display also in title of this page. |
Coordinate parameters
Following the geographical coordinate, further parameters can optionally be supplied, separated by underscores. This will help in finding suitable map resources, and will become more important when the Wikimaps become fully functional.
type:T
scale:N
region:R
globe:G
source:S
Display
To always display coordinates as DMS values, add this to your common.css: <syntaxhighlight lang="css" style="display:table; padding:0.5em; margin-left:1em; border-radius:2px"> .geo-default { display: inline } .geo-nondefault { display: inline } .geo-dec { display: none } .geo-dms { display: inline } </syntaxhighlight>
To always display coordinates as decimal values, add this to your common.css: <syntaxhighlight lang="css" style="display:table; padding:0.5em; margin-left:1em; border-radius:2px"> .geo-default { display: inline } .geo-nondefault { display: inline } .geo-dec { display: inline } .geo-dms { display: none } </syntaxhighlight>
To display coordinates in both formats, add this to your common.css: <syntaxhighlight lang="css" style="display:table; padding:0.5em; margin-left:1em; border-radius:2px"> .geo-default { display: inline } .geo-nondefault { display: inline } .geo-dec { display: inline } .geo-dms { display: inline } .geo-multi-punct { display: inline } </syntaxhighlight>
If CSS is disabled, or you have an old copy of MediaWiki:Common.css cached, you will see both formats. (You can either clear your cache or manually refresh this URL: [1].)
To disable display of the blue globe adjacent to coordinates, add this to your common.js: <syntaxhighlight lang="javascript" style="display:table; padding:0.5em; margin-left:1em; border-radius:2px"> var wma_settings = {enabled:false} </syntaxhighlight> Note that this will disable WikiMiniAtlas.
See also Wikipedia:Manual of Style (dates and numbers)#Geographical coordinates.
Name
Incorrect uses and maintenance category
The template has a few input checks built in. Basic errors display the message on Coord/input/ERROR (see Special:WhatLinksHere/Template:Coord/input/ERROR for pages to fix)
A series of other input errors categorize the pages in the maintenance category Coord template needing repair. See the category description for more details. There are currently 0 pages in that category.
Subtemplates
See Template:Coord/doc/internals and Category:Coord template
name | function |
---|---|
Coord/input/d | converts coordinates from input in degrees format {{coord|12|N|12|W}} |
Coord/input/dm | converts coordinates from input in degrees/minutes format {{coord|12|12|N|12|12|W}} |
Coord/input/dms | converts coordinates from input in degrees/minutes/seconds format {{coord|12|12|12|N|12|12|12|W}} |
Coord/display/inline | creates output to display coordinates inline |
Coord/display/title | creates output to display above the article (generally to the right of the article's title) |
Coord/display/inline,title | creates output to display coordinates inline and above the article |
Coordinates in PDF
For the generation of the PDF version, printed books and Open Office export format, two templates are substituted for the regular templates:
- Template:Coord/display/title/Print for {{Coord/display/title}}
- Template:Coord/link/Print for {{Coord/link}}
Samples are available at:
Class names
The class names geo, latitude and longitude are used to generate the microformat and MUST NOT be changed.