Module:Citation/CS1: Difference between revisions

147,782 bytes added ,  2 years ago
m
m>Dragons flight
(sync to sandbox, addresses archiveurl= error handling)
m (21 revisions imported from wikipedia:Module:Citation/CS1: see Topic:Vtixlm0q28eo6jtf)
 
(113 intermediate revisions by 16 users not shown)
Line 1: Line 1:
local z = {
    error_categories = {};
}


-- 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 .. "[" .. args.prefix .. url_string .. args.suffix .. " " .. nowiki(args.id) .. "]"
returns false when the value contains any of these characters.
 
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid URL (the
|<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",label="ASIN",prefix="//www.amazon."..domain.."/dp/",id=id,encode=false})
portions of the URL.  If both are valid, or for protocol-relative if domain is valid, return true, else false.
 
Because it is different from a standard URL, and because this module used external_link() to make external links
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 )
 
    return str:gsub( '[%[%]\n]', {   
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
        ['['] = '&#91;',
non-space characters following the opening bracket appear to be a URL.  The test will also find external wikilinks
        [']'] = '&#93;',
that use protocol-relative URLs. Also finds bare URLs.
        ['\n'] = ' ' } );
 
The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs.  The tests that
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
is possible as might be [[en://Hus]].
 
]=]
 
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
end


-- Converts a hyphen to a dash
 
function hyphentodash( str )
--[[-------------------------< C H E C K _ F O R _ U R L >-----------------------------------------------------
    if str == nil then
 
        return nil;
loop through a list of parameters and their values.  Look at the value and if it has an external link, emit an error message.
    end  
 
    if str:match( "[%[%]{}<>]" ) ~= nil then
]]
        return str;
 
    end  
local function check_for_url (parameter_list)
    return str:gsub( '-', '' );
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
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
 
function safeforitalics( str )
--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------
    --[[ 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
Escape sequences for content that will be used for URL descriptions
    (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
 
    tend to interact poorly under Mediawiki's HTML tidy. ]]
]]
   
 
    if str == nil or str == '' then
local function safe_for_url( str )
        return str;
if str:match( "%[%[.-%]%]" ) ~= nil then  
    else
table.insert( z.message_tail, { utilities.set_message ( 'err_wikilink_in_url', {}, true ) } );
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
end
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
        return str;
return str:gsub( '[%[%]\n]', {
    end
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end
end


--[[
 
Joins a sequence of string together while checking for duplicate separation
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
characters.
 
Format an external link with error checking
 
]]
]]
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);
                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;
                    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 external_link( URL, label, source, access)
Return the year portion of a date string, if possible.   
local error_str = "";
Returns empty string if the argument can not be interpreted
local domain;
as a year.
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 messageOnly 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
 
]]
]]
function selectyear( str )
 
    -- Is the input a simple number?
local function deprecated_parameter(name)
    local num = tonumber( str );
if not added_deprecated_cat then
    if num ~= nil and num > 0 and num < 2100 and num == math.abs(num) then
added_deprecated_cat = true; -- note that we've added this category
        return str;
table.insert( z.message_tail, { utilities.set_message ( 'err_deprecated_params', {name}, true ) } ); -- add error message
    else
end
        -- Use formatDate to interpret more complicated formats
        local lang = mw.getContentLanguage();
        local good, result;
        good, result = pcall( lang.formatDate, lang, 'Y', str )
        if good then
            return result;
        else
            -- Can't make sense of this input, return blank.
            return "";
        end
    end
end
end


-- Formats an OpenLibrary link, and checks for associated errors.
 
