View source for Template:GNIS 2/doc

{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->

[[Template:GNIS 2]] generates an external link to a Feature Detail Report from the [[Geographic Names Information System]] (GNIS), published by the [[United States Geological Survey]] (USGS). The external link is displayed as a footnote style link (&nbsp;[1]&nbsp;) or with an optionally specified name as the [[anchor text]].

== Usage ==

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=''ID''}}

If desired, the template can display the feature name as the [[anchor text]], which can be specified in a second unnamed parameter (optionally, this parameter name can be named <code>name</code>):

 <nowiki>{{</nowiki>GNIS 2|''ID''|''Name''}}
 <nowiki>{{</nowiki>GNIS 2|id=''ID''|name=''Name''}}

For GNIS features in Antarctica, add <code>|type=antarid</code>.

 <nowiki>{{</nowiki>GNIS 2|''ID''|type=antarid}}
 <nowiki>{{</nowiki>GNIS 2|id=''ID''|type=antarid}}

 <nowiki>{{</nowiki>GNIS 2|''ID''|''Name''|type=antarid}}
 <nowiki>{{</nowiki>GNIS 2|id=''ID''|name=''Name''|type=antarid}}

== TemplateData ==

{{TemplateDataHeader}}
<templatedata>{
"description": "This template generates an external link to a Feature Detail Report from the Geographic Names Information System (GNIS), published by the United States Geological Survey (USGS). The external link is displayed as a footnote style link ( [1] ) or with an optionally specified name as the anchor text.",
"params": {
  "1": {
    "label": "ID",
    "aliases": ["id"],
    "description": "GNIS Feature ID, a number without leading zeros.",
    "type": "number",
    "default": "",
    "required": true
  },
  "2": {
    "label": "Name",
    "aliases": ["name"],
    "description": "GNIS Feature Name or other descriptive text.",
    "type": "string",
    "default": "",
    "required": false
  },
  "type": {
    "label": "Type",
    "description": "Use the value 'antarid' (type=antarid) for features in Antarctica.",
    "type": "string",
    "default": "",
    "required": false
  }
}}</templatedata>

== Instructions ==

# Go to the [https://geonames.usgs.gov/apex/f?p=gnispq GNIS Feature Search] page.
# Search for the name, location, and/or class of the feature desired, e.g., to find a mountain called 'Mt. Foo', type '<code>mount foo</code>' in the Feature Name box and select 'Summit' from the Feature Class list.
# Copy the 'ID' number for the desired feature and insert it into the <code><nowiki>{{</nowiki>GNIS 2|...}}</code> template.
# The latitude and longitude can also be copied and used in the {{tlx|coord}} template, inserting the '{{para}}' vertical bar between degrees, minutes, seconds, and direction, e.g.: 441613N&nbsp;&nbsp;0711812W → <code><nowiki>{{</nowiki>coord|44|16|13|N|071|18|12|W|region:US}}</code>

== Examples ==

=== ID only ===

URL: https://geonames.usgs.gov/apex/f?p=gnispq:3:::NO::P3_FID:871352
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 | 871352 }}</code>
** ''Result:'' {{GNIS 2 | 871352 }}
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 |id= 871352 }}</code>
** ''Result:'' {{GNIS 2 |id= 871352 }}

URL: https://geonames.usgs.gov/apex/f?p=gnispq:5:::NO::P5_ANTAR_ID:2828
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 | 2828 |type= antarid }}</code>
** ''Result:'' {{GNIS 2 | 2828 |type= antarid }}
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 |id= 2828 |type= antarid }}</code>
** ''Result:'' {{GNIS 2 |id= 2828 |type= antarid }}

=== ID and Name ===

URL: https://geonames.usgs.gov/apex/f?p=gnispq:3:::NO::P3_FID:871352
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 | 871352 | Mount Washington }}</code>
** ''Result:'' {{GNIS 2 | 871352 | Mount Washington }}
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 |id= 871352 |name= Mount Washington }}</code>
** ''Result:'' {{GNIS 2 |id= 871352 |name= Mount Washington }}

URL: https://geonames.usgs.gov/apex/f?p=gnispq:5:::NO::P5_ANTAR_ID:2828
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 | 2828 | Clarke Glacier |type= antarid }}</code>
** ''Result:'' {{GNIS 2 | 2828 | Clarke Glacier |type= antarid }}
* ''Usage:'' <code><nowiki>{{</nowiki>GNIS 2 |id= 2828 |name= Clarke Glacier |type= antarid }}</code>
** ''Result:'' {{GNIS 2 |id= 2828 |name= Clarke Glacier |type= antarid }}

== See also ==

Other GNIS templates:
* [[Template:GNIS]] – link with anchor text "U.S. Geological Survey Geographic Names Information System: ''Name''"
* [[Template:GNIS 3]] – link as bare [[URL]] only, without anchor text
* [[Template:GNIS 4]] – link with GNIS Feature ID number as the anchor text
* [[Template:Cite GNIS]] – link using the {{tl|Cite web}} template, for use as a reference

List of pages linking to [[Special:Linksearch/geonames.usgs.gov|geonames.usgs.gov]]:
* [[Special:Linksearch/geonames.usgs.gov/apex/f?p=gnispq]] (current format)
* [[Special:Linksearch/geonames.usgs.gov/pls/gnispublic/f?p=gnispq]] (old format)

Similar templates:
* [[Template:Mountain index row]] – includes an optional GNIS link
* [[Template:Cite cgndb]] – for links to [[Canadian Geographical Names Data Base]]
** [[Template:Cite bcgnis]] – for links to [[BC Geographical Names]] for British Columbia
* [[Template:GPN]] – for links to Gazetteer of Planetary Nomenclature
* [[Template:GEOnet2]] and [[Template:Cite GNS]] – for links to non-U.S. geographic feature names from [[GEOnet Names Server]]

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:United States government external link templates]]
}}</includeonly>