Jump to content

Module:Citation/CS1: Difference between revisions

Module:Citation/CS1 (edit)

Revision as of 11:41, 21 May 2021

144,146 bytes added ,  4 years ago
m
21 revisions imported from wikipedia:Module:Citation/CS1: see Topic:Vtixlm0q28eo6jtf
m>Dragons flight
(sync to sandbox. Fixes publication-date issues, repeated "." in wikilink, and format on chapterurl.)
m (21 revisions imported from wikipedia:Module:Citation/CS1: see Topic:Vtixlm0q28eo6jtf)
 
(110 intermediate revisions by 16 users not shown)
Line 1: Line 1:
local z = {
    error_categories = {};
    message_tail = {};
}


-- Formats a hidden comment for error trapping not intended to be visible to readers
require('Module:No globals');
function hiddencomment( content )
 
    return '<span style="display: none;" class="citation-comment">' .. content .. '</span>';
--[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
each of these counts against the Lua upvalue limit
]]
 
local validation; -- functions in Module:Citation/CS1/Date_validation
 
local utilities; -- functions in Module:Citation/CS1/Utilities
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 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 >---------------
declare variables here that have page-wide scope that are not brought in from
other modules; that are created here and used here
]]
local added_deprecated_cat; -- Boolean flag so that the category is added only once
local added_discouraged_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 Frame; -- holds the module's frame table
 
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
 
Locates and returns the first set value in a table of values where the order established in the table,
left-to-right (or top-to-bottom), is the order in which the values are evaluated.  Returns nil if none are set.
 
This version replaces the original 'for _, val in pairs do' and a similar version that used ipairs.  With the pairs
version the order of evaluation could not be guaranteed.  With the ipairs version, a nil value would terminate
the for-loop before it reached the actual end of the list.
 
]]
 
local function first_set (list, count)
local i = 1;
while i <= count do -- loop through all items in list
if utilities.is_set( list[i] ) then
return list[i]; -- return the first set list member
end
i = i + 1; -- point to next
end
end
end


-- This returns a string with HTML character entities for wikitext markup characters.
 
function wikiescape(text)
--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------
    text = text:gsub( '[&\'%[%]{|}]', {   
 
            ['&'] = '&#38;',   
Adds a single Vancouver system error message to the template's output regardless of how many error actually exist.
            ["'"] = '&#39;',   
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
            ['['] = '&#91;',   
 
            [']'] = '&#93;',  
added_vanc_errs is a Boolean declared in page scope variables above
            ['{'] = '&#123;',  
 
            ['|'] = '&#124;',
]]
            ['}'] = '&#125;' } );
 
    return text;
local function add_vanc_error (source, position)
if added_vanc_errs then return end
added_vanc_errs = true; -- note that we've added this category
table.insert( z.message_tail, { utilities.set_message ( 'err_vancouver', {source, position}, true ) } );
end
end


-- Create an HTML tag
 
function createTag(t, frame)
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
    local name = t.name or "!-- --"
 
    local content = t.contents or ""
does this thing that purports to be a URI scheme seem to be a valid scheme?  The scheme is checked to see if it
    local attrs = {}
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
    for n,v in pairs(t.params) do
Scheme names consist of a sequence of characters beginning with a
        if (v) then
  letter and followed by any combination of letters, digits, plus
            table.insert(attrs, n .. "=\"" .. wikiescape(v) .. "\"")
  ("+"), period ("."), or hyphen ("-").
        else
 
            table.insert(attrs, n)
returns true if it does, else false
        end
 
    end
]]
    if ("" == content) then
 
        return "<" .. name .. " " .. table.concat(attrs, " ") .. "/>"
local function is_scheme (scheme)
    else
return scheme and scheme:match ('^%a[%a%d%+%.%-]*:'); -- true if scheme is set and matches the pattern
        return "<" .. name .. " " .. table.concat(attrs, " ") .. ">" .. content .. "</" .. name .. ">"
end
    end
 
 
--[=[-------------------------< I S _ D O M A I N _ N A M E >--------------------------------------------------
 
Does this thing that purports to be a domain name seem to be a valid domain name?
 
Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
BNF defined here: https://tools.ietf.org/html/rfc4234
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]]
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
the first and last characters the name may use letters, digits, and the hyphen.
 
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
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.
 
There are several tests:
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
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
two-character SL domains in gTLDs (where the gTLD is two or more letters)
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
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
 
]=]
 
local function is_domain_name (domain)
if not domain then
return false; -- if not set, abandon
end
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
return false;
end
 
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource
return false;
end
 
local patterns = { -- patterns that look like URLs
'%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
}
 
for _, pattern in ipairs (patterns) do -- loop through the patterns list
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 ({'cash', 'company', 'today', 'org'}) 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
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
wikilinks.
 
]]
 
local function is_url (scheme, domain)
if utilities.is_set (scheme) then -- if scheme is set check it and domain
return is_scheme (scheme) and is_domain_name (domain);
else
return is_domain_name (domain); -- scheme not set when URL is protocol-relative
end
end
end


--[[
 
This is a clone of mw.text.nowiki. When the mw.text library is installed,
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
this can be replaced by a call to that library.  
 
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(#).
 
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
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;
 
]]
]]
function nowiki( s )
    -- string.gsub is safe here, because we're only caring about ASCII chars
    s = string.gsub( s, '["&\'<=>%[%]{|}]', {
        ['"'] = '&#34;',
        ['&'] = '&#38;',
        ["'"] = '&#39;',
        ['<'] = '&#60;',
        ['='] = '&#61;',
        ['>'] = '&#62;',
        ['['] = '&#91;',
        [']'] = '&#93;',
        ['{'] = '&#123;',
        ['|'] = '&#124;',
        ['}'] = '&#125;',
    } )
    s = string.sub( string.gsub( '\n' .. s, '\n[#*:;]', {
        ["\n#"] = "\n&#35;",
        ["\n*"] = "\n&#42;",
        ["\n:"] = "\n&#58;",
        ["\n;"] = "\n&#59;",
    } ), 2 )
    s = string.gsub( s, '://', '&#58;//' )
    s = string.gsub( s, 'ISBN ', 'ISBN&#32;' )
    s = string.gsub( s, 'RFC ', 'RFC&#32;' )


    return s
local function split_url (url_str)
local scheme, authority, domain;
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
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
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;
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
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
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
end
return scheme, domain;
end
end


-- Formats a wiki style external link
 
function externallinkid(args)
--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------
    local sep = args.separator or "&nbsp;"
 
    args.suffix = args.suffix or ""
checks the content of |title-link=, |series-link=, |author-link=, etc. for properly formatted content: no wikilinks, no URLs
    local url_string = args.id
 
    if args.encode == true or args.encode == nil then
Link parameters are to hold the title of a Wikipedia article, so none of the WP:TITLESPECIALCHARACTERS are allowed:
        url_string = mw.uri.encode( url_string );
# < > [ ] | { } _
    end
except the underscore which is used as a space in wiki URLs and # which is used for section links
   
 
    return "[[" .. args.link .. "|" .. args.label .. "]]" .. sep .. "[" ..
returns false when the value contains any of these characters.
            args.prefix .. url_string .. args.suffix .. " " .. nowiki(args.id) .. "]"
 
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).
 
]]
 
local function link_param_ok (value)
local scheme, domain;
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
return false;
end
 
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
end
end


-- Formats a wiki style internal link
 
function internallinkid(args)
--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------
    local sep = args.separator or "&nbsp;"
 
    args.suffix = args.suffix or ""
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.
    return "[[" .. args.link .. "|" .. args.label .. "]]" .. sep .. "[[" ..
 
            args.prefix .. args.id .. args.suffix .. "|" .. nowiki(args.id) .. "]]"
|<title>= may be wiki-linked but not when |<param>-link= has a value. This function emits an error message when
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 orig;
if utilities.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
orig = lorig; -- identify the failing link parameter
elseif title:find ('%[%[') then -- check |title= for wikilink markup
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
 
if utilities.is_set (orig) then
link = ''; -- unset
table.insert( z.message_tail, { utilities.set_message ( 'err_bad_paramlink', orig)}); -- URL or wikilink in |title= with |title-link=;
end
return link; -- link if ok, empty string else
end
end


-- Formats a link to Amazon
 
function amazon(id, domain)
--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
    if ( nil == domain ) then  
 
        domain = "com"
Determines whether a URL string appears to be valid.
    elseif ( "jp" == domain or "uk" == domain ) then
 
        domain = "co." .. domain
First we test for space characters.  If any are found, return false.  Then split the URL into scheme and domain
    end
portions, or for protocol-relative (//example.com) URLs, just the domain.  Use is_url() to validate the two
    return externallinkid({link="Amazon Standard Identification Number",
portions of the URL.  If both are valid, or for protocol-relative if domain is valid, return true, else false.
        label="ASIN",prefix="//www.amazon."..domain.."/dp/",id=id,encode=false})
 
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
is at https://tools.ietf.org/html/rfc5536#section-3.1.4
 
]]
 
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
return false;
end
local scheme, domain;
 
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from URL;
if 'news:' == scheme then -- special case for newsgroups
return domain:match('^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$');
end
return is_url (scheme, domain); -- return true if value appears to be a valid URL
end
end


-- Formats a DOI and checks for DOI errors.
function doi(id, inactive)
    local cat = ""
   
    local text;
    if ( inactive ~= nil ) then
        text = "[[Digital object identifier|doi]]:" .. id;
        table.insert( z.error_categories, "Pages with DOIs inactive since " .. selectyear(inactive) );       
        inactive = " (inactive " .. inactive .. ")"
    else
        text = externallinkid({link="Digital object identifier",label="doi",
            prefix="http://dx.doi.org/",id=id,separator=":"})
        inactive = ""
    end
    if ( string.sub(id,1,3) ~= "10." ) then
        table.insert( z.error_categories, "Pages with DOI errors" );       
        cat = ' <span class="error">Bad DOI (expected "10." prefix) in code number</span>'
    end
    return text .. inactive .. cat
end


