Module:Citation/CS1 and Module:Citation/CS1/sandbox: Difference between pages

(Difference between pages)
Jump to: navigation, search
Page 1
Page 2
No edit summary
 
m 1 revision imported
 
Line 1: Line 1:
require ('strict');
--[[
History of changes since last sync: 2016-10-29
 
2016-11-07: override mw:Extension:CLDR language definition for code bn; see: Help_talk:Citation_Style_1#Bengali_or_Bangla.3F
2016-11-21: remove support for special cite interview parameters
2016-12-29: fix spacing oddity in maint cat messaging; see Help_talk:Citation_Style_1#Weird_linebreak_at_the_end_of_citations
2016-12-31: fix multi-byte character |vauthors= bug; see Help_talk:Citation_Style_1#.7Cvauthors.3D_bug_fix
2017-01-05: detect and alert on wayback machine deprecated liveweb host name; see Help_talk:Citation_Style_1#liveweb.archive.org
2017-01-12: move transtitle out of external link
2017-02-09: 2017-02-09: access signal lock images per RFC; see Wikipedia:Village_pump_(proposals)/Archive_135#Access_locks:_Visual_Design_RFC
2017-02-12: remove duplicate lock image code; see Help_talk:Citation_Style_1#Whatever_happened_to_the_access_lock_RFCs.3F
2017-02-23: replace cite arxiv unsupported parameter test with lint of supported in whitelist; see Help_talk:Citation_Style_1#cite_arxiv_unsupported_parameters
2017-03-26: support for cite biorxiv and cite citeseerx; see Help_talk:Citation_Style_1#.7B.7Bcite_bioRxiv.7D.7D
 
]]
 
local cs1 ={};


--[[--------------------------< 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 dates, year_date_check, reformat_dates, date_hyphen_to_dash -- functions in Module:Citation/CS1/Date_validation


each of these counts against the Lua upvalue limit
local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities
add_maint_cat, wrap_style, safe_for_italics, remove_wiki_link;


]]
local z ={}; -- tables in Module:Citation/CS1/Utilities


local validation; -- functions in Module:Citation/CS1/Date_validation
local extract_ids, extract_id_access_levels, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers


local utilities; -- functions in Module:Citation/CS1/Utilities
local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS
local z = {}; -- table of tables in Module:Citation/CS1/Utilities


local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers
local metadata; -- 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 >--------------------------------------


declare variables here that have page-wide scope that are not brought in from
delare variables here that have page-wide scope that are not brought in from other modules; thatare created here
other modules; that are created here and used here
and used here


]]
]]


local added_deprecated_cat; -- Boolean flag so that the category is added only once
local added_deprecated_cat; -- boolean flag so that the category is added only once
local added_vanc_errs; -- Boolean flag so we only emit one Vancouver error / category
local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats
local added_generic_name_errs; -- Boolean flag so we only emit one generic name error / category and stop testing names once an error is encountered
local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category
local added_numeric_name_errs; -- Boolean flag so we only emit one numeric name error / category and stop testing names once an error is encountered
 
local added_numeric_name_maint; -- Boolean flag so we only emit one numeric name maint category and stop testing names once a category has been emitted
local Frame; -- holds the module's frame table
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
local is_sandbox; -- true when using sandbox modules to render citation




Line 48: Line 63:
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 utilities.is_set( list[i] ) then
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
Line 55: Line 70:
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.
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
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
end
end


--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------
--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------
Line 61: Line 90:
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
To prevent duplication, added_vanc_errs is nil until an error message is emitted.


added_vanc_errs is a Boolean declared in page scope variables above
added_vanc_errs is a boolean declared in page scope variables above


]]
]]


local function add_vanc_error (source, position)
local function add_vanc_error (source)
if added_vanc_errs then return end
if not added_vanc_errs then
added_vanc_errs = true; -- note that we've added this category
added_vanc_errs = true; -- note that we've added this category
table.insert( z.message_tail, { set_error( 'vancouver', {source}, true ) } );
utilities.set_message ('err_vancouver', {source, position});
end
end
end


Line 75: Line 104:
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------


does this thing that purports to be a URI scheme seem to be a valid scheme?  The scheme is checked to see if it
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 98: Line 127:
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 TLDs: https://www.iana.org/domains/root/db
list of tlds: https://www.iana.org/domains/root/db


RFC 952 (modified by RFC 1123) requires the first and last character of a hostname to be a letter or a digit.  Between
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 TLD.  tld
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 URL with a scheme) will be stripped
is two or more alpha characters.  Any preceding '//' (from splitting a url with a scheme) will be stripped
here.  Perhaps not necessary but retained in case it is necessary for IPv4 dot decimal.
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 (ASCII characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the TLD) see https://tools.ietf.org/html/rfc3490
internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
single-letter/digit second-level domains in the .org TLD
q, x, and z SL domains in the .com TLD
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
i and q SL domains in the .net TLD
Line 120: Line 149:
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 TLD or IPv4 address, else false
returns true if domain appears to be a proper name and tld or IPv4 address, else false


]=]
]=]
Line 131: Line 160:
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 ('^[%w]') then -- first character must be letter or digit
if not domain:match ('^[%a%d]') then -- first character must be letter or digit
return false;
return false;
end
end
 
-- Do most common case first
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource
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;
elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix
return true;
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character .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;
return false;
end
end
end


local patterns = { -- patterns that look like URLs
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
'%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
'%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
'%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
'%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
'%f[%w][%w]%.%a%a$', -- one character hostname and ccTLD (2 chars)
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
'[%a%d]+%:?'                                                            -- IPv6 address
}


for _, pattern in ipairs (patterns) do -- loop through the patterns list
returns true if the scheme and domain parts of a url appear to be a valid url; else false.
if domain:match (pattern) then
return true; -- if a match then we think that this thing that purports to be a URL is a URL
end
end
 
for _, d in ipairs (cfg.single_letter_2nd_lvl_domains_t) do -- look for single letter second level domain names for these top level domains
if domain:match ('%f[%w][%w]%.' .. d) then
return true
end
end
return false; -- no matches, we don't know what this thing is
end
 
 
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
 
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 176: Line 197:


local function is_url (scheme, domain)
local function is_url (scheme, domain)
if utilities.is_set (scheme) then -- if scheme is set check it and domain
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 URL is protocol-relative
return is_domain_name (domain); -- scheme not set when url is protocol relative
end
end
end
end
Line 186: Line 207:
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------


Split a URL into a scheme, authority indicator, and domain.
Split a url into a scheme, authority indicator, and domain.


First remove Fully Qualified Domain Name terminator (a dot following TLD) (if any) and any path(/), query(?) or fragment(#).
First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#).


If protocol-relative URL, return nil scheme and domain else return nil for both scheme and domain.
If protocol relative url, return nil scheme and domain else return nil for both scheme and domain.


When not protocol-relative, get scheme, authority indicator, and domain.  If there is an authority indicator (one
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.
Any URL that does not have news: scheme must have authority indicator (//).  TODO: are there other common schemes
like news: that don't use authority indicator?


Strip off any port and path;
Strip off any port and path;
Line 207: Line 225:
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-relative URL
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
if utilities.is_set (authority) then
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
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
if utilities.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
return scheme; -- return scheme only making domain nil which will cause an error message
end
else
if not scheme:match ('^news:') then -- except for news:..., MediaWiki won't link URLs that do not have authority indicator; TODO: a better way to do this test?
return scheme; -- return scheme only making domain nil which will cause an error message
end
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 230: Line 242:
--[[--------------------------< 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=, etc. for properly formatted content: no wikilinks, no URLs
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 Wikipedia article, so none of the WP:TITLESPECIALCHARACTERS are allowed:
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 URLs and # which is used for section links
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 URL (the
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 URL (the |<param>-link= parameter is NOT ok).
|<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok).


]]
]]
Line 245: Line 257:
local function link_param_ok (value)
local function link_param_ok (value)
local scheme, domain;
local scheme, domain;
if value:find ('[<>%[%]|{}]') then                                         -- if any prohibited characters
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
return false;
return false;
end
end


scheme, domain = split_url (value); -- get scheme or nil and domain or nil from URL;  
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 URL
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url
end
end


--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------
--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------
Line 258: Line 269:
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 wiki-linked but not when |<param>-link= has a value.  This function emits an error message when
|<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
check <link> for inter-language interwiki-link prefix.  prefix must be a MediaWiki-recognized language
code and must begin with a colon.


]]
]]


local function link_title_ok (link, lorig, title, torig)
local function link_title_ok (link, lorig, title, torig)
local orig;
local orig;
if utilities.is_set (link) then -- don't bother if <param>-link doesn't have a value
 
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
elseif link:match ('^%a+:') then -- if the link is what looks like an interwiki
local prefix = link:match ('^(%a+):'):lower(); -- get the interwiki prefix
if cfg.inter_wiki_map[prefix] then -- if prefix is in the map, must have preceding colon
orig = lorig; -- flag as error
end
end
end
end
end


if utilities.is_set (orig) then
if is_set (orig) then
link = ''; -- unset
table.insert( z.message_tail, { set_error( 'bad_paramlink', orig)}); -- url or wikilink in |title= with |title-link=;
utilities.set_message ('err_bad_paramlink', orig); -- URL or wikilink in |title= with |title-link=;
end
end
return link; -- link if ok, empty string else
end
end


Line 295: Line 295:
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 URL into scheme and domain
First we test for space characters.  If any are found, return false.  Then split the url into scheme and domain
portions, or for protocol-relative (//example.com) URLs, just the domain.  Use is_url() to validate the two
portions, or for protocol relative (//example.com) urls, just the domain.  Use is_url() to validate the two
portions of the URL.  If both are valid, or for protocol-relative if domain is valid, return true, else false.
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 URL, and because this module used external_link() to make external links
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 306: Line 306:


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 URL
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 URL;
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 317: Line 317:
end
end
return is_url (scheme, domain); -- return true if value appears to be a valid URL
return is_url (scheme, domain); -- return true if value appears to be a valid url
end
end


Line 324: Line 324:


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 URL.  The test will also find external wikilinks
non-space characters following the opening bracket appear to be a url.  The test will also find external wikilinks
that use protocol-relative URLs. Also finds bare URLs.
that use protocol relative urls. Also finds bare urls.


The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs.  The tests that
The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls.  The tests that
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
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 337: Line 337:
local scheme, domain;
local scheme, domain;


if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext. wikilink with scheme and domain: [xxxx://yyyyy.zzz]
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-relative ext. wikilink: [//yyyyy.zzz]
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 URL with scheme; may have leading or trailing plain text
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+') or value:match ('%s//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; authority indicator (//) must be be preceded nothing or by whitespace
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 URL
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 URL
return is_url (scheme, domain); -- return true if value appears to be a valid url
end
end


Line 359: Line 359:
]]
]]


local function check_for_url (parameter_list, error_list)
local function check_for_url (parameter_list)
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 URL add an error message
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message
table.insert (error_list, utilities.wrap_style ('parameter', k));
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
end
error_message=error_message .. "&#124;" .. k .. "="; -- add the failed parameter
end
end
end
if is_set (error_message) then -- done looping, if there is an error message, display it
table.insert( z.message_tail, { set_error( 'param_has_ext_link', {error_message}, true ) } );
end
end
end
end
Line 376: Line 383:
local function safe_for_url( str )
local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then  
if str:match( "%[%[.-%]%]" ) ~= nil then  
utilities.set_message ('err_wikilink_in_url', {});
table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } );
end
end
Line 384: Line 391:
['\n'] = ' ' } );
['\n'] = ' ' } );
end
end


--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
Line 392: Line 398:
]]
]]


local function external_link (URL, label, source, access)
local function external_link( URL, label, source, access)
local err_msg = '';
local error_str = "";
local domain;
local domain;
local path;
local path;
local base_url;
local base_url;
 
if not utilities.is_set (label) then
if not is_set( label ) then
label = URL;
label = URL;
if utilities.is_set (source) then
if is_set( source ) then
utilities.set_message ('err_bare_url_missing_title', {utilities.wrap_style ('parameter', source)});
error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
else
else
error (cfg.messages["bare_url_no_origin"]); -- programmer error; valid parameter name does not have matching meta-parameter
error( cfg.messages["bare_url_no_origin"] );
end
end
end
end
if not check_url (URL) then
if not check_url( URL ) then
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)});
error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str;
end
end
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path
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'}); -- replace '[' and ']' with their percent-encoded values
path = path:gsub ('[%[%]]', {['[']='%5b',[']']='%5d'}); -- replace '[' and ']' with their percent encoded values
URL = table.concat ({domain, path}); -- and reassemble
URL=domain..path; -- and reassemble
end
end
-- base_url = table.concat({ "[", URL, " ", safe_for_url( label ), "]" });
-- if is_set(access) then -- access level (free, paywalled, ...)
-- base_url = substitute(cfg.presentation[access], base_url);
-- end
if is_set (access) then -- access level (subscription, registration, limited)
local label_head = '';
local label_tail;
local markup = ''; -- can't start a span inside italic markup and end it outside the italic markup


base_url = table.concat ({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL
label = safe_for_url (label); -- replace square brackets and newlines (is this necessary? already done above?)
if label:match ("(.*)%s+(.+)('''?)$") then -- for italicized titles (cite book, etc)
label_head, label_tail, markup = label:match ("(.*)%s+(.+)('''?)$"); -- split the label at the right-most space
elseif label:match ("(.*)%s+(.+)$") then -- for upright titles (journal, news, magazine, etc)
label_head, label_tail = label:match ("(.*)%s+(.+)$"); -- split the label at the right-most space; separate the markup
elseif label:match ("(.+)('''?)$") then -- single word label with markup
label_tail, markup = label:match ("(.+)('''?)$"); -- save label text as label tail; separate the markup
else
label_tail = label;
end


if utilities.is_set (access) then -- access level (subscription, registration, limited)
base_url = table.concat (
base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
{
'<span class="plainlinks">[', -- opening css
URL, -- the url
' ', -- the required space
label_head, -- all but the last word of the label
' <span class="nowrap">', -- nowrap css for the last word and the signal icon
label_tail, -- last (or only) word of the label inside the span
'<span style="padding-left:0.15em">', -- signal spacing css
cfg.presentation[access], -- the appropriate icon
'</span></span>', -- close signal spacing and nowrap spans
markup, -- insert italic markup if any
']</span>' -- close the plain links span
});
else
base_url = table.concat({ "[", URL, " ", safe_for_url( label ), "]" }); -- no signal markup
end
end
 
return base_url;
return table.concat({ base_url, error_str });
end
end


Line 432: Line 472:
parameters in the citation.
parameters in the citation.


added_deprecated_cat is a Boolean declared in page scope variables above
added_deprecated_cat is a boolean declared in page scope variables above


]]
]]
Line 439: Line 479:
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
utilities.set_message ('err_deprecated_params', {name}); -- add error message
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
end
end
end
end


--[[--------------------------< 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 Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value.
 
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
mark contained in a |title= or |chapter= parameter's value.
 
This function will positive kern either single or double quotes:
This function will positive kern either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
Double single quotes (italic or bold wiki-markup) are not kerned.
Double single quotes (italic or bold wikimarkup) are not kerned.


Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
Replaces unicode quotemarks with typewriter quote marks regardless of the need for kerning.
quote marks regardless of the need for kerning.  Unicode quote marks are not replaced in simple [[D]] wikilinks.


Call this function for chapter titles, for website titles, etc.; not for book titles.
Call this function for chapter titles, for website titles, etc; not for book titles.


]=]
]]


local function kern_quotes (str)
local function kern_quotes (str)
local cap = '';
local cap='';
local wl_type, label, link;
local cap2='';
 
-- TODO: move this elswhere so that all title-holding elements get these quote marks replaced?
wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
str= mw.ustring.gsub (str, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
str= mw.ustring.gsub (str, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
if is_set (cap) then
str = utilities.substitute (cfg.presentation['kern-left'], str);
str = substitute (cfg.presentation['kern-left'], {cap, cap2});
str = utilities.substitute (cfg.presentation['kern-right'], str);
end
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
str = utilities.substitute (cfg.presentation['kern-left'], str);
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
str = utilities.substitute (cfg.presentation['kern-right'], str);
end
 
else -- plain text or [[L|D]]; text in label variable
label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)


cap = mw.ustring.match (label, "^([\"\'][^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
if utilities.is_set (cap) then
if is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-left'], cap);
str = substitute (cfg.presentation['kern-right'], {cap, cap2});
end
cap = mw.ustring.match (label, "^(.+[^\'][\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
if utilities.is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-right'], cap);
end
if 2 == wl_type then
str = utilities.make_wikilink (link, label); -- reassemble the wikilink
else
str = label;
end
end
end
return str;
return str;
end
end


--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------


|script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
|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 RTL languages from the English left to right.
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 ISO 639-1 language code and a colon:
|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 517: Line 532:
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 ISO 639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
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=, |script-chapter=, |script-<periodical>=
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, script_param)
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%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
if not utilities.is_set (lang) then
if not is_set (lang) then
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing title part']}); -- prefix without 'title'; add error message
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_tag_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
name = mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize
if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code?
if is_set (name) then -- is prefix a proper ISO 639-1 language code?
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
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 utilities.in_array (lang, cfg.script_lang_codes) then
if in_array (lang, cfg.script_lang_codes) then
utilities.add_prop_cat ('script', {name, lang})
add_prop_cat ('script_with_name', {name, lang})
else
else
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['unknown language code']}); -- unknown script-language; add error message
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
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['invalid language code']}); -- invalid language code; add error message
lang = ''; -- invalid so set lang to empty string
lang = ''; -- invalid so set lang to empty string
end
end
else
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing prefix']}); -- no language code prefix; add error message
end
end
script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl


return script_value;
return script_value;
end
end


--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------


Initially for |title= and |script-title=, this function concatenates those two parameter values after the script
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been  
value has been wrapped in <bdi> tags.
wrapped in <bdi> tags.
 
]]
]]


local function script_concatenate (title, script, script_param)
local function script_concatenate (title, script)
if utilities.is_set (script) then
if is_set (script) then
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
if utilities.is_set (script) then
if is_set (script) then
title = title .. ' ' .. script; -- concatenate title and script title
title = title .. ' ' .. script; -- concatenate title and script title
end
end
Line 585: Line 595:


local function wrap_msg (key, str, lower)
local function wrap_msg (key, str, lower)
if not utilities.is_set ( str ) then
if not is_set( str ) then
return "";
return "";
end
end
Line 591: Line 601:
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 utilities.substitute ( msg, str ); -- including template text
return substitute( msg, str ); -- including template text
else
else
return utilities.substitute ( cfg.messages[key], str );
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 >-------------------
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
 
Makes a Wikisource URL from Wikisource interwiki-link.  Returns the URL and appropriate
label; nil else.


str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).


]]
]]


local function wikisource_url_make (str)
local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes)
local wl_type, D, L;
local chapter_error = '';
local ws_url, ws_label;
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});
if not is_set (chapter) then
chapter = ''; -- to be safe for concatenation
else
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
chapter = wrap_style ('quoted-title', chapter);
end
end


wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped


if 0 == wl_type then -- not a wikilink; might be from |title-link=
if is_set (transchapter) then
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
transchapter = wrap_style ('trans-quoted-title', transchapter);
if utilities.is_set (str) then
if is_set (chapter) then
ws_url = table.concat ({ -- build a Wikisource URL
chapter = chapter .. ' ' .. transchapter;
wikisource_prefix, -- prefix
else -- here when transchapter without chapter or script-chapter
str, -- article title
chapter = transchapter; --  
});
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
ws_label = str; -- label for the URL
end
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
if utilities.is_set (str) then
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title
});
ws_label = str; -- label for the URL
end
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
if utilities.is_set (str) then
ws_label = D; -- get ws article name from display portion of interwiki link
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title without namespace from link portion of wikilink
});
end
end
end
end


if ws_url then
if is_set (chapterurl) then
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL
chapter = external_link (chapterurl, chapter, chapter_url_source, nil); -- adds bare_url_missing_title error if appropriate
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent-encoding of fragment marker
end
end


return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil
return chapter .. chapter_error;
end
end


--[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >----------------------------------------


--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
This function searches a parameter's value for nonprintable or invisible characters.  The search stops at the
first match.


Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
This function will detect the visible replacement character when it is part of the wikisource.
and |trans-<periodical>= into a single Periodical meta-parameter.


]]
Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers (gallery, math, pre, ref)
and identifies them with a slightly different error message.  See also coins_cleanup().


local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
Detects but ignores the character pattern that results from the transclusion of {{'}} templates.


if not utilities.is_set (periodical) then
Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
periodical = ''; -- to be safe for concatenation
that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the
else
parameter value.
periodical = utilities.wrap_style ('italic-title', periodical); -- style
end


periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
]]


if utilities.is_set (trans_periodical) then
local function has_invisible_chars (param, v)
trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical);
local position = ''; -- position of invisible char or starting position of stripmarker
if utilities.is_set (periodical) then
local dummy; -- end of matching string; not used but required to hold end position when a capture is returned
periodical = periodical .. ' ' .. trans_periodical;
local capture; -- used by stripmarker detection to hold name of the stripmarker
else -- here when trans-periodical without periodical or script-periodical
local i=1;
periodical = trans_periodical;
local stripmarker, apostrophe;
utilities.set_message ('err_trans_missing_title', {'periodical'});
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;
end
 
while cfg.invisible_chars[i] do
local char=cfg.invisible_chars[i][1] -- the character or group name
local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it
position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern
if position then
if 'nowiki' == capture or 'math' == capture then -- nowiki, math stripmarker (not an error condition)
stripmarker = true; -- set a flag
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
else
local err_msg;
if capture then
err_msg = capture .. ' ' .. char;
else
err_msg = char .. ' ' .. 'character';
end
 
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
end
end
end
i=i+1; -- bump our index
end
end
return periodical;
end
end




--[[------------------< F O R M A T _ C H A P T E R _ T I T L E >---------------
--[[--------------------------< A R G U M E N T _ W R A P P E R >----------------------------------------------


Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=,
Argument wrapper.  This function provides support for argument mapping defined in the configuration file so that
and |chapter-url= into a single chapter meta- parameter (chapter_url_source used
multiple names can be transparently aliased to single internal variable.
for error messages).


]]
]]


