Module:Naval Vessel Register URL/doc
 | This is a documentation subpage for Module:Naval Vessel Register URL. It may contain usage information, categories and other content that is not part of the original module page. |
{{#invoke:NVR|function}}
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
Summary
This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database. Intended to be used by:
- {{NVR url}}
- {{NVR SC url}}
The table of URL transformations used by this module can be found at Module:NVR/rules.
Using this module from templates
MakeShipLink
This function returns a link to a ship in the Naval Vessel Register.
Usage:
{{#invoke:NVR|MakeShipLink|id=|title=}}{{#invoke:NVR|MakeShipLink}}— uses the calling template's parameters
Parameters:
- 1 or id — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension.
- 2 or title — A title or label for the link.
Examples:
{{#invoke:NVR|MakeShipLink|DDG_1000}}produces Script error: No such module "NVR".{{#invoke:NVR|MakeShipLink|OLDIRON}}produces Script error: No such module "NVR".{{#invoke:NVR|MakeShipLink|OLDIRON|USS ''Constitution''}}produces Script error: No such module "NVR".
MakeServiceCraftLink
This function returns a link to a service craft in the Naval Vessel Register.
Usage:
{{#invoke:NVR|MakeServiceCraftLink|id=|title=}}{{#invoke:NVR|MakeServiceCraftLink}}— uses the calling template's parameters
Parameters:
- 1 or id — The 'file name' portion of the url path (typically the craft's hull designation) without the .HTM/.HTML extension.
- 2 or title — A title or label for the link.
Example:
{{#invoke:NVR|MakeServiceCraftLink|AFDB1_1}}produces Script error: No such module "NVR".
Using this module from Lua code
In order to use the functions in this module from another Lua module you first have to import this module.
Example:
local nvr = require('Module:NVR')
_MakeShipLink
This function returns a link to a ship in the Naval Vessel Register.
Usage:
link_string = nvr._MakeShipLink(nvrid, title)
Parameters:
- nvrid — The 'file name' portion of the url path (typically the ship's hull designation) without the .HTM/.HTML extension, as a string.
- title — Title for link, set to
''for a bare link without a title.
Examples:
link_string = nvr._MakeShipLink('DDG_1000', '')link_string = nvr._MakeShipLink('OLDIRON', '')
_MakeServiceCraftLink
This function returns a link to a service craft in the Naval Vessel Register.
Usage:
link_string = nvr._MakeServiceCraftLink(nvrid, title)
Parameters:
- nvrid — The 'file name' portion of the url path (typically the craft's hull designation) without the .HTM/.HTML extension, as a string.
- title — Title for link, set to
''for a bare link without a title.
Example:
link_string = nvr._MakeServiceCraftLink('AFDB1_1', '')