-- Escape sequences for content that will be used for URL descriptions
--[=[-------------------------< I S _ P A R A M E T E R _ E X T _ W I K I L I N K >----------------------------
function safeforurl( str )
 
    if str:match( "%[%[.-%]%]" ) ~= nil then  
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
        table.insert( z.error_categories, "Pages with citations having wikilinks embedded in URL titles" );
non-space characters following the opening bracket appear to be a URL.  The test will also find external wikilinks
        table.insert( z.message_tail, "Wikilink embedded in URL title" );
that use protocol-relative URLs. Also finds bare URLs.
    end
 
   
The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs.  The tests that
    return str:gsub( '[%[%]\n]', {  
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
        ['['] = '&#91;',
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
        [']'] = '&#93;',
is possible as might be [[en://Hus]].
        ['\n'] = ' ' } );
 
]=]
 
local function is_parameter_ext_wikilink (value)
local scheme, domain;
 
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+).*%]'));
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol-relative ext. wikilink: [//yyyyy.zzz]
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
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
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
else
return false; -- didn't find anything that is obviously a URL
end
 
return is_url (scheme, domain); -- return true if value appears to be a valid URL
end
 
 
--[[-------------------------< C H E C K _ F O R _ U R L >-----------------------------------------------------
 
loop through a list of parameters and their values.  Look at the value and if it has an external link, emit an error message.
 
]]
 
local function check_for_url (parameter_list)
local error_message = '';
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 utilities.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
if utilities.is_set (error_message) then -- done looping, if there is an error message, display it
table.insert( z.message_tail, { utilities.set_message ( 'err_param_has_ext_link', {error_message}, true ) } );
end
end
 
 
--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------
 
Escape sequences for content that will be used for URL descriptions
 
]]
 
local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then  
table.insert( z.message_tail, { utilities.set_message ( 'err_wikilink_in_url', {}, true ) } );
end
return str:gsub( '[%[%]\n]', {
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end
 
 
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
 
Format an external link with error checking
 
]]
 
local function external_link( URL, label, source, access)
local error_str = "";
local domain;
local path;
local base_url;
 
if not utilities.is_set ( label ) then
label = URL;
if utilities.is_set ( source ) then
error_str = utilities.set_message ( 'err_bare_url_missing_title', { utilities.wrap_style ('parameter', source) }, false, " " );
else
error( cfg.messages["bare_url_no_origin"] );
end
end
if not check_url( URL ) then
error_str = utilities.set_message ( 'err_bad_url', {utilities.wrap_style ('parameter', source)}, false, " " ) .. error_str;
end
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path
if path then -- if there is a path portion
path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); -- replace '[' and ']' with their percent-encoded values
URL = table.concat ({domain, path}); -- and reassemble
end
 
base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL
 
if utilities.is_set (access) then -- access level (subscription, registration, limited)
base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
end
return table.concat ({base_url, error_str});
end
 
 
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
 
Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
offending parameter name to the error message.  Only one error message is emitted regardless of the number of deprecated
parameters in the citation.
 
added_deprecated_cat is a Boolean declared in page scope variables above
 
]]
 
local function deprecated_parameter(name)
if not added_deprecated_cat then
added_deprecated_cat = true; -- note that we've added this category
table.insert( z.message_tail, { utilities.set_message ( 'err_deprecated_params', {name}, true ) } ); -- add error message
end
end
 
 
--[[--------------------------< D I S C O U R A G E D _ P A R A M E T E R >------------------------------------
 
Categorize and emit an maintenance message when the citation contains one or more discouraged parameters.  Only
one error message is emitted regardless of the number of discouraged parameters in the citation.
 
added_discouraged_cat is a Boolean declared in page scope variables above
 
]]
 
local function discouraged_parameter(name)
if not added_discouraged_cat then
added_discouraged_cat = true; -- note that we've added this category
table.insert( z.message_tail, { utilities.set_message ( 'maint_discouraged', {name}, true ) } ); -- add maint message
end
end
 
 
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
 
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
mark contained in a |title= or |chapter= parameter's value.
 
This function will positive kern either single or double quotes:
"'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)
Double single quotes (italic or bold wiki-markup) are not kerned.
 
Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
quote marks regardless of the need for kerning.  Unicode quote marks are not replaced in simple [[D]] wikilinks.
 
Call this function for chapter titles, for website titles, etc.; not for book titles.
 
]=]
 
local function kern_quotes (str)
local cap = '';
local cap2 = '';
local wl_type, label, link;
 
wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
str = utilities.substitute (cfg.presentation['kern-wl-both'], str);
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
str = utilities.substitute (cfg.presentation['kern-wl-left'], str);
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
str = utilities.substitute (cfg.presentation['kern-wl-right'], str);
end
 
else -- plain text or [[L|D]]; text in label variable
label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
 
cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
if utilities.is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-left'], {cap, cap2});
end
cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
if utilities.is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-right'], {cap, cap2});
end
if 2 == wl_type then
str = utilities.make_wikilink (link, label); -- reassemble the wikilink
else
str = label;
end
end
return str;
end
 
 
--[[--------------------------< 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
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.
 
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=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:
|script-title=ja : *** ***
|script-title=ja: *** ***
|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
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.
 
Supports |script-title=, |script-chapter=, |script-<periodical>=
 
]]
 
local function format_script_value (script_value, script_param)
local lang=''; -- initialize to empty string
local name;
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 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
if not utilities.is_set (lang) then
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message
return ''; -- script_value was just the prefix so return empty string
end
-- if we get this far we have prefix and script
name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- 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?
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
-- is prefix one of these language codes?
if utilities.in_array (lang, cfg.script_lang_codes) then
utilities.add_prop_cat ('script_with_name', {name, lang})
else
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message
end
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
else
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message
lang = ''; -- invalid so set lang to empty string
end
else
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message
end
script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL
 
return script_value;
end
 
 
--[[--------------------------< 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 value has been
wrapped in <bdi> tags.
]]
 
local function script_concatenate (title, script, script_param)
if utilities.is_set (script) then
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
if utilities.is_set (script) then
title = title .. ' ' .. script; -- concatenate title and script title
end
end
return title;
end
 
 
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
 
Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
configuration taking one argument.  Supports lower case text for {{citation}} templates.  Additional text taken
from citation_config.messages - the reason this function is similar to but separate from wrap_style().
 
]]
 
local function wrap_msg (key, str, lower)
if not utilities.is_set ( str ) then
return "";
end
if true == lower then
local msg;
msg = cfg.messages[key]:lower(); -- set the message to lower case before
return utilities.substitute ( msg, str ); -- including template text
else
return utilities.substitute ( cfg.messages[key], str );
end
end
 
 
--[[----------------< W I K I S O U R C E _ U R L _ M A K E >-------------------
 
Makes a Wikisource URL from Wikisource interwiki-link.  Returns the URL and appropriate
label; nil else.
 
str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
 
]]
 
local function wikisource_url_make (str)
local wl_type, D, L;
local ws_url, ws_label;
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});
 
wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
 
if 0 == wl_type then -- not a wikilink; might be from |title-link=
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 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
 
if ws_url then
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent-encoding of fragment marker
end
 
return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil
end
 
 
--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
 
Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
and |trans-<periodical>= into a single Periodical meta-parameter.
 
]]
 
local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
local periodical_error = '';
 
if not utilities.is_set (periodical) then
periodical = ''; -- to be safe for concatenation
else
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
trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical);
if utilities.is_set (periodical) then
periodical = periodical .. ' ' .. trans_periodical;
else -- here when trans-periodical without periodical or script-periodical
periodical = trans_periodical;
periodical_error = ' ' .. utilities.set_message ('err_trans_missing_title', {'periodical'});
end
end
 
return periodical .. periodical_error;
end
end


-- Converts a hyphen to a dash
 
function hyphentodash( str )
--[[------------------< F O R M A T _ C H A P T E R _ T I T L E >---------------
    if str == nil then
 
        return nil;
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=,
    end  
and |chapter-url= into a single chapter meta- parameter (chapter_url_source used
    if str:match( "[%[%]{}<>]" ) ~= nil then  
for error messages).
        return str;
 
    end   
]]
    return str:gsub( '-', '–' );
 
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 chapter_error = '';
 
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
if ws_url then
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
chapter = ws_label;
end
 
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
 
chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
 
if utilities.is_set (chapter_url) then
chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
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?
chapter = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
end
 
if utilities.is_set (trans_chapter) then
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
if utilities.is_set (chapter) then
chapter = chapter .. ' ' .. trans_chapter;
else -- here when trans_chapter without chapter or script-chapter
chapter = trans_chapter;
chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>
chapter_error = ' ' .. utilities.set_message ('err_trans_missing_title', {chapter_source});
end
end
 
return chapter .. chapter_error;
end
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
 
function safeforitalics( str )
--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------
    --[[ Note: We can not use <i> for italics, as the expected behavior for
 
    italics specified by ''...'' in the title is that they will be inverted
This function searches a parameter's value for non-printable or invisible characters.
    (i.e. unitalicized) in the resulting references. In addition, <i> and ''
The search stops at the first match.
    tend to interact poorly under Mediawiki's HTML tidy. ]]
 
   
This function will detect the visible replacement character when it is part of the Wikisource.
    if str == nil or str == '' then
 
        return str;
Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers
    else
(gallery, math, pre, ref) and identifies them with a slightly different error message.
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
See also coins_cleanup().
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
 
        return str;
Output of this function is an error message that identifies the character or the
    end
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.
 
]]
 
local function has_invisible_chars (param, v)
local position = ''; -- position of invisible char or starting position of stripmarker
local capture; -- used by stripmarker detection to hold name of the stripmarker
local stripmarker; -- boolean set true when a stripmarker is found
 
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
 
for _, invisible_char in ipairs (cfg.invisible_chars) do
local char_name = invisible_char[1]; -- the character or group name
local pattern = invisible_char[2]; -- the pattern used to find it
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
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[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
position = nil; -- unset position
end
end
if position then
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
stripmarker = true; -- set a flag
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
position = nil; -- unset
else
local err_msg;
if capture and not (cfg.invisible_defs.del == capture or cfg.invisible_defs.zwj == capture) then
err_msg = capture .. ' ' .. char_name;
else
err_msg = char_name .. ' ' .. 'character';
end
 
table.insert (z.message_tail, {utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}, true)}); -- add error message
return; -- and done with this parameter
end
end
end
end
end


