وي عرب

الفرق بين المراجعتين لصفحة: «وحدة:Citation/CS1/Utilities»

وحدة نقاش

وحدة:Citation/CS1/Utilities (عرض المصدر)

مراجعة ١٠:٣٥، ٢٠ نوفمبر ٢٠٢١

أُزيل ٣٬٨٣٥ بايت ،  ٢٠ نوفمبر ٢٠٢١
ط
مراجعة واحدة
(sync from sandbox;)
ط (مراجعة واحدة)
سطر ١٣: سطر ١٣:


local cfg; -- table of tables imported from selected Module:Citation/CS1/Configuration
local cfg; -- table of tables imported from selected Module:Citation/CS1/Configuration
--[[--------------------------< H A S _ A C C E P T _ A S _ W R I T T E N >------------------------------------
When <str> is wholly wrapped in accept-as-written markup, return <str> without markup and true; return <str> and false else
with allow_empty = false, <str> must have at least one character inside the markup
with allow_empty = true, <str> the markup frame can be empty like (()) to distinguish an empty template parameter from the specific condition "has no applicable value" in citation-context.
After further evaluation the two cases might be merged at a later stage, but should be kept separated for now.
]]
local function has_accept_as_written (str, allow_empty)
local count;
if true == allow_empty then
str, count = str:gsub ('^%(%((.*)%)%)$', '%1'); -- allows (()) to be an empty set
else
str, count = str:gsub ('^%(%((.+)%)%)$', '%1');
end
return str, 0 ~= count;
end




سطر ٤٣: سطر ٢١:
]]
]]


local function is_set (var)
local function is_set( var )
return not (var == nil or var == '');
return not (var == nil or var == '');
end
end
سطر ٥٤: سطر ٣٢:
]]
]]


local function in_array (needle, haystack)
local function in_array( needle, haystack )
if needle == nil then
if needle == nil then
return false;
return false;
end
end
for n, v in ipairs (haystack) do
for n,v in ipairs( haystack ) do
if v == needle then
if v == needle then
return n;
return n;
سطر ٧٣: سطر ٥١:
]]
]]


local function substitute (msg, args)
local function substitute( msg, args )
return args and mw.message.newRawMessage (msg, args):plain() or msg;
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
end
end


سطر ٨٠: سطر ٥٨:
--[[--------------------------< E R R O R _ C O M M E N T >----------------------------------------------------
--[[--------------------------< E R R O R _ C O M M E N T >----------------------------------------------------


Wraps error messages with CSS markup according to the state of hidden.
Wraps error messages with css markup according to the state of hidden.


]]
]]


local function error_comment (content, hidden)
local function error_comment( content, hidden )
return substitute (hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content);
return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content );
end
end


سطر ٩١: سطر ٦٩:
--[=[-------------------------< M A K E _ W I K I L I N K >----------------------------------------------------
--[=[-------------------------< M A K E _ W I K I L I N K >----------------------------------------------------


Makes a wikilink; when both link and display text is provided, returns a wikilink in the form [[L|D]]; if only
Makes a wikilink; when bot link and display text is provided, returns a wikilink in the form [[L|D]]; if only
link is provided (or link and display are the same), returns a wikilink in the form [[L]]; if neither are
link is provided, returns a wikilink in the form [[L]]; if neither are provided or link is omitted, returns an
provided or link is omitted, returns an empty string.
empty string.


]=]
]=]


local function make_wikilink (link, display)
local function make_wikilink (link, display)
if not is_set (link) then return '' end
if is_set (link) then
 
if is_set (display) then
if is_set (display) and link ~= display then
return table.concat ({'[[', link, '|', display, ']]'});
return table.concat ({'[[', link, '|', display, ']]'});
else
return table.concat ({'[[', link, ']]'});
end
else
else
return table.concat ({'[[', link, ']]'});
return '';
end
end
end
end




