Template:Cite gnis2/sandbox

"Cite gnis2/sandbox", Geographic Names Information System, United States Geological Survey, United States Department of the Interior

This is the template sandbox page for Template:Cite gnis2 (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is a Citation Style 2 template based on {{Cite gnis}}. For centralised Citation Style 2 discussions, see Help talk:Citation Style 2.

This template uses Lua:

{{cite gnis2}} generates a CS2 citation with a link to a Feature Detail Report from the Geographic Names Information System (GNIS), published by the United States Geological Survey (USGS). The citation is displayed as

"Place name", Geographic Names Information System, United States Geological Survey, United States Department of the Interior

,

where Place name is either the Wikipedia article name or an optionally specified name.

The CS2 citation includes a {{harvid}} anchor with format "Place_name_USGS".

Usage

The citation may be placed in the article text with code like:

Some article text.<ref>{{cite gnis2|ID|Name}}</ref>

It may also be placed in a list of sources near the foot of the article, and referenced from the article text by code like:

Some article text.{{sfn|Name USGS}}

...

* {{cite gnis2|ID|Name}}

Note that the Harvard ref is automatically generated by the template, with an anchor "Name USGS". If a different anchor name is desired, it can be set via

* {{cite gnis2|ID|Name|ref={{harvid|Anchor}}}}

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.

{{cite gnis2|ID}}
{{cite gnis2|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.

{{cite gnis2|ID|Name}}
{{cite gnis2|id=ID|name=Name}}

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

{{cite gnis2|ID|type=antarid}}
{{cite gnis2|id=ID|type=antarid}}
{{cite gnis2|ID|Name|type=antarid}}
{{cite gnis2|id=ID|name=Name|type=antarid}}

For feature types retired in 2021, add |type=retired.

{{cite gnis2|ID|type=retired}}
{{cite gnis2|id=ID|type=retired}}
{{cite gnis2|ID|Name|type=retired}}
{{cite gnis2|id=ID|name=Name|type=retired}}

To format the citation using CS1 style, rather than the default CS2 style, specify |mode=cs1

{{cite gnis2|ID|Name|mode=cs1}}

TemplateData

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

TemplateData for Cite gnis2

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 ({{PAGENAME}}) or an optionally specified name.

Template parameters[Edit template data]
Parameter		Description	Type	Status
ID	`1` `id`	GNIS Feature ID, a number without leading zeros.	Number	required
Name	`2` `name`	GNIS Feature Name or other descriptive text. If not given it defaults to the Wikipedia article name Default {{PAGENAME}}	String	optional
Mode	`mode`	Use the value 'cs1' (mode=cs1) to override the default cs2 format. Default cs2	String	optional
Type	`type`	Use the value 'antarid' for features in Antarctica. Use 'retired' for types retired in 2021.	String	optional
Ref	`ref`	Use ref={{harvid\|anchor}} to provide a target for an {{sfn}} short footnote . Default {{harvid\|feature name USGS}}	String	optional

Instructions

Go to the 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 'mount foo' in the Feature Name box and select 'Summit' from the Feature Class list.
Copy the id number for the desired feature (above its name) and insert it into the {{cite gnis2|...}} template.
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}}
But note that latitude, longitude and elevation may be somewhat inaccurate. It is best to confirm this data by viewing the location on a map. If necessary use more reliable sources.

Examples

Long footnote style

Your text.<ref>{{cite gnis2|871352|Mount Washington}}</ref> {{Reflist}}

Result

Your text.^[1]

^ "Mount Washington", Geographic Names Information System, United States Geological Survey, United States Department of the Interior

Long footnote style; CS1

Your text.<ref>{{cite gnis2|871352|Mount Washington|mode=cs1}}</ref> {{Reflist}}

Result

Your text.^[1]

^ "Mount Washington". Geographic Names Information System. United States Geological Survey, United States Department of the Interior.

Short footnote + sources style

Your text.{{sfn|Mt Washington USGS}} {{Reflist}} *{{cite gnis2|871352| Mt Washington}}

Result:

Your text.^[1]

^ Mt Washington USGS.

"Mt Washington", Geographic Names Information System, United States Geological Survey, United States Department of the Interior

All parameters

{{cite gnis2|871352|Mount Washington |mode=cs1 |links=off |entry-date=27 August 1980 |accessdate=3 May 2021|ref={{harvid|Mt Washington USGS}} }}

Result:

"Mount Washington". Geographic Names Information System. United States Geological Survey. 27 August 1980. Retrieved 3 May 2021.