--[[
 
Joins a sequence of strings together while checking for duplicate separation
--[[-------------------< A R G U M E N T _ W R A P P E R >----------------------
characters.
 
Argument wrapper.  This function provides support for argument mapping defined
in the configuration file so that multiple names can be transparently aliased to
single internal variable.
 
]]
]]
function safejoin( tbl, duplicate_char )
    --[[
    Note: we use string functions here, rather than ustring functions.
   
    This has considerably faster performance and should work correctly as
    long as the duplicate_char is strict ASCII.  The strings
    in tbl may be ASCII or UTF8.
    ]]
   
    local str = '';
    local comp = '';
    local end_chr = '';
    for _, value in ipairs( tbl ) do
        if value == nil then value = ''; end
       
        if str == '' then
            str = value;
        elseif value ~= '' then
            if value:sub(1,1) == '<' then
                -- Special case of values enclosed in spans and other markup.
                comp = value:gsub( "%b<>", "" );
            else
                comp = value;
            end
           
            if comp:sub(1,1) == duplicate_char then
                end_chr = str:sub(-1,-1);
                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
                if end_chr == duplicate_char then
                    str = str:sub(1,-2) .. value;
                elseif end_chr == "'" then
                    if str:sub(-3,-1) == duplicate_char .. "''" then
                        str = str:sub(1, -4) .. "''" .. value;
                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
                        str = str .. value:sub(2,-1)
                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
                        str = str .. value:sub(2,-1)
                    else
                        str = str .. value;
                    end
                elseif end_chr == "]" then
                    if str:sub(-3,-1) == duplicate_char .. "]]" then
                        str = str .. value:sub(2,-1)
                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
                        str = str .. value:sub(2,-1)
                    else
                        str = str .. value;
                    end
                elseif end_chr == " " then
                    if str:sub(-2,-1) == duplicate_char .. " " then
                        str = str:sub(1,-3) .. value;
                    else
                        str = str .. value;
                    end
                else
                    str = str .. value;
                end
            else
                str = str .. value;
            end
        end
    end
    return str;
end 


--[[
local function argument_wrapper ( args )
Return the year portion of a date string, if possible.
local origin = {};
Returns empty string if the argument can not be interpreted
as a year.
return setmetatable({
ORIGIN = function ( self, k )
local dummy = self[k]; -- force the variable to be loaded.
return origin[k];
end
},
{
__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
 
 
--[[--------------------------< 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
 
DOES NOT yet support MMMM YYYY or any of the date ranges.
 
]]
]]
function selectyear( str )
 
    -- Is the input a simple number?
local function nowrap_date (date)
    local num = tonumber( str );
local cap = '';
    if num ~= nil and num > 0 and num < 2100 and num == math.abs(num) then
local cap2 = '';
        return str;
 
    else
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
        -- Use formatDate to interpret more complicated formats
date = utilities.substitute (cfg.presentation['nowrap1'], date);
        local lang = mw.getContentLanguage();
        local good, result;
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
        good, result = pcall( lang.formatDate, lang, 'Y', str )
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
        if good then
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
            return result;
end
        else
            -- Can't make sense of this input, return blank.
return date;
            return "";
        end
    end
end
end


-- Formats an OpenLibrary link, and checks for associated errors.
 
function openlibrary(id)
--[[--------------------------< S E T _ T I T L E T Y P E >---------------------
    local code = id:sub(-1,-1)
 
    if ( code == "A" ) then
This function sets default title types (equivalent to the citation including
        return externallinkid({link="Open Library",label="OL",
|type=<default value>) for those templates that have defaults. Also handles the
            prefix="http://openlibrary.org/authors/OL",id=id})
special case where it is desirable to omit the title type from the rendered citation
    elseif ( code == "M" ) then
(|type=none).
        return externallinkid({link="Open Library",label="OL",
 
            prefix="http://openlibrary.org/books/OL",id=id})
]]
    elseif ( code == "W" ) then
 
        return externallinkid({link="Open Library",label="OL",
local function set_titletype (cite_class, title_type)
            prefix= "http://openlibrary.org/works/OL",id=id})
if utilities.is_set (title_type) then
    else
if 'none' == cfg.keywords_xlate[title_type] then
        table.insert( z.error_categories, "Pages with OL errors" );
title_type = ''; -- if |type=none then type parameter not displayed
        return externallinkid({link="Open Library",label="OL",
end
            prefix= "http://openlibrary.org/OL",id=id}) ..
return title_type; -- if |type= has been set to any other value use that value
            ' <span class="error">Bad OL specified</span>';
end
    end
 
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
end


-- Attempts to convert names to initials.
 
function reducetoinitials(first)
--[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------
    local initials = {}
 
    for word in string.gmatch(first, "%S+") do
Converts a hyphen to a dash under certain conditions.  The hyphen must separate
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
like items; unlike items are returned unmodified.  These forms are modified:
    end
letter - letter (A - B)
    return table.concat(initials) -- Vancouver format does not include spaces.
digit - digit (4-5)
digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5)
letterdigit - letterdigit (A1-A5) (an optional separator between letter and
digit is supported – a.1-a.5 or a-1-a-5)
digitletter - digitletter (5a - 5d) (an optional separator between letter and
digit is supported – 5.a-5.d or 5-a-5-d)
 
any other forms are returned unmodified.
 
str may be a comma- or semicolon-separated list
 
]]
 
local function hyphen_to_dash( str )
if not utilities.is_set (str) then
return str;
end
 
local accept; -- Boolean
 
str = str:gsub ('&[nm]dash;', {['&ndash;'] = '–', ['&mdash;'] = '—'}); -- replace &mdash; and &ndash; entities with their characters; semicolon mucks up the text.split
str = str:gsub ('&#45;', '-'); -- replace HTML numeric entity with hyphen character
 
str = str:gsub ('&nbsp;', ' '); -- replace &nbsp; entity with generic keyboard space character
local out = {};
local list = mw.text.split (str, '%s*[,;]%s*'); -- split str at comma or semicolon separators if there are any
 
for _, item in ipairs (list) do -- for each item in the list
item, accept = utilities.has_accept_as_written (item); -- remove accept-this-as-written markup when it wraps all of item
if not accept and mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators
if item:match ('^%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+$') or -- letterdigit hyphen letterdigit (optional separator between letter and digit)
item:match ('^%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+$') or -- digitletter hyphen digitletter (optional separator between digit and letter)
item:match ('^%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+$') or -- digit separator digit hyphen digit separator digit
item:match ('^%d+%s*%-%s*%d+$') or -- digit hyphen digit
item:match ('^%a+%s*%-%s*%a+$') then -- letter hyphen letter
item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters
else
item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous whitespace
end
end
table.insert (out, item); -- add the (possibly modified) item to the output table
end
 
local temp_str = ''; -- concatenate the output table into a comma separated string
temp_str, accept = utilities.has_accept_as_written (table.concat (out, ', ')); -- remove accept-this-as-written markup when it wraps all of concatenated out
if accept then
temp_str = utilities.has_accept_as_written (str); -- when global markup removed, return original str; do it this way to suppress boolean second return value
return temp_str;
else
return temp_str; -- else, return assembled temp_str
end
end
end


-- Formats a list of people (e.g. authors / editors)
 
function listpeople(control, people)
--[[--------------------------< S A F E _ J O I N >-----------------------------
    local sep = control.sep;
 
    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
Joins a sequence of strings together while checking for duplicate separation characters.
    local namesep = control.namesep
 
    local format = control.format
]]
    local maximum = control.maximum
 
    local lastauthoramp = control.lastauthoramp;
local function safe_join( tbl, duplicate_char )
    local text = {}
local f = {}; -- create a function table appropriate to type of 'duplicate character'
    local etal = false;
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
    for i,person in ipairs(people) do
f.gsub = string.gsub
        if (person.last ~= nil or person.last ~= "") then
f.match = string.match
            local mask = person.mask
f.sub = string.sub
            local one
else -- for multi-byte characters use the ustring library functions
            if ( maximum ~= nil and i == maximum + 1 ) then
f.gsub = mw.ustring.gsub
                etal = true;
f.match = mw.ustring.match
                break;
f.sub = mw.ustring.sub
            elseif (mask ~= nil) then
end
                local n = tonumber(mask)
 
                if (n ~= nil) then
local str = ''; -- the output string
                    one = string.rep("&mdash;",n)
local comp = ''; -- what does 'comp' mean?
                else
local end_chr = '';
                    one = mask
local trim;
                end
for _, value in ipairs( tbl ) do
            else
if value == nil then value = ''; end
                one = person.last
                local first = person.first
if str == '' then -- if output string is empty
                if (first ~= nil and first ~= '') then
str = value; -- assign value to it (first time through the loop)
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
elseif value ~= '' then
                    one = one .. namesep .. first
if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup.
                end
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
                if (person.link ~= nil and person.link ~= "") then one = "[[" .. person.link .. "|" .. one .. "]]" end
else
            end
comp = value;
            table.insert(text, one)
end
        end
-- typically duplicate_char is sepc
    end
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
    local count = #text;
--  Because individual string segments often (always?) begin with terminal punct for the
    if count > 1 and lastauthoramp ~= nil and lastauthoramp ~= "" and not etal then
--  preceding segment: 'First element' .. 'sepc next element' .. etc.?
        text[count-1] = text[count-1] .. " & " .. text[count];
trim = false;
        text[count] = nil;
end_chr = f.sub(str, -1, -1); -- get the last character of the output string
    end   
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
    local result = table.concat(text, sep) -- construct list
if end_chr == duplicate_char then -- if same as separator
    if etal then
str = f.sub(str, 1, -2); -- remove it
        local etal_text = "et al."
elseif end_chr == "'" then -- if it might be wiki-markup
        if (sepc == ".") then etal_text = "et al" end
if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
        result = result .. " " .. etal_text;
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
    end
elseif  f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
   
trim = true; -- why? why do this and next differently from previous?
    -- if necessary wrap result in <span> tag to format in Small Caps
elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
    if ( "scap" == format ) then result= createTag({name="span", contents=result,  
trim = true; -- same question
        params={class="smallcaps", style="font-variant:small-caps;"}}) end  
end
    return result, count
elseif end_chr == "]" then -- if it might be wiki-markup
if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
trim = true;
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
trim = true;
elseif  f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
trim = true;
elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
trim = true;
end
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>
str = f.sub(str, 1, -3); -- remove them both
end
end
 
if trim then
if value ~= comp then -- value does not equal comp when value contains HTML markup
local dup2 = duplicate_char;
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows HTML markup
else
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character
end
end
end
str = str .. value; -- add it to the output string
end
end
return str;
end
end


-- Generates a CITEREF anchor ID.
 
function anchorid(args)
--[[--------------------------< I S _ S U F F I X >-----------------------------
    local P1 = args[1] or ""
 
    local P2 = args[2] or ""
returns true is suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
    local P3 = args[3] or ""
Puncutation not allowed.
    local P4 = args[4] or ""
 
    local P5 = args[5] or ""
]]
   
 
    -- Bugzilla 46608
local function is_suffix (suffix)
    local encoded = mw.uri.anchorEncode( P1 .. P2 .. P3 .. P4 .. P5 );
if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
    if encoded == false then
return true;
        encoded = "";
end
    end
return false;
   
    return "CITEREF" .. encoded;
end
end


-- Gets author list from the input arguments
 
function extractauthors(args)
--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------
    local authors = {};
 
    local i = 1;