function openlibrary(id)
--[[--------------------------< D I S C O U R A G E D _ P A R A M E T E R >------------------------------------
    local code = id:sub(-1,-1)
 
    if ( code == "A" ) then
Categorize and emit an maintenance message when the citation contains one or more discouraged parameters.  Only
        return externallinkid({link="Open Library",label="OL",prefix="http://openlibrary.org/authors/OL",id=id})
one error message is emitted regardless of the number of discouraged parameters in the citation.
    elseif ( code == "M" ) then
 
        return externallinkid({link="Open Library",label="OL",prefix="http://openlibrary.org/books/OL",id=id})
added_discouraged_cat is a Boolean declared in page scope variables above
    elseif ( code == "W" ) then
 
        return externallinkid({link="Open Library",label="OL",prefix= "http://openlibrary.org/works/OL",id=id})
]]
    else
 
        table.insert( z.error_categories, "Pages with OL errors" );
local function discouraged_parameter(name)
        return externallinkid({link="Open Library",label="OL",prefix= "http://openlibrary.org/OL",id=id}) ..
if not added_discouraged_cat then
            ' <span class="error">Bad OL specified</span>';
added_discouraged_cat = true; -- note that we've added this category
    end
table.insert( z.message_tail, { utilities.set_message ( 'maint_discouraged', {name}, true ) } ); -- add maint message
end
end
end


-- Attempts to convert names to initials.
 
function reducetoinitials(first)
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
    local initials = {}
 
    for word in string.gmatch(first, "%S+") do
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
mark contained in a |title= or |chapter= parameter's value.
    end
 
    return table.concat(initials) -- Vancouver format does not include spaces.
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
end


-- Formats a list of people (e.g. authors / editors)
 
function listpeople(control, people)
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
    local sep = control.sep;
 
    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
|script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
    local namesep = control.namesep
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
    local format = control.format
in italic markup.
    local maximum = control.maximum
 
    local lastauthoramp = control.lastauthoramp;
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.
    local text = {}
 
    local etal = false;
|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:
    for i,person in ipairs(people) do
|script-title=ja:*** *** (where * represents a Japanese character)
        if (person.last ~= nil or person.last ~= "") then
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
            local mask = person.mask
|script-title=ja : *** ***
            local one
|script-title=ja: *** ***
            if ( maximum ~= nil and i == maximum + 1 ) then
|script-title=ja :*** ***
                etal = true;
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
                break;
 
            elseif (mask ~= nil) then
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
                local n = tonumber(mask)
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute
                if (n ~= nil) then
is not added.  At this time there is no error message for this condition.
                    one = string.rep("&mdash;",n)
 
                else
Supports |script-title=, |script-chapter=, |script-<periodical>=
                    one = mask
 
                end
]]
            else
 
                one = person.last
local function format_script_value (script_value, script_param)
                local first = person.first
local lang=''; -- initialize to empty string
                if (first ~= nil and first ~= '') then
local name;
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
                    one = one .. namesep .. first
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
                end
if not utilities.is_set (lang) then
                if (person.link ~= nil and person.link ~= "") then one = "[[" .. person.link .. "|" .. one .. "]]" end
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message
            end
return ''; -- script_value was just the prefix so return empty string
            table.insert(text, one)
end
        end
-- if we get this far we have prefix and script
    end
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
    local count = #text;
if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code?
    if count > 1 and lastauthoramp ~= nil and lastauthoramp ~= "" and not etal then
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
        text[count-1] = text[count-1] .. " & " .. text[count];
-- is prefix one of these language codes?
        text[count] = nil;
if utilities.in_array (lang, cfg.script_lang_codes) then
    end   
utilities.add_prop_cat ('script_with_name', {name, lang})
    local result = table.concat(text, sep) -- construct list
else
    if etal then
