Template:Coord/doc: Difference between revisions
m
1 revision imported
Vivaporius (talk | contribs) (Created page with "{{Documentation subpage}} {{#ifeq: {{FULLPAGENAME}} | Template:Coord | {{high-risk|760,000+}} }} {{Transwiki guide candidate}} {{lua|Module:Coordinates}} {{#switch: {{FULLPAGE...") |
Vivaporius (talk | contribs) m (1 revision imported) |
||
(2 intermediate revisions by 2 users not shown) | |||
Line 1:
{{Documentation subpage}}
{{#ifeq: {{FULLPAGENAME}} | Template:Coord | {{high-
{{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==
{{
* 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|
* 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 [[
For
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
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.
* 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.
==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.
== 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
:* '''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
===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
=== 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 [[
===== type:''T'' =====
Line 205 ⟶ 199:
{{UF-coord-classes}}
==Incorrect uses and maintenance
The template has some input checks built in.
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>.
===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:
{{TemplateData header}}
<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": {
"suggested": true
},
"2": {
"label": "2",
"description": "Either: minutes latitude, signed decimal degrees longitude or 'N' or 'S'.",
"type": "string",
"required": false,
"suggested": true
},
"3": {
"description": "Either: second latitude, degrees longitude, 'N' or 'S' or GeoHack parameters",
"type": "string",
"required": false
},
"4": {
"description": "Either: degrees longitude, 'N', 'S', 'E' or 'W' or GeoHack parameters",
"type": "string",
"required": false
},
"5": {
"description": "Either: degrees longitude, minutes longitude or GeoHack parameters",
"type": "string",
"required": false
},
"6": {
"description": "Either: minutes longitude, 'E' or 'W' or GeoHack parameters",
"type": "string",
"required": false
},
"7": {
"description": "Either second longitude, or GeoHack parameters",
"type": "string",
"required": false
},
"8": {
"description": "'E' or 'W'.",
"type": "string",
"required": false
},
"9": {
"description": "GeoHack parameters. Example: dim:30_region:US-WI_type:event",
"type": "string",
"required": false
},
"qid": {
"description": "Retrieve coordinates from a WikiData entry instead of from this template's parameters",
"type": "line",
"required": false,
"example": "Q513"
},
"display": {
"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",
"type": "line",
"default": "inline",
"suggested": true,
"required": false,
"suggestedvalues": [
"inline",
"title",
"inline,title"
]
},
"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": "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:
-->
== See also ==
* [[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| ]]
|