local function format_chapter_title (script_chapter, script_chapter_source, chapter, chapter_source, trans_chapter, trans_chapter_source, chapter_url, chapter_url_source, no_quotes, access)
local function argument_wrapper( args )
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
local origin = {};
if ws_url then
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
return setmetatable({
chapter = ws_label;
ORIGIN = function( self, k )
end
local dummy = self[k]; --force the variable to be loaded.
 
return origin[k];
if not utilities.is_set (chapter) then
chapter = ''; -- to be safe for concatenation
else
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from module provided quote marks
chapter = utilities.wrap_style ('quoted-title', chapter);
end
end
end
},
 
{
chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
__index = function ( tbl, k )
 
if origin[k] ~= nil then
if utilities.is_set (chapter_url) then
return nil;
chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
end
elseif ws_url then
chapter = external_link (ws_url, chapter .. '&nbsp;', '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?
local args, list, v = args, cfg.aliases[k];
chapter = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
end
if type( list ) == 'table' then
 
v, origin[k] = select_one( args, list, 'redundant_parameters' );
if utilities.is_set (trans_chapter) then
if origin[k] == nil then
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
origin[k] = ''; -- Empty string, not nil
if utilities.is_set (chapter) then
end
chapter = chapter .. ' ' .. trans_chapter;
elseif list ~= nil then
else -- here when trans_chapter without chapter or script-chapter
v, origin[k] = args[list], list;
chapter = trans_chapter;
else
chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>
-- maybe let through instead of raising an error?
utilities.set_message ('err_trans_missing_title', {chapter_source});
-- v, origin[k] = args[k], k;
end
error( cfg.messages['unknown_argument_map'] );
end
end
 
return chapter;
-- Empty strings, not nil;
if v == nil then
v = cfg.defaults[k] or '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
end


--[[--------------------------< V A L I D A T E >--------------------------------------------------------------


--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------
Looks for a parameter's name in one of several whitelists.
 
This function searches a parameter's value for non-printable or invisible characters.
The search stops at the first match.
 
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
(gallery, math, pre, ref) and identifies them with a slightly different error message.
See also coins_cleanup().
 
Output of this function is an error message that identifies the character or the
Unicode group, or the stripmarker that was detected along with its position (or,
for multi-byte characters, the position of its first byte) in the parameter value.


Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
]]
]]


local function has_invisible_chars (param, v)
--local function validate( name )
local position = ''; -- position of invisible char or starting position of stripmarker
local function validate( name, cite_class )
local capture; -- used by stripmarker detection to hold name of the stripmarker
local name = tostring( name );
local stripmarker; -- boolean set true when a stripmarker is found
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 false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end


capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true
if 'arxiv' == cite_class then -- basic parameters unique to these templates
if capture == v then -- if same there are no Unicode characters
state = whitelist.arxiv_basic_arguments[name];
return;
end
end
if 'biorxiv' == cite_class then
state = whitelist.biorxiv_basic_arguments[name];
end
if 'citeseerx' == cite_class then
state = whitelist.citeseerx_basic_arguments[name];
end


for _, invisible_char in ipairs (cfg.invisible_chars) do
if true == state then return true; end -- valid actively supported parameter
local char_name = invisible_char[1]; -- the character or group name
if false == state then
local pattern = invisible_char[2]; -- the pattern used to find it
deprecated_parameter (name); -- parameter is deprecated but still supported
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
return true;
if position and (cfg.invisible_defs.zwj == capture) then -- if we found a zero-width joiner character
if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts
position = nil; -- unset position
elseif cfg.emoji_t[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
position = nil; -- unset position
end
end
end
-- limited enumerated parameters list
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#)
state = whitelist.limited_numbered_arguments[ name ];
if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end
return false; -- not supported because not found or name is set to nil
end -- end limited parameter-set templates
if position then
state = whitelist.basic_arguments[ name ]; -- all other templates; all normal parameters allowed
if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition)
('templatestyles' == capture and utilities.in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters
if true == state then return true; end -- valid actively supported parameter
stripmarker = true; -- set a flag
if false == state then
elseif true == stripmarker and cfg.invisible_defs.del == capture then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
deprecated_parameter (name); -- parameter is deprecated but still supported
position = nil; -- unset
return true;
else
end
local err_msg;
-- all enumerated parameters allowed
if capture and not (cfg.invisible_defs.del == capture or cfg.invisible_defs.zwj == capture) then
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
err_msg = capture .. ' ' .. char_name;
state = whitelist.numbered_arguments[ name ];
else
err_msg = char_name .. ' ' .. 'character';
end


utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}); -- add error message
if true == state then return true; end -- valid actively supported parameter
return; -- and done with this parameter
if false == state then
end
deprecated_parameter (name); -- parameter is deprecated but still supported
end
return true;
end
end
return false; -- not supported because not found or name is set to nil
end
end




--[[-------------------< A R G U M E N T _ W R A P P E R >----------------------
--[[--------------------------< 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 DD MMMM YYYY or is
MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY


Argument wrapper.  This function provides support for argument mapping defined
DOES NOT yet support MMMM YYYY or any of the date ranges.
in the configuration file so that multiple names can be transparently aliased to
single internal variable.


]]
]]


local function argument_wrapper ( args )
local function nowrap_date (date)
local origin = {};
local cap='';
local cap2='';
 
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = substitute (cfg.presentation['nowrap1'], date);
return setmetatable({
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
ORIGIN = function ( self, k )
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
local dummy = self[k]; -- force the variable to be loaded.
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
return origin[k];
end
end
},
return date;
{
__index = function ( tbl, k )
if origin[k] ~= nil then
return nil;
end
local args, list, v = args, cfg.aliases[k];
if type( list ) == 'table' then
v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' );
if origin[k] == nil then
origin[k] = ''; -- Empty string, not nil
end
elseif list ~= nil then
v, origin[k] = args[list], list;
else
-- maybe let through instead of raising an error?
-- v, origin[k] = args[k], k;
error( cfg.messages['unknown_argument_map'] .. ': ' .. k);
end
-- Empty strings, not nil;
if v == nil then
v = '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
end


--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------


--[[--------------------------< N O W R A P _ D A T E >-------------------------
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).


When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
]]
When date is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span:
<span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY


DOES NOT yet support MMMM YYYY or any of the date ranges.
local function set_titletype (cite_class, title_type)
if is_set(title_type) then
if "none" == title_type then
title_type = ""; -- if |type=none then type parameter not displayed
end
return title_type; -- if |type= has been set to any other value use that value
end


]]
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
 
local function nowrap_date (date)
local cap = '';
local cap2 = '';
 
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = utilities.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
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
end
return date;
end
end