table.insert( z.message_tail, { utilities.set_message ( 'err_script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message
        local etal_text = "et al."
end
        if (sepc == ".") then etal_text = "et al" end
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
        result = result .. " " .. etal_text;
else
    end
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
    if ( "scap" == format ) then result= createTag({name="span", contents=result, params={class="smallcaps", style="font-variant:small-caps;"}}) end -- if necessary wrap result in <span> tag to format in Small Caps
end
    return result, count
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
end


-- Generates a CITEREF anchor ID.
 
function anchorid(args)
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
    local P1 = args[1] or ""
 
    local P2 = args[2] or ""
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
    local P3 = args[3] or ""
wrapped in <bdi> tags.
    local P4 = args[4] or ""
]]
    local P5 = args[5] or ""
 
   
local function script_concatenate (title, script, script_param)
    -- Bugzilla 46608
if utilities.is_set (script) then
    local encoded = mw.uri.anchorEncode( P1 .. P2 .. P3 .. P4 .. P5 );
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
    if encoded == false then
if utilities.is_set (script) then
        encoded = "";
title = title .. ' ' .. script; -- concatenate title and script title
    end
end
   
end
    return "CITEREF" .. encoded;
return title;
end
end


-- Gets author list from the input arguments
 
function extractauthors(args)
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
    local authors = {};
 
    local i = 1;
Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
    local last;
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().
    while true do
 
        last = args["author" .. i .. "-last"] or args["author-last" .. i] or args["last" .. i] or args["surname" .. i] or args["Author" .. i] or args["author" .. i]
]]
        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
 
            authors[i] = {
local function wrap_msg (key, str, lower)
                last = last,
if not utilities.is_set ( str ) then
                first = args["author" .. i .. "-first"] or args["author-first" .. i] or args["first" .. i] or args["given" .. i],
return "";
                link = args["author" .. i .. "-link"] or args["author-link" .. i] or args["author" .. i .. "link"] or args["authorlink" .. i],
end
                mask = args["author" .. i .. "-mask"] or args["author-mask" .. i] or args["author" .. i .. "mask"] or args["authormask" .. i]
if true == lower then
            }
local msg;
        else
msg = cfg.messages[key]:lower(); -- set the message to lower case before
            break;
return utilities.substitute ( msg, str ); -- including template text
        end
else
        i = i + 1;
return utilities.substitute ( cfg.messages[key], str );
    end
end
    return authors;
end
end


-- Gets editor list from the input arguments
 
function extracteditors(args)
--[[----------------< W I K I S O U R C E _ U R L _ M A K E >-------------------
    local editors = {};
 
    local i = 1;
Makes a Wikisource URL from Wikisource interwiki-link.  Returns the URL and appropriate
    local last;
label; nil else.
   
 
    while true do
str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
        last = args["editor" .. i .. "-last"] or args["editor-last" .. i] or args["EditorSurname" .. i] or args["Editor" .. i] or args["editor" .. i]
 
        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
]]
            editors[i] = {
 
                last = last,
local function wikisource_url_make (str)
                first = args["editor" .. i .. "-first"] or args["editor-first" .. i] or args["EditorGiven" .. i],
local wl_type, D, L;
                link = args["editor" .. i .. "-link"] or args["editor-link" .. i] or args["editor" .. i .. "link"] or args["editorlink" .. i],
local ws_url, ws_label;
                mask = args["editor" .. i .. "-mask"] or args["editor-mask" .. i] or args["editor" .. i .. "mask"] or args["editormask" .. i]
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});
            }
 
        else
wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
            break;
 
        end
if 0 == wl_type then -- not a wikilink; might be from |title-link=
        i = i + 1;
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
    end
if utilities.is_set (str) then
    return editors;
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
end


--[[
 
This is the main function foing the majority of the citation
--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
formatting.
 
Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
and |trans-<periodical>= into a single Periodical meta-parameter.
 
]]
]]
function citation0( config, args)
    -- Load Input Parameters


    local PPrefix = config.PPrefix or "p.&nbsp;"
local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
    local PPPrefix = config.PPPrefix or "pp.&nbsp;"
