Module:Citation/CS1/Utilities: Difference between revisions
m>Trappist the monk No edit summary |
m>Trappist the monk No edit summary |
||
Line 58: | Line 58: | ||
end | end | ||
return {is_set=is_set, in_array=in_array, substitute=substitute, error_comment=error_comment, z=z} | --[[--------------------------< S E T _ E R R O R >-------------------------------------------------------------- | ||
Sets an error condition and returns the appropriate error message. The actual placement of the error message in the output is | |||
the responsibility of the calling function. | |||
]] | |||
local function set_error( error_id, arguments, raw, prefix, suffix ) | |||
local error_state = cfg.error_conditions[ error_id ]; | |||
prefix = prefix or ""; | |||
suffix = suffix or ""; | |||
if error_state == nil then | |||
error( cfg.messages['undefined_error'] ); | |||
elseif is_set( error_state.category ) then | |||
table.insert( z.error_categories, error_state.category ); | |||
end | |||
local message = substitute( error_state.message, arguments ); | |||
message = message .. " ([[" .. cfg.messages['help page link'] .. | |||
"#" .. error_state.anchor .. "|" .. | |||
cfg.messages['help page label'] .. "]])"; | |||
z.error_ids[ error_id ] = true; | |||
if in_array( error_id, { 'bare_url_missing_title', 'trans_missing_title' } ) | |||
and z.error_ids['citation_missing_title'] then | |||
return '', false; | |||
end | |||
message = table.concat({ prefix, message, suffix }); | |||
if raw == true then | |||
return message, error_state.hidden; | |||
end | |||
return error_comment( message, error_state.hidden ); | |||
end | |||
return { -- return exported functions and tables | |||
is_set = is_set, | |||
in_array = in_array, | |||
substitute = substitute, | |||
error_comment = error_comment, | |||
set_error = set_error, | |||
z = z, | |||
} |
Revision as of 20:43, 13 December 2015
Documentation for this module may be created at Module:Citation/CS1/Utilities/doc
local u = {} local z = { error_categories = {}; -- for categorizing citations that contain errors error_ids = {}; message_tail = {}; maintenance_cats = {}; -- for categorizing citations that aren't erroneous per se, but could use a little work properties_cats = {}; -- for categorizing citations based on certain properties, language of source for instance }; local cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); --[[--------------------------< I S _ S E T >------------------------------------------------------------------ Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string. This function is global because it is called from both this module and from Date validation ]] function is_set( var ) return not (var == nil or var == ''); end --[[--------------------------< I N _ A R R A Y >-------------------------------------------------------------- Whether needle is in haystack ]] local function in_array( needle, haystack ) if needle == nil then return false; end for n,v in ipairs( haystack ) do if v == needle then return n; end end return false; end --[[--------------------------< S U B S T I T U T E >---------------------------------------------------------- Populates numbered arguments in a message string using an argument table. ]] local function substitute( msg, args ) return args and mw.message.newRawMessage( msg, args ):plain() or msg; end --[[--------------------------< E R R O R _ C O M M E N T >---------------------------------------------------- Wraps error messages with css markup according to the state of hidden. ]] local function error_comment( content, hidden ) return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content ); end --[[--------------------------< S E T _ E R R O R >-------------------------------------------------------------- Sets an error condition and returns the appropriate error message. The actual placement of the error message in the output is the responsibility of the calling function. ]] local function set_error( error_id, arguments, raw, prefix, suffix ) local error_state = cfg.error_conditions[ error_id ]; prefix = prefix or ""; suffix = suffix or ""; if error_state == nil then error( cfg.messages['undefined_error'] ); elseif is_set( error_state.category ) then table.insert( z.error_categories, error_state.category ); end local message = substitute( error_state.message, arguments ); message = message .. " ([[" .. cfg.messages['help page link'] .. "#" .. error_state.anchor .. "|" .. cfg.messages['help page label'] .. "]])"; z.error_ids[ error_id ] = true; if in_array( error_id, { 'bare_url_missing_title', 'trans_missing_title' } ) and z.error_ids['citation_missing_title'] then return '', false; end message = table.concat({ prefix, message, suffix }); if raw == true then return message, error_state.hidden; end return error_comment( message, error_state.hidden ); end return { -- return exported functions and tables is_set = is_set, in_array = in_array, substitute = substitute, error_comment = error_comment, set_error = set_error, z = z, }