Module:Naval Vessel Register URL/doc

Summary

This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database. Intended to be used by:

• {{Naval Vessel Register URL}}
• {{Naval Vessel Register service craft URL}}

NVR have, over time, adopted several different conventions to link to a ship's data base on the ship's hull classification symbol.

To get round 'new' conventions, this version of the module adopts a brute-force mechanism by using a local database that maps a ship's hull classification symbol to its associated NVR ship-data identifier. The database is two large Lua tables maintained at Module:Naval Vessel Register URL/data. Previous versions of this module and its associated data module ignored T- prefixes that are part of several hull designators. As of the 2025-07-16 version, this module does not ignore the prefix; if NVR uses the T- prefix, this module expects to see that prefix in its |id= parameter.

Using this module from templates

nvr_url_make

This function returns a link to a ship's page at the Naval Vessel Register website.

Usage:

{{#invoke:Naval Vessel Register URL|nvr_url_make |id=|title=}}

{{#invoke:Naval Vessel Register URL|nvr_url_make}} — uses the calling template's parameters

Parameters:

1 or id — the ship's case-insensitive hull classification symbol in one of four 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 – the form used in the NVR
3. SSBN659
4. SSBN_659

There are exceptions. 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.

2 or title — A title or label for the link.

Examples:

{{#invoke:Naval Vessel Register URL|nvr_url_make|DDG_1000}} produces https://www.nvr.navy.mil/nvr/getHull.htm?shipId=5450

{{#invoke:Naval Vessel Register URL|nvr_url_make|constitution}} produces https://www.nvr.navy.mil/nvr/getHull.htm?shipId=1315

{{#invoke:Naval Vessel Register URL|nvr_url_make|maine|USS ''Maine''}} produces USS Maine

This function can also return a link to a service craft in the Naval Vessel Register.

Usage:

{{#invoke:Naval Vessel Register URL|nvr_url_make|id=|title=}}

{{#invoke:Naval Vessel Register URL|nvr_url_make}} — uses the calling template's parameters

Parameters:

1 or id — the ship's case-insensitive hull classification symbol in one of four forms:

1. YTB-760 – the preferred format because it matches the format for hull classification symbols generally used for US Navy ships throughout Wikipedia
2. YTB 760 – the form used in the NVR
3. YTB760
4. YTB_760

There are exceptions. NVR has separate pages for some single and some multiple sections of some floating drydocks. For these, this module adopts a convention similarly used by NVR where each section is distinguished by a letter designator; that letter must be appended to the hull classification symbol used in this parameter; see the examples

2 or title — A title or label for the link.

Examples:

{{#invoke:Naval Vessel Register URL|nvr_url_make|AFDB-7F}} produces https://www.nvr.navy.mil/nvr/getHull.htm?shipId=1549

{{#invoke:Naval Vessel Register URL|nvr_url_make|ytb-760|''Natick''}} produces Natick