Template:Naval Vessel Register URL/doc

The purpose of this template is to have a single location for the Naval Vessel Register (NVR) ship detail base url as a method of combating link rot.

Usage

The template takes two parameters:

|id= – (required) the ship's case-insensitive hull classification symbol in one of five forms:

1. SSBN-659 – the preferred format because it matches the format for hull classification symbols generally used for US Navy ships throughout Wikipedia
2. SSBN 659
3. SSBN659
4. SSBN_659
5. SSBN_659_1635 – the NVR file name format as of September 2017

There are exceptions. USS Ponce (AFSB (I)-15) has a unique hull classification symbol that must be used in this template exactly as shown. There are three ships listed at the NVR website that do not have hull classification symbols. These are: USS Constitution, USS Maine, and USS Texas. For these three ships, use the ship's name for this parameter. The code word OLDIRON, previously used to identify Constitution, is no longer supported.

|title= – (optional) a title or label for an external link

Parameter names are not required. When not used, the positional order is:

{{Naval Vessel Register URL|id|title}}

When |title= is empty or omitted, the template produces a url suitable for use in Citation Style 1 and Citation Style 2 templates.

{{cite web |title=USS Zumwalt |website=Naval Vessel Register |url={{Naval Vessel Register URL|DDG-1000}} |accessdate=1 October 2016}}

With a title, the template produces a properly marked up external wikilink:

{{Naval Vessel Register URL|DDG-1000|USS ''Zumwalt''}}

[http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_DDG_1000.HTML USS ''Zumwalt'']

USS Zumwalt

There are three ships listed at the NVR website that do not have hull classification symbols. These are: USS Constitution, USS Maine, and USS Texas. For these three ships, use the ship's name for this parameter. The code word OLDIRON, previously used to identify Constitution, is no longer supported.

{{Naval Vessel Register URL|constitution|USS ''Constitution''}}

[http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_1315.HTML USS ''Constitution'']

USS Constitution

Error messages

Module:Naval Vessel Register URL returns error messages when it cannot return a link into the NVR. These error messages are:

1. – displayed when |id= is empty or omitted from the template call; add a hull classification symbol
2. – the value assigned to |id= is not one of the supported hull classification symbol forms; use a supported form
3. – the data tables used by the template are grouped by hull type (the letter portion of a hull classification symbol). This error message indicates that the hull type could not be found in the data table. Check for a typo or, if a new hull type, add the hull type data to Module:NVR/data (further instructions there)
4. – the hull classification symbol value assigned to |id= was not found in the data tables; check for a typo in the number portion of the hull classification symbol or, if a new ship, add the ship data to Module:Naval Vessel Register URL/data (further instructions there)
5. – the tables in Module:Naval Vessel Register URL/data have a listing for the ship but the listing is incomplete; add the missing data to Module:Naval Vessel Register URL/data (further instructions there)

Errors occurring on main-space pages are categorized at Category:WPSHIPS:Template errors.

See also

WP:SHIPS citation templates
type	group	template	ref article	example
Dictionary of American Naval Fighting Ships (DANFS) (external link)
source	dictionary	{{DANFS}}	DANFS public domain attribution notice	This article incorporates text from the public domain Dictionary of American Naval Fighting Ships.
source	dictionary	{{Cite DANFS}}	DANFS material citation
Naval Vessel Register (NVR) (external link)
source	register	{{NVR}}	Naval Vessel Register, public domain attribution notice	This article includes information collected from the Naval Vessel Register, which, as a U.S. government publication, is in the public domain.
source	register	{{NVR url}}	creates urls for NVR ship details pages
source	register	{{NVR SC url}}	creates urls for NVR service craft details pages
Category:Ship templates (90) Category:Ship book citation templates‎ (0)