--[[--------------------------< S E T _ M E S S A G E >----------------------------------------------------------
--[[--------------------------< 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
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.
the responsibility of the calling function.
TODO: change z.error_categories and z.maintenance_cats to have the form cat_name = true; to avoid dups without having to have an extra cat


]]
]]
local added_maint_cats = {} -- list of maintenance categories that have been added to z.maintenance_cats; TODO: figure out how to delete this table


local function set_message (error_id, arguments, raw, prefix, suffix)
local function set_error( error_id, arguments, raw, prefix, suffix )
local error_state = cfg.error_conditions[error_id];
local error_state = cfg.error_conditions[ error_id ];
prefix = prefix or '';
prefix = prefix or "";
suffix = suffix or '';
suffix = suffix or "";
if error_state == nil then
if error_state == nil then
error (cfg.messages['undefined_error'] .. ': ' .. error_id); -- because missing error handler in Module:Citation/CS1/Configuration
error( cfg.messages['undefined_error'] ); -- because missing error handler in Module:Citation/CS1/Configuration
 
elseif is_set( error_state.category ) then
elseif is_set (error_state.category) then
table.insert( z.error_categories, error_state.category );
if error_state.message then -- when error_state.message defined, this is an error message
table.insert (z.error_categories, error_state.category);
else
if not added_maint_cats[error_id] then
added_maint_cats[error_id] = true; -- note that we've added this category
table.insert (z.maintenance_cats, substitute (error_state.category, arguments)); -- make cat name then add to table
end
return; -- because no message, nothing more to do
end
end
end
 
local message = substitute (error_state.message, arguments);
local message = substitute( error_state.message, arguments );


message = table.concat (
message = table.concat (
سطر ١٥٦: سطر ١٢٤:
});
});


z.error_ids[error_id] = true;
z.error_ids[ error_id ] = true;
if z.error_ids['err_citation_missing_title'] and -- if missing-title error already noted
if in_array( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
in_array (error_id, {'err_bare_url_missing_title', 'err_trans_missing_title'}) then -- and this error is one of these
and z.error_ids['citation_missing_title'] then
return '', false; -- don't bother because one flavor of missing title is sufficient
return '', false;
end
end
message = table.concat ({prefix, message, suffix});
message = table.concat({ prefix, message, suffix });
 
if raw == true then
if raw == true then
return message, error_state.hidden;
return message, error_state.hidden;
end
end
 
return error_comment (message, error_state.hidden);
return error_comment( message, error_state.hidden );
end
end


سطر ١٨١: سطر ١٤٩:
alias – one of the list of possible aliases in the aliases lists from Module:Citation/CS1/Configuration
alias – one of the list of possible aliases in the aliases lists from Module:Citation/CS1/Configuration
index – for enumerated parameters, identifies which one
index – for enumerated parameters, identifies which one
enumerated – true/false flag used to choose how enumerated aliases are examined
enumerated – true/false flag used choose how enumerated aliases are examined
value – value associated with an alias that has previously been selected; nil if not yet selected
value – value associated with an alias that has previously been selected; nil if not yet selected
selected – the alias that has previously been selected; nil if not yet selected
selected – the alias that has previously been selected; nil if not yet selected
سطر ١٩٩: سطر ١٦٧:
end
end


if is_set (args[alias]) then -- alias is in the template's argument list
if is_set(args[alias]) then -- alias is in the template's argument list
if value ~= nil and selected ~= alias then -- if we have already selected one of the aliases
if value ~= nil and selected ~= alias then -- if we have already selected one of the aliases
local skip;
local skip;
for _, v in ipairs (error_list) do -- spin through the error list to see if we've added this alias
for _, v in ipairs(error_list) do -- spin through the error list to see if we've added this alias
if v == alias then
if v == alias then
skip = true;
skip = true;
سطر ٢٠٩: سطر ١٧٧:
end
end
if not skip then -- has not been added so
if not skip then -- has not been added so
table.insert (error_list, alias); -- add error alias to the error list
table.insert( error_list, alias ); -- add error alias to the error list
end
end
else
else
سطر ٢٢٧: سطر ١٩٥:
]]
]]


