Difference between revisions of "Template:GNIS/doc"
imported>Droll (→See also: tweaked) |
imported>Zyxw (document update to "GNIS 2", update other sections to show usage of optional parameter names) |
||
| Line 7: | Line 7: | ||
<nowiki>{{</nowiki>GNIS|''ID''}} | <nowiki>{{</nowiki>GNIS|''ID''}} | ||
| + | <nowiki>{{</nowiki>GNIS|id=''ID''}} | ||
To have the link text be other than the article name, use a second parameter (optionally, this can be named <code>name</code>): | To have the link text be other than the article name, use a second parameter (optionally, this can be named <code>name</code>): | ||
<nowiki>{{</nowiki>GNIS|''ID''|''Name''}} | <nowiki>{{</nowiki>GNIS|''ID''|''Name''}} | ||
| + | <nowiki>{{</nowiki>GNIS|id=''ID''|name=''Name''}} | ||
This can be used when the Wikipedia page name contains disambiguation brackets; for example, at the page: [[Mount Washington (New Hampshire)]], use {{nowrap| <nowiki>{{</nowiki><code>GNIS{{!}}871352{{!}}Mount Washington}}</code>}} to have "{{GNIS|871352| Mount Washington}}" rather than "{{GNIS|871352| Mount Washington (New Hampshire)}}". This is also necessary should you need to add a link to an article about somebody or something other than the linked feature. | This can be used when the Wikipedia page name contains disambiguation brackets; for example, at the page: [[Mount Washington (New Hampshire)]], use {{nowrap| <nowiki>{{</nowiki><code>GNIS{{!}}871352{{!}}Mount Washington}}</code>}} to have "{{GNIS|871352| Mount Washington}}" rather than "{{GNIS|871352| Mount Washington (New Hampshire)}}". This is also necessary should you need to add a link to an article about somebody or something other than the linked feature. | ||
| Line 18: | Line 20: | ||
<nowiki>{{</nowiki>GNIS|''ID''|''Name''|type=antarid}} | <nowiki>{{</nowiki>GNIS|''ID''|''Name''|type=antarid}} | ||
| + | <nowiki>{{</nowiki>GNIS|id=''ID''|name=''Name''|type=antarid}} | ||
==Template:GNIS 2== | ==Template:GNIS 2== | ||
| − | {{tlx|GNIS 2}} generates a footnote-type link | + | {{tlx|GNIS 2}} generates a footnote-type link. The only required parameter is the GNIS Feature ID number (optionally, this parameter can be named <code>id</code>): |
<nowiki>{{</nowiki>GNIS 2|''ID''}} | <nowiki>{{</nowiki>GNIS 2|''ID''}} | ||
| + | <nowiki>{{</nowiki>GNIS 2|id=''ID''}} | ||
| − | + | If desired, the template can display the feature name as the [[anchor text]], which must be specified in a second unnamed parameter (optionally, this can be named <code>name</code>): | |
| + | |||
| + | <nowiki>{{</nowiki>GNIS|''ID''|''Name''}} | ||
| + | <nowiki>{{</nowiki>GNIS|id=''ID''|name=''Name''}} | ||
| + | |||
| + | Examples: | ||
<nowiki>{{</nowiki>GNIS 2|871352}} | <nowiki>{{</nowiki>GNIS 2|871352}} | ||
| + | <nowiki>{{</nowiki>GNIS 2|871352|Mount Washington}} | ||
| − | + | Results: | |
<br/>{{GNIS 2|871352}} | <br/>{{GNIS 2|871352}} | ||
| + | <br/>{{GNIS 2|871352|Mount Washington}} | ||
===Antarctica=== | ===Antarctica=== | ||
For GNIS pages in Antarctica, use the <code>type=antarid</code> parameter and the corresponding Antarctic GNIS ID. | For GNIS pages in Antarctica, use the <code>type=antarid</code> parameter and the corresponding Antarctic GNIS ID. | ||
| − | + | Examples: | |
<nowiki>{{</nowiki>GNIS 2|2828|type=antarid}} | <nowiki>{{</nowiki>GNIS 2|2828|type=antarid}} | ||
| + | <nowiki>{{</nowiki>GNIS 2|2828|Clarke Glacier|type=antarid}} | ||
| − | + | Results: | |
<br/>{{GNIS 2|2828|type=antarid}} | <br/>{{GNIS 2|2828|type=antarid}} | ||
| + | <br/>{{GNIS 2|2828|Clarke Glacier|type=antarid}} | ||
==Template:GNIS 3== | ==Template:GNIS 3== | ||
| Line 83: | Line 96: | ||
<nowiki>{{</nowiki>GNIS 4|''ID''}} | <nowiki>{{</nowiki>GNIS 4|''ID''}} | ||
| + | <nowiki>{{</nowiki>GNIS 4|id=''ID''}} | ||
Example: | Example: | ||
Revision as of 02:56, 27 January 2013
| This is a documentation subpage for Template:GNIS. It contains usage information, categories and other content that is not part of the original template page. |
These are templates that generate external links to the United States Geological Survey's Geographic Names Information System.
Contents
Template:GNIS
Template:GNIS generates an external link to a GNIS page. The only required parameter is the GNIS Feature ID number (optionally, this parameter can be named id) and the template then uses the article title as the anchor text:
{{GNIS|ID}}
{{GNIS|id=ID}}
To have the link text be other than the article name, use a second parameter (optionally, this can be named name):
{{GNIS|ID|Name}}
{{GNIS|id=ID|name=Name}}
This can be used when the Wikipedia page name contains disambiguation brackets; for example, at the page: Mount Washington (New Hampshire), use {{GNIS|871352|Mount Washington}} to have "U.S. Geological Survey Geographic Names Information System: Mount Washington" rather than "U.S. Geological Survey Geographic Names Information System: Mount Washington (New Hampshire)". This is also necessary should you need to add a link to an article about somebody or something other than the linked feature.
Antarctica
For GNIS pages in Antarctica, use the type=antarid parameter and the corresponding Antarctic GNIS ID:
{{GNIS|ID|Name|type=antarid}}
{{GNIS|id=ID|name=Name|type=antarid}}
Template:GNIS 2
{{GNIS 2}} generates a footnote-type link. The only required parameter is the GNIS Feature ID number (optionally, this parameter can be named id):
{{GNIS 2|ID}}
{{GNIS 2|id=ID}}
If desired, the template can display the feature name as the anchor text, which must be specified in a second unnamed parameter (optionally, this can be named name):
{{GNIS|ID|Name}}
{{GNIS|id=ID|name=Name}}
Examples:
{{GNIS 2|871352}}
{{GNIS 2|871352|Mount Washington}}
Results:
[1]
Mount Washington
Antarctica
For GNIS pages in Antarctica, use the type=antarid parameter and the corresponding Antarctic GNIS ID.
Examples:
{{GNIS 2|2828|type=antarid}}
{{GNIS 2|2828|Clarke Glacier|type=antarid}}
Results:
[2]
Clarke Glacier
Template:GNIS 3
{{GNIS 3}} generates a bare URL. The only required parameter is the GNIS Feature ID number:
{{GNIS 3|ID}}
Example:
{{GNIS 3|871352}}
Result:
https://geonames.usgs.gov/apex/f?p=gnispq:3:::NO::P3_FID:871352
Antarctica
For GNIS pages in Antarctica, use the type=antarid parameter and the corresponding Antarctic GNIS ID.
Example:
{{GNIS 3|type=antarid|9763}}
Result:
https://geonames.usgs.gov/apex/f?p=gnispq:5:::NO::P5_ANTAR_ID:9763
Use in a template
{{Cite web
| url = {{GNIS 3|112837}}
| title = Wheeler Lake
| work = [[Geographic Names Information System]]
| publisher = [[United States Geological Survey]]
| accessdate = 2009-07-05
}}
Result:
"Wheeler Lake". Geographic Names Information System. United States Geological Survey. Retrieved 2009-07-05.
Template:GNIS 4
{{GNIS 4}} generates an external link which displays the GNIS Feature ID number. The only required parameter is ID number (optionally, this parameter can be named id):
{{GNIS 4|ID}}
{{GNIS 4|id=ID}}
Example:
{{GNIS 4|871352}}
Result:
871352
Antarctica
For GNIS pages in Antarctica, use the type=antarid parameter and the corresponding Antarctic GNIS ID.
Example:
{{GNIS 4|2828|type=antarid}}
Result:
2828
Instructions
- Go to http://geonames.usgs.gov/pls/gnispublic/
- Search for the name, location, and / or type of the feature desired, e.g., to find a mountain called 'Mt. Foo', put '
mount foo' in the Feature Name and select 'Summit' for the Feature Class. - Copy the 'ID' and insert it into:
- {{
GNIS|...}}or {{GNIS 2|...}}
- {{
- You can also copy the latitude and longitude and use them in the
{{coord}}template, inserting the '|' vertical bar in-between, e.g.: 44_16_13_N 071_18_12_W →{{coord|44|16|13|N|071|18|12|W|region:US}}
Parameters
| Parameter | Required or Optional | Description |
|---|---|---|
| {1} or id= | Required | GNIS Feature ID, a number without leading zeros |
| {2} or name= | Optional | GNIS Feature Name (only in Template:GNIS), defaults to {{PAGENAME}} |
| type= | Optional | antarid (for locations in Antarctica) |
See also
- Special:Linksearch/geonames.usgs.gov
- Template:Cite gnis
- Template:Mountain index row
- Template:Cite cgndb (Canada)
- Template:Cite bcgnis (British Columbia)
- Template:GPN (Gazetteer of Planetary Nomenclature)