Module:Naval Vessel Register URL/sandbox

Module documentation[view] [edit] [history] [purge]

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 adopted a file naming convention based on a ship's hull classification symbol with an appended underscore and some number of digits. The extra digits do not seem to follow an identifiable pattern so the former rules-based system used here no longer works.

To get round the 'new' file format, 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 file name. The database is two large Lua tables maintained at Module:Naval Vessel Register URL/data.

Using this module from templates

MakeShipLink

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

Usage:

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

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

Parameters:

1 or id — 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. 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|MakeShipLink|DDG_1000}} produces http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_DDG_1000.HTML

{{#invoke:Naval Vessel Register URL|MakeShipLink|constitution}} produces http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_1315.HTML

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

MakeServiceCraftLink

This function returns a link to a service craft in the Naval Vessel Register.

Usage:

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

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

Parameters: Parameters:

1 or id — the ship's case-insensitive hull classification symbol in one of five 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
3. YTB760
4. YTB_760
5. YTB_760_5292 – the NVR file name format as of September 2017

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|MakeServiceCraftLink|AFDB-7F}} produces http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_AFDB_7_1549.HTML

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

The above documentation is transcluded from Module:Naval Vessel Register URL/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.

--[[  
 
This module generates links to ships in the Naval Vessel Register (nvr.navy.mil) database.  
It is used by Template:NVR_url and Template:NVR_SC_url
 
Please do not modify this code without applying the changes first at Module:NVR/sandbox and testing 
at Module:NVR/sandbox/testcases and Module talk:NVR/sandbox/testcases.
 
Authors and maintainers:
* User:RP88
 
]]

require('Module:No globals')
local p = {}

--[[--------------------------< F O R W A R D   D E C L A R A T I O N S >--------------------------------------
]]

local ships_data = {};
local srv_craft_data = {};


--[[--------------------------< M A K E _ S H I P _ L I N K >--------------------------------------------------

This function returns a link to a ship in the Naval Vessel Register.
 
Usage:
{{#invoke:NVR|MakeShipLink|1=|title=}}
{{#invoke:NVR|MakeShipLink}} - uses the caller's parameters
 
Parameters
    1, id: The ship's hull classification symbol
    2, title: A title or label for the link.
]]

function p.MakeShipLink (frame)
	-- if no argument provided than check parent template/module args
	local args = frame.args
	local output = {};

	if (args[1]==nil) and (args["id"]==nil) then
		args = frame:getParent().args;
		if (args[1]==nil) and (args["id"]==nil) then
			return 'required parameters missing';
		end
	end
	
	local data = mw.loadData ('Module:NVR/data');
	ships_data = data.nvr_ships_id;

	local hull = args["id"] or args[1] or '';
	local title = args["title"] or args[2] or '';
	
	if '' == title then															-- to prevent external links that look like this: [1]
		title = nil;
	end
	
	hull = mw.text.trim (hull);													-- make sure that there is no leading/trailing whitespace
	hull = hull:upper();														-- and all uppercase

	local hull_prefix;
	
	if hull:match ('(%a+)%-%d+') then											-- most common case
		hull_prefix = hull:match ('(%a+)%-%d+');
	elseif hull:match ('T%-%a+') then											-- T- prefix
		hull_prefix = hull:match ('T%-(%a+)%-%d+')								-- these are grouped with ships that don't use the prefix
	elseif hull:match ('[%a+ %(%)]+%-%d+') then									-- special one-off case for AFSB (I)-15
		hull_prefix = hull:match ('([%a+ %(%)]+)%-%d+')
	elseif hull:match ('^%a+$') then											-- letters only
		hull_prefix = hull;														-- Constitution, Maine, or Texas
	else
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'cannot recognize hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert (output, '\']</span>');
		return table.concat (output);
	end
	
	if not ships_data[hull_prefix] then											-- is there a group for the hull number?
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'unable to find group: [\'');
		table.insert (output, hull_prefix);
		table.insert (output, '\'] in MODULE:NVR/data nvr_ships_id</span>');
		return table.concat (output);
	end

	if not ships_data[hull_prefix][hull] then									-- is there a hull number
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'unable to find hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert (output, '\'] in MODULE:NVR/data nvr_ships_id</span>');
		return table.concat (output);
	end

	local nvr_id = ships_data[hull_prefix][hull][1];							-- try to fetch nvr id

	if (nil ~= nvr_id) and ('' ~= nvr_id) then									-- there appears to be an identifier, so use it
		if title then
			table.insert (output, '[');
		end
		table.insert (output, 'http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_');
		table.insert (output, nvr_id);
		table.insert (output, '.HTML');
		if title then
			table.insert (output, ' ');
			table.insert (output, title);
			table.insert (output, ']');
		end
		
	else																		-- no identifier
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'no identifier for hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert ('\'] in MODULE:NVR/data nvr_ships_id</span>');
	end
	
	return table.concat (output);
