Administrators, upwizcampeditors
0
edits
Chalochatu (talk | contribs) (Created page with " local cs1 ={}; --[[--------------------------< F O R W A R D D E C L A R A T I O N S >-------------------------------------- ]] local dates, year_date_check, reformat_dat...") |
m (1 revision imported) |
||
(One intermediate revision by the same user not shown) | |||
Line 5: | Line 5: | ||
]] | ]] | ||
local dates, year_date_check, reformat_dates, date_hyphen_to_dash -- functions in Module:Citation/CS1/Date_validation | local dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- functions in Module:Citation/CS1/Date_validation | ||
date_name_xlate | |||
local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities | local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities | ||
add_maint_cat, wrap_style, safe_for_italics, | add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink; | ||
local z ={}; -- tables in Module:Citation/CS1/Utilities | local z ={}; -- tables in Module:Citation/CS1/Utilities | ||
local extract_ids, build_id_list, is_embargoed; | local extract_ids, extract_id_access_levels, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers | ||
local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS | local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS | ||
Line 22: | Line 23: | ||
--[[--------------------------< P A G E S C O P E V A R I A B L E S >-------------------------------------- | --[[--------------------------< P A G E S C O P E V A R I A B L E S >-------------------------------------- | ||
delare variables here that have page-wide scope | delare variables here that have page-wide scope that are not brought in from other modules; thatare created here | ||
and used here | |||
]] | ]] | ||
local | local added_deprecated_cat; -- boolean flag so that the category is added only once | ||
local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats | |||
local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category | |||
local Frame; -- holds the module's frame table | |||
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------ | --[[--------------------------< F I R S T _ S E T >------------------------------------------------------------ | ||
Line 48: | Line 55: | ||
end | end | ||
end | end | ||
--[[--------------------------< A D D _ P R O P _ C A T >-------------------------------------------------------- | --[[--------------------------< 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. | 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 function add_prop_cat (key, arguments) | local function add_prop_cat (key, arguments) | ||
if not added_prop_cats [key] then | if not added_prop_cats [key] then | ||
added_prop_cats [key] = true; -- note that we've added this category | added_prop_cats [key] = true; -- note that we've added this category | ||
key = key:gsub ('(foreign_lang_source_?2?)%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 | table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table | ||
end | end | ||
end | end | ||
--[[--------------------------< A D D _ V A N C _ E R R O R >---------------------------------------------------- | --[[--------------------------< A D D _ V A N C _ E R R O R >---------------------------------------------------- | ||
Line 67: | Line 81: | ||
Adds a single Vancouver system error message to the template's output regardless of how many error actually exist. | Adds a single Vancouver system error message to the template's output regardless of how many error actually exist. | ||
To prevent duplication, added_vanc_errs is nil until an error message is emitted. | To prevent duplication, added_vanc_errs is nil until an error message is emitted. | ||
added_vanc_errs is a boolean declared in page scope variables above | |||
]] | ]] | ||
local function add_vanc_error (source) | local function add_vanc_error (source) | ||
if not added_vanc_errs then | if not added_vanc_errs then | ||
Line 118: | Line 133: | ||
the first character of the whole domain name including subdomains must be a letter or a digit | the first character of the whole domain name including subdomains must be a letter or a digit | ||
internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490 | internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490 | ||
single-letter/digit second-level domains in the .org | single-letter/digit second-level domains in the .org and .cash TLDs | ||
q, x, and z SL domains in the .com TLD | q, x, and z SL domains in the .com TLD | ||
i and q SL domains in the .net TLD | i and q SL domains in the .net TLD | ||
Line 145: | Line 160: | ||
elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix | elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix | ||
return true; | return true; | ||
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character .org hostname | elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname | ||
return true; | |||
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character/digit .org hostname | |||
return true; | return true; | ||
elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10) | elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10) | ||
Line 241: | Line 258: | ||
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url | return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url | ||
end | end | ||
--[[--------------------------< L I N K _ T I T L E _ O K >--------------------------------------------------- | --[[--------------------------< L I N K _ T I T L E _ O K >--------------------------------------------------- | ||
Line 368: | Line 386: | ||
['\n'] = ' ' } ); | ['\n'] = ' ' } ); | ||
end | end | ||
--[[--------------------------< E X T E R N A L _ L I N K >---------------------------------------------------- | --[[--------------------------< E X T E R N A L _ L I N K >---------------------------------------------------- | ||
Line 375: | Line 394: | ||
]] | ]] | ||
local function external_link( URL, label, source ) | local function external_link( URL, label, source, access) | ||
local error_str = ""; | local error_str = ""; | ||
local domain; | local domain; | ||
local path; | local path; | ||
local base_url; | |||
if not is_set( label ) then | if not is_set( label ) then | ||
Line 398: | Line 418: | ||
end | end | ||
if is_set (access) then -- access level (subscription, registration, limited) | |||
label = safe_for_url (label); -- replace square brackets and newlines | |||
base_url = table.concat ( -- assemble external link with access signal | |||
{ | |||
'<span class="plainlinks">[', -- opening css and url markup | |||
URL, -- the url | |||
' ', -- the required space | |||
label, | |||
'<span style="padding-left:0.15em">', -- signal spacing css | |||
cfg.presentation[access], -- the appropriate icon | |||
'</span>', -- close signal spacing span | |||
']</span>' -- close url markup and plain links span | |||
}); | |||
else | |||
base_url = table.concat({ "[", URL, " ", safe_for_url( label ), "]" }); -- no signal markup | |||
end | |||
return table.concat({ base_url, error_str }); | |||
end | end | ||
Line 407: | Line 445: | ||
offending parameter name to the error message. Only one error message is emitted regardless of the number of deprecated | offending parameter name to the error message. Only one error message is emitted regardless of the number of deprecated | ||
parameters in the citation. | parameters in the citation. | ||
added_deprecated_cat is a boolean declared in page scope variables above | |||
]] | ]] | ||
local function deprecated_parameter(name) | local function deprecated_parameter(name) | ||
if not | if not added_deprecated_cat then | ||
added_deprecated_cat = true; -- note that we've added this category | |||
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message | table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message | ||
end | end | ||
end | end | ||
Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value. | --[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- | ||
Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote | |||
mark contained in a |title= or |chapter= parameter's value. | |||
This function will positive kern either single or double quotes: | This function will positive kern either single or double quotes: | ||
"'Unkerned title with leading and trailing single quote marks'" | "'Unkerned title with leading and trailing single quote marks'" | ||
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example) | " 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example) | ||
Double single quotes (italic or bold wikimarkup) are not kerned. | Double single quotes (italic or bold wikimarkup) are not kerned. | ||
Replaces unicode quotemarks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter | |||
quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks. | |||
Call this function for chapter titles, for website titles, etc; not for book titles. | Call this function for chapter titles, for website titles, etc; not for book titles. | ||
]] | ]=] | ||
local function kern_quotes (str) | local function kern_quotes (str) | ||
local cap=''; | local cap=''; | ||
local cap2=''; | local cap2=''; | ||
local wl_type, label, link; | |||
wl_type, label, link = is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] | |||
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks | |||
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks | |||
str = substitute (cfg.presentation['kern-wl-both'], str); | |||
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks | |||
str = substitute (cfg.presentation['kern-wl-left'], str); | |||
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks | |||
str = substitute (cfg.presentation['kern-wl-right'], str); | |||
end | |||
else -- plain text or [[L|D]]; text in label variable | |||
label= mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark) | |||
label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark) | |||
cap, cap2 = | cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) | ||
if is_set (cap) then | |||
label = substitute (cfg.presentation['kern-left'], {cap, cap2}); | |||
end | |||
cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) | |||
if is_set (cap) then | |||
label = substitute (cfg.presentation['kern-right'], {cap, cap2}); | |||
end | |||
if 2 == wl_type then | |||
str = make_wikilink (link, label); -- reassemble the wikilink | |||
else | |||
str = label; | |||
end | |||
end | end | ||
return str; | return str; | ||
end | end | ||
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >---------------------------------------- | --[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >---------------------------------------- | ||
Line 480: | Line 549: | ||
end | end | ||
-- if we get this far we have prefix and script | -- if we get this far we have prefix and script | ||
name = mw.language.fetchLanguageName( lang, "en" ); | name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize | ||
if is_set (name) then -- is prefix a proper ISO 639-1 language code? | if is_set (name) then -- is prefix a proper ISO 639-1 language code? | ||
script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script | script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script | ||
Line 498: | Line 567: | ||
return script_value; | return script_value; | ||
end | end | ||
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------ | --[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------ | ||
Line 545: | Line 615: | ||
]] | ]] | ||
local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes) | local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access) | ||
local chapter_error = ''; | local chapter_error = ''; | ||
Line 552: | Line 622: | ||
else | else | ||
if false == no_quotes then | if false == no_quotes then | ||
chapter = kern_quotes (chapter); | chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks | ||
chapter = wrap_style ('quoted-title', chapter); | chapter = wrap_style ('quoted-title', chapter); | ||
end | end | ||
Line 558: | Line 628: | ||
chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
if is_set (chapterurl) then | |||
chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | |||
end | |||
if is_set (transchapter) then | if is_set (transchapter) then | ||
Line 569: | Line 643: | ||
end | end | ||
-- if is_set (chapterurl) then | |||
-- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | |||
-- end | |||
return chapter .. chapter_error; | return chapter .. chapter_error; | ||
end | end | ||
--[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >---------------------------------------- | --[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >---------------------------------------- | ||
Line 610: | Line 685: | ||
local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it | local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it | ||
position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern | position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern | ||
if position and (char == 'zero width joiner') then -- if we found a zero width joiner character | |||
if mw.ustring.find (v, cfg.indic_script) then -- its ok if one of the indic scripts | |||
position = nil; -- unset position | |||
end | |||
end | |||
if position then | if position then | ||
Line 681: | Line 762: | ||
}); | }); | ||
end | end | ||
--[[--------------------------< V A L I D A T E >-------------------------------------------------------------- | --[[--------------------------< V A L I D A T E >-------------------------------------------------------------- | ||
Looks for a parameter's name in | |||
Looks for a parameter's name in one of several whitelists. | |||
Parameters in the whitelist can have three values: | Parameters in the whitelist can have three values: | ||
Line 692: | Line 775: | ||
]] | ]] | ||
local function validate( name ) | local function validate( name, cite_class ) | ||
local name = tostring( name ); | local name = tostring( name ); | ||
local state | local state; | ||
-- | if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- limited parameter sets allowed for these templates | ||
if true == state then return true; end | state = whitelist.limited_basic_arguments[ name ]; | ||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | |||
deprecated_parameter (name); -- parameter is deprecated but still supported | |||
return true; | |||
end | |||
if 'arxiv' == cite_class then -- basic parameters unique to these templates | |||
state = whitelist.arxiv_basic_arguments[name]; | |||
end | |||
if 'biorxiv' == cite_class then | |||
state = whitelist.biorxiv_basic_arguments[name]; | |||
end | |||
if 'citeseerx' == cite_class then | |||
state = whitelist.citeseerx_basic_arguments[name]; | |||
end | |||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | |||
deprecated_parameter (name); -- parameter is deprecated but still supported | |||
return true; | |||
end | |||
-- limited enumerated parameters list | |||
name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) | |||
state = whitelist.limited_numbered_arguments[ name ]; | |||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | |||
deprecated_parameter (name); -- parameter is deprecated but still supported | |||
return true; | |||
end | |||
return false; -- not supported because not found or name is set to nil | |||
end -- end limited parameter-set templates | |||
state = whitelist.basic_arguments[ name ]; -- all other templates; all normal parameters allowed | |||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | if false == state then | ||
deprecated_parameter (name); | deprecated_parameter (name); -- parameter is deprecated but still supported | ||
return true; | return true; | ||
end | end | ||
-- all enumerated parameters allowed | |||
name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) | |||
name = name:gsub( "%d+", "#" ); | |||
state = whitelist.numbered_arguments[ name ]; | state = whitelist.numbered_arguments[ name ]; | ||
if true == state then return true; end | |||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | if false == state then | ||
deprecated_parameter (name); | deprecated_parameter (name); -- parameter is deprecated but still supported | ||
return true; | return true; | ||
end | end | ||
return false; | return false; -- not supported because not found or name is set to nil | ||
end | end | ||
Line 739: | Line 858: | ||
return date; | return date; | ||
end | end | ||
--[[--------------------------< S E T _ T I T L E T Y P E >---------------------------------------------------- | --[[--------------------------< S E T _ T I T L E T Y P E >---------------------------------------------------- | ||
Line 780: | Line 900: | ||
local function safe_join( tbl, duplicate_char ) | local function safe_join( tbl, duplicate_char ) | ||
-- | local f = {}; -- create a function table appropriate to type of 'dupicate character' | ||
if 1 == #duplicate_char then -- for single byte ascii characters use the string library functions | |||
f.gsub=string.gsub | |||
f.match=string.match | |||
f.sub=string.sub | |||
else -- for multi-byte characters use the ustring library functions | |||
f.gsub=mw.ustring.gsub | |||
f.match=mw.ustring.match | |||
f.sub=mw.ustring.sub | |||
end | |||
local str = ''; -- the output string | local str = ''; -- the output string | ||
local comp = ''; -- what does 'comp' mean? | local comp = ''; -- what does 'comp' mean? | ||
Line 804: | Line 927: | ||
end | end | ||
-- typically duplicate_char is sepc | -- typically duplicate_char is sepc | ||
if | if f.sub(comp, 1,1) == duplicate_char then -- is first character same as duplicate_char? why test first character? | ||
-- Because individual string segments often (always?) begin with terminal punct for | -- Because individual string segments often (always?) begin with terminal punct for the | ||
-- preceding segment: 'First element' .. 'sepc next element' .. etc? | -- preceding segment: 'First element' .. 'sepc next element' .. etc? | ||
trim = false; | trim = false; | ||
end_chr = | end_chr = f.sub(str, -1,-1); -- get the last character of the output string | ||
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff? | -- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff? | ||
if end_chr == duplicate_char then -- if same as separator | if end_chr == duplicate_char then -- if same as separator | ||
str = | str = f.sub(str, 1,-2); -- remove it | ||
elseif end_chr == "'" then -- if it might be wikimarkup | elseif end_chr == "'" then -- if it might be wikimarkup | ||
if | if f.sub(str, -3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc'' | ||
str = | str = f.sub(str, 1, -4) .. "''"; -- remove them and add back '' | ||
elseif | elseif f.sub(str, -5,-1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]'' | ||
trim = true; -- why? why do this and next differently from previous? | trim = true; -- why? why do this and next differently from previous? | ||
elseif | elseif f.sub(str, -4,-1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]'' | ||
trim = true; -- same question | trim = true; -- same question | ||
end | end | ||
elseif end_chr == "]" then -- if it might be wikimarkup | elseif end_chr == "]" then -- if it might be wikimarkup | ||
if | if f.sub(str, -3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink | ||
trim = true; | |||
elseif f.sub(str, -3,-1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link | |||
trim = true; | trim = true; | ||
elseif | elseif f.sub(str, -2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link | ||
trim = true; | trim = true; | ||
elseif | elseif f.sub(str, -4,-1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title. | ||
trim = true; | trim = true; | ||
end | end | ||
elseif end_chr == " " then -- if last char of output string is a space | elseif end_chr == " " then -- if last char of output string is a space | ||
if | if f.sub(str, -2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> | ||
str = | str = f.sub(str, 1,-3); -- remove them both | ||
end | end | ||
end | end | ||
Line 837: | Line 962: | ||
if value ~= comp then -- value does not equal comp when value contains html markup | if value ~= comp then -- value does not equal comp when value contains html markup | ||
local dup2 = duplicate_char; | local dup2 = duplicate_char; | ||
if | if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it | ||
value = | value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup | ||
else | else | ||
value = | value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character | ||
end | end | ||
end | end | ||
Line 849: | Line 974: | ||
end | end | ||
return str; | return str; | ||
end | end | ||
Line 864: | Line 989: | ||
return false; | return false; | ||
end | end | ||
--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >-------------------------------------------- | --[[--------------------------< I S _ G O O D _ V A N C _ N A M E >-------------------------------------------- | ||
Line 887: | Line 1,013: | ||
to use an external editor to maintain this code. | to use an external editor to maintain this code. | ||
\195\128-\195\150 – À-Ö | \195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls) | ||
\195\152-\195\182 – Ø-ö | \195\152-\195\182 – Ø-ö (U+00D8-U+00F6 – C0 controls) | ||
\195\184-\198\191 – ø-ƿ | \195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B) | ||
\199\132-\201\143 – DŽ-ɏ | \199\132-\201\143 – DŽ-ɏ (U+01C4-U+024F – Latin extended B) | ||
]] | ]] | ||
Line 910: | Line 1,036: | ||
return true; | return true; | ||
end | end | ||
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------ | --[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------ | ||
Line 932: | Line 1,059: | ||
if name then -- if first is initials with or without suffix | if name then -- if first is initials with or without suffix | ||
if 3 > | if 3 > mw.ustring.len (name) then -- if one or two initials | ||
if suffix then -- if there is a suffix | if suffix then -- if there is a suffix | ||
if is_suffix (suffix) then -- is it legitimate? | if is_suffix (suffix) then -- is it legitimate? | ||
Line 966: | Line 1,093: | ||
end | end | ||
return table.concat(initials) -- Vancouver format does not include spaces. | return table.concat(initials) -- Vancouver format does not include spaces. | ||
end | end | ||
--[[--------------------------< L I S T _ P E O P L E >------------------------------------------------------- | --[[--------------------------< L I S T _ P E O P L E >------------------------------------------------------- | ||
Line 989: | Line 1,112: | ||
if 'vanc' == format then -- Vancouver-like author/editor name styling? | if 'vanc' == format then -- Vancouver-like author/editor name styling? | ||
sep = ' | sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma | ||
namesep = ' '; | namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space | ||
else | else | ||
sep = '; | sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon | ||
namesep = ' | namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space> | ||
end | end | ||
Line 1,018: | Line 1,141: | ||
one = person.last | one = person.last | ||
local first = person.first | local first = person.first | ||
if is_set(first) then | if is_set(first) then | ||
if ( "vanc" == format ) then -- if vancouver format | if ( "vanc" == format ) then -- if vancouver format | ||
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) | one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) | ||
if not person.corporate and is_good_vanc_name (one, first) then | if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested | ||
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials | first = reduce_to_initials(first) -- attempt to convert first name(s) to initials | ||
end | end | ||
end | end | ||
one = one .. namesep .. first | one = one .. namesep .. first; | ||
end | end | ||
if is_set(person.link) and person.link ~= control.page_name then | if is_set(person.link) and person.link ~= control.page_name then | ||
one = | one = make_wikilink (person.link, one); -- link author/editor if this page is not the author's/editor's page | ||
end | end | ||
end | end | ||
Line 1,051: | Line 1,174: | ||
return result, count | return result, count | ||
end | end | ||
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------ | --[[--------------------------< A N C H O R _ I D >------------------------------------------------------------ | ||
Line 1,108: | Line 1,232: | ||
end | end | ||
--[[--------------------------< N A M E _ H A S _ M U L T _ N A M E S >---------------------------------------- | |||
--[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------ | |||
Evaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc. | |||
These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function | |||
adds the editor markup maintenance category. | |||
]] | |||
local function name_has_ed_markup (name, list_name) | |||
local _, pattern; | |||
local patterns = { -- these patterns match annotations at end of name | |||
'%f[%(%[][%(%[]%s*[Ee][Dd][Ss]?%.?%s*[%)%]]?$', -- (ed) or (eds): leading '(', case insensitive 'ed', optional 's', '.' and/or ')' | |||
'[,%.%s]%f[e]eds?%.?$', -- ed or eds: without '('or ')'; case sensitive (ED could be initials Ed could be name) | |||
'%f[%(%[][%(%[]%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.?%s*[%)%]]?$', -- (editor) or (editors): leading '(', case insensitive, optional '.' and/or ')' | |||
'[,%.%s]%f[Ee][Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.?$', -- editor or editors: without '('or ')'; case insensitive | |||
-- these patterns match annotations at beginning of name | |||
'^eds?[%.,;]', -- ed. or eds.: lower case only, optional 's', requires '.' | |||
'^[%(%[]%s*[Ee][Dd][Ss]?%.?%s*[%)%]]', -- (ed) or (eds): also sqare brackets, case insensitive, optional 's', '.' | |||
'^[%(%[]?%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%A', -- (editor or (editors: also sq brackets, case insensitive, optional brackets, 's' | |||
'^[%(%[]?%s*[Ee][Dd][Ii][Tt][Ee][Dd]%A', -- (edited: also sq brackets, case insensitive, optional brackets | |||
} | |||
if is_set (name) then | |||
for _, pattern in ipairs (patterns) do -- spin through patterns table and | |||
if name:match (pattern) then | |||
add_maint_cat ('extra_text_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template | |||
break; | |||
end | |||
end | |||
end | |||
return name; -- and done | |||
end | |||
--[[--------------------------< N A M E _ H A S _ M U L T _ N A M E S >---------------------------------------- | |||
Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are | Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are | ||
Line 1,119: | Line 1,279: | ||
local count, _; | local count, _; | ||
if is_set (name) then | if is_set (name) then | ||
_, count = name:gsub ('[;,]', ''); -- count the number of separator-like characters | |||
if 1 < count then -- param could be |author= or |editor= so one separator character is acceptable | |||
add_maint_cat ('mult_names', cfg.special_case_translation [list_name]); -- more than one separator indicates multiple names so add a maint cat for this template | |||
end | end | ||
end | end | ||
return name; -- and done | return name; -- and done | ||
end | end | ||
--[[--------------------------< N A M E _ C H E C K S >-------------------------------------------------------- | |||
This function calls various name checking functions used to validate the content of the various name-holding | |||
parameters. | |||
]] | |||
local function name_checks (last, first, list_name) | |||
if is_set (last) then | |||
if last:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written | |||
last = last:match ('^%(%((.*)%)%)$'); -- strip parens | |||
else | |||
last = name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only) | |||
last = name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation | |||
end | |||
end | |||
if is_set (first) then | |||
if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written | |||
first = first:match ('^%(%((.*)%)%)$'); -- strip parens | |||
else | |||
first = name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation | |||
end | |||
end | |||
return last, first; -- done | |||
end | |||
--[[--------------------------< E X T R A C T _ N A M E S >---------------------------------------------------- | --[[--------------------------< E X T R A C T _ N A M E S >---------------------------------------------------- | ||
Line 1,168: | Line 1,351: | ||
last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al. | last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al. | ||
first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al. | first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al. | ||
last = | last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks | ||
if first and not last then -- if there is a firstn without a matching lastn | if first and not last then -- if there is a firstn without a matching lastn | ||
Line 1,192: | Line 1,375: | ||
return names, etal; -- all done, return our list of names | return names, etal; -- all done, return our list of names | ||
end | end | ||
--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------ | --[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------ | ||
Line 1,202: | Line 1,386: | ||
return the original language name string. | return the original language name string. | ||
mw.language.fetchLanguageNames(<local wiki language>, 'all') | mw.language.fetchLanguageNames(<local wiki language>, 'all') returns a list of languages that in some cases may include | ||
extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support | extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support | ||
code 'cbk' or name 'Chavacano'. | code 'cbk' or name 'Chavacano'. Most (all?) of these languages are not used a 'language' codes per se, rather they | ||
are used as sub-domain names: cbk-zam.wikipedia.org. These names can be found (for the time being) at | |||
https://phabricator.wikimedia.org/diffusion/ECLD/browse/master/LocalNames/LocalNamesEn.php | |||
Names but that are included in the list will be found if that name is provided in the |language= parameter. For example, | Names but that are included in the list will be found if that name is provided in the |language= parameter. For example, | ||
Line 1,215: | Line 1,401: | ||
local function get_iso639_code (lang, this_wiki_code) | local function get_iso639_code (lang, this_wiki_code) | ||
if cfg.lang_name_remap[lang:lower()] then -- if there is a remapped name (because MediaWiki uses something that we don't think is correct) | |||
return cfg.lang_name_remap[lang:lower()][1], cfg.lang_name_remap[lang:lower()][2]; -- for this language 'name', return a possibly new name and appropriate code | |||
end | |||
local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia | local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia | ||
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa) | -- ('all' is required for North Ndebele, South Ndebele, and Ojibwa) | ||
Line 1,229: | Line 1,419: | ||
return lang; -- not valid language; return language in original case and nil for the code | return lang; -- not valid language; return language in original case and nil for the code | ||
end | end | ||
--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------ | --[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------ | ||
Line 1,266: | Line 1,457: | ||
if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code | if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code | ||
name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code | name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code | ||
if not is_set (name) then | |||
name = cfg.lang_code_remap[lang]; -- not supported by MediaWiki; is it in remap? | |||
end | |||
end | end | ||
Line 1,275: | Line 1,469: | ||
if is_set (code) then -- only 2- or 3-character codes | if is_set (code) then -- only 2- or 3-character codes | ||
name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names | |||
if this_wiki_code ~= code then -- when the language is not the same as this wiki's language | if this_wiki_code ~= code then -- when the language is not the same as this wiki's language | ||
if 2 == code:len() then -- and is a two-character code | if 2 == code:len() then -- and is a two-character code | ||
add_prop_cat ('foreign_lang_source', {name, code}) | add_prop_cat ('foreign_lang_source' .. code, {name, code}) -- categorize it | ||
else -- or is a recognized language (but has a three-character code) | else -- or is a recognized language (but has a three-character code) | ||
add_prop_cat ('foreign_lang_source_2', {code}) | add_prop_cat ('foreign_lang_source_2' .. code, {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template | ||
end | end | ||
end | end | ||
Line 1,301: | Line 1,497: | ||
end | end | ||
return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)' | return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)' | ||
--[[ TODO: should only return blank or name rather than full list | |||
so we can clean up the bunched parenthetical elements Language, Type, Format | |||
]] | |||
end | end | ||
--[[--------------------------< S E T _ C S 1 _ S T Y L E >---------------------------------------------------- | --[[--------------------------< S E T _ C S 1 _ S T Y L E >---------------------------------------------------- | ||
Set style settings for CS1 citation templates. Returns separator and postscript settings | Set style settings for CS1 citation templates. Returns separator and postscript settings | ||
At en.wiki, for cs1: | |||
ps gets: '.' | |||
sep gets: '.' | |||
]] | ]] | ||
Line 1,311: | Line 1,514: | ||
local function set_cs1_style (ps) | local function set_cs1_style (ps) | ||
if not is_set (ps) then -- unless explicitely set to something | if not is_set (ps) then -- unless explicitely set to something | ||
ps = ' | ps = cfg.presentation['ps_cs1']; -- terminate the rendered citation | ||
end | end | ||
return ' | return cfg.presentation['sep_cs1'], ps; -- element separator | ||
end | end | ||
--[[--------------------------< S E T _ C S 2 _ S T Y L E >---------------------------------------------------- | --[[--------------------------< S E T _ C S 2 _ S T Y L E >---------------------------------------------------- | ||
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings | Set style settings for CS2 citation templates. Returns separator, postscript, ref settings | ||
At en.wiki, for cs2: | |||
ps gets: '' (empty string - no terminal punctuation) | |||
sep gets: ',' | |||
]] | ]] | ||
Line 1,324: | Line 1,531: | ||
local function set_cs2_style (ps, ref) | local function set_cs2_style (ps, ref) | ||
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default | if not is_set (ps) then -- if |postscript= has not been set, set cs2 default | ||
ps = ''; | ps = cfg.presentation['ps_cs2']; -- terminate the rendered citation | ||
end | end | ||
if not is_set (ref) then -- if |ref= is not set | if not is_set (ref) then -- if |ref= is not set | ||
ref = "harv"; -- set default |ref=harv | ref = "harv"; -- set default |ref=harv | ||
end | end | ||
return ' | return cfg.presentation['sep_cs2'], ps, ref; -- element separator | ||
end | end | ||
--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >---------------------- | --[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >---------------------- | ||
Line 1,349: | Line 1,557: | ||
return sep, ps, ref -- return them all | return sep, ps, ref -- return them all | ||
end | end | ||
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------ | --[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------ | ||
Line 1,372: | Line 1,581: | ||
return sep, ps, ref | return sep, ps, ref | ||
end | end | ||
--[=[-------------------------< I S _ P D F >------------------------------------------------------------------ | --[=[-------------------------< I S _ P D F >------------------------------------------------------------------ | ||
Line 1,378: | Line 1,588: | ||
applying the pdf icon to external links. | applying the pdf icon to external links. | ||
returns true if file extension is one of the recognized | returns true if file extension is one of the recognized extensions, else false | ||
]=] | ]=] | ||
local function is_pdf (url) | local function is_pdf (url) | ||
return url:match ('%.pdf[%?#] | return url:match ('%.pdf$') or url:match ('%.PDF$') or url:match ('%.pdf[%?#]') or url:match ('%.PDF[%?#]'); | ||
end | end | ||
--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ | --[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ | ||
Line 1,397: | Line 1,608: | ||
local function style_format (format, url, fmt_param, url_param) | local function style_format (format, url, fmt_param, url_param) | ||
if is_set (format) then | if is_set (format) then | ||
format = wrap_style ('format', format); -- add leading space, | format = wrap_style ('format', format); -- add leading space, parentheses, resize | ||
if not is_set (url) then | if not is_set (url) then | ||
format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message | format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message | ||
Line 1,408: | Line 1,619: | ||
return format; | return format; | ||
end | end | ||
--[[--------------------------< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >------------------------ | --[[--------------------------< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >------------------------ | ||
Line 1,440: | Line 1,652: | ||
max = tonumber (max); -- make it a number | max = tonumber (max); -- make it a number | ||
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors | if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors | ||
add_maint_cat ('disp_auth_ed', list_name); | add_maint_cat ('disp_auth_ed', cfg.special_case_translation [list_name]); | ||
end | end | ||
else -- not a valid keyword or number | else -- not a valid keyword or number | ||
Line 1,450: | Line 1,662: | ||
return max, etal; | return max, etal; | ||
end | end | ||
--[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------ | --[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------ | ||
Line 1,463: | Line 1,676: | ||
local function extra_text_in_page_check (page) | local function extra_text_in_page_check (page) | ||
local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg? | local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg? | ||
local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; | local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; | ||
Line 1,471: | Line 1,682: | ||
add_maint_cat ('extra_text'); | add_maint_cat ('extra_text'); | ||
end | end | ||
-- | end | ||
-- | |||
-- | |||
-- end | --[=[-------------------------< G E T _ V _ N A M E _ T A B L E >---------------------------------------------- | ||
split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled | |||
parentheses to also have commas; in the old version of the code, the doubled parnetheses were included in the | |||
rendered citation and in the metadata. Individual author names may be wikilinked | |||
|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.)) | |||
]=] | |||
local function get_v_name_table (vparam, output_table, output_link_table) | |||
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas | |||
local wl_type, label, link; -- wl_type not used here; just a place holder | |||
local i = 1; | |||
while name_table[i] do | |||
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parens | |||
local name = name_table[i]; | |||
i=i+1; -- bump indexer to next segment | |||
while name_table[i] do | |||
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments | |||
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens | |||
break; -- and done reassembling so | |||
end | |||
i=i+1; -- bump indexer | |||
end | |||
table.insert (output_table, name); -- and add corporate name to the output table | |||
table.insert (output_link_table, ''); -- no wikilink | |||
else | |||
wl_type, label, link = is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]] | |||
table.insert (output_table, label); -- add this name | |||
if 1 == wl_type then | |||
table.insert (output_link_table, label); -- simple wikilink [[D]] | |||
else | |||
table.insert (output_link_table, link); -- no wikilink or [[L|D]]; add this link if there is one, else empty string | |||
end | |||
end | |||
i = i+1; | |||
end | |||
return output_table; | |||
end | end | ||
Line 1,496: | Line 1,747: | ||
local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn= | local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn= | ||
local v_name_table = {}; | local v_name_table = {}; | ||
local v_link_table = {}; -- when name is wikilinked, targets go in this table | |||
local etal = false; -- return value set to true when we find some form of et al. vauthors parameter | local etal = false; -- return value set to true when we find some form of et al. vauthors parameter | ||
local last, first, link, mask, suffix; | local last, first, link, mask, suffix; | ||
Line 1,501: | Line 1,753: | ||
vparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (do it here because et al. might have a period) | vparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (do it here because et al. might have a period) | ||
v_name_table = get_v_name_table (vparam, v_name_table, v_link_table); -- names are separated by commas | |||
v_name_table = | |||
for i, v_name in ipairs(v_name_table) do | for i, v_name in ipairs(v_name_table) do | ||
Line 1,544: | Line 1,793: | ||
end | end | ||
else | else | ||
is_good_vanc_name (last, ''); | if not corporate then | ||
is_good_vanc_name (last, ''); | |||
end | |||
end | end | ||
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ) or v_link_table[i]; | |||
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ); | |||
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i ); | mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i ); | ||
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list | names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list | ||
Line 1,555: | Line 1,804: | ||
return names, etal; -- all done, return our list of names | return names, etal; -- all done, return our list of names | ||
end | end | ||
--[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------------------ | --[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------------------ | ||
Line 1,576: | Line 1,826: | ||
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name) | local function select_author_editor_source (vxxxxors, xxxxors, args, list_name) | ||
local lastfirst = false; | local lastfirst = false; | ||
if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a | if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a |first1= without a |last1=; this ... | ||
select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) then | select_one( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors= | ||
select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or | |||
select_one( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then | |||
lastfirst=true; | lastfirst=true; | ||
end | end | ||
Line 1,605: | Line 1,857: | ||
This function is used to validate a parameter's assigned value for those parameters that have only a limited number | This function is used to validate a parameter's assigned value for those parameters that have only a limited number | ||
of allowable values (yes, y, true, no, etc). When the parameter value has not been assigned a value (missing or empty | of allowable values (yes, y, true, no, etc). When the parameter value has not been assigned a value (missing or empty | ||
in the source template) the function | in the source template) the function returns true. If the parameter value is one of the list of allowed values returns | ||
true; else, emits an error message and returns false. | true; else, emits an error message and returns false. | ||
Line 1,632: | Line 1,884: | ||
local function terminate_name_list (name_list, sepc) | local function terminate_name_list (name_list, sepc) | ||
if (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char | if (string.sub (name_list,-3,-1) == sepc .. '. ') then -- if already properly terminated | ||
return name_list; -- just return the name list | |||
elseif (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char | |||
return name_list .. " "; -- don't add another | return name_list .. " "; -- don't add another | ||
else | else | ||
Line 1,661: | Line 1,915: | ||
end | end | ||
end | end | ||
local vol = ''; | local vol = ''; | ||
Line 1,668: | Line 1,922: | ||
vol = substitute (cfg.messages['j-vol'], {sepc, volume}); | vol = substitute (cfg.messages['j-vol'], {sepc, volume}); | ||
else | else | ||
vol = | vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); | ||
end | end | ||
end | end | ||
Line 1,677: | Line 1,931: | ||
end | end | ||
--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >----------------------------------------- | --[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >----------------------------------------- | ||
Line 1,727: | Line 1,959: | ||
end | end | ||
local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'journal' == origin); | local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin); | ||
if is_set (page) then | if is_set (page) then | ||
if is_journal then | if is_journal then | ||
Line 1,790: | Line 2,022: | ||
local path, timestamp, flag; -- portions of the archive.or url | local path, timestamp, flag; -- portions of the archive.or url | ||
if not url:match('//web%.archive%.org/') then | if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url | ||
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate | return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate | ||
end | end | ||
if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page | if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page | ||
err_msg = 'save command'; | |||
if | url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL | ||
elseif url:match('//liveweb%.archive%.org/') then | |||
err_msg = 'liveweb'; | |||
else | |||
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation | |||
if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here | |||
err_msg = 'timestamp'; | |||
if '*' ~= flag then | |||
url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat) | |||
end | |||
elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element | |||
err_msg = 'path'; | |||
elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element) | |||
err_msg = 'flag'; | |||
elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element) | |||
err_msg = 'flag'; | |||
else | else | ||
return | return url, date; -- return archiveURL and ArchiveDate | ||
end | end | ||
end | end | ||
-- if here, something not right so | |||
-- if | table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and | ||
if is_set (Frame:preprocess('{{REVISIONID}}')) then | |||
return '', ''; -- return empty strings for archiveURL and ArchiveDate | |||
if | |||
else | else | ||
return url, date; -- preview mode so return archiveURL and ArchiveDate | return url, date; -- preview mode so return archiveURL and ArchiveDate | ||
end | end | ||
end | end | ||
Line 1,875: | Line 2,100: | ||
-- Pick out the relevant fields from the arguments. Different citation templates | -- Pick out the relevant fields from the arguments. Different citation templates | ||
-- define different field names for the same underlying things. | -- define different field names for the same underlying things. | ||
local author_etal; | |||
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= | -- set default parameter values defined by |mode= parameter. | ||
local Authors; | local Mode = A['Mode']; | ||
local NameListFormat = A['NameListFormat']; | if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then | ||
local Collaboration = A['Collaboration']; | Mode = ''; | ||
end | |||
local author_etal; | |||
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= | |||
local Authors; | |||
local NameListFormat = A['NameListFormat']; | |||
local Collaboration = A['Collaboration']; | |||
do -- to limit scope of selected | do -- to limit scope of selected | ||
Line 1,890: | Line 2,122: | ||
elseif 3 == selected then | elseif 3 == selected then | ||
Authors = A['Authors']; -- use content of |authors= | Authors = A['Authors']; -- use content of |authors= | ||
if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors= | |||
add_maint_cat ('authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO: | |||
end | |||
end | end | ||
if is_set (Collaboration) then | if is_set (Collaboration) then | ||
Line 1,896: | Line 2,131: | ||
end | end | ||
local Others = A['Others']; | local Others = A['Others']; | ||
Line 1,912: | Line 2,146: | ||
elseif 3 == selected then | elseif 3 == selected then | ||
Editors = A['Editors']; -- use content of |editors= | Editors = A['Editors']; -- use content of |editors= | ||
add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged | |||
end | end | ||
end | end | ||
Line 1,918: | Line 2,153: | ||
local Translators; -- assembled translators name list | local Translators; -- assembled translators name list | ||
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn= | t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn= | ||
local interviewers_list = {}; | |||
local Interviewers = A['Interviewers'] | |||
if is_set (Interviewers) then -- add a maint cat if the |interviewers= is used | |||
add_maint_cat ('interviewers'); -- because use of this parameter is discouraged | |||
else | |||
interviewers_list = extract_names (args, 'InterviewerList'); -- else, process preferred interviewers parameters | |||
end | |||
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs | local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs | ||
local Contributors; -- assembled contributors name list | local Contributors; -- assembled contributors name list | ||
Line 1,998: | Line 2,241: | ||
local At; | local At; | ||
if in_array (config.CitationClass, cfg.templates_using_volume | if in_array (config.CitationClass, cfg.templates_using_volume) then | ||
Volume = A['Volume']; | Volume = A['Volume']; | ||
end | end | ||
-- conference & map books do not support issue | |||
if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then | if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then | ||
Issue = A['Issue']; | Issue = A['Issue']; | ||
Line 2,020: | Line 2,264: | ||
RegistrationRequired=nil; | RegistrationRequired=nil; | ||
end | end | ||
local SubscriptionRequired = A['SubscriptionRequired']; | local SubscriptionRequired = A['SubscriptionRequired']; | ||
if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then | if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then | ||
SubscriptionRequired=nil; | SubscriptionRequired=nil; | ||
end | |||
local UrlAccess = A['UrlAccess']; | |||
if not is_valid_parameter_value (UrlAccess, 'url-access', cfg.keywords ['url-access']) then | |||
UrlAccess = nil; | |||
end | |||
if not is_set(URL) and is_set(UrlAccess) then | |||
UrlAccess = nil; | |||
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } ); | |||
end | |||
if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set | |||
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message | |||
SubscriptionRequired = nil; -- unset; prefer |access= over |subscription= | |||
end | |||
if is_set (UrlAccess) and is_set (RegistrationRequired) then -- these are not the same but contradictory so if both are set | |||
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'registration')}, true ) } ); -- add error message | |||
RegistrationRequired = nil; -- unset; prefer |access= over |registration= | |||
end | |||
local ChapterUrlAccess = A['ChapterUrlAccess']; | |||
if not is_valid_parameter_value (ChapterUrlAccess, 'chapter-url-access', cfg.keywords ['url-access']) then -- same as url-access | |||
ChapterUrlAccess = nil; | |||
end | |||
if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then | |||
ChapterUrlAccess = nil; | |||
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'chapter-url'}, true ) } ); | |||
end | end | ||
Line 2,043: | Line 2,315: | ||
local ID_list = extract_ids( args ); | local ID_list = extract_ids( args ); | ||
local ID_access_levels = extract_id_access_levels( args, ID_list ); | |||
local Quote = A['Quote']; | local Quote = A['Quote']; | ||
Line 2,056: | Line 2,329: | ||
local LastAuthorAmp = A['LastAuthorAmp']; | local LastAuthorAmp = A['LastAuthorAmp']; | ||
if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then | if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then | ||
LastAuthorAmp = nil; | LastAuthorAmp = nil; -- set to empty string | ||
end | end | ||
local no_tracking_cats = A['NoTracking']; | local no_tracking_cats = A['NoTracking']; | ||
if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then | if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then | ||
Line 2,063: | Line 2,337: | ||
end | end | ||
--local variables that are not cs1 parameters | |||
--local variables that are not cs1 parameters | |||
local use_lowercase; -- controls capitalization of certain static text | local use_lowercase; -- controls capitalization of certain static text | ||
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language | local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language | ||
Line 2,079: | Line 2,348: | ||
end | end | ||
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma | local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma | ||
local PostScript; | local PostScript; | ||
Line 2,090: | Line 2,354: | ||
use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text | use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text | ||
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | ||
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page | if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page | ||
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then | if in_array (this_page.nsText, cfg.uncategorized_namespaces) then | ||
Line 2,103: | Line 2,367: | ||
end | end | ||
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) | -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) | ||
select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category | select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category | ||
Line 2,126: | Line 2,390: | ||
end | end | ||
-- both |publication-place= and |place= (|location=) allowed if different | -- both |publication-place= and |place= (|location=) allowed if different | ||
if not is_set(PublicationPlace) and is_set(Place) then | if not is_set(PublicationPlace) and is_set(Place) then | ||
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place | PublicationPlace = Place; -- promote |place= (|location=) to |publication-place | ||
Line 2,133: | Line 2,397: | ||
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same | if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same | ||
--[[ | --[[ | ||
Parameter remapping for cite encyclopedia: | Parameter remapping for cite encyclopedia: | ||
When the citation has these parameters: | When the citation has these parameters: | ||
|encyclopedia and |title then map |title to |article and |encyclopedia to |title | |||
|encyclopedia and |article then map |encyclopedia to |title | |||
|encyclopedia then map |encyclopedia to |title | |||
|trans-title maps to |trans-chapter when |title is re-mapped | |||
|url maps to |chapterurl when |title is remapped | |||
All other combinations of |encyclopedia, |title, and |article are not modified | All other combinations of |encyclopedia, |title, and |article are not modified | ||
]] | ]] | ||
local Encyclopedia = A['Encyclopedia']; | local Encyclopedia = A['Encyclopedia']; | ||
Line 2,157: | Line 2,421: | ||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | |||
if not is_set (ChapterURL) and is_set (TitleLink) then | if not is_set (ChapterURL) and is_set (TitleLink) then | ||
Chapter= | Chapter = make_wikilink (TitleLink, Chapter); | ||
end | end | ||
Title = Periodical; | Title = Periodical; | ||
Line 2,176: | Line 2,442: | ||
end | end | ||
-- Special case for cite techreport. | -- Special case for cite techreport. | ||
if (config.CitationClass == "techreport") then -- special case for cite techreport | if (config.CitationClass == "techreport") then -- special case for cite techreport | ||
if is_set(A['Number']) then | if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue' | ||
if not is_set(ID) then -- can we use ID for the "number"? | if not is_set(ID) then -- can we use ID for the "number"? | ||
ID = A['Number']; | ID = A['Number']; -- yes, use it | ||
else -- ID has a value so emit error message | else -- ID has a value so emit error message | ||
table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); | table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); | ||
Line 2,187: | Line 2,453: | ||
end | end | ||
-- special case for cite mailing list | |||
-- special case for cite mailing list | |||
if (config.CitationClass == "mailinglist") then | if (config.CitationClass == "mailinglist") then | ||
Periodical = A ['MailingList']; | Periodical = A ['MailingList']; | ||
Line 2,226: | Line 2,460: | ||
end | end | ||
-- Account for the oddity that is {{cite conference}}, before generation of COinS data. | -- Account for the oddity that is {{cite conference}}, before generation of COinS data. | ||
if 'conference' == config.CitationClass then | if 'conference' == config.CitationClass then | ||
if is_set(BookTitle) then | if is_set(BookTitle) then | ||
Line 2,232: | Line 2,466: | ||
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated | -- ChapterLink = TitleLink; -- |chapterlink= is deprecated | ||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | |||
ChapterURLorigin = URLorigin; | ChapterURLorigin = URLorigin; | ||
URLorigin = ''; | URLorigin = ''; | ||
Line 2,246: | Line 2,481: | ||
end | end | ||
-- cite map oddities | -- cite map oddities | ||
local Cartography = ""; | local Cartography = ""; | ||
local Scale = ""; | local Scale = ""; | ||
Line 2,254: | Line 2,489: | ||
Chapter = A['Map']; | Chapter = A['Map']; | ||
ChapterURL = A['MapURL']; | ChapterURL = A['MapURL']; | ||
ChapterUrlAccess = UrlAccess; | |||
TransChapter = A['TransMap']; | TransChapter = A['TransMap']; | ||
ChapterURLorigin = A:ORIGIN('MapURL'); | ChapterURLorigin = A:ORIGIN('MapURL'); | ||
Line 2,268: | Line 2,504: | ||
end | end | ||
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data. | -- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data. | ||
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then | if 'episode' == config.CitationClass or 'serial' == config.CitationClass then | ||
local AirDate = A['AirDate']; | local AirDate = A['AirDate']; | ||
Line 2,306: | Line 2,542: | ||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | |||
ChapterURLorigin = A:ORIGIN('URL'); | ChapterURLorigin = A:ORIGIN('URL'); | ||
Line 2,313: | Line 2,550: | ||
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL | if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL | ||
Chapter = | Chapter = make_wikilink (ChapterLink, Chapter); | ||
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode; | elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode; | ||
Series = | Series = make_wikilink (ChapterLink, Series); | ||
end | end | ||
URL = ''; -- unset | URL = ''; -- unset | ||
Line 2,325: | Line 2,562: | ||
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? | Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? | ||
if is_set (Series) and is_set (SeriesLink) then | if is_set (Series) and is_set (SeriesLink) then | ||
Series = | Series = make_wikilink (SeriesLink, Series); | ||
end | end | ||
Series = wrap_style ('italic-title', Series); -- series is italicized | Series = wrap_style ('italic-title', Series); -- series is italicized | ||
end | end | ||
end | end | ||
-- end of {{cite episode}} stuff | -- end of {{cite episode}} stuff | ||
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data. | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data. | ||
if 'arxiv' | do | ||
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then | |||
if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates | |||
table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message | |||
end | |||
if 'arxiv' == config.CitationClass then | |||
Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string | |||
end | |||
if 'biorxiv' == config.CitationClass then | |||
Periodical = 'bioRxiv'; -- set to bioRxiv for COinS; after that, must be set to empty string | |||
end | |||
if 'citeseerx' == config.CitationClass then | |||
Periodical = 'CiteSeerX'; -- set to CiteSeerX for COinS; after that, must be set to empty string | |||
end | |||
end | end | ||
end | end | ||
-- handle type parameter for those CS1 citations that have default values | -- handle type parameter for those CS1 citations that have default values | ||
if in_array(config.CitationClass, {"AV-media-notes", " | if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then | ||
TitleType = set_titletype (config.CitationClass, TitleType); | TitleType = set_titletype (config.CitationClass, TitleType); | ||
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis | if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis | ||
TitleType = Degree .. | TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); | ||
end | end | ||
end | end | ||
if is_set(TitleType) then -- if type parameter is specified | if is_set(TitleType) then -- if type parameter is specified | ||
TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses | |||
-- TODO: Hack on TitleType to fix bunched parentheses problem | |||
end | end | ||
-- legacy: | -- legacy: promote PublicationDate to Date if neither Date nor Year are set. | ||
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging | |||
if not is_set (Date) then | if not is_set (Date) then | ||
Date = Year; -- promote Year to Date | Date = Year; -- promote Year to Date | ||
Line 2,377: | Line 2,612: | ||
Date = PublicationDate; -- promote PublicationDate to Date | Date = PublicationDate; -- promote PublicationDate to Date | ||
PublicationDate = ''; -- unset, no longer needed | PublicationDate = ''; -- unset, no longer needed | ||
Date_origin = A:ORIGIN('PublicationDate'); -- save the name of the promoted parameter | |||
else | |||
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter | |||
end | end | ||
else | |||
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging | |||
end | end | ||
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation | if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation | ||
--[[ | --[[ | ||
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where | Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where | ||
we get the date used in the metadata. | we get the date used in the metadata. | ||
Date validation supporting code is in Module:Citation/CS1/Date_validation | Date validation supporting code is in Module:Citation/CS1/Date_validation | ||
]] | ]] | ||
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch | do -- create defined block to contain local variables error_message, date_parameters_list, mismatch | ||
local error_message = ''; | local error_message = ''; | ||
-- AirDate has been promoted to Date so not necessary to check it | -- AirDate has been promoted to Date so not necessary to check it | ||
-- local date_parameters_list = {['access-date']=AccessDate, ['archive-date']=ArchiveDate, ['date']=Date, ['doi-broken-date']=DoiBroken, | |||
-- ['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year}; | |||
local date_parameters_list = { | |||
['access-date'] = {val=AccessDate, name=A:ORIGIN ('AccessDate')}, | |||
['archive-date'] = {val=ArchiveDate, name=A:ORIGIN ('ArchiveDate')}, | |||
['date'] = {val=Date, name=Date_origin}, | |||
['doi-broken-date'] = {val=DoiBroken, name=A:ORIGIN ('DoiBroken')}, | |||
['embargo'] = {val=Embargo, name=A:ORIGIN ('Embargo')}, | |||
['lay-date'] = {val=LayDate, name=A:ORIGIN ('LayDate')}, | |||
['publication-date'] ={val=PublicationDate, name=A:ORIGIN ('PublicationDate')}, | |||
['year'] = {val=Year, name=A:ORIGIN ('Year')}, | |||
}; | |||
anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date); | anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date); | ||
-- start temporary Julian / Gregorian calendar uncertainty categorization | |||
if COinS_date.inter_cal_cat then | |||
add_prop_cat ('jul_greg_uncertainty'); | |||
end | |||
-- end temporary Julian / Gregorian calendar uncertainty categorization | |||
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed; | if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed; | ||
Line 2,410: | Line 2,666: | ||
if not is_set(error_message) then -- error free dates only | if not is_set(error_message) then -- error free dates only | ||
local modified = false; -- flag | local modified = false; -- flag | ||
if is_set (DF) then -- if we need to reformat dates | if is_set (DF) then -- if we need to reformat dates | ||
modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate | modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate | ||
end | end | ||
if true == date_hyphen_to_dash (date_parameters_list) then | if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate | ||
modified = true; | modified = true; | ||
add_maint_cat ('date_format'); -- hyphens were converted so add maint category | add_maint_cat ('date_format'); -- hyphens were converted so add maint category | ||
end | end | ||
-- for those wikis that can and want to have English date names translated to the local language, | |||
-- uncomment these three lines. Not supported by en.wiki (for obvious reasons) | |||
-- set date_name_xlate() second argument to true to translate English digits to local digits (will translate ymd dates) | |||
-- if date_name_xlate (date_parameters_list, false) then | |||
-- modified = true; | |||
-- end | |||
if modified then -- if the date_parameters_list values were modified | if modified then -- if the date_parameters_list values were modified | ||
AccessDate = date_parameters_list['access-date']; | AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values | ||
ArchiveDate = date_parameters_list['archive-date']; | ArchiveDate = date_parameters_list['archive-date'].val; | ||
Date = date_parameters_list['date']; | Date = date_parameters_list['date'].val; | ||
DoiBroken = date_parameters_list['doi-broken-date']; | DoiBroken = date_parameters_list['doi-broken-date'].val; | ||
LayDate = date_parameters_list['lay-date']; | LayDate = date_parameters_list['lay-date'].val; | ||
PublicationDate = date_parameters_list['publication-date']; | PublicationDate = date_parameters_list['publication-date'].val; | ||
end | end | ||
else | else | ||
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message | table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message | ||
end | end | ||
end -- end of do | end -- end of do | ||
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS. | -- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS. | ||
-- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date | -- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date | ||
Embargo = is_embargoed (Embargo); | Embargo = is_embargoed (Embargo); | ||
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then | if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then | ||
Line 2,453: | Line 2,704: | ||
URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed | URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed | ||
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title= | URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title= | ||
if is_set(AccessDate) then -- access date requires |url=; pmc created url is not |url= | |||
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); | |||
AccessDate = ''; -- unset | |||
end | |||
end | end | ||
end | end | ||
-- At this point fields may be nil if they weren't specified in the template use. We can use that fact. | -- At this point fields may be nil if they weren't specified in the template use. We can use that fact. | ||
-- Test if citation has no title | -- Test if citation has no title | ||
if not is_set(Title) and | if not is_set(Title) and | ||
Line 2,521: | Line 2,777: | ||
}, config.CitationClass); | }, config.CitationClass); | ||
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data. | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data. | ||
if 'arxiv' | if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, or CiteSeerX now unset so it isn't displayed | ||
Periodical = ''; -- periodical not allowed in | Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal | ||
end | end | ||
-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text | -- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text | ||
if 'newsgroup' == config.CitationClass then | if 'newsgroup' == config.CitationClass then | ||
if is_set (PublisherName) then | if is_set (PublisherName) then | ||
PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName') )); | PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil )); | ||
end | end | ||
end | end | ||
Line 2,541: | Line 2,797: | ||
do | do | ||
local last_first_list; | local last_first_list; | ||
local control = { | local control = { | ||
format = NameListFormat, -- empty string or 'vanc' | format = NameListFormat, -- empty string or 'vanc' | ||
maximum = nil, -- as if display-authors or display-editors not set | maximum = nil, -- as if display-authors or display-editors not set | ||
lastauthoramp = LastAuthorAmp, | lastauthoramp = LastAuthorAmp, | ||
page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn | page_name = this_page.text, -- get current page name so that we don't wikilink to it via editorlinkn | ||
mode = Mode | |||
}; | }; | ||
do -- do editor name list first because coauthors | do -- do editor name list first because the now unsupported coauthors used to modify control table | ||
control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal); | control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal); | ||
last_first_list, EditorCount = list_people(control, e, editor_etal); | last_first_list, EditorCount = list_people(control, e, editor_etal); | ||
Line 2,567: | Line 2,823: | ||
EditorCount = 2; -- spoof to display (eds.) annotation | EditorCount = 2; -- spoof to display (eds.) annotation | ||
end | end | ||
end | |||
do -- now do interviewers | |||
control.maximum = #interviewers_list; -- number of interviewerss | |||
Interviewers = list_people(control, interviewers_list, false); -- et al not currently supported | |||
end | end | ||
do -- now do translators | do -- now do translators | ||
Line 2,579: | Line 2,839: | ||
control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal); | control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal); | ||
last_first_list = list_people(control, a, author_etal); | last_first_list = list_people(control, a, author_etal); | ||
Line 2,600: | Line 2,855: | ||
end | end | ||
end | end | ||
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, | -- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, | ||
-- an error message if the associated url is not set, or an empty string for concatenation | -- an error message if the associated url is not set, or an empty string for concatenation | ||
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); | ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); | ||
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); | ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); | ||
Line 2,613: | Line 2,865: | ||
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl'); | TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl'); | ||
-- special case for chapter format so no error message or cat when chapter not supported | -- special case for chapter format so no error message or cat when chapter not supported | ||
if not (in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) or | if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or | ||
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then | ||
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | ||
Line 2,631: | Line 2,883: | ||
end | end | ||
local OriginalURL, OriginalURLorigin, OriginalFormat; | local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; | ||
DeadURL = DeadURL:lower(); -- used later when assembling archived text | DeadURL = DeadURL:lower(); -- used later when assembling archived text | ||
if is_set( ArchiveURL ) then | if is_set( ArchiveURL ) then | ||
if is_set (ChapterURL) then | if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it | ||
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text | OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text | ||
OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages | OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages | ||
OriginalFormat = ChapterFormat; -- and original |format= | OriginalFormat = ChapterFormat; -- and original |chapter-format= | ||
if 'no' ~= DeadURL then | if 'no' ~= DeadURL then | ||
ChapterURL = ArchiveURL -- swap-in the archive's url | ChapterURL = ArchiveURL -- swap-in the archive's url | ||
ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages | ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages | ||
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format | ChapterFormat = ArchiveFormat or ''; -- swap in archive's format | ||
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived urls | |||
end | end | ||
elseif is_set (URL) then | elseif is_set (URL) then | ||
OriginalURL = URL; -- save copy of original source URL | OriginalURL = URL; -- save copy of original source URL | ||
OriginalURLorigin = URLorigin; -- name of url parameter for error messages | OriginalURLorigin = URLorigin; -- name of url parameter for error messages | ||
OriginalFormat = Format; | OriginalFormat = Format; -- and original |format= | ||
OriginalAccess = UrlAccess; | |||
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it | if 'no' ~= DeadURL then -- if URL set then archive-url applies to it | ||
URL = ArchiveURL -- swap-in the archive's url | URL = ArchiveURL -- swap-in the archive's url | ||
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages | URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages | ||
Format = ArchiveFormat or ''; -- swap in archive's format | Format = ArchiveFormat or ''; -- swap in archive's format | ||
UrlAccess = nil; -- restricted access levels do not make sense for archived urls | |||
end | end | ||
end | end | ||
end | end | ||
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) or -- if any of the 'periodical' cites except encyclopedia | if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia | ||
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then | ||
local chap_param; | local chap_param; | ||
Line 2,686: | Line 2,941: | ||
end | end | ||
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes); -- Contribution is also in Chapter | Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter | ||
if is_set (Chapter) then | if is_set (Chapter) then | ||
Chapter = Chapter .. ChapterFormat ; | Chapter = Chapter .. ChapterFormat ; | ||
Line 2,699: | Line 2,954: | ||
-- Format main title. | -- Format main title. | ||
if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title= | |||
Title = mw.ustring.gsub (Title, '(%.%.%.)%.+$', '%1'); -- limit the number of dots to three | |||
elseif not mw.ustring.find (Title, '%.%s*%a%.') then -- end of title is not a 'dot-(optional space-)letter-dot' initialism | |||
Title = mw.ustring.gsub(Title, '%'..sepc..'$', ''); -- remove any trailing separator character | |||
end | |||
if is_set(TitleLink) and is_set(Title) then | if is_set(TitleLink) and is_set(Title) then | ||
Title = | Title = make_wikilink (TitleLink, Title); | ||
end | end | ||
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'mailinglist', 'arxiv'}) or | if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) or | ||
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or | ||
('map' == config.CitationClass and is_set (Periodical)) then -- special case for cite map when the map is in a periodical treat as an article | ('map' == config.CitationClass and is_set (Periodical)) then -- special case for cite map when the map is in a periodical treat as an article | ||
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks | Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks | ||
Title = wrap_style ('quoted-title', Title); | Title = wrap_style ('quoted-title', Title); | ||
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
TransTitle= wrap_style ('trans-quoted-title', TransTitle ); | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); | ||
Line 2,728: | Line 2,987: | ||
end | end | ||
end | end | ||
if is_set(Title) then | if is_set(Title) then | ||
if not is_set(TitleLink) and is_set(URL) then | if not is_set(TitleLink) and is_set(URL) then | ||
Title = external_link( URL, Title, URLorigin ) .. | |||
Title = external_link( URL, Title, URLorigin, UrlAccess ) .. TransTitle .. TransError .. Format; | |||
URL = ''; -- unset these because no longer needed | URL = ''; -- unset these because no longer needed | ||
Format = ""; | Format = ""; | ||
else | else | ||
Title = Title .. TransError; | Title = Title .. TransTitle .. TransError; | ||
end | end | ||
else | |||
Title = TransTitle .. TransError; | |||
end | end | ||
Line 2,759: | Line 3,007: | ||
if is_set (Conference) then | if is_set (Conference) then | ||
if is_set (ConferenceURL) then | if is_set (ConferenceURL) then | ||
Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin ); | Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil ); | ||
end | end | ||
Conference = sepc .. " " .. Conference .. ConferenceFormat; | Conference = sepc .. " " .. Conference .. ConferenceFormat; | ||
elseif is_set(ConferenceURL) then | elseif is_set(ConferenceURL) then | ||
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin ); | Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil ); | ||
end | end | ||
Line 2,817: | Line 3,065: | ||
else | else | ||
Language=""; -- language not specified so make sure this is an empty string; | Language=""; -- language not specified so make sure this is an empty string; | ||
--[[ TODO: need to extract the wrap_msg from language_parameter | |||
so that we can solve parentheses bunching problem with Format/Language/TitleType | |||
]] | |||
end | end | ||
Line 2,822: | Line 3,073: | ||
if is_set (Translators) then | if is_set (Translators) then | ||
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); | |||
Others = sepc .. ' ' | |||
end | end | ||
if is_set (Interviewers) then | |||
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); | |||
end | |||
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; | TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; | ||
if is_set (Edition) then | if is_set (Edition) then | ||
Line 2,837: | Line 3,090: | ||
Series = is_set(Series) and (sepc .. " " .. Series) or ""; | Series = is_set(Series) and (sepc .. " " .. Series) or ""; | ||
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation | |||
Agency = is_set(Agency) and (sepc .. " " .. Agency) or ""; | Agency = is_set(Agency) and (sepc .. " " .. Agency) or ""; | ||
Line 2,847: | Line 3,101: | ||
end | end | ||
--[[ | --[[ | ||
Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link | Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link | ||
note is displayed. There are no error messages for this condition. | note is displayed. There are no error messages for this condition. | ||
]] | ]] | ||
if is_set (SubscriptionRequired) then | if is_set (SubscriptionRequired) then | ||
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message | SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message | ||
Line 2,864: | Line 3,118: | ||
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format | AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format | ||
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if | if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case | ||
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text | AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text | ||
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates | AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates | ||
end | end | ||
Line 2,878: | Line 3,132: | ||
end | end | ||
ID_list = build_id_list( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} ); | ID_list = build_id_list( ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} ); | ||
if is_set(URL) then | if is_set(URL) then | ||
URL = " " .. external_link( URL, nil, URLorigin ); | URL = " " .. external_link( URL, nil, URLorigin, UrlAccess ); | ||
end | end | ||
Line 2,901: | Line 3,155: | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], | Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], | ||
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL') ) .. ArchiveFormat, ArchiveDate } ); | { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | ||
if not is_set(OriginalURL) then | if not is_set(OriginalURL) then | ||
Archived = Archived .. " " .. set_error('archive_missing_url'); | Archived = Archived .. " " .. set_error('archive_missing_url'); | ||
Line 2,908: | Line 3,162: | ||
local arch_text = cfg.messages['archived-dead']; | local arch_text = cfg.messages['archived-dead']; | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
if in_array (DeadURL, {'unfit', 'usurped'}) then | if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then | ||
Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | ||
if 'bot: unknown' == DeadURL then | |||
add_maint_cat ('bot:_unknown'); -- and add a category if not already added | |||
else | |||
add_maint_cat ('unfit'); -- and add a category if not already added | |||
end | |||
else -- DeadURL is empty, 'yes', 'true', or 'y' | else -- DeadURL is empty, 'yes', 'true', or 'y' | ||
Archived = sepc .. " " .. substitute( arch_text, | Archived = sepc .. " " .. substitute( arch_text, | ||
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin ) .. OriginalFormat, ArchiveDate } ); -- format already styled | { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | ||
end | end | ||
else | else | ||
Line 2,935: | Line 3,194: | ||
end | end | ||
if sepc == '.' then | if sepc == '.' then | ||
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate | Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate | ||
else | else | ||
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate | Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate | ||
end | end | ||
elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= | elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= | ||
Line 2,945: | Line 3,204: | ||
if is_set(Transcript) then | if is_set(Transcript) then | ||
if is_set(TranscriptURL) then | if is_set(TranscriptURL) then | ||
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin ); | Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil ); | ||
end | end | ||
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | ||
elseif is_set(TranscriptURL) then | elseif is_set(TranscriptURL) then | ||
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin ); | Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil ); | ||
end | end | ||
local Publisher; | local Publisher; | ||
if is_set( | if is_set(PublicationDate) then | ||
PublicationDate = wrap_msg ('published', PublicationDate); | |||
end | |||
if is_set(PublisherName) then | |||
if is_set(PublicationPlace) then | |||
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; | |||
else | |||
Publisher = sepc .. " " .. PublisherName .. PublicationDate; | |||
end | |||
elseif is_set(PublicationPlace) then | |||
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; | |||
else | |||
Publisher = PublicationDate; | |||
if is_set( | |||
end | end | ||
Line 3,002: | Line 3,236: | ||
end | end | ||
--[[ | --[[ | ||
Handle the oddity that is cite speech. This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that | Handle the oddity that is cite speech. This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that | ||
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided). | the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided). | ||
]] | ]] | ||
if "speech" == config.CitationClass then -- cite speech only | if "speech" == config.CitationClass then -- cite speech only | ||
TitleNote = " (Speech)"; -- annotate the citation | TitleNote = " (Speech)"; -- annotate the citation | ||
Line 3,023: | Line 3,257: | ||
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | ||
if is_set(Others) then Others = Others | if is_set(Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here? | ||
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, | tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc ); | ||
elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites | elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites | ||
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc | if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc | ||
Line 3,046: | Line 3,278: | ||
elseif 'episode' == config.CitationClass then -- special case for cite episode | elseif 'episode' == config.CitationClass then -- special case for cite episode | ||
tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc ); | tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc ); | ||
else -- all other CS1 templates | else -- all other CS1 templates | ||
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, | tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, | ||
Line 3,073: | Line 3,306: | ||
end | end | ||
if is_set(Authors) then | if is_set(Authors) then | ||
if | if (not is_set (Date)) then -- when date is set it's in parentheses; no Authors termination | ||
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space | Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space | ||
end | end | ||
Line 3,088: | Line 3,314: | ||
if is_set(Chapter) and 0 == #c then | if is_set(Chapter) and 0 == #c then | ||
in_text = in_text .. cfg.messages['in'] .. " " | in_text = in_text .. cfg.messages['in'] .. " " | ||
if (sepc ~= '.') then in_text = in_text:lower() | if (sepc ~= '.') then | ||
in_text = in_text:lower() -- lowercase for cs2 | |||
end | |||
else | else | ||
if EditorCount <= 1 then | if EditorCount <= 1 then | ||
Line 3,102: | Line 3,330: | ||
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 | if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 | ||
Authors = by_text .. Authors; -- author follows title so tweak it here | Authors = by_text .. Authors; -- author follows title so tweak it here | ||
if is_set (Editors) then | if is_set (Editors) and is_set (Date) then -- when Editors make sure that Authors gets terminated | ||
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space | Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space | ||
end | end | ||
if not is_set (Date) then -- when date is set it's in parentheses; no Contributors termination | if (not is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination | ||
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space | Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space | ||
end | end | ||
Line 3,174: | Line 3,402: | ||
end | end | ||
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then | if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>","")) <= 2 then -- remove <span> tags and other html-like markup; then get length of what remains | ||
z.error_categories = {}; | z.error_categories = {}; | ||
text = set_error('empty_citation'); | text = set_error('empty_citation'); | ||
Line 3,180: | Line 3,408: | ||
end | end | ||
local render = {}; -- here we collect the final bits for concatenation into the rendered citation | |||
if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags | if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags | ||
table.insert (render, substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})); -- when |ref= is set | |||
else | else | ||
table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases | |||
end | end | ||
table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation | |||
if #z.message_tail ~= 0 then | if #z.message_tail ~= 0 then | ||
table.insert (render, ' '); | |||
for i,v in ipairs( z.message_tail ) do | for i,v in ipairs( z.message_tail ) do | ||
if is_set(v[1]) then | if is_set(v[1]) then | ||
if i == #z.message_tail then | if i == #z.message_tail then | ||
table.insert (render, error_comment( v[1], v[2] )); | |||
else | else | ||
table.insert (render, error_comment( v[1] .. "; ", v[2] )); | |||
end | end | ||
end | end | ||
Line 3,202: | Line 3,432: | ||
if #z.maintenance_cats ~= 0 then | if #z.maintenance_cats ~= 0 then | ||
table.insert (render, '<span class="citation-comment" style="display:none; color:#33aa33; margin-left:0.3em">'); | |||
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories | for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories | ||
table.insert (render, v); | |||
table.insert (render, ' ('); | |||
table.insert (render, make_wikilink (':Category:' .. v, 'link')); | |||
table.insert (render, ') '); | |||
end | end | ||
table.insert (render, '</span>'); | |||
end | end | ||
Line 3,212: | Line 3,445: | ||
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then | if in_array(no_tracking_cats, {"", "no", "false", "n"}) then | ||
for _, v in ipairs( z.error_categories ) do | for _, v in ipairs( z.error_categories ) do | ||
table.insert (render, make_wikilink ('Category:' .. v)); | |||
end | end | ||
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories | for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories | ||
table.insert (render, make_wikilink ('Category:' .. v)); | |||
end | end | ||
for _, v in ipairs( z.properties_cats ) do -- append | for _, v in ipairs( z.properties_cats ) do -- append properties categories | ||
table.insert (render, make_wikilink ('Category:' .. v)); | |||
end | end | ||
end | end | ||
return | return table.concat (render); | ||
end | end | ||
--[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------ | --[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------ | ||
Line 3,232: | Line 3,466: | ||
function cs1.citation(frame) | function cs1.citation(frame) | ||
Frame = frame; -- save a copy incase we need to display an error message in preview mode | |||
local pframe = frame:getParent() | local pframe = frame:getParent() | ||
local validation, utilities, identifiers, metadata; | local validation, utilities, identifiers, metadata; | ||
Line 3,254: | Line 3,489: | ||
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables | utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables | ||
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module | identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module | ||
validation.set_selected_modules (utilities); | validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module | ||
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module | metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module | ||
Line 3,261: | Line 3,496: | ||
reformat_dates = validation.reformat_dates; | reformat_dates = validation.reformat_dates; | ||
date_hyphen_to_dash = validation.date_hyphen_to_dash; | date_hyphen_to_dash = validation.date_hyphen_to_dash; | ||
date_name_xlate = validation.date_name_xlate; | |||
is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities | is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities | ||
in_array = utilities.in_array; | in_array = utilities.in_array; | ||
Line 3,271: | Line 3,507: | ||
wrap_style = utilities.wrap_style; | wrap_style = utilities.wrap_style; | ||
safe_for_italics = utilities.safe_for_italics; | safe_for_italics = utilities.safe_for_italics; | ||
is_wikilink = utilities.is_wikilink; | |||
make_wikilink = utilities.make_wikilink; | |||
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | ||
extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/ | extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Identifiers | ||
build_id_list = identifiers.build_id_list; | build_id_list = identifiers.build_id_list; | ||
is_embargoed = identifiers.is_embargoed; | is_embargoed = identifiers.is_embargoed; | ||
extract_id_access_levels = identifiers.extract_id_access_levels; | |||
make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS | make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS | ||
Line 3,283: | Line 3,521: | ||
COinS = metadata.COinS; | COinS = metadata.COinS; | ||
local args = {}; -- table where we store all of the template's arguments | |||
local suggestions = {}; -- table where we store suggestions if we need to loadData them | |||
local | |||
local error_text, error_state; | local error_text, error_state; | ||
local config = {}; | local config = {}; -- table to store parameters from the module {{#invoke:}} | ||
for k, v in pairs( frame.args ) do | for k, v in pairs( frame.args ) do | ||
config[k] = v; | config[k] = v; | ||
-- args[k] = v; -- debug tool that allows us to render a citation from module {{#invoke:}} | |||
end | end | ||
Line 3,304: | Line 3,534: | ||
for k, v in pairs( pframe.args ) do | for k, v in pairs( pframe.args ) do | ||
if v ~= '' then | if v ~= '' then | ||
if not validate( k ) then | if ('string' == type (k)) then | ||
k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- for enumerated parameters, translate 'local' digits to Western 0-9 | |||
end | |||
if not validate( k, config.CitationClass ) then | |||
error_text = ""; | error_text = ""; | ||
if type( k ) ~= 'string' then | if type( k ) ~= 'string' then | ||
Line 3,311: | Line 3,544: | ||
error_text, error_state = set_error( 'text_ignored', {v}, true ); | error_text, error_state = set_error( 'text_ignored', {v}, true ); | ||
end | end | ||
elseif validate( k:lower() ) then | elseif validate( k:lower(), config.CitationClass ) then | ||
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); | error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); | ||
else | else | ||
Line 3,333: | Line 3,566: | ||
else | else | ||
error_text, error_state = set_error( 'parameter_ignored', {k}, true ); | error_text, error_state = set_error( 'parameter_ignored', {k}, true ); | ||
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists) | |||
end | end | ||
end | end | ||
Line 3,341: | Line 3,575: | ||
end | end | ||
missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe? | missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe? | ||
-- TODO: is this the best place for this translation? | |||
args[k] = v; | args[k] = v; | ||
elseif args[k] ~= nil or (k == 'postscript') then -- here when v is empty string | |||
args[k] = v; -- why do we do this? we don't support 'empty' parameters | |||
end | end | ||
end | end |