View source for Template:GeoGroup/doc

{{Documentation subpage}}
{{High-use}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

{{tl|GeoGroup}} generates an infobox type list of external links to services that present or display all [[Geographic coordinate system|coordinates]] listed on certain Wikipedia articles that have multiples of coordinates. The template is also capable of generating all the title coordinates from many articles listed in a single Wikipedia category. The template is intended to be inserted in the ''External links'' section of articles, or inside a section with a list or table of features, if appropriate (e.g. see [[Tame Valley Canal]]).
{{TOC right}}

The linked services allow the following results:
* A link to an [[OpenStreetMap]] map with the waypoints plotted onto the map.
* Export all coordinates from the Wikipedia page or category in a [[Keyhole Markup Language|KML]] file suitable for use in [[Google Earth]], [[NASA World Wind]] and similar applications.
* Export all coordinates in a GPX file.
* <s>Export Microformatted coordinates from the Wikipedia page in a [[GeoRSS]] file.</s> (No longer working)
* <s>Export place data in an RDF file.</s> (No longer working)

{{TOC right}}

==Usage==
Inline coordinates can be associated with a name using {{Tl|Coord}} with the {{para|name}} parameter, such as:
:<code>&#123;{[[Template:Coord|coord]]|1|2|type:landmark|name=Interesting uncharted point in the sea}}</code>

However, do not use the {{para|name}} parameter when the coordinates are within a parent template or table which emits a [[Wikipedia:microformats|microformat]], such as an infobox.

This template is not intended for articles with single sets of coordinates; such coordinates already link indirectly to {{Tl|GeoTemplate}}.

To use this template, add {{tl|GeoGroup}} to the ''External links'' section of an article, or, for list articles with no title coordinate, at the top of the article.

===Optional parameters===
'''article=''' The name of an article or a category, from which coordinates will be displayed:
:{{tlx|GeoGroup|2=article=''article name''}}
:{{tlx|GeoGroup|2=article=''Category:category name''}}
For a category example, see [[List of stations in London fare zone 2#List of stations]])

'''articlee=''' Encoded name of the article. The encoding process here involves changing spaces to underscores (&nbsp;'''_'''&nbsp;), everything else is taken care of by the [[Wikipedia:Magic words#Paths|<code>urlencode</code> magic word]].
:{{tlx|GeoGroup|2=article=''article name''|3=articlee=''article_name''}}

'''section=''' The section parameter arranges most of the links to use only coordinates in the named section of the article.  This is useful to limit the number seen at one time in articles with many coordinates.  For examples, see [[List of rapids of the Columbia River]].in
:{{tlx|GeoGroup|2=section=''section name''}}

A section-specific GeoGroup makes most sense placed within the section to which it refers.  

No matter if the template is set to display coordinates of a faraway section, the GeoGroup box's wording will still assert it will display coordinates of "this section".  Every section-specific GeoGroup box is worded "Map this section's coordinates...", and currently (March 2015) there is no way to change the wording presented.

'''mapframe=''' Set to {{kbd|yes}} to show the coordinates in a [[Template:mapframe|mapframe]] map at the top of the box. (Not available if a category is used.)

'''maplink=''' Set to {{kbd|yes}} to show the coordinates in a [[Template:maplink|maplink]] map, linked from the "Map all coordinates..." or "Map this section's coordinates..." text. (Not available if a category is used.)

===Option for categories===
There is one optional parameter for display of coordinates in categories:
:{{tlx|GeoGroup|2=level=''0,1,2,3,...''}}
'''level=''' Category recursion level, where 0 means unlimited

==Cache delay and updating maps==
Currently (as of 18 March 2015) maps displayed using Open Street Map are regenerated with each visit, and no [[Web cache|caching]] is used.  So if an editor adds or changes coordinates in an article, then clicks on the GeoGroup template to "Map all coordinates using OSM", the OSM map displayed will immediately show the changed data.

==Linking==
Wiki-links may be made directly to a page's instance of the template, with the ID <code>GeoGroup</code>., by using <code><nowiki>[[#GeoGroup|Example Link Text]]</nowiki></code>, which produces: [[#GeoGroup|Example Link Text]].

To jump to GeoGroup box location in the current article use:
::<code><nowiki>[[#GeoGroup|Jump to map box]]</nowiki></code>, which produces: [[#GeoGroup|Jump to map box]].

To jump to GeoGroup box location in a different article use:
::<code><nowiki>[[Article name#GeoGroup|Example Link Text]]</nowiki></code>

For example, <code><nowiki>[[Listed buildings in Runcorn (urban area)#GeoGroup|Mapping of Runcorn listed buildings]]</nowiki></code> produces: [[Listed buildings in Runcorn (urban area)#GeoGroup|Mapping of Runcorn listed buildings]]

If there are multiple usages of GeoGroup template in an article, as in [[List of rapids of the Columbia River]], the target is not well-defined.  For example, <code><nowiki>[[List of rapids of the Columbia River#GeoGroup|Jump to a map box of Columbia River rapids]]</nowiki></code> which produces [[List of rapids of the Columbia River#GeoGroup|Jump to a map box of Columbia River rapids]], could perhaps jump to any one of the GeoGroup templates in that article.

==Expansion==
Other KML aware services may be added, as they become available; as might services converting the coordinates to [[GPX]] ({{done}}) or [[Point of interest#File formats|other formats]].

==Examples==

===Netherton Tunnel Branch Canal===
Data from [[Netherton Tunnel Branch Canal]] article:
{{stack|1=<code><nowiki>{{GeoGroup|section=Examples}}</nowiki></code>
{{GeoGroup{{\sandbox}}|section=Examples}}
}}
{{stack|1=<code><nowiki>{{GeoGroup|mapframe=yes|section=Examples}}</nowiki></code>
{{GeoGroup{{\sandbox}}|mapframe=yes|section=Examples<includeonly>|article=Template:GeoGroup/doc</includeonly>}}
}}
{{stack|1=<code><nowiki>{{GeoGroup|maplink=yes|section=Examples}}</nowiki></code>
{{GeoGroup{{\sandbox}}|maplink=yes|section=Examples<includeonly>|article=Template:GeoGroup/doc</includeonly>}}
}}
<!--  Example taken from [[Netherton Tunnel Branch Canal]] -->
{{-}}
{| class="wikitable"
! Point
! [[Geographic coordinate system|Coordinates]]<br />(links to map & photo sources)
|-
| Dudley Port Junction
| {{coord|52.52204|-2.04331|region:GB_type:landmark|name=Dudley Port Junction}}
|-
| Groveland Bridge (Tipton Road, A457)
| {{coord|52.51758|-2.04760|region:GB_type:landmark|name=Groveland Bridge (Tipton Road, A457)}}
|-
| Tividale Aqueduct (Old BCN Main Line)
| {{coord|52.51640|-2.04843|region:GB_type:landmark|name=Tividale Aqueduct (Old BCN Main Line)}}
|-
| Northern tunnel portal
| {{coord|52.51534|-2.04948|region:GB_type:landmark|name=Northern tunnel portal}}
|-
| Aston Road air vent
| {{coord|52.50850|-2.05518|region:GB_type:landmark|name=Aston Road air vent}}
|-
| Regent Road air vent
| {{coord|52.50697|-2.05708|region:GB_type:landmark|name=Regent Road air vent}} <!-- Approx. canal mid-point -->
|-
| Approx. tunnel midpoint
| {{coord|52.50435|-2.05932|region:GB_type:landmark|name=Approx. tunnel midpoint}}
|-
| Southern tunnel portal
| {{coord|52.49335|-2.06916|region:GB_type:landmark|name=Southern tunnel portal}}
|-
| Windmill End Junction
| {{coord|52.49157|-2.07019|region:GB_type:landmark|name=Windmill End Junction}}
|}

{{clear}}

===Other examples===
{{GeoGroup|section=Examples}}
Display the coordinates from a different section than this one (in current article):
<code><nowiki>{{GeoGroup|section=Netherton Tunnel Branch Canal}}</nowiki></code>
*Result: Works as intended, but GeoGroup box displays "this section".
{{clear}}

{{GeoGroup|section=Linking}}
Display the coordinates from a different section than this one (in current article), when that section has no coordinates:
<code><nowiki>{{GeoGroup|section=Linking}}</nowiki></code>
*Result: Works: "sorry, no data to show", but GeoGroup box displays "this section".
{{clear}}

{{GeoGroup|article=List of United States cities by population}}
Display all the coordinates in a different article:
<code><nowiki>{{GeoGroup|article=List of United States cities by population}}</nowiki></code>
*Result: Works
{{clear}}

{{GeoGroup|article=List of United States cities by population|section=Puerto Rico}}
Display just the coordinates in one section of a different article:
<code><nowiki>{{GeoGroup|article=List of United States cities by population|section=Puerto Rico}}</nowiki></code>
*Result: Works, but GeoGroup box displays "this section".
{{clear}}

{{GeoGroup|article=List of United States cities by population#Puerto Rico}}
Try to display all coordinates in just one section of a different article, by giving a link to that section in the article:
<code><nowiki>{{GeoGroup|article=List of United States cities by population#Puerto Rico}}</nowiki></code>
*Result: Fails, as all coordinates in the article are displayed, not just the ones from the [[List of United States cities by population#Puerto Rico|intended section]]. (So use "|section=" option.)
{{clear}}

{{GeoGroup|article=Category:Rail transport stations in London fare zone 2}}
Display all coordinates in a category:
<code><nowiki>{{GeoGroup|article=Category:Rail transport stations in London fare zone 2}}</nowiki></code>
*Result: Works
{{clear}}

{{GeoGroup|article=Category:Listed churches by grade in the United Kingdom|level=0}}
Try to display all coordinates in a large parent category and all of its subcategories (using infinite recursion):
<code><nowiki>{{GeoGroup|article=Category:Listed churches by grade in the United Kingdom|level=0}}</nowiki></code>
*Result: Works
{{clear}}

{{GeoGroup|article=Category:Listed churches by grade in the United Kingdom|level=1}}
Display all coordinates in the large parent category to one level of subcategories (using recursion level 1):
<code><nowiki>{{GeoGroup|article=Category:Listed churches by grade in the United Kingdom|level=1}}</nowiki></code>
*Result: Works, properly showing no data.
{{clear}}

{{GeoGroup|article=Category:Listed churches by grade in the United Kingdom|level=2}}
Display coordinates in the large parent category to two levels of subcategories (using recursion level 2):
<code><nowiki>{{GeoGroup|article=Category:Rail transport stations in London by fare zone|level=2}}</nowiki></code>
*Result: Works, appears same as with Level=0, as there are just two levels of subcategories.
{{clear}}

Display all coordinates in another large category and all its subcategories:
<code><nowiki>{{GeoGroup|article=Category:Railway stations in London|level=0}}</nowiki></code>
{{GeoGroup|article=Category:Railway stations in London}}
{{clear}}

Note one can use "GeoGroupTemplate" or "GeoGroup" interchangeably.

==Wording displayed==
{{GeoGroup|article=Category:Rail transport stations in London fare zone 2}}
There is currently no option to change the wording that is shown in the GeoGroup box displayed in an article. 

For example, when providing means for a reader to map locations within [[:Category:Rail transport stations in London fare zone 2]], an editor might prefer for the Geogroup box to display "Map the Zone 2 stations using OSM" in the article, instead of "Map all coordinates in 'Category:Rail transport stations in London fare zone 2' using OSM".  However, there is no way currently to change the wording presented.

Also when "|section=" option is used, there is no way to change displayed wording from "Map this section's coordinates using ...".

==Bookmarklet to add GeoGroup to categories==
To add the template to categories, you may want to use the [[bookmarklet]] below. Sample edit: [//en.wikipedia.org/w/index.php?title=Category:Loughs_of_County_Mayo&diff=230771016&oldid=165713411]

<nowiki>
javascript:with(document.forms[0]){void(wpSummary.value+='+{{[[Template:GeoGroup|GeoGroup]]}}%20(see%20also%20[[Wikipedia:WikiProject_Geographical_coordinates|WP:GEO]]');void(wpTextbox1.value='{{GeoGroup}}'+wpTextbox1.value);void(wpSave.click())}
</nowiki>

==See also==
*{{tl|Attached KML}}
*{{tl|Maplink}}

<includeonly>{{Sandbox other|
| <!-- ADD CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:External link templates]]
[[Category:Map formatting and function templates]]
[[Category:Geographic coordinate lists|τ]]
[[Category:Articles with Geo|τ]]
}}</includeonly>