Template:GNIS/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Template:GNIS 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 link is displayed as "U.S. Geological Survey Geographic Names Information System: Name", where Name is either the Wikipedia article name ({{PAGENAME}}) or an optionally specified name.

Usage

The only required parameter is the GNIS Feature ID number (optionally, this parameter can be named id). The template then uses the Wikipedia article name as part of the anchor text.

{{GNIS|ID}}
{{GNIS|id=ID}}

If desired, a feature name other than the article name can be specified in a second unnamed parameter (optionally, this can be named name). This can be used if the article name contains disambiguation or when the GNIS feature name is different than the article name.

{{GNIS|ID|Name}}
{{GNIS|id=ID|name=Name}}

For GNIS features in Antarctica, add |type=antarid.

{{GNIS|ID|type=antarid}}
{{GNIS|id=ID|type=antarid}}
{{GNIS|ID|Name|type=antarid}}
{{GNIS|id=ID|name=Name|type=antarid}}

For GNIS types types of features retired in 2021, add |type=retired.

{{GNIS|ID|type=retired}}
{{GNIS|id=ID|type=retired}}
{{GNIS|ID|Name|type=retired}}
{{GNIS|id=ID|name=Name|type=retired}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:GNIS in articles based on its TemplateData.

TemplateData for GNIS

<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 link is displayed as 'U.S. Geological Survey Geographic Names Information System: Name', where Name is either the Wikipedia article name (GNIS/doc) or an optionally specified name.", "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. If not given it defaults to the Wikipedia article name",
   "type": "string",
   "default": "GNIS/doc",
   "required": false
 },
 "type": {
   "label": "Type",
   "description": "Use the value 'antarid' for features in Antarctica. Use the value 'retired' for feature types retired in 2021.",
   "type": "string",
   "default": "",
   "required": false
 }

}}</templatedata>

Instructions

  1. Go to the GNIS Feature Search page.
  2. Search for the name, location, and/or class of the feature desired, e.g., to find a mountain called 'Mt. Foo', type 'mount foo' in the Feature Name box and select 'Summit' from the Feature Class list.
  3. Copy the id number for the desired feature (above its name) and insert it into the {{GNIS|...}} template.
  4. The latitude and longitude can also be copied and used in the {{coord}} template, inserting the '|' vertical bar between degrees, minutes, seconds, and direction, e.g.: 441613N  0711812W → {{coord|44|16|13|N|071|18|12|W|region:US}}

Examples

URL: https://edits.nationalmap.gov/apps/gaz-domestic/public/summary/871352

URL: https://web.archive.org/web/2020/https://geonames.usgs.gov/apex/f?p=gnispq:5:::NO::P5_ANTAR_ID:2828

URL: https://web.archive.org/web/2020/https://geonames.usgs.gov/apex/f?p=gnispq:3:::NO::P3_FID:235365

Retired data

In October 2021, USGS announced that several classes of data had been removed from their searchable database:

The following feature classes will be archived: Airport, Bridge, Building, Cemetery, Church, Dam, Forest, Harbor, Hospital, Mine, Oilfield, Park, Post Office, Reserve, School, Tower, Trail, Tunnel, and Well.

If you encounter articles with GNIS links that return the error "The ID does not exist", they were probably for records in one of these classes. In this case, specify |type=retired, and a link will be generated to a 2020 snapshot of the GNIS feature.

The snapshot was taken by http://web.archive.org and it may not exist. If you find it doesn't exist, then the link is permanently broken and should be marked with {{dead link}}.

See also

Other GNIS templates
  • {{GNIS 2}} – link with anchor text "[1]" or "Name"
  • {{GNIS URL}} – link as bare URL only, without anchor text
  • {{GNIS 4}} – link with GNIS Feature ID number as the anchor text
  • {{Cite gnis}} – link using the {{Cite web}} template, for use as a reference
List of pages linking to geonames.usgs.gov
Similar templates