local periodical_error = '';
    if ( nil ~= args.nopp ) then PPPrefix = "" PPrefix = "" end
   
    -- Transfer unnumbered arguments to numbered arguments if necessary.
    args["author1"] = args.author1 or args.author or args.authors
    args["author1-last"] = args["author1-last"] or args["author-last"] or args["last"]
    args["author1-first"] = args["author1-first"] or args["author-first"]
      or args.first or args.first1 or args.given or args.given1
    args["author1-link"] = args["author1-link"] or args["author-link"]
    args["author1-mask"] = args["author1-mask"] or args["author-mask"] or args["authormask"]
    args["author1link"] = args["author1link"] or args["authorlink"]   
    args["editor1"] = args["editor1"] or args["editor"]
    args["editor1-last"] = args["editor1-last"] or args["editor-last"]
    args["editor1-first"] = args["editor1-first"] or args["editor-first"]
    args["editor1-link"] = args["editor1-link"] or args["editor-link"]
    args["editor1-mask"] = args["editor1-mask"] or args["editor-mask"] or args["editormask"]
    args["editor1link"] = args["editor1link"] or args["editorlink"]   


    -- Pick out the relevant fields from the arguments. Different citation templates define different field names for the same underlying things.  
if not utilities.is_set (periodical) then
    local Authors = args.authors
periodical = ''; -- to be safe for concatenation
    local i
else
    local a = extractauthors( args );
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
 
 
--[[------------------< F O R M A T _ C H A P T E R _ T I T L E >---------------


    local Coauthors = args.coauthors or args.coauthor
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=,
    local Others = args.others
and |chapter-url= into a single chapter meta- parameter (chapter_url_source used
    local EditorMask = args.editormask or args["editor-mask"]
for error messages).
    local EditorFormat = args["editor-format"] or args.editorformat
 
    local Editors = args.editors
]]
    local e = extracteditors( args );


    local Year = args.year
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 PublicationDate = args.publicationdate or args["publication-date"]
local chapter_error = '';
    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 = ""           
        elseif ( Chapter == nil or Chapter == '' ) then
            if Title ~= args.encyclopedia then
                Chapter = Title
                TransChapter = TransTitle
                Title = ""           
            end
        end
        if ( Periodical and Periodical ~= "") then
            if Periodical == Title or Periodical == Chapter then Periodical = '' 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 Location = PublicationPlace
    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 "";
    local MessageTail = {};


    if ( config.CitationClass == "journal" ) then
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
        if (URL == nil or URL == "") then
if ws_url then
          if (PMC ~= nil and PMC ~="")
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
            then URL="http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. PMC
chapter = ws_label;
            else URL=nil
end
          end
        end
    elseif ( config.CitationClass == "citation" ) then
        sepc = ","
        if ( Ref == nil ) then Ref = "harv" end
    end


    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
if not utilities.is_set (chapter) then
   
chapter = ''; -- to be safe for concatenation
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
    if ( BookTitle ) then
        Chapter = Title
        ChapterLink = TitleLink
        TransChapter = TransTitle
        Title = BookTitle
        TitleLink = nil
        TransTitle = nil
    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
if false == no_quotes then
        end
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from module provided quote marks
    end
chapter = utilities.wrap_style ('quoted-title', chapter);
    local OCinSids = {} -- COinS data only for id, bibcode, doi, pmid, etc.
end
    OCinSids["info:arxiv"] = ARXIV
end
    OCinSids["info:asin"] = ASIN
    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
chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
        (Chapter == nil or Chapter == '') and
        (Title ~= nil and Title ~= "") then
            Chapter = Title
            ChapterLink = TitleLink
            TransChapter = TransTitle
            Title = nil
            TitleLink = nil
            TransTitle = nil           
    end


    -- Now perform various field substitutions.
if utilities.is_set (chapter_url) then
    -- We also add leading spaces and surrounding markup and punctuation to the various parts of the citation, but only when they are non-nil.
chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
    if ( Authors == nil ) then  
elseif ws_url then
        local Maximum = tonumber(args["display-authors"] or args.displayauthors);
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});
        -- Preserve old-style implicit et al.