For Vancouver style, author/editor names are supposed to be rendered in Latin
    local last;
(read ASCII) characters.  When a name uses characters that contain diacritical
   
marks, those characters are to be converted to the corresponding Latin
    while true do
character. When a name is written using a non-Latin alphabet or logogram, that
        last = args["author" .. i .. "-last"] or args["author-last" .. i] or
name is to be transliterated into Latin characters. The module doesn't do this
                args["last" .. i] or args["surname" .. i] or args["Author" .. i] or args["author" .. i]
so editors may/must.
        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
 
            authors[i] = {
This test allows |first= and |last= names to contain any of the letters defined
                last = last,
in the four Unicode Latin character sets
                first = args["author" .. i .. "-first"] or args["author-first" .. i] or
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
                        args["first" .. i] or args["given" .. i],
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
                link = args["author" .. i .. "-link"] or args["author-link" .. i] or
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F
                        args["author" .. i .. "link"] or args["authorlink" .. i],
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
                mask = args["author" .. i .. "-mask"] or args["author-mask" .. i] or  
 
                        args["author" .. i .. "mask"] or args["authormask" .. i]
|lastn= also allowed to contain hyphens, spaces, and apostrophes.
            }
(http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
        else
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
            break;
 
        end
This original test:
        i = i + 1;
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$")
    end
or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
    return authors;
was written outside of the code editor and pasted here because the code editor
gets confused between character insertion point and cursor position. 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 to use an external editor
to maintain this code.
 
\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
\195\152-\195\182 – Ø-ö (U+00D8-U+00F6 – C0 controls)
\195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B)
\199\132-\201\143 – DŽ-ɏ (U+01C4-U+024F – Latin extended B)
 
]]
 
local function is_good_vanc_name (last, first, suffix, position)
if not suffix then
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
suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix
end
end
if utilities.is_set (suffix) then
if not is_suffix (suffix) then
add_vanc_error (cfg.err_msg_supl.suffix, position);
return false; -- not a name with an appropriate suffix
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%-%s%']*$") or
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then
add_vanc_error (cfg.err_msg_supl['non-Latin char'], position);
return false; -- not a string of Latin characters; Vancouver requires Romanization
end;
return true;
end
end


-- Gets editor list from the input arguments
 
function extracteditors(args)
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
    local editors = {};
 
    local i = 1;
Attempts to convert names to initials in support of |name-list-style=vanc. 
    local last;
 
   
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period.
    while true do
See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
        last = args["editor" .. i .. "-last"] or args["editor-last" .. i] or
 
                args["EditorSurname" .. i] or args["Editor" .. i] or args["editor" .. i]
Vancouver style requires family rank designations (Jr, II, III, etc.) to be rendered
        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
            editors[i] = {
This code only accepts and understands generational suffix in the Vancouver format
                last = last,
because Roman numerals look like, and can be mistaken for, initials.
                first = args["editor" .. i .. "-first"] or args["editor-first" .. i] or args["EditorGiven" .. i],
 
                link = args["editor" .. i .. "-link"] or args["editor-link" .. i] or
This function uses ustring functions because firstname initials may be any of the
                        args["editor" .. i .. "link"] or args["editorlink" .. i],
Unicode Latin characters accepted by is_good_vanc_name ().
                mask = args["editor" .. i .. "-mask"] or args["editor-mask" .. i] or
 
                        args["editor" .. i .. "mask"] or args["editormask" .. i]
]]
            }
 
        else
local function reduce_to_initials(first, position)
            break;
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
        end
 
        i = i + 1;
if not name then -- if not initials and a suffix
    end
name = mw.ustring.match(first, "^(%u+)$"); -- is it just initials?
    return editors;
end
 
if name then -- if first is initials with or without suffix
if 3 > mw.ustring.len (name) then -- if one or two initials
if suffix then -- if there is a suffix
if is_suffix (suffix) then -- is it legitimate?
return first; -- one or two initials and a valid suffix so nothing to do
else
add_vanc_error (cfg.err_msg_supl.suffix, position); -- one or two initials with invalid suffix so error message
return first; -- and return first unmolested
end
else
return first; -- one or two initials without suffix; nothing to do
end
end
end -- if here then name has 3 or more uppercase letters so treat them as a word
 
local initials, names = {}, {}; -- tables to hold name parts and initials
local i = 1; -- counter for number of initials
 
names = mw.text.split (first, '[%s,]+'); -- split into a table of names and possible suffix
 
while names[i] do -- loop through the table
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[i] = names[i]:gsub ('%.', ''); -- remove terminal dot if present
if is_suffix (names[i]) then -- if a legitimate suffix
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
end -- no error message if not a suffix; possibly because of Romanization
end
if 3 > i then
table.insert (initials, mw.ustring.sub(names[i], 1, 1)); -- insert the initial at end of initials table
end
i = i + 1; -- bump the counter
end
return table.concat(initials) -- Vancouver format does not include spaces.
end
end


--[[
 
This is the main function foing the majority of the citation
--[[--------------------------< L I S T _ P E O P L E >--------------------------
formatting.
 
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
 
]]
]]
function citation0( config, args)
    -- Load Input Parameters


    local PPrefix = config.PPrefix or "p.&nbsp;"
local function list_people (control, people, etal)
    local PPPrefix = config.PPPrefix or "pp.&nbsp;"
local sep;
    if ( nil ~= args.nopp ) then PPPrefix = "" PPrefix = "" end
local namesep;
   
local format = control.format;
    -- Transfer unnumbered arguments to numbered arguments if necessary.
local maximum = control.maximum;
    args["author1"] = args.author1 or args.author or args.authors
local name_list = {};
    args["author1-last"] = args["author1-last"] or args["author-last"] or args["last"]
 
    args["author1-first"] = args["author1-first"] or args["author-first"]
if 'vanc' == format then -- Vancouver-like name styling?
      or args.first or args.first1 or args.given or args.given1
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between names is a comma
    args["author1-link"] = args["author1-link"] or args["author-link"]
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
    args["author1-mask"] = args["author1-mask"] or args["author-mask"] or args["authormask"]
else
    args["author1link"] = args["author1link"] or args["authorlink"]   
sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon
    args["editor1"] = args["editor1"] or args["editor"]
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
    args["editor1-last"] = args["editor1-last"] or args["editor-last"]
end
    args["editor1-first"] = args["editor1-first"] or args["editor-first"]
    args["editor1-link"] = args["editor1-link"] or args["editor-link"]
if sep:sub (-1, -1) ~= " " then sep = sep .. " " end
    args["editor1-mask"] = args["editor1-mask"] or args["editor-mask"] or args["editormask"]
if utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names
    args["editor1link"] = args["editor1link"] or args["editorlink"]   
for i, person in ipairs (people) do
if utilities.is_set (person.last) then
local mask = person.mask;
local one;
local sep_one = sep;
 
if utilities.is_set (maximum) and i > maximum then
etal = true;
break;
end
if mask then
local n = tonumber (mask); -- convert to a number if it can be converted; nil else
if n then
one = 0 ~= n and string.rep("&mdash;", n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name
person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil
else
one = mask; -- replace name with mask text (must include name-list separator)
sep_one = " "; -- modify name-list separator
end
else
one = person.last; -- get surname
local first = person.first -- get given name
if utilities.is_set (first) then
if ("vanc" == format) then -- if Vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first, nil, i) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials (first, i); -- attempt to convert first name(s) to initials
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)
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
end
 