local added_maint_cats = {} -- list of maintenance categories that have been added to z.maintenance_cats
local function add_maint_cat (key, arguments)
local function add_maint_cat (key, arguments)
if not added_maint_cats [key] then
if not added_maint_cats [key] then
added_maint_cats [key] = true; -- note that we've added this category
added_maint_cats [key] = true; -- note that we've added this category
table.insert (z.maintenance_cats, substitute (cfg.maint_cats [key], arguments)); -- make name then add to table
table.insert( z.maintenance_cats, substitute (cfg.maint_cats [key], arguments)); -- make name then add to table
end
end
 
 
--[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------
 
Adds a category to z.properties_cats using names from the configuration file with additional text if any.
 
foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languages
may be categorized but multiples of the same language are not categorized.
 
added_prop_cats is a table declared in page scope variables above
 
]]
 
local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats
 
local function add_prop_cat (key, arguments)
if not added_prop_cats [key] then
added_prop_cats [key] = true; -- note that we've added this category
key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?[%a%-]*', '%1'); -- strip lang code from keyname
table.insert (z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
end
end
end
end
سطر ٢٦٧: سطر ٢١٤:
]]
]]


local function safe_for_italics (str)
local function safe_for_italics( str )
if not is_set (str) then return str end
if not is_set(str) then
 
return str;
if str:sub (1, 1) == "'" then str = "<span></span>" .. str; end
else
if str:sub (-1, -1) == "'" then str = str .. "<span></span>"; end
if str:sub(1,1) == "'" then str = "<span></span>" .. str; end
if str:sub(-1,-1) == "'" then str = str .. "<span></span>"; end
-- Remove newlines as they break italics.
return str:gsub ('\n', ' ');
-- Remove newlines as they break italics.
 
return str:gsub( '\n', ' ' );
end
end
end


سطر ٢٨٨: سطر ٢٣٦:


local function wrap_style (key, str)
local function wrap_style (key, str)
if not is_set (str) then
if not is_set( str ) then
return "";
return "";
elseif in_array (key, {'italic-title', 'trans-italic-title'}) then
elseif in_array( key, { 'italic-title', 'trans-italic-title' } ) then
str = safe_for_italics (str);
str = safe_for_italics( str );
end
end


return substitute (cfg.presentation[key], {str});
return substitute( cfg.presentation[key], {str} );
end
 
 
--[[--------------------------< M A K E _ S E P _ L I S T >------------------------------------------------------------
 
make a separated list of items using provided separators.
<sep_list> - typically '<comma><space>'
<sep_list_pair> - typically '<space>and<space>'
<sep_list_end> - typically '<comma><space>and<space>' or '<comma><space>&<space>'
 
defaults to cfg.presentation['sep_list'], cfg.presentation['sep_list_pair'], and cfg.presentation['sep_list_end']
if <sep_list_end> is specified, <sep_list> and <sep_list_pair> must also be supplied
 
]]
 
local function make_sep_list (count, list_seq, sep_list, sep_list_pair, sep_list_end)
local list = '';
 
if not sep_list then -- set the defaults
sep_list = cfg.presentation['sep_list'];
sep_list_pair = cfg.presentation['sep_list_pair'];
sep_list_end = cfg.presentation['sep_list_end'];
end
if 2 >= count then
list = table.concat (list_seq, sep_list_pair); -- insert separator between two items; returns list_seq[1] then only one item
elseif 2 < count then
list = table.concat (list_seq, sep_list, 1, count - 1); -- concatenate all but last item with plain list separator
list = table.concat ({list, list_seq[count]}, sep_list_end); -- concatenate last item onto end of <list> with final separator
end
return list;
end
end


سطر ٣٤٣: سطر ٢٥٩:
]]
]]


