Difference between revisions of "Module:NVR/doc"
Jump to navigation
Jump to search
blackwiki>RP88 (→See Also: add Module:NVR/rules) |
blackwiki>RP88 (module in beta) |
||
| Line 1: | Line 1: | ||
{{ml|NVR|sandbox=NVR/sandbox}} | {{ml|NVR|sandbox=NVR/sandbox}} | ||
| − | {{Module rating | | + | {{Module rating |beta <!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}} |
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --> | ||
__NOTOC__ | __NOTOC__ | ||
Revision as of 07:12, 2 October 2016
{{#invoke:NVR|function}}
| This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. |
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|OLDIRON}}produces malformed hull classification symbol: OLDIRON (help){{#invoke:NVR|MakeShipLink|OLDIRON|USS ''Constitution''}}produces malformed hull classification symbol: OLDIRON (help)
MakeServiceShipLink
This function returns a link to a service ship in the Naval Vessel Register.
Usage:
{{#invoke:NVR|MakeServiceShipLink|id=|title=}}{{#invoke:NVR|MakeServiceShipLink}}— 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.
Example:
{{#invoke:NVR|MakeServiceShipLink|AFDB1_1}}produces Script error: The function "MakeServiceShipLink" does not exist.
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.
Example:
link_string = nvr._MakeShipLink('OLDIRON', '')
_MakeServiceShipLink
This function returns a link to a service ship in the Naval Vessel Register.
Usage:
link_string = nvr._MakeServiceShipLink(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.
Example:
link_string = nvr._MakeServiceShipLink('AFDB1_1', '')