local count = #name_list / 2; -- (number of names + number of separators) divided by 2
if 0 < count then
if 1 < count and not etal then
if 'amp' == format then
name_list[#name_list-2] = " & "; -- replace last separator with ampersand text
elseif 'and' == format then
if 2 == count then
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
name_list[#name_list] = nil; -- erase the last separator
end
 
local result = table.concat (name_list); -- 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
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've got a last-first list and etal so add et al.
end
return result, count; -- return name-list string and count of number of names (count used for editor names only)
end


    -- Pick out the relevant fields from the arguments.  Different citation templates
--[[--------------------< M A K E _ C I T E R E F _ I D >-----------------------
    -- define different field names for the same underlying things.   
    local Authors = args.authors
    local i
    local a = extractauthors( args );


    local Coauthors = args.coauthors or args.coauthor
Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise
    local Others = args.others
returns an empty string.
    local EditorMask = args.editormask or args["editor-mask"]
    local EditorFormat = args["editor-format"] or args.editorformat
    local Editors = args.editors
    local e = extracteditors( args );


    local Year = args.year
namelist is one of the contributor-, author-, or editor-name lists chosen in that
    local PublicationDate = args.publicationdate or args["publication-date"]
order. year is Year or anchor_year.
    local OrigYear = args.origyear
    local Date = args.date
    local LayDate = args.laydate
    ------------------------------------------------- Get title data
    local Title = args.title or args.encyclopaedia or args.encyclopedia or args.dictionary
    local BookTitle = args.booktitle
    local Conference = args.conference
    local TransTitle = args.trans_title
    local TitleNote = args.department
    local TitleLink = args.titlelink or args.episodelink
    local Chapter = args.chapter or args.contribution or args.entry
    local ChapterLink = args.chapterlink
    local TransChapter = args["trans-chapter"] or args.trans_chapter
    local TitleType = args.type
    local ArchiveURL = args["archive-url"] or args.archiveurl
    local URL = args.url or args.URL
    local ChapterURL = args["chapter-url"] or args.chapterurl
    local ConferenceURL = args["conference-url"] or args.conferenceurl
    local Periodical = args.journal or args.newspaper or args.magazine or args.work
            or args.periodical or args.encyclopedia or args.encyclopaedia
           
    if ( config.CitationClass == "encyclopaedia" ) then
        if ( args.article and args.article ~= "") then
            if ( Title and Title ~= "") then Periodical = Title end
            Chapter = args.article
            TransChapter = TransTitle
            Title = nil         
            TransTitle = nil
        elseif ( Chapter == nil or Chapter == '' ) then
            if Title ~= args.encyclopedia then
                Chapter = Title
                TransChapter = TransTitle
                Title = nil
                TransTitle = nil
            end
        end
        if ( Periodical and Periodical ~= "") then
            if Periodical == Title or Periodical == Chapter then Periodical = nil end
        end
    end
    local Series = args.series or args.version
    local Volume = args.volume
    local Issue = args.issue or args.number
    local Position = nil
    local Page = args.p or args.page
    local Pages = hyphentodash( args.pp or args.pages )
    local At = args.at
    local page_error = false;
   
    if Page ~= nil and Page ~= '' then
        if (Pages ~= nil and Pages ~= '') or (At ~= nil and At ~= '') then
            Pages = nil;
            At = nil;
            page_error = true;
        end
    elseif Pages ~= nil and Pages ~= '' then
        if At ~= nil and At ~= '' then
            At = nil;
            page_error = true;
        end
    end
   
    local Edition = args.edition
    local PublicationPlace = args["publication-place"] or args.publicationplace
            or args.place or args.location
    local Place = args.place or args.location
    if PublicationPlace == Place then Place = nil; end
   
    local PublisherName = args.publisher
    local SubscriptionRequired = args.subscription
    local Via = args.via
    local AccessDate = args["access-date"] or args.accessdate
    local ArchiveDate = args["archive-date"] or args.archivedate
    local Agency = args.agency
    local DeadURL = args.deadurl or "yes"          -- Only used is ArchiveURL is present.
    local Language = args.language or args["in"]
    local Format = args.format
    local Ref = args.ref or args.Ref
    local ARXIV = args.arxiv or args.ARXIV
    local ASIN = args.asin or args.ASIN
    local ASINTLD = args["ASIN-TLD"] or args["asin-tld"]
    local BIBCODE = args.bibcode or args.BIBCODE
    local DOI = args.doi or args.DOI
    local DoiBroken = args.doi_inactivedate or args.doi_brokendate or args.DoiBroken
    local ID = args.id or args.ID
    local ISBN = args.isbn13 or args.isbn or args.ISBN
    local ISSN = args.issn or args.ISSN
    local JFM = args.jfm or args.JFM
    local JSTOR = args.jstor or args.JSTOR
    local LCCN = args.lccn or args.LCCN
    local MR = args.mr or args.MR
    local OCLC = args.oclc or args.OCLC
    local OL = args.ol or args.OL
    local OSTI = args.osti or args.OSTI
    local PMC = args.pmc or args.PMC
    local PMID = args.pmid or args.PMID
    local RFC = args.rfc or args.RFC
    local SSRN = args.ssrn or args.SSRN
    local ZBL = args.zbl or args.ZBL
    local Quote = args.quote or args.quotation
    local PostScript = args.postscript or "."
    local LaySummary = args.laysummary
    local LaySource = args.laysource
    local Transcript = args.transcript
    local TranscriptURL = args["transcript-url"] or args.transcripturl
    local sepc = args.separator or "."
    local LastAuthorAmp = args.lastauthoramp
    local no_tracking_cats = args["template doc demo"] or args.nocat or
            args.notracking or args["no-tracking"] or "";


    if ( config.CitationClass == "journal" ) then
]]
        if (URL == nil or URL == "") then
          if (PMC ~= nil and PMC ~="")
            then URL="http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. PMC
            else URL=nil
          end
        end
    end


    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
local function make_citeref_id (namelist, year)
   
local names={}; -- a table for the one to four names and year
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
    if ( BookTitle ) then
names[i] = v.last
        Chapter = Title
if i == 4 then break end -- if four then done
        ChapterLink = TitleLink
end
        TransChapter = TransTitle
table.insert (names, year); -- add the year at the end
        Title = BookTitle
local id = table.concat(names); -- concatenate names and year for CITEREF id
        TitleLink = nil
if utilities.is_set (id) then -- if concatenation is not an empty string
        TransTitle = nil
return "CITEREF" .. id; -- add the CITEREF portion
    end
    -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
    if config.CitationClass == "episode" then
        local AirDate = args.airdate
        local SeriesLink = args.serieslink
        local Season = args.season
        local SeriesNumber = args.seriesnumber or args.seriesno
        local Network = args.network
        local Station = args.station
        local s = {}
        if Issue ~= nil then table.insert(s, "episode " .. Issue) Issue = nil end
        if Season ~= nil then table.insert(s, "season " .. Season) end
        if SeriesNumber ~= nil then table.insert(s, "series " .. SeriesNumber) end
        local n = {}
        if Network ~= nil then table.insert(n, Network) end
        if Station ~= nil then table.insert(n, Station) end
        Date = Date or AirDate
        Chapter = Title
        ChapterLink = TitleLink
        TransChapter = TransTitle
        Title = Series
        TitleLink = SeriesLink
        TransTitle = nil
        local Sep = args["series-separator"] or args["separator"] or ". "
        Series = table.concat(s, Sep)
        ID = table.concat(n, Sep)
    end
   
    -- These data form a COinS tag (see <http://ocoins.info/>) which allows
    -- automated tools to parse the citation information.
    local OCinSdata = {} -- COinS metadata excluding id, bibcode, doi, etc.
    local ctx_ver = "Z39.88-2004"
    OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
    if ( nil ~= Periodical ) then
        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"
        OCinSdata["rft.genre"] = "article"
        OCinSdata["rft.jtitle"] = Periodical
        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
    end
    if ( nil ~= Chapter and "" ~= Chapter) then
        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
        OCinSdata["rft.genre"] = "bookitem"
        OCinSdata["rft.btitle"] = Chapter
        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
    else
        OCinSdata["rft.genre"] = "book"
    if ( nil ~= Title ) then OCinSdata["rft.btitle"] = Title end
    end
    OCinSdata["rft.place"] = PublicationPlace
    OCinSdata["rft.date"] = Date or Year or PublicationDate
    OCinSdata["rft.series"] = Series
    OCinSdata["rft.volume"] = Volume
    OCinSdata["rft.issue"] = Issue
    OCinSdata["rft.pages"] = Page or Pages or At
    OCinSdata["rft.edition"] = Edition
    OCinSdata["rft.pub"] = PublisherName
    OCinSdata["rft.isbn"] = ISBN
    OCinSdata["rft.issn"] = ISSN
    OCinSdata["rft.jfm"] = JFM
    OCinSdata["rft.jstor"] = JSTOR
    OCinSdata["rft.lccn"] = LCCN
    OCinSdata["rft.mr"] = MR
    OCinSdata.rft_id = URL or ChapterURL
    if ( nil ~= a[1] and nil ~= a[1].last) then
    local last = a[1].last
local first = a[1].first
OCinSdata["rft.aulast"] = last
        if ( nil ~= first ) then
    OCinSdata["rft.aufirst"] = first
    OCinSdata["rft.au"] = last .. (args.NameSep or ", ") .. first
else
else
    OCinSdata["rft.au"] = last
return ''; -- return an empty string; no reason to include CITEREF id in this citation
        end
end
    end
end
    local OCinSids = {} -- COinS data only for id, bibcode, doi, pmid, etc.
 
    OCinSids["info:arxiv"] = ARXIV
 
    OCinSids["info:asin"] = ASIN
--[[---------------------< N A M E _ H A S _ E T A L >--------------------------
    OCinSids["info:bibcode"] = BIBCODE
    OCinSids["info:doi"] = DOI
    OCinSids["info:oclcnum"] = OCLC
    OCinSids["info:olnum"] = OL
    OCinSids["info:osti"] = OSTI
    OCinSids["info:pmc"] = PMC
    OCinSids["info:pmid"] = PMID
    OCinSids["info:rfc"] = RFC
    OCinSids["info:ssrn"] = SSRN
    OCinSids["info:zbl"] = ZBL
    local OCinStitle = "ctx_ver=" .. ctx_ver  -- such as "Z39.88-2004"
    for name,value in pairs(OCinSids) do
        OCinStitle = OCinStitle .. "&rft_id=" .. mw.uri.encode(name .. "/" .. value)
    end
    for name,value in pairs(OCinSdata) do
        OCinStitle = OCinStitle .. "&" .. name .. "=" .. mw.uri.encode(value)
    end
   
    local this_page = mw.title.getCurrentTitle();
    OCinStitle = OCinStitle .. "&rfr_id=info:sid/en.wikipedia.org:"
      .. this_page.prefixedText  -- end COinS data by page's non-encoded pagename


    if (Periodical ~= nil and Periodical ~= "") and
Evaluates the content of name parameters (author, editor, etc.) for variations on
        (Chapter == nil or Chapter == '') and
the theme of et al.  If found, the et al. is removed, a flag is set to true and
        (Title ~= nil and Title ~= "") then
the function returns the modified name and the flag.
            Chapter = Title
            ChapterLink = TitleLink
            TransChapter = TransTitle
            Title = nil
            TitleLink = nil
            TransTitle = nil           
    end


    -- Now perform various field substitutions.
This function never sets the flag to false but returns its previous state because
    -- We also add leading spaces and surrounding markup and punctuation to the
it may have been set by previous passes through this function or by the associated
    -- various parts of the citation, but only when they are non-nil.
|display-<names>=etal parameter
    if ( Authors == nil ) then
        local Maximum = tonumber(args["display-authors"] or args.displayauthors);
       
        -- Preserve old-style implicit et al.
        if Maximum == nil and #a == 9 then
            Maximum = 8;
            table.insert( z.error_categories, 'Pages using citations with old-style implicit et al.' );
            table.insert( z.message_tail, 'Citation uses old-style implicit et al. for authors' );
        elseif Maximum == nil then
            Maximum = #a + 1;
        end
           
        local control = {
            sep = (args["author-separator"] or ";") .. " ",
            namesep = (args["author-name-separator"] or args["name-separator"] or ",") .. " ",
            format = args["author-format"] or args.authorformat,
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
        }
       
        -- If the coauthor field is also used, prevent ampersand and et al. formatting.
        if Coauthors ~= nil and Coauthors ~= "" then
            control.lastauthoramp = nil;
            control.maximum = #a + 1;
        end
               
        Authors = listpeople(control, a)
    end
    local EditorCount
    if ( Editors == nil ) then
        local Maximum = tonumber(args["display-editors"] or args.displayeditors);


        -- Preserve old-style implicit et al.
]]
        if Maximum == nil and #e == 4 then
            Maximum = 3;
            table.insert( z.error_categories, 'Pages using citations with old-style implicit et al.' );
            table.insert( z.message_tail, 'Citation uses old-style implicit et al. for editors' );
        elseif Maximum == nil then
            Maximum = #e + 1;
        end


        local control = {
local function name_has_etal (name, etal, nocat, param)
            sep = (args["editor-separator"] or ";") .. " ",
            namesep = (args["editor-name-separator"] or args["name-separator"] or ",") .. " ",
            format = args["editor-format"] or args.editorformat,
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
            }


        Editors, EditorCount = listpeople(control, e)  
if utilities.is_set (name) then -- name can be nil in which case just return
    else
local patterns = cfg.et_al_patterns; -- get patterns from configuration
        EditorCount = 1;
    end
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
    if ( Date == nil or Date == "") then
if name:match (pattern) then -- if this 'et al' pattern is found in name
--   there's something hinky with how this adds dashes to perfectly-good free-standing years
name = name:gsub (pattern, ''); -- remove the offending text
--[[        Date = Year
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
        if ( Date ~= nil ) then
if not nocat then -- no categorization for |vauthors=
            local Month = args.month
table.insert( z.message_tail, {utilities.set_message ('err_etal', {param})}); -- and set an error if not added
            if ( Month == nil ) then
end
                local Began = args.began
end
                local Ended = args.ended
end
                if Began ~= nil and Ended ~= nil then
end
                    Month = Began .. "&ndash;" .. Ended
                else
                    Month = "&ndash;"
                end
            end
            Date = Month .. " " .. Date
            local Day = args.day
            if ( Day ~= nil ) then Date = Day .. " " .. Date end
        end
]] -- so let's use the original version for now
        Date = Year
        if ( Date ~= nil and Date ~="") then
            local Month = args.month
            if ( Month ~= nil and Month ~= "") then
                Date = Month .. " " .. Date
                local Day = args.day
                if ( Day ~= nil ) then Date = Day .. " " .. Date end
                else Month = ""
            end
            else Date = ""
        end
    end
    if ( PublicationDate == Date or PublicationDate == Year ) then PublicationDate = nil end
    if( (Date == nil or Date == "") and PublicationDate ~= nil ) then
        Date = PublicationDate;
        PublicationDate = nil;
    end  


    -- Captures the value for Date prior to adding parens or other textual transformations
return name, etal;
    local DateIn = Date
end
   
    if ( URL == nil or URL == '' ) and
            ( ChapterURL == nil or ChapterURL == '' ) and
            ( ArchiveURL == nil or ArchiveURL == '' ) and               
            ( ConferenceURL == nil or ConferenceURL == '' ) and               
            ( TranscriptURL == nil or TranscriptURL == '' ) then


        -- Test if cite web is called without giving a URL
        if ( config.CitationClass == "web" ) then
            table.insert( z.error_categories, 'Pages using web citations with no URL' );
            table.insert( z.message_tail, 'No URL on cite web' );
        end


        -- Test if accessdate is given without giving a URL
--[[---------------------< N A M E _ I S _ N U M E R I C >----------------------
        if ( AccessDate ~= nil and AccessDate ~= '' ) then
            table.insert( z.error_categories, 'Pages using citations with accessdate and no URL' );
            table.insert( z.message_tail, 'Accessdate used without URL' );
            AccessDate = nil;
        end     
   
        -- Test if format is given without giving a URL
        if ( Format ~= nil and Format ~= '' ) then
            table.insert( z.error_categories, 'Pages using citations with format and no URL' );
            Format = Format .. hiddencomment( "File format specified without giving a URL" );
        end       
    end   


    -- Test if citation has no title
Add maint cat when name parameter value does not contain letters.  Does not catch
    if ( Chapter == nil or Chapter == "" ) and
mixed alphanumeric names so |last=A. Green (1922-1987) does not get caught in the
            ( Title == nil or Title == "" ) and
current version of this test but |first=(1888) is caught.
            ( Periodical == nil or Periodical == "" ) and
            ( Conference == nil or Conference == "" ) and
            ( TransTitle == nil or TransTitle == "" ) and
            ( TransChapter == nil or TransChapter == "" ) then
        table.insert( z.error_categories, 'Pages with citations lacking titles' );
        table.insert( z.message_tail, 'Citation has no title' );
    end


    if ( Format ~= nil and Format ~="" ) then
returns nothing
        Format = " (" .. Format .. ")" else Format = "" end
   
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
    if ( ArchiveURL and "" < ArchiveURL ) then
        if ( DeadURL ~= "no" ) then
            URL = ArchiveURL
        end
    end


    if ( TransTitle and "" < TransTitle ) then TransTitle = " [" .. TransTitle .. "&#93;" else TransTitle = "" end
]]
    if ( TransChapter and "" < TransChapter ) then TransChapter = " [" .. TransChapter .. "&#93;" else TransChapter = "" end
       
    -- Format chapter / article title
    if ( Chapter ~= nil and Chapter ~= "" ) then
        if ( ChapterLink and "" < ChapterLink ) then Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]" end
        if ( Periodical and "" < Periodical ) and (Title ~= nil and Title ~= "" )
        then
            Chapter = "''" .. safeforitalics(Chapter) .. "''"
        else
            Chapter = "\"" .. Chapter .. "\""
        end
    else
        Chapter = "";
    end
    if TransChapter ~= "" and Chapter == "" then
        table.insert( z.error_categories, 'Pages with citations using translated terms without the original' );
        TransChapter = TransChapter .. hiddencomment( "Translated title included without the original" );
    end
    Chapter = Chapter .. TransChapter
    if Chapter ~= "" then
        if ( ChapterLink == nil ) then
            if ( ChapterURL and "" < ChapterURL ) then
                Chapter = "[" .. ChapterURL .. " " .. safeforurl( Chapter )  .. "]"
                if URL == nil or URL == "" then
                    Chapter = Chapter .. Format;
                    Format = "";
                end
            elseif ( URL and "" < URL ) then
                Chapter = "[" .. URL .. " " .. safeforurl( Chapter ) .. "]" .. Format
                URL = nil
                Format = ""
            end
        end
        Chapter = Chapter .. sepc .. " " -- with end-space
    end
   
    -- Format main title.
    if ( Title and "" < Title ) then
        if ( TitleLink and "" < TitleLink ) then
            Title = "[[" .. TitleLink .. "|" .. Title .. "]]" end
        if ( Periodical and "" < Periodical ) then
            Title = "\"" .. Title .. "\""
        elseif ( config.CitationClass == "web"
                or config.CitationClass == "news"
                or config.CitationClass == "pressrelease" ) and
                Chapter == "" then
            Title = "\"" .. Title .. "\""
        else
            Title = "''" .. safeforitalics(Title) .. "''"
        end
    else
        Title = "";
    end   
    if TransTitle ~= "" and Title == "" then
        table.insert( z.error_categories, 'Pages with citations using translated terms without the original' );
        TransTitle = TransTitle .. hiddencomment( "Translated title included without the original" );
    end
    Title = Title .. TransTitle
    if Title ~= "" then
        if ( TitleLink == nil and URL and "" < URL ) then
            Title = "[" .. URL .. " " .. safeforurl( Title ) .. "]" .. Format
            URL = nil
            Format = ''
        end
    end


    if ( Place ~= nil and Place ~= "" ) then
local function name_is_numeric (name, list_name)
        if sepc == '.' then
if utilities.is_set (name) then
            Place = " Written at " .. Place .. sepc .. " ";
if mw.ustring.match (name, '^[%A]+$') then -- when name does not contain any letters
        else
utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
            Place = " written at " .. Place .. sepc .. " ";
end
        end           
end
    else
end
        Place = "";
    end
   
    if ( Conference ~= nil and Conference ~="" ) then
        if ( ConferenceURL ~= nil ) then
            Conference = "[" .. ConferenceURL .. " " .. safeforurl( Conference ) .. "]"
        end
        Conference = " " .. Conference
    else
        Conference = ""
    end
    if ( nil ~= Position or nil ~= Page or nil ~= Pages ) then At = nil end
    if ( nil == Position and "" ~= Position ) then
        local Minutes = args.minutes
        if ( nil ~= Minutes ) then
            Position = " " .. Minutes .. " minutes in"
        else
            local Time = args.time
            if ( nil ~= Time ) then
                local TimeCaption = args.timecaption or "Event occurs at"
                Position = " " .. TimeCaption .. " " .. Time
            else
                Position = ""
            end
        end
    else
        Position = " " .. Position
    end
    if ( nil == Page or "" == Page ) then
        Page = ""
        if ( nil == Pages or "" == Pages) then
            Pages = ""
        elseif ( Periodical ~= nil and Periodical ~= "" and
                config.CitationClass ~= "encyclopaedia" and
                config.CitationClass ~= "web" and
                config.CitationClass ~= "book" and
                config.CitationClass ~= "news") then
            Pages = ": " .. Pages
        else
            if ( tonumber(Pages) ~= nil ) then
              Pages = sepc .." " .. PPrefix .. Pages
            else Pages = sepc .." " .. PPPrefix .. Pages
            end
        end
    else
        Pages = ""
        if ( Periodical ~= nil and Periodical ~= "" and
            config.CitationClass ~= "encyclopaedia" and
            config.CitationClass ~= "web" and
            config.CitationClass ~= "book" and
            config.CitationClass ~= "news") then
            Page = ": " .. Page
        else
            Page = sepc .." " .. PPrefix .. Page
        end
    end
    if ( At ~= nil and At ~="") then At = sepc .. " " .. At
    else At = "" end
    if ( Coauthors == nil ) then Coauthors = "" end
    if ( Others ~= nil and Others ~="" ) then
        Others = sepc .. " " .. Others else Others = "" end
    if ( TitleType ~= nil and TitleType ~="" ) then
        TitleType = " (" .. TitleType .. ")" else TitleType = "" end
    if ( TitleNote ~= nil and TitleNote ~="" ) then
        TitleNote = sepc .. " " .. TitleNote else TitleNote = "" end
    if ( Language ~= nil and Language ~="" ) then
        Language = " (in " .. Language .. ")" else Language = "" end
    if ( Edition ~= nil and Edition ~="" ) then
        Edition = " (" .. Edition .. " ed.)" else Edition = "" end
    if ( Volume ~= nil and Volume ~="" )
    then
        if ( mw.ustring.len(Volume) > 4 )
          then Volume = sepc .." " .. Volume
          else Volume = " <b>" .. hyphentodash(Volume) .. "</b>"
        end
    else Volume = "" end
    if ( Issue ~= nil and Issue ~="" ) then
        Issue = " (" .. Issue .. ")" else Issue = "" end
    if ( Series ~= nil and Series ~="" ) then
        Series = sepc .. " " .. Series else Series = "" end
    if ( OrigYear ~= nil and OrigYear ~="" ) then
        OrigYear = " [" .. OrigYear .. "]" else OrigYear = "" end
    if ( Agency ~= nil and Agency ~="" ) then
        Agency = sepc .. " " .. Agency else Agency = "" end
    ------------------------------------ totally unrelated data
    if ( Date ~= nil ) then Date = Date else Date = "" end
    if ( Via ~= nil and Via ~="" ) then
        Via = " &mdash; via " .. Via else Via = "" end
    if ( AccessDate ~= nil and AccessDate ~="" )
    then local retrv_text = " retrieved "
        if (sepc == ".") then retrv_text = " Retrieved " end
        AccessDate = '<span class="reference-accessdate">'
        .. sepc .. retrv_text .. AccessDate .. '</span>'
    else AccessDate = "" end
    if ( SubscriptionRequired ~= nil and
        SubscriptionRequired ~= "" ) then
        SubscriptionRequired = sepc .. " " .. createTag({name="span", contents="(subscription required)",
            params={style="font-size:0.95em; font-size: 90%; color: #555"}})
    else
        SubscriptionRequired = ""
    end
    if ( ARXIV ~= nil and ARXIV ~= "" ) then
        ARXIV = sepc .. " " .. externallinkid({label="arXiv",link="arXiv",
            prefix="http://arxiv.org/abs/",id=ARXIV,separator=":",encode=false}) else ARXIV = "" end
    if ( ASIN ~= nil and ASIN ~= "" ) then
        ASIN = sepc .. " " .. amazon(ASIN, ASINTLD) else ASIN = "" end
    if ( BIBCODE ~= nil and BIBCODE ~= "" ) then
        BIBCODE = sepc .. " " .. externallinkid({label="Bibcode",link="Bibcode",
            prefix="http://adsabs.harvard.edu/abs/",id=BIBCODE,separator=":"}) else BIBCODE = "" end
    if ( DOI ~= nil and DOI ~= "" ) then
        DOI = sepc .. " " .. doi(DOI, DoiBroken) else DOI = "" end
    if ( ID ~= nil and ID ~="") then ID = sepc .." ".. ID else ID="" end
    if ( ISBN ~= nil and ISBN ~= "") then
        ISBN = sepc .. " " .. internallinkid({label="ISBN",link="International Standard Book Number",
            prefix="Special:BookSources/",id=ISBN}) else ISBN = "" end
    if ( ISSN ~= nil and ISSN ~="" ) then
        ISSN = sepc .. " " .. externallinkid({label="ISSN",link="International Standard Serial Number",
            prefix="//www.worldcat.org/issn/",id=ISSN,encode=false}) else ISSN = "" end
    if ( JFM ~= nil and JFM ~="" ) then
        JFM = sepc .." " .. externallinkid({label="JFM",link="Jahrbuch über die Fortschritte der Mathematik",
            prefix="http://www.zentralblatt-math.org/zmath/en/search/?format=complete&q=an:",id=JFM}) else JFM = "" end
    if ( JSTOR ~= nil and JSTOR ~="") then
        JSTOR = sepc .." " .. externallinkid({label="JSTOR",link="JSTOR",
            prefix="http://www.jstor.org/stable/",id=JSTOR}) else JSTOR = "" end
    if ( LCCN ~= nil and LCCN ~="" ) then
        LCCN = sepc .." " .. externallinkid({label="LCCN",link="Library of Congress Control Number",
            prefix="http://lccn.loc.gov/",id=LCCN,encode=false}) else LCCN = "" end
    if ( MR ~= nil and MR ~="" ) then
        MR = sepc .." " .. externallinkid({label="MR",link="Mathematical Reviews",
            prefix="http://www.ams.org/mathscinet-getitem?mr=",id=MR}) else MR = "" end
    if ( OCLC ~= nil and OCLC ~="") then
        OCLC = sepc .." " .. externallinkid({label="OCLC",link="OCLC",
            prefix="//www.worldcat.org/oclc/",id=OCLC}) else OCLC = "" end
    if ( OL ~= nil and OL ~="") then
        OL = sepc .. " " .. openlibrary(OL) else OL = "" end   
    if ( OSTI ~= nil and OSTI ~="") then
        OSTI = sepc .." " .. externallinkid({label="OSTI",link="Office of Scientific and Technical Information",
            prefix="http://www.osti.gov/energycitations/product.biblio.jsp?osti_id=",id=OSTI}) else OSTI = "" end
    if ( PMC ~= nil and PMC ~="") then
        PMC = sepc .." " .. externallinkid({label="PMC",link="PubMed Central"
            ,prefix="//www.ncbi.nlm.nih.gov/pmc/articles/PMC",suffix=" ",id=PMC}) else PMC = "" end
    if ( PMID ~= nil and PMID ~="") then
        PMID = sepc .." " .. externallinkid({label="PMID",link="PubMed Identifier",
            prefix="//www.ncbi.nlm.nih.gov/pubmed/",id=PMID,encode=false}) else PMID = "" end
    if ( RFC ~= nil and RFC ~="") then
        RFC = sepc .." " .. externallinkid({label="RFC",link="Request for Comments",
            prefix="//tools.ietf.org/html/rfc",id=RFC,encode=false}) else RFC = "" end
    if ( SSRN ~= nil and SSRN ~="") then
        SSRN = sepc .." " .. externallinkid({label="SSRN",link="Social Science Research Network",
            prefix="http://ssrn.com/abstract=",id=SSRN}) else SSRN = "" end
    if ( ZBL ~= nil and ZBL ~="") then
        ZBL = sepc .." " .. externallinkid({label="Zbl",link="Zentralblatt MATH",
            prefix="http://www.zentralblatt-math.org/zmath/en/search/?format=complete&q=an:",id=ZBL}) else ZBL = "" end


    if ( URL ~= nil and URL ~="") then
        URL = " " .. "[" .. URL .. " " .. nowiki(URL) .. "]";
        table.insert( z.error_categories, "Pages with citations having bare URLs" );
        if config.CitationClass == "web" then
            table.insert( z.error_categories, "Pages using web citations with no title" );
            URL = URL .. " <span class='error'>No <code>title=</code> specified</span>"
        else
            URL = URL .. hiddencomment("Bare URL needs a title");
        end     
    else
        URL = ""
    end


    if ( Quote and Quote ~="" ) then
--[[-------------------< N A M E _ H A S _ E D _ M A R K U P >------------------
        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
            Quote = Quote:sub(2,-2);
        end
       
        Quote = sepc .." \"" .. Quote .. "\""
        PostScript = ""
    else
        if ( PostScript == nil) then PostScript = "" end
        Quote = ""
    end
   
    local Archived
    if ( nil ~= ArchiveURL and "" ~= ArchiveURL ) then
        if ( ArchiveDate ~= nil and ArchiveDate ~="" ) then
            ArchiveDate = " " .. ArchiveDate
        else
            ArchiveDate = " <span class='error'>If you specify <code>archiveurl=</code>, " ..
                "you must also specify <code>archivedate=</code></span> "
            table.insert( z.error_categories, 'Pages with archiveurl citation errors' );
        end
        local arch_text = " archived"
        if (sepc == ".") then arch_text = " Archived" end
        if ( "no" == DeadURL ) then
            Archived = sepc .. " [" .. ArchiveURL .. arch_text .. "] from the original on" .. ArchiveDate
            if OriginalURL == nil or OriginalUrl == '' then
                table.insert( z.error_categories, 'Pages with archiveurl citation errors' );
                Archived = Archived .. " <span class='error'>If you specify <code>archiveurl=</code>" ..
                    " and <code>deadurl=no</code>, then you must also specify <code>url=</code></span>";                             
            end
        else
            if OriginalURL ~= nil and OriginalURL ~= '' then
                Archived = sepc .. arch_text .. " from [" .. OriginalURL .. " the original] on" .. ArchiveDate
            else
                if config.CitationClass ~= 'web' then
                    Archived = sepc .. arch_text .. " from <span class='error'>If you specify <code>archiveurl=</code>" ..
                        ", you must also specify <code>url=</code></span> on" .. ArchiveDate
                    table.insert( z.error_categories, 'Pages with archiveurl citation errors' );
                else
                    Archived = sepc .. arch_text .. " from the original on" .. ArchiveDate
                end
            end               
        end
    else
        Archived = ""
    end
    local Lay
    if ( nil ~= LaySummary and "" ~= LaySummary ) then
        if ( LayDate ~= nil ) then LayDate = " (" .. LayDate .. ")" else LayDate = "" end
        if ( LaySource ~= nil ) then
            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''"
        else
            LaySource = ""
        end
        if sepc == '.' then
            Lay = sepc .. " [" .. LaySummary .. " Lay summary]" .. LaySource .. LayDate
        else
            Lay = sepc .. " [" .. LaySummary .. " lay summary]" .. LaySource .. LayDate
        end           
    else
        Lay = ""
    end
    if ( nil ~= Transcript and "" ~= Transcript ) then
        if ( TranscriptURL ~= nil ) then Transcript = "[" .. TranscriptURL .. Transcript .. "]" end
    else
        Transcript = ""
    end
    local Publisher = ""
    if ( Periodical and Periodical ~= "" and
        config.CitationClass ~= "encyclopaedia" and
        config.CitationClass ~= "web" ) then
        if ( PublisherName ~= nil and PublisherName ~="" ) then
            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
                Publisher = PublicationPlace .. ": " .. PublisherName;
            else
                Publisher = PublisherName; 
            end           
        elseif (PublicationPlace ~= nil and PublicationPlace ~= '') then
            Publisher= PublicationPlace;
        else
            Publisher = "";
        end
        if ( PublicationDate and PublicationDate ~="" ) then
            if Publisher ~= '' then
                Publisher = Publisher .. ", published " .. PublicationDate;
            else
                Publisher = PublicationDate;
            end
        end
        if Publisher ~= "" then
            Publisher = " (" .. Publisher .. ")";
        end
    else
        if ( PublicationDate and PublicationDate ~="" ) then
            PublicationDate = " (published " .. PublicationDate .. ")"
        else
            PublicationDate = ""
        end
        if ( PublisherName ~= nil and PublisherName ~="" ) then
            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
            else
                Publisher = sepc .. " " .. PublisherName .. PublicationDate; 
            end           
        elseif (PublicationPlace ~= nil and PublicationPlace ~= '') then
            Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
        else
            Publisher = PublicationDate;
        end
    end
    -- Several of the above rely upon detecting this as nil, so do it last.
    if ( Periodical ~= nil and Periodical ~="" ) then
        if ( Title and Title ~= "" ) or ( TitleNote and TitleNote ~= "" ) then
            Periodical = sepc .. " ''" .. safeforitalics(Periodical) .. "''"
        else
            Periodical = "''" .. safeforitalics(Periodical) .. "''"
        end
    else Periodical = "" end


    -- Piece all bits together at last. Here, all should be non-nil.
Evaluates the content of author and editor parameters for extraneous editor annotations:
    -- We build things this way because it is more efficient in LUA
ed, ed., eds, (Ed.), etc. These annotations do not belong in author parameters and
    -- not to keep reassigning to the same string variable over and over.
are redundant in editor parameters.  If found, the function adds the editor markup
maintenance category.


    local tcommon
returns nothing
    if ( ( (config.CitationClass == "journal") or (config.CitationClass == "citation") )  and
        Periodical ~= "" ) then
        if (Others ~= "") then Others = Others .. sepc .. " " end
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,
            Language, Edition, Publisher, Agency, Volume, Issue, Position}, sepc );
    else
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
            Volume, Issue, Others, Edition, Publisher, Agency, Position}, sepc );
    end
   
    local idcommon = safejoin( { ARXIV, ASIN, BIBCODE, DOI, ISBN, ISSN, JFM, JSTOR, LCCN, MR, OCLC, OL, OSTI,
        PMC, PMID, RFC, SSRN, URL, ZBL, ID, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );


    local text
]]
    local pgtext = Page .. Pages .. At
    if page_error then
        table.insert( z.error_categories, 'Pages with citations using conflicting page specifications' );
        pgtext = pgtext .. hiddencomment('Bad page specification here');
    end
   
    if ( "" ~= Authors ) then
        if (Coauthors ~= "")
          then Authors = Authors .. "; " .. Coauthors
        end
        if ( "" ~= Date )
          then Date = " ("..Date..")" .. OrigYear .. sepc .. " "
          else
            if ( string.sub(Authors,-1,-1) == sepc) --check end character
              then Authors = Authors .. " "
              else Authors = Authors .. sepc .. " "
            end
        end
        if ( "" ~= Editors) then
            local in_text = " in "
            if (sepc == '.') then in_text = " In " end
            if (string.sub(Editors,-1,-1) == sepc)
                then Editors = in_text .. Editors .. " "
                else Editors = in_text .. Editors .. sepc .. " "
            end
        end
        text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
        text = safejoin( {text, pgtext, idcommon}, sepc );
    elseif ( "" ~= Editors) then
        if ( "" ~= Date ) then
            if EditorCount <= 1 then
                Editors = Editors .. ", ed."
            else
                Editors = Editors .. ", eds."
            end
            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
        else
            if EditorCount <= 1 then
                Editors = Editors .. " (ed.)" .. sepc .. " "
            else
                Editors = Editors .. " (eds.)" .. sepc .. " "
            end
        end
        text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
        text = safejoin( {text, pgtext, idcommon}, sepc );
    else
        if ( "" ~= Date ) then
            if ( string.sub(tcommon,-1,-1) ~= sepc )
              then Date = sepc .." " .. Date .. OrigYear
              else Date = " " .. Date .. OrigYear
            end
        end -- endif ""~=Date
        if ( config.CitationClass=="journal" and Periodical ) then
          text = safejoin( {Chapter, Place, tcommon}, sepc );
          text = safejoin( {text, pgtext, Date, idcommon}, sepc );
        else
          text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
          text = safejoin( {text, pgtext, idcommon}, sepc );
        end
    end
   
    if PostScript ~= '' and PostScript ~= nil and PostScript ~= sepc then
        text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
        text = text:sub(1,-2); --Remove final seperator   
    end   
   
    text = safejoin( {text, PostScript}, sepc );


    -- Now enclose the whole thing in a <span/> element