end
        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( MessageTail, '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 utilities.is_set (trans_chapter) then
        if Maximum == nil and #e == 4 then
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
            Maximum = 3;
if utilities.is_set (chapter) then
            table.insert( z.error_categories, 'Pages using citations with old-style implicit et al.' );
chapter = chapter .. ' ' .. trans_chapter;
            table.insert( MessageTail, 'Citation uses old-style implicit et al. for editors' );
else -- here when trans_chapter without chapter or script-chapter
        elseif Maximum == nil then
chapter = trans_chapter;
            Maximum = #e + 1;
chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>
        end
chapter_error = ' ' .. utilities.set_message ('err_trans_missing_title', {chapter_source});
end
end


        local control = {
return chapter .. chapter_error;
            sep = (args["editor-separator"] or ";") .. " ",
end
            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)
    else
        EditorCount = 1;
    end
    if ( Date == nil or Date == "") then
--  there's something hinky with how this adds dashes to perfectly-good free-standing years
--[[        Date = Year
        if ( Date ~= nil ) then
            local Month = args.month
            if ( Month == nil ) then
                local Began = args.began
                local Ended = args.ended
                if Began ~= nil and Ended ~= nil then
                    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
--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------
    local DateIn = Date
   
    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
This function searches a parameter's value for non-printable or invisible characters.
        if ( config.CitationClass == "web" ) then
The search stops at the first match.
            table.insert( z.error_categories, 'Pages using web citations with no URL' );
            table.insert( MessageTail, 'No URL on cite web' );
        end


        -- Test if accessdate is given without giving a URL
This function will detect the visible replacement character when it is part of the Wikisource.
        if ( AccessDate ~= nil and AccessDate ~= '' ) then
            table.insert( z.error_categories, 'Pages using citations with accessdate and no URL' );
            table.insert( MessageTail, '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
Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers
    if ( Chapter == nil or Chapter == "" ) and  
(gallery, math, pre, ref) and identifies them with a slightly different error message.
            ( Title == nil or Title == "" ) and
See also coins_cleanup().
            ( Periodical == nil or Periodical == "" ) and
            ( Conference == nil or Conference == "" ) then
        table.insert( z.error_categories, 'Pages with citations lacking titles' );
        table.insert( MessageTail, 'Citation has no title' );
    end


    if ( Format ~= nil and Format ~="" ) then
Output of this function is an error message that identifies the character or the
        Format = " (" .. Format .. ")" else Format = "" 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 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
    if ( Chapter 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
        Chapter = Chapter .. TransChapter
        if ( ChapterLink == nil ) then
            if ( ChapterURL and "" < ChapterURL ) then
                Chapter = "[" .. ChapterURL .. " " .. safeforurl( Chapter )  .. "]"
            elseif ( URL and "" < URL ) then
                Chapter = "[" .. URL .. " " .. safeforurl( Chapter ) .. "]" .. Format
                URL = nil
                Format = ""
            end
        end
        Chapter = Chapter .. sepc .. " " -- with end-space
    else
        Chapter = ""
    end
    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" ) and
                Chapter == "" then
            Title = "\"" .. Title .. "\""
        else
            Title = "''" .. safeforitalics(Title) .. "''"
        end
        Title = Title .. TransTitle
        if ( TitleLink == nil and URL and "" < URL ) then
            Title = "[" .. URL .. " " .. safeforurl( Title ) .. "]" .. Format
            URL = nil
            Format = ''
        end
    else
        Title = ""
    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 ( PublicationPlace ~= nil and PublicationPlace ~="" ) then
        PublicationPlace = PublicationPlace .. ": "
        else PublicationPlace = "" 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
local function has_invisible_chars (param, v)
        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
local position = ''; -- position of invisible char or starting position of stripmarker
            Quote = Quote:sub(2,-2);
local capture; -- used by stripmarker detection to hold name of the stripmarker
        end
local stripmarker; -- boolean set true when a stripmarker is found
       
        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
        Lay = sepc .. " [" .. LaySummary .. " Lay summary]" .. LaySource .. LayDate
    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 ( PublicationDate and PublicationDate ~="" )
            then PublicationDate = " " .. PublicationDate
            else PublicationDate = "" end
        if ( PublisherName and PublisherName ~="" ) then
            Publisher = " (" .. PublicationPlace .. PublisherName .. PublicationDate .. ")"
        else
            if (Location ~= nil and Location ~= '') then Publisher= " (" .. Location .. ")"
            else Publisher = "" end
        end
    else
        if ( PublicationDate and PublicationDate ~="" ) then
            PublicationDate = " (published " .. PublicationDate .. ")"
            else PublicationDate = "" end
        if ( PublisherName and PublisherName ~="" ) then
            Publisher = sepc .. " " .. PublicationPlace .. PublisherName .. PublicationDate
        else
            if (Location ~= nil and Location ~= '') then Publisher= sepc .. " " .. Location
            else Publisher = "" end
        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.
capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true
    -- We build things this way because it is more efficient in LUA
if capture == v then -- if same there are no Unicode characters
    -- not to keep reassigning to the same string variable over and over.
return;
end


    local tcommon
for _, invisible_char in ipairs (cfg.invisible_chars) do
    if ( config.CitationClass == "journal" and
local char_name = invisible_char[1]; -- the character or group name
        Periodical ~= "" ) then
local pattern = invisible_char[2]; -- the pattern used to find it
        if (Others ~= "") then Others = Others .. sepc .. " " end
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume, Issue, Position}, sepc );
    elseif ( config.CitationClass == "citation" ) or (config.CitationClass == "encyclopaedia" ) then
if position and (cfg.invisible_defs.zwj == capture) then -- if we found a zero-width joiner character
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Issue, Edition, Publisher, Agency, Others, Position}, sepc );
if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts
    else  
position = nil; -- unset position
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Issue, Others, Edition, Publisher, Agency, Position}, sepc );
elseif cfg.emoji[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
    end
position = nil; -- unset position
   
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 );
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


    local text