local function select_one (args, aliases_list, error_condition, index)
local function select_one( args, aliases_list, error_condition, index )
local value = nil; -- the value assigned to the selected parameter
local value = nil; -- the value assigned to the selected parameter
local selected = ''; -- the name of the parameter we have chosen
local selected = ''; -- the name of the parameter we have chosen
سطر ٣٥٠: سطر ٢٦٦:
if index ~= nil then index = tostring(index); end
if index ~= nil then index = tostring(index); end


for _, alias in ipairs (aliases_list) do -- for each alias in the aliases list
for _, alias in ipairs( aliases_list ) do -- for each alias in the aliases list
if alias:match ('#') then -- if this alias can be enumerated
if alias:match ('#') then -- if this alias can be enumerated
if '1' == index then -- when index is 1 test for enumerated and non-enumerated aliases
if '1' == index then -- when index is 1 test for enumerated and non-enumerated aliases
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); -- first test for non-enumerated alias
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); -- first test for non-enumerated alias
end
end
value, selected = is_alias_used (args, alias, index, true, value, selected, error_list); -- test for enumerated alias
value, selected = is_alias_used (args, alias, index, true, value, selected, error_list); -- test for enumerated alias
else
else
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); -- test for non-enumerated alias
value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); --test for non-enumerated alias
end
end
end
end