local function name_has_ed_markup (name, list_name)
    if ( Year == nil ) then
local patterns = cfg.editor_markup_patterns; -- get patterns from configuration
        if ( DateIn ~= nil and DateIn ~= "" ) then
            Year = selectyear( DateIn )
        elseif( PublicationDate ~= nil and PublicationDate ~= "" ) then
            Year = selectyear( PublicationDate )
        else
            Year = ""
        end
    end
    local classname = "citation"
    if ( config.CitationClass ~= "citation" )
      then classname = "citation " .. (config.CitationClass or "") end
    local args = { class=classname }
    if ( Ref ~= nil ) then
        local id = Ref
        if ( "harv" == Ref ) then
            local names = {} --table of last names & year
            if ( "" ~= Authors ) then
                for i,v in ipairs(a) do names[i] = v.last end
            elseif ( "" ~= Editors ) then
                for i,v in ipairs(e) do names[i] = v.last end
            end
            if ( names[1] == nil ) then
                names[1] = Year
            elseif ( names[2] == nil ) then
                names[2] = Year
            elseif ( names[3] == nil ) then
                names[3] = Year
            elseif ( names[4] == nil ) then
                names[4] = Year
            else
                names[5] = Year
            end
            id = anchorid(names)
        end
        args.id = id;
    end
   
    if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
        z.error_categories = { 'Pages with empty citations' };
        text = '<span class="error">Citation is empty</span>';
        z.message_tail = {};
    end
   
    text = createTag({name="span", contents=text, params=args})


    local empty_span = createTag( {name="span", contents="&nbsp;", params={style="display: none;"}} );
