Omniversalis

Template:Coord/doc: Difference between revisions

Template Discussion

Template:Coord/doc (edit)

Revision as of 22:53, 9 March 2022

355 bytes removed ,  2 years ago
no edit summary
m (1 revision imported)
en>Erik
No edit summary
Line 1:
{{Documentation subpage}}
{{#ifeq: {{FULLPAGENAME}} | Template:Coord | {{high-riskuse|760,000+all-pages=yes}} }}
{{Transwiki guide candidate}}
{{lua|Module:Coordinates}}
{{#switch: {{FULLPAGENAME}} | Template:Coord | Template:Coord/doc = {{Uses Wikidata|P625}} {{Tracks Wikidata|P625|cat=Coordinates Wikidata tracking categories}} }}
Only for '''display=title''' the use of this template is restricted: {{Navbox visibility}} {{Template display|nomobile}}
 
==Quick guide==
Line 10 ⟶ 11:
__TOC__
==Purpose==
{{Tldtlf|Coord}} provides a standard notation for encoding locations by their [[latitude]] and [[longitude]] coordinates. It is primarily for specifying the [[World Geodetic System|WGS84]] geographic coordinates of locations on [[Earth]], at the same time emitting a machine-readable [[Geo (microformat)|Geo microformat]]. However, it can also encode locations on natural satellites, dwarf planets, and planets other than Earth.
 
* To specify celestial coordinates, use {{tl|Sky}} instead.
* Tag articles which lack coordinates (but need them) with {{tl|Coord missing}}.
* If the subject's location is truly unknown or disputed, note this with {{tl|coordCoord unknown}}.
* If the coordinates were [[meta:Wikidata/Notes/Inclusion syntax|transcluded from Wikidata]], use {{tl|WikidataCoord}}.
 
See also: [[Wikipedia:WikiProject Geographical coordinates]].
 
==Features==
Latitude and longitude may be specified (with appropriate precision) either in decimal notation or as degrees/minutes/seconds. By default, coordinates appear in the format used to specify them. However, the <code>format=</code> parameter can be used to force display in a particular format. The template also accepts and displays coordinates formatted as degrees and decimal minutes as found on charts and maritime references.
 
The template displays the formatted coordinates with a [[hyperlink]] to [[tswikimw:GeoHack|GeoHack]]. GeoHack displays information customized to the location, including links to external mapping services.
 
For [[Earth|terrestrial]] locations, a blue globe ([[Image:Erioll_world.svg|18px]]) appears to the left of the hyperlink. Clicking on the globe activates the [[:meta:WikiMiniAtlas|WikiMiniAtlas]] (requires [[JavaScript]]).
 
By default, coordinates appear "in line" with the adjacent text. However, the <code>display=</code> parameter can be used to move the coordinates up near the page title—ortitle (in desktop view only; title coordinates do not display in mobile view)—or display them in both places at once.
 
The template outputs coordinates in three formats:
Line 33 ⟶ 34:
* A machine readable [[Geo (microformat)|Geo microformat]].
 
Additional features
Logged-in users can [[#Per-user_display_customization|customize]] how coordinates appear in their browsers.
* Logged-in users can [[#Per-user_display_customization|customize]] how coordinates appear in their browsers.
<!-- Not currently functional without errors:
* You can get coordinates from Wikidata by transcluding this template without any numbered arguments. -->
* You can extract information from the Coord template for use in mathematical expressions. For details, see [[:Module:Coordinates]].
 
* All coordinates used in a page through this template are registered in the [[mw:API:Geosearch|geosearch API]]. If a coordinate is using title display, then these coordinates will be marked as the primary coordinates with regards to the page and therefore the topic of that page.
You can extract information from the Coord template for use in mathematical expressions. For details, see [[:Module:Coordinates]].
 
==Caveats==
The template '''must not''' be modified without prior discussion. External tools can depend on the format of both the wikitext and/or the generated html.
 
Tools which read Wikipedia database dumps (such as [[Google Earth]]) often ignore inline coordinates. To ensure that coordinates are seen by these tools, one set should be displayed beside the title. See [http://support.google.com/earth/bin/answer.py?hl=en&answer=2395280 How do I get my Wikipedia article to show up in the Google Earth Geographic Web layer?]{{deadlink}}. However, if multiple title coordinates appear on a single page, they will overlap, making them illegible.
 
==Superseded templates==
This single template supersedes {{tl|coor d}}, (and others in that family which have since been redirected to it), plus the [{{fullurl:Special:PrefixIndex|from=Geolinks&namespace=10}} Geolinks] and [{{fullurl:Special:PrefixIndex|from=Mapit&namespace=10}} Mapit] templates. Most parameters can be used as before – see [[#Usage|Usage]].
 
Examples:
<table class="wikitable">
<tr><td>&#123;{coord|10.2|N|-20.3|E|'''type:'''city}&#125;</td><td>Replaces &#123;{coor d|10.2|N|-20.3|E|city}&#125;</td></tr>
 
<tr><td>&#123;{coord|44.4|-111.1|'''type:city_region:US'''|display=inline,title}&#125;</td><td>Replaces &#123;{Geolinks-'''US-cityscale'''|44.4|-111.1}&#125;</td></tr>
 
<tr><td>&#123;{coord|51.01234|-1.56789|'''type:landmark_region:GB'''|display=inline,title}&#125;</td><td>Replaces &#123;{Geolinks-'''UK-buildingscale'''|51.01234|-1.56789}&#125;</td></tr>
 
<tr><td>&#123;{coord|-35.5|150.1|'''type:landmark_region:AU'''|display=inline,title}&#125;</td><td>Replaces &#123;{Mapit-'''AUS-suburbscale'''|lat=-35.5|long=150.1}&#125;</td></tr>
 
<tr><td>&#123;{coord|12|34|12|N|45|33|45|W|'''display=title'''}&#125;</td><td>Replaces &#123;{'''CoorHeader'''|12|34|12|N|45|33|45|W}&#125;</td></tr>
 
</table>
 
== Usage ==
Line 76 ⟶ 58:
:* '''display=''' can be one of the following:
::* <code>display=inline</code> – Display the coordinate inline (default)
::* <code>display=title</code> – Display the coordinate at the top of the article, beside the article's title (replaces {{tl|coor title dms}} family; coordinates are displayed in desktop view only; title coordinates do not display in mobile view)
::** shortcut: <code>display=t</code>
::* <code>display=inline,title</code> – Display the coordinate both inline and beside the article's title (replaces {{tl|coor at dms}} family)
::** shortcut: <code>display=it</code>
::* <code>display=title,inline</code> has the same effect as <code>display=inline,title</code>
::Note: the <code>title</code> attribute indicates that the coordinates apply to the entire article, and not just one of (perhaps many) places mentioned in it &mdash; soit—so it should only be omitted in the latter case. Additionally the title option will mark the coordinates as the primary coordinates for the page (and topic of the page) in the [[mw:API:Geosearch|geosearch API]].
:* '''format=''' can be used to force ''dec'' or ''dms'' coordinate display.
::* <code>format=dec</code> reformats the coordinates to <span style="text-decoration:underline;">decimal degrees</span> format.
Line 88 ⟶ 70:
::Note: a ''name='' parameter causes {{tl|Coord}} to emit an [[hCard]] [[microformat]] using that name, ''even if used within an existing hCard''. Do not use when the name is that of a person (e.g for a gravesite), as the generated hCard would be invalid. Also, do not use square brackets in names.
:* '''notes=''' specifies text to be displayed immediately following the coordinates. This is primarily intended for adding footnotes to coordinates displayed beside the title.
:* '''qid=''' specify Q item to display the coordinates of. Used primarily by Wikidata powered infoboxes.
 
==Helper functions==
Helper functions are available to manipulate thothe output from {{ttl|Coord}} when it appears in a container template such as an infobox.
 
===To extract the latitude from a Coord template===
===To extract the latitude from a Coord template===
Use:
 
Line 99 ⟶ 84:
<code><nowiki>{{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}</nowiki></code> → {{#invoke:coordinates|coord2text|{{Coord|57|18|22|N|4|27|32|E}}|long}}
 
:'''Note: this method removes the microformat markup, and should not be used inside temaaltestemplates which emit parent microformats, such as infoboxes or table-row templates.'''
 
=== Displaying all coordinate links on one map ===
Line 105 ⟶ 90:
 
== Examples ==
{{for|the guideline on coordinate precision|WP:OPCOORD}}
{| class="wikitable"
| <code><nowiki>{{coord|43.651234|-79.383333}}</nowiki></code>
Line 169 ⟶ 155:
| {{coord|52|28|N|1|55|W|region:GB_type:city|notes=<ref>{{cite web|url=http://www.fallingrain.com/world/UK/0/Birmingham.html|title=Birmingham}}</ref>|display=inline,title}}
| Birmingham – with display, notes, and parameter settings; note that these coordinates are also displayed at the top of this page.
|-
| <code><nowiki>{{coord|51|25.813|N|0|43.945|E}}</nowiki></code>
| {{coord|51|25.813|N|0|43.945|E}}
| Navigation buoy in the River Medway, England.
|-
| <code><nowiki>{{coord|51|36.287|N|8|32.018|W}}</nowiki></code>
| {{coord|51|36.287|N|8|32.018|W}}
| Lighthouse at the [[Old Head of Kinsale]] as defined by the [[Commissioners of Irish Lights]].
|}
 
Line 175 ⟶ 169:
 
== Coordinate parameters ==
The first unnamed parameter following the longitude is an optional string of coordinate parameters, separated by underscores. These parameters help [[tswikimw:GeoHack|GeoHack]] select suitable map resources, and they will become more important when [[meta:Wikimaps|Wikimaps]] becomes fully functional.
 
===== type:''T'' =====
Line 205 ⟶ 199:
{{UF-coord-classes}}
 
==Incorrect uses and maintenance categorycategories==
The template has some input checks built in. Most errors display a <span style="color:red;"><b>'''bold, red</b>'''</span> message inline and categorize the article in the [[Wikipedia:Hidden category|hidden]] [[Wikipedia:Categorization#Non-article and maintenance categories|maintenance category]] '''[[:Category:Pages with malformed coordinate tags|Pages with malformed coordinate tags]]'''. There {{#IFEQ:{{PAGESINCATEGORY:Pages with malformed coordinate tags}}|1|is currently '''1''' page|are currently '''{{PAGESINCATEGORY:Pages with malformed coordinate tags}}''' pages}} in that category. See the category description for further instructions.
 
A more thorough daily report of coordinates needing repair is at [[tools:~dispenser/view/File viewer#log:coord-enwiki.log]].
Line 213 ⟶ 207:
 
==Internals==
This template is completely powered by the [[Wikipedia:Lua|Lua]] <code>[[:Module:Coordinates]]</code>.
See [[Template:Coord/doc/internals]] and [[:Category:Coord template]].
 
===Subtemplates===
{{Coord/sub doc}}
 
===Coordinates in PDF===
For generating PDF, 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}}
*[[Template:Coord/display/inline,title/Print]] for {{tl|Coord/display/inline,title}}
 
Samples are available at:
*[[Help:Books/Feedback/Tests/coord 1]]
*[[Help:Books/Feedback/Tests/coord 2]]
 
===Class names===
The class names '''geo''', '''latitude''' and '''longitude''' are used to generate the microformat and '''MUST NOT''' be changed.
 
===History===
This template used to use a lot of [[Template:Coord/doc/internals|sub templates]] but these have all been replaced by {{tlm|Coordinates}}.
 
===Template Data===
This template uses overloading{{clarify|reason=What does this mean? Where is it defined?}} which does not work well with the [[Wikipedia:VisualEditor/TemplateData|VisualEditor/TemplateData]]. Consider using "Edit source" instead of the visual editor until this defect is corrected. To facilitate visual editing in the mean timemeantime, consider using {{tl|coordDec}} for signed decimal degrees, {{tl|coordDMS}} when degrees minutes and seconds are specified, and {{tl|coordDM}} when just degrees and minutes are given.
 
{{TemplateData header}}
{{TemplateDataHeader}}
<templatedata>{
"description": "Encodes the latitude and longitude coordinates of a location, provides a link to map of the location. This template does not work well with the Visual Editor, consider using {{coordDec}} for signed decimal degrees, {{coordDMS}} when degrees minutes and seconds are specified {{coordDM}} when only degrees and minutes are specified. To use this template you will need to use positional parameter following one of these schemes: {{coord | D | M | S | NS | D | M | S | EW | geo | opts}}, {{coord | D | M | NS | D | M | EW | geo | opts}}, {{coord | D| NS | D| EW | geo | opts}} {{coord | sD | sD | geo | opts}} where D is degrees, M is minutes, S seconds, sD signed decimal degrees, NS is N or S, EW is E or W, opts are named parameter and geo are the coordinate parameters described on the main doc page.",
"params": {
"1": {
"label": "1",
"description": "Either degrees latitude or a signed decimal degrees latitude",
"type": "number",
"required": truefalse,
"suggested": true
},
},
"2": {
"2": {
"label": "2",
"label": "2",
"description": "Either: minutes latitude, signed decimal degrees longitude or 'N' or 'S'.",
"description": "Either: minutes latitude, signed decimal degrees longitude or 'N' or 'S'.",
"type": "string",
"type": "string",
"required": true
"required": false,
},
"suggested": true
"3": {
},
"label": "3",
"3": {
"description": "Either: second latitude, degrees longitude, 'N' or 'S' or GeoHack parameters",
"typelabel": "string3",
"description": "Either: second latitude, degrees longitude, 'N' or 'S' or GeoHack parameters",
"required": false
"type": "string",
},
"required": false
"4": {
},
"label": "4",
"4": {
"description": "Either: degrees longitude, 'N', 'S', 'E' or 'W' or GeoHack parameters",
"typelabel": "string4",
"description": "Either: degrees longitude, 'N', 'S', 'E' or 'W' or GeoHack parameters",
"required": false
"type": "string",
},
"required": false
"5": {
},
"label": "5",
"5": {
"description": "Either: degrees longitude, minutes longitude or GeoHack parameters",
"typelabel": "string5",
"description": "Either: degrees longitude, minutes longitude or GeoHack parameters",
"required": false
"type": "string",
},
"required": false
"6": {
},
"label": "6",
"6": {
"description": "Either: minutes longitude, 'E' or 'W' or GeoHack parameters",
"typelabel": "string6",
"description": "Either: minutes longitude, 'E' or 'W' or GeoHack parameters",
"required": false
"type": "string",
},
"required": false
"7": {
},
"label": "7",
"7": {
"description": "Either second longitude, or GeoHack parameters",
"typelabel": "string7",
"description": "Either second longitude, or GeoHack parameters",
"required": false
"type": "string",
},
"required": false
"8": {
},
"label": "8",
"8": {
"description": "'E' or 'W'.",
"typelabel": "string8",
"description": "'E' or 'W'.",
"required": false
"type": "string",
},
"required": false
"9": {
},
"label": "9",
"9": {
"description": "GeoHack parameters. Example: dim:30_region:US-WI_type:event",
"typelabel": "string9",
"description": "GeoHack parameters. Example: dim:30_region:US-WI_type:event",
"required": false
"type": "string",
},
"required": false
"display": {
},
"label": "Display",
"qid": {
"description": "Where it is displayed. Can be one of: 'inline' in the body of the article, 'title' at the top of the article or 'inline,title' both",
"typelabel": "stringWikidata item",
"description": "Retrieve coordinates from a WikiData entry instead of from this template's parameters",
"default": "inline",
"type": "line",
"required": false
"required": false,
},
"example": "Q513"
"name": {
},
"label": "Name",
"display": {
"description": "a label to place on maps (default is PAGENAME)",
"typelabel": "stringDisplay",
"description": "Where it is displayed. Can be one of: 'inline' in the body of the article, 'title' at the top of the article or 'inline,title' both",
"required": false
"type": "line",
},
"default": "inline",
"notes": {
"suggested": true,
"label": "Notes",
"required": false,
"description": "text displayed immediately following the coordinates",
"suggestedvalues": [
"type": "string",
"inline",
"required": false
"title",
},
"inline,title"
"format": {
]
"label": "Format",
},
"description": "How the coordinates are displayed, either 'dec' or 'dms'",
"name": {
"type": "string",
"label": "Name",
"required": false
"description": "a label to place on maps (default is PAGENAME)",
}
"type": "string",
}}</templatedata>
"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": "line",
"required": false,
"suggestedvalues": [
"dec",
"dms"
]
},
"nosave": {
"label": "Geosearch",
"description": "Set to 'true' if you want to avoid this coordinate to be registered in the geosearch API.",
"type": "string",
"required": false
}
}
}</templatedata>
<!--
"1": {
Line 375 ⟶ 385:
 
-->
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
== See also ==
<!-- Categories below this line, please; interwikis at Wikidata -->
* [[Special:PrefixIndex/Template:GeoTemplate]], for the geohack page templates used on Earth and other bodies
 
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Coord template]]
[[Category:Coordinates conversion templates| ]]
Anonymous user
Retrieved from "https://en.omniversalis.org/wiki/Special:MobileDiff/16891"