if #error_list > 0 and 'none' ~= error_condition then -- for cases where this code is used outside of extract_names()
if #error_list > 0 and 'none' ~= error_condition then -- for cases where this code is used outside of extract_names()
for i, v in ipairs (error_list) do
local error_str = "";
error_list[i] = wrap_style ('parameter', v);
for _, k in ipairs( error_list ) do
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
error_str = error_str .. wrap_style ('parameter', k);
end
end
table.insert (error_list, wrap_style ('parameter', selected));
if #error_list > 1 then
table.insert (z.message_tail, {set_message (error_condition, {make_sep_list (#error_list, error_list)}, true)});
error_str = error_str .. cfg.messages['parameter-final-separator'];
else
error_str = error_str .. cfg.messages['parameter-pair-separator'];
end
error_str = error_str .. wrap_style ('parameter', selected);
table.insert( z.message_tail, { set_error( error_condition, {error_str}, true ) } );
end
end
سطر ٣٧٩: سطر ٣٠٢:
The str:gsub() returns either A|B froma [[A|B]] or B from [[B]] or B from B (no wikilink markup).
The str:gsub() returns either A|B froma [[A|B]] or B from [[B]] or B from B (no wikilink markup).


In l(), l:gsub() removes the link and pipe (if they exist); the second :gsub() trims whitespace from the label
In l(), l:gsub() removes the link and pipe (if they exist); the second :gsub() trims white space from the label
if str was wrapped in wikilink markup.  Presumably, this is because without wikimarkup in str, there is no match
if str was wrapped in wikilink markup.  Presumably, this is because without wikimarkup in str, there is no match
in the initial gsub, the replacement function l() doesn't get called.
in the initial gsub, the replacement function l() doesn't get called.
سطر ٣٨٦: سطر ٣٠٩:


local function remove_wiki_link (str)
local function remove_wiki_link (str)
return (str:gsub ("%[%[([^%[%]]*)%]%]", function(l)
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub ("^[^|]*|(.*)$", "%1" ):gsub ("^%s*(.-)%s*$", "%1");
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end));
end
end
سطر ٣٩٤: سطر ٣١٧:
--[=[-------------------------< I S _ W I K I L I N K >--------------------------------------------------------
--[=[-------------------------< I S _ W I K I L I N K >--------------------------------------------------------


Determines if str is a wikilink, extracts, and returns the wikilink type, link text, and display text parts.
Determines if str is a wikilink, extracts, and returns the the wikilink type, link text, and display text parts.
If str is a complex wikilink ([[L|D]]):
If str is a complex wikilink ([[L|D]]):
returns wl_type 2 and D and L from [[L|D]];
returns wl_type 2 and D and L from [[L|D]];
سطر ٤٠٢: سطر ٣٢٥:
returns wl_type 0, str as D, and L as empty string.
returns wl_type 0, str as D, and L as empty string.


trims leading and trailing whitespace and pipes from L and D ([[L|]] and [[|D]] are accepted by MediaWiki and
trims leading and trailing white space and pipes from L and D ([[L|]] and [[|D]] are accepted by MediaWiki and
treated like [[D]]; while [[|D|]] is not accepted by MediaWiki, here, we accept it and return D without the pipes).
treated like [[D]]; while [[|D|]] is not accepted by MediaWiki, here, we accept it and return D without the pipes).


سطر ٤١٢: سطر ٣٣٥:


if not str:match ('^%[%[[^%]]+%]%]$') then -- is str some sort of a wikilink (must have some sort of content)
if not str:match ('^%[%[[^%]]+%]%]$') then -- is str some sort of a wikilink (must have some sort of content)
return 0, str, ''; -- not a wikilink; return wl_type as 0, str as D, and empty string as L
return 0, str, ''; -- not a wililink; return wl_type as 0, str as D, and empty string as L
end
end
سطر ٤٢٣: سطر ٣٤٦:
D = mw.text.trim (D, '%s|'); -- trim white space and pipe characters  
D = mw.text.trim (D, '%s|'); -- trim white space and pipe characters  
-- L = L and mw.text.trim (L, '%s|');
return wl_type, D, L or '';
return wl_type, D, L or '';
end
end
سطر ٤٥٠: سطر ٣٧٤:
local flag;
local flag;
while true do
while true do
if argument:find ("'''''", 1, true) then -- bold italic (5)
if argument:find ( "'''''", 1, true ) then -- bold italic (5)
argument, flag = argument:gsub ("%'%'%'%'%'", ""); -- remove all instances of it
argument, flag=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it
elseif argument:find ("''''", 1, true) then -- italic start and end without content (4)
elseif argument:find ( "''''", 1, true ) then -- italic start and end without content (4)
argument, flag=argument:gsub ("%'%'%'%'", "");
argument, flag=argument:gsub("%'%'%'%'", "");
elseif argument:find ("'''", 1, true) then -- bold (3)
elseif argument:find ( "'''", 1, true ) then -- bold (3)
argument, flag=argument:gsub ("%'%'%'", "");
argument, flag=argument:gsub("%'%'%'", "");
elseif argument:find ("''", 1, true) then -- italic (2)
elseif argument:find ( "''", 1, true ) then -- italic (2)
argument, flag = argument:gsub ("%'%'", "");
argument, flag=argument:gsub("%'%'", "");
else
else
break;
break;
سطر ٤٨٣: سطر ٤٠٧:


return {
return {
add_maint_cat = add_maint_cat, -- exported functions
is_set = is_set, -- exported functions
add_prop_cat = add_prop_cat,
in_array = in_array,
substitute = substitute,
error_comment = error_comment,
error_comment = error_comment,
has_accept_as_written = has_accept_as_written,
set_error = set_error,
in_array = in_array,
select_one = select_one,
is_set = is_set,
add_maint_cat = add_maint_cat,
wrap_style = wrap_style,
safe_for_italics = safe_for_italics,
remove_wiki_link = remove_wiki_link,
is_wikilink = is_wikilink,
is_wikilink = is_wikilink,
make_sep_list = make_sep_list,
make_wikilink = make_wikilink,
make_wikilink = make_wikilink,
remove_wiki_link = remove_wiki_link,
safe_for_italics = safe_for_italics,
select_one = select_one,
set_message = set_message,
set_selected_modules = set_selected_modules,
set_selected_modules = set_selected_modules,
strip_apostrophe_markup = strip_apostrophe_markup,
strip_apostrophe_markup = strip_apostrophe_markup,
substitute = substitute,
wrap_style = wrap_style,
z = z, -- exported table
z = z, -- exported table
}
}
مجلوبة من «https://wikiar.org/wiki/خاص:فرق_المحمول/270»