Module:WPSHIPS utilities and Module:WPSHIPS utilities/sandbox: Difference between pages

local data = mw.loadData ('Module:WPSHIPS utilities/data');

--[[--------------------------< E R R O R _ M A P _ T >--------------------------------------------------------

]]

local error_map_t = { -- [1] is error message; [2] is error category

synonymous = {'has synonymous parameter', 'Category:Pages using infobox ship with synonymous parameters'};

missing = {'missing required parameter: %s', 'Category:WPSHIPS: sclass and sclass2 errors'},

format = {'invalid format code: %s. Should be 0–5, or blank', 'Category:WPSHIPS: sclass and sclass2 errors'},

missing_name = {'missing name', 'Category:WPSHIPS: Template Ship parameter errors'},

missing_dab = {'missing disambiguator', 'Category:WPSHIPS: Template Ship parameter errors'},

missing_prefix = {'missing prefix', 'Category:WPSHIPS: Template Ship parameter errors'},

invalid_control = {'invalid control parameter: %s', 'Category:WPSHIPS: Template Ship parameter errors'},

--[[--------------------------< E R R O R _ M S G _ M A K E >--------------------------------------------------

assembles an error message from message text and category in <error_map_t>. creates a help link to the category

page; categorizes only main and template namespaces.

<no_cat> disables categorization for those templates that support it; to disable categorization set <no_cat> true

local function error_msg_make (msg_idx, template, detail, no_cat, link_template_name)

table.insert (out, '<span style=\"font-size: 100%; font-style: normal;\" class=\"error\">Error: '); --TODO: simplify?

if template then

if link_template_name then

table.insert (out, table.concat ({'{{[[Template:', template, '|', template, ']]}} '}));

else

table.insert (out, table.concat ({'{{', template, '}} '})); -- TODO: get template names for synonymous parameter errors

end

end

table.insert (out, string.format (error_map_t[msg_idx][1], detail)); -- build error message from base + <detail>

table.insert (out, table.concat ({' ([[:', error_map_t[msg_idx][2], '|help]])'})); -- help text on category pages; TODO: help text on template pages also?

table.insert (out, table.concat ({'[[', error_map_t[msg_idx][2], ']]'}));

return table.concat (out); -- make a big string and done

local function _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, template, no_cat)

error_msg = error_msg_make ('missing_name', template, '', no_cat, true);

error_msg = error_msg_make ('missing_dab', template, '', no_cat, true);

error_msg = error_msg_make ('missing_prefix', template, '', no_cat, true);

error_msg = error_msg_make ('invalid_control', template, control, no_cat, true);

if ('number' ~= type (tonumber (control))) or (1 ~= control:len()) or (1 > tonumber (control) or 6 < tonumber (control)) then -- control must be a single-digit number 1 through 6

error_msg = error_msg_make ('invalid_control', template, control, no_cat, true);

error_msg = error_msg_make ('missing_prefix', template, '', no_cat, true);

return error_msg;

local link = '';

link = prefix .. ' ' .. name; -- begin assembling the article name (link) portion of the wikilink

link = name;

local target_object = mw.title.new (link).redirectTarget; -- if <link> points to a redirect

if target_object then

link = target_object.fullText; -- get the target title to avoid linking through the redirect

end

if is_set (prefix) then

end

if '5' ~= control and'6' ~= control and is_set (control) then

unlinked_prefix = false; -- no prefix so don't try to unlink it

return link_name; -- no linking desired so done

elseif unlinked_prefix and is_set (prefix) then -- when there is a prefix to unlink

link_name = link_name:gsub ('^.-&nbsp;', '', 1); -- remove the prefix and nbsp

return prefix .. '&nbsp;[[' .. link .. '|' .. link_name .. ']]'; -- add prefix and nbsp to front and done

return '[[' .. link .. '|' .. link_name .. ']]'; -- construct the wikilink and done

{{#invoke:WPSHIPS_utilities|ship|_template=<template name>}}

{{#invoke:WPSHIPS_utilities|ship_pre|prefix=<prefix>|_template=<template name>}}

Parameters in the module frame are:

there are no module frame parameters

Parameters in the template frame are:

{{{1|}}} – prefix (HMS, USS, Japanese submarine, etc)

{{{2|}}} – ship's name (required)

{{{3|}}} – disambiguator (year, hull or pennant number, etc)

{{{4|}}} – format control (1, 2, 3, 5, 6; 4 not allowed)

|wl= – when set to 'no', rendering is not wikilinked

|up= – when set to 'yes' prefix (if rendered) is not linked

local args_t = get_args (frame);

local prefix = args_t[1] or ''; -- fetch positional parameters into named variables for readability

local name = args_t[2] or ''; -- stripped of leading and trailing whitespace

local dab = args_t[3] or ''; -- empty positional parameters are nil so convert nil to empty string

local control = args_t[4];

local unlinked_prefix = 'yes' == args_t.up; -- make boolean: true when |up=yes

local unlinked_whole = 'no' == args_t.wl; -- make boolean: true when |wl=no

local no_cat = 'yes' == args_t['no-tracking']; -- make boolean: true when |no-tracking=yes

return _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, 'Ship', no_cat);

end

--[[--------------------------< S H I P _ P R E F I X _ T E M P L A T E S >------------------------------------

This is a possible replacement for the template prefix templates {{USS}}, {{HMS}}, etc. It has better error

detection and handling.

This function is the externally accessible entry point for those templates

{{#invoke:WPSHIPS_utilities|ship_prefix_templates|prefix=<prefix>|template=<template name>}}

Parameters in the module frame are:

|_prefix= – (required) _prefix (HMS, USS, Japanese submarine, etc)

|_template= template name for error messages; optional when |prefix= same as template name

Parameters in the template frame are:

{{{1|}}} – ship's name (required)

{{{2|}}} – disambiguator (year, hull or pennant number, etc)

{{{3|}}} – format control (1, 2, 3, 5, 6; 4 not allowed)

|wl= – when set to 'no', rendering is not wikilinked

|up= – when set to 'yes' prefix (if rendered) is not linked

]]

local function ship_prefix_templates (frame) -- this version not supported from the templates yet

local args_t = get_args (frame);

local prefix = args_t.prefix or ''; -- fetch positional parameters into named variables for readability

local name = args_t[1] or ''; -- stripped of leading and trailing whitespace

local dab = args_t[2] or ''; -- empty positional parameters are nil so convert nil to empty string

local control = args_t[3];

local unlinked_prefix = 'yes' == args_t.up; -- make boolean: true when |up=yes

local unlinked_whole = 'no' == args_t.wl; -- make boolean: true when |wl=no

local no_cat = 'yes' == args_t['no-tracking']; -- make boolean: true when |no-tracking=yes

return _ship (prefix, name, dab, control, unlinked_prefix, unlinked_whole, args_t.template_name or prefix, no_cat);

table.insert (html_table, '<ul style="list-style: none">'); -- add a new sublist

local function synonym_check (args_t, uk_param, us_param, error_flag)

args_t[uk_param] = args_t[uk_param] .. error_msg_make ('synonymous'); -- both are set so append error message with category

args_t[us_param] = args_t[us_param] .. error_msg_make ('synonymous', nil, nil, true); -- but append error message without category

return error_flag; -- no match so return unmodified <error_flag>

end

--[[--------------------------< I S _ E M P T Y _ I B O X _ T E M P L A T E >----------------------------------

temporary(?) code to add Category:WPSHIPS: articles with empty infobox templates when empty infobox templates

are encountered. A template is empty when no parameters have assigned values or when the only parameter with an

assigned value is |Hide header=

when 'empty', returns the category name; nil else

]]

local function is_empty_ibox_template (args_t)

local i = 0;

for k, v in pairs (args_t) do

i = i + 1;

end

if ((1 == i) and args_t['Hide header']) or (0 == i) then

return '[[Category:WPSHIPS: articles with empty infobox templates]]';

end

local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates

if err_cat then

return err_cat; -- template is empty so return the category and done

end

local error_flag = false; -- controls emission of maint category when synonymous parameters are both set

error_flag = synonym_check (args_t, 'Ship stricken', 'Ship struck', error_flag); -- error if both synonymous parameters set

error_flag = synonym_check (args_t, 'Ship honours', 'Ship honors', error_flag);

table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;color:inherit;text-align:left;padding-left:2px;vertical-align:middle;font-size:110%;">');

table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;color:inherit;text-align:center;vertical-align:middle;font-size:110%;">');

table.insert (html_out_t, '<tr><th height="30" colspan="2" style="background-color:#B0C4DE;color:inherit;padding-left:2px;">');

local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates

if err_cat then

return err_cat; -- template is empty so return the category and done

end

local error_flag = false; -- controls emission of maint category when synonymous parameters are both set

error_flag = synonym_check (args_t, 'Ship armour', 'Ship armor', error_flag); -- error if both synonymous parameters set

error_flag = synonym_check (args_t, 'Ship draught', 'Ship draft', error_flag);

local err_cat = is_empty_ibox_template (args_t); -- look for and identify empty templates

if err_cat then

return err_cat; -- template is empty so return the category and done

end

local year, volume, scan;

if args_t[1] then -- this to avoid script errors when args_t[1] missing

year, volume, scan = args_t[1]:match ('(%d%d)(%l)(%d%d%d%d)%.[Pp][Dd][Ff]'); -- get the various parts

end

end

--[[--------------------------< S C L A S S >------------------------------------------------------------------

implements {{sclass}} and {{sclass2}}

{{#invoke:WPSHIPS utilities|sclass}}

]]

local function sclass (frame)

local args_t = get_args (frame);

local parent = frame:getParent();

local template = parent:getTitle():gsub ('^Template:', ''):lower(); -- get the name of the template that called this module (includes namespace so strip that)

local class_name = args_t[1]; -- names to make it easier to understand

local ship_type = args_t[2];

local format = args_t[3];

local ship_type_dab = args_t[4];

local class_name_dab = args_t[5];

local no_cat = 'yes' == args_t['no-cat']; -- make a boolean

if not class_name then -- when omitted, abandon with error message

return error_msg_make ('missing', template, 'class name', no_cat);

end

if not ship_type then -- when omitted, abandon with error message

return error_msg_make ('missing', template, 'ship type', no_cat);

end

if format then

if tonumber (format) then -- if <format> has a value that is a number

format = tonumber (format); -- make it a number for comparisons

if 5 < format then -- is <format> outside of allowed range

return error_msg_make ('format', template, format, no_cat);

end

else -- <format> could not be converted to a number

return error_msg_make ('format', template, format, no_cat);

end

end

local out_t = {}; -- output goes here

table.insert (out_t, '[['); -- open the wikilink

table.insert (out_t, class_name); -- build the wikilink to the class article

table.insert (out_t, '-class ');

table.insert (out_t, ship_type); -- add ship type

if class_name_dab then -- when class article is disambiguated

table.insert (out_t, ' ('); -- add the disambiguator

table.insert (out_t, class_name_dab);

table.insert (out_t, ')');

end

table.insert (out_t, '|');

if 'sclass' == template:gsub ('/sandbox', '') then -- strip '/sandbox' if present; class named for a member of the class

table.insert (out_t, '\'\''); -- class name is italicized

table.insert (out_t, class_name);

table.insert (out_t, '\'\'');

else

table.insert (out_t, class_name); -- class name is a common attribute; plain text

end

if not format or (3 == format) then -- when format is omitted, same as format #3

table.insert (out_t, '-class]] [['); -- open ship-type wikilink

if ship_type_dab then -- when ship-type article is disambiguated

table.insert (out_t, ship_type); -- add ship type

table.insert (out_t, ' ('); -- and the disambiguator

table.insert (out_t, ship_type_dab);

table.insert (out_t, ')|'); -- dab is not displayed so insert a pipe and

end

table.insert (out_t, ship_type); -- add ship type

table.insert (out_t, ']]'); -- close ship-type wikilink

end

if 0 == format then -- no separate ship-type wikilink

table.insert (out_t, '-class]]');

end

if 1 == format then -- no separate ship-type wikilink

table.insert (out_t, '-class ');

table.insert (out_t, ship_type);

table.insert (out_t, ']]');

end

if 2 == format then -- ship-type is not wikilinked

table.insert (out_t, '-class]] ');

table.insert (out_t, ship_type);

end

if 4 == format then -- noun form; no ship type

table.insert (out_t, ' class]]');

end

if 5 == format then -- class name only; no '-class' annotation

table.insert (out_t, ']]');

end

return table.concat (out_t);

sclass = sclass,

ship_prefix_templates = ship_prefix_templates, -- experiment