Difference between revisions of "Module:NVR/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>RP88
m (remove extraneous punctuation)
blackwiki>RP88
Line 79: Line 79:
  
 
==See Also==
 
==See Also==
 +
* [[Module:NVR/rules]]
 
* [[Template:NVR url]]
 
* [[Template:NVR url]]
 
* [[Template:NVR SC url]]
 
* [[Template:NVR SC url]]

Revision as of 01:13, 29 September 2016

{{#invoke:NVR|function}}

Summary

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

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', '')

See Also