if utilities.is_set (name) then
   
for _, pattern in ipairs (patterns) do -- spin through patterns table and
    -- Note: Using display: none on then COinS span breaks some clients.
if name:match (pattern) then
    local OCinS = createTag({name="span", contents=empty_span, params={class="Z3988",title=OCinStitle }})
utilities.set_message ('maint_extra_text_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
    text = text .. OCinS;
break;
   
end
    if #z.message_tail ~= 0 then
end
        text = text .. hiddencomment( table.concat( z.message_tail, "; " ) );
end
    end
   
    if no_tracking_cats == '' then
        for _, v in ipairs( z.error_categories ) do
            text = text .. '[[Category:' .. v ..']]';
        end
    end
   
    return text
end
end


-- This is used by templates such as {{cite book}} to create the actual citation text.
function z.citation(frame)
    local pframe = frame:getParent()
   
    local args = {};
    for k, v in pairs( pframe.args ) do
        if v ~= '' then
            args[k] = v;
        elseif k == 'postscript' then
            args[k] = v;
        end       
    end   


    local config = {};
--[[-----------------< N A M E _ H A S _ M U L T _ N A M E S >------------------
    for k, v in pairs( frame.args ) do
 
        config[k] = v;
Evaluates the content of last/surname (authors etc.) parameters for multiple names.
        if args[k] == nil and (v ~= '' or k == 'postscript') then
Multiple names are indicated if there is more than one comma or any "unescaped"
            args[k] = v;
semicolons. Escaped semicolons are ones used as part of selected HTML entities.
        end      
If the condition is met, the function adds the multiple name maintenance category.
    end  
 
   
returns nothing
    return citation0( config, args)
 
]]
 
local function name_has_mult_names (name, list_name)
local _, commas, semicolons, nbsps;
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 1 < 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


return z
 
---------------------------------------------------------------------
--[[------------------------< N A M E _ C H E C K S >---------------------------
--NOTES
 
--
This function calls various name checking functions used to validate the content
-- NOTE A1: This Lua module was originally designed to handle a mix
of the various name-holding parameters.
--      of citation styles, crossing Vancouver style with Wikipedia'
 
]]
 
local function name_checks (last, first, list_name)
local accept_name;
 
if utilities.is_set (last) then
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
name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only)
name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation
name_is_numeric (last, list_name); -- check for names that are composed of digits and punctuation
end
end
 
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_ed_markup (first, list_name); -- check for extraneous 'editor' annotation
name_is_numeric (first, list_name); -- check for names that are composed of digits and punctuation
end
end
 