end


--[[--------------------------< M A K E _ S E R V I C E _ C R A F T _ L I N K >--------------------------------

This function returns a link to a service craft in the Naval Vessel Register.
 
Usage:
{{#invoke:NVR|MakeServiceCraftLink|1=|title=}}
{{#invoke:NVR|MakeServiceCraftLink}} - uses the caller's parameters
 
Parameters
    1, id: The 'file name' portion of the url path (typically the craft's hull designation) without the .HTM/.HTML extension. 
    2, title: A title or label for the link.
]]

function p.MakeServiceCraftLink( frame )
	-- if no argument provided than check parent template/module args
	local args = frame.args
	local output = {};

	if (args[1]==nil) and (args["id"]==nil) then
		args = frame:getParent().args;
		if (args[1]==nil) and (args["id"]==nil) then
			return 'required parameters missing';
		end
	end
	
	local data = mw.loadData ('Module:NVR/data');
	srv_craft_data = data.nvr_srv_craft_id;

	local hull = args["id"] or args[1] or '';
	local title = args["title"] or args[2] or '';
	
	if '' == title then															-- to prevent external links that look like this: [1]
		title = nil;
	end
	
	hull = mw.text.trim (hull);													-- make sure that there is no leading/trailing whitespace
	hull = hull:upper();														-- and all uppercase

	local hull_prefix;
	
	if hull:match ('(%a+)%-%d+') then											-- most common case
		hull_prefix = hull:match ('(%a+)%-%d+');
	elseif hull:match ('(%a+)%-%d+%a+') then									-- special cases for the various sections of floating dry docks
		hull_prefix = hull:match ('(%a+)%-%d+%a+');
	else
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'cannot recognize hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert (output, '\']</span>');
		return table.concat (output);
	end
	
	if not srv_craft_data[hull_prefix] then										-- is there a group for the hull number?
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'unable to find group: [\'');
		table.insert (output, hull_prefix);
		table.insert (output, '\'] in MODULE:NVR/data nvr_ships_id</span>');
		return table.concat (output);
	end

	if not srv_craft_data[hull_prefix][hull] then								-- is there a hull number
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'unable to find hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert (output, '\'] in MODULE:NVR/data nvr_ships_id</span>');
		return table.concat (output);
	end

	local nvr_id = srv_craft_data[hull_prefix][hull][1];						-- try to fetch nvr id

	if (nil ~= nvr_id) and ('' ~= nvr_id) then									-- there appears to be an identifier, so use it
		if title then
			table.insert (output, '[');
		end
		table.insert (output, 'http://www.nvr.navy.mil/SHIPDETAILS/SHIPSDETAIL_');
		table.insert (output, nvr_id);
		table.insert (output, '.HTML');
		if title then
			table.insert (output, ' ');
			table.insert (output, title);
			table.insert (output, ']');
		end
	else																		-- no identifier
		table.insert (output, '<span style="font-size:100%" class="error">')
		table.insert (output, 'no identifier for hull classification symbol: [\'');
		table.insert (output, hull);
		table.insert ('\'] in MODULE:NVR/data nvr_ships_id</span>');
	end
	
	return table.concat (output);
end

return p