--[[--------------------------< S E T _ T I T L E T Y P E >---------------------
--[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------


This function sets default title types (equivalent to the citation including
Converts a hyphen to a dash
|type=<default value>) for those templates that have defaults. Also handles the
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 hyphen_to_dash( str )
if utilities.is_set (title_type) then
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
if 'none' == cfg.keywords_xlate[title_type] then
return str;
title_type = ''; -- if |type=none then type parameter not displayed
end
end
return str:gsub( '-', '–' );
return title_type; -- if |type= has been set to any other value use that value
end
 
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
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 898: Line 888:


local function safe_join( tbl, duplicate_char )
local function safe_join( tbl, duplicate_char )
local f = {}; -- create a function table appropriate to type of 'duplicate character'
--[[
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
Note: we use string functions here, rather than ustring functions.
f.gsub = string.gsub
f.match = string.match
This has considerably faster performance and should work correctly as
f.sub = string.sub
long as the duplicate_char is strict ASCII. The strings
else -- for multi-byte characters use the ustring library functions
in tbl may be ASCII or UTF8.
f.gsub = mw.ustring.gsub
]]
f.match = mw.ustring.match
f.sub = mw.ustring.sub
end
 
local str = ''; -- the output string
local str = ''; -- the output string
local comp = ''; -- what does 'comp' mean?
local comp = ''; -- what does 'comp' mean?
Line 919: Line 906:
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 -- special case of values enclosed in spans and other markup.
if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
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 comp:sub(1,1) == duplicate_char then -- is first charactier 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 th
--  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 = str:sub(-1,-1); -- get the last character of the output string
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff?
if end_chr == duplicate_char then -- if same as separator
if end_chr == duplicate_char then -- if same as separator
str = f.sub(str, 1, -2); -- remove it
str = str:sub(1,-2); -- remove it
elseif end_chr == "'" then -- if it might be wiki-markup
elseif end_chr == "'" then -- if it might be wikimarkup
if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc''  
if str:sub(-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 = str:sub(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 str:sub(-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 str:sub(-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 wiki-markup
elseif end_chr == "]" then -- if it might be wikimarkup
if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink  
if str:sub(-3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink  
trim = true;
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
trim = true;
trim = true;
elseif f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
elseif str:sub(-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 str:sub(-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 str:sub(-2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
str = f.sub(str, 1, -3); -- remove them both
str = str:sub(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 HTML markup
if value ~= comp then -- value does not equal comp when value contains html markup
local dup2 = duplicate_char;
local dup2 = duplicate_char;
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
if dup2:match( "%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 HTML markup
value = value:gsub( "(%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 = value:sub( 2, -1 ); -- remove duplicate_char when it is first character
end
end
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
return str;
return str;
end
end




--[[--------------------------< I S _ S U F F I X >-----------------------------
--[[--------------------------< I S _ S U F F I X >------------------------------------------------------------


returns true if suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
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 utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
if in_array (suffix, {'Jr', 'Sr', '2nd', '3rd'}) or suffix:match ('^%dth$') then
return true;
return true;
end
end
Line 989: Line 973:
end
end


--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------


--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------
For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters.  When a name
uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character.
When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters.
These things are not currently possible in this module so are left to the editor to do.


For Vancouver style, author/editor names are supposed to be rendered in Latin
This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets
(read ASCII) characters.  When a name uses characters that contain diacritical
marks, those characters are to be converted to the corresponding Latin
character. When a name is written using a non-Latin alphabet or logogram, that
name is to be transliterated into Latin characters. The module doesn't do this
so editors may/must.
 
This test allows |first= and |last= names to contain any of the letters defined
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,006: Line 986:
[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/)
(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
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 outside of the code editor and pasted here because the code editor
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 Unicode characters so that it is not necessary to use an external editor
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,026: Line 1,002:
]]
]]


local function is_good_vanc_name (last, first, suffix, position)
local function is_good_vanc_name (last, first)
if not suffix then
local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it
if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix
 
first = first:match ('(.-)[,%s]+'); -- get name/initials
if is_set (suffix) then
suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix
end
end
if utilities.is_set (suffix) then
if not is_suffix (suffix) then
if not is_suffix (suffix) then
add_vanc_error (cfg.err_msg_supl.suffix, position);
add_vanc_error ('suffix');
return false; -- not a name with an appropriate suffix
return false; -- not a name with an appropriate suffix
end
end
end
end
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\225\184\128-\225\187\191%-%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\225\184\128-\225\187\191%-%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 (cfg.err_msg_supl['non-Latin char'], position);
add_vanc_error ('non-Latin character');
return false; -- not a string of Latin characters; Vancouver requires Romanization
return false; -- not a string of latin characters; Vancouver requires Romanization
end;
end;
return true;
return true;
end
end


--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------


Attempts to convert names to initials in support of |name-list-style=vanc.   
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.) to be rendered
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 ().
Unicode Latin characters accepted by is_good_vanc_name ().


]]
]]


local function reduce_to_initials (first, position)
local function reduce_to_initials(first)
if first:find (',', 1, true) then
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
return first; -- commas not allowed; abandon
end
 
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 initials?
name = mw.ustring.match(first, "^(%u+)$"); -- is it just intials?
end
end


Line 1,082: Line 1,045:
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 (cfg.err_msg_supl.suffix, position); -- one or two initials with invalid suffix so error message
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,091: Line 1,054:
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_t, names_t = {}, {}; -- tables to hold name parts and initials
 
local initials, names = {}, {}; -- tables to hold name parts and initials
local i = 1; -- counter for number of initials
local i = 1; -- counter for number of initials


names_t = mw.text.split (first, '[%s%-]+'); -- split into a sequence of names and possible suffix
names = mw.text.split (first, '[%s,]+'); -- split into a table of names and possible suffix


while names_t[i] do -- loop through the sequence
while names[i] do -- loop through the table
if 1 < i and names_t[i]:match ('[%dJS][%drndth]+%.?$') then -- if not the first name, and looks like a suffix (may have trailing dot)
if 1 < i and names[i]:match ('[%dJS][%drndth]+%.?$') then -- if not the first name, and looks like a suffix (may have trailing dot)
names_t[i] = names_t[i]:gsub ('%.', ''); -- remove terminal dot if present
names[i] = names[i]:gsub ('%.', ''); -- remove terminal dot if present
if is_suffix (names_t[i]) then -- if a legitimate suffix
if is_suffix (names[i]) then -- if a legitimate suffix
table.insert (initials_t, ' ' .. names_t[i]); -- add a separator space, insert at end of initials sequence
table.insert (initials, ' ' .. names[i]); -- add a separator space, insert at end of initials table
break; -- and done because suffix must fall at the end of a name
break; -- and done because suffix must fall at the end of a name
end -- no error message if not a suffix; possibly because of Romanization
end -- no error message if not a suffix; possibly because of Romanization
end
end
if 3 > i then
if 3 > i then
table.insert (initials_t, mw.ustring.sub (names_t[i], 1, 1)); -- insert the initial at end of initials sequence
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
return table.concat (initials_t); -- Vancouver format does not include spaces.
return table.concat(initials) -- Vancouver format does not include spaces.
end
 
 
--[[--------------------------< I N T E R W I K I _ P R E F I X E N _ G E T >----------------------------------
 
extract interwiki prefixen from <value>.  Returns two one or two values:
false – no prefixen
nil – prefix exists but not recognized
project prefix, language prefix – when value has either of:
:<project>:<language>:<article>
:<language>:<project>:<article>
project prefix, nil – when <value> has only a known single-letter prefix
nil, language prefix – when <value> has only a known language prefix
 
accepts single-letter project prefixen: 'd' (wikidata), 's' (wikisource), and 'w' (wikipedia) prefixes; at this
writing, the other single-letter prefixen (b (wikibook), c (commons), m (meta), n (wikinews), q (wikiquote), and
v (wikiversity)) are not supported.
 
]]
 
local function interwiki_prefixen_get (value, is_link)
if not value:find (':%l+:') then -- if no prefix
return false; -- abandon; boolean here to distinguish from nil fail returns later
end
 
local prefix_patterns_linked_t = { -- sequence of valid interwiki and inter project prefixen
'^%[%[:([dsw]):(%l%l+):', -- wikilinked; project and language prefixes
'^%[%[:(%l%l+):([dsw]):', -- wikilinked; language and project prefixes
'^%[%[:([dsw]):', -- wikilinked; project prefix
'^%[%[:(%l%l+):', -- wikilinked; language prefix
}
local prefix_patterns_unlinked_t = { -- sequence of valid interwiki and inter project prefixen
'^:([dsw]):(%l%l+):', -- project and language prefixes
'^:(%l%l+):([dsw]):', -- language and project prefixes
'^:([dsw]):', -- project prefix
'^:(%l%l+):', -- language prefix
}
local cap1, cap2;
for _, pattern in ipairs ((is_link and prefix_patterns_linked_t) or prefix_patterns_unlinked_t) do
cap1, cap2 = value:match (pattern);
if cap1 then
break; -- found a match so stop looking
end
end
if cap1 and cap2 then -- when both then :project:language: or :language:project: (both forms allowed)
if 1 == #cap1 then -- length == 1 then :project:language:
if cfg.inter_wiki_map[cap2] then -- is language prefix in the interwiki map?
return cap1, cap2; -- return interwiki project and interwiki language
end
else -- here when :language:project:
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
return cap2, cap1; -- return interwiki project and interwiki language
end
end
return nil; -- unknown interwiki language
elseif not (cap1 or cap2) then -- both are nil?
return nil; -- we got something that looks like a project prefix but isn't; return fail
elseif 1 == #cap1 then -- here when one capture
return cap1, nil; -- length is 1 so return project, nil language
else -- here when one capture and its length it more than 1
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
return nil, cap1; -- return nil project, language
end
end
end
end


--[[--------------------------< 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 (e.g. authors / editors)  
 
Formats a list of people (authors, contributors, editors, interviewers, translators)  
 
names in the list will be linked when
|<name>-link= has a value
|<name>-mask- does NOT have a value; masked names are presumed to have been
rendered previously so should have been linked there
 
when |<name>-mask=0, the associated name is not rendered


]]
]]


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 name_list = {};
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 names is a comma
sep = ','; -- name-list separator between authors is a comma
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
namesep = ' '; -- last/first separator is a space
elseif 'mla' == control.mode then
sep = ','; -- name-list separator between authors is a comma
namesep = ', ' -- last/first separator is <comma><space>
else
else
sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon
sep = ';' -- name-list separator between authors is a semicolon
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
namesep = ', ' -- 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 utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names
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 utilities.is_set (person.last) then
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 utilities.is_set (maximum) and i > maximum then
etal = true;
etal = true;
break;
break;
end
elseif (mask ~= nil) then
local n = tonumber(mask)
if mask then
if (n ~= nil) then
local n = tonumber (mask); -- convert to a number if it can be converted; nil else
one = string.rep("&mdash;",n)
if n then
else
one = 0 ~= n and string.rep("&mdash;", n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name
one = mask;
person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil
sep_one = " ";
else
one = mask; -- replace name with mask text (must include name-list separator)
sep_one = " "; -- modify name-list separator
end
end
else
else
one = person.last; -- get surname
one = person.last
local first = person.first -- get given name
local first = person.first
if utilities.is_set (first) then
if is_set(first) then
if ("vanc" == format) then -- if Vancouver format
if 'mla' == control.mode then
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if i == 1 then -- for mla
if not person.corporate and is_good_vanc_name (one, first, nil, i) then -- and name is all Latin characters; corporate authors not tested
one = one .. namesep .. first; -- first name last, first
first = reduce_to_initials (first, i); -- attempt to convert first name(s) to initials
else -- all other names
one = first .. ' ' .. one; -- first last
end
else
if ( "vanc" == format ) then -- if vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials
end
end
end
one = one .. namesep .. first;
end
end
one = one .. namesep .. first;
end
end
if utilities.is_set (person.link) then
one = utilities.make_wikilink (person.link, one); -- link author/editor
end
if one then -- if <one> has a value (name, mdash replacement, or mask text replacement)
local proj, tag = interwiki_prefixen_get (one, true); -- get the interwiki prefixen if present
if 'w' == proj and ('Wikipedia' == mw.site.namespaces.Project['name']) then
proj = nil; -- for stuff like :w:de:<article>, :w is unnecessary TODO: maint cat?
end
if proj then
local proj_name = ({['d'] = 'Wikidata', ['s'] = 'Wikisource', ['w'] = 'Wikipedia'})[proj]; -- :w (wikipedia) for linking from a non-wikipedia project
if proj_name then
one = one .. utilities.wrap_style ('interproj', proj_name); -- add resized leading space, brackets, static text, language name
utilities.add_prop_cat ('interproj-linked-name', proj); -- categorize it; <proj> is sort key
tag = nil; -- unset; don't do both project and language
end
end
if tag == cfg.this_wiki_code then
tag = nil; -- stuff like :en:<article> at en.wiki is pointless TODO: maint cat?
end
end
if tag then
if is_set(person.link) and person.link ~= control.page_name then
local lang = cfg.lang_tag_remap[tag] or cfg.mw_languages_by_tag_t[tag];
one = "[[" .. person.link .. "|" .. one .. "]]" -- link author/editor if this page is not the author's/editor's page
if lang then -- error messaging done in extract_names() where we know parameter names
one = one .. utilities.wrap_style ('interwiki', lang); -- add resized leading space, brackets, static text, language name
utilities.add_prop_cat ('interwiki-linked-name', tag); -- categorize it; <tag> is sort key
end
end
end
table.insert (name_list, one); -- add it to the list of names
table.insert (name_list, sep_one); -- add the proper name-list separator
end
end
table.insert( text, one )
table.insert( text, sep_one )
end
end
end
end


local count = #name_list / 2; -- (number of names + number of separators) divided by 2
local count = #text / 2; -- (number of names + number of separators) divided by 2
if 0 < count then  
if count > 0 then  
if 1 < count and not etal then
if count > 1 and is_set(lastauthoramp) and not etal then
if 'amp' == format then
if 'mla' == control.mode then
name_list[#name_list-2] = " & "; -- replace last separator with ampersand text
text[#text-2] = ", and "; -- replace last separator with ', and ' text
elseif 'and' == format then
else
if 2 == count then
text[#text-2] = " & "; -- replace last separator with ampersand text
name_list[#name_list-2] = cfg.presentation.sep_nl_and; -- replace last separator with 'and' text
else
name_list[#name_list-2] = cfg.presentation.sep_nl_end; -- replace last separator with '(sep) and' text
end
end
end
end
end
name_list[#name_list] = nil; -- erase the last separator
text[#text] = nil; -- erase the last separator
end
end
 
local result = table.concat (name_list); -- construct list
local result = table.concat(text) -- construct list
if etal and utilities.is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
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 got a last-first list and etal so add et al.
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 name-list string and count of number of names (count used for editor names only)
return result, count
end
end


--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------


--[[--------------------< M A K E _ C I T E R E F _ I D >-----------------------
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise 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 make_citeref_id (namelist, year)
local names={}; -- a table for the one to four names and year
local names={}; -- a table for the one to four names and year
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 -- loop through the list and take up to the first four last names
names[i] = v.last  
names[i] = v.last
if i == 4 then break end -- if four then done
if i == 4 then break end -- if four then done
end
end
table.insert (names, year); -- add the year at the end
table.insert (names, year); -- add the year at the end
local id = table.concat(names); -- concatenate names and year for CITEREF id
local id = table.concat(names); -- concatenate names and year for CITEREF id
if utilities.is_set (id) then -- if concatenation is not an empty string
if is_set (id) then -- if concatenation is not an empty string
return "CITEREF" .. id; -- add the CITEREF portion
return "CITEREF" .. id; -- add the CITEREF portion
else
else
return ''; -- return an empty string; no reason to include CITEREF id in this citation
return ''; -- return an empty string; no reason to include CITEREF id in this citation
end
end
end
end




--[[--------------------------< C I T E _ C L A S S _A T T R I B U T E _M A K E >------------------------------
--[[--------------------------< N A M E _ H A S _ E T A L >----------------------------------------------------


construct <cite> tag class attribute for this citation.
Evaluates the content of author and editor name parameters for variations on the theme of et al.  If found,
the et al. is removed, a flag is set to true and the function returns the modified name and the flag.


<cite_class> – config.CitationClass from calling template
This function never sets the flag to false but returns it's previous state because it may have been set by
<mode> – value from |mode= parameter
previous passes through this function or by the parameters |display-authors=etal or |display-editors=etal


]]
]]


local function cite_class_attribute_make (cite_class, mode)
local function name_has_etal (name, etal, nocat)
local class_t = {};
 
table.insert (class_t, 'citation'); -- required for blue highlight
if is_set (name) then -- name can be nil in which case just return
if 'citation' ~= cite_class then
local etal_pattern = "[;,]? *[\"']*%f[%a][Ee][Tt] *[Aa][Ll][%.\"']*$" -- variations on the 'et al' theme
table.insert (class_t, cite_class); -- identify this template for user css
local others_pattern = "[;,]? *%f[%a]and [Oo]thers"; -- and alternate to et al.
table.insert (class_t, utilities.is_set (mode) and mode or 'cs1'); -- identify the citation style for user css or javascript
else
if name:match (etal_pattern) then -- variants on et al.
table.insert (class_t, utilities.is_set (mode) and mode or 'cs2'); -- identify the citation style for user css or javascript
name = name:gsub (etal_pattern, ''); -- if found, remove
end
etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
for _, prop_key in ipairs (z.prop_keys_t) do
if not nocat then -- no categorization for |vauthors=
table.insert (class_t, prop_key); -- identify various properties for user css or javascript
add_maint_cat ('etal'); -- and add a category if not already added
end
elseif name:match (others_pattern) then -- if not 'et al.', then 'and others'?
name = name:gsub (others_pattern, ''); -- if found, remove
etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
if not nocat then -- no categorization for |vauthors=
add_maint_cat ('etal'); -- and add a category if not already added
end
end
end
end
 
return name, etal; --  
return table.concat (class_t, ' '); -- make a big string 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 _ E T A L >--------------------------
Evaluates the content of author and editor (surnames only) parameters for multiple names.  Multiple names are
 
indicated if there is more than one comma and or semicolon.  If found, the function adds the multiple name
Evaluates the content of name parameters (author, editor, etc.) for variations on
(author or editor) maintenance category.
the theme of et al.  If found, the et al. is removed, a flag is set to true and
the function returns the modified name and the flag.
 
This function never sets the flag to false but returns its previous state because
it may have been set by previous passes through this function or by the associated
|display-<names>=etal parameter


]]
]]


local function name_has_etal (name, etal, nocat, param)
local function name_has_mult_names (name, list_name)
 
local count, _;
if utilities.is_set (name) then -- name can be nil in which case just return
if is_set (name) then
local patterns = cfg.et_al_patterns; -- get patterns from configuration
if name:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, ignore
name = name:match ('^%(%((.*)%)%)$'); -- strip parens
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
else
if name:match (pattern) then -- if this 'et al' pattern is found in name
_, count = name:gsub ('[;,]', ''); -- count the number of separator-like characters
name = name:gsub (pattern, ''); -- remove the offending text
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
if 1 < count then -- param could be |author= or |editor= so one separactor character is acceptable
if not nocat then -- no categorization for |vauthors=
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
utilities.set_message ('err_etal', {param}); -- and set an error if not added
end
end
end
end
end
end
end
 
return name; -- and done
return name, etal;
end
end


--[[--------------------------< E X T R A C T _ N A M E S >----------------------------------------------------
Gets name list from the input arguments


--[[---------------------< N A M E _ I S _ N U M E R I C >----------------------
Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
find |last4= and |last5= then the search is done.


Add an error message and category when <name> parameter value does not contain letters.
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=
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.


Add a maintenance category when <name> parameter value has numeric characters mixed with characters that are
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
not numeric characters; could be letters and/or punctuation characters.
that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps 'et al.' out of the
template's metadata.  When this occurs, the page is added to a maintenance category.


This function will only emit one error and one maint message for the current template.  Does not emit both error
]]
and maint messages/categories for the same parameter value.


returns nothing
local function extract_names(args, list_name)
local names = {}; -- table of names
local last; -- individual name components
local first;
local link;
local mask;
local i = 1; -- loop counter/indexer
local n = 1; -- output table indexer
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; -- return value set to true when we find some form of et al. in an author parameter


]]
local err_msg_list_name = list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary
while true do
last = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1
first = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );


local function name_is_numeric (name, name_alias, list_name)
last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al.
local patterns = {
first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al.
'^%D+%d', -- <name> must have digits preceded by other characters
-- last = name_has_mult_names (last, err_msg_list_name); -- check for multiple names in last and its aliases
'^%D*%d+%D+', -- <name> must have digits followed by other characters
last = name_has_mult_names (last, list_name); -- check for multiple names in last and its aliases
}
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', {err_msg_list_name, i}, true ) } ); -- add this error message
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
if 2 <= count then -- two missing names and we give up
break; -- normal exit or there is a two-name hole in the list; can't tell which
end
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


if not added_numeric_name_errs and mw.ustring.match (name, '^[%A]+$') then -- if we have not already set an error message and <name> does not have any alpha characters
names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only)
utilities.set_message ('err_numeric_names', name_alias); -- add an error message
n = n + 1; -- point to next location in the names table
added_numeric_name_errs = true; -- set the flag so we emit only one error message
if 1 == count then -- if the previous name was missing
return; -- when here no point in further testing; abandon
table.insert( z.message_tail, { set_error( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
end
 
if not added_numeric_name_maint then -- if we have already set a maint message
for _, pattern in ipairs (patterns) do -- spin through list of patterns
if mw.ustring.match (name, pattern) then -- digits preceded or followed by anything but digits; %D+ includes punctuation
utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
added_numeric_name_maint = true; -- set the flag so we emit only one maint message
return; -- when here no point in further testing; abandon
end
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
end
i = i + 1; -- point to next args location
end
end
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 >------------------------------------------------


--[[-----------------< N A M E _ H A S _ M U L T _ N A M E S >------------------
Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code.


Evaluates the content of last/surname (authors etc.) parameters for multiple names.
Returns the language name and associated two- or three-character code.  Because case of the source may be incorrect
Multiple names are indicated if there is more than one comma or any "unescaped"
or different from the case that WikiMedia uses, the name comparisons are done in lower case and when a match is
semicolons. Escaped semicolons are ones used as part of selected HTML entities.
found, the Wikimedia version (assumed to be correct) is returned along with the code. When there is no match, we
If the condition is met, the function adds the multiple name maintenance category.
return the original language name string.


Same test for first except that commas should not appear in given names (MOS:JR says
mw.language.fetchLanguageNames(<local wiki language>, 'all') return a list of languages that in some cases may include
that the generational suffix does not take a separator character).  Titles, degrees,
extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support
postnominals, affiliations, all normally comma separated don't belong in a citation.
code 'cbk' or name 'Chavacano'.


<name> – name parameter value
Names but that are included in the list will be found if that name is provided in the |language= parameter.  For example,
<list_name> – AuthorList, EditorList, etc
if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'.  When names are found
<limit> – number of allowed commas; 1 (default) for surnames; 0 for given names
and the associated code is not two or three characters, this function returns only the Wikimedia language name.


returns nothing
Adapted from code taken from Module:Check ISO 639-1.


]]
]]


local function name_has_mult_names (name, list_name, limit)
local function get_iso639_code (lang, this_wiki_code)
local _, commas, semicolons, nbsps;
if 'bangla' == lang:lower() then -- special case related to Wikimedia remap of code 'bn' at mw:Extension:CLDR
limit = limit and limit or 1;
return 'Bengali', 'bn'; -- make sure rendered version is properly capitalized
if utilities.is_set (name) then
_, commas = name:gsub (',', ''); -- count the number of commas
_, semicolons = name:gsub (';', ''); -- count the number of semicolons
-- nbsps probably should be its own separate count rather than merged in
-- some way with semicolons because Lua patterns do not support the
-- grouping operator that regex does, which means there is no way to add
-- more entities to escape except by adding more counts with the new
-- entities
_, nbsps = name:gsub ('&nbsp;',''); -- count nbsps
-- There is exactly 1 semicolon per &nbsp; entity, so subtract nbsps
-- from semicolons to 'escape' them. If additional entities are added,
-- they also can be subtracted.
if limit < commas or 0 < (semicolons - nbsps) then
utilities.set_message ('maint_mult_names', cfg.special_case_translation [list_name]); -- add a maint message
end
end
end
end


 
local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
--[=[-------------------------< I S _ G E N E R I C >----------------------------------------------------------
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
 
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
Compares values assigned to various parameters according to the string provided as <item> in the function call.
<item> can have on of two values:
for code, name in pairs(languages) do -- scan the list to see if we can find our language
'generic_names' – for name-holding parameters: |last=, |first=, |editor-last=, etc
if langlc == mw.ustring.lower(name) then
'generic_titles' – for |title=
if 2 ~= code:len() and 3 ~= code:len() then -- two- or three-character codes only; extensions not supported
 
return name; -- so return the name but not the code
There are two types of generic tests. The 'accept' tests look for a pattern that should not be rejected by the
'reject' test. For example,
|author=[[John Smith (author)|Smith, John]]
would be rejected by the 'author' reject test.  But piped wikilinks with 'author' disambiguation should not be
rejected so the 'accept' test prevents that from happening.  Accept tests are always performed before reject
tests.
 
Each of the 'accept' and 'reject' sequence tables hold tables for en.wiki (['en']) and local.wiki (['local'])
that each can hold a test sequence table  The sequence table holds, at index [1], a test pattern, and, at index
[2], a boolean control value.  The control value tells string.find() or mw.ustring.find() to do plain-text search (true)
or a pattern search (false).  The intent of all this complexity is to make these searches as fast as possible so
that we don't run out of processing time on very large articles.
 
Returns
true when a reject test finds the pattern or string
false when an accept test finds the pattern or string
nil else
 
]=]
 
local function is_generic (item, value, wiki)
local test_val;
local str_lower = { -- use string.lower() for en.wiki (['en']) and use mw.ustring.lower() or local.wiki (['local'])
['en'] = string.lower,
['local'] = mw.ustring.lower,
}
local str_find = { -- use string.find() for en.wiki (['en']) and use mw.ustring.find() or local.wiki (['local'])
['en'] = string.find,
['local'] = mw.ustring.find,
}
 
local function test (val, test_t, wiki) -- local function to do the testing; <wiki> selects lower() and find() functions
val = test_t[2] and str_lower[wiki](value) or val; -- when <test_t[2]> set to 'true', plaintext search using lowercase value
return str_find[wiki] (val, test_t[1], 1, test_t[2]); -- return nil when not found or matched
end
local test_types_t = {'accept', 'reject'}; -- test accept patterns first, then reject patterns
local wikis_t = {'en', 'local'}; -- do tests for each of these keys; en.wiki first, local.wiki second
 
for _, test_type in ipairs (test_types_t) do -- for each test type
for _, generic_value in pairs (cfg.special_case_translation[item][test_type]) do -- spin through the list of generic value fragments to accept or reject
for _, wiki in ipairs (wikis_t) do
if generic_value[wiki] then
if test (value, generic_value[wiki], wiki) then -- go do the test
return ('reject' == test_type); -- param value rejected, return true; false else
end
end
end
end
return name, code; -- found it, return name to ensure proper capitalization and the the code
end
end
end
end
return lang; -- not valid language; return language in original case and nil for the code
end
end


--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------


--[[--------------------------< N A M E _ I S _ G E N E R I C >------------------------------------------------
Gets language name from a provided two- or three-character ISO 639 code.  If a code is recognized by MediaWiki,
use the returned name; if not, then use the value that was provided with the language parameter.


calls is_generic() to determine if <name> is a 'generic name' listed in cfg.generic_names; <name_alias> is the
When |language= contains a recognized language (either code or name), the page is assigned to the category for
parameter name used in error messaging
that code: Category:Norwegian-language sources (no).  For valid three-character code languages, the page is assigned
to the single category 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 not recognize three-character
equivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not.


local function name_is_generic (name, name_alias)
This function supports multiple languages in the form |language=nb, French, th where the language names or codes are
if not added_generic_name_errs  and is_generic ('generic_names', name) then
separated from each other by commas.
utilities.set_message ('err_generic_name', name_alias); -- set an error message
added_generic_name_errs = true;
end
end


]]


--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------
local function language_parameter (lang)
 
local code; -- the two- or three-character language code
This function calls various name checking functions used to validate the content of the various name-holding parameters.
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
local names_table = {}; -- table made from the value assigned to |language=


]]
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


local function name_checks (last, first, list_name, last_alias, first_alias)
names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
local accept_name;


if utilities.is_set (last) then
for _, lang in ipairs (names_table) do -- reuse lang
last, accept_name = utilities.has_accept_as_written (last); -- remove accept-this-as-written markup when it wraps all of <last>


if not accept_name then -- <last> not wrapped in accept-as-written markup
if lang:match ('^%a%a%-') then -- strip ietf language tags from code; TODO: is there a need to support 3-char with tag?
name_has_mult_names (last, list_name); -- check for multiple names in the parameter
lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
name_is_numeric (last, last_alias, list_name); -- check for names that have no letters or are a mix of digits and other characters
name_is_generic (last, last_alias); -- check for names found in the generic names list
end
end
end
if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code
 
name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code
if utilities.is_set (first) then
first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first>
 
if not accept_name then -- <first> not wrapped in accept-as-written markup
name_has_mult_names (first, list_name, 0); -- check for multiple names in the parameter; 0 is number of allowed commas in a given name
name_is_numeric (first, first_alias, list_name); -- check for names that have no letters or are a mix of digits and other characters
name_is_generic (first, first_alias); -- check for names found in the generic names list
end
end
local wl_type, D = utilities.is_wikilink (first);
if 0 ~= wl_type then
if is_set (name) then -- if |language= specified a valid code
first = D;
code = lang:lower(); -- save it
utilities.set_message ('err_bad_paramlink', first_alias);
else
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
end
 
if is_set (code) then -- only 2- or 3-character codes
return last, first; -- done
if 'bn' == code then name = 'Bengali' end; -- override wikimedia when code is 'bn'
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
add_prop_cat ('foreign_lang_source', {name, code}) -- categorize it
else -- or is a recognized language (but has a three-character code)
add_prop_cat ('foreign_lang_source_2', {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
end
end
else
add_maint_cat ('unknown_lang'); -- add maint category if not already added
end
table.insert (language_list, name);
name = ''; -- so we can reuse it
end
code = #language_list -- reuse code as number of languages in the list
if 2 >= code then
name = table.concat (language_list, ' and ') -- insert '<space>and<space>' between two language names
elseif 2 < code then
language_list[code] = 'and ' .. language_list[code]; -- prepend last name with 'and<space>'
name = table.concat (language_list, ', ') -- and concatenate with '<comma><space>' separators
end
if this_wiki_name == name then
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
end
return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)'
--[[ TODO: should only return blank or name rather than full list
so we can clean up the bunched parenthetical elements Language, Type, Format
]]
end
end


--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------


--[[----------------------< E X T R A C T _ N A M E S >-------------------------
Set style settings for CS1 citation templates. Returns separator and postscript settings


Gets name list from the input arguments
]]


Searches through args in sequential order to find |lastn= and |firstn= parameters
local function set_cs1_style (ps)
(or their aliases), and their matching link and mask parameters. Stops searching
if not is_set (ps) then -- unless explicitely set to something
when both |lastn= and |firstn= are not found in args after two sequential attempts:
ps = '.'; -- terminate the rendered citation with a period
found |last1=, |last2=, and |last3= but doesn't find |last4= and |last5= then the
end
search is done.
return '.', ps; -- separator is a full stop
end


This function emits an error message when there is a |firstn= without a matching
--[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------
|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=.


When an author or editor parameter contains some form of 'et al.', the 'et al.'
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
is stripped from the parameter and a flag (etal) returned that will cause list_people()
to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps
'et al.' out of the template's metadata.  When this occurs, an error is emitted.


]]
]]


local function extract_names(args, list_name)
local function set_cs2_style (ps, ref)
local names = {}; -- table of names
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
local last; -- individual name components
ps = ''; -- make sure it isn't nil
local first;
end
local link;
if not is_set (ref) then -- if |ref= is not set
local mask;
ref = "harv"; -- set default |ref=harv
local i = 1; -- loop counter/indexer
end
local n = 1; -- output table indexer
return ',', ps, ref; -- separator is a comma
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)
end
local etal = false; -- return value set to true when we find some form of et al. in an author parameter
 
--[[--------------------------< 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.


local last_alias, first_alias, link_alias; -- selected parameter aliases used in error messaging
]]
while true do
 
last, last_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'err_redundant_parameters', i ); -- search through args for name components beginning at 1
local function get_settings_from_cite_class (ps, ref, cite_class)
first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i );
local sep;
link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i );
if (cite_class == "citation") then -- for citation templates (CS2)
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
sep, ps, ref = set_cs2_style (ps, ref);
else -- not a citation template so CS1
if last then -- error check |lastn= alias for unknown interwiki link prefix; done here because this is where we have the parameter name
sep, ps = set_cs1_style (ps);
local project, language = interwiki_prefixen_get (last, true); -- true because we expect interwiki links in |lastn= to be wikilinked
end
if nil == project and nil == language then -- when both are nil
 
utilities.set_message ('err_bad_paramlink', last_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
return sep, ps, ref -- return them all
last = utilities.remove_wiki_link (last); -- remove wikilink markup; show display value only
end
end
 
end
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
if link then -- error check |linkn= alias for unknown interwiki link prefix
local project, language = interwiki_prefixen_get (link, false); -- false because wiki links in |author-linkn= is an error
if nil == project and nil == language then -- when both are nil
utilities.set_message ('err_bad_paramlink', link_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
link = nil; -- unset so we don't link
link_alias = nil;
end
end
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.
last, first = name_checks (last, first, list_name, last_alias, first_alias); -- multiple names, extraneous annotation, etc. checks


if first and not last then -- if there is a firstn without a matching lastn
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias
config.CitationClass from the template's #invoke: to establish style.
utilities.set_message ('err_first_missing_last', {
first_alias, -- param name of alias missing its mate
first_alias:gsub (alias, {['first'] = 'last', ['given'] = 'surname'}), -- make param name appropriate to the alias form
}); -- add this error message
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
if 2 <= count then -- two missing names and we give up
break; -- normal exit or there is a two-name hole in the list; can't tell which
end
else -- we have last with or without a first
local result;
link = link_title_ok (link, link_alias, last, last_alias); -- check for improper wiki-markup


if first then
]]
link = link_title_ok (link, link_alias, first, first_alias); -- check for improper wiki-markup
end


names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only)
local function set_style (mode, ps, ref, cite_class)
n = n + 1; -- point to next location in the names table
local sep;
if 1 == count then -- if the previous name was missing
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
utilities.set_message ('err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}); -- add this error message
sep, ps, ref = set_cs2_style (ps, ref);
end
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
count = 0; -- reset the counter, we're looking for two consecutive missing names
sep, ps = set_cs1_style (ps);
end
elseif 'mla' == mode then -- if this template is to be rendered in mla style use cs1 for bot cs1 & cs2 templates
i = i + 1; -- point to next args location
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 names, etal; -- all done, return our list of names and the etal flag
return sep, ps, ref
end
end


--[=[-------------------------< I S _ P D F >------------------------------------------------------------------


--[[--------------------------< N A M E _ T A G _ G E T >------------------------------------------------------
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.


attempt to decode |language=<lang_param> and return language name and matching tag; nil else.
returns true if file extension is one of the recognized extension, else false


This function looks for:
]=]
<lang_param> as a tag in cfg.lang_tag_remap{}
<lang_param> as a name in cfg.lang_name_remap{}
<lang_param> as a name in cfg.mw_languages_by_name_t
<lang_param> as a tag in cfg.mw_languages_by_tag_t
when those fail, presume that <lang_param> is an IETF-like tag that MediaWiki does not recognize.  Strip all
script, region, variant, whatever subtags from <lang_param> to leave just a two or three character language tag
and look for the new <lang_param> in cfg.mw_languages_by_tag_t{}


on success, returns name (in properly capitalized form) and matching tag (in lowercase); on failure returns nil
local function is_pdf (url)
return url:match ('%.pdf[%?#]?') or url:match ('%.PDF[%?#]?');
end


]]
--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------


local function name_tag_get (lang_param)
Applies css style to |format=, |chapter-format=, etc.  Also emits an error message if the format parameter does
local lang_param_lc = mw.ustring.lower (lang_param); -- use lowercase as an index into the various tables
not have a matching url parameter. If the format parameter is not set and the url contains a file extension that
local name;
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
local tag;
the appropriate styling.


name = cfg.lang_tag_remap[lang_param_lc]; -- assume <lang_param_lc> is a tag; attempt to get remapped language name
]]
if name then -- when <name>, <lang_param> is a tag for a remapped language name
if cfg.lang_name_remap[name:lower()][2] ~= lang_param_lc then
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
return name, cfg.lang_name_remap[name:lower()][2]; -- so return name and tag from lang_name_remap[name]; special case to xlate sr-ec and sr-el to sr-cyrl and sr-latn
end
return name, lang_param_lc; -- so return <name> from remap and <lang_param_lc>
end


tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- still assuming that <lang_param_lc> is a tag; strip script, region, variant subtags
local function style_format (format, url, fmt_param, url_param)
name = cfg.lang_tag_remap[tag]; -- attempt to get remapped language name with language subtag only
if is_set (format) then
if name then -- when <name>, <tag> is a tag for a remapped language name
format = wrap_style ('format', format); -- add leading space, parenthases, resize
return name, tag; -- so return <name> from remap and <tag>
if not is_set (url) then
end
format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message
 
if cfg.lang_name_remap[lang_param_lc] then -- not a remapped tag, assume <lang_param_lc> is a name; attempt to get remapped language tag
return cfg.lang_name_remap[lang_param_lc][1], cfg.lang_name_remap[lang_param_lc][2]; -- for this <lang_param_lc>, return a (possibly) new name and appropriate tag
end
 
name = cfg.mw_languages_by_tag_t[lang_param_lc]; -- assume that <lang_param_lc> is a tag; attempt to get its matching language name
if name then
return name, lang_param_lc; -- <lang_param_lc> is a tag so return it and <name>
end
tag = cfg.mw_languages_by_name_t[lang_param_lc]; -- assume that <lang_param_lc> is a language name; attempt to get its matching tag
if tag then
return cfg.mw_languages_by_tag_t[tag], tag; -- <lang_param_lc> is a name so return the name from the table and <tag>
end
 
tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- is <lang_param_lc> an IETF-like tag that MediaWiki doesn't recognize? <tag> gets the language subtag; nil else
 
if tag then
name = cfg.mw_languages_by_tag_t[tag]; -- attempt to get a language name using the shortened <tag>
if name then
return name, tag; -- <lang_param_lc> is an unrecognized IETF-like tag so return <name> and language subtag
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 _ A U T H O R S _ E D I T O R S >------------------------


--[[-------------------< L A N G U A G E _ P A R A M E T E R >------------------
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.


Gets language name from a provided two- or three-character ISO 639 code.  If a code
When the value assigned to |display-xxxxors= is a number greater than or equal to zero, return the number and
is recognized by MediaWiki, use the returned name; if not, then use the value that
the previous state of the 'etal' flag (false by default but may have been set to true if the name list contains
was provided with the language parameter.
some variant of the text 'et al.').


When |language= contains a recognized language (either code or name), the page is
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number that is one greater than the
assigned to the category for that code: Category:Norwegian-language sources (no).
number of authors in the list and set the 'etal' flag true.  This will cause the list_people() to display all of
For valid three-character code languages, the page is assigned to the single category
the names in the name list followed by 'et al.'
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
In all other cases, returns nil and the previous state of the 'etal' flag.
not recognize three-character equivalents of two-character codes: code 'ar' is
recognized but code 'ara' is not.


This function supports multiple languages in the form |language=nb, French, th
inputs:
where the language names or codes are separated from each other by commas with
max: A['DisplayAuthors'] or A['DisplayEditors']; a number or some flavor of etal
optional space characters.
count: #a or #e
list_name: 'authors' or 'editors'
etal: author_etal or editor_etal


]]
]]


local function language_parameter (lang)
local function get_display_authors_editors (max, count, list_name, etal)
local tag; -- some form of IETF-like language tag; language subtag with optional region, sript, vatiant, etc subtags
if is_set (max) then
local lang_subtag; -- ve populates |language= with mostly unecessary region subtags the MediaWiki does not recognize; this is the base language subtag
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
local name; -- the language name
max = count + 1; -- number of authors + 1 so display all author name plus et al.
local language_list = {}; -- table of language names to be rendered
etal = true; -- overrides value set by extract_names()
local names_t = {}; -- table made from the value assigned to |language=
elseif max:match ('^%d+$') then -- if is a string of numbers
 
max = tonumber (max); -- make it a number
local this_wiki_name = mw.language.fetchLanguageName (cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
 
add_maint_cat ('disp_auth_ed', cfg.special_case_translation [list_name]);
names_t = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
 
for _, lang in ipairs (names_t) do -- reuse lang here because we don't yet know if lang is a language name or a language tag
name, tag = name_tag_get (lang); -- attempt to get name/tag pair for <lang>; <name> has proper capitalization; <tag> is lowercase
 
if utilities.is_set (tag) then
lang_subtag = tag:gsub ('^(%a%a%a?)%-.*', '%1'); -- for categorization, strip any IETF-like tags from language tag
 
if cfg.this_wiki_code ~= lang_subtag then -- when the language is not the same as this wiki's language
if 2 == lang_subtag:len() then -- and is a two-character tag
utilities.add_prop_cat ('foreign-lang-source', {name, tag}, lang_subtag); -- categorize it; tag appended to allow for multiple language categorization
else -- or is a recognized language (but has a three-character tag)
utilities.add_prop_cat ('foreign-lang-source-2', {lang_subtag}, lang_subtag); -- categorize it differently TODO: support multiple three-character tag categories per cs1|2 template?
end
elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
utilities.add_prop_cat ('local-lang-source', {name, lang_subtag}); -- categorize it
end
end
else
else -- not a valid keyword or number
name = lang; -- return whatever <lang> has so that we show something
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
max = nil; -- unset; as if |display-xxxxors= had not been set
end
end
table.insert (language_list, name);
name = ''; -- so we can reuse it
end
end
name = utilities.make_sep_list (#language_list, language_list);
return max, etal;
if (1 == #language_list) and (lang_subtag == cfg.this_wiki_code) then -- when only one language, find lang name in this wiki lang name; for |language=en-us, 'English' in 'American English'
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
end
return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)'
--[[ TODO: should only return blank or name rather than full list
so we can clean up the bunched parenthetical elements Language, Type, Format
]]
end
end


--[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------


--[[-----------------------< S E T _ C S _ S T Y L E >--------------------------
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.


Gets the default CS style configuration for the given mode.
check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value:
Returns default separator and either postscript as passed in or the default.
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
In CS1, the default postscript and separator are '.'.
bad pattern: '^[Pp][Pp]' matches matches when |page(s)= begins pp or pP or Pp or PP
In CS2, the default postscript is the empty string and the default separator is ','.


]]
]]


local function set_cs_style (postscript, mode)
local function extra_text_in_page_check (page)
if utilities.is_set(postscript) then
-- local good_pattern = '^P[^%.P%l]';
-- emit a maintenance message if user postscript is the default cs1 postscript
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?
-- we catch the opposite case for cs2 in set_style
-- local bad_pattern = '^[Pp][Pp]';
if mode == 'cs1' and postscript == cfg.presentation['ps_' .. mode] then
local bad_pattern = '^[Pp]?[Pp]%.?[ %d]';
utilities.set_message ('maint_postscript');
 
end
if not page:match (good_pattern) and (page:match (bad_pattern) or  page:match ('^[Pp]ages?')) then
else
add_maint_cat ('extra_text');
postscript = cfg.presentation['ps_' .. mode];
end
end
return cfg.presentation['sep_' .. mode], postscript;
-- if Page:match ('^[Pp]?[Pp]%.?[ %d]') or  Page:match ('^[Pp]ages?[ %d]') or
-- Pages:match ('^[Pp]?[Pp]%.?[ %d]') or  Pages:match ('^[Pp]ages?[ %d]') then
-- add_maint_cat ('extra_text');
-- end
end
end


--[[--------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
split apart a |vautthors= 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.


--[[--------------------------< S E T _ S T Y L E >-----------------------------
|vauthors=Jones AB, White EB, ((Black, Brown, and Co.))


Sets the separator and postscript styles. Checks the |mode= first and the
This code is experimental and may not be retained.
#invoke CitationClass second. Removes the postscript if postscript == none.


]]
]]
 
local function get_v_name_table (vparam, output_table)
local function set_style (mode, postscript, cite_class)
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas
local sep;
if 'cs2' == mode then
local i = 1;
sep, postscript = set_cs_style (postscript, 'cs2');
elseif 'cs1' == mode then
while name_table[i] do
sep, postscript = set_cs_style (postscript, 'cs1');
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parens
elseif 'citation' == cite_class then
local name = name_table[i];
sep, postscript = set_cs_style (postscript, 'cs2');
i=i+1; -- bump indexer to next segment
else
while name_table[i] do
sep, postscript = set_cs_style (postscript, 'cs1');
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
end
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens
 
break; -- and done reassembling so
if cfg.keywords_xlate[postscript:lower()] == 'none' then
end
-- emit a maintenance message if user postscript is the default cs2 postscript
i=i+1; -- bump indexer
-- we catch the opposite case for cs1 in set_cs_style
end
if 'cs2' == mode or ('cs1' ~= mode and 'citation' == cite_class) then -- {{citation |title=Title |mode=cs1 |postscript=none}} should not emit maint message
table.insert (output_table, name); -- and add corporate name to the output table
utilities.set_message ('maint_postscript');
else
table.insert (output_table, name_table[i]); -- add this name
end
end
postscript = '';
i = i+1;
end
end
return output_table;
return sep, postscript
end
end


--[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------


--[=[-------------------------< I S _ P D F >-----------------------------------
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.


Determines if a URL has the file extension that is one of the PDF file extensions
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
used by [[MediaWiki:Common.css]] when applying the PDF icon to external links.
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.


returns true if file extension is one of the recognized extensions, else false
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
 
]=]
 
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&#035') or url:match ('%.pdf&#035');
end
 
 
--[[--------------------------< S T Y L E _ F O R M A T >-----------------------


Applies CSS style to |format=, |chapter-format=, etc.  Also emits an error message
This function sets the vancouver error when a reqired comma is missing and when there is a space between an author's initials.
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 style_format (format, url, fmt_param, url_param)
local function parse_vauthors_veditors (args, vparam, list_name)
if utilities.is_set (format) then
local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn=
format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize
local v_name_table = {};
if not utilities.is_set (url) then
local etal = false; -- return value set to true when we find some form of et al. vauthors parameter
utilities.set_message ('err_format_missing_url', {fmt_param, url_param}); -- add an error message
local last, first, link, mask, suffix;
end
local corporate = false;
elseif is_pdf (url) then -- format is not set so if URL is a PDF file then
 
format = utilities.wrap_style ('format', 'PDF'); -- set format to PDF
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)
else
if vparam:find ('%[%[') or vparam:find ('%]%]') then -- no wikilinking vauthors names
format = ''; -- empty string for concatenation
add_vanc_error ('wikilink');
end
end
return format;
v_name_table = get_v_name_table (vparam, v_name_table); -- names are separated by commas
end


 
for i, v_name in ipairs(v_name_table) do
--[[---------------------< G E T _ D I S P L A Y _ N A M E S >------------------
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
Returns a number that defines the number of names displayed for author and editor
last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses
name lists and a Boolean flag to indicate when et al. should be appended to the name list.
corporate = true; -- flag used in list_people()
 
elseif string.find(v_name, "%s") then
When the value assigned to |display-xxxxors= is a number greater than or equal to zero,
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;  
return the number and the previous state of the 'etal' flag (false by default
add_vanc_error ('punctuation');
but may have been set to true if the name list contains some variant of the text 'et al.').
end
 
local lastfirstTable = {}
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number
lastfirstTable = mw.text.split(v_name, "%s")
that is one greater than the number of authors in the list and set the 'etal' flag true.
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials
This will cause the list_people() to display all of the names in the name list followed by 'et al.'
if is_suffix (first) then -- if a valid suffix
 
suffix = first -- save it as a suffix and
In all other cases, returns nil and the previous state of the 'etal' flag.
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?
inputs:
last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials
max: A['DisplayAuthors'] or A['DisplayEditors'], etc; a number or some flavor of etal
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
count: #a or #e
add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing
list_name: 'authors' or 'editors'
end
etal: author_etal or editor_etal
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
This function sets an error message when |display-xxxxors= value greater than or equal to number of names but
end
not when <max> comes from {{cs1 config}} global settings.  When using global settings, <param> is set to the
else
keyword 'cs1 config' which is used to supress the normal error.  Error is suppressed because it is to be expected
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
that some citations in an article will have the same or fewer names that the limit specified in {{cs1 config}}.
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
local function get_display_names (max, count, list_name, etal, param)
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
if utilities.is_set (max) then
add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
end
max = count + 1; -- number of authors + 1 so display all author name plus et al.
is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit
etal = true; -- overrides value set by extract_names()
if is_set (suffix) then
elseif max:match ('^%d+$') then -- if is a string of numbers
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
max = tonumber (max); -- make it a number
suffix = ''; -- unset so we don't add this suffix to all subsequent names
if (max >= count) and ('cs1 config' ~= param) then -- error when local |display-xxxxors= value greater than or equal to number of names; not an error when using global setting
end
utilities.set_message ('err_disp_name', {param, max}); -- add error message
else
max = nil;
if not corporate then
is_good_vanc_name (last, '');
end
end
else -- not a valid keyword or number
utilities.set_message ('err_disp_name', {param, max}); -- add error message
max = nil; -- unset; as if |display-xxxxors= had not been set
end
end
-- this from extract_names ()
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list
end
end
return names, etal; -- all done, return our list of names
return max, etal;
end
end




--[[----------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >---------------
--[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------------------


Adds error if |page=, |pages=, |quote-page=, |quote-pages= has what appears to be
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
some form of p. or pp. abbreviation in the first characters of the parameter content.
select one of |editors=, |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.


check page for extraneous p, p., pp, pp., pg, pg. at start of parameter value:
Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest and
good pattern: '^P[^%.P%l]' matches when page begins PX or P# but not Px
similarly, |editorn= (and aliases) highest and |editors= lowest
      where x and X are letters and # is a digit
bad pattern:  '^[Pp][PpGg]' matches when page begins pp, pP, Pp, PP, pg, pG, Pg, PG


]]
When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
test which mimicks the test used in extract_names() when looking for a hole in the author name list.  There may be a better
way to do this, I just haven't discovered what that way is.
 
Emits an error message when more than one xxxxor name source is provided.
 
In this function, vxxxxors = vauthors or veditors; xxxxors = authors or editors as appropriate.


local function extra_text_in_page_check (val, name)
]]
if not val:match (cfg.vol_iss_pg_patterns.good_ppattern) then
for _, pattern in ipairs (cfg.vol_iss_pg_patterns.bad_ppatterns) do -- spin through the selected sequence table of patterns
if val:match (pattern) then -- when a match, error so
utilities.set_message ('err_extra_text_pages', name); -- add error message
return; -- and done
end
end
end
end


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


--[[--------------------------< E X T R A _ T E X T _ I N _ V O L _ I S S _ C H E C K >------------------------
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


Adds error if |volume= or |issue= has what appears to be some form of redundant 'type' indicator.  Applies to
if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
both; this function looks for issue text in both |issue= and |volume= and looks for volume-like text in |voluem=
if is_set (vxxxxors) then return 2 end;
and |issue=.
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


For |volume=:
'V.', or 'Vol.' (with or without the dot) abbreviations or 'Volume' in the first characters of the parameter
content (all case insensitive). 'V' and 'v' (without the dot) are presumed to be roman numerals so
are allowed.


For |issue=:
--[[--------------------------< I S _ V A L I D _ P A R A M E T E R _ V A L U E >------------------------------
'No.', 'I.', 'Iss.' (with or without the dot) abbreviations, or 'Issue' in the first characters of the
parameter content (all case insensitive); numero styling: 'n°' with degree sign U+00B0, and № precomposed
numero sign U+2116.
Single character values ('v', 'i', 'n') allowed when not followed by separator character ('.', ':', '=', or
whitespace character) – param values are trimmed of whitespace by MediaWiki before delivered to the module.
<val> is |volume= or |issue= parameter value
<name> is |volume= or |issue= parameter name for error message
<selector> is 'v' for |volume=, 'i' for |issue=


sets error message on failure; returns nothing
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 refurns 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 extra_text_in_vol_iss_check (val, name, selector)
local function is_valid_parameter_value (value, name, possible, cite_class)
if not utilities.is_set (val) then
-- begin hack to limit |mode=mla to a specific set of templates
return;
if ('mode' == name) and ('mla' == value) and not in_array (cite_class, {'book', 'journal', 'news'}) then
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 hack
local handler = 'v' == selector and 'err_extra_text_volume' or 'err_extra_text_issue';
val = val:lower(); -- force parameter value to lower case


for _, pattern in ipairs (cfg.vol_iss_pg_patterns.vi_patterns_t) do -- spin through the sequence table of patterns
if not is_set (value) then
if val:match (pattern) then -- when a match, error so
return true; -- an empty parameter is ok
utilities.set_message (handler, name); -- add error message
elseif in_array(value:lower(), possible) then
return; -- and done
return true;
end
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




--[=[-------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------


split apart a |vauthors= or |veditors= parameter.  This function allows for corporate names, wrapped in doubled
This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
parentheses to also have commas; in the old version of the code, the doubled parentheses were included in the
when the last character is not a sepc character or when the last three characters are not sepc followed by two
rendered citation and in the metadata. Individual author names may be wikilinked
closing square brackets (close of a wikilink).  When either of these is true, the name_list is terminated with a
single space character.


|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.))
]]


]=]
local function terminate_name_list (name_list, sepc)
 
if (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char
local function get_v_name_table (vparam, output_table, output_link_table)
return name_list .. " "; -- don't add another
local _, accept = utilities.has_accept_as_written (vparam);
else
if accept then
return name_list .. sepc .. ' '; -- otherwise terninate the name list
utilities.add_prop_cat ('vanc-accept'); -- add properties category
end
end
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 placeholder
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 parentheses
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 parentheses
break; -- and done reassembling so
end
i = i + 1; -- bump indexer
end
table.insert (output_table, name); -- and add corporate name to the output table
table.insert (output_link_table, ''); -- no wikilink
else
wl_type, label, link = utilities.is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
table.insert (output_table, label); -- add this name
if 1 == wl_type then
table.insert (output_link_table, label); -- simple wikilink [[D]]
else
table.insert (output_link_table, link); -- no wikilink or [[L|D]]; add this link if there is one, else empty string
end
end
i = i + 1;
end
return output_table;
end
end




--[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------


This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and
returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
|xxxxor-linkn= in args.  It then returns a table of assembled names just as extract_names() does.
or formatted issue, or an empty string if neither are set.


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 parentheses ((corporate name)) to suppress the format tests.
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower, mode)
if not is_set (volume) and not is_set (issue) then
return '';
end
if ('mla' == mode) and ('journal' == cite_class) then -- same as cs1 for magazines
lower = true; -- mla 8th edition; force these to lower case
if is_set (volume) and is_set (issue) then
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
elseif is_set (volume) then
return wrap_msg ('vol', {sepc, volume}, lower);
else
return '';
end
end


Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then
if is_set (volume) and is_set (issue) then
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
elseif is_set (volume) then
return wrap_msg ('vol', {sepc, volume}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end


This function sets the Vancouver error when a required comma is missing and when there is a space between an author's initials.
local vol = '';
if is_set (volume) then
if (4 < mw.ustring.len(volume)) then
vol = substitute (cfg.messages['j-vol'], {sepc, volume});
else
vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)});
end
end
if is_set (issue) then
return vol .. substitute (cfg.messages['j-issue'], issue);
end
return vol;
end


]]


local function parse_vauthors_veditors (args, vparam, list_name)
--[[-------------------------< N O R M A L I Z E _ P A G E _ L I S T >-----------------------------------------
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)
not currently used
v_name_table = get_v_name_table (vparam, v_name_table, v_link_table); -- names are separated by commas


for i, v_name in ipairs(v_name_table) do
normalizes a comma, ampersand, and/or space separated list to be '<value>, <value>, ..., <value>'
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
returns list unchanged if there are no commas else strips whitespace and then reformats the list
local accept_name;
v_name, accept_name = utilities.has_accept_as_written (v_name); -- remove accept-this-as-written markup when it wraps all of <v_name>


if accept_name then
]]
last = v_name;
--[[
corporate = true; -- flag used in list_people()
local function normalize_page_list (list)
elseif string.find(v_name, "%s") then
if not list:find ('[,& ]') then return list end -- if list is not delimited with commas, ampersands, or spaces; done
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
add_vanc_error (cfg.err_msg_supl.punctuation, i);
list = mw.text.split (list, '[,&%s]+'); -- make a table of values
end
list = table.concat (list, ', '); -- and now make a normalized list
local lastfirstTable = {}
return list;
lastfirstTable = mw.text.split(v_name, "%s+")
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be initials or generational suffix
 
if not mw.ustring.match (first, '^%u+$') then -- mw.ustring here so that later we will catch non-Latin characters
suffix = first; -- not initials so assume that whatever we got is a generational suffix
first = table.remove(lastfirstTable); -- get what should be the initials from the table
end
last = table.concat(lastfirstTable, ' ') -- returns a string that is the concatenation of all other names that are not initials and generational suffix
if not utilities.is_set (last) then
first = ''; -- unset
last = v_name; -- last empty because something wrong with first
add_vanc_error (cfg.err_msg_supl.name, i);
end
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
add_vanc_error (cfg.err_msg_supl['missing comma'], i); -- 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 (cfg.err_msg_supl.initials, i); -- matches a space between two initials
end
else
last = v_name; -- last name or single corporate name?  Doesn't support multiword corporate names? do we need this?
end
if utilities.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 (cfg.err_msg_supl.initials, i); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
end
is_good_vanc_name (last, first, suffix, i); -- check first and last before restoring the suffix which may have a non-Latin digit
if utilities.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, '', nil, i);
end
end
 
link = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ) or v_link_table[i];
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_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 >------------------------
--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------


Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
adds static text to one of |page(s)= or |sheet(s)= values and returns it with all of the others set to empty strings.
select one of |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.
The return order is:
page, pages, sheet, sheets


Only one of these appropriate three will be used.  The hierarchy is: |authorn= (and aliases) highest and |authors= lowest;
Singular has priority over plural when both are provided.
|editorn= (and aliases) highest and |veditors= lowest (support for |editors= withdrawn)
 
When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
test which mimicks the test used in extract_names() when looking for a hole in the author name list.  There may be a better
way to do this, I just haven't discovered what that way is.
 
Emits an error message when more than one xxxxor name source is provided.
 
In this function, vxxxxors = vauthors or veditors; xxxxors = authors as appropriate.


]]
]]