return last, first; -- done
end
 
 
--[[----------------------< E X T R A C T _ N A M E S >-------------------------
Gets name list from the input arguments
 
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.
 
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=.
 
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 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 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 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
first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i );
link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i );
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
 
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); -- multiple names, extraneous annotation, etc. checks
if first and not last then -- if there is a firstn without a matching lastn
local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias
table.insert (z.message_tail, { 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
}, 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
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)
n = n + 1; -- point to next location in the names table
if 1 == count then -- if the previous name was missing
table.insert( z.message_tail, { utilities.set_message ( 'err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}, true ) } ); -- add this error message
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
i = i + 1; -- point to next args location
end
return names, etal; -- all done, return our list of names and the etal flag
end
 
 
--[[---------------------< G E T _ I S O 6 3 9 _ C O D E >----------------------
 
Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code.
 
Returns the language name and associated two- or three-character code.  Because
case of the source may be incorrect or different from the case that WikiMedia uses,
the name comparisons are done in lower case and when a match is found, the Wikimedia
version (assumed to be correct) is returned along with the code.  When there is no
match, we return the original language name string.
 
mw.language.fetchLanguageNames(<local wiki language>, 'all') returns a list of
languages that in some cases may include extensions. For example, code 'cbk-zam'
and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support
code 'cbk' or name 'Chavacano'.  Most (all?) of these languages are not used a
'language' codes per se, rather they are used as sub-domain names: cbk-zam.wikipedia.org.
A list of language names and codes supported by fetchLanguageNames() can be found
at Template:Citation Style documentation/language/doc
 
Names that are included in the list will be found if that name is provided in the
|language= parameter.  For example, if |language=Chavacano de Zamboanga, that name
will be found with the associated code 'cbk-zam'.  When names are found and the
associated code is not two or three characters, this function returns only the
WikiMedia language name.
 
Some language names have multiple entries under different codes:
Aromanian has code rup and code roa-rup
When this occurs, this function returns the language name and the 2- or 3-character code
 
Adapted from code taken from Module:Check ISO 639-1.
 
]]
 
local function get_iso639_code (lang, this_wiki_code)
if cfg.lang_name_remap[lang:lower()] then -- if there is a remapped name (because MediaWiki uses something that we don't think is correct)
return cfg.lang_name_remap[lang:lower()][1], cfg.lang_name_remap[lang:lower()][2]; -- for this language 'name', return a possibly new name and appropriate code
end
 
local ietf_code; -- because some languages have both IETF-like codes and ISO 639-like codes
local ietf_name;
local langlc = mw.ustring.lower (lang); -- lower-case version for comparisons
 
for code, name in pairs (cfg.languages) do -- scan the list to see if we can find our language
if langlc == mw.ustring.lower (name) then
if 2 == #code or 3 == #code then -- two- or three-character codes only; IETF extensions not supported
return name, code; -- so return the name and the code
end
ietf_code = code; -- remember that we found an IETF-like code and save its name
ietf_name = name; -- but keep looking for a 2- or 3-char code
end
end
-- didn't find name with 2- or 3-char code; if IETF-like code found return
return ietf_code and ietf_name or lang; -- associated name; return original language text else
end
 
 
--[[-------------------< L A N G U A G E _ P A R A M E T E R >------------------
 
Gets language name from a provided two- or three-character ISO 639 code.  If a code
is recognized by MediaWiki, use the returned name; if not, then use the value that
was provided with the language parameter.
 
When |language= contains a recognized language (either code or name), the page is
assigned to the category for 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 but code 'ara' is not.
 
This function supports multiple languages in the form |language=nb, French, th
where the language names or codes are separated from each other by commas with
optional space characters.
 
]]
 
local function language_parameter (lang)
local code; -- the two- or three-character language code
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/17712...17821"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information