Editing Module:Citation/CS1
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
--[[--------------------------< F O R W A R D D E C L A R A T I O N S >-------------------------------------- | --[[--------------------------< F O R W A R D D E C L A R A T I O N S >-------------------------------------- | ||
]] | ]] | ||
local | local dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- functions in Module:Citation/CS1/Date_validation | ||
date_name_xlate | |||
local | local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities | ||
local z ={}; -- | add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink; | ||
local z ={}; -- tables in Module:Citation/CS1/Utilities | |||
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 cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration | local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration | ||
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist | local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist | ||
--[[------------------< 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 >-------------------------------------- | |||
other modules; | |||
delare variables here that have page-wide scope that are not brought in from other modules; thatare created here | |||
and used here | |||
]] | ]] | ||
local added_deprecated_cat; -- | |||
local | local added_deprecated_cat; -- boolean flag so that the category is added only once | ||
local added_vanc_errs; -- | 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 | 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 39: | Line 47: | ||
local i = 1; | local i = 1; | ||
while i <= count do -- loop through all items in list | while i <= count do -- loop through all items in list | ||
if | if is_set( list[i] ) then | ||
return list[i]; -- return the first set list member | return list[i]; -- return the first set list member | ||
end | end | ||
i = i + 1; -- point to next | i = i + 1; -- point to next | ||
end | |||
end | |||
--[[--------------------------< A D D _ P R O P _ C A T >-------------------------------------------------------- | |||
Adds a category to z.properties_cats using names from the configuration file with additional text if any. | |||
foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languages | |||
may be categorized but multiples of the same language are not categorized. | |||
added_prop_cats is a table declared in page scope variables above | |||
]] | |||
local function add_prop_cat (key, arguments) | |||
if not added_prop_cats [key] then | |||
added_prop_cats [key] = true; -- note that we've added this category | |||
key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname | |||
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table | |||
end | end | ||
end | end | ||
Line 52: | Line 80: | ||
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 | 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 added_vanc_errs then | if not added_vanc_errs then | ||
added_vanc_errs = true; -- note that we've added this category | |||
table.insert( z.message_tail, { set_error( 'vancouver', {source}, true ) } ); | |||
end | |||
end | end | ||
Line 66: | Line 94: | ||
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------ | --[[--------------------------< I S _ S C H E M E >------------------------------------------------------------ | ||
does this thing that purports to be a | does this thing that purports to be a uri scheme seem to be a valid scheme? The scheme is checked to see if it | ||
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says: | is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says: | ||
Scheme names consist of a sequence of characters beginning with a | Scheme names consist of a sequence of characters beginning with a | ||
Line 89: | Line 117: | ||
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15; | Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15; | ||
see also [[Single-letter second-level domain]] | see also [[Single-letter second-level domain]] | ||
list of | list of tlds: https://www.iana.org/domains/root/db | ||
rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit. Between | |||
the first and last characters the name may use letters, digits, and the hyphen. | the first and last characters the name may use letters, digits, and the hyphen. | ||
Also allowed are IPv4 addresses. IPv6 not supported | Also allowed are IPv4 addresses. IPv6 not supported | ||
domain is expected to be stripped of any path so that the last character in the last character of the | domain is expected to be stripped of any path so that the last character in the last character of the tld. tld | ||
is two or more alpha characters. Any preceding '//' (from splitting a | is two or more alpha characters. Any preceding '//' (from splitting a url with a scheme) will be stripped | ||
here. Perhaps not necessary but retained | here. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal. | ||
There are several tests: | There are several tests: | ||
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 ( | 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, .cash, and .today TLDs | single-letter/digit second-level domains in the .org, .cash, and .today TLDs | ||
q, x, and z SL domains in the .com TLD | q, x, and z SL domains in the .com TLD | ||
Line 111: | Line 139: | ||
IPv4 dot-decimal address format; TLD not allowed | IPv4 dot-decimal address format; TLD not allowed | ||
returns true if domain appears to be a proper name and | returns true if domain appears to be a proper name and tld or IPv4 address, else false | ||
]=] | ]=] | ||
Line 122: | Line 150: | ||
domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once | domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once | ||
if not domain:match ('^[% | if not domain:match ('^[%a%d]') then -- first character must be letter or digit | ||
return false; | return false; | ||
end | end | ||
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at | if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at wikisource | ||
return false; | return false; | ||
end | end | ||
-- Do most common case first | |||
if domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$') then -- three or more character hostname.hostname or hostname.tld | |||
return true; | |||
'%f[% | elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix | ||
'%f[%a][qxz]%.com$' | return true; | ||
'%f[%a][iq]%.net$' | elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname | ||
'%f[% | return true; | ||
'%f[% | elseif domain:match ('%f[%a%d][%a%d]%.today') then -- one character/digit .today hostname | ||
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?' | return true; | ||
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character/digit .org hostname | |||
return true; | |||
elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10) | |||
return true; | |||
elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10) | |||
return true; | |||
elseif domain:match ('%f[%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars) | |||
return true; | |||
elseif domain:match ('%f[%a%d][%a%d][%a%d]%.%a%a+$') then -- two character hostname and tld | |||
return true; | |||
elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address | |||
return true; | |||
else | |||
return false; | |||
end | end | ||
end | end | ||
Line 157: | Line 186: | ||
--[[--------------------------< I S _ U R L >------------------------------------------------------------------ | --[[--------------------------< I S _ U R L >------------------------------------------------------------------ | ||
returns true if the scheme and domain parts of a | returns true if the scheme and domain parts of a url appear to be a valid url; else false. | ||
This function is the last step in the validation process. This function is separate because there are cases that | This function is the last step in the validation process. This function is separate because there are cases that | ||
Line 166: | Line 195: | ||
local function is_url (scheme, domain) | local function is_url (scheme, domain) | ||
if | if is_set (scheme) then -- if scheme is set check it and domain | ||
return is_scheme (scheme) and is_domain_name (domain); | return is_scheme (scheme) and is_domain_name (domain); | ||
else | else | ||
return is_domain_name (domain); -- scheme not set when | return is_domain_name (domain); -- scheme not set when url is protocol relative | ||
end | end | ||
end | end | ||
Line 176: | Line 205: | ||
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------ | --[[--------------------------< S P L I T _ U R L >------------------------------------------------------------ | ||
Split a | Split a url into a scheme, authority indicator, and domain. | ||
First remove Fully Qualified Domain Name terminator (a dot following | First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#). | ||
If protocol | If protocol relative url, return nil scheme and domain else return nil for both scheme and domain. | ||
When not protocol | When not protocol relative, get scheme, authority indicator, and domain. If there is an authority indicator (one | ||
or more '/' characters immediately following the scheme's colon), make sure that there are only 2. | or more '/' characters immediately following the scheme's colon), make sure that there are only 2. | ||
Strip off any port and path; | Strip off any port and path; | ||
Line 197: | Line 223: | ||
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//') | url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//') | ||
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol | if url_str:match ('^//%S*') then -- if there is what appears to be a protocol relative url | ||
domain = url_str:match ('^//(%S*)') | domain = url_str:match ('^//(%S*)') | ||
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name | elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name | ||
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions | scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions | ||
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing; | |||
if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then | |||
return scheme; -- return scheme only making domain nil which will cause an error message | |||
end | end | ||
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present | domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present | ||
Line 220: | Line 240: | ||
--[[--------------------------< L I N K _ P A R A M _ O K >--------------------------------------------------- | --[[--------------------------< L I N K _ P A R A M _ O K >--------------------------------------------------- | ||
checks the content of |title-link=, |series-link=, |author-link= | checks the content of |title-link=, |series-link=, |author-link= etc for properly formatted content: no wikilinks, no urls | ||
Link parameters are to hold the title of a | Link parameters are to hold the title of a wikipedia article so none of the WP:TITLESPECIALCHARACTERS are allowed: | ||
# < > [ ] | { } _ | # < > [ ] | { } _ | ||
except the underscore which is used as a space in wiki | except the underscore which is used as a space in wiki urls and # which is used for section links | ||
returns false when the value contains any of these characters. | returns false when the value contains any of these characters. | ||
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid | When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid url (the | ||
|<param>-link= parameter is ok); else false when value appears to be a valid | |<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok). | ||
]] | ]] | ||
Line 239: | Line 259: | ||
end | end | ||
scheme, domain = split_url (value); -- get scheme or nil and domain or nil from | scheme, domain = split_url (value); -- get scheme or nil and domain or nil from url; | ||
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid | return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url | ||
end | end | ||
Line 248: | Line 268: | ||
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value. | Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value. | ||
|<title>= may be | |<title>= may be wikilinked but not when |<param>-link= has a value. This function emits an error message when | ||
that condition exists | that condition exists | ||
]] | ]] | ||
Line 258: | Line 275: | ||
local function link_title_ok (link, lorig, title, torig) | local function link_title_ok (link, lorig, title, torig) | ||
local orig; | local orig; | ||
if | |||
if is_set (link) then -- don't bother if <param>-link doesn't have a value | |||
if not link_param_ok (link) then -- check |<param>-link= markup | if not link_param_ok (link) then -- check |<param>-link= markup | ||
orig = lorig; -- identify the failing link parameter | orig = lorig; -- identify the failing link parameter | ||
elseif title:find ('%[%[') then -- check |title= for wikilink markup | elseif title:find ('%[%[') then -- check |title= for wikilink markup | ||
orig = torig; -- identify the failing |title= parameter | orig = torig; -- identify the failing |title= parameter | ||
end | end | ||
end | end | ||
if | if is_set (orig) then | ||
table.insert( z.message_tail, { set_error( 'bad_paramlink', orig)}); -- url or wikilink in |title= with |title-link=; | |||
table.insert( z.message_tail, { | |||
end | end | ||
end | end | ||
Line 285: | Line 294: | ||
Determines whether a URL string appears to be valid. | Determines whether a URL string appears to be valid. | ||
First we test for space characters. If any are found, return false. Then split the | First we test for space characters. If any are found, return false. Then split the url into scheme and domain | ||
portions, or for protocol | portions, or for protocol relative (//example.com) urls, just the domain. Use is_url() to validate the two | ||
portions of the | portions of the url. If both are valid, or for protocol relative if domain is valid, return true, else false. | ||
Because it is different from a standard | Because it is different from a standard url, and because this module used external_link() to make external links | ||
that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name | that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name | ||
is at https://tools.ietf.org/html/rfc5536#section-3.1.4 | is at https://tools.ietf.org/html/rfc5536#section-3.1.4 | ||
Line 296: | Line 305: | ||
local function check_url( url_str ) | local function check_url( url_str ) | ||
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper | if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper url | ||
return false; | return false; | ||
end | end | ||
local scheme, domain; | local scheme, domain; | ||
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from | scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from url; | ||
if 'news:' == scheme then -- special case for newsgroups | if 'news:' == scheme then -- special case for newsgroups | ||
Line 307: | Line 316: | ||
end | end | ||
return is_url (scheme, domain); -- return true if value appears to be a valid | return is_url (scheme, domain); -- return true if value appears to be a valid url | ||
end | end | ||
Line 314: | Line 323: | ||
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first | Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first | ||
non-space characters following the opening bracket appear to be a | non-space characters following the opening bracket appear to be a url. The test will also find external wikilinks | ||
that use protocol | that use protocol relative urls. Also finds bare urls. | ||
The frontier pattern prevents a match on interwiki | The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls. The tests that | ||
find bracketed | find bracketed urls are required because the parameters that call this test (currently |title=, |chapter=, |work=, | ||
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]] | and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]] | ||
is possible as might be [[en://Hus]]. | is possible as might be [[en://Hus]]. | ||
Line 327: | Line 336: | ||
local scheme, domain; | local scheme, domain; | ||
if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext | if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext wikilink with scheme and domain: [xxxx://yyyyy.zzz] | ||
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]')); | scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]')); | ||
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol | elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz] | ||
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]')); | scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]')); | ||
elseif value:match ('%a%S*:%S+') then -- if bare | elseif value:match ('%a%S*:%S+') then -- if bare url with scheme; may have leading or trailing plain text | ||
scheme, domain = split_url (value:match ('(%a%S*:%S+)')); | scheme, domain = split_url (value:match ('(%a%S*:%S+)')); | ||
elseif value:match ('//%S+') then -- if protocol | elseif value:match ('//%S+') then -- if protocol relative bare url: //yyyyy.zzz; may have leading or trailing plain text | ||
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain | scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain | ||
else | else | ||
return false; -- didn't find anything that is obviously a | return false; -- didn't find anything that is obviously a url | ||
end | end | ||
return is_url (scheme, domain); -- return true if value appears to be a valid | return is_url (scheme, domain); -- return true if value appears to be a valid url | ||
end | end | ||
Line 352: | Line 361: | ||
local error_message = ''; | local error_message = ''; | ||
for k, v in pairs (parameter_list) do -- for each parameter in the list | for k, v in pairs (parameter_list) do -- for each parameter in the list | ||
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a | if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message | ||
if | if is_set(error_message) then -- once we've added the first portion of the error message ... | ||
error_message = error_message .. ", "; -- ... add a comma space separator | error_message=error_message .. ", "; -- ... add a comma space separator | ||
end | end | ||
error_message = error_message .. "|" .. k .. "="; -- add the failed parameter | error_message=error_message .. "|" .. k .. "="; -- add the failed parameter | ||
end | end | ||
end | end | ||
if | if is_set (error_message) then -- done looping, if there is an error message, display it | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'param_has_ext_link', {error_message}, true ) } ); | ||
end | end | ||
end | end | ||
Line 373: | Line 382: | ||
local function safe_for_url( str ) | local function safe_for_url( str ) | ||
if str:match( "%[%[.-%]%]" ) ~= nil then | if str:match( "%[%[.-%]%]" ) ~= nil then | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } ); | ||
end | end | ||
Line 395: | Line 404: | ||
local base_url; | local base_url; | ||
if not | if not is_set( label ) then | ||
label = URL; | label = URL; | ||
if | if is_set( source ) then | ||
error_str = | error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " ); | ||
else | else | ||
error( cfg.messages["bare_url_no_origin"] ); | error( cfg.messages["bare_url_no_origin"] ); | ||
Line 404: | Line 413: | ||
end | end | ||
if not check_url( URL ) then | if not check_url( URL ) then | ||
error_str = | error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str; | ||
end | end | ||
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the | domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the url into scheme plus domain and path | ||
if path then -- if there is a path portion | if path then -- if there is a path portion | ||
path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); | path = path:gsub ('[%[%]]', {['[']='%5b',[']']='%5d'}); -- replace '[' and ']' with their percent encoded values | ||
URL = table.concat ({domain, path}); -- and reassemble | URL = table.concat ({domain, path}); -- and reassemble | ||
end | end | ||
base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a | base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wikimarkup url | ||
if | if is_set (access) then -- access level (subscription, registration, limited) | ||
base_url = | base_url = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon | ||
end | end | ||
Line 429: | Line 438: | ||
parameters in the citation. | parameters in the citation. | ||
added_deprecated_cat is a | added_deprecated_cat is a boolean declared in page scope variables above | ||
]] | ]] | ||
Line 436: | Line 445: | ||
if not added_deprecated_cat then | if not added_deprecated_cat then | ||
added_deprecated_cat = true; -- note that we've added this category | added_deprecated_cat = true; -- note that we've added this category | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message | ||
end | end | ||
end | end | ||
Line 460: | Line 452: | ||
--[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- | --[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- | ||
Apply kerning to open the space between the quote mark provided by the | 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. | mark contained in a |title= or |chapter= parameter's value. | ||
Line 466: | Line 458: | ||
"'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 | Double single quotes (italic or bold wikimarkup) are not kerned. | ||
Replaces | 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. | 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 | 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; | local wl_type, label, link; | ||
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 1 == wl_type then -- [[D]] simple wikilink with or without quote marks | ||
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks | if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks | ||
str = | str = substitute (cfg.presentation['kern-wl-both'], str); | ||
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks | elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks | ||
str = | str = substitute (cfg.presentation['kern-wl-left'], str); | ||
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks | elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks | ||
str = | str = substitute (cfg.presentation['kern-wl-right'], str); | ||
end | end | ||
else -- plain text or [[L|D]]; text in label variable | 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+201C & U+201D) with " (typewriter double quote mark) | ||
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark) | label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark) | ||
cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) | cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) | ||
if | if is_set (cap) then | ||
label = | label = substitute (cfg.presentation['kern-left'], {cap, cap2}); | ||
end | end | ||
cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) | cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) | ||
if | if is_set (cap) then | ||
label = | label = substitute (cfg.presentation['kern-right'], {cap, cap2}); | ||
end | end | ||
if 2 == wl_type then | if 2 == wl_type then | ||
str = | str = make_wikilink (link, label); -- reassemble the wikilink | ||
else | else | ||
str = label; | str = label; | ||
Line 517: | Line 509: | ||
--[[--------------------------< 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 >---------------------------------------- | ||
|script-title= holds title parameters that are not written in Latin | |script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should | ||
not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped | not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped | ||
in italic markup. | in italic markup. | ||
Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate | Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate rtl languages from the English left to right. | ||
|script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character | |script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO639-1 language code and a colon: | ||
|script-title=ja:*** *** (where * represents a Japanese character) | |script-title=ja:*** *** (where * represents a Japanese character) | ||
Spaces between the two-character code and the colon and the colon and the first script character are allowed: | Spaces between the two-character code and the colon and the colon and the first script character are allowed: | ||
Line 531: | Line 523: | ||
Spaces preceding the prefix are allowed: |script-title = ja:*** *** | Spaces preceding the prefix are allowed: |script-title = ja:*** *** | ||
The prefix is checked for validity. If it is a valid | The prefix is checked for validity. If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can | ||
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute | know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute | ||
is not added. At this time there is no error message for this condition. | is not added. At this time there is no error message for this condition. | ||
Supports |script-title= | Supports |script-title= and |script-chapter= | ||
TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script; | |||
]] | ]] | ||
local function format_script_value (script_value | local function format_script_value (script_value) | ||
local lang=''; -- initialize to empty string | local lang=''; -- initialize to empty string | ||
local name; | local name; | ||
if script_value:match('^%l%l | if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix | ||
lang = script_value:match('^(%l%l | lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script | ||
if not | if not is_set (lang) then | ||
return ''; -- script_value was just the prefix so return empty string | return ''; -- script_value was just the prefix so return empty string | ||
end | end | ||
-- if we get this far we have prefix and script | -- if we get this far we have prefix and script | ||
name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, | name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize | ||
if | if is_set (name) then -- is prefix a proper ISO 639-1 language code? | ||
script_value = script_value:gsub ('^%l | script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script | ||
-- is prefix one of these language codes? | -- is prefix one of these language codes? | ||
if | if in_array (lang, cfg.script_lang_codes) then | ||
add_prop_cat ('script_with_name', {name, lang}) | |||
else | else | ||
add_prop_cat ('script') | |||
end | end | ||
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute | lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute | ||
else | else | ||
lang = ''; -- invalid so set lang to empty string | lang = ''; -- invalid so set lang to empty string | ||
end | end | ||
end | end | ||
script_value = | script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl | ||
return script_value; | return script_value; | ||
Line 578: | Line 567: | ||
]] | ]] | ||
local function script_concatenate (title, script | local function script_concatenate (title, script) | ||
if | if is_set (script) then | ||
script = format_script_value (script | script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error | ||
if | if is_set (script) then | ||
title = title .. ' ' .. script; -- concatenate title and script title | title = title .. ' ' .. script; -- concatenate title and script title | ||
end | end | ||
Line 598: | Line 587: | ||
local function wrap_msg (key, str, lower) | local function wrap_msg (key, str, lower) | ||
if not | if not is_set( str ) then | ||
return ""; | return ""; | ||
end | end | ||
Line 604: | Line 593: | ||
local msg; | local msg; | ||
msg = cfg.messages[key]:lower(); -- set the message to lower case before | msg = cfg.messages[key]:lower(); -- set the message to lower case before | ||
return | return substitute( msg, str ); -- including template text | ||
else | else | ||
return | return substitute( cfg.messages[key], str ); | ||
end | end | ||
end | end | ||
--[[----------------< W I K I S O U R C E _ U R L _ M A K E >------------------- | --[[--------------------------< W I K I S O U R C E _ U R L _ M A K E >---------------------------------------- | ||
makes a wikisource url from wikisource interwiki link. returns the url and appropriate label; nil else. | |||
label; nil else. | |||
str is the value assigned to |chapter= (or aliases) or |title= or |title-link= | str is the value assigned to |chapter= (or aliases) or |title= or |title-link= | ||
Line 623: | Line 611: | ||
local wl_type, D, L; | local wl_type, D, L; | ||
local ws_url, ws_label; | local ws_url, ws_label; | ||
wl_type, D, L = | wl_type, D, L = is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink) | ||
if 0 == wl_type then -- not a wikilink; might be from |title-link= | if 0 == wl_type then -- not a wikilink; might be from |title-link= | ||
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | ||
if | if is_set (str) then | ||
ws_url = table.concat ({ -- build a | ws_url = table.concat ({ -- build a wikisource url | ||
'https://en.wikisource.org/wiki/', -- prefix | |||
str, -- article title | str, -- article title | ||
}); | }); | ||
ws_label = str; -- label for the | ws_label = str; -- label for the url | ||
end | end | ||
elseif 1 == wl_type then | elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]] | ||
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | ||
if | if is_set (str) then | ||
ws_url = table.concat ({ -- build a | ws_url = table.concat ({ -- build a wikisource url | ||
'https://en.wikisource.org/wiki/', -- prefix | |||
str, -- article title | str, -- article title | ||
}); | }); | ||
ws_label = str; -- label for the | ws_label = str; -- label for the url | ||
end | end | ||
elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]]) | elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]]) | ||
str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace | ||
if | if is_set (str) then | ||
ws_label = D; -- get ws article name from display portion of interwiki link | ws_label = D; -- get ws article name from display portion of interwiki link | ||
ws_url = table.concat ({ -- build a | ws_url = table.concat ({ -- build a wikisource url | ||
'https://en.wikisource.org/wiki/', -- prefix | |||
str, -- article title without namespace from link portion of wikilink | str, -- article title without namespace from link portion of wikilink | ||
}); | }); | ||
end | end | ||
end | end | ||
if ws_url then | if ws_url then | ||
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable | ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable url | ||
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent | ws_url = ws_url:gsub ('%%23', '#'); -- undo percent encoding of anchor | ||
end | end | ||
return ws_url, ws_label, L or D; | return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil | ||
end | end | ||
--[[----------------< F O R M A T _ P E R I | --[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >-------------------------------------- | ||
Format the | Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta- | ||
and | | parameter (chapter_url_source used for error messages). | ||
]] | ]] | ||
local function | local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access) | ||
local | local chapter_error = ''; | ||
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource url and label from a wikisource interwiki link | |||
if ws_url then | |||
ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters | |||
chapter = ws_label; | |||
end | end | ||
if not is_set (chapter) then | |||
chapter = ''; -- to be safe for concatenation | |||
else | |||
if not | |||
chapter = ''; -- to be safe for concatenation | |||
else | |||
if false == no_quotes then | if false == no_quotes then | ||
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from | chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks | ||
chapter = | chapter = wrap_style ('quoted-title', chapter); | ||
end | end | ||
end | end | ||
chapter = script_concatenate (chapter, | chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
if | if is_set (chapterurl) then | ||
chapter = external_link ( | chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | ||
elseif ws_url then | elseif ws_url then | ||
chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? | chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? | ||
chapter = | chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter}); | ||
end | end | ||
if | if is_set (transchapter) then | ||
transchapter = wrap_style ('trans-quoted-title', transchapter); | |||
if | if is_set (chapter) then | ||
chapter = chapter .. ' ' .. | chapter = chapter .. ' ' .. transchapter; | ||
else -- here when | else -- here when transchapter without chapter or script-chapter | ||
chapter = | chapter = transchapter; -- | ||
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'}); | |||
chapter_error = ' ' .. | |||
end | end | ||
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; | ||
Line 747: | Line 704: | ||
--[[----------------< 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 >---------------------------------------- | ||
This function searches a parameter's value for | This function searches a parameter's value for nonprintable or invisible characters. The search stops at the | ||
The search stops at the first match. | first match. | ||
This function will detect the visible replacement character when it is part of the | This function will detect the visible replacement character when it is part of the wikisource. | ||
Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers | Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (gallery, math, pre, ref) | ||
(gallery, math, pre, ref) and identifies them with a slightly different error message. | and identifies them with a slightly different error message. See also coins_cleanup(). | ||
See also coins_cleanup(). | |||
Output of this function is an error message that identifies the character or the | Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker | ||
Unicode group, or the stripmarker that was detected along with its position (or, | that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the | ||
for multi-byte characters, the position of its first byte) in the parameter value. | parameter value. | ||
]] | ]] | ||
Line 766: | Line 722: | ||
local function has_invisible_chars (param, v) | local function has_invisible_chars (param, v) | ||
local position = ''; -- position of invisible char or starting position of stripmarker | local position = ''; -- position of invisible char or starting position of stripmarker | ||
local dummy; -- end of matching string; not used but required to hold end position when a capture is returned | |||
local capture; -- used by stripmarker detection to hold name of the stripmarker | local capture; -- used by stripmarker detection to hold name of the stripmarker | ||
local stripmarker; | local i=1; | ||
local stripmarker, apostrophe; | |||
capture = string.match (v, '[%w%p ]*'); -- | |||
if capture == v then -- if same there are no | capture = string.match (v, '[%w%p ]*'); -- Test for values that are simple ASCII text and bypass other tests if true | ||
if capture == v then -- if same there are no unicode characters | |||
return; | return; | ||
end | end | ||
while cfg.invisible_chars[i] do | |||
local | local char=cfg.invisible_chars[i][1] -- the character or group name | ||
local pattern = | local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it | ||
position, | position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern | ||
if position and ( | 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 -- | if mw.ustring.find (v, cfg.indic_script) then -- its ok if one of the indic scripts | ||
position = nil; -- unset position | position = nil; -- unset position | ||
end | end | ||
Line 789: | Line 745: | ||
if position then | if position then | ||
if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition) | if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition) | ||
('templatestyles' == capture and | ('templatestyles' == capture and in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters | ||
stripmarker = true; -- set a flag | stripmarker = true; -- set a flag | ||
elseif true == stripmarker and | elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker | ||
position = nil; -- unset | position = nil; -- unset | ||
else | else | ||
local err_msg; | local err_msg; | ||
if capture | if capture then | ||
err_msg = capture .. ' ' .. | err_msg = capture .. ' ' .. char; | ||
else | else | ||
err_msg = | err_msg = char .. ' ' .. 'character'; | ||
end | end | ||
table.insert (z.message_tail, { | table.insert( z.message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } ); -- add error message | ||
return; -- and done with this parameter | return; -- and done with this parameter | ||
end | end | ||
end | end | ||
i=i+1; -- bump our index | |||
end | end | ||
end | end | ||
--[[-------------------< A R G U M E N T _ W R A P P E R >---------------------- | --[[--------------------------< A R G U M E N T _ W R A P P E R >---------------------------------------------- | ||
Argument wrapper. This function provides support for argument mapping defined | Argument wrapper. This function provides support for argument mapping defined in the configuration file so that | ||
in the configuration file so that multiple names can be transparently aliased to | multiple names can be transparently aliased to single internal variable. | ||
single internal variable. | |||
]] | ]] | ||
local function argument_wrapper ( args ) | local function argument_wrapper( args ) | ||
local origin = {}; | local origin = {}; | ||
return setmetatable({ | return setmetatable({ | ||
ORIGIN = function ( self, k ) | ORIGIN = function( self, k ) | ||
local dummy = self[k]; | local dummy = self[k]; --force the variable to be loaded. | ||
return origin[k]; | return origin[k]; | ||
end | end | ||
Line 835: | Line 791: | ||
if type( list ) == 'table' then | if type( list ) == 'table' then | ||
v, origin[k] = | v, origin[k] = select_one( args, list, 'redundant_parameters' ); | ||
if origin[k] == nil then | if origin[k] == nil then | ||
origin[k] = ''; | origin[k] = ''; -- Empty string, not nil | ||
end | end | ||
elseif list ~= nil then | elseif list ~= nil then | ||
Line 844: | Line 800: | ||
-- maybe let through instead of raising an error? | -- maybe let through instead of raising an error? | ||
-- v, origin[k] = args[k], k; | -- v, origin[k] = args[k], k; | ||
error( cfg.messages['unknown_argument_map'] | error( cfg.messages['unknown_argument_map'] ); | ||
end | end | ||
-- Empty strings, not nil; | -- Empty strings, not nil; | ||
if v == nil then | if v == nil then | ||
v = ''; | v = cfg.defaults[k] or ''; | ||
origin[k] = ''; | origin[k] = ''; | ||
end | end | ||
Line 860: | Line 816: | ||
--[[--------------------------< N O W R A P _ D A T E >------------------------- | --[[--------------------------< N O W R A P _ D A T E >-------------------------------------------------------- | ||
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. | When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or is | ||
When date is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span: | MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY | ||
<span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY | |||
DOES NOT yet support MMMM YYYY or any of the date ranges. | DOES NOT yet support MMMM YYYY or any of the date ranges. | ||
Line 871: | Line 826: | ||
local function nowrap_date (date) | local function nowrap_date (date) | ||
local cap = ''; | local cap=''; | ||
local cap2 = ''; | local cap2=''; | ||
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then | if date:match("^%d%d%d%d%-%d%d%-%d%d$") then | ||
date = | date = substitute (cfg.presentation['nowrap1'], date); | ||
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then | elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then | ||
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$"); | cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$"); | ||
date = | date = substitute (cfg.presentation['nowrap2'], {cap, cap2}); | ||
end | end | ||
Line 886: | Line 841: | ||
--[[--------------------------< S E T _ T I T L E T Y P E >--------------------- | --[[--------------------------< S E T _ T I T L E T Y P E >---------------------------------------------------- | ||
This function sets default title types (equivalent to the citation including | This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults. | ||
|type=<default value>) for those templates that have defaults. Also handles the | Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none). | ||
special case where it is desirable to omit the title type from the rendered citation | |||
(|type=none). | |||
]] | ]] | ||
local function set_titletype (cite_class, title_type) | local function set_titletype (cite_class, title_type) | ||
if | if is_set(title_type) then | ||
if | if "none" == title_type then | ||
title_type = | title_type = ""; -- if |type=none then type parameter not displayed | ||
end | end | ||
return title_type; -- if |type= has been set to any other value use that value | return title_type; -- if |type= has been set to any other value use that value | ||
Line 909: | Line 862: | ||
--[[--------------------------< H Y P H E N _ T O _ D A S H >-------------------------------------------------- | --[[--------------------------< H Y P H E N _ T O _ D A S H >-------------------------------------------------- | ||
Converts a hyphen to a dash under certain conditions. The hyphen must separate | Converts a hyphen to a dash under certain conditions. The hyphen must separate like items; unlike items are | ||
like items; unlike items are returned unmodified. These forms are modified: | returned unmodified. These forms are modified: | ||
letter - letter (A - B) | letter - letter (A - B) | ||
digit - digit (4-5) | digit - digit (4-5) | ||
digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5) | digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5) | ||
letterdigit - letterdigit (A1-A5) (an optional separator between letter and | letterdigit - letterdigit (A1-A5) (an optional separator between letter and digit is supported – a.1-a.5 or a-1-a-5) | ||
digitletter - digitletter (5a - 5d) (an optional separator between letter and digit is supported – 5.a-5.d or 5-a-5-d) | |||
digitletter - digitletter (5a - 5d) (an optional separator between letter and | |||
any other forms are returned unmodified. | any other forms are returned unmodified. | ||
Line 926: | Line 877: | ||
local function hyphen_to_dash( str ) | local function hyphen_to_dash( str ) | ||
if not | if not is_set (str) then | ||
return str; | return str; | ||
end | end | ||
str, count = str:gsub ('^%(%((.+)%)%)$', '%1'); -- remove accept-this-as-written markup when it wraps all of str | |||
if 0 ~= count then -- non-zero when markup removed; zero else | |||
str = str:gsub ('&[nm]dash;', {['–'] = '–', ['—'] = '—'}); -- replace — and – entities with their characters; semicolon mucks up the text.split | return str; -- nothing to do, we're done | ||
end | |||
str = str:gsub ('&[nm]dash;', {['–'] = '–', ['—'] = '—'}); -- replace — and – entities with their characters; semicolon mucks up the text.split | |||
local out = {}; | local out = {}; | ||
Line 941: | Line 892: | ||
for _, item in ipairs (list) do -- for each item in the list | for _, item in ipairs (list) do -- for each item in the list | ||
if mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators | |||
if | if item:match ('%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+') or -- letterdigit hyphen letterdigit (optional separator between letter and digit) | ||
if item:match (' | item:match ('%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+') or -- digitletter hyphen digitletter (optional separator between digit and letter) | ||
item:match (' | item:match ('%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+') or -- digit separator digit hyphen digit separator digit | ||
item:match (' | item:match ('%d+%s*%-%s*%d+') or -- digit hyphen digit | ||
item:match (' | item:match ('%a+%s*%-%s*%a+') then -- letter hyphen letter | ||
item:match (' | |||
item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters | item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters | ||
else | else | ||
item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous | item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous white space | ||
end | end | ||
end | end | ||
item = item:gsub ('^%(%((.+)%)%)$', '%1'); -- remove the accept-this-as-written markup | |||
table.insert (out, item); -- add the (possibly modified) item to the output table | table.insert (out, item); -- add the (possibly modified) item to the output table | ||
end | end | ||
return table.concat (out, ', '); -- concatenate the output table into a comma separated string | |||
end | end | ||
--[[--------------------------< S A F E _ J O I N >----------------------------- | --[[--------------------------< S A F E _ J O I N >------------------------------------------------------------ | ||
Joins a sequence of strings together while checking for duplicate separation characters. | Joins a sequence of strings together while checking for duplicate separation characters. | ||
Line 974: | Line 918: | ||
local function safe_join( tbl, duplicate_char ) | local function safe_join( tbl, duplicate_char ) | ||
local f = {}; -- create a function table appropriate to type of ' | local f = {}; -- create a function table appropriate to type of 'dupicate character' | ||
if 1 == #duplicate_char then -- for single byte | if 1 == #duplicate_char then -- for single byte ascii characters use the string library functions | ||
f.gsub = string.gsub | f.gsub=string.gsub | ||
f.match = string.match | f.match=string.match | ||
f.sub = string.sub | f.sub=string.sub | ||
else -- for multi-byte characters use the ustring library functions | else -- for multi-byte characters use the ustring library functions | ||
f.gsub = mw.ustring.gsub | f.gsub=mw.ustring.gsub | ||
f.match = mw.ustring.match | f.match=mw.ustring.match | ||
f.sub = mw.ustring.sub | f.sub=mw.ustring.sub | ||
end | end | ||
Line 995: | Line 939: | ||
str = value; -- assign value to it (first time through the loop) | str = value; -- assign value to it (first time through the loop) | ||
elseif value ~= '' then | elseif value ~= '' then | ||
if value:sub(1, 1) == '<' then -- | if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup. | ||
comp = value:gsub( "%b<>", "" ); -- remove | comp = value:gsub( "%b<>", "" ); -- remove html markup (<span>string</span> -> string) | ||
else | else | ||
comp = value; | comp = value; | ||
end | end | ||
-- typically duplicate_char is sepc | -- typically duplicate_char is sepc | ||
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character? | 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 the | -- 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 = f.sub(str, -1, -1); -- get the last character of the output string | end_chr = f.sub(str, -1,-1); -- get the last character of the output string | ||
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" | -- 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 = f.sub(str, 1, -2); | str = f.sub(str, 1,-2); -- remove it | ||
elseif end_chr == "'" then -- if it might be | elseif end_chr == "'" then -- if it might be wikimarkup | ||
if f.sub(str, -3, -1) == duplicate_char .. "''" then | if f.sub(str, -3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc'' | ||
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back '' | str = f.sub(str, 1, -4) .. "''"; -- remove them and add back '' | ||
elseif f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]'' | 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 f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]'' | 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 | elseif end_chr == "]" then -- if it might be wikimarkup | ||
if f.sub(str, -3, -1) == duplicate_char .. "]]" then | if f.sub(str, -3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink | ||
trim = true; | trim = true; | ||
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link | 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 f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link | elseif f.sub(str, -2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link | ||
trim = true; | trim = true; | ||
elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title. | 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 f.sub(str, -2, -1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> | if f.sub(str, -2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> | ||
str = f.sub(str, 1, -3); | str = f.sub(str, 1,-3); -- remove them both | ||
end | end | ||
end | end | ||
if trim then | if trim then | ||
if value ~= comp then -- value does not equal comp when value contains | if value ~= comp then -- value does not equal comp when value contains html markup | ||
local dup2 = duplicate_char; | local dup2 = duplicate_char; | ||
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it | if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it | ||
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows | value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup | ||
else | else | ||
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character | value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character | ||
Line 1,044: | Line 988: | ||
end | end | ||
end | end | ||
str = str .. value; -- add it to the output string | str = str .. value; --add it to the output string | ||
end | end | ||
end | end | ||
Line 1,051: | Line 995: | ||
--[[--------------------------< I S _ S U F F I X >----------------------------- | --[[--------------------------< I S _ S U F F I X >------------------------------------------------------------ | ||
returns true is suffix is properly formed Jr, Sr, or ordinal in the range | returns true is suffix is properly formed Jr, Sr, or ordinal in the range 2–9. Puncutation not allowed. | ||
Puncutation not allowed. | |||
]] | ]] | ||
local function is_suffix (suffix) | local function is_suffix (suffix) | ||
if | if in_array (suffix, {'Jr', 'Sr', '2nd', '3rd'}) or suffix:match ('^%dth$') then | ||
return true; | return true; | ||
end | end | ||
Line 1,066: | Line 1,009: | ||
--[[--------------------< 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 >-------------------------------------------- | ||
For Vancouver | For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a name | ||
(read ASCII) characters. When a name uses characters that contain diacritical | uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character. | ||
marks, those characters are to | When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters. | ||
character. When a name is written using a non-Latin alphabet or logogram, that | These things are not currently possible in this module so are left to the editor to do. | ||
name is to be transliterated into Latin characters. | |||
This test allows |first= and |last= names to contain any of the letters defined | This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets | ||
in the four Unicode Latin character sets | |||
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A | [http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A | ||
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF | [http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF | ||
Line 1,082: | Line 1,022: | ||
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F | [http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F | ||
|lastn= also allowed to contain hyphens, spaces, and apostrophes. | |lastn= also allowed to contain hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) | ||
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods | |firstn= also allowed to contain hyphens, spaces, apostrophes, and periods | ||
This original test: | This original test: | ||
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") | if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then | ||
was written ouside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position. | |||
was written | The test has been rewritten to use decimal character escape sequence for the individual bytes of the unicode characters so that it is not necessary | ||
gets confused between character insertion point and cursor position. The test has | to use an external editor to maintain this code. | ||
been rewritten to use decimal character escape sequence for the individual bytes | |||
of the | |||
to maintain this code. | |||
\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls) | \195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls) | ||
Line 1,102: | Line 1,038: | ||
]] | ]] | ||
local function is_good_vanc_name (last, first | local function is_good_vanc_name (last, first) | ||
local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it | |||
if is_set (suffix) then | |||
if | |||
if not is_suffix (suffix) then | if not is_suffix (suffix) then | ||
add_vanc_error ( | add_vanc_error ('suffix'); | ||
return false; -- not a name with an appropriate suffix | return false; -- not a name with an appropriate suffix | ||
end | end | ||
Line 1,117: | Line 1,049: | ||
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or | if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or | ||
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then | nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then | ||
add_vanc_error ( | add_vanc_error ('non-Latin character'); | ||
return false; -- not a string of | return false; -- not a string of latin characters; Vancouver requires Romanization | ||
end; | end; | ||
return true; | return true; | ||
Line 1,126: | Line 1,058: | ||
--[[--------------------------< 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 >------------------------------------------ | ||
Attempts to convert names to initials in support of |name-list- | Attempts to convert names to initials in support of |name-list-format=vanc. | ||
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. | Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/. | ||
See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/. | |||
Vancouver style requires family rank designations (Jr, II, III, etc | Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/. | ||
as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/. | This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials. | ||
This code only accepts and understands generational suffix in the Vancouver format | |||
because Roman numerals look like, and can be mistaken for, initials. | |||
This function uses ustring functions because firstname initials may be any of the | This function uses ustring functions because firstname initials may be any of the unicode Latin characters accepted by is_good_vanc_name (). | ||
]] | ]] | ||
local function reduce_to_initials(first | local function reduce_to_initials(first) | ||
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$"); | local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$"); | ||
if not name then -- if not initials and a suffix | if not name then -- if not initials and a suffix | ||
name = mw.ustring.match(first, "^(%u+)$"); -- is it just | name = mw.ustring.match(first, "^(%u+)$"); -- is it just intials? | ||
end | end | ||
Line 1,154: | Line 1,082: | ||
return first; -- one or two initials and a valid suffix so nothing to do | return first; -- one or two initials and a valid suffix so nothing to do | ||
else | else | ||
add_vanc_error ( | add_vanc_error ('suffix'); -- one or two initials with invalid suffix so error message | ||
return first; -- and return first unmolested | return first; -- and return first unmolested | ||
end | end | ||
Line 1,162: | Line 1,090: | ||
end | end | ||
end -- if here then name has 3 or more uppercase letters so treat them as a word | end -- if here then name has 3 or more uppercase letters so treat them as a word | ||
local initials, names = {}, {}; -- tables to hold name parts and initials | local initials, names = {}, {}; -- tables to hold name parts and initials | ||
Line 1,177: | Line 1,106: | ||
end | end | ||
if 3 > i then | if 3 > i then | ||
table.insert (initials, mw.ustring.sub(names[i], 1, 1)); | table.insert (initials, mw.ustring.sub(names[i],1,1)); -- insert the intial at end of initials table | ||
end | end | ||
i = i + 1; -- bump the counter | i = i+1; -- bump the counter | ||
end | end | ||
Line 1,186: | Line 1,115: | ||
--[[--------------------------< L I S T _ P E O P L E >-------------------------- | --[[--------------------------< L I S T _ P E O P L E >------------------------------------------------------- | ||
Formats a list of people (authors | Formats a list of people (e.g. authors / editors) | ||
]] | ]] | ||
local function list_people (control, people, etal) | local function list_people(control, people, etal) | ||
local sep; | local sep; | ||
local namesep; | local namesep; | ||
local format = control.format | local format = control.format | ||
local maximum = control.maximum; | local maximum = control.maximum | ||
local | local lastauthoramp = control.lastauthoramp; | ||
local text = {} | |||
if 'vanc' == format then -- Vancouver-like name styling? | if 'vanc' == format then -- Vancouver-like author/editor name styling? | ||
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between | sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma | ||
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space | namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space | ||
else | else | ||
sep = cfg.presentation['sep_nl']; -- name-list separator between | sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon | ||
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space> | namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space> | ||
end | end | ||
if sep:sub (-1, -1) ~= " " then sep = sep .. " " end | if sep:sub(-1,-1) ~= " " then sep = sep .. " " end | ||
if | if is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for authors | ||
for i, person in ipairs (people) do | for i,person in ipairs(people) do | ||
if | if is_set(person.last) then | ||
local mask = person.mask | local mask = person.mask | ||
local one | local one | ||
local sep_one = sep; | local sep_one = sep; | ||
if is_set (maximum) and i > maximum then | |||
if | |||
etal = true; | etal = true; | ||
break; | break; | ||
elseif (mask ~= nil) then | |||
local n = tonumber(mask) | |||
if (n ~= nil) then | |||
local n = tonumber (mask) | one = string.rep("—",n) | ||
if n then | |||
one = | |||
else | else | ||
one = mask; | one = mask; | ||
sep_one = " "; | sep_one = " "; | ||
end | end | ||
else | else | ||
one = person.last | one = person.last | ||
local first = person.first | local first = person.first | ||
if | if is_set(first) then | ||
if ("vanc" == format) then | 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 | 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 | 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 | |||
if is_set(person.link) and person.link ~= control.page_name then | |||
one = make_wikilink (person.link, one); -- link author/editor if this page is not the author's/editor's page | |||
end | end | ||
end | end | ||
table.insert( text, one ) | |||
table.insert( text, sep_one ) | |||
end | end | ||
end | end | ||
local count = # | local count = #text / 2; -- (number of names + number of separators) divided by 2 | ||
if 0 | if count > 0 then | ||
if 1 | if count > 1 and is_set(lastauthoramp) and not etal then | ||
text[#text-2] = " & "; -- replace last separator with ampersand text | |||
end | end | ||
text[#text] = nil; -- erase the last separator | |||
end | end | ||
local result = table.concat ( | local result = table.concat(text) -- construct list | ||
if etal and | if etal and is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list | ||
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've | result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've go a last-first list and etal so add et al. | ||
end | end | ||
return result, count | return result, count | ||
end | end | ||
Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise | --[[--------------------------< A N C H O R _ I D >------------------------------------------------------------ | ||
returns an empty string. | |||
Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise returns an empty string. | |||
namelist is one of the contributor-, author-, or editor-name lists chosen in that | namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year. | ||
order. year is Year or anchor_year. | |||
]] | ]] | ||
local function anchor_id (namelist, year) | |||
local function | local names={}; -- a table for the one to four names and year | ||
local names={}; | for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names | ||
for i,v in ipairs (namelist) do | names[i] = v.last | ||
names[i] = v.last | if i == 4 then break end -- if four then done | ||
if i == 4 then break end | |||
end | end | ||
table.insert (names, year); | table.insert (names, year); -- add the year at the end | ||
local id = table.concat(names); | local id = table.concat(names); -- concatenate names and year for CITEREF id | ||
if | if is_set (id) then -- if concatenation is not an empty string | ||
return "CITEREF" .. id; | return "CITEREF" .. id; -- add the CITEREF portion | ||
else | else | ||
return ''; | return ''; -- return an empty string; no reason to include CITEREF id in this citation | ||
end | end | ||
end | end | ||
--[[---------------------< N A M E _ H A S _ E T A L >-------------------------- | --[[--------------------------< N A M E _ H A S _ E T A L >---------------------------------------------------- | ||
Evaluates the content of name parameters (author, editor, etc | Evaluates the content of name parameters (author, editor, etc) for variations on the theme of et al. If found, | ||
the theme of et al. If found, the et al. is removed, a flag is set to true and | the et al. is removed, a flag is set to true and the function returns the modified name and the flag. | ||
the function returns the modified name and the flag. | |||
This function never sets the flag to false but returns | This function never sets the flag to false but returns it's previous state because it may have been set by | ||
it may have been set by previous passes through this function or by the associated | previous passes through this function or by the associated |display-<names>=etal parameter | ||
|display-<names>=etal parameter | |||
]] | ]] | ||
Line 1,324: | Line 1,229: | ||
local function name_has_etal (name, etal, nocat, param) | local function name_has_etal (name, etal, nocat, param) | ||
if | if is_set (name) then -- name can be nil in which case just return | ||
local patterns = cfg.et_al_patterns; | local patterns = cfg.et_al_patterns; --get patterns from configuration | ||
for _, pattern in ipairs (patterns) do -- loop through all of the patterns | for _, pattern in ipairs (patterns) do -- loop through all of the patterns | ||
Line 1,332: | Line 1,237: | ||
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) | etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) | ||
if not nocat then -- no categorization for |vauthors= | if not nocat then -- no categorization for |vauthors= | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added | ||
end | end | ||
end | end | ||
Line 1,338: | Line 1,243: | ||
end | end | ||
return name, etal; | return name, etal; -- | ||
-- | |||
end | end | ||
--[[-------------------< N A M E _ H A S _ E D _ M A R K U P >------------------ | --[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------ | ||
Evaluates the content of author and editor parameters for | Evaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc. | ||
ed, ed., eds, (Ed.), etc. These | These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function | ||
are redundant in editor parameters. If found, the function adds the editor markup | adds the editor markup maintenance category. | ||
maintenance category. | |||
]] | ]] | ||
local function name_has_ed_markup (name, list_name) | local function name_has_ed_markup (name, list_name) | ||
local _, pattern; | |||
local patterns = cfg.editor_markup_patterns; -- get patterns from configuration | local patterns = cfg.editor_markup_patterns; -- get patterns from configuration | ||
if | if is_set (name) then | ||
for _, pattern in ipairs (patterns) do -- spin through patterns table and | for _, pattern in ipairs (patterns) do -- spin through patterns table and | ||
if name:match (pattern) then | 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; | break; | ||
end | end | ||
end | end | ||
end | end | ||
return name; -- and done | |||
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 _ M U L T _ N A M E S >---------------------------------------- | ||
Evaluates the content of | Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are | ||
Multiple names are indicated if there is more than one comma or | indicated if there is more than one comma and or semicolon. If found, the function adds the multiple name | ||
(author or editor) maintenance category. | |||
If | |||
]] | ]] | ||
local function name_has_mult_names (name, list_name) | local function name_has_mult_names (name, list_name) | ||
local count, _; | |||
if | 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 | |||
end | end | ||
--[[------------------------< N A M E _ C H E C K S >--------------------------- | --[[--------------------------< 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 | |||
This function calls various name checking functions used to validate the content | parameters. | ||
of the various name-holding parameters. | |||
]] | ]] | ||
local function name_checks (last, first, list_name) | 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 | |||
if | last = last:match ('^%(%((.*)%)%)$'); -- strip parens | ||
last | 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 | |||
name_has_mult_names (last, list_name); | |||
name_has_ed_markup (last, list_name); | |||
end | end | ||
end | end | ||
if is_set (first) then | |||
if | if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written | ||
first | first = first:match ('^%(%((.*)%)%)$'); -- strip parens | ||
else | |||
first = name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation | |||
end | end | ||
end | end | ||
return last, first; -- done | return last, first; -- done | ||
end | 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 >---------------------------------------------------- | ||
Gets name list from the input arguments | Gets name list from the input arguments | ||
Searches through args in sequential order to find |lastn= and |firstn= parameters | Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters. | ||
(or their aliases), and their matching link and mask parameters. Stops searching | Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't | ||
when both |lastn= and |firstn= are not found in args after two sequential attempts: | find |last4= and |last5= then the search is done. | ||
found |last1=, |last2=, and |last3= but doesn't find |last4= and |last5= then the | |||
search is done. | |||
This function emits an error message when there is a |firstn= without a matching | This function emits an error message when there is a |firstn= without a matching |lastn=. When there are 'holes' in the list of last names, |last1= and |last3= | ||
|lastn=. When there are 'holes' in the list of last names, |last1= and |last3= | are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=. | ||
are present but |last2= is missing, an error message is emitted. |lastn= is not | |||
required to have a matching |firstn=. | |||
When an author or editor parameter contains some form of 'et al.', the 'et al.' | When an author or editor parameter contains some form of 'et al.', the 'et al.' is stripped from the parameter and a flag (etal) returned | ||
is stripped from the parameter and a flag (etal) returned that will cause list_people() | that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps 'et al.' out of the | ||
to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps | template's metadata. When this occurs, the page is added to a maintenance category. | ||
'et al.' out of the template's metadata. When this occurs, | |||
]] | ]] | ||
local function extract_names(args, list_name) | local function extract_names(args, list_name) | ||
local names = {}; | local names = {}; -- table of names | ||
local last; | local last; -- individual name components | ||
local first; | local first; | ||
local link; | local link; | ||
local mask; | local mask; | ||
local i = 1; | local i = 1; -- loop counter/indexer | ||
local n = 1; | local n = 1; -- output table indexer | ||
local count = 0; | local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors) | ||
local etal = false; | local etal=false; -- return value set to true when we find some form of et al. in an author parameter | ||
local last_alias, first_alias | local last_alias, first_alias; -- selected parameter aliases used in error messaging | ||
while true do | while true do | ||
last, last_alias = | last, last_alias = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1 | ||
first, first_alias = | first, first_alias = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ); | ||
link | link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ); | ||
mask = | mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i ); | ||
last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al. | last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al. | ||
first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al. | first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al. | ||
last, first = name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc | 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 | ||
table.insert( z.message_tail, { set_error( 'first_missing_last', {first_alias, first_alias:gsub('first', 'last')}, true ) } ); -- add this error message | |||
table.insert (z.message_tail, { | |||
elseif not first and not last then -- if both firstn and lastn aren't found, are we done? | elseif not first and not last then -- if both firstn and lastn aren't found, are we done? | ||
count = count + 1; -- number of times we haven't found last and first | count = count + 1; -- number of times we haven't found last and first | ||
Line 1,507: | Line 1,364: | ||
end | end | ||
else -- we have last with or without a first | else -- we have last with or without a first | ||
link_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup | |||
names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only) | names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only) | ||
n = n + 1; -- point to next location in the names table | n = n + 1; -- point to next location in the names table | ||
if 1 == count then -- if the previous name was missing | if 1 == count then -- if the previous name was missing | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'missing_name', {list_name:match ("(%w+)List"):lower(), i-1}, true ) } ); -- add this error message | ||
end | end | ||
count = 0; -- reset the counter, we're looking for two consecutive missing names | count = 0; -- reset the counter, we're looking for two consecutive missing names | ||
Line 1,523: | Line 1,376: | ||
end | end | ||
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 >------------------------------------------------ | ||
Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code. | Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code. | ||
Returns the language name and associated two- or three-character code. Because | Returns the language name and associated two- or three-character code. Because case of the source may be incorrect | ||
case of the source may be incorrect or different from the case that WikiMedia uses, | or different from the case that WikiMedia uses, the name comparisons are done in lower case and when a match is | ||
the name comparisons are done in lower case and when a match is found, the Wikimedia | found, the Wikimedia version (assumed to be correct) is returned along with the code. When there is no match, we | ||
version (assumed to be correct) is returned along with the code. When there is no | return the original language name string. | ||
match, we return the original language name string. | |||
mw.language.fetchLanguageNames(<local wiki language>, 'all') returns a list of | mw.language.fetchLanguageNames(<local wiki language>, 'all') returns a list of languages that in some cases may include | ||
languages that in some cases may include extensions. For example, code 'cbk-zam' | extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support | ||
and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support | code 'cbk' or name 'Chavacano'. Most (all?) of these languages are not used a 'language' codes per se, rather they | ||
code 'cbk' or name 'Chavacano'. Most (all?) of these languages are not used a | are used as sub-domain names: cbk-zam.wikipedia.org. A list of language names and codes supported by fetchLanguageNames() | ||
'language' codes per se, rather they are used as sub-domain names: cbk-zam.wikipedia.org. | can be found at Template:Citation Style documentation/language/doc | ||
A list of language names and codes supported by fetchLanguageNames() can be found | |||
at Template:Citation Style documentation/language/doc | |||
Names that are included in the list will be found if that name is provided in the | Names that are included in the list will be found if that name is provided in the |language= parameter. For example, | ||
|language= parameter. For example, if |language=Chavacano de Zamboanga, that name | if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'. When names are found | ||
will be found with the associated code 'cbk-zam'. When names are found and the | and the associated code is not two or three characters, this function returns only the WikiMedia language name. | ||
associated code is not two or three characters, this function returns only the | |||
WikiMedia language name. | |||
Some language names have multiple entries under different codes: | Some language names have multiple entries under different codes: | ||
Line 1,564: | Line 1,412: | ||
end | end | ||
local ietf_code; -- because some languages have both | local ietf_code; -- because some languages have both ietf-like codes and iso 639-like codes | ||
local ietf_name; | local ietf_name; | ||
local langlc = mw.ustring.lower (lang); -- lower | 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) | |||
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons | |||
for code, name in pairs ( | for code, name in pairs(languages) do -- scan the list to see if we can find our language | ||
if langlc == mw.ustring.lower (name) then | if langlc == mw.ustring.lower(name) then | ||
if 2 == | if 2 == code:len() or 3 == code:len() then -- two- or three-character codes only; extensions not supported | ||
return name, code; -- so return the name and the code | return name, code; -- so return the name and the code | ||
end | end | ||
ietf_code = code; -- remember that we found an | ietf_code = code; -- remember that we found an ietf-like code and save its name | ||
ietf_name = name; -- but keep looking for a 2- or 3-char code | ietf_name = name; -- but keep looking for a 2- or 3-char code | ||
end | end | ||
end | end | ||
-- didn't find name with 2- or 3-char code; if | -- didn't find name with 2- or 3-char code; if ietf-like code found return | ||
return ietf_code and ietf_name or lang; -- associated name; return original language text else | return ietf_code and ietf_name or lang; -- associated name; return original language text else | ||
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 >------------------------------------------ | ||
Gets language name from a provided two- or three-character ISO 639 code. If a code | Gets language name from a provided two- or three-character ISO 639 code. If a code is recognized by MediaWiki, | ||
is recognized by MediaWiki, use the returned name; if not, then use the value that | use the returned name; if not, then use the value that was provided with the language parameter. | ||
was provided with the language parameter. | |||
When |language= contains a recognized language (either code or name), the page is | When |language= contains a recognized language (either code or name), the page is assigned to the category for | ||
assigned to the category for that code: Category:Norwegian-language sources (no). | that code: Category:Norwegian-language sources (no). For valid three-character code languages, the page is assigned | ||
For valid three-character code languages, the page is assigned to the single category | to the single category for '639-2' codes: Category:CS1 ISO 639-2 language sources. | ||
for '639-2' codes: Category:CS1 ISO 639-2 language sources. | |||
Languages that are the same as the local wiki are not categorized. MediaWiki does | Languages that are the same as the local wiki are not categorized. MediaWiki does not recognize three-character | ||
not recognize three-character equivalents of two-character codes: code 'ar' is | equivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not. | ||
recognized | |||
This function supports multiple languages in the form |language=nb, French, th | This function supports multiple languages in the form |language=nb, French, th where the language names or codes are | ||
where the language names or codes are separated from each other by commas | separated from each other by commas. | ||
]] | ]] | ||
Line 1,610: | Line 1,456: | ||
local names_table = {}; -- table made from the value assigned to |language= | local names_table = {}; -- table made from the value assigned to |language= | ||
local this_wiki_name = mw.language.fetchLanguageName ( | local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki | ||
local this_wiki_code = this_wiki:getCode() -- get this wiki's language code | |||
local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, this_wiki_code); -- get this wiki's language name | |||
names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list | names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list | ||
Line 1,618: | Line 1,466: | ||
if name then -- there was a remapped code so | if name then -- there was a remapped code so | ||
lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip ietf tags from code | |||
lang = lang: | else | ||
if lang:match ('^%a%a%-') then -- strip ietf tags from code; TODO: is there a need to support 3-char with tag? | |||
lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code? | |||
end | end | ||
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(), | name = mw.language.fetchLanguageName (lang:lower(), this_wiki_code); -- get language name if |language= is a proper code | ||
end | end | ||
end | end | ||
if | if is_set (name) then -- if |language= specified a valid code | ||
code = lang:lower(); -- save it | code = lang:lower(); -- save it | ||
else | else | ||
name, code = get_iso639_code (lang, | name, code = get_iso639_code (lang, this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) | ||
end | end | ||
if | 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 | name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names | ||
if | 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' .. 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, {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template | |||
end | end | ||
end | end | ||
else | else | ||
add_maint_cat ('unknown_lang'); -- add maint category if not already added | |||
end | end | ||
Line 1,653: | Line 1,499: | ||
name = ''; -- so we can reuse it | name = ''; -- so we can reuse it | ||
end | end | ||
name = | code = #language_list -- reuse code as number of languages in the list | ||
if 2 >= code then | |||
name = table.concat (language_list, cfg.messages['parameter-pair-separator']) -- insert '<space>and<space>' between two language names | |||
elseif 2 < code then | |||
name = table.concat (language_list, ', '); -- and concatenate with '<comma><space>' separators | |||
name = name:gsub (', ([^,]+)$', cfg.messages['parameter-final-separator'] .. '%1'); -- replace last '<comma><space>' separator with '<comma><space>and<space>' separator | |||
end | |||
if this_wiki_name == name then | if this_wiki_name == name then | ||
return ''; -- if one language and that language is this wiki's return an empty string (no annotation) | return ''; -- if one language and that language is this wiki's return an empty string (no annotation) | ||
Line 1,665: | Line 1,516: | ||
end | end | ||
--[[--------------------------< S E T _ 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 | |||
At en.wiki, for cs1: | |||
ps gets: '.' | |||
sep gets: '.' | |||
]] | ]] | ||
if | local function set_cs1_style (ps) | ||
if not is_set (ps) then -- unless explicitely set to something | |||
ps = cfg.presentation['ps_cs1']; -- terminate the rendered citation | |||
end | end | ||
return cfg.presentation['sep_cs1'], ps; -- element separator | |||
return | |||
end | end | ||
--[[--------------------------< S E T _ C S 2 _ S T Y L E >---------------------------------------------------- | |||
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: ',' | |||
] | ]] | ||
local function | local function set_cs2_style (ps, ref) | ||
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default | |||
ps = cfg.presentation['ps_cs2']; -- terminate the rendered citation | |||
end | |||
if not is_set (ref) then -- if |ref= is not set | |||
ref = "harv"; -- set default |ref=harv | |||
end | |||
return cfg.presentation['sep_cs2'], ps, ref; -- element separator | |||
end | end | ||
--[[--------------------------< S T | --[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >---------------------- | ||
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish | |||
rendered style. | |||
is not set | |||
]] | ]] | ||
local function | local function get_settings_from_cite_class (ps, ref, cite_class) | ||
if | local sep; | ||
if (cite_class == "citation") then -- for citation templates (CS2) | |||
sep, ps, ref = set_cs2_style (ps, ref); | |||
else -- not a citation template so CS1 | |||
sep, ps = set_cs1_style (ps); | |||
end | end | ||
return | |||
return sep, ps, ref -- return them all | |||
end | end | ||
--[[---------------------< | --[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------ | ||
Establish basic style settings to be used when rendering the citation. Uses |mode= if set and valid or uses | |||
config.CitationClass from the template's #invoke: to establish style. | |||
]] | ]] | ||
local function | local function set_style (mode, ps, ref, cite_class) | ||
local sep; | |||
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style | |||
sep, ps, ref = set_cs2_style (ps, ref); | |||
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style | |||
sep, ps = set_cs1_style (ps); | |||
else -- anything but cs1 or cs2 | |||
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass | |||
end | |||
if 'none' == ps:lower() then -- if assigned value is 'none' then | |||
ps = ''; -- set to empty string | |||
end | end | ||
return | return sep, ps, ref | ||
end | end | ||
--[[----------< | --[=[-------------------------< I S _ P D F >------------------------------------------------------------------ | ||
Determines if a url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.css]] when | |||
applying the pdf icon to external links. | |||
returns true if file extension is one of the recognized extensions, else false | |||
]] | ]=] | ||
local function | local function is_pdf (url) | ||
return url:match ('%.pdf$') or url:match ('%.PDF$') or | |||
url:match ('%.pdf[%?#]') or url:match ('%.PDF[%?#]') or | |||
url:match ('%.PDF#') or url:match ('%.pdf#'); | |||
end | end | ||
--[[--------------------------< E | --[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ | ||
Applies css style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does | |||
not have a matching url parameter. If the format parameter is not set and the url contains a file extension that | |||
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with | |||
the appropriate styling. | |||
]] | ]] | ||
local function | local function style_format (format, url, fmt_param, url_param) | ||
if | if is_set (format) then | ||
format = wrap_style ('format', format); -- add leading space, parentheses, resize | |||
if not is_set (url) then | |||
format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message | |||
if | |||
end | end | ||
elseif is_pdf (url) then -- format is not set so if url is a pdf file then | |||
format = wrap_style ('format', 'PDF'); -- set format to pdf | |||
else | |||
format = ''; -- empty string for concatenation | |||
end | end | ||
return format; | |||
end | end | ||
--[ | --[[--------------------------< G E T _ D I S P L A Y _ N A M E S >-------------------------------------------- | ||
Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag | |||
to indicate when et al. should be appended to the name list. | |||
When the value assigned to |display-xxxxors= is a number greater than or equal to zero, return the number and | |||
the previous state of the 'etal' flag (false by default but may have been set to true if the name list contains | |||
some variant of the text 'et al.'). | |||
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number that is one greater than the | |||
number of authors in the list and set the 'etal' flag true. This will cause the list_people() to display all of | |||
the names in the name list followed by 'et al.' | |||
In all other cases, returns nil and the previous state of the 'etal' flag. | |||
inputs: | |||
max: A['DisplayAuthors'] or A['DisplayEditors']; a number or some flavor of etal | |||
count: #a or #e | |||
list_name: 'authors' or 'editors' | |||
local | etal: author_etal or editor_etal | ||
]] | |||
if | |||
local function get_display_names (max, count, list_name, etal) | |||
if is_set (max) then | |||
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings | |||
max = count + 1; -- number of authors + 1 so display all author name plus et al. | |||
etal = true; -- overrides value set by extract_names() | |||
elseif max:match ('^%d+$') then -- if is a string of numbers | |||
max = tonumber (max); -- make it a number | |||
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors | |||
add_maint_cat ('disp_name', cfg.special_case_translation [list_name]); | |||
end | end | ||
else -- not a valid keyword or number | |||
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message | |||
max = nil; -- unset; as if |display-xxxxors= had not been set | |||
end | end | ||
end | |||
return | return max, etal; | ||
end | end | ||
--[[--------------------------< P A | --[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------ | ||
Adds page to Category:CS1 maint: extra text if |page= or |pages= has what appears to be some form of p. or pp. | |||
abbreviation in the first characters of the parameter content. | |||
check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value: | |||
| | good pattern: '^P[^%.P%l]' matches when |page(s)= begins PX or P# but not Px where x and X are letters and # is a dgiit | ||
bad pattern: '^[Pp][Pp]' matches matches when |page(s)= begins pp or pP or Pp or PP | |||
]] | |||
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 bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; | |||
if not page:match (good_pattern) and (page:match (bad_pattern) or page:match ('^[Pp]ages?')) then | |||
add_maint_cat ('extra_text'); | |||
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 | end | ||
table.insert (output_table, name); -- and add corporate name to the output table | |||
table.insert (output_link_table, ''); -- no wikilink | |||
else | 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 | |||
if | |||
end | end | ||
end | end | ||
i = i+1; | |||
end | |||
return output_table; | |||
end | |||
return | |||
end | end | ||
--[[--------------------------< S E | --[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >-------------------------------- | ||
This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and | |||
|xxxxor-linkn= in args. It then returns a table of assembled names just as extract_names() does. | |||
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names | |||
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance | |||
tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests. | |||
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th. | |||
This function sets the vancouver error when a reqired comma is missing and when there is a space between an author's initials. | |||
]] | ]] | ||
local function | local function parse_vauthors_veditors (args, vparam, list_name) | ||
local | local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn= | ||
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 last, first, link, mask, suffix; | |||
local corporate = false; | |||
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 | |||
if true == | for i, v_name in ipairs(v_name_table) do | ||
if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to supress vanc formatting and error detection | |||
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor | |||
last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses | |||
corporate = true; -- flag used in list_people() | |||
elseif string.find(v_name, "%s") then | |||
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters; | |||
add_vanc_error ('punctuation'); | |||
end | |||
local lastfirstTable = {} | |||
lastfirstTable = mw.text.split(v_name, "%s") | |||
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials | |||
if is_suffix (first) then -- if a valid suffix | |||
suffix = first -- save it as a suffix and | |||
first = table.remove(lastfirstTable); -- get what should be the initials from the table | |||
end -- no suffix error message here because letter combination may be result of Romanization; check for digits? | |||
last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials | |||
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then | |||
add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing | |||
end | |||
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test | |||
add_vanc_error ('name'); -- matches a space between two intiials | |||
end | |||
else | |||
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor | |||
last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this? | |||
end | |||
if is_set (first) then | |||
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else | |||
add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials | |||
end | |||
is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit | |||
if is_set (suffix) then | |||
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials | |||
suffix = ''; -- unset so we don't add this suffix to all subsequent names | |||
end | |||
else | |||
if not corporate then | |||
is_good_vanc_name (last, ''); | |||
end | |||
end | |||
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ) or v_link_table[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 | |||
end | |||
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 >------------------------ | ||
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or | |||
of | select one of |editors=, |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list. | ||
or | |||
of the | |||
Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest and | |||
similarly, |editorn= (and aliases) highest and |editors= lowest | |||
local function is_valid_parameter_value (value, name, possible | When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second | ||
if not | test which mimicks the test used in extract_names() when looking for a hole in the author name list. There may be a better | ||
return | way to do this, I just haven't discovered what that way is. | ||
elseif | |||
return | Emits an error message when more than one xxxxor name source is provided. | ||
else | |||
table.insert( z.message_tail, { | In this function, vxxxxors = vauthors or veditors; xxxxors = authors or editors as appropriate. | ||
return | |||
]] | |||
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name) | |||
local lastfirst = false; | |||
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 .. '-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; | |||
end | |||
if (is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions | |||
(is_set (vxxxxors) and is_set (xxxxors)) or | |||
(true == lastfirst and is_set (xxxxors)) then | |||
local err_name; | |||
if 'AuthorList' == list_name then -- figure out which name should be used in error message | |||
err_name = 'author'; | |||
else | |||
err_name = 'editor'; | |||
end | |||
table.insert( z.message_tail, { set_error( 'redundant_parameters', | |||
{err_name .. '-name-list parameters'}, true ) } ); -- add error message | |||
end | |||
if true == lastfirst then return 1 end; -- return a number indicating which author name source to use | |||
if is_set (vxxxxors) then return 2 end; | |||
if is_set (xxxxors) then return 3 end; | |||
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last | |||
end | |||
--[[--------------------------< I S _ V A L I D _ P A R A M E T E R _ V A L U E >------------------------------ | |||
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 | |||
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. | |||
]] | |||
local function is_valid_parameter_value (value, name, possible) | |||
if not is_set (value) then | |||
return true; -- an empty parameter is ok | |||
elseif in_array(value:lower(), possible) then | |||
return true; | |||
else | |||
table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message | |||
return false | |||
end | end | ||
end | end | ||
Line 2,071: | Line 1,900: | ||
local function terminate_name_list (name_list, sepc) | local function terminate_name_list (name_list, sepc) | ||
if (string.sub (name_list, -3, -1) == sepc .. '. ') then | if (string.sub (name_list,-3,-1) == sepc .. '. ') then -- if already properly terminated | ||
return name_list; -- just return the name list | 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 | 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 | ||
return name_list .. sepc .. ' '; -- otherwise | return name_list .. sepc .. ' '; -- otherwise terninate the name list | ||
end | end | ||
end | end | ||
Line 2,089: | Line 1,918: | ||
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower) | local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower) | ||
if not | if not is_set (volume) and not is_set (issue) then | ||
return ''; | return ''; | ||
end | end | ||
if 'magazine' == cite_class or ( | if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then | ||
if | if is_set (volume) and is_set (issue) then | ||
return wrap_msg ('vol-no', {sepc, | return wrap_msg ('vol-no', {sepc, volume, issue}, lower); | ||
elseif | elseif is_set (volume) then | ||
return wrap_msg ('vol', {sepc, | return wrap_msg ('vol', {sepc, volume}, lower); | ||
else | else | ||
return wrap_msg ('issue', {sepc, issue}, lower); | return wrap_msg ('issue', {sepc, issue}, lower); | ||
end | end | ||
end | end | ||
local vol = ''; -- here for all cites except magazine | local vol = ''; -- here for all cites except magazine | ||
if | if is_set (volume) then | ||
if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$') then -- volume value is all digits or all uppercase | if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')then -- volume value is all digits or all uppercase roman numerals | ||
vol = | vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- render in bold face | ||
elseif (4 < mw.ustring.len(volume)) then -- not all digits or | elseif (4 < mw.ustring.len(volume)) then -- not all digits or roman numerals and longer than 4 characters | ||
vol = | vol = substitute (cfg.messages['j-vol'], {sepc, volume}); -- not bold | ||
add_prop_cat ('long_vol'); | |||
else -- four or less characters | else -- four or less characters | ||
vol = | vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- bold | ||
end | end | ||
end | end | ||
if | if is_set (issue) then | ||
return vol . | return vol .. substitute (cfg.messages['j-issue'], issue); | ||
end | end | ||
return vol; | return vol; | ||
Line 2,138: | Line 1,963: | ||
local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower) | local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower) | ||
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators | if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators | ||
if | if is_set (sheet) then | ||
if 'journal' == origin then | if 'journal' == origin then | ||
return '', '', wrap_msg ('j-sheet', sheet, lower), ''; | return '', '', wrap_msg ('j-sheet', sheet, lower), ''; | ||
Line 2,144: | Line 1,969: | ||
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), ''; | return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), ''; | ||
end | end | ||
elseif | elseif is_set (sheets) then | ||
if 'journal' == origin then | if 'journal' == origin then | ||
return '', '', '', wrap_msg ('j-sheets', sheets, lower); | return '', '', '', wrap_msg ('j-sheets', sheets, lower); | ||
Line 2,153: | Line 1,978: | ||
end | end | ||
local is_journal = 'journal' == cite_class or ( | local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin); | ||
if | if is_set (page) then | ||
if is_journal then | if is_journal then | ||
return | return substitute (cfg.messages['j-page(s)'], page), '', '', ''; | ||
elseif not nopp then | elseif not nopp then | ||
return | return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', ''; | ||
else | else | ||
return | return substitute (cfg.messages['nopp'], {sepc, page}), '', '', ''; | ||
end | end | ||
elseif | elseif is_set(pages) then | ||
if is_journal then | if is_journal then | ||
return | return substitute (cfg.messages['j-page(s)'], pages), '', '', ''; | ||
elseif tonumber(pages) ~= nil and not nopp then | elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number | ||
return '', | return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', ''; | ||
elseif not nopp then | elseif not nopp then | ||
return '', | return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', ''; | ||
else | else | ||
return '', | return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', ''; | ||
end | end | ||
end | end | ||
Line 2,183: | Line 2,008: | ||
returns one of the in-source locators: page, pages, or at. | returns one of the in-source locators: page, pages, or at. | ||
If any of these are interwiki links to | If any of these are interwiki links to wikisource, returns the label portion of the interwikilink as plain text | ||
for use in COinS. This COinS thing is done because here we convert an interwiki | for use in COinS. This COinS thing is done because here we convert an interwiki link to and external link and | ||
add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it? | add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it? | ||
Line 2,194: | Line 2,019: | ||
]] | ]] | ||
local function insource_loc_get (page | local function insource_loc_get (page, pages, at) | ||
local ws_url, ws_label, coins_pages, L; -- for | local ws_url, ws_label, coins_pages, L; -- for wikisource interwikilinks; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?) | ||
if | if is_set (page) then | ||
if | if is_set (pages) or is_set(at) then | ||
pages = ''; -- unset the others | pages = ''; -- unset the others | ||
at = ''; | at = ''; | ||
end | end | ||
extra_text_in_page_check (page | extra_text_in_page_check (page); -- add this page to maint cat if |page= value begins with what looks like p. or pp. | ||
ws_url, ws_label, L = wikisource_url_make (page); -- make ws | ws_url, ws_label, L = wikisource_url_make (page); -- make ws url from |page= interwiki link; link portion L becomes tool tip label | ||
if ws_url then | if ws_url then | ||
page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | ||
page = | page = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page}); | ||
coins_pages = ws_label; | coins_pages = ws_label; | ||
end | end | ||
elseif | elseif is_set (pages) then | ||
if | if is_set (at) then | ||
at = ''; -- unset | at = ''; -- unset | ||
end | end | ||
extra_text_in_page_check (pages | extra_text_in_page_check (pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp. | ||
ws_url, ws_label, L = wikisource_url_make (pages); -- make ws | ws_url, ws_label, L = wikisource_url_make (pages); -- make ws url from |pages= interwiki link; link portion L becomes tool tip label | ||
if ws_url then | if ws_url then | ||
pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | ||
pages = | pages = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages}); | ||
coins_pages = ws_label; | coins_pages = ws_label; | ||
end | end | ||
elseif | elseif is_set (at) then | ||
ws_url, ws_label, L = wikisource_url_make (at); -- make ws | ws_url, ws_label, L = wikisource_url_make (at); -- make ws url from |at= interwiki link; link portion L becomes tool tip label | ||
if ws_url then | if ws_url then | ||
at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this? | ||
at = | at = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at}); | ||
coins_pages = ws_label; | coins_pages = ws_label; | ||
end | end | ||
Line 2,234: | Line 2,059: | ||
end | end | ||
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >-------------------------------------------- | --[=[-------------------------< A R C H I V E _ U R L _ C H E C K >-------------------------------------------- | ||
Check archive.org | Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the | ||
save snapshot | save snapshot url or to calendar pages. When the archive url is 'https://web.archive.org/save/' (or http://...) | ||
archive.org saves a snapshot of the target page in the | archive.org saves a snapshot of the target page in the url. That is something that Wikipedia should not allow | ||
unwitting readers to do. | unwitting readers to do. | ||
When the archive.org | When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own | ||
algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results. | algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results. | ||
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and | This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and | ||
|archive-date= and an error message when: | |archive-date= and an error message when: | ||
|archive-url= holds an archive.org save command | |archive-url= holds an archive.org save command url | ||
|archive-url= is an archive.org | |archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the | ||
correct place | correct place | ||
otherwise returns |archive-url= and |archive-date= | otherwise returns |archive-url= and |archive-date= | ||
There are two mostly compatible archive.org | There are two mostly compatible archive.org urls: | ||
//web.archive.org/<timestamp>... -- the old form | //web.archive.org/<timestamp>... -- the old form | ||
//web.archive.org/web/<timestamp>... -- the new form | //web.archive.org/web/<timestamp>... -- the new form | ||
Line 2,277: | Line 2,086: | ||
we don't check for these specific flags but we do check the form. | we don't check for these specific flags but we do check the form. | ||
This function supports a preview mode. When the article is rendered in preview mode, this | This function supports a preview mode. When the article is rendered in preview mode, this funct may return a modified | ||
archive | archive url: | ||
for save command errors, return undated wildcard (/*/) | for save command errors, return undated wildcard (/*/) | ||
for timestamp errors when the timestamp has a wildcard, return the | for timestamp errors when the timestamp has a wildcard, return the url unmodified | ||
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/) | for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/) | ||
Line 2,287: | Line 2,096: | ||
local function archive_url_check (url, date) | local function archive_url_check (url, date) | ||
local err_msg = ''; -- start with the error message empty | local err_msg = ''; -- start with the error message empty | ||
local path, timestamp, flag; -- portions of the archive. | local path, timestamp, flag; -- portions of the archive.or url | ||
if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine | 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 | 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 = | err_msg = 'save command'; | ||
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL | url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL | ||
elseif url:match('//liveweb%.archive%.org/') then | elseif url:match('//liveweb%.archive%.org/') then | ||
err_msg = | err_msg = 'liveweb'; | ||
else | else | ||
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the | path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation | ||
if not | if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here | ||
err_msg = | err_msg = 'timestamp'; | ||
if '*' ~= flag then | 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) | 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 | end | ||
elseif | elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element | ||
err_msg = | err_msg = 'path'; | ||
elseif | 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 = | err_msg = 'flag'; | ||
elseif | 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 = | err_msg = 'flag'; | ||
else | else | ||
return url, date; -- return | return url, date; -- return archiveURL and ArchiveDate | ||
end | end | ||
end | end | ||
-- if here, something not right so | -- if here, something not right so | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and | ||
if | if is_set (Frame:preprocess('{{REVISIONID}}')) then | ||
return '', ''; -- return empty strings for | return '', ''; -- return empty strings for archiveURL and ArchiveDate | ||
else | else | ||
return url, date; -- preview mode so return | return url, date; -- preview mode so return archiveURL and ArchiveDate | ||
end | end | ||
end | end | ||
--[[--------------------------< | --[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------ | ||
This is the main function doing the majority of the citation formatting. | |||
]] | ]] | ||
local function | local function citation0( config, args) | ||
--[[ | |||
Load Input Parameters | |||
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable. | |||
]] | |||
local A = argument_wrapper( args ); | |||
local i | |||
-- Pick out the relevant fields from the arguments. Different citation templates | |||
-- define different field names for the same underlying things. | |||
--[[ | -- set default parameter values defined by |mode= parameter. | ||
local Mode = A['Mode']; | |||
if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then | |||
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 | |||
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList'); | |||
if 1 == selected then | |||
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn= | |||
elseif 2 == selected then | |||
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be | |||
a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn= | |||
elseif 3 == selected then | |||
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 | |||
if is_set (Collaboration) then | |||
if | author_etal = true; -- so that |display-authors=etal not required | ||
end | |||
end | |||
end | end | ||
local Others = A['Others']; | |||
-- | local editor_etal; | ||
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors= | |||
local Editors; | |||
do -- to limit scope of selected | |||
local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList'); | |||
if 1 == selected then | |||
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn= | |||
elseif 2 == selected then | |||
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be | |||
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn= | |||
elseif 3 == selected then | |||
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 | ||
local translator_etal; | |||
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs | |||
local Translators; -- assembled translators name list | |||
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn= | |||
-- | local interviewer_etal; | ||
local interviewers_list = {}; | |||
local Interviewers; -- used later | |||
interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters | |||
local contributor_etal; | |||
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs | |||
local Contributors; -- assembled contributors name list | |||
local Contribution = A['Contribution']; | |||
if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites | |||
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn= | |||
if 0 < #c then | |||
if not is_set (Contribution) then -- |contributor= requires |contribution= | |||
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message | |||
c = {}; -- blank the contributors' table; it is used as a flag later | |||
end | |||
if 0 == #a then -- |contributor= requires |author= | |||
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message | |||
c = {}; -- blank the contributors' table; it is used as a flag later | |||
end | |||
end | |||
else -- if not a book cite | |||
if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters? | |||
table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message | |||
end | |||
Contribution = nil; -- unset | |||
end | |||
] | if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc' | ||
NameListFormat = ''; -- anything else, set to empty string | |||
end | |||
if is_set (Others) then | |||
-- | if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor= | ||
add_maint_cat ('others'); | |||
end | |||
end | |||
local Year = A['Year']; | |||
local PublicationDate = A['PublicationDate']; | |||
local OrigYear = A['OrigYear']; | |||
local | local Date = A['Date']; | ||
local | local LayDate = A['LayDate']; | ||
local | ------------------------------------------------- Get title data | ||
local | local Title = A['Title']; | ||
local | local ScriptTitle = A['ScriptTitle']; | ||
local BookTitle = A['BookTitle']; | |||
local Conference = A['Conference']; | |||
local TransTitle = A['TransTitle']; | |||
local TitleNote = A['TitleNote']; | |||
local TitleLink = A['TitleLink']; | |||
link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set | |||
local Chapter = A['Chapter']; | |||
local ScriptChapter = A['ScriptChapter']; | |||
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode | |||
local TransChapter = A['TransChapter']; | |||
local TitleType = A['TitleType']; | |||
local Degree = A['Degree']; | |||
local Docket = A['Docket']; | |||
local ArchiveFormat = A['ArchiveFormat']; | |||
local | local ArchiveDate; | ||
local | local ArchiveURL; | ||
ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) | |||
local DeadURL = A['DeadURL'] | |||
if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes' | |||
DeadURL = ''; -- anything else, set to empty string | |||
end | end | ||
local | local URL = A['URL'] | ||
local | local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL | ||
local ChapterURL = A['ChapterURL']; | |||
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL | |||
local ConferenceFormat = A['ConferenceFormat']; | |||
local ConferenceURL = A['ConferenceURL']; | |||
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL | |||
local Periodical = A['Periodical']; | |||
local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter | |||
local | local Series = A['Series']; | ||
local Volume; | local Volume; | ||
local Issue; | local Issue; | ||
local Page; | local Page; | ||
local Pages; | local Pages; | ||
local At; | local At; | ||
if not | |||
if in_array (config.CitationClass, cfg.templates_using_volume) then | |||
Volume = A['Volume']; | |||
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 | |||
Issue = hyphen_to_dash (A['Issue']); | |||
end | |||
local Position = ''; | |||
if not in_array (config.CitationClass, cfg.templates_not_using_page) then | |||
Page = A['Page']; | Page = A['Page']; | ||
Pages = hyphen_to_dash (A['Pages']); | Pages = hyphen_to_dash (A['Pages']); | ||
Line 2,567: | Line 2,312: | ||
local Edition = A['Edition']; | local Edition = A['Edition']; | ||
local PublicationPlace = | local PublicationPlace = A['PublicationPlace'] | ||
local Place = | local Place = A['Place']; | ||
local PublisherName = A['PublisherName']; | local PublisherName = A['PublisherName']; | ||
local | local RegistrationRequired = A['RegistrationRequired']; | ||
if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then | |||
RegistrationRequired=nil; | |||
end | end | ||
local | local SubscriptionRequired = A['SubscriptionRequired']; | ||
if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then | |||
SubscriptionRequired=nil; | |||
end | |||
local UrlAccess = A['UrlAccess']; | |||
if | 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 | 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 | 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 | 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 | ||
local | local Via = A['Via']; | ||
local AccessDate = A['AccessDate']; | |||
local Agency = A['Agency']; | |||
local | local Language = A['Language']; | ||
local Format = A['Format']; | local Format = A['Format']; | ||
local ChapterFormat = A['ChapterFormat']; | local ChapterFormat = A['ChapterFormat']; | ||
local | local DoiBroken = A['DoiBroken']; | ||
local | local ID = A['ID']; | ||
local | local ASINTLD = A['ASINTLD']; | ||
local | local IgnoreISBN = A['IgnoreISBN']; | ||
if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then | |||
IgnoreISBN = nil; -- anything else, set to empty string | |||
end | |||
local Embargo = A['Embargo']; | |||
local Class = A['Class']; -- arxiv class identifier | |||
local ID_list = extract_ids( args ); | |||
local ID_access_levels = extract_id_access_levels( args, ID_list ); | |||
local Quote = A['Quote']; | |||
local | local LayFormat = A['LayFormat']; | ||
local LayURL = A['LayURL']; | |||
local LaySource = A['LaySource']; | |||
local Transcript = A['Transcript']; | |||
local TranscriptFormat = A['TranscriptFormat']; | |||
local TranscriptURL = A['TranscriptURL'] | |||
local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL | |||
local LastAuthorAmp = A['LastAuthorAmp']; | |||
if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then | |||
LastAuthorAmp = nil; -- set to empty string | |||
end | end | ||
local no_tracking_cats = A['NoTracking']; | |||
if | if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then | ||
no_tracking_cats = nil; -- set to empty string | |||
end | end | ||
--local variables that are not cs1 parameters | |||
local use_lowercase; -- controls capitalization of certain static text | |||
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language | |||
local anchor_year; -- used in the CITEREF identifier | |||
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification | |||
local DF = A['DF']; -- date format set in cs1|2 template | |||
if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword | |||
DF = ''; -- not valid, set to empty string | |||
end | |||
if not is_set (DF) then | |||
DF = cfg.global_df; | |||
end | |||
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma | |||
local PostScript; | |||
local Ref; | |||
sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); | |||
use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text | |||
if not | --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | ||
Chapter = | if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page | ||
end | if in_array (this_page.nsText, cfg.uncategorized_namespaces) then | ||
no_tracking_cats = "true"; -- set no_tracking_cats | |||
end | |||
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns | |||
if this_page.text:match (v) then -- test page name against each pattern | |||
no_tracking_cats = "true"; -- set no_tracking_cats | |||
break; -- bail out if one is found | |||
end | |||
end | |||
end | |||
-- 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 | |||
local coins_pages; | |||
Page, Pages, At, coins_pages = insource_loc_get (Page, Pages, At); | |||
local NoPP = A['NoPP'] | |||
if is_set (NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_y']) then | |||
NoPP = true; | |||
else | |||
NoPP = nil; -- unset, used as a flag later | |||
end | |||
-- both |publication-place= and |place= (|location=) allowed if different | |||
if not is_set(PublicationPlace) and is_set(Place) then | |||
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place | |||
end | |||
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same | |||
--[[ | |||
Parameter remapping for cite encyclopedia: | |||
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 | |||
]] | |||
local Encyclopedia = A['Encyclopedia']; | |||
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation | |||
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set | |||
if is_set(Title) or is_set (ScriptTitle) then | |||
if not is_set(Chapter) then | |||
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title | |||
ScriptChapter = ScriptTitle; | |||
TransChapter = TransTitle; | |||
ChapterURL = URL; | |||
ChapterUrlAccess = UrlAccess; | |||
if not is_set (ChapterURL) and is_set (TitleLink) then | |||
Chapter = make_wikilink (TitleLink, Chapter); | |||
end | |||
Title = Periodical; | Title = Periodical; | ||
ChapterFormat = Format; | ChapterFormat = Format; | ||
Line 2,717: | Line 2,485: | ||
ScriptTitle = ''; | ScriptTitle = ''; | ||
end | end | ||
else -- |title not set | |||
Title = Periodical; -- |encyclopedia | Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title | ||
Periodical = ''; -- redundant so unset | Periodical = ''; -- redundant so unset | ||
end | end | ||
Line 2,724: | Line 2,492: | ||
end | end | ||
-- | -- 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 | if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue' | ||
if not | if not is_set(ID) then -- can we use ID for the "number"? | ||
ID = A['Number']; -- yes, use it | 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, { | table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); | ||
end | end | ||
end | end | ||
end | |||
-- special case for cite mailing list | |||
if (config.CitationClass == "mailinglist") then | |||
Periodical = A ['MailingList']; | |||
elseif 'mailinglist' == A:ORIGIN('Periodical') then | |||
Periodical = ''; -- unset because mailing list is only used for cite mailing list | |||
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 | if is_set(BookTitle) then | ||
Chapter = Title; | Chapter = Title; | ||
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated | |||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | ChapterUrlAccess = UrlAccess; | ||
ChapterURLorigin = URLorigin; | |||
URLorigin = ''; | |||
ChapterFormat = Format; | ChapterFormat = Format; | ||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
Title = BookTitle; | Title = BookTitle; | ||
Format = ''; | Format = ''; | ||
-- TitleLink = ''; | |||
TransTitle = ''; | TransTitle = ''; | ||
URL = ''; | URL = ''; | ||
Line 2,762: | Line 2,530: | ||
Conference = ''; -- not cite conference or cite speech so make sure this is empty string | Conference = ''; -- not cite conference or cite speech so make sure this is empty string | ||
end | end | ||
-- cite map oddities | -- cite map oddities | ||
local Cartography = ""; | local Cartography = ""; | ||
Line 2,776: | Line 2,537: | ||
local Sheets = A['Sheets'] or ''; | local Sheets = A['Sheets'] or ''; | ||
if config.CitationClass == "map" then | if config.CitationClass == "map" then | ||
Chapter = A['Map']; | Chapter = A['Map']; | ||
ChapterURL = A['MapURL']; | ChapterURL = A['MapURL']; | ||
ChapterUrlAccess = UrlAccess; | |||
TransChapter = A['TransMap']; | TransChapter = A['TransMap']; | ||
ChapterURLorigin = A:ORIGIN('MapURL'); | |||
ChapterFormat = A['MapFormat']; | ChapterFormat = A['MapFormat']; | ||
Cartography = A['Cartography']; | Cartography = A['Cartography']; | ||
if | if is_set( Cartography ) then | ||
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); | Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); | ||
end | end | ||
Scale = A['Scale']; | Scale = A['Scale']; | ||
if | if is_set( Scale ) then | ||
Scale = sepc .. " " .. Scale; | Scale = sepc .. " " .. Scale; | ||
end | end | ||
Line 2,801: | Line 2,555: | ||
-- 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 SeriesLink = A['SeriesLink']; | local SeriesLink = A['SeriesLink']; | ||
link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set | |||
local Network = A['Network']; | local Network = A['Network']; | ||
Line 2,811: | Line 2,565: | ||
local s, n = {}, {}; | local s, n = {}, {}; | ||
-- do common parameters first | -- do common parameters first | ||
if | if is_set(Network) then table.insert(n, Network); end | ||
if | if is_set(Station) then table.insert(n, Station); end | ||
ID = table.concat(n, sepc .. ' '); | ID = table.concat(n, sepc .. ' '); | ||
if not is_set (Date) and is_set (AirDate) then -- promote airdate to date | |||
Date = AirDate; | |||
end | |||
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}} | if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}} | ||
local Season = A['Season']; | local Season = A['Season']; | ||
local SeriesNumber = A['SeriesNumber']; | local SeriesNumber = A['SeriesNumber']; | ||
if | if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'season') .. ' and ' .. wrap_style ('parameter', 'seriesno')}, true ) } ); -- add error message | ||
SeriesNumber = ''; -- unset; prefer |season= over |seriesno= | SeriesNumber = ''; -- unset; prefer |season= over |seriesno= | ||
end | end | ||
-- assemble a table of parts concatenated later into Series | -- assemble a table of parts concatenated later into Series | ||
if | if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end | ||
if | if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end | ||
if | if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end | ||
Issue = ''; -- unset because this is not a unique parameter | Issue = ''; -- unset because this is not a unique parameter | ||
Chapter = Title; -- promote title parameters to chapter | Chapter = Title; -- promote title parameters to chapter | ||
ScriptChapter = ScriptTitle; | ScriptChapter = ScriptTitle; | ||
ChapterLink = TitleLink; -- alias episodelink | |||
ChapterLink = TitleLink; -- alias | |||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | ChapterUrlAccess = UrlAccess; | ||
ChapterURLorigin = A:ORIGIN('URL'); | |||
Title = Series; -- promote series to title | Title = Series; -- promote series to title | ||
Line 2,842: | Line 2,599: | ||
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number | Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number | ||
if | if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL | ||
Chapter = | Chapter = make_wikilink (ChapterLink, Chapter); | ||
elseif | 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,854: | Line 2,611: | ||
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial | Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial | ||
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? | Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? | ||
if | if is_set (Series) and is_set (SeriesLink) then | ||
Series = | Series = make_wikilink (SeriesLink, Series); | ||
end | end | ||
Series = | 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}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data. | |||
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 | |||
-- 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", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then | |||
if | |||
TitleType = set_titletype (config.CitationClass, TitleType); | TitleType = set_titletype (config.CitationClass, TitleType); | ||
if | if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis | ||
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); | TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); | ||
end | end | ||
end | end | ||
if | if is_set(TitleType) then -- if type parameter is specified | ||
TitleType = | TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses | ||
-- TODO: Hack on TitleType to fix bunched parentheses problem | -- TODO: Hack on TitleType to fix bunched parentheses problem | ||
end | end | ||
-- legacy: promote PublicationDate to Date if neither Date nor Year are set. | -- 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 | local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging | ||
if not | if not is_set (Date) then | ||
Date = Year; -- promote Year to Date | Date = Year; -- promote Year to Date | ||
Year = nil; -- make nil so Year as empty string isn't used for CITEREF | Year = nil; -- make nil so Year as empty string isn't used for CITEREF | ||
if not | if not is_set (Date) and is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set | ||
Date = PublicationDate; -- promote PublicationDate to Date | Date = PublicationDate; -- promote PublicationDate to Date | ||
PublicationDate = ''; -- unset, no longer needed | PublicationDate = ''; -- unset, no longer needed | ||
Line 2,905: | Line 2,678: | ||
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 | |||
local error_message = ''; | |||
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch | |||
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 = { | local date_parameters_list = { | ||
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')}, | ['access-date'] = {val=AccessDate, name=A:ORIGIN ('AccessDate')}, | ||
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')}, | ['archive-date'] = {val=ArchiveDate, name=A:ORIGIN ('ArchiveDate')}, | ||
['date'] = {val = Date, name = Date_origin}, | ['date'] = {val=Date, name=Date_origin}, | ||
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')}, | ['doi-broken-date'] = {val=DoiBroken, name=A:ORIGIN ('DoiBroken')}, | ||
[' | ['embargo'] = {val=Embargo, name=A:ORIGIN ('Embargo')}, | ||
['lay-date'] = {val = LayDate, name = A:ORIGIN ('LayDate')}, | ['lay-date'] = {val=LayDate, name=A:ORIGIN ('LayDate')}, | ||
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')}, | ['publication-date'] ={val=PublicationDate, name=A:ORIGIN ('PublicationDate')}, | ||
['year'] = {val = Year, name = A:ORIGIN ('Year')}, | ['year'] = {val=Year, name=A:ORIGIN ('Year')}, | ||
}; | }; | ||
anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date); | |||
anchor_year, Embargo = | |||
-- start temporary Julian / Gregorian calendar uncertainty categorization | -- start temporary Julian / Gregorian calendar uncertainty categorization | ||
if COinS_date.inter_cal_cat then | if COinS_date.inter_cal_cat then | ||
add_prop_cat ('jul_greg_uncertainty'); | |||
end | end | ||
-- end temporary Julian / Gregorian calendar uncertainty categorization | -- end temporary Julian / Gregorian calendar uncertainty categorization | ||
if | if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed; | ||
local mismatch = year_date_check (Year, Date) | |||
if 0 == mismatch then -- |year= does not match a year-value in |date= | |||
if is_set (error_message) then -- if there is already an error message | |||
error_message = error_message .. ', '; -- tack on this additional message | |||
end | |||
error_message = error_message .. '|year= / |date= mismatch'; | |||
elseif 1 == mismatch then -- |year= matches year-value in |date= | |||
add_maint_cat ('date_year'); | |||
end | |||
end | end | ||
if | if not is_set(error_message) then -- error free dates only | ||
local modified = false; -- flag | local modified = false; -- flag | ||
if | 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 = | |||
end | end | ||
if true == | 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 | |||
end | end | ||
-- for those wikis that can and want to have English date names translated to the local language, | -- for those wikis that can and want to have English date names translated to the local language, | ||
-- uncomment | -- uncomment these three lines. Not supported by en.wiki (for obvious reasons) | ||
-- set | -- 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 | ||
Line 2,986: | Line 2,739: | ||
end | end | ||
else | else | ||
table.insert (z.message_tail, { | 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. | |||
-- 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); | |||
-- Account for the | |||
if | |||
if config.CitationClass == "journal" and not | if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then | ||
if | if not is_set (Embargo) then -- if not embargoed or embargo has expired | ||
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= | |||
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 | end | ||
Line 3,035: | Line 2,761: | ||
-- 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 | if not is_set(Title) and | ||
not is_set(TransTitle) and | |||
not is_set(ScriptTitle) then | |||
if 'episode' == config.CitationClass then -- special case for cite episode; TODO: is there a better way to do this? | |||
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'series'}, true ) } ); | |||
else | |||
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'title'}, true ) } ); | |||
end | |||
end | end | ||
if | if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites | ||
Title = ''; -- set title to empty string | |||
add_maint_cat ('untitled'); | |||
end | end | ||
check_for_url ({ -- add error message when any of these parameters | check_for_url ({ -- add error message when any of these parameters contains a URL | ||
['title'] = Title, | ['title']=Title, | ||
[A:ORIGIN('Chapter')] = Chapter, | [A:ORIGIN('Chapter')]=Chapter, | ||
[ | [A:ORIGIN('Periodical')]=Periodical, | ||
[ | [A:ORIGIN('PublisherName')] = PublisherName | ||
}); | }); | ||
Line 3,061: | Line 2,790: | ||
local coins_chapter = Chapter; -- default assuming that remapping not required | local coins_chapter = Chapter; -- default assuming that remapping not required | ||
local coins_title = Title; -- et tu | local coins_title = Title; -- et tu | ||
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and | if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then | ||
if | if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then | ||
coins_chapter = Title; -- remap | coins_chapter = Title; -- remap | ||
coins_title = Periodical; | coins_title = Periodical; | ||
Line 3,071: | Line 2,800: | ||
coins_author = c; -- use that instead | coins_author = c; -- use that instead | ||
end | end | ||
-- this is the function call to COinS() | -- this is the function call to COinS() | ||
local OCinSoutput = | local OCinSoutput = COinS({ | ||
['Periodical'] = | ['Periodical'] = Periodical, | ||
['Encyclopedia'] = Encyclopedia, | ['Encyclopedia'] = Encyclopedia, | ||
['Chapter'] = | ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup | ||
['Degree'] = Degree; -- cite thesis only | ['Degree'] = Degree; -- cite thesis only | ||
['Title'] = | ['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup | ||
['PublicationPlace'] = PublicationPlace, | ['PublicationPlace'] = PublicationPlace, | ||
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid; | ['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid; | ||
['Season'] = COinS_date.rftssn, | ['Season'] = COinS_date.rftssn, | ||
['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit? | ['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit? | ||
['Series'] = Series, | ['Series'] = Series, | ||
['Volume'] = Volume, | ['Volume'] = Volume, | ||
['Issue'] = Issue, | ['Issue'] = Issue, | ||
['Pages'] = coins_pages or | ['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links | ||
['Edition'] = Edition, | ['Edition'] = Edition, | ||
['PublisherName'] = PublisherName | ['PublisherName'] = PublisherName, | ||
['URL'] = first_set ({ChapterURL, URL}, 2), | ['URL'] = first_set ({ChapterURL, URL}, 2), | ||
['Authors'] = coins_author, | ['Authors'] = coins_author, | ||
['ID_list'] = | ['ID_list'] = ID_list, | ||
['RawPage'] = this_page.prefixedText, | ['RawPage'] = this_page.prefixedText, | ||
}, config.CitationClass); | }, config.CitationClass); | ||
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data. | ||
if | 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 these templates; if article has been published, use cite journal | 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 | if 'newsgroup' == config.CitationClass then | ||
if is_set (PublisherName) then | |||
PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil )); | |||
end | |||
end | end | ||
-- Now perform various field substitutions. | -- Now perform various field substitutions. | ||
-- We also add leading spaces and surrounding markup and punctuation to the | -- We also add leading spaces and surrounding markup and punctuation to the | ||
-- various parts of the citation, but only when they are non-nil. | -- various parts of the citation, but only when they are non-nil. | ||
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list | |||
do | do | ||
local last_first_list; | local last_first_list; | ||
local control = { | local control = { | ||
format = | 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, | |||
page_name = this_page.text, -- get current page name so that we don't wikilink to it via editorlinkn | |||
mode = Mode | mode = Mode | ||
}; | }; | ||
do -- do editor name list first because the now unsupported coauthors used to modify control table | do -- do editor name list first because the now unsupported coauthors used to modify control table | ||
control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal | control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal); | ||
last_first_list, EditorCount = list_people(control, e, editor_etal); | |||
if is_set (Editors) then | |||
Editors, editor_etal = name_has_etal (Editors, editor_etal, false, 'editors'); -- find and remove variations on et al. | |||
if editor_etal then | |||
Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal | |||
EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation | |||
else | |||
EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation | |||
end | |||
else | |||
Editors = last_first_list; -- either an author name list or an empty string | |||
end | |||
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then | if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then | ||
Line 3,142: | Line 2,873: | ||
end | end | ||
do -- now do interviewers | do -- now do interviewers | ||
control.maximum, interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal | control.maximum , interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal); | ||
Interviewers = list_people (control, interviewers_list, interviewer_etal); | Interviewers = list_people (control, interviewers_list, interviewer_etal); | ||
end | end | ||
do -- now do translators | do -- now do translators | ||
control.maximum, translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal | control.maximum , translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal); | ||
Translators = list_people (control, t, translator_etal); | Translators = list_people (control, t, translator_etal); | ||
end | end | ||
do -- now do contributors | do -- now do contributors | ||
control.maximum, contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal | control.maximum , contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal); | ||
Contributors = list_people (control, c, contributor_etal); | Contributors = list_people (control, c, contributor_etal); | ||
-- control.maximum = #c; -- number of contributors | |||
-- Contributors = list_people(control, c, false); -- et al not currently supported | |||
end | end | ||
do -- now do authors | do -- now do authors | ||
control.maximum, author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal | control.maximum , author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal); | ||
last_first_list = list_people (control, a, author_etal); | last_first_list = list_people(control, a, author_etal); | ||
if | if is_set (Authors) then | ||
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al. | Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al. | ||
if author_etal then | if author_etal then | ||
Line 3,168: | Line 2,901: | ||
end -- end of do | end -- end of do | ||
if | if is_set (Authors) and is_set (Collaboration) then | ||
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al. | Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al. | ||
end | end | ||
Line 3,174: | Line 2,907: | ||
end | end | ||
-- 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 | |||
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'); | ||
Format = style_format (Format, URL, 'format', 'url'); | Format = style_format (Format, URL, 'format', 'url'); | ||
LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url'); | |||
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 ( | if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or | ||
('citation' == config.CitationClass and | ('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'); | ||
end | end | ||
if not | if not is_set(URL) then | ||
if | if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist | ||
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } ); | |||
end | end | ||
-- do we have |accessdate= without either |url= or |chapter-url=? | -- do we have |accessdate= without either |url= or |chapter-url=? | ||
if | if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set; | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); | ||
AccessDate = ''; | AccessDate = ''; | ||
end | end | ||
end | end | ||
local | local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; | ||
DeadURL = DeadURL:lower(); -- used later when assembling archived text | |||
if is_set( ArchiveURL ) then | |||
if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it | |||
if | |||
if | |||
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 | |||
OriginalFormat = ChapterFormat; -- and original |chapter-format= | OriginalFormat = ChapterFormat; -- and original |chapter-format= | ||
if 'no' ~= DeadURL then | |||
if ' | ChapterURL = ArchiveURL -- swap-in the archive's url | ||
ChapterURL = ArchiveURL -- swap-in the archive's | 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 | ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived urls | ||
end | end | ||
elseif | 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 | |||
OriginalFormat = Format; -- and original |format= | OriginalFormat = Format; -- and original |format= | ||
OriginalAccess = UrlAccess; | OriginalAccess = UrlAccess; | ||
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it | |||
if ' | URL = ArchiveURL -- swap-in the archive's url | ||
URL = ArchiveURL -- swap-in the archive's | 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 | UrlAccess = nil; -- restricted access levels do not make sense for archived urls | ||
end | end | ||
end | end | ||
end | end | ||
if | 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 | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then | ||
local chap_param; | local chap_param; | ||
if | if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters | ||
chap_param = A:ORIGIN ('Chapter') | chap_param = A:ORIGIN ('Chapter') | ||
elseif | elseif is_set (TransChapter) then | ||
chap_param = A:ORIGIN ('TransChapter') | chap_param = A:ORIGIN ('TransChapter') | ||
elseif | elseif is_set (ChapterURL) then | ||
chap_param = A:ORIGIN ('ChapterURL') | chap_param = A:ORIGIN ('ChapterURL') | ||
elseif | elseif is_set (ScriptChapter) then | ||
chap_param = | chap_param = A:ORIGIN ('ScriptChapter') | ||
else | else is_set (ChapterFormat) | ||
chap_param = A:ORIGIN ('ChapterFormat') | chap_param = A:ORIGIN ('ChapterFormat') | ||
end | end | ||
if | if is_set (chap_param) then -- if we found one | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- add error message | ||
Chapter = ''; -- and set them to empty string to be safe with concatenation | Chapter = ''; -- and set them to empty string to be safe with concatenation | ||
TransChapter = ''; | TransChapter = ''; | ||
Line 3,256: | Line 2,985: | ||
else -- otherwise, format chapter / article title | else -- otherwise, format chapter / article title | ||
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value | local no_quotes = false; -- default assume that we will be quoting the chapter parameter value | ||
if | if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s) | ||
if | if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title | ||
no_quotes = true; -- then render it unquoted | no_quotes = true; -- then render it unquoted | ||
end | end | ||
end | end | ||
Chapter = format_chapter_title (ScriptChapter | Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter | ||
if | if is_set (Chapter) then | ||
Chapter = Chapter .. ChapterFormat ; | Chapter = Chapter .. ChapterFormat ; | ||
if 'map' == config.CitationClass and | if 'map' == config.CitationClass and is_set (TitleType) then | ||
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title | Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title | ||
end | end | ||
Chapter = Chapter .. sepc .. ' '; | Chapter = Chapter.. sepc .. ' '; | ||
elseif | elseif is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ... | ||
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it | Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it | ||
end | end | ||
end | end | ||
-- Format main title | -- Format main title. | ||
if is_set (ArchiveURL) and mw.ustring.match (mw.ustring.lower(Title), cfg.special_case_translation['archived_copy']) then -- if title is 'Archived copy' (place holder added by bots that can't find proper title) | |||
add_maint_cat ('archived_copy'); -- add maintenance category before we modify the content of Title | |||
if | |||
end | end | ||
if | if Title:match ('^%(%(.*%)%)$') then -- if keep as written markup: | ||
if '...' == Title:sub (-3) then -- if | Title= Title:gsub ('^%(%((.*)%)%)$', '%1') -- remove the markup | ||
else | |||
if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title= | |||
Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three | Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three | ||
elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ... | elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ... | ||
not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.) | not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.) | ||
Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); | Title = mw.ustring.gsub(Title, '%'..sepc..'$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters | ||
end | end | ||
end | |||
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 | |||
('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 = wrap_style ('quoted-title', Title); | |||
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 ); | |||
elseif 'report' == config.CitationClass then -- no styling for cite report | |||
if | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
('citation' == config.CitationClass and | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title | ||
('map' == config.CitationClass and | |||
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from | |||
Title = | |||
Title = script_concatenate (Title, ScriptTitle | |||
TransTitle = | |||
elseif | |||
Title = script_concatenate (Title, ScriptTitle | |||
TransTitle = | |||
else | else | ||
Title = | Title = wrap_style ('italic-title', Title); | ||
Title = script_concatenate (Title, ScriptTitle | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
TransTitle = | TransTitle = wrap_style ('trans-italic-title', TransTitle); | ||
end | end | ||
local TransError = ""; | local TransError = ""; | ||
if | if is_set(TransTitle) then | ||
if | if is_set(Title) then | ||
TransTitle = " " .. TransTitle; | TransTitle = " " .. TransTitle; | ||
else | else | ||
TransError = " " .. | TransError = " " .. set_error( 'trans_missing_title', {'title'} ); | ||
end | end | ||
end | end | ||
if | if is_set(Title) then | ||
if not is_set (TitleLink) and is_set (URL) then | |||
Title = external_link (URL, Title, URLorigin, UrlAccess) .. TransTitle .. TransError .. Format; | |||
if not | |||
Title = external_link (URL, Title, | |||
URL = ''; -- unset these because no longer needed | URL = ''; -- unset these because no longer needed | ||
Format = ""; | Format = ""; | ||
elseif | elseif is_set (TitleLink) and not is_set (URL) then | ||
local ws_url; | local ws_url; | ||
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here | ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here | ||
if ws_url then | if ws_url then | ||
Title = external_link (ws_url, Title .. ' ', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | Title = external_link (ws_url, Title .. ' ', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | ||
Title = | Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title}); | ||
Title = Title .. TransTitle .. TransError; | Title = Title .. TransTitle .. TransError; | ||
else | else | ||
Title = | Title = make_wikilink (TitleLink, Title) .. TransTitle .. TransError; | ||
end | end | ||
else | else | ||
local ws_url, ws_label | local ws_url, ws_label; | ||
ws_url, ws_label, L = wikisource_url_make (Title | ws_url, ws_label, L = wikisource_url_make (Title); -- make ws url from |title= interwiki link; link portion L becomes tool tip label | ||
if ws_url then | if ws_url then | ||
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup | Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup | ||
Title = external_link (ws_url, Title .. ' ', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | Title = external_link (ws_url, Title .. ' ', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | ||
Title = | Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title}); | ||
Title = Title .. TransTitle .. TransError; | Title = Title .. TransTitle .. TransError; | ||
else | else | ||
Line 3,365: | Line 3,075: | ||
end | end | ||
if | if is_set(Place) then | ||
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "; | Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "; | ||
end | end | ||
if is_set (Conference) then | |||
if | if is_set (ConferenceURL) then | ||
if | Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil ); | ||
Conference = external_link( ConferenceURL, Conference, | |||
end | end | ||
Conference = sepc .. " " .. Conference .. ConferenceFormat; | Conference = sepc .. " " .. Conference .. ConferenceFormat; | ||
elseif | elseif is_set(ConferenceURL) then | ||
Conference = sepc .. " " .. external_link( ConferenceURL, nil, | Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil ); | ||
end | end | ||
if not is_set(Position) then | |||
if not | |||
local Minutes = A['Minutes']; | local Minutes = A['Minutes']; | ||
local Time = A['Time']; | local Time = A['Time']; | ||
if | if is_set(Minutes) then | ||
if | if is_set (Time) then | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } ); | ||
end | end | ||
Position = " " .. Minutes .. " " .. cfg.messages['minutes']; | Position = " " .. Minutes .. " " .. cfg.messages['minutes']; | ||
else | else | ||
if | if is_set(Time) then | ||
local TimeCaption = A['TimeCaption'] | local TimeCaption = A['TimeCaption'] | ||
if not | if not is_set(TimeCaption) then | ||
TimeCaption = cfg.messages['event']; | TimeCaption = cfg.messages['event']; | ||
if sepc ~= '.' then | if sepc ~= '.' then | ||
Line 3,408: | Line 3,116: | ||
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase); | Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase); | ||
At = | At = is_set(At) and (sepc .. " " .. At) or ""; | ||
Position = | Position = is_set(Position) and (sepc .. " " .. Position) or ""; | ||
if config.CitationClass == 'map' then | if config.CitationClass == 'map' then | ||
local Sections = A['Sections']; | local Section = A['Section']; | ||
local Sections = A['Sections']; | |||
local Inset = A['Inset']; | local Inset = A['Inset']; | ||
if | if is_set( Inset ) then | ||
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); | Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); | ||
end | end | ||
if | if is_set( Sections ) then | ||
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); | Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); | ||
elseif | elseif is_set( Section ) then | ||
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); | Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); | ||
end | end | ||
Line 3,426: | Line 3,135: | ||
end | end | ||
if is_set (Language) then | |||
if | Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc | ||
else | |||
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 | ||
Others = | |||
Others = is_set(Others) and (sepc .. " " .. Others) or ""; | |||
if | if is_set (Translators) then | ||
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); | Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); | ||
end | end | ||
if | if is_set (Interviewers) then | ||
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); | Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); | ||
end | end | ||
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; | |||
if is_set (Edition) then | |||
if | if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then | ||
if Edition:match ('%f[%a][Ee]d | add_maint_cat ('extra_text', 'edition'); | ||
end | end | ||
Edition = " " .. wrap_msg ('edition', Edition); | Edition = " " .. wrap_msg ('edition', Edition); | ||
Line 3,455: | Line 3,163: | ||
end | end | ||
Series = | Series = is_set(Series) and (sepc .. " " .. Series) or ""; | ||
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation | |||
Agency = | |||
Agency = is_set(Agency) and (sepc .. " " .. Agency) or ""; | |||
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); | Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); | ||
if | ------------------------------------ totally unrelated data | ||
if is_set(Via) then | |||
Via = " " .. wrap_msg ('via', Via); | |||
end | |||
--[[ | |||
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. | |||
]] | |||
if is_set (SubscriptionRequired) then | |||
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message | |||
elseif is_set (RegistrationRequired) then | |||
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message | |||
else | |||
SubscriptionRequired = ''; -- either or both might be set to something other than yes true y | |||
end | |||
if is_set(AccessDate) then | |||
local retrv_text = " " .. cfg.messages['retrieved'] | local retrv_text = " " .. cfg.messages['retrieved'] | ||
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 mode is cs2, lower case | if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case | ||
AccessDate = | AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text | ||
AccessDate = | AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates | ||
end | end | ||
if | if is_set(ID) then ID = sepc .." ".. ID; end | ||
if "thesis" == config.CitationClass and is_set(Docket) then | |||
ID = sepc .." Docket ".. Docket .. ID; | |||
if "thesis" == config.CitationClass and | |||
ID = sepc .. " Docket " .. Docket .. ID; | |||
end | end | ||
if "report" == config.CitationClass and | if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set | ||
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set | ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set | ||
end | end | ||
if | ID_list = build_id_list( ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} ); | ||
URL = " " .. external_link( URL, nil, | |||
if is_set(URL) then | |||
URL = " " .. external_link( URL, nil, URLorigin, UrlAccess ); | |||
end | end | ||
if is_set(Quote) then | |||
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then -- if first and last characters of quote are quote marks | |||
Quote = Quote:sub(2,-2); -- strip them off | |||
if | end | ||
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags | |||
end | |||
Quote = | |||
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set | PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set | ||
end | end | ||
local Archived | local Archived | ||
if | if is_set(ArchiveURL) then | ||
if not is_set(ArchiveDate) then | |||
if not | ArchiveDate = set_error('archive_missing_date'); | ||
ArchiveDate = | |||
end | end | ||
if " | if "no" == DeadURL then | ||
arch_text = cfg.messages['archived']; | local arch_text = cfg.messages['archived']; | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
Archived = sepc .. " " . | Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], | ||
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | ||
if not | if not is_set(OriginalURL) then | ||
Archived = Archived .. " " .. | Archived = Archived .. " " .. set_error('archive_missing_url'); | ||
end | end | ||
elseif | elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped' | ||
local arch_text = cfg.messages['archived-dead']; | |||
if sepc ~= "." then arch_text = arch_text:lower() end | |||
if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then | |||
Archived = sepc .. " " .. | Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | ||
if 'bot: unknown' == | if 'bot: unknown' == DeadURL then | ||
add_maint_cat ('bot:_unknown'); -- and add a category if not already added | |||
else | else | ||
add_maint_cat ('unfit'); -- and add a category if not already added | |||
end | end | ||
else -- | else -- DeadURL is empty, 'yes', 'true', or 'y' | ||
Archived = sepc .. " " .. substitute( arch_text, | |||
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | |||
Archived = sepc .. " " . | |||
{ external_link( OriginalURL, cfg.messages['original'], | |||
end | end | ||
else | else | ||
arch_text = cfg.messages['archived-missing']; | local arch_text = cfg.messages['archived-missing']; | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
Archived = sepc .. " " . | Archived = sepc .. " " .. substitute( arch_text, | ||
{ | { set_error('archive_missing_url'), ArchiveDate } ); | ||
end | end | ||
elseif | elseif is_set (ArchiveFormat) then | ||
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message | Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message | ||
else | else | ||
Line 3,588: | Line 3,260: | ||
local Lay = ''; | local Lay = ''; | ||
if is_set(LayURL) then | |||
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end | |||
if is_set(LaySource) then | |||
LaySource = " – ''" .. safe_for_italics(LaySource) .. "''"; | |||
if | |||
if | |||
if | |||
LaySource = " – ''" . | |||
else | else | ||
LaySource = ""; | LaySource = ""; | ||
Line 3,604: | Line 3,272: | ||
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate | Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate | ||
end | end | ||
elseif | elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= | ||
Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message | Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message | ||
end | end | ||
if is_set(Transcript) then | |||
if is_set(TranscriptURL) then | |||
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil ); | |||
if | |||
if | |||
Transcript = external_link( TranscriptURL, Transcript, | |||
end | end | ||
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | ||
elseif | elseif is_set(TranscriptURL) then | ||
Transcript = external_link( TranscriptURL, nil, | Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil ); | ||
end | end | ||
local Publisher; | local Publisher; | ||
if | if is_set(PublicationDate) then | ||
PublicationDate = wrap_msg ('published', PublicationDate); | PublicationDate = wrap_msg ('published', PublicationDate); | ||
end | end | ||
if | if is_set(PublisherName) then | ||
if | if is_set(PublicationPlace) then | ||
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; | Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; | ||
else | else | ||
Publisher = sepc .. " " .. PublisherName .. PublicationDate; | Publisher = sepc .. " " .. PublisherName .. PublicationDate; | ||
end | end | ||
elseif | elseif is_set(PublicationPlace) then | ||
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; | Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; | ||
else | else | ||
Line 3,638: | Line 3,301: | ||
end | end | ||
-- Several of the above rely upon detecting this as nil, so do it last. | -- Several of the above rely upon detecting this as nil, so do it last. | ||
if | if is_set(Periodical) then | ||
if | if is_set(Title) or is_set(TitleNote) then | ||
Periodical = sepc .. " " .. | Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical) | ||
else | else | ||
Periodical = | Periodical = wrap_style ('italic-title', Periodical) | ||
end | end | ||
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 | if "speech" == config.CitationClass then -- cite speech only | ||
TitleNote = " (Speech)"; | TitleNote = " (Speech)"; -- annotate the citation | ||
if | if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter | ||
if | if is_set (Conference) then -- and if |event= is set | ||
Conference = Conference .. sepc .. " "; | Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering | ||
end | end | ||
end | end | ||
Line 3,679: | Line 3,330: | ||
local tcommon2; -- used for book cite when |contributor= is set | local tcommon2; -- used for book cite when |contributor= is set | ||
if | if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | ||
if | 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, Language, Edition, Publisher, Agency, Volume}, sepc ); | tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc ); | ||
elseif | elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites | ||
if | if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc | ||
tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2 | tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2 | ||
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); | tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); | ||
Line 3,691: | Line 3,342: | ||
elseif 'map' == config.CitationClass then -- special cases for cite map | elseif 'map' == config.CitationClass then -- special cases for cite map | ||
if | if is_set (Chapter) then -- map in a book; TitleType is part of Chapter | ||
tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | ||
elseif | elseif is_set (Periodical) then -- map in a periodical | ||
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc ); | ||
else -- a sheet or stand-alone map | else -- a sheet or stand-alone map | ||
Line 3,713: | Line 3,364: | ||
end | end | ||
local idcommon; | local idcommon; | ||
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript | if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript | ||
idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Lay, Quote }, sepc ); | idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc ); | ||
else | else | ||
idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Lay, Quote }, sepc ); | idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc ); | ||
end | end | ||
Line 3,725: | Line 3,374: | ||
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; | local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; | ||
if is_set(Date) then | |||
if is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set | |||
if | Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses | ||
if | |||
Date = " (" .. Date .. ")" .. | |||
else -- neither of authors and editors set | else -- neither of authors and editors set | ||
if (string.sub(tcommon, -1, -1) == sepc) then | if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc | ||
Date = " " .. Date .. | Date = " " .. Date .. OrigYear; -- Date does not begin with sepc | ||
else | else | ||
Date = sepc .. " " .. Date .. | Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc | ||
end | end | ||
end | end | ||
end | end | ||
if | if is_set(Authors) then | ||
if (not | 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 | ||
if | if is_set(Editors) then | ||
local in_text = " "; | local in_text = " "; | ||
local post_text = ""; | local post_text = ""; | ||
if | 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 | if (sepc ~= '.') then | ||
Line 3,758: | Line 3,405: | ||
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space | Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space | ||
end | end | ||
if | if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc | ||
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; | local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; | ||
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 | 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 | 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,772: | Line 3,419: | ||
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); | text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); | ||
end | end | ||
elseif | elseif is_set(Editors) then | ||
if | if is_set(Date) then | ||
if EditorCount <= 1 then | if EditorCount <= 1 then | ||
Editors = Editors .. ", " .. cfg.messages['editor']; | Editors = Editors .. ", " .. cfg.messages['editor']; | ||
Line 3,788: | Line 3,435: | ||
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); | text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); | ||
else | else | ||
if | if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then | ||
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc ); | text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc ); | ||
else | else | ||
Line 3,795: | Line 3,442: | ||
end | end | ||
if | if is_set(PostScript) and PostScript ~= sepc then | ||
text = safe_join( {text, sepc}, sepc ); | text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc. | ||
text = text:sub(1, -sepc:len() - 1); | text = text:sub(1,-sepc:len()-1); | ||
end | end | ||
text = safe_join( {text, PostScript}, sepc ); | text = safe_join( {text, PostScript}, sepc ); | ||
-- Now enclose the whole thing in a <cite> element | -- Now enclose the whole thing in a <cite/> element | ||
local options = {}; | local options = {}; | ||
if | if is_set(config.CitationClass) and config.CitationClass ~= "citation" then | ||
options.class = | options.class = config.CitationClass; | ||
options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref= | |||
else | else | ||
options.class = | options.class = "citation"; | ||
end | end | ||
if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate | |||
if | |||
local id = Ref | local id = Ref | ||
local namelist = {}; | if ('harv' == Ref ) then | ||
local namelist = {}; -- holds selected contributor, author, editor name list | |||
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation | |||
if #c > 0 then -- if there is a contributor list | |||
namelist = c; -- select it | |||
elseif #a > 0 then -- or an author list | |||
namelist = a; | |||
elseif #e > 0 then -- or an editor list | |||
namelist = e; | |||
end | |||
if #namelist > 0 then -- if there are names in namelist | |||
id = anchor_id (namelist, year); -- go make the CITEREF anchor | |||
else | |||
id = ''; -- unset | |||
end | |||
end | end | ||
options.id = id; | options.id = id; | ||
end | end | ||
if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>", "")) <= 2 then -- remove <span> tags and other | 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 = | text = set_error('empty_citation'); | ||
z.message_tail = {}; | z.message_tail = {}; | ||
end | end | ||
Line 3,852: | Line 3,489: | ||
local render = {}; -- here we collect the final bits for concatenation into the rendered citation | local render = {}; -- here we collect the final bits for concatenation into the rendered citation | ||
if | if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags | ||
table.insert (render, | 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, | table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases | ||
end | end | ||
table.insert (render, | table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation | ||
if 0 ~= #z.message_tail then | if 0 ~= #z.message_tail then | ||
table.insert (render, ' '); | table.insert (render, ' '); | ||
for i,v in ipairs( z.message_tail ) do | for i,v in ipairs( z.message_tail ) do | ||
if | if is_set(v[1]) then | ||
if i == #z.message_tail then | if i == #z.message_tail then | ||
table.insert (render, | table.insert (render, error_comment( v[1], v[2] )); | ||
else | else | ||
table.insert (render, | table.insert (render, error_comment( v[1] .. "; ", v[2] )); | ||
end | end | ||
end | end | ||
Line 3,879: | Line 3,516: | ||
table.insert (maint, v); -- maint msg is the category name | table.insert (maint, v); -- maint msg is the category name | ||
table.insert (maint, ' ('); -- open the link text | table.insert (maint, ' ('); -- open the link text | ||
table.insert (maint, | table.insert (maint, make_wikilink (':Category:' .. v, 'link')); -- add the link | ||
table.insert (maint, ')'); -- and close it | table.insert (maint, ')'); -- and close it | ||
table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table | table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table | ||
end | end | ||
table.insert (render, | table.insert (render, substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs, ' '))); -- wrap the group of maint message with proper presentation and save | ||
end | end | ||
if | no_tracking_cats = no_tracking_cats:lower(); | ||
for _, v in ipairs( z.error_categories ) do | if in_array(no_tracking_cats, {"", "no", "false", "n"}) then | ||
table.insert (render, | 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, | table.insert (render, make_wikilink ('Category:' .. v)); | ||
end | end | ||
for _, v in ipairs( z.properties_cats ) do -- append properties categories | for _, v in ipairs( z.properties_cats ) do -- append properties categories | ||
table.insert (render, | table.insert (render, make_wikilink ('Category:' .. v)); | ||
end | end | ||
end | end | ||
Line 3,913: | Line 3,551: | ||
]] | ]] | ||
local function validate (name, cite_class | 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 | |||
state = whitelist.limited_basic_arguments[name]; | |||
if true == state then return true; end -- valid actively supported parameter | if true == state then return true; end -- valid actively supported parameter | ||
if false == state then | if false == state then | ||
deprecated_parameter (name); -- parameter is deprecated but still supported | deprecated_parameter (name); -- parameter is deprecated but still supported | ||
return true; | return true; | ||
end | end | ||
if ' | |||
state = whitelist[cite_class .. '_basic_arguments'][name]; -- look in the parameter-list for the template identified by cite_class | |||
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; | return true; | ||
end | end | ||
return false; -- not supported because not found or name is set to nil | return false; -- not supported because not found or name is set to nil | ||
end -- end limited parameter-set templates | end -- end limited parameter-set templates | ||
state = whitelist.basic_arguments[name]; -- all other templates; all normal parameters allowed | state = whitelist.basic_arguments[name]; -- all other templates; all normal parameters allowed | ||
if true == | |||
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 | |||
-- all enumerated parameters allowed | -- all enumerated parameters allowed | ||
name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) | |||
state = whitelist.numbered_arguments[ | state = whitelist.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 | return false; -- not supported because not found or name is set to nil | ||
end | end | ||
Line 3,994: | Line 3,607: | ||
Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal | Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal | ||
sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a | sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a | ||
parameter that is missing its pipe | parameter that is missing its pipe: | ||
{{cite ... |title=Title access-date=2016-03-17}} | {{cite ... |title=Title access-date=2016-03-17}} | ||
cs1|2 shares some parameter names with | cs1|2 shares some parameter names with xml/html atributes: class=, title=, etc. To prevent false positives xml/html | ||
tags are removed before the search. | tags are removed before the search. | ||
Line 4,006: | Line 3,619: | ||
local function missing_pipe_check (parameter, value) | local function missing_pipe_check (parameter, value) | ||
local capture; | local capture; | ||
value = value:gsub ('%b<>', ''); -- remove | value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc | ||
capture = value:match ('%s+(%a[% | capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes | ||
if capture and validate (capture) then | if capture and validate (capture) then -- if the capture is a valid parameter name | ||
table.insert( z.message_tail, { | table.insert( z.message_tail, {set_error ('missing_pipe',parameter)}); | ||
end | end | ||
end | end | ||
--[[--------------------------< | --[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------ | ||
This is used by templates such as {{cite book}} to create the actual citation text. | |||
]] | ]] | ||
local function | local function citation(frame) | ||
Frame = frame; -- save a copy incase we need to display an error message in preview mode | |||
local pframe = frame:getParent() | |||
local validation, utilities, identifiers, metadata, styles; | |||
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? | |||
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of support modules | |||
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox'); | |||
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? | |||
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of support modules | |||
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox'); | |||
utilities = require ('Module:Citation/CS1/Utilities/sandbox'); | utilities = require ('Module:Citation/CS1/Utilities/sandbox'); | ||
validation = require ('Module:Citation/CS1/Date_validation/sandbox'); | validation = require ('Module:Citation/CS1/Date_validation/sandbox'); | ||
Line 4,065: | Line 3,656: | ||
metadata = require ('Module:Citation/CS1/COinS'); | metadata = require ('Module:Citation/CS1/COinS'); | ||
styles = 'Module:Citation/CS1/styles.css'; | styles = 'Module:Citation/CS1/styles.css'; | ||
end | end | ||
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the | 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 (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module | 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 | ||
dates = validation.dates; -- imported functions from Module:Citation/CS1/Date validation | |||
year_date_check = validation.year_date_check; | |||
reformat_dates = validation.reformat_dates; | |||
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 | |||
in_array = utilities.in_array; | |||
substitute = utilities.substitute; | |||
error_comment = utilities.error_comment; | |||
set_error = utilities.set_error; | |||
select_one = utilities.select_one; | |||
add_maint_cat = utilities.add_maint_cat; | |||
wrap_style = utilities.wrap_style; | |||
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/Identifiers | |||
build_id_list = identifiers.build_id_list; | |||
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 | |||
get_coins_pages = metadata.get_coins_pages; | |||
COinS = metadata.COinS; | |||
local args = {}; -- table where we store all of the template's arguments | local args = {}; -- table where we store all of the template's arguments | ||
Line 4,079: | Line 3,698: | ||
local config = {}; -- table to store parameters from the module {{#invoke:}} | 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 | ||
local capture; -- the single supported capture when matching unknown parameters using patterns | local capture; -- the single supported capture when matching unknown parameters using patterns | ||
for k, v in pairs( pframe.args ) do | |||
for k, v in pairs( pframe.args ) do | |||
if v ~= '' then | if v ~= '' then | ||
if ('string' == type (k)) then | if ('string' == type (k)) then | ||
Line 4,095: | Line 3,712: | ||
error_text = ""; | error_text = ""; | ||
if type( k ) ~= 'string' then | if type( k ) ~= 'string' then | ||
-- | -- Exclude empty numbered parameters | ||
if v:match("%S+") ~= nil then | if v:match("%S+") ~= nil then | ||
error_text, error_state = | error_text, error_state = set_error( 'text_ignored', {v}, true ); | ||
end | end | ||
elseif validate( k:lower(), config.CitationClass ) then | elseif validate( k:lower(), config.CitationClass ) then | ||
error_text, error_state = | error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); -- suggest the lowercase version of the parameter | ||
else | else | ||
if nil == suggestions.suggestions then -- if this table is nil then we need to load it | if nil == suggestions.suggestions then -- if this table is nil then we need to load it | ||
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? | if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? | ||
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version | suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version | ||
else | else | ||
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version | suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version | ||
end | end | ||
end | end | ||
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter | for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter | ||
capture = k:match (pattern); -- the whole match if no | capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match | ||
if capture then -- if the pattern matches | if capture then -- if the pattern matches | ||
param = | param = substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator) | ||
if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists) | if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists) | ||
error_text, error_state = | error_text, error_state = set_error ('parameter_ignored_suggest', {k, param}, true); -- set the suggestion error message | ||
else | else | ||
error_text, error_state = | error_text, error_state = set_error( 'parameter_ignored', {param}, true ); -- suggested param not supported by this template | ||
end | |||
end | end | ||
end | end | ||
end | if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion? | ||
if not | if suggestions.suggestions[ k:lower() ] ~= nil then | ||
if | error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true ); | ||
error_text, error_state = | else | ||
else | error_text, error_state = set_error( 'parameter_ignored', {k}, true ); | ||
error_text, error_state = | v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists) | ||
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists) | end | ||
end | end | ||
end | end | ||
end | if error_text ~= '' then | ||
if error_text ~= '' then | table.insert( z.message_tail, {error_text, error_state} ); | ||
table.insert( z.message_tail, {error_text, error_state} ); | end | ||
end | end | ||
end | missing_pipe_check (k, 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; | |||
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 | ||
for k, v in pairs( args ) do | for k, v in pairs( args ) do | ||
if 'string' == type (k) then -- don't evaluate positional parameters | if 'string' == type (k) then -- don't evaluate positional parameters | ||
has_invisible_chars (k, v); | has_invisible_chars (k, v); | ||
end | end | ||
end | end | ||
return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})}); | |||
return table.concat ({ | |||
end | end | ||