table.insert (z.message_tail, {utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}, true)}); -- add error message
    local pgtext = Page .. Pages .. At
return; -- and done with this parameter
    if page_error then
end
        table.insert( z.error_categories, 'Pages with citations using conflicting page specifications' );
end
        pgtext = pgtext .. hiddencomment('Bad page specification here');
end
    end
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, 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, 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, tcommon}, sepc );
          text = safejoin( {text, pgtext, Date, idcommon}, sepc );
        else
          text = safejoin( {Chapter, tcommon, Date}, sepc );
          text = safejoin( {text, pgtext, idcommon}, sepc );
        end
    end
   
    if ( config.CitationClass == "citation") then PostScript = "" 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
    if ( Year == nil ) then
        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>';
        MessageTail = {};
    end
   
    text = createTag({name="span", contents=text, params=args})


    local empty_span = createTag( {name="span", contents="&nbsp;", params={style="display: none;"}} );
--[[-------------------< A R G U M E N T _ W R A P P E R >----------------------
   
 
    -- Note: Using display: none on then COinS span breaks some clients.
Argument wrapper.  This function provides support for argument mapping defined
    local OCinS = createTag({name="span", contents=empty_span, params={class="Z3988",title=OCinStitle }})
in the configuration file so that multiple names can be transparently aliased to
    text = text .. OCinS;
single internal variable.
   
 
    if #MessageTail ~= 0 then
]]
        text = text .. hiddencomment( table.concat( MessageTail, "; " ) );
 
    end
local function argument_wrapper ( args )
   
local origin = {};
    if no_tracking_cats == '' then
        for _, v in ipairs( z.error_categories ) do
return setmetatable({
            text = text .. '[[Category:' .. v ..']]';
ORIGIN = function ( self, k )
        end
local dummy = self[k]; -- force the variable to be loaded.
    end
return origin[k];
   
end
    return text
},
{
__index = function ( tbl, k )
if origin[k] ~= nil then
return nil;
end
local args, list, v = args, cfg.aliases[k];
if type( list ) == 'table' then
v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' );
if origin[k] == nil then
origin[k] = ''; -- Empty string, not nil
end
elseif list ~= nil then
v, origin[k] = args[list], list;
else
-- maybe let through instead of raising an error?
-- v, origin[k] = args[k], k;
error( cfg.messages['unknown_argument_map'] .. ': ' .. k);
end
-- Empty strings, not nil;
if v == nil then
v = '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
end


-- 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 O W R A P _ D A T E >-------------------------
    for k, v in pairs( frame.args ) do
 
        config[k] = v;
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
    end  
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
    return citation0( config, args)
 
DOES NOT yet support MMMM YYYY or any of the date ranges.
 
]]
 
local function nowrap_date (date)
local cap = '';
local cap2 = '';
 
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = utilities.substitute (cfg.presentation['nowrap1'], date);
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
end
return date;
end
end


return z
 
---------------------------------------------------------------------
--[[--------------------------< S E T _ T I T L E T Y P E >---------------------
--NOTES
 
--
This function sets default title types (equivalent to the citation including
-- NOTE A1: This Lua module was originally designed to handle a mix
|type=<default value>) for those templates that have defaults. Also handles the
--      of citation styles, crossing Vancouver
special case where it is desirable to omit the title type from the rendered citation
(|type=none).
 
]]
 
local function set_titletype (cite_class, title_type)
if utilities.is_set (title_type) then
if 'none' == cfg.keywords_xlate[title_type] then
title_type = ''; -- if |type=none then type parameter not displayed
end
return title_type; -- if |type= has been set to any other value use that value
end
 
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
 
 
--[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------
 
Converts a hyphen to a dash under certain conditions.  The hyphen must separate
like items; unlike items are returned unmodified.  These forms are modified:
letter - letter (A - B)
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
 
 
--[[--------------------------< S A F E _ J O I N >-----------------------------
 
Joins a sequence of strings together while checking for duplicate separation characters.
 
]]
 
local function safe_join( tbl, duplicate_char )
local f = {}; -- create a function table appropriate to type of 'duplicate character'
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
f.gsub = string.gsub
f.match = string.match
f.sub = string.sub
else -- for multi-byte characters use the ustring library functions
f.gsub = mw.ustring.gsub
f.match = mw.ustring.match
f.sub = mw.ustring.sub
end
 
local str = ''; -- the output string
local comp = ''; -- what does 'comp' mean?
local end_chr = '';
local trim;
for _, value in ipairs( tbl ) do
if value == nil then value = ''; end
if str == '' then -- if output string is empty
str = value; -- assign value to it (first time through the loop)
elseif value ~= '' then
if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
else
comp = value;
end
-- typically duplicate_char is sepc
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
--  Because individual string segments often (always?) begin with terminal punct for the
--  preceding segment: 'First element' .. 'sepc next element' .. etc.?
trim = false;
end_chr = f.sub(str, -1, -1); -- get the last character of the output string
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
if end_chr == duplicate_char then -- if same as separator
str = f.sub(str, 1, -2); -- remove it
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''
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
elseif  f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
trim = true; -- why? why do this and next differently from previous?
elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
trim = true; -- same question
end
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
 
 
--[[--------------------------< I S _ S U F F I X >-----------------------------
 
returns true is suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
Puncutation not allowed.
 
]]
 
local function is_suffix (suffix)
if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
return true;
end
return false;
end
 
 
--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------
 
For Vancouver style, author/editor names are supposed to be rendered in Latin
(read ASCII) characters.  When a name uses characters that contain diacritical
marks, those characters are to be converted to the corresponding Latin
character. When a name is written using a non-Latin alphabet or logogram, that
name is to be transliterated into Latin characters. The module doesn't do this
so editors may/must.
 
This test allows |first= and |last= names to contain any of the letters defined
in the four Unicode Latin character sets
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
 
|lastn= also allowed to contain hyphens, spaces, and apostrophes.
(http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
 
This original test:
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$")
or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a