local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower, mode)
local lastfirst = false;
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
if utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice in case we have a |first1= without a |last1=; this ...
if is_set (sheet) then
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
if 'journal' == origin then
utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
else
lastfirst = true;
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
end
end
 
elseif is_set (sheets) then
if (utilities.is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
if 'journal' == origin then
(utilities.is_set (vxxxxors) and utilities.is_set (xxxxors)) or
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
(true == lastfirst and utilities.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
else
err_name = 'editor';
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
end
end
utilities.set_message ('err_redundant_parameters', err_name .. '-name-list parameters'); -- add error message
end
end
end


if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'journal' == origin);
if utilities.is_set (vxxxxors) then return 2 end;
if utilities.is_set (xxxxors) then return 3 end;
if is_journal and 'mla' == mode then
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
is_journal = false; -- mla always uses p & pp
end
end


if is_set (page) then
if is_journal then
return substitute (cfg.messages['j-page(s)'], page), '', '', '';
elseif not nopp then
return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
else
return substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
end
elseif is_set(pages) then
if is_journal then
return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif not nopp then
return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
else
return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
end
end
return '', '', '', ''; -- return empty strings
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
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
of allowable values (yes, y, true, live, dead, etc.).  When the parameter value has not been assigned a value (missing
or empty in the source template) the function returns the value specified by ret_val.  If the parameter value is one
of the list of allowed values returns the translated value; else, emits an error message and returns the value
specified by ret_val.


TODO: explain <invert>
Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the
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 url.  That is something that Wikipedia should not allow
unwitting readers to do.


]]
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.


local function is_valid_parameter_value (value, name, possible, ret_val, invert)
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
if not utilities.is_set (value) then
|archive-date= and an error message when:
return ret_val; -- an empty parameter is ok
|archive-url= holds an archive.org save command url
end
|archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
correct place
otherwise returns |archive-url= and |archive-date=


if (not invert and utilities.in_array (value, possible)) then -- normal; <value> is in <possible> table
There are two mostly compatible archive.org urls:
return cfg.keywords_xlate[value]; -- return translation of parameter keyword
//web.archive.org/<timestamp>... -- the old form
elseif invert and not utilities.in_array (value, possible) then -- invert; <value> is not in <possible> table
//web.archive.org/web/<timestamp>... -- the new form
return value; -- return <value> as it is
else
utilities.set_message ('err_invalid_param_val', {name, value}); -- not an allowed value so add error message
return ret_val;
end
end


The old form does not support or map to the new form when it contains a display flag.  There are four identified flags
('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
we don't check for these specific flags but we do check the form.


--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------
This function supports a preview mode.  When the article is rendered in preview mode, this funct may return a modified
archive url:
for save command errors, return undated wildcard (/*/)
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*/)


This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
]=]
when the last character is not a sepc character or when the last three characters are not sepc followed by two
closing square brackets (close of a wikilink).  When either of these is true, the name_list is terminated with a
single space character.


]]
local function archive_url_check (url, date)
local err_msg = ''; -- start with the error message empty
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 url
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
end


local function terminate_name_list (name_list, sepc)
if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
if (string.sub (name_list, -3, -1) == sepc .. '. ') then -- if already properly terminated
err_msg = 'save command';
return name_list; -- just return the name list
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
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 url:match('//liveweb%.archive%.org/') then
return name_list .. " "; -- don't add another
err_msg = 'liveweb';
else
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation
if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = 'timestamp';
if '*' ~= flag then
url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
end
elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
err_msg = 'path';
elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
err_msg = 'flag';
elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
err_msg = 'flag';
else
return url, date; -- return archiveURL and ArchiveDate
end
end
-- if here, something not right so
table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and
if is_set (Frame:preprocess('{{REVISIONID}}')) then
return '', ''; -- return empty strings for archiveURL and ArchiveDate
else
else
return name_list .. sepc .. ' '; -- otherwise terminate the name list
return url, date; -- preview mode so return archiveURL and ArchiveDate
end
end
end
end




--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >-----------------------------------------
--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------
 
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
parameter that is missing its pipe:
{{cite ... |title=Title access-date=2016-03-17}}
 
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.


returns the concatenation of the formatted volume and issue (or journal article number) parameters as a single
If a missing pipe is detected, this function adds the missing pipe maintenance category.
string; or formatted volume or formatted issue, or an empty string if neither are set.


]]
]]
local function format_volume_issue (volume, issue, article, cite_class, origin, sepc, lower)
if not utilities.is_set (volume) and not utilities.is_set (issue) and not utilities.is_set (article) then
return '';
end


-- same condition as in format_pages_sheets()
local function missing_pipe_check (value)
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
local capture;
 
value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc
local is_numeric_vol = volume and (volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')); -- is only uppercase roman numerals or only digits?
local is_long_vol = volume and (4 < mw.ustring.len(volume)); -- is |volume= value longer than 4 characters?
if volume and (not is_numeric_vol and is_long_vol) then -- when not all digits or Roman numerals, is |volume= longer than 4 characters?
utilities.add_prop_cat ('long-vol'); -- yes, add properties cat
end
 
if is_journal then -- journal-style formatting
local vol = '';
 
if utilities.is_set (volume) then
if is_numeric_vol then -- |volume= value all digits or all uppercase Roman numerals?
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, volume}); -- render in bold face
elseif is_long_vol then -- not all digits or Roman numerals; longer than 4 characters?
vol = utilities.substitute (cfg.messages['j-vol'], {sepc, utilities.hyphen_to_dash (volume)}); -- not bold
else -- four or fewer characters
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, utilities.hyphen_to_dash (volume)}); -- bold
end
end
vol = vol .. (utilities.is_set (issue) and utilities.substitute (cfg.messages['j-issue'], issue) or '')
vol = vol .. (utilities.is_set (article) and utilities.substitute (cfg.messages['j-article-num'], article) or '')
return vol;
end
if 'podcast' == cite_class and utilities.is_set (issue) then
return wrap_msg ('issue', {sepc, issue}, lower);
end
if 'conference' == cite_class and utilities.is_set (article) then -- |article-number= supported only in journal and conference cites
if utilities.is_set (volume) and utilities.is_set (article) then -- both volume and article number
return wrap_msg ('vol-art', {sepc, utilities.hyphen_to_dash (volume), article}, lower);
elseif utilities.is_set (article) then -- article number alone; when volume alone, handled below
return wrap_msg ('art', {sepc, article}, lower);
end
end


-- all other types of citation
capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes
if utilities.is_set (volume) and utilities.is_set (issue) then
if capture and validate (capture) then -- if the capture is a valid parameter name
return wrap_msg ('vol-no', {sepc, utilities.hyphen_to_dash (volume), issue}, lower);
add_maint_cat ('missing_pipe');
elseif utilities.is_set (volume) then
return wrap_msg ('vol', {sepc, utilities.hyphen_to_dash (volume)}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end
end
end




--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------


adds static text to one of |page(s)= or |sheet(s)= values and returns it with all of the others set to empty strings.
This is the main function doing the majority of the citation formatting.
The return order is:
page, pages, sheet, sheets
 
Singular has priority over plural when both are provided.


]]
]]


local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
local function citation0( config, args)
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
--[[
if utilities.is_set (sheet) then
Load Input Parameters
if 'journal' == origin then
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
]]
else
local A = argument_wrapper( args );
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
local i
end
 
elseif utilities.is_set (sheets) then
-- Pick out the relevant fields from the arguments.  Different citation templates
if 'journal' == origin then
-- define different field names for the same underlying things.
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
 
else
-- set default parameter values defined by |mode= parameter.  If |mode= is empty or omitted, use CitationClass to set these values
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
local Mode = A['Mode'];
if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode'], config.CitationClass) 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
end
if is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end
end
end


local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
local Coauthors = A['Coauthors'];
local Others = A['Others'];
if utilities.is_set (page) then
 
if is_journal then
local editor_etal;
return utilities.substitute (cfg.messages['j-page(s)'], page), '', '', '';
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
elseif not nopp then
local Editors;
return utilities.substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
 
else
do -- to limit scope of selected
return utilities.substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
end
if 1 == selected then
elseif utilities.is_set (pages) then
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
if is_journal then
elseif 2 == selected then
return utilities.substitute (cfg.messages['j-page(s)'], pages), '', '', '';
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
return '', utilities.substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif 3 == selected then
elseif not nopp then
Editors = A['Editors']; -- use content of |editors=
return '', utilities.substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged
else
return '', utilities.substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
end
end
end
end
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=
return '', '', '', ''; -- return empty strings
end


local interviewers_list = {};
local Interviewers = A['Interviewers']
if is_set (Interviewers) then -- add a maint cat if the |interviewers= is used
add_maint_cat ('interviewers'); -- because use of this parameter is discouraged
else
interviewers_list = extract_names (args, 'InterviewerList'); -- else, process preferred interviewers parameters
end


--[[--------------------------< I N S O U R C E _ L O C _ G E T >----------------------------------------------
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
 
local Contributors; -- assembled contributors name list
returns one of the in-source locators: page, pages, or at.
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
If any of these are interwiki links to Wikisource, returns the label portion of the interwiki-link as plain text
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
for use in COinS.  This COinS thing is done because here we convert an interwiki-link to an external link and
add an icon span around that; get_coins_pages() doesn't know about the span.  TODO: should it? 
if 0 < #c then
 
if not is_set (Contribution) then -- |contributor= requires |contribution=
TODO: add support for sheet and sheets?; streamline;
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
TODO: make it so that this function returns only one of the three as the single in-source (the return value assigned
end
to a new name)?
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
local function insource_loc_get (page, page_orig, pages, pages_orig, at)
local ws_url, ws_label, coins_pages, L; -- for Wikisource interwiki-links; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
 
if utilities.is_set (page) then
if utilities.is_set (pages) or utilities.is_set (at) then
pages = ''; -- unset the others
at = '';
end
end
extra_text_in_page_check (page, page_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
else -- if not a book cite
 
if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label
table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message
if ws_url then
page = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
page = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
coins_pages = ws_label;
end
elseif utilities.is_set (pages) then
if utilities.is_set (at) then
at = ''; -- unset
end
extra_text_in_page_check (pages, pages_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
 
ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label
if ws_url then
pages = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
pages = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
coins_pages = ws_label;
end
elseif utilities.is_set (at) then
ws_url, ws_label, L = wikisource_url_make (at); -- make ws URL from |at= interwiki link; link portion L becomes tooltip label
if ws_url then
at = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
at = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
coins_pages = ws_label;
end
end
Contribution = nil; -- unset
end
end
return page, pages, at, coins_pages;
end
--[[--------------------------< I S _ U N I Q U E _ A R C H I V E _ U R L >------------------------------------
add error message when |archive-url= value is same as |url= or chapter-url= (or alias...) value
]]


local function is_unique_archive_url (archive, url, c_url, source, date)
if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc'
if utilities.is_set (archive) then
NameListFormat = ''; -- anything else, set to empty string
if archive == url or archive == c_url then
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)}); -- add error message
return '', ''; -- unset |archive-url= and |archive-date= because same as |url= or |chapter-url=
end
end
end


return archive, date;
local Year = A['Year'];
end
local PublicationDate = A['PublicationDate'];
 
local OrigYear = A['OrigYear'];
local Date = A['Date'];
local LayDate = A['LayDate'];
------------------------------------------------- Get title data
local Title = A['Title'];
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


--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
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'];


Check archive.org URLs to make sure they at least look like they are pointing at valid archives and not to the
local ArchiveDate;
save snapshot URL or to calendar pages.  When the archive URL is 'https://web.archive.org/save/' (or http://...)
local ArchiveURL;
archive.org saves a snapshot of the target page in the URL.  That is something that Wikipedia should not allow
unwitting readers to do.


When the archive.org URL does not have a complete timestamp, archive.org chooses a snapshot according to its own
ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
algorithm or provides a calendar 'search' result.  [[WP:ELNO]] discourages links to search results.
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


This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
local URL = A['URL']
|archive-date= and an error message when:
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
|archive-url= holds an archive.org save command URL
local ChapterURL = A['ChapterURL'];
|archive-url= is an archive.org URL that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
correct place
local ConferenceFormat = A['ConferenceFormat'];
otherwise returns |archive-url= and |archive-date=
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


There are two mostly compatible archive.org URLs:
local Series = A['Series'];
//web.archive.org/<timestamp>... -- the old form
//web.archive.org/web/<timestamp>... -- the new form
local Volume;
 
local Issue;
The old form does not support or map to the new form when it contains a display flag. There are four identified flags
local Page;
('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
local Pages;
we don't check for these specific flags but we do check the form.
local At;
-- previously conference books did not support volume
-- if in_array (config.CitationClass, cfg.templates_using_volume) and not ('conference' == config.CitationClass and not is_set (Periodical)) then
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 = A['Issue'];
end
local Position = '';
if not in_array (config.CitationClass, cfg.templates_not_using_page) then
Page = A['Page'];
Pages = hyphen_to_dash( A['Pages'] );
At = A['At'];
end


This function supports a preview mode. When the article is rendered in preview mode, this function may return a modified
local Edition = A['Edition'];
archive URL:
local PublicationPlace = A['PublicationPlace']
for save command errors, return undated wildcard (/*/)
local Place = A['Place'];
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*/)
local PublisherName = A['PublisherName'];
local RegistrationRequired = A['RegistrationRequired'];
if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then
RegistrationRequired=nil;
end
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 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


A secondary function is to return an archive-url timestamp from those urls that have them (archive.org and
if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set
archive.today). The timestamp is used by validation.archive_date_check() to see if the value in |archive-date=
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message
matches the timestamp in the archive url.
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 function archive_url_check (url, date)
local Via = A['Via'];
local err_msg = ''; -- start with the error message empty
local AccessDate = A['AccessDate'];
local path, timestamp, flag; -- portions of the archive.org URL
local Agency = A['Agency'];
timestamp = url:match ('//archive.today/(%d%d%d%d%d%d%d%d%d%d%d%d%d%d)/') or -- get timestamp from archive.today urls
url:match ('//archive.today/(%d%d%d%d%.%d%d%.%d%d%-%d%d%d%d%d%d)/'); -- this timestamp needs cleanup
if timestamp then -- if this was an archive.today url ...
return url, date, timestamp:gsub ('[%.%-]', ''); -- return ArchiveURL, ArchiveDate, and timestamp (dots and dashes removed) from |archive-url=, and done
end
-- here for archive.org urls
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
end


if url:match('//web%.archive%.org/save/') then -- if a save command URL, we don't want to allow saving of the target page
local Language = A['Language'];
err_msg = cfg.err_msg_supl.save;
local Format = A['Format'];
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
local ChapterFormat = A['ChapterFormat'];
elseif url:match('//liveweb%.archive%.org/') then
local DoiBroken = A['DoiBroken'];
err_msg = cfg.err_msg_supl.liveweb;
local ID = A['ID'];
else
local ASINTLD = A['ASINTLD'];
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation
local IgnoreISBN = A['IgnoreISBN'];
if not path then -- malformed in some way; pattern did not match
if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then
err_msg = cfg.err_msg_supl.timestamp;
IgnoreISBN = nil; -- anything else, set to empty string
elseif 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = cfg.err_msg_supl.timestamp;
if '*' ~= flag then
local replacement = timestamp:match ('^%d%d%d%d%d%d') or timestamp:match ('^%d%d%d%d'); -- get the first 6 (YYYYMM) or first 4 digits (YYYY)
if replacement then -- nil if there aren't at least 4 digits (year)
replacement = replacement .. string.rep ('0', 14 - replacement:len()); -- year or yearmo (4 or 6 digits) zero-fill to make 14-digit timestamp
url=url:gsub ('(//web%.archive%.org/[^%d]*)%d[^/]*', '%1' .. replacement .. '*', 1) -- for preview, modify ts to 14 digits plus splat for calendar display
end
end
elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element
err_msg = cfg.err_msg_supl.path;
elseif utilities.is_set (flag) and not utilities.is_set (path) then -- flag not allowed with the old form URL (without the 'web/' path element)
err_msg = cfg.err_msg_supl.flag;
elseif utilities.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 = cfg.err_msg_supl.flag;
else
return url, date, timestamp; -- return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
end
end
end
local Embargo = A['Embargo'];
-- if here, something not right so
local Class = A['Class']; -- arxiv class identifier
utilities.set_message ('err_archive_url', {err_msg}); -- add error message and
 
local ID_list = extract_ids( args );
local ID_access_levels = extract_id_access_levels( args, ID_list );


if is_preview_mode then
local Quote = A['Quote'];
return url, date, timestamp; -- preview mode so return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
else
return '', ''; -- return empty strings for ArchiveURL and ArchiveDate
end
end


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


--[[--------------------------< P L A C E _ C H E C K >--------------------------------------------------------
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
if 'mla' == Mode then
LastAuthorAmp = 'yes'; -- replaces last author/editor separator with ' and ' text
end
local no_tracking_cats = A['NoTracking'];
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


check |place=, |publication-place=, |location= to see if these params include digits. This function added because
--local variables that are not cs1 parameters
many editors misuse location to specify the in-source location (|page(s)= and |at= are supposed to do that)
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


returns the original parameter value without modification; added maint cat when parameter value contains digits
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


]]
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


local function place_check (param_val)
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
if not utilities.is_set (param_val) then -- parameter empty or omitted
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
return param_val; -- return that empty state
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
end
no_tracking_cats = "true"; -- set no_tracking_cats
end
if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
utilities.set_message ('maint_location'); -- yep, add maint cat
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
end
return param_val; -- and done
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


--[[--------------------------< I S _ A R C H I V E D _ C O P Y >----------------------------------------------
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


compares |title= to 'Archived copy' (placeholder added by bots that can't find proper title); if matches, return true; nil else
if is_set(Page) then
 
if is_set(Pages) or is_set(At) then
]]
Pages = ''; -- unset the others
At = '';
end
extra_text_in_page_check (Page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
elseif is_set(Pages) then
if is_set(At) then
At = ''; -- unset
end
extra_text_in_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
end


local function is_archived_copy (title)
-- both |publication-place= and |place= (|location=) allowed if different
title = mw.ustring.lower(title); -- switch title to lower case
if not is_set(PublicationPlace) and is_set(Place) then
if title:find (cfg.special_case_translation.archived_copy.en) then -- if title is 'Archived copy'
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
return true;
elseif cfg.special_case_translation.archived_copy['local'] then
if mw.ustring.find (title, cfg.special_case_translation.archived_copy['local']) then -- mw.ustring() because might not be Latin script
return true;
end
end
end
end
 
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
 
--[[--------------------------< D I S P L A Y _ N A M E S _ S E L E C T >--------------------------------------
--[[
 
Parameter remapping for cite encyclopedia:
for any of the |display-authors=, |display-editors=, etc parameters, select either the local or global setting.
When the citation has these parameters:
When both are present, look at <local_display_names> value.  When the value is some sort of 'et al.'string,
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
special handling is required.
|encyclopedia and |article then map |encyclopedia to |title
|encyclopedia then map |encyclopedia to |title


When {{cs1 config}} has |display-<namelist>= AND this template has |display-<namelist>=etal AND:
|trans_title maps to |trans_chapter when |title is re-mapped
the number of names specified by <number_of_names> is:
|url maps to |chapterurl when |title is remapped
greater than the number specified in the global |display-<namelist>= parameter (<global_display_names>)
use global |display-<namelist>= parameter value
set overridden maint category
less than or equal to the number specified in the global |display-<namelist>=  parameter
use local |display-<namelist>= parameter value


The purpose of this function is to prevent categorizing a template that has fewer names than the global setting
All other combinations of |encyclopedia, |title, and |article are not modified
to keep the etal annotation specified by <local_display_names>.


]]
]]


local function display_names_select (global_display_names, local_display_names, param_name, number_of_names, test)
local Encyclopedia = A['Encyclopedia'];
if global_display_names and utilities.is_set (local_display_names) then -- when both
if 'etal' == local_display_names:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
number_of_names = tonumber (number_of_names); -- convert these to numbers for comparison
local global_display_names_num = tonumber (global_display_names); -- <global_display_names> not set when parameter value is not digits


if number_of_names > global_display_names_num then -- template has more names than global config allows to be displayed?
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
utilities.set_message ('maint_overridden_setting'); -- set a maint message because global is overriding local |display-<namelist>=etal
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
if is_set(Title) or is_set (ScriptTitle) then
else
if not is_set(Chapter) then
return local_display_names, param_name; -- return local because fewer names so let <local_display_names> control
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
end
ScriptChapter = ScriptTitle;
end
TransChapter = TransTitle;
-- here when <global_display_names> and <local_display_names> both numbers; <global_display_names> controls
ChapterURL = URL;
utilities.set_message ('maint_overridden_setting'); -- set a maint message
if not is_set (ChapterURL) and is_set (TitleLink) then
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
Chapter= '[[' .. TitleLink .. '|' .. Chapter .. ']]';
end
end
-- here when only one of <global_display_names> or <local_display_names> set
Title = Periodical;
if global_display_names then
ChapterFormat = Format;
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
Periodical = ''; -- redundant so unset
else
TransTitle = '';
return local_display_names, param_name; -- return local
URL = '';
Format = '';
TitleLink = '';
ScriptTitle = '';
end
else -- |title not set
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Periodical = ''; -- redundant so unset
end
end
end
end
end


 
-- Special case for cite techreport.
--[[--------------------------< M O D E _ S E T >--------------------------------------------------------------
if (config.CitationClass == "techreport") then -- special case for cite techreport
 
if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
fetch global mode setting from {{cs1 config}} (if present) or from |mode= (if present); global setting overrides
if not is_set(ID) then -- can we use ID for the "number"?
local |mode= parameter value.  When both are present, emit maintenance message
ID = A['Number']; -- yes, use it
 
else -- ID has a value so emit error message
]]
table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )});
 
end
local function mode_set (Mode, Mode_origin)
end
local mode;
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}}; nil when empty or assigned value invalid
mode = is_valid_parameter_value (cfg.global_cs1_config_t['Mode'], 'cs1 config: mode', cfg.keywords_lists['mode'], ''); -- error messaging 'param' here is a hoax
else
mode = is_valid_parameter_value (Mode, Mode_origin, cfg.keywords_lists['mode'], '');
end
end


if cfg.global_cs1_config_t['Mode'] and utilities.is_set (Mode) then -- when template has |mode=<something> which global setting has overridden
-- special case for cite mailing list
utilities.set_message ('maint_overridden_setting'); -- set a maint message
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
return mode;
end


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
if 'conference' == config.CitationClass then
if is_set(BookTitle) then
Chapter = Title;
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
ChapterURL = URL;
ChapterURLorigin = URLorigin;
URLorigin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
Title = BookTitle;
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
elseif 'speech' ~= config.CitationClass then
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end


--[[--------------------------< Q U O T E _ M A K E >----------------------------------------------------------
-- cite map oddities
 
local Cartography = "";
create quotation from |quote=, |trans-quote=, and/or script-quote= with or without |quote-page= or |quote-pages=
local Scale = "";
 
local Sheet = A['Sheet'] or '';
when any of those three quote parameters are set, this function unsets <PostScript>.  When none of those parameters
local Sheets = A['Sheets'] or '';
are set, |quote-page= and |quote-pages= are unset to nil so that they are not included in the template's metadata
if config.CitationClass == "map" then
 
Chapter = A['Map'];
]]
ChapterURL = A['MapURL'];
 
TransChapter = A['TransMap'];
local function quote_make (quote, trans_quote, script_quote, quote_page, quote_pages, nopp, sepc, postscript)
ChapterURLorigin = A:ORIGIN('MapURL');
if utilities.is_set (quote) or utilities.is_set (trans_quote) or utilities.is_set (script_quote) then
ChapterFormat = A['MapFormat'];
 
if utilities.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
end
end
quote = kern_quotes (quote); -- kern if needed
Cartography = A['Cartography'];
quote = utilities.wrap_style ('quoted-text', quote ); -- wrap in <q>...</q> tags
if is_set( Cartography ) then
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
if utilities.is_set (script_quote) then
end
quote = script_concatenate (quote, script_quote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
Scale = A['Scale'];
if is_set( Scale ) then
Scale = sepc .. " " .. Scale;
end
end
end


if utilities.is_set (trans_quote) then
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
if trans_quote:sub(1, 1) == '"' and trans_quote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
trans_quote = trans_quote:sub(2, -2); -- strip them off
local AirDate = A['AirDate'];
end
local SeriesLink = A['SeriesLink'];
quote = quote .. " " .. utilities.wrap_style ('trans-quoted-title', trans_quote );
 
end
link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set


if utilities.is_set (quote_page) or utilities.is_set (quote_pages) then -- add page prefix
local Network = A['Network'];
local quote_prefix = '';
local Station = A['Station'];
if utilities.is_set (quote_page) then
local s, n = {}, {};
extra_text_in_page_check (quote_page, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
-- do common parameters first
if not nopp then
if is_set(Network) then table.insert(n, Network); end
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_page}), '', '', '';
if is_set(Station) then table.insert(n, Station); end
else
ID = table.concat(n, sepc .. ' ');
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_page}), '', '', '';
end
if not is_set (Date) and is_set (AirDate) then -- promote airdate to date
elseif utilities.is_set (quote_pages) then
Date = AirDate;
extra_text_in_page_check (quote_pages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
if tonumber(quote_pages) ~= nil and not nopp then -- if only digits, assume single page
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_pages}), '', '';
elseif not nopp then
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, quote_pages}), '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_pages}), '', '';
end
end
                       
quote = quote_prefix .. ": " .. quote;
else
quote = sepc .. " " .. quote;
end
end


postscript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
elseif utilities.is_set (quote_page) or utilities.is_set (quote_pages) then
local SeriesNumber = A['SeriesNumber'];
quote_page = nil; -- unset; these require |quote=; TODO: error message?
quote_pages = nil;
end


return quote, quote_page, quote_pages, postscript;
if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
end
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=
 
end
--[[--------------------------< C H E C K _ P U B L I S H E R _ N A M E >--------------------------------------
-- assemble a table of parts concatenated later into Series
 
if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
look for variations of '<text>: <text>' that might be '<location>: <publisher>' in |publisher= parameter value.
if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
when found, emit a maintenance message; return nil else
if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
 
Issue = ''; -- unset because this is not a unique parameter
<publisher> is the value assigned to |publisher= or |institution=
 
]]
 
local function check_publisher_name (publisher)
local patterns_t = {
'^[%w%s]+%s*:%s*[%w%s]+$', -- plain text <location>: <publisher>
'^%[+[%w%s:|]+%]+%s*:%s*[%w%s]+$', -- partially wikilinked [[<location>]]: <publisher>
'^[%w%s]+%s*:%s*%[+[%w%s:|]+%]+$', -- partially wikilinked <location>: [[<publisher>]]
'^%[+[%w%s:|]+%]+%s*:%s*%[+[%w%s:|]+%]+$', -- wikilinked [[<location>]]: [[<publisher>]]
}
for _, pattern in ipairs (patterns_t) do -- spin through the patterns_t sequence
Chapter = Title; -- promote title parameters to chapter
if mw.ustring.match (publisher, pattern) then -- does this pattern match?
ScriptChapter = ScriptTitle;
utilities.set_message ('maint_publisher_location'); -- set a maint message
ChapterLink = TitleLink; -- alias episodelink
return; -- and done
TransChapter = TransTitle;
end
ChapterURL = URL;
ChapterURLorigin = A:ORIGIN('URL');
Title = Series; -- promote series to title
TitleLink = SeriesLink;
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
 
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
Chapter = '[[' .. ChapterLink .. '|' .. Chapter .. ']]'; -- ok to wikilink
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
Series = '[[' .. ChapterLink .. '|' .. Series .. ']]'; -- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
end
URL = ''; -- unset
TransTitle = '';
ScriptTitle = '';
else -- now oddities that are 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?
if is_set (Series) and is_set (SeriesLink) then
Series = '[[' .. SeriesLink .. '|' .. Series .. ']]';
end
Series = wrap_style ('italic-title', Series); -- series is italicized
end
end
end
end
-- 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
elseif is_set (Series) then -- series is an alias of version (deprecated for cite arxiv) (not allowed for biorxiv and citeseerx)
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
Series = ''; -- unset
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
-- if 'arxiv' == config.CitationClass then
-- if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
-- table.insert( z.message_tail, { set_error( 'arxiv_missing', {}, true ) } ); -- add error message
-- elseif is_set (Series) then -- series is an alias of version (deprecated for cite arxiv)
-- ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
-- Series = ''; -- unset
-- end
-- Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string
-- end
end
-- 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
TitleType = set_titletype (config.CitationClass, TitleType);
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
end
end


--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
if is_set(TitleType) then -- if type parameter is specified
 
TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses
This is the main function doing the majority of the citation formatting.
-- TODO: Hack on TitleType to fix bunched parentheses problem
 
end
]]


local function citation0( config, args )
-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
--[[
if not is_set (Date) then
Load Input Parameters
Date = Year; -- promote Year to Date
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
]]
if not is_set (Date) and is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
local A = argument_wrapper ( args );
Date = PublicationDate; -- promote PublicationDate to Date
local i
PublicationDate = ''; -- unset, no longer needed
 
-- Pick out the relevant fields from the arguments.  Different citation templates
-- define different field names for the same underlying things.
 
local author_etal;
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local Authors;
local NameListStyle;
if cfg.global_cs1_config_t['NameListStyle'] then -- global setting in {{cs1 config}} overrides local |name-list-style= parameter value; nil when empty or assigned value invalid
NameListStyle = is_valid_parameter_value (cfg.global_cs1_config_t['NameListStyle'], 'cs1 config: name-list-style', cfg.keywords_lists['name-list-style'], ''); -- error messaging 'param' here is a hoax
else
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
end
end
end


if cfg.global_cs1_config_t['NameListStyle'] and utilities.is_set (A['NameListStyle']) then -- when template has |name-list-style=<something> which global setting has overridden
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end


local Collaboration = A['Collaboration'];
--[[
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.


do -- to limit scope of selected
Date validation supporting code is in Module:Citation/CS1/Date_validation
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
]]
if 1 == selected then
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
local error_message = '';
elseif 2 == selected then
-- AirDate has been promoted to Date so not necessary to check it
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
local date_parameters_list = {['access-date']=AccessDate, ['archive-date']=ArchiveDate, ['date']=Date, ['doi-broken-date']=DoiBroken,
a, author_etal = parse_vauthors_veditors (args, A['Vauthors'], 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year};
elseif 3 == selected then
Authors = A['Authors']; -- use content of |people= or |credits=; |authors= is deprecated; TODO: constrain |people= and |credits= to cite av media, episode, serial?
end
if utilities.is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end


local editor_etal;
anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=


do -- to limit scope of selected
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed;
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
local mismatch = year_date_check (Year, Date)
if 1 == selected then
if 0 == mismatch then -- |year= does not match a year-value in |date=
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
if is_set (error_message) then -- if there is already an error message
elseif 2 == selected then
error_message = error_message .. ', '; -- tack on this additional message
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
end
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
error_message = error_message .. '&#124;year= / &#124;date= mismatch';
end
elseif 1 == mismatch then -- |year= matches year-value in |date=
end
add_maint_cat ('date_year');
end
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases
local Chapter_origin = A:ORIGIN ('Chapter');
local Contribution; -- because contribution is required for contributor(s)
if 'contribution' == Chapter_origin then
Contribution = Chapter; -- get the name of the contribution
end
end
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.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(error_message) then -- error free dates only
if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=
local modified = false; -- flag
utilities.set_message ('err_contributor_missing_required_param', 'contribution'); -- add missing contribution error message
if is_set (DF) then -- if we need to reformat dates
c = {}; -- blank the contributors' table; it is used as a flag later
modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate
end
end
if 0 == #a then -- |contributor= requires |author=
 
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
c = {}; -- blank the contributors' table; it is used as a flag later
modified = true;
add_maint_cat ('date_format'); -- hyphens were converted so add maint category
end
if modified then -- if the date_parameters_list values were modified
AccessDate = date_parameters_list['access-date']; -- overwrite date holding parameters with modified values
ArchiveDate = date_parameters_list['archive-date'];
Date = date_parameters_list['date'];
DoiBroken = date_parameters_list['doi-broken-date'];
LayDate = date_parameters_list['lay-date'];
PublicationDate = date_parameters_list['publication-date'];
end
end
else
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
end
end
else -- if not a book cite
end -- end of do
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
 
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
end
-- 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
Contribution = nil; -- unset
Embargo = is_embargoed (Embargo); --  
end


local Title = A['Title'];
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
local TitleLink = A['TitleLink'];
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


local auto_select = ''; -- default is auto
end
local accept_link;
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
auto_select = TitleLink; -- remember selection for later
TitleLink = ''; -- treat as if |title-link= would have been empty
end
end


TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set
-- 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
local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
if not is_set(Title) and
if 'map' == config.CitationClass and 'section' == Chapter_origin then
not is_set(TransTitle) and
Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}}
not is_set(ScriptTitle) then
Chapter = ''; -- unset for now; will be reset later from |map= if present
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
local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN('Periodical');
local ScriptPeriodical = A['ScriptPeriodical'];
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
local TransPeriodical =  A['TransPeriodical'];
local TransPeriodical_origin =  A:ORIGIN ('TransPeriodical');
if (utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical))) then
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
local param;
Title = ''; -- set title to empty string
if utilities.is_set (Periodical) then -- get a parameter name from one of these periodical related meta-parameters
add_maint_cat ('untitled');
Periodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = Periodical_origin -- get parameter name for error messaging
elseif utilities.is_set (TransPeriodical) then
TransPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = TransPeriodical_origin; -- get parameter name for error messaging
elseif utilities.is_set (ScriptPeriodical) then
ScriptPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = ScriptPeriodical_origin; -- get parameter name for error messaging
end
 
if utilities.is_set (param) then -- if we found one
utilities.set_message ('err_periodical_ignored', {param}); -- emit an error message
end
end
end


if utilities.is_set (Periodical) then
check_for_url ({ -- add error message when any of these parameters contains a URL
local i;
['title']=Title,
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
[A:ORIGIN('Chapter')]=Chapter,
if i then -- non-zero when markup was stripped so emit an error message
[A:ORIGIN('Periodical')]=Periodical,
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
[A:ORIGIN('PublisherName')] = PublisherName
end
});
end


if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error TODO: make a function for this and similar?
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')});
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
end
-- is the article title, and Chapter is a section within the article.  So, we remap
 
Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
Periodical_origin = A:ORIGIN('MailingList');
end
 
-- web and news not tested for now because of
-- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
-- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
if p[config.CitationClass] then
utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]});
end
end
local Volume;
local coins_chapter = Chapter; -- default assuming that remapping not required
if 'citation' == config.CitationClass then
local coins_title = Title; -- et tu
if utilities.is_set (Periodical) then
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
if not utilities.in_array (Periodical_origin, cfg.citation_no_volume_t) then -- {{citation}} does not render |volume= when these parameters are used
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
Volume = A['Volume']; -- but does for all other 'periodicals'
coins_chapter = Title; -- remap
end
coins_title = Periodical;
elseif utilities.is_set (ScriptPeriodical) then
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
Volume = A['Volume']; -- but does for all other 'periodicals'
end
else
Volume = A['Volume']; -- and does for non-'periodical' cites
end
elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
Volume = A['Volume'];
end
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');
 
local Issue;
if 'citation' == config.CitationClass then
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, cfg.citation_issue_t) then -- {{citation}} may render |issue= when these parameters are used
Issue = utilities.hyphen_to_dash (A['Issue']);
end
elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
Issue = utilities.hyphen_to_dash (A['Issue']);
end
end
end
end
local coins_author = a; -- default for coins rft.au
local ArticleNumber;
if 0 < #c then -- but if contributor list
 
coins_author = c; -- use that instead
if utilities.in_array (config.CitationClass, {'journal', 'conference'}) or ('citation' == config.CitationClass and utilities.is_set (Periodical) and 'journal' == Periodical_origin) then
ArticleNumber = A['ArticleNumber'];
end
end


extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');
-- this is the function call to COinS()
 
local OCinSoutput = COinS({
local Page;
['Periodical'] = Periodical,
local Pages;
['Encyclopedia'] = Encyclopedia,
local At;
['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
local QuotePage;
['Degree'] = Degree; -- cite thesis only
local QuotePages;
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then -- TODO: rewrite to emit ignored parameter error message?
['PublicationPlace'] = PublicationPlace,
Page = A['Page'];
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
Pages = utilities.hyphen_to_dash (A['Pages']);
['Season'] = COinS_date.rftssn,
At = A['At'];
['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?
QuotePage = A['QuotePage'];
['Series'] = Series,
QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
['Volume'] = Volume,
end
['Issue'] = Issue,
['Pages'] = get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName,
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);


local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
 
-- if 'arxiv' == config.CitationClass then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
local Mode = mode_set (A['Mode'], A:ORIGIN('Mode'));
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
-- separator character and postscript
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
local Quote;
Quote, QuotePage, QuotePages, PostScript = quote_make (A['Quote'], A['TransQuote'], A['ScriptQuote'], QuotePage, QuotePages, NoPP, sepc, PostScript);
 
local Edition = A['Edition'];
local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
local Place = place_check (A['Place'], A:ORIGIN('Place'));
local PublisherName = A['PublisherName'];
local PublisherName_origin = A:ORIGIN('PublisherName');
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then
local i = 0;
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized
if i and (0 < i) then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
end
end
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'});
end
end


local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
local Newsgroup_origin = A:ORIGIN('Newsgroup');
 
if 'newsgroup' == config.CitationClass then
if 'newsgroup' == config.CitationClass then
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
if is_set (PublisherName) then
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil ));
end
end
PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
end
end


if 'book' == config.CitationClass or 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and not utilities.is_set (Periodical)) then
local accept;
PublisherName, accept = utilities.has_accept_as_written (PublisherName); -- check for and remove accept-as-written markup from |publisher= wrapped
if not accept then -- when no accept-as-written markup
check_publisher_name (PublisherName); -- emit maint message when |publisher= might be prefixed with publisher's location
end
end


local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL?
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then
UrlAccess = nil;
utilities.set_message ('err_param_access_requires_param', 'url');
end
local ChapterURL = A['ChapterURL'];
local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then
ChapterUrlAccess = nil;
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')});
end


local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
-- Now perform various field substitutions.
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then
-- We also add leading spaces and surrounding markup and punctuation to the
MapUrlAccess = nil;
-- various parts of the citation, but only when they are non-nil.
utilities.set_message ('err_param_access_requires_param', {'map-url'});
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
end
do
local last_first_list;
local control = {
format = NameListFormat, -- empty string or 'vanc'
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
};
 
do -- do editor name list first because coauthors can modify control table
control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal);
last_first_list, EditorCount = list_people(control, e, editor_etal);


local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
if is_set (Editors) then
local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
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


-- check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then  
if not utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
EditorCount = 2; -- spoof to display (eds.) annotation
if cfg.uncategorized_namespaces[this_page.namespace] then -- is this page's namespace id one of the uncategorized namespace ids?
end
no_tracking_cats = "true"; -- set no_tracking_cats
end
end
for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
do -- now do interviewers
if this_page.text:match (v) then -- test page name against each pattern
control.maximum = #interviewers_list; -- number of interviewerss
no_tracking_cats = "true"; -- set no_tracking_cats
Interviewers = list_people(control, interviewers_list, false); -- et al not currently supported
break; -- bail out if one is found
end
end
end
end
do -- now do translators
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
control.maximum = #t; -- number of translators
utilities.select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'err_redundant_parameters'); -- this is a dummy call simply to get the error message and category
Translators = list_people(control, t, false); -- et al not currently supported
 
local coins_pages;
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);
 
if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
utilities.add_prop_cat ('location-test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
if PublicationPlace == Place then
Place = ''; -- unset; don't need both if they are the same
end
end
elseif not utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- when only |place= (|location=) is set ...
do -- now do contributors
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
control.maximum = #c; -- number of contributors
end
Contributors = list_people(control, c, false); -- et al not currently supported
 
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
do -- now do authors
control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal);


local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
if is_set(Coauthors) then -- if the coauthor field is also used, prevent ampersand and et al. formatting.
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
control.lastauthoramp = nil;
local ScriptChapter = A['ScriptChapter'];
control.maximum = #a + 1;
local ScriptChapter_origin = A:ORIGIN ('ScriptChapter');
end
local Format = A['Format'];
local ChapterFormat = A['ChapterFormat'];
last_first_list = list_people(control, a, author_etal);
local TransChapter = A['TransChapter'];
local TransChapter_origin = A:ORIGIN ('TransChapter');
local TransTitle = A['TransTitle'];
local ScriptTitle = A['ScriptTitle'];
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= for rendering
|encyclopedia= and |article= then map |encyclopedia= to |title= for rendering


|trans-title= maps to |trans-chapter= when |title= is re-mapped
if is_set (Authors) then
|url= maps to |chapter-url= when |title= is remapped
Authors, author_etal = name_has_etal (Authors, author_etal, false); -- find and remove variations on et al.
if author_etal then
All other combinations of |encyclopedia=, |title=, and |article= are not modified
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
end
]]
 
local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
local ScriptEncyclopedia = A['ScriptEncyclopedia'];
local TransEncyclopedia = A['TransEncyclopedia'];
 
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
if utilities.is_set (Encyclopedia) then
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
else
else
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('ScriptEncyclopedia')});
Authors = last_first_list; -- either an author name list or an empty string
end
end
Encyclopedia = nil; -- unset these because not supported by this template
end -- end of do
ScriptEncyclopedia = nil;
TransEncyclopedia = nil;
if is_set (Authors) and is_set (Collaboration) then
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
end
end
elseif utilities.is_set (TransEncyclopedia) then
utilities.set_message ('err_trans_missing_title', {'encyclopedia'});
end


if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
if utilities.is_set (Periodical) and utilities.is_set (Encyclopedia) then -- when both parameters set emit an error message; {{citation}} only; Periodical not allowed in {{cite encyclopedia}}
table.insert( z.message_tail, { set_error('coauthors_missing_author', {}, true) } ); -- emit error message
utilities.set_message ('err_periodical_ignored', {Periodical_origin});
end
end
end


if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia
-- an error message if the associated url is not set, or an empty string for concatenation
Periodical_origin = A:ORIGIN ('Encyclopedia');
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
ScriptPeriodical = ScriptEncyclopedia;
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
ScriptPeriodical_origin = A:ORIGIN ('ScriptEncyclopedia');
Format = style_format (Format, URL, 'format', 'url');
LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url');
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');


if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then
-- special case for chapter format so no error message or cat when chapter not supported
if not utilities.is_set (Chapter) then
if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= params to |article= params for rendering
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then
ScriptChapter = ScriptTitle;
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
end
TransChapter = TransTitle;
ChapterURL = URL;
ChapterURL_origin = URL_origin;
ChapterUrlAccess = UrlAccess;
ChapterFormat = Format;


if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then
if not is_set(URL) then
Chapter = utilities.make_wikilink (TitleLink, Chapter);
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist
end
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
Title = Periodical; -- now map |encyclopedia= params to |title= params for rendering
end
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
-- do we have |accessdate= without either |url= or |chapter-url=?
Periodical = ''; -- redundant so unset
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set;
ScriptPeriodical = '';
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
URL = '';
AccessDate = '';
Format = '';
TitleLink = '';
end
elseif utilities.is_set (Chapter) or utilities.is_set (ScriptChapter) then -- |title= not set
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= for rendering
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
end
end
end
end
end


-- special case for cite techreport.
local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
local ID = A['ID'];
DeadURL = DeadURL:lower(); -- used later when assembling archived text
if (config.CitationClass == "techreport") then -- special case for cite techreport
if is_set( ArchiveURL ) then
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it
if not utilities.is_set (ID) then -- can we use ID for the "number"?
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
ID = A['Number']; -- yes, use it
OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages
else -- ID has a value so emit error message
OriginalFormat = ChapterFormat; -- and original |format=
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'number')});
if 'no' ~= DeadURL then
ChapterURL = ArchiveURL -- swap-in the archive's url
ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
end
elseif is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
OriginalURLorigin = URLorigin; -- name of url parameter for error messages
OriginalFormat = Format; -- and original |format=
OriginalAccess = UrlAccess;
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
URL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
Format = ArchiveFormat or ''; -- swap in archive's format
UrlAccess = nil; -- restricted access levels do not make sense for archived urls
end
end
end
end
end
end


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
local Conference = A['Conference'];
local chap_param;
local BookTitle = A['BookTitle'];
if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
local TransTitle_origin = A:ORIGIN ('TransTitle');
chap_param = A:ORIGIN ('Chapter')
if 'conference' == config.CitationClass then
elseif is_set (TransChapter) then
if utilities.is_set (BookTitle) then
chap_param = A:ORIGIN ('TransChapter')
Chapter = Title;
elseif is_set (ChapterURL) then
Chapter_origin = 'title';
chap_param = A:ORIGIN ('ChapterURL')
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
elseif is_set (ScriptChapter) then
ChapterURL = URL;
chap_param = A:ORIGIN ('ScriptChapter')
ChapterUrlAccess = UrlAccess;
else is_set (ChapterFormat)
ChapterURL_origin = URL_origin;
chap_param = A:ORIGIN ('ChapterFormat')
URL_origin = '';
end
ChapterFormat = Format;
 
TransChapter = TransTitle;
if is_set (chap_param) then -- if we found one
TransChapter_origin = TransTitle_origin;
table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- add error message
Title = BookTitle;
Chapter = ''; -- and set them to empty string to be safe with concatenation
Format = '';
TransChapter = '';
-- TitleLink = '';
ChapterURL = '';
TransTitle = '';
ScriptChapter = '';
URL = '';
ChapterFormat = '';
end
else -- otherwise, format chapter / article title
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
end
end
 
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes); -- Contribution is also in Chapter
if is_set (Chapter) then
Chapter = Chapter .. ChapterFormat ;
if 'map' == config.CitationClass and is_set (TitleType) then
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
Chapter = Chapter.. sepc .. ' ';
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
end
end
elseif 'speech' ~= config.CitationClass then
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end
end
local use_lowercase = ( sepc == ',' ); -- controls capitalization of certain static text
-- cite map oddities
local Cartography = "";
local Scale = "";
local Sheet = A['Sheet'] or '';
local Sheets = A['Sheets'] or '';
if config.CitationClass == "map" then
if utilities.is_set (Chapter) then --TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'map') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', Chapter_origin)}); -- add error message
end
Chapter = A['Map'];
Chapter_origin = A:ORIGIN('Map');
ChapterURL = A['MapURL'];
ChapterURL_origin = A:ORIGIN('MapURL');
TransChapter = A['TransMap'];
ScriptChapter = A['ScriptMap']
ScriptChapter_origin = A:ORIGIN('ScriptMap')


ChapterUrlAccess = MapUrlAccess;
-- Format main title.
ChapterFormat = A['MapFormat'];
if is_set(TitleLink) and is_set(Title) then
Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
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
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 ); -- for cite report, use this form for trans-title
else
Title = wrap_style ('italic-title', Title);
Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
TransTitle = wrap_style ('trans-italic-title', TransTitle);
end


Cartography = A['Cartography'];
local TransError = "";
if utilities.is_set ( Cartography ) then
if is_set(TransTitle) then
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
if is_set(Title) then
end
TransTitle = " " .. TransTitle;
Scale = A['Scale'];
else
if utilities.is_set ( Scale ) then
TransError = " " .. set_error( 'trans_missing_title', {'title'} );
Scale = sepc .. " " .. Scale;
end
end
end
end
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;
-- this experiment hidden 2016-04-10; see Help_talk:Citation_Style_1#Recycled_urls
-- local temp_title = external_link( URL, Title, URLorigin ) .. TransError .. Format; -- do this so we get error message even if url is usurped no archive
-- if in_array (DeadURL, {'unfit no archive', 'usurped no archive'}) then -- when url links to inappropriate location and there is no archive of original source available
-- local err_msg
-- if temp_title:match ('%[%S+%s+(.+)%](<.+)') then -- if there is an error message
-- Title, err_msg = temp_title:match ('%[%S+%s+(.+)%](<.+)'); -- strip off external link; TODO: find a better to do this
-- Title = Title .. (err_msg or '');
-- end
-- else
-- Title = temp_title;
-- end


-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
URL = ''; -- unset these because no longer needed
local Series = A['Series'];
Format = "";
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
else
local SeriesLink = A['SeriesLink'];
Title = Title .. TransTitle .. TransError;
end
end


SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set
if is_set(Place) then
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
end


local Network = A['Network'];
if is_set (Conference) then
local Station = A['Station'];
if is_set (ConferenceURL) then
local s, n = {}, {};
Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil );
-- do common parameters first
end
if utilities.is_set (Network) then table.insert(n, Network); end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
if utilities.is_set (Station) then table.insert(n, Station); end
elseif is_set(ConferenceURL) then
ID = table.concat(n, sepc .. ' ');
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil );
end
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];


if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set TODO: make a function for this and similar?
if not is_set(Position) then
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
local Minutes = A['Minutes'];
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
local Time = A['Time'];
end
-- assemble a table of parts concatenated later into Series
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter
Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
ChapterLink = TitleLink; -- alias |episode-link=
TransChapter = TransTitle;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
ChapterFormat = Format;
 
Title = Series; -- promote series to title
TitleLink = SeriesLink;
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number


if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL
if is_set(Minutes) then
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
if is_set (Time) then
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode;
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } );
Series = utilities.make_wikilink (ChapterLink, Series);
end
end
URL = ''; -- unset
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
TransTitle = '';
else
ScriptTitle = '';
if is_set(Time) then
Format = '';
local TimeCaption = A['TimeCaption']
if not is_set(TimeCaption) then
else -- now oddities that are cite serial
TimeCaption = cfg.messages['event'];
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
if sepc ~= '.' then
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
TimeCaption = TimeCaption:lower();
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
end
Series = utilities.make_wikilink (SeriesLink, Series);
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
end
end
-- end of {{cite episode}} stuff
-- handle type parameter for those CS1 citations that have default values
local TitleType = A['TitleType'];
local Degree = A['Degree'];
if utilities.in_array (config.CitationClass, {'AV-media-notes', 'document', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
TitleType = set_titletype (config.CitationClass, TitleType);
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
end
end
else
Position = " " .. Position;
At = '';
end
end


if utilities.is_set (TitleType) then -- if type parameter is specified
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase, Mode);
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
-- TODO: Hack on TitleType to fix bunched parentheses problem
end


-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
At = is_set(At) and (sepc .. " " .. At) or "";
local Date = A['Date'];
Position = is_set(Position) and (sepc .. " " .. Position) or "";
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
if config.CitationClass == 'map' then
local PublicationDate = A['PublicationDate'];
local Section = A['Section'];
local Year = A['Year'];
local Sections = A['Sections'];
local Inset = A['Inset'];
if is_set( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end
 
if is_set( Sections ) then
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
elseif is_set( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
end
At = At .. Inset .. Section;
end
 
if is_set (Language) then
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


if utilities.is_set (Year) then
Others = is_set(Others) and (sepc .. " " .. Others) or "";
validation.year_check (Year); -- returns nothing; emits maint message when |year= doesn't hold a 'year' value
if is_set (Translators) then
if 'mla' == Mode then
Others = sepc .. ' Trans. ' .. Translators .. Others;
else
Others = sepc .. ' ' .. wrap_msg ('translated', Translators, use_lowercase) .. Others;
end
end
if is_set (Interviewers) then
Others = sepc .. ' ' .. wrap_msg ('interview', Interviewers, use_lowercase) .. Others;
end
end
if not utilities.is_set (Date) then
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
Date = Year; -- promote Year to Date
if is_set (Edition) then
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then
if not utilities.is_set (Date) and utilities.is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
add_maint_cat ('extra_text', 'edition');
Date = PublicationDate; -- promote PublicationDate to Date
end
PublicationDate = ''; -- unset, no longer needed
if 'mla' == Mode then
Date_origin = A:ORIGIN('PublicationDate'); -- save the name of the promoted parameter
Edition = '. ' .. Edition .. ' ed.';
else
else
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter
Edition = " " .. wrap_msg ('edition', Edition);
end
end
else
else
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging
Edition = '';
end
end


if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
Series = is_set(Series) and (sepc .. " " .. Series) or "";
if 'mla' == Mode then -- not in brackets for mla
OrigYear = is_set(OrigYear) and (". " .. OrigYear) or "";
else
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
end
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";


--[[
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase, Mode);
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.
Date validation supporting code is in Module:Citation/CS1/Date_validation
]]


local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
------------------------------------ totally unrelated data
if not utilities.is_set (DF) then
if is_set(Via) then
DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template
Via = " " .. wrap_msg ('via', Via);
end
end


local ArchiveURL;
--[[
local ArchiveDate;
Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link
local ArchiveFormat = A['ArchiveFormat'];
note is displayed. There are no error messages for this condition.
local archive_url_timestamp; -- timestamp from wayback machine url
ArchiveURL, ArchiveDate, archive_url_timestamp = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
ArchiveURL, ArchiveDate = is_unique_archive_url (ArchiveURL, URL, ChapterURL, A:ORIGIN('ArchiveURL'), ArchiveDate); -- add error message when URL or ChapterURL == ArchiveURL


local AccessDate = A['AccessDate'];
]]
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
if is_set (SubscriptionRequired) then
local DoiBroken = A['DoiBroken'];
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
local Embargo = A['Embargo'];
elseif is_set (RegistrationRequired) then
local anchor_year; -- used in the CITEREF identifier
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
else
local error_message = '';
SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
-- AirDate has been promoted to Date so not necessary to check it
end
local date_parameters_list = {
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
['date'] = {val = Date, name = Date_origin},
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')},
['year'] = {val = Year, name = A:ORIGIN ('Year')},
};


local error_list = {};
if is_set(AccessDate) then
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);
local retrv_text = " " .. cfg.messages['retrieved']


if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;  
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
validation.year_date_check (Year, A:ORIGIN ('Year'), Date, A:ORIGIN ('Date'), error_list);
if 'mla' == Mode then -- retrieved text not used in mla
AccessDate = ' ' .. AccessDate;
else
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text
end
end
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
end
if is_set(ID) then ID = sepc .." ".. ID; end
  if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
end
  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
end


if 0 == #error_list then -- error free dates only; 0 when error_list is empty
ID_list = build_id_list( ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} );
local modified = false; -- flag
if utilities.is_set (DF) then -- if we need to reformat dates
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
end


if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
if is_set(URL) then
modified = true;
URL = " " .. external_link( URL, nil, URLorigin, UrlAccess );
utilities.set_message ('maint_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; not supported at en.wiki
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
modified = true;
end


if modified then -- if the date_parameters_list values were modified
if is_set(Quote) then
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then -- if first and last characters of quote are quote marks
ArchiveDate = date_parameters_list['archive-date'].val;
Quote = Quote:sub(2,-2); -- strip them off
Date = date_parameters_list['date'].val;
end
DoiBroken = date_parameters_list['doi-broken-date'].val;
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
PublicationDate = date_parameters_list['publication-date'].val;
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
end
end
 
if archive_url_timestamp and utilities.is_set (ArchiveDate) then
local Archived
validation.archive_date_check (ArchiveDate, archive_url_timestamp, DF); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate
if is_set(ArchiveURL) then
if not is_set(ArchiveDate) then
ArchiveDate = set_error('archive_missing_date');
end
if "no" == DeadURL then
local arch_text = cfg.messages['archived'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } );
if not is_set(OriginalURL) then
Archived = Archived .. " " .. set_error('archive_missing_url');  
end
end
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 from the original on ' .. ArchiveDate; -- format already styled
if 'bot: unknown' == DeadURL then
add_maint_cat ('bot:_unknown'); -- and add a category if not already added
else
add_maint_cat ('unfit'); -- and add a category if not already added
end
else -- DeadURL is empty, 'yes', 'true', or 'y'
Archived = sepc .. " " .. substitute( arch_text,
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
end
else
else
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message
local arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,  
{ set_error('archive_missing_url'), ArchiveDate } );
end
end
end -- end of do
elseif is_set (ArchiveFormat) then
 
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others?
else
('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) or -- {{citation}} as an encylopedia citation
Archived = ""
('citation' == config.CitationClass and not utilities.is_set (Periodical)) then -- {{citation}} as a book citation
if utilities.is_set (PublicationPlace) then
if not utilities.is_set (PublisherName) then
local date = COinS_date.rftdate and tonumber (COinS_date.rftdate:match ('%d%d%d%d')); -- get year portion of COinS date (because in Arabic numerals); convert string to number
if date and (1850 <= date) then -- location has no publisher; if date is 1850 or later
utilities.set_message ('maint_location_no_publisher'); -- add maint cat
end
else -- PublisherName has a value
if cfg.keywords_xlate['none'] == PublisherName then -- if that value is 'none' (only for book and encyclopedia citations)
PublisherName = ''; -- unset
end
end
end
end
end
local ID_list = {}; -- sequence table of rendered identifiers
local ID_list_coins = {}; -- table of identifiers and their values from args; key is same as cfg.id_handlers's key
local Class = A['Class']; -- arxiv class identifier
local ID_support = {
local Lay = '';
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
if is_set(LayURL) then
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
if is_set(LaySource) then
}
LaySource = " &ndash; ''" .. safe_for_italics(LaySource) .. "''";
 
else
ID_list, ID_list_coins = identifiers.identifier_lists_get (args, {DoiBroken = DoiBroken, ASINTLD = A['ASINTLD'], Embargo = Embargo, Class = Class, Year=anchor_year}, ID_support);
LaySource = "";
 
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, {{cite ssrn}}, before generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv=, |citeseerx=, |medrxiv=, |ssrn= required for their templates
if not (args[cfg.id_handlers[config.CitationClass:upper()].parameters[1]] or -- can't use ID_list_coins k/v table here because invalid parameters omitted
args[cfg.id_handlers[config.CitationClass:upper()].parameters[2]]) then -- which causes unexpected parameter missing error message
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
end
end
 
if sepc == '.' then
Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['medrxiv'] = 'medRxiv', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
else
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
end
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
end
end


-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free
if is_set(Transcript) then
 
if is_set(TranscriptURL) then
if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil );
if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled
if identifiers.auto_link_urls[auto_select] then -- manual selection
URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link
URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC
URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed
URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI
URL = identifiers.auto_link_urls['doi'];
URL_origin = cfg.id_handlers['DOI'].parameters[1];
end
end
 
if utilities.is_set (URL) then -- set when using an identifier-created URL
if utilities.is_set (AccessDate) then -- |access-date= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_accessdate_missing_url'); -- add an error message
AccessDate = ''; -- unset
end
 
if utilities.is_set (ArchiveURL) then -- |archive-url= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_archive_missing_url'); -- add an error message
ArchiveURL = ''; -- unset
end
end
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif is_set(TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil );
end
end


-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
local Publisher;
-- Test if citation has no title
if is_set(PublicationDate) then
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
PublicationDate = wrap_msg ('published', PublicationDate);
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
end
end
 
if is_set(PublisherName) then
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
if is_set(PublicationPlace) then
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and
else
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
Publisher = sepc .. " " .. PublisherName .. PublicationDate; 
Title = ''; -- set title to empty string
end
utilities.set_message ('maint_untitled'); -- add maint cat
elseif is_set(PublicationPlace) then  
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
else
Publisher = PublicationDate;
end
end
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
-- is the article title, and Chapter is a section within the article.  So, we remap
local coins_chapter = Chapter; -- default assuming that remapping not required
-- Several of the above rely upon detecting this as nil, so do it last.
local coins_title = Title; -- et tu
if is_set(Periodical) then
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
if is_set(Title) or is_set(TitleNote) then  
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then
Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)
coins_chapter = Title; -- remap
else
coins_title = Periodical;
Periodical = wrap_style ('italic-title', Periodical)
end
end
end
end
local coins_author = a; -- default for coins rft.au
 
if 0 < #c then -- but if contributor list
--[[
coins_author = c; -- use that instead
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
end
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
]]
-- this is the function call to COinS()
if "speech" == config.CitationClass then -- cite speech only
local OCinSoutput = metadata.COinS({
TitleNote = " (Speech)"; -- annotate the citation
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
if is_set (Conference) then -- and if |event= is set
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
['Degree'] = Degree; -- cite thesis only
end
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
end
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date.* has correctly formatted date values if Date is valid;
['Season'] = COinS_date.rftssn,
['Quarter'] = COinS_date.rftquarter,
['Chron'] = COinS_date.rftchron,
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['ArticleNumber'] = ArticleNumber,
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['ID_list'] = ID_list_coins,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);
 
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, and {{cite ssrn}} AFTER generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, medRxiv, or ssrn now unset so it isn't displayed
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
-- Piece all bits together at last.  Here, all should be non-nil.
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
-- We build things this way because it is more efficient in LUA
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
-- not to keep reassigning to the same string variable over and over.
end


local Editors;
local tcommon;
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
local tcommon2; -- used for book cite when |contributor= is set
local Contributors; -- assembled contributors name list
local contributor_etal;
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
local Translators; -- assembled translators name list
if is_set(Others) then Others = Others .. sepc .. " " end
local translator_etal;
if 'mla' == Mode then
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
tcommon = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc );
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
else
local Interviewers;
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,  
local interviewers_list = {};
Language, Edition, Publisher, Agency, Volume}, sepc );
interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters
end
local interviewer_etal;
elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc
-- Now perform various field substitutions.
tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2
-- We also add leading spaces and surrounding markup and punctuation to the
if 'mla' == Mode then
-- various parts of the citation, but only when they are non-nil.
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Edition, Publisher, Agency}, sepc );
do
else
local last_first_list;
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
local control = {
format = NameListStyle, -- empty string, '&', 'amp', 'and', or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
mode = Mode
};
 
do -- do editor name list first because the now unsupported coauthors used to modify control table
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayEditors'], A['DisplayEditors'], A:ORIGIN ('DisplayEditors'), #e);
control.maximum, editor_etal = get_display_names (display_names, #e, 'editors', editor_etal, param);
 
Editors, EditorCount = list_people (control, e, editor_etal);
 
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
EditorCount = 2; -- spoof to display (eds.) annotation
end
end
elseif 'mla' == Mode then
tcommon = safe_join( {TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Publisher, Agency}, sepc );
else
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
end
end
do -- now do interviewers
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayInterviewers'], A['DisplayInterviewers'], A:ORIGIN ('DisplayInterviewers'), #interviewers_list);
control.maximum, interviewer_etal = get_display_names (display_names, #interviewers_list, 'interviewers', interviewer_etal, param);


Interviewers = list_people (control, interviewers_list, interviewer_etal);
elseif 'map' == config.CitationClass then -- special cases for cite map
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 );
elseif is_set (Periodical) then -- map in a periodical
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
else -- a sheet or stand-alone map
tcommon = safe_join( {Title, TitleType, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc );
end
end
do -- now do translators
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayTranslators'], A['DisplayTranslators'], A:ORIGIN ('DisplayTranslators'), #t);
elseif 'episode' == config.CitationClass then -- special case for cite episode
control.maximum, translator_etal = get_display_names (display_names, #t, 'translators', translator_etal, param);
tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc );


Translators = list_people (control, t, translator_etal);
elseif ('news' == config.CitationClass) and ('mla' == Mode) then -- special case for cite news in MLA mode
end
tcommon = safe_join( {Periodical, Format, TitleType, Series, Language, Edition, Agency}, sepc );
do -- now do contributors
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayContributors'], A['DisplayContributors'], A:ORIGIN ('DisplayContributors'), #c);
control.maximum, contributor_etal = get_display_names (display_names, #c, 'contributors', contributor_etal, param);


Contributors = list_people (control, c, contributor_etal);
elseif ('web' == config.CitationClass) and ('mla' == Mode) then -- special case for cite web in MLA mode
end
tcommon = safe_join( {Periodical, Format, TitleType, Series, Language,  
do -- now do authors
Edition, Publisher, Agency}, sepc );
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayAuthors'], A['DisplayAuthors'], A:ORIGIN ('DisplayAuthors'), #a, author_etal);
control.maximum, author_etal = get_display_names (display_names, #a, 'authors', author_etal, param);


last_first_list = list_people (control, a, author_etal);
else -- all other CS1 templates
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
Volume, Others, Edition, Publisher, Agency}, sepc );
end
if #ID_list > 0 then
ID_list = safe_join( { sepc .. " ", table.concat( ID_list, sepc .. " " ), ID }, sepc );
else
ID_list = ID;
end
local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
local text;
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;


if utilities.is_set (Authors) then
if is_set(Date) then
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
if ('mla' == Mode) then
if author_etal then
if in_array (config.CitationClass, {'book', 'news', 'web'}) then
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
Date = ', ' .. Date; -- origyear follows title in mla
end
elseif 'journal' == config.CitationClass then
Date = ', (' .. Date .. ')';
end
elseif is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses
else -- neither of authors and editors set
if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc
Date = " " .. Date .. OrigYear; -- Date does not begin with sepc
else
Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc
end
end
end
if is_set(Authors) then
if is_set(Coauthors) then
if 'vanc' == NameListFormat then -- separate authors and coauthors with proper name-list-separator
Authors = Authors .. ', ' .. Coauthors;
else
else
Authors = last_first_list; -- either an author name list or an empty string
Authors = Authors .. '; ' .. Coauthors;
end
end
end -- end of do
if utilities.is_set (Authors) and utilities.is_set (Collaboration) then
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
end
end
 
if (not is_set (Date)) or ('mla' == Mode) then -- when date is set it's in parentheses; no Authors termination
end
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
 
end
local ConferenceFormat = A['ConferenceFormat'];
if is_set(Editors) then
local ConferenceURL = A['ConferenceURL'];
local in_text = " ";
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
local post_text = "";
Format = style_format (Format, URL, 'format', 'url');
if is_set(Chapter) and 0 == #c and 'mla' ~= Mode then
 
in_text = in_text .. cfg.messages['in'] .. " "
-- special case for chapter format so no error message or cat when chapter not supported
if (sepc ~= '.') then in_text = in_text:lower() end -- lowercase for cs2
if not (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or
elseif is_set(Chapter) and 'mla' == Mode then
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia))) then
if EditorCount <= 1 then
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
in_text = '. Ed. ';
end
else
 
in_text = '. Eds. ';
if not utilities.is_set (URL) then
end
if utilities.in_array (config.CitationClass, {"web", "podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist
else
('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website=
if EditorCount <= 1 then
utilities.set_message ('err_cite_web_url');
post_text = ", " .. cfg.messages['editor'];
else
post_text = ", " .. cfg.messages['editors'];
end
end
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
end
end
if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc
-- do we have |accessdate= without either |url= or |chapter-url=?
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set;
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
utilities.set_message ('err_accessdate_missing_url');
Authors = by_text .. Authors; -- author follows title so tweak it here
AccessDate = '';
if is_set (Editors) and ('mla' ~= Mode)then -- when Editors make sure that Authors gets terminated
end
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
end
end
 
if (not is_set (Date)) or ('mla' == Mode) then -- when date is set it's in parentheses; no Contributors termination
local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
local OriginalURL
local OriginalURL_origin
local OriginalFormat
local OriginalAccess;
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
if utilities.is_set ( ArchiveURL ) then
if utilities.is_set (ChapterURL) then -- if chapter-url= is set apply archive url to it
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
OriginalURL_origin = ChapterURL_origin; -- name of |chapter-url= parameter for error messages
OriginalFormat = ChapterFormat; -- and original |chapter-format=
 
if 'live' ~= UrlStatus then
ChapterURL = ArchiveURL -- swap-in the archive's URL
ChapterURL_origin = A:ORIGIN('ArchiveURL') -- name of |archive-url= parameter for error messages
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs
end
end
elseif utilities.is_set (URL) then
if 'mla' == Mode then
OriginalURL = URL; -- save copy of original source URL
text = safe_join( {Contributors, Chapter, tcommon, OrigYear, Authors, Place, Others, Editors, tcommon2, Date, pgtext, idcommon }, sepc );
OriginalURL_origin = URL_origin; -- name of URL parameter for error messages
else
OriginalFormat = Format; -- and original |format=
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
OriginalAccess = UrlAccess;
 
if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it
URL = ArchiveURL -- swap-in the archive's URL
URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages
Format = ArchiveFormat or ''; -- swap in archive's format
UrlAccess = nil; -- restricted access levels do not make sense for archived URLs
end
end
elseif 'mla' == Mode then
tcommon = tcommon .. Date; -- hack to avoid duplicate separators
text = safe_join( {Authors, Chapter, Title, OrigYear, Others, Editors, Edition, Place, tcommon, pgtext, idcommon }, sepc );
else
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
end
end
elseif utilities.is_set (UrlStatus) then -- if |url-status= is set when |archive-url= is not set
elseif is_set(Editors) then
utilities.set_message ('maint_url_status'); -- add maint cat
if is_set(Date) then
end
if EditorCount <= 1 then
 
Editors = Editors .. ", " .. cfg.messages['editor'];
if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
else
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) then
Editors = Editors .. ", " .. cfg.messages['editors'];
local chap_param;
if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = A:ORIGIN ('Chapter')
elseif utilities.is_set (TransChapter) then
chap_param = A:ORIGIN ('TransChapter')
elseif utilities.is_set (ChapterURL) then
chap_param = A:ORIGIN ('ChapterURL')
elseif utilities.is_set (ScriptChapter) then
chap_param = ScriptChapter_origin;
else utilities.is_set (ChapterFormat)
chap_param = A:ORIGIN ('ChapterFormat')
end
end
 
else
if utilities.is_set (chap_param) then -- if we found one
if EditorCount <= 1 then
utilities.set_message ('err_chapter_ignored', {chap_param}); -- add error message
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
Chapter = ''; -- and set them to empty string to be safe with concatenation
else
TransChapter = '';
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
ChapterURL = '';
ScriptChapter = '';
ChapterFormat = '';
end
else -- otherwise, format chapter / article title
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
end
end
end
end
 
if 'mla' == Mode then
Chapter = format_chapter_title (ScriptChapter, ScriptChapter_origin, Chapter, Chapter_origin, TransChapter, TransChapter_origin, ChapterURL, ChapterURL_origin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
if in_array(config.CitationClass, {'journal', 'news', 'web'}) and is_set(Periodical) then
if utilities.is_set (Chapter) then
text = safe_join( {Editors, Title, Place, tcommon, pgtext, Date, idcommon}, sepc );
Chapter = Chapter .. ChapterFormat ;
else
if 'map' == config.CitationClass and utilities.is_set (TitleType) then
text = safe_join( {Editors, Chapter, Title, Place, tcommon, Date, pgtext, idcommon}, sepc );
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
end
Chapter = Chapter .. sepc .. ' ';
else
elseif utilities.is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ...
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc );
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it
end
end
end
elseif 'mla' == Mode then
 
if in_array(config.CitationClass, {'journal', 'news', 'web'}) and is_set(Periodical) then
-- Format main title
text = safe_join( {Title, Place, tcommon, pgtext, Date, idcommon}, sepc );
local plain_title = false;
else
local accept_title;
text = safe_join( {Chapter, Title, Place, tcommon, Date, pgtext, idcommon}, sepc );
Title, accept_title = utilities.has_accept_as_written (Title, true); -- remove accept-this-as-written markup when it wraps all of <Title>
if accept_title and ('' == Title) then -- only support forced empty for now "(())"
Title = cfg.messages['notitle']; -- replace by predefined "No title" message
-- TODO: utilities.set_message ( 'err_redundant_parameters', ...); -- issue proper error message instead of muting
ScriptTitle = ''; -- just mute for now
TransTitle = ''; -- just mute for now
plain_title = true; -- suppress text decoration for descriptive title
utilities.set_message ('maint_untitled'); -- add maint cat
end
 
if not accept_title then -- <Title> not wrapped in accept-as-written markup
if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title=
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 ...
not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.)
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
 
else
if utilities.is_set (ArchiveURL) and is_archived_copy (Title) then
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
utilities.set_message ('maint_archived_copy'); -- add maintenance category before we modify the content of Title
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
end
else
 
text = safe_join( {Chapter, Place, tcommon, Date, pgtext, idcommon}, sepc );
if is_generic ('generic_titles', Title) then
utilities.set_message ('err_generic_title'); -- set an error message
end
end
end
end
if is_set(PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
text = text:sub(1,-sepc:len()-1);
end
text = safe_join( {text, PostScript}, sepc );


if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'document', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or
-- Now enclose the whole thing in a <cite/> element
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) or
local options = {};
('map' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)))) 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
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
Title = utilities.wrap_style ('quoted-title', Title);
options.class = config.CitationClass;
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref=
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle );
elseif plain_title or ('report' == config.CitationClass) then -- no styling for cite report and descriptive titles (otherwise same as above)
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
else
else
Title = utilities.wrap_style ('italic-title', Title);
options.class = "citation";
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle);
end
 
if utilities.is_set (TransTitle) then
if utilities.is_set (Title) then
TransTitle = " " .. TransTitle;
else
utilities.set_message ('err_trans_missing_title', {'title'});
end
end
end
if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate
local id = Ref
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 utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs?
if #c > 0 then -- if there is a contributor list
if utilities.is_set (TitleLink) and utilities.is_set (URL) then
namelist = c; -- select it
utilities.set_message ('err_wikilink_in_url'); -- set an error message because we can't have both
elseif #a > 0 then -- or an author list
TitleLink = ''; -- unset
namelist = a;
end
elseif #e > 0 then -- or an editor list
namelist = e;
if not utilities.is_set (TitleLink) and utilities.is_set (URL) then
Title = external_link (URL, Title, URL_origin, UrlAccess) .. TransTitle .. Format;
URL = ''; -- unset these because no longer needed
Format = "";
elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then
local ws_url;
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
if ws_url then
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
Title = Title .. TransTitle;
else
Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle;
end
end
else
if #namelist > 0 then -- if there are names in namelist
local ws_url, ws_label, L; -- Title has italic or quote markup by the time we get here which causes is_wikilink() to return 0 (not a wikilink)
id = anchor_id (namelist, year); -- go make the CITEREF anchor
ws_url, ws_label, L = wikisource_url_make (Title:gsub('^[\'"]*(.-)[\'"]*$', '%1')); -- make ws URL from |title= interwiki link (strip italic or quote markup); link portion L becomes tooltip label
if ws_url then
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
Title = Title .. TransTitle;
else
else
Title = Title .. TransTitle;
id = ''; -- unset
end
end
end
end
else
options.id = id;
Title = TransTitle;
end
end
 
if utilities.is_set (Place) then
if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>","")) <= 2 then -- remove <span> tags and other html-like markup; then get length of what remains
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
z.error_categories = {};
text = set_error('empty_citation');
z.message_tail = {};
end
end
if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
text = substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text}); -- when |ref= is set
else
text = substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text}); -- all other cases
end


local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
text = text .. substitute (cfg.presentation['ocins'], {OCinSoutput}); -- append metadata to the citation
if utilities.is_set (Conference) then
if utilities.is_set (ConferenceURL) then
if #z.message_tail ~= 0 then
Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil );
text = text .. " ";
for i,v in ipairs( z.message_tail ) do
if is_set(v[1]) then
if i == #z.message_tail then
text = text .. error_comment( v[1], v[2] );
else
text = text .. error_comment( v[1] .. "; ", v[2] );
end
end
end
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif utilities.is_set (ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil );
end
end


local Position = '';
if #z.maintenance_cats ~= 0 then
if not utilities.is_set (Position) then
text = text .. '<span class="citation-comment" style="display:none; color:#33aa33; margin-left:0.3em">';
local Minutes = A['Minutes'];
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
local Time = A['Time'];
text = text .. v .. ' ([[:Category:' .. v ..'|link]])';
 
if utilities.is_set (Minutes) then
if utilities.is_set (Time) then --TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'minutes') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'time')});
end
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
else
if utilities.is_set (Time) then
local TimeCaption = A['TimeCaption']
if not utilities.is_set (TimeCaption) then
TimeCaption = cfg.messages['event'];
if sepc ~= '.' then
TimeCaption = TimeCaption:lower();
end
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
end
else
text = text .. '</span>'; -- maintenance mesages (realy just the names of the categories for now)
Position = " " .. Position;
At = '';
end
end
 
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);
no_tracking_cats = no_tracking_cats:lower();
 
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
At = utilities.is_set (At) and (sepc .. " " .. At) or "";
for _, v in ipairs( z.error_categories ) do
Position = utilities.is_set (Position) and (sepc .. " " .. Position) or "";
text = text .. '[[Category:' .. v ..']]';
if config.CitationClass == 'map' then
end
local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
local Inset = A['Inset'];
text = text .. '[[Category:' .. v ..']]';
if utilities.is_set ( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end
 
if utilities.is_set ( Sections ) then
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
elseif utilities.is_set ( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
end
end
At = At .. Inset .. Section;
for _, v in ipairs( z.properties_cats ) do -- append maintenance categories
end
text = text .. '[[Category:' .. v ..']]';
 
local Others = A['Others'];
if utilities.is_set (Others) and 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
if config.CitationClass == "AV-media-notes"
or config.CitationClass == "audio-visual" then -- special maint for AV/M which has a lot of 'false' positives right now
utilities.set_message ('maint_others_avm')
else
utilities.set_message ('maint_others');
end
end
end
end
Others = utilities.is_set (Others) and (sepc .. " " .. Others) or "";
if utilities.is_set (Translators) then
return text
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc);
end
end
 
if utilities.is_set (Interviewers) then
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc);
end
local TitleNote = A['TitleNote'];
TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or "";
if utilities.is_set (Edition) then
if Edition:match ('%f[%a][Ee]d%n?%.?$') or Edition:match ('%f[%a][Ee]dition$') then -- Ed, ed, Ed., ed., Edn, edn, Edn., edn.
utilities.set_message ('err_extra_text_edition'); -- add error message
end
Edition = " " .. wrap_msg ('edition', Edition);
else
Edition = '';
end


Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
--[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------
local Agency = A['Agency'] or ''; -- |agency= is supported by {{cite magazine}}, {{cite news}}, {{cite press release}}, {{cite web}}, and certain {{citation}} templates
if utilities.is_set (Agency) then -- this testing done here because {{citation}} supports 'news' citations
if utilities.in_array (config.CitationClass, {'magazine', 'news', 'pressrelease', 'web'}) or ('citation' == config.CitationClass and utilities.in_array (Periodical_origin, {"magazine", "newspaper", "work"})) then
Agency = wrap_msg ('agency', {sepc, Agency}); -- format for rendering
else
Agency = ''; -- unset; not supported
utilities.set_message ('err_parameter_ignored', {'agency'}); -- add error message
end
end
Volume = format_volume_issue (Volume, Issue, ArticleNumber, config.CitationClass, Periodical_origin, sepc, use_lowercase);


if utilities.is_set (AccessDate) then
This is used by templates such as {{cite book}} to create the actual citation text.
local retrv_text = " " .. cfg.messages['retrieved']


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
AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text


AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
function cs1.citation(frame)
Frame = frame; -- save a copy incase we need to display an error message in preview mode
local pframe = frame:getParent()
local validation, utilities, identifiers, metadata;
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');
validation = require ('Module:Citation/CS1/Date_validation/sandbox');
identifiers = require ('Module:Citation/CS1/Identifiers/sandbox');
metadata = require ('Module:Citation/CS1/COinS/sandbox');
else -- otherwise
cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load live versions of support modules
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist');
utilities = require ('Module:Citation/CS1/Utilities');
validation = require ('Module:Citation/CS1/Date_validation');
identifiers = require ('Module:Citation/CS1/Identifiers');
metadata = require ('Module:Citation/CS1/COinS');
end
end
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
validation.set_selected_modules (utilities); -- so that functions in Date validataion can see 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
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;
if utilities.is_set (ID) then ID = sepc .. " " .. ID; end
is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities
in_array = utilities.in_array;
local Docket = A['Docket'];
substitute = utilities.substitute;
  if "thesis" == config.CitationClass and utilities.is_set (Docket) then
error_comment = utilities.error_comment;
ID = sepc .. " Docket " .. Docket .. ID;
set_error = utilities.set_error;
end
select_one = utilities.select_one;
  if "report" == config.CitationClass and utilities.is_set (Docket) then -- for cite report when |docket= is set
add_maint_cat = utilities.add_maint_cat;
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set
wrap_style = utilities.wrap_style;
end
safe_for_italics = utilities.safe_for_italics;
remove_wiki_link = utilities.remove_wiki_link;
 
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities


if utilities.is_set (URL) then
extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Utilities
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
build_id_list = identifiers.build_id_list;
end
is_embargoed = identifiers.is_embargoed;
extract_id_access_levels = identifiers.extract_id_access_levels;
-- We check length of PostScript here because it will have been nuked by
make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS
-- the quote parameters. We'd otherwise emit a message even if there wasn't
get_coins_pages = metadata.get_coins_pages;
-- a displayed postscript.
COinS = metadata.COinS;
-- TODO: Should the max size (1) be configurable?
 
-- TODO: Should we check a specific pattern?
local args = {};
if utilities.is_set(PostScript) and mw.ustring.len(PostScript) > 1 then
local suggestions = {};
utilities.set_message ('maint_postscript')
local error_text, error_state;
end
 
local config = {};
local Archived;
for k, v in pairs( frame.args ) do
if utilities.is_set (ArchiveURL) then
config[k] = v;
if not utilities.is_set (ArchiveDate) then -- ArchiveURL set but ArchiveDate not set
args[k] = v;  
utilities.set_message ('err_archive_missing_date'); -- emit an error message
end
ArchiveURL = ''; -- empty string for concatenation
ArchiveDate = ''; -- empty string for concatenation
end
else
if utilities.is_set (ArchiveDate) then -- ArchiveURL not set but ArchiveDate is set
utilities.set_message ('err_archive_date_missing_url'); -- emit an error message
ArchiveURL = ''; -- empty string for concatenation
ArchiveDate = ''; -- empty string for concatenation
end
end


if utilities.is_set (ArchiveURL) then
local capture; -- the single supported capture when matching unknown parameters using patterns
local arch_text;
for k, v in pairs( pframe.args ) do
if "live" == UrlStatus then
if v ~= '' then
arch_text = cfg.messages['archived'];
if not validate( k, config.CitationClass ) then
if sepc ~= "." then arch_text = arch_text:lower() end
error_text = "";
if utilities.is_set (ArchiveDate) then
if type( k ) ~= 'string' then
Archived = sepc .. ' ' .. utilities.substitute ( cfg.messages['archived-live'],
-- Exclude empty numbered parameters
{external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil) .. ArchiveFormat, ArchiveDate } );
if v:match("%S+") ~= nil then
else
error_text, error_state = set_error( 'text_ignored', {v}, true );
Archived = '';
end
end
elseif validate( k:lower(), config.CitationClass ) then  
if not utilities.is_set (OriginalURL) then
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true );
utilities.set_message ('err_archive_missing_url');
Archived = ''; -- empty string for concatenation
end
elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
arch_text = cfg.messages['archived-unfit'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. ' ' .. arch_text .. ArchiveDate; -- format already styled
if 'bot: unknown' == UrlStatus then
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
else
else
utilities.add_prop_cat ('unfit'); -- and add a category if not already added
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
end
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
else -- UrlStatus is empty, 'dead'
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version
arch_text = cfg.messages['archived-dead'];
else
if sepc ~= "." then arch_text = arch_text:lower() end
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version
if utilities.is_set (ArchiveDate) then
end
Archived = sepc .. " " .. utilities.substitute ( arch_text,
{ external_link( OriginalURL, cfg.messages['original'], OriginalURL_origin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
else
Archived = ''; -- unset for concatenation
end
end
else -- OriginalUrl not set
utilities.set_message ('err_archive_missing_url');
Archived = ''; -- empty string for concatenation
end
elseif utilities.is_set (ArchiveFormat) then
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
else
Archived = '';
end
local TranscriptURL = A['TranscriptURL']
local TranscriptFormat = A['TranscriptFormat'];
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');
local Transcript = A['Transcript'];
local TranscriptURL_origin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
if utilities.is_set (Transcript) then
if utilities.is_set (TranscriptURL) then
Transcript = external_link( TranscriptURL, Transcript, TranscriptURL_origin, nil );
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif utilities.is_set (TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil );
end
 
local Publisher;
if utilities.is_set (PublicationDate) then
PublicationDate = wrap_msg ('published', PublicationDate);
end
if utilities.is_set (PublisherName) then
if utilities.is_set (PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
else
Publisher = sepc .. " " .. PublisherName .. PublicationDate; 
end
elseif utilities.is_set (PublicationPlace) then
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
else
Publisher = PublicationDate;
end
-- Several of the above rely upon detecting this as nil, so do it last.
if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then
if utilities.is_set (Title) or utilities.is_set (TitleNote) then
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
else
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
end
end
local Language = A['Language'];
if utilities.is_set (Language) then
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
 
--[[
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).
]]
if "speech" == config.CitationClass then -- cite speech only
TitleNote = TitleType; -- move TitleType to TitleNote so that it renders ahead of |event=
TitleType = ''; -- and unset
 
if utilities.is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
if utilities.is_set (Conference) then -- and if |event= is set
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
end
end
end
 
-- Piece all bits together at last.  Here, all should be non-nil.
-- We build things this way because it is more efficient in LUA
-- not to keep reassigning to the same string variable over and over.
 
local tcommon;
local tcommon2; -- used for book cite when |contributor= is set
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites
if utilities.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
tcommon2 = safe_join ({TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc);
else
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc);
end
 
elseif 'map' == config.CitationClass then -- special cases for cite map
if utilities.is_set (Chapter) then -- map in a book; TitleType is part of Chapter
tcommon = safe_join ({Title, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc);
elseif utilities.is_set (Periodical) then -- map in a periodical
tcommon = safe_join ({Title, TitleType, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc);
else -- a sheet or stand-alone map
tcommon = safe_join ({Title, TitleType, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc);
end
elseif 'episode' == config.CitationClass then -- special case for cite episode
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Edition, Publisher}, sepc);
 
else -- all other CS1 templates
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc);
end
if #ID_list > 0 then
ID_list = safe_join( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
else
ID_list = ID;
end
local Via = A['Via'];
Via = utilities.is_set (Via) and  wrap_msg ('via', Via) or '';
local idcommon;
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, Quote }, sepc );
else
idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Quote }, sepc );
end
local text;
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
 
local OrigDate = A['OrigDate'];
OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or '';
if utilities.is_set (Date) then
if utilities.is_set (Authors) or utilities.is_set (Editors) then -- date follows authors or editors when authors not set
Date = " (" .. Date .. ")" .. OrigDate .. sepc .. " "; -- in parentheses
else -- neither of authors and editors set
if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc
Date = " " .. Date .. OrigDate; -- Date does not begin with sepc
else
Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc
end
end
end
if utilities.is_set (Authors) then
if (not utilities.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
end
if utilities.is_set (Editors) then
local in_text = '';
local post_text = '';
if utilities.is_set (Chapter) and 0 == #c then
in_text = cfg.messages['in'] .. ' ';
if (sepc ~= '.') then
in_text = in_text:lower(); -- lowercase for cs2
end
end
if EditorCount <= 1 then
post_text = ' (' .. cfg.messages['editor'] .. ')'; -- be consistent with no-author, no-date case
else
post_text = ' (' .. cfg.messages['editors'] .. ')';
end
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
end
if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc.
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
Authors = by_text .. Authors; -- author follows title so tweak it here
if utilities.is_set (Editors) and utilities.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
end
if (not utilities.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
end
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
else
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
end
elseif utilities.is_set (Editors) then
if utilities.is_set (Date) then
if EditorCount <= 1 then
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editor'];
else
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editors'];
end
else
if EditorCount <= 1 then
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
else
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc );
else
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
else
text = safe_join( {Chapter, Place, tcommon, Date, pgtext, idcommon}, sepc );
end
end
 
if utilities.is_set (PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc ); -- Deals with italics, spaces, etc.
if '.' == sepc then -- remove final seperator if present
text = text:gsub ('%' .. sepc .. '$', ''); -- dot must be escaped here
else
text = mw.ustring.gsub (text, sepc .. '$', ''); -- using ustring for non-dot sepc (likely a non-Latin character)
end
end
text = safe_join( {text, PostScript}, sepc );
 
-- Now enclose the whole thing in a <cite> element
local options_t = {};
options_t.class = cite_class_attribute_make (config.CitationClass, Mode);
 
local Ref = is_valid_parameter_value (A['Ref'], A:ORIGIN('Ref'), cfg.keywords_lists['ref'], nil, true); -- nil when |ref=harv; A['Ref'] else
 
if 'none' ~= cfg.keywords_xlate[(Ref and Ref:lower()) or ''] then
local namelist_t = {}; -- 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_t = c; -- select it
elseif #a > 0 then -- or an author list
namelist_t = a;
elseif #e > 0 then -- or an editor list
namelist_t = e;
end
local citeref_id;
if #namelist_t > 0 then -- if there are names in namelist_t
citeref_id = make_citeref_id (namelist_t, year); -- go make the CITEREF anchor
if mw.uri.anchorEncode (citeref_id) == ((Ref and mw.uri.anchorEncode (Ref)) or '') then -- Ref may already be encoded (by {{sfnref}}) so citeref_id must be encoded before comparison
utilities.set_message ('maint_ref_duplicates_default');
end
else
citeref_id = ''; -- unset
end
options_t.id = Ref or citeref_id;
end
 
if string.len (text:gsub('%b<>', '')) <= 2 then -- remove html and html-like tags; then get length of what remains;
z.error_cats_t = {}; -- blank the categories list
z.error_msgs_t = {}; -- blank the error messages list
OCinSoutput = nil; -- blank the metadata string
text = ''; -- blank the the citation
utilities.set_message ('err_empty_citation'); -- set empty citation message and category
end
local render_t = {}; -- here we collect the final bits for concatenation into the rendered citation
 
if utilities.is_set (options_t.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
table.insert (render_t, utilities.substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options_t.id), mw.text.nowiki(options_t.class), text})); -- when |ref= is set or when there is a namelist
else
table.insert (render_t, utilities.substitute (cfg.presentation['cite'], {mw.text.nowiki(options_t.class), text})); -- when |ref=none or when namelist_t empty and |ref= is missing or is empty
end
 
if OCinSoutput then -- blanked when citation is 'empty' so don't bother to add boilerplate metadata span
table.insert (render_t, utilities.substitute (cfg.presentation['ocins'], OCinSoutput)); -- format and append metadata to the citation
end
 
local template_name = ('citation' == config.CitationClass) and 'citation' or 'cite ' .. (cfg.citation_class_map_t[config.CitationClass] or config.CitationClass);
local template_link = '[[Template:' .. template_name .. '|' .. template_name .. ']]';
local msg_prefix = '<code class="cs1-code">{{' .. template_link .. '}}</code>: ';
 
if 0 ~= #z.error_msgs_t then
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_e, template_link));
 
table.insert (render_t, ' '); -- insert a space between citation and its error messages
table.sort (z.error_msgs_t); -- sort the error messages list; sorting includes wrapping <span> and <code> tags; hidden-error sorts ahead of visible-error
 
local hidden = true; -- presume that the only error messages emited by this template are hidden
for _, v in ipairs (z.error_msgs_t) do -- spin through the list of error messages
if v:find ('cs1-visible-error', 1, true) then -- look for the visible error class name
hidden = false; -- found one; so don't hide the error message prefix
break; -- and done because no need to look further
end
end
 
z.error_msgs_t[1] = table.concat ({utilities.error_comment (msg_prefix, hidden), z.error_msgs_t[1]}); -- add error message prefix to first error message to prevent extraneous punctuation
table.insert (render_t, table.concat (z.error_msgs_t, '; ')); -- make a big string of error messages and add it to the rendering
end
 
if 0 ~= #z.maint_cats_t then
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_m, template_link));
 
table.sort (z.maint_cats_t); -- sort the maintenance messages list
 
local maint_msgs_t = {}; -- here we collect all of the maint messages
 
if 0 == #z.error_msgs_t then -- if no error messages
table.insert (maint_msgs_t, msg_prefix); -- insert message prefix in maint message livery
end
for _, v in ipairs( z.maint_cats_t ) do -- append maintenance categories
table.insert (maint_msgs_t, -- assemble new maint message and add it to the maint_msgs_t table
table.concat ({v, ' (', utilities.substitute (cfg.messages[':cat wikilink'], v), ')'})
);
end
table.insert (render_t, utilities.substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs_t, ' '))); -- wrap the group of maint messages with proper presentation and save
end
 
if not no_tracking_cats then
local sort_key;
local cat_wikilink = 'cat wikilink';
if cfg.enable_sort_keys then -- when namespace sort keys enabled
local namespace_number = mw.title.getCurrentTitle().namespace; -- get namespace number for this wikitext
sort_key = (0 ~= namespace_number and (cfg.name_space_sort_keys[namespace_number] or cfg.name_space_sort_keys.other)) or nil; -- get sort key character; nil for mainspace
cat_wikilink = (not sort_key and 'cat wikilink') or 'cat wikilink sk'; -- make <cfg.messages> key
end
 
for _, v in ipairs (z.error_cats_t) do -- append error categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
if cfg.id_limits_data_load_fail then -- boolean true when load failed
utilities.set_message ('maint_id_limit_load_fail'); -- done here because this maint cat emits no message
end
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v)); -- no sort keys
end
end
 
return table.concat (render_t); -- make a big string and done
end
 
 
--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
 
Looks for a parameter's name in one of several whitelists.
 
Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
]]
 
local function validate (name, cite_class, empty)
local name = tostring (name);
local enum_name; -- parameter name with enumerator (if any) replaced with '#'
local state;
local function state_test (state, name) -- local function to do testing of state values
if true == state then return true; end -- valid actively supported parameter
if false == state then
if empty then return nil; end -- empty deprecated parameters are treated as unknowns
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end
if 'tracked' == state then
local base_name = name:gsub ('%d', ''); -- strip enumerators from parameter names that have them to get the base name
utilities.add_prop_cat ('tracked-param', {base_name}, base_name); -- add a properties category; <base_name> modifies <key>
return true;
end
return nil;
end
 
if name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted
return nil;
end
-- replace enumerator digit(s) with # (|last25= becomes |last#=) (mw.ustring because non-Western 'local' digits)
enum_name = mw.ustring.gsub (name, '%d+$', '#'); -- where enumerator is last charaters in parameter name (these to protect |s2cid=)
enum_name = mw.ustring.gsub (enum_name, '%d+([%-l])', '#%1'); -- where enumerator is in the middle of the parameter name; |author#link= is the oddity
 
if 'document' == cite_class then -- special case for {{cite document}}
state = whitelist.document_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
if true == state_test (state, name) then return true; end
return false;
end
 
if utilities.in_array (cite_class, whitelist.preprint_template_list_t) then -- limited parameter sets allowed for these templates
state = whitelist.limited_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
if true == state_test (state, name) then return true; end
 
state = whitelist.preprint_arguments_t[cite_class][name]; -- look in the parameter-list for the template identified by cite_class
if true == state_test (state, name) then return true; end
 
return false; -- not supported because not found or name is set to nil
end -- end limited parameter-set templates
 
if utilities.in_array (cite_class, whitelist.unique_param_template_list_t) then -- template-specific parameters for templates that accept parameters from the basic argument list
state = whitelist.unique_arguments_t[cite_class][name]; -- look in the template-specific parameter-lists for the template identified by cite_class
if true == state_test (state, name) then return true; end
end -- if here, fall into general validation
 
state = whitelist.common_parameters_t[enum_name]; -- all other templates; all normal parameters allowed; this list holds enumerated and nonenumerated parameters
if true == state_test (state, name) then return true; end
 
return false; -- not supported because not found or name is set to nil
end
 
 
--[=[-------------------------< I N T E R _ W I K I _ C H E C K >----------------------------------------------
 
check <value> for inter-language interwiki-link markup.  <prefix> must be a MediaWiki-recognized language
code.  when these values have the form (without leading colon):
[[<prefix>:link|label]] return label as plain-text
[[<prefix>:link]] return <prefix>:link as plain-text
 
return value as is else
 
]=]
 
local function inter_wiki_check (parameter, value)
local prefix = value:match ('%[%[(%a+):'); -- get an interwiki prefix if one exists
local _;
if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so
utilities.set_message ('err_bad_paramlink', parameter); -- emit an error message
_, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink
end
return value;
end
 
 
--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------
 
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
parameter that is missing its pipe.  There are two tests made:
{{cite ... |title=Title access-date=2016-03-17}} -- the first parameter has a value and whitespace separates that value from the missing pipe parameter name
{{cite ... |title=access-date=2016-03-17}} -- the first parameter has no value (whitespace after the first = is trimmed by MediaWiki)
cs1|2 shares some parameter names with XML/HTML attributes: class=, title=, etc.  To prevent false positives XML/HTML
tags are removed before the search.
 
If a missing pipe is detected, this function adds the missing pipe maintenance category.
 
]]
 
local function missing_pipe_check (parameter, value)
local capture;
value = value:gsub ('%b<>', ''); -- remove XML/HTML tags because attributes: class=, title=, etc.
 
capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
if capture and validate (capture) then -- if the capture is a valid parameter name
utilities.set_message ('err_missing_pipe', parameter);
end
end
 
 
--[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >--------------------------------------
 
look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked
 
]]
 
local function has_extraneous_punc (param, value)
if 'number' == type (param) then
return;
end
param = param:gsub ('%d+', '#'); -- enumerated name-list mask params allow terminal punct; normalize
if cfg.punct_skip[param] then
return; -- parameter name found in the skip table so done
end
if value:match ('[,;:]$') then
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
end
if value:match ('^=') then -- sometimes an extraneous '=' character appears ...
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
end
end
 
 
--[[--------------------------< H A S _ T W L _ U R L >--------------------------------------------------------
 
look for The Wikipedia Library urls in url-holding parameters.  TWL urls are accessible for readers who are not
active extended confirmed Wikipedia editors.  This function emits an error message when such urls are discovered.
 
looks for: '.wikipedialibrary.idm.oclc.org'
 
]]
 
local function has_twl_url (url_params_t)
local url_error_t = {}; -- sequence of url-holding parameters that have a TWL url
for param, value in pairs (url_params_t) do
if value:find ('%.wikipedialibrary%.idm%.oclc%.org') then -- has the TWL base url?
table.insert (url_error_t, utilities.wrap_style ('parameter', param)); -- add parameter name to the list
end
end
if 0 ~= #url_error_t then -- non-zero when there are errors
table.sort (url_error_t);
utilities.set_message ('err_param_has_twl_url', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
return true;
end
end
 
 
--[[--------------------------< H A S _ E X T R A N E O U S _ U R L >------------------------------------------
 
look for extraneous url parameter values; parameters listed in skip table are not checked
 
]]
 
local function has_extraneous_url (non_url_param_t)
local url_error_t = {};
check_for_url (non_url_param_t, url_error_t); -- extraneous url check
if 0 ~= #url_error_t then -- non-zero when there are errors
table.sort (url_error_t);
utilities.set_message ('err_param_has_ext_link', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
end
end
 
 
--[[--------------------------< _ C I T A T I O N >------------------------------------------------------------
 
Module entry point
 
frame – from template call (citation()); may be nil when called from another module
args – table of all cs1|2 parameters in the template (the template frame)
config – table of template-supplied parameter (the #invoke frame)
 
]]
 
local function _citation (frame, args, config) -- save a copy in case we need to display an error message in preview mode
if not frame then
frame = mw.getCurrentFrame(); -- if called from another module, get a frame for frame-provided functions
end
-- i18n: set the name that your wiki uses to identify sandbox subpages from sandbox template invoke (or can be set here)
local sandbox = ((config.SandboxPath and '' ~= config.SandboxPath) and config.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}}
is_sandbox = nil ~= string.find (frame:getTitle(), sandbox, 1, true); -- is this invoke the sandbox module?
sandbox = is_sandbox and sandbox or ''; -- use i18n sandbox to load sandbox modules when this module is the sandox; live modules else
 
cfg = mw.loadData ('Module:Citation/CS1/Configuration' .. sandbox); -- load sandbox versions of support modules when {{#invoke:Citation/CS1/sandbox|...}}; live modules else
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist' .. sandbox);
utilities = require ('Module:Citation/CS1/Utilities' .. sandbox);
validation = require ('Module:Citation/CS1/Date_validation' .. sandbox);
identifiers = require ('Module:Citation/CS1/Identifiers' .. sandbox);
metadata = require ('Module:Citation/CS1/COinS' .. sandbox);
 
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
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
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module
 
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
 
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));
 
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local error_text; -- used as a flag
 
local capture; -- the single supported capture when matching unknown parameters using patterns
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
for k, v in pairs( args ) do -- get parameters from the parent (template) frame
v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string
if v ~= '' then
if ('string' == type (k)) then
k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- for enumerated parameters, translate 'local' digits to Western 0-9
end
if not validate( k, config.CitationClass ) then
if type (k) ~= 'string' then -- exclude empty numbered parameters
if v:match("%S+") ~= nil then
error_text = utilities.set_message ('err_text_ignored', {v});
end
elseif validate (k:lower(), config.CitationClass) then
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, k:lower()}); -- suggest the lowercase version of the parameter
else
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
suggestions = mw.loadData ('Module:Citation/CS1/Suggestions' .. sandbox); --load sandbox version of suggestion module when {{#invoke:Citation/CS1/sandbox|...}}; live module else
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 in pattern else the capture if a match
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 = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
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)
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, param}, true ); -- set the error message
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message
end
else
end
error_text = utilities.set_message ('err_parameter_ignored', {k}); -- suggested param not supported by this template
if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion?
v = ''; -- unset
if suggestions.suggestions[ k:lower() ] ~= nil then
end
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true );
else
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
end
end
end
end
if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an explicit suggestion?
end  
if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], config.CitationClass) then
if error_text ~= '' then
utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]});
table.insert( z.message_tail, {error_text, error_state} );
else
end
utilities.set_message ('err_parameter_ignored', {k});
end
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe?
end
end
args[k] = v;
end  
elseif args[k] ~= nil or (k == 'postscript') then
end
args[k] = v;
 
end
args[k] = v; -- save this parameter and its value
 
elseif not utilities.is_set (v) then -- for empty parameters
if not validate (k, config.CitationClass, true) then -- is this empty parameter a valid parameter
k = ('' == k) and '(empty string)' or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text
table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list
end
-- crude debug support that allows us to render a citation from module {{#invoke:}} TODO: keep?
-- elseif args[k] ~= nil or (k == 'postscript') then -- when args[k] has a value from {{#invoke}} frame (we don't normally do that)
-- args[k] = v; -- overwrite args[k] with empty string from pframe.args[k] (template frame); v is empty string here
end -- not sure about the postscript bit; that gets handled in parameter validation; historical artifact?
end
end
if 0 ~= #empty_unknowns then -- create empty unknown error message
utilities.set_message ('err_param_unknown_empty', {
1 == #empty_unknowns and '' or 's',
utilities.make_sep_list (#empty_unknowns, empty_unknowns)
});
end
local non_url_param_t = {}; -- table of parameters and values that are not url-holding parameters
local url_param_t = {}; -- table of url-holding paramters and their values


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); -- look for invisible characters
has_invisible_chars (k, v);
end
has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe?
args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label
 
if 'string' == type (k) then -- when parameter k is not positional
if not cfg.url_skip[k] then -- and not in url skip table
non_url_param_t[k] = v; -- make a parameter/value list for extraneous url check
else -- and is in url skip table (a url-holding parameter)
url_param_t[k] = v; -- make a parameter/value list to check for values that are The Wikipedia Library url
end
end
end
end
end
 
return citation0( config, args)
has_extraneous_url (non_url_param_t); -- look for url in parameter values where a url does not belong
if has_twl_url (url_param_t) then -- look for url-holding parameters that hold a The Wikipedia Library url
args['url-access'] = 'subscription';
end
return table.concat ({
frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1' .. sandbox .. '/styles.css'}),
citation0( config, args)
});
end
 
 
--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
 
Template entry point
 
]]
 
local function citation (frame)
local config_t = {}; -- table to store parameters from the module {{#invoke:}}
local args_t = frame:getParent().args; -- get template's preset parameters
 
for k, v in pairs (frame.args) do -- get parameters from the {{#invoke}} frame
config_t[k] = v;
-- args_t[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
end
return _citation (frame, args_t, config_t)
end
end


 
return cs1;
--[[--------------------------< E X P O R T E D  F U N C T I O N S >------------------------------------------
]]
 
return {
citation = citation, -- template entry point
_citation = _citation, -- module entry point
}
Retrieved from "https://breakintochat.com/wiki/Special:ComparePages"