Module:Citation/CS1: Difference between revisions

    m (254 revisions imported from templatewiki:Module:Citation/CS1)
    (sync from sandbox;)
    Line 1: Line 1:
    local cs1 ={};


    --[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
    --[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
    Line 9: Line 7:


    local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities
    local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities
    add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink;
    add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink,
    strip_apostrophe_markup;


    local z ={}; -- tables in Module:Citation/CS1/Utilities
    local z ={}; -- tables in Module:Citation/CS1/Utilities
    Line 71: Line 70:
    if not added_prop_cats [key] then
    if not added_prop_cats [key] then
    added_prop_cats [key] = true; -- note that we've added this category
    added_prop_cats [key] = true; -- note that we've added this category
    key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname
    key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?[%a%-]*', '%1'); -- strip lang code from keyname
    table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
    table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
    end
    end
    end
    end
    Line 133: Line 132:
    the first character of the whole domain name including subdomains must be a letter or a digit
    the first character of the whole domain name including subdomains must be a letter or a digit
    internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
    internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
    single-letter/digit second-level domains in the .org and .cash TLDs
    single-letter/digit second-level domains in the .org, .cash, and .today TLDs
    q, x, and z SL domains in the .com TLD
    q, x, and z SL domains in the .com TLD
    i and q SL domains in the .net TLD
    i and q SL domains in the .net TLD
    Line 152: Line 151:
    domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once
    domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once
    if not domain:match ('^[%a%d]') then -- first character must be letter or digit
    if not domain:match ('^[%w]') then -- first character must be letter or digit
    return false;
    return false;
    end
    end
    -- Do most common case first
     
    if domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$') then -- three or more character hostname.hostname or hostname.tld
    if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at wikisource
    return true;
    elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix
    return true;
    elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname
    return true;
    elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character/digit .org hostname
    return true;
    elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10)
    return true;
    elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
    return true;
    elseif domain:match ('%f[%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars)
    return true;
    elseif domain:match ('%f[%a%d][%a%d][%a%d]%.%a%a+$') then -- two character hostname and tld
    return true;
    elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address
    return true;
    else
    return false;
    return false;
    end
    end
    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
    end


    Line 399: Line 403:
    local path;
    local path;
    local base_url;
    local base_url;
     
    if not is_set( label ) then
    if not is_set( label ) then
    label = URL;
    label = URL;
    Line 419: Line 423:


    base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wikimarkup url
    base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wikimarkup url
     
    if is_set (access) then -- access level (subscription, registration, limited)
    if is_set (access) then -- access level (subscription, registration, limited)
    base_url = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
    base_url = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
    Line 441: Line 445:
    if not added_deprecated_cat then
    if not added_deprecated_cat then
    added_deprecated_cat = true; -- note that we've added this category
    added_deprecated_cat = true; -- note that we've added this category
    table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
    table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
    end
    end
    end
    end
    Line 523: Line 527:
    is not added.  At this time there is no error message for this condition.
    is not added.  At this time there is no error message for this condition.


    Supports |script-title= and |script-chapter=
    Supports |script-title=, |script-chapter=, |script-<periodical>=


    TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
    ]]
    ]]


    local function format_script_value (script_value)
    local function format_script_value (script_value, script_param)
    local lang=''; -- initialize to empty string
    local lang=''; -- initialize to empty string
    local name;
    local name;
    if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
    -- if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
    lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
    if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
    -- lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
    lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
    if not is_set (lang) then
    if not is_set (lang) then
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message
    return ''; -- script_value was just the prefix so return empty string
    return ''; -- script_value was just the prefix so return empty string
    end
    end
    -- if we get this far we have prefix and script
    -- if we get this far we have prefix and script
    name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, "en" ); -- get language name so that we can use it to categorize
    name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
    if is_set (name) then -- is prefix a proper ISO 639-1 language code?
    if is_set (name) then -- is prefix a proper ISO 639-1 language code?
    script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script
    -- script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script
    script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
    -- is prefix one of these language codes?
    -- is prefix one of these language codes?
    if in_array (lang, cfg.script_lang_codes) then
    if in_array (lang, cfg.script_lang_codes) then
    add_prop_cat ('script_with_name', {name, lang})
    add_prop_cat ('script_with_name', {name, lang})
    else
    else
    add_prop_cat ('script')
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message
    end
    end
    lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
    lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
    else
    else
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message
    lang = ''; -- invalid so set lang to empty string
    lang = ''; -- invalid so set lang to empty string
    end
    end
    else
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message
    end
    end
    script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
    script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
    Line 563: Line 573:
    ]]
    ]]


    local function script_concatenate (title, script)
    local function script_concatenate (title, script, script_param)
    if is_set (script) then
    if is_set (script) then
    script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
    script = format_script_value (script, script_param); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
    if is_set (script) then
    if is_set (script) then
    title = title .. ' ' .. script; -- concatenate title and script title
    title = title .. ' ' .. script; -- concatenate title and script title
    Line 589: Line 599:
    local msg;
    local msg;
    msg = cfg.messages[key]:lower(); -- set the message to lower case before  
    msg = cfg.messages[key]:lower(); -- set the message to lower case before  
    return substitute( msg, str ); -- including template text
    return substitute( msg, str ); -- including template text
    else
    else
    return substitute( cfg.messages[key], str );
    return substitute( cfg.messages[key], str );
    Line 596: Line 606:




    --[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
    --[[--------------------------< W I K I S O U R C E _ U R L _ M A K E >----------------------------------------
     
    makes a wikisource url from wikisource interwiki link.  returns the url and appropriate label; nil else.


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


    ]]
    ]]


    local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access)
    local function wikisource_url_make (str)
    local chapter_error = '';
    local wl_type, D, L;
    local ws_url, ws_label;
     
    wl_type, D, L = is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
     
    if 0 == wl_type then -- not a wikilink; might be from |title-link=
    str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
    if is_set (str) then
    ws_url = table.concat ({ -- build a wikisource url
    'https://en.wikisource.org/wiki/', -- 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 is_set (str) then
    ws_url = table.concat ({ -- build a wikisource url
    'https://en.wikisource.org/wiki/', -- 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 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
    'https://en.wikisource.org/wiki/', -- prefix
    str, -- article title without namespace from link portion of wikilink
    });
    end
    end
    if not is_set (chapter) then
    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 anchor
    end
     
    return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil
    end
     
     
    --[[--------------------------< F O R M A T _ P E R I O D I C A L >--------------------------------------------
     
    Format the four periodical parameters: |script-<periodical>=, |<periodical>=, and |trans-<periodical>= into a single Periodical meta-
    parameter.
     
    ]]
     
    local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
    local periodical_error = '';
     
    if not is_set (periodical) then
    periodical = ''; -- to be safe for concatenation
    else
    periodical = wrap_style ('italic-title', periodical); -- style
    end
     
    periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
     
    if is_set (trans_periodical) then
    trans_periodical = wrap_style ('trans-italic-title', trans_periodical);
    if is_set (periodical) then
    periodical = periodical ..  ' ' .. trans_periodical;
    else -- here when transchapter without chapter or script-chapter
    periodical = trans_periodical;
    periodical_error = ' ' .. set_error ('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 >--------------------------------------
     
    Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
    parameter (chapter_url_source used for error messages).
     
    ]]
     
    local function format_chapter_title (scriptchapter, script_chapter_source, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access)
    local chapter_error = '';
     
    local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource url and label from a wikisource interwiki link
    if ws_url then
    ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters
    chapter = ws_label;
    end
     
    if not is_set (chapter) then
    chapter = ''; -- to be safe for concatenation
    chapter = ''; -- to be safe for concatenation
    else
    else
    Line 615: Line 715:
    end
    end


    chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    chapter = script_concatenate (chapter, scriptchapter, script_chapter_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped


    if is_set (chapterurl) then
    if is_set (chapterurl) then
    chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
    chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
    elseif ws_url then
    chapter = external_link (ws_url, chapter .. '&nbsp;', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this?
    chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
    end
    end


    Line 626: Line 729:
    chapter = chapter ..  ' ' .. transchapter;
    chapter = chapter ..  ' ' .. transchapter;
    else -- here when transchapter without chapter or script-chapter
    else -- here when transchapter without chapter or script-chapter
    chapter = transchapter; --
    chapter = transchapter;
    chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
    chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
    end
    end
    Line 632: Line 735:


    -- if is_set (chapterurl) then
    -- if is_set (chapterurl) then
    -- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
    -- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
    -- end
    -- end


    Line 648: Line 751:
    Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers (gallery, math, pre, ref)
    Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers (gallery, math, pre, ref)
    and identifies them with a slightly different error message.  See also coins_cleanup().
    and identifies them with a slightly different error message.  See also coins_cleanup().
    Detects but ignores the character pattern that results from the transclusion of {{'}} templates.


    Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
    Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
    Line 737: Line 838:
    -- maybe let through instead of raising an error?
    -- maybe let through instead of raising an error?
    -- v, origin[k] = args[k], k;
    -- v, origin[k] = args[k], k;
    error( cfg.messages['unknown_argument_map'] );
    error( cfg.messages['unknown_argument_map'] .. ': ' .. k);
    end
    end
    Line 822: Line 923:
    return str; -- nothing to do, we're done
    return str; -- nothing to do, we're done
    end
    end
    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
    local out = {};
    local out = {};
    Line 828: Line 932:
    for _, item in ipairs (list) do -- for each item in the list
    for _, item in ipairs (list) do -- for each item in the list
    if mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators
    if 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)
    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+[%.%-]?%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+[%.%-]%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 ('^%d+%s*%-%s*%d+$') or -- digit hyphen digit
    item:match ('%a+%s*%-%s*%a+') then -- letter hyphen letter
    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
    item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters
    else
    else
    Line 974: Line 1,078:


    local function is_good_vanc_name (last, first)
    local function is_good_vanc_name (last, first)
    local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it
    local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it


    if is_set (suffix) then
    if is_set (suffix) then
    Line 1,067: Line 1,171:
    sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma
    sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma
    namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
    namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
    lastauthoramp = nil; -- unset because isn't used by Vancouver style
    else
    else
    sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon
    sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon
    Line 1,154: Line 1,259:
    --[[--------------------------< N A M E _ H A S _ E T A L >----------------------------------------------------
    --[[--------------------------< N A M E _ H A S _ E T A L >----------------------------------------------------


    Evaluates the content of author and editor name parameters for variations on the theme of et al.  If found,
    Evaluates the content of name parameters (author, editor, etc) for variations on the theme of et al.  If found,
    the et al. is removed, a flag is set to true and the function returns the modified name and the flag.
    the et al. is removed, a flag is set to true and the function returns the modified name and the flag.


    This function never sets the flag to false but returns it's previous state because it may have been set by
    This function never sets the flag to false but returns it's previous state because it may have been set by
    previous passes through this function or by the parameters |display-authors=etal or |display-editors=etal
    previous passes through this function or by the associated |display-<names>=etal parameter


    ]]
    ]]


    local function name_has_etal (name, etal, nocat)
    local function name_has_etal (name, etal, nocat, param)


    if is_set (name) then -- name can be nil in which case just return
    if is_set (name) then -- name can be nil in which case just return
    local etal_pattern = "[;,]? *[\"']*%f[%a][Ee][Tt] *[Aa][Ll][%.\"']*$" -- variations on the 'et al' theme
    local patterns = cfg.et_al_patterns; --get patterns from configuration
    local others_pattern = "[;,]? *%f[%a]and [Oo]thers"; -- and alternate to et al.
    if name:match (etal_pattern) then -- variants on et al.
    for _, pattern in ipairs (patterns) do -- loop through all of the patterns
    name = name:gsub (etal_pattern, ''); -- if found, remove
    if name:match (pattern) then -- if this 'et al' pattern is found in name
    etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
    name = name:gsub (pattern, ''); -- remove the offending text
    if not nocat then -- no categorization for |vauthors=
    etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
    add_maint_cat ('etal'); -- and add a category if not already added
    if not nocat then -- no categorization for |vauthors=
    end
    table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added
    elseif name:match (others_pattern) then -- if not 'et al.', then 'and others'?
    end
    name = name:gsub (others_pattern, ''); -- if found, remove
    etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
    if not nocat then -- no categorization for |vauthors=
    add_maint_cat ('etal'); -- and add a category if not already added
    end
    end
    end
    end
    end
    end
    return name, etal; --  
    return name, etal; --  
    end
    end
    Line 1,196: Line 1,297:
    local function name_has_ed_markup (name, list_name)
    local function name_has_ed_markup (name, list_name)
    local _, pattern;
    local _, pattern;
    local patterns = { -- these patterns match annotations at end of name
    local patterns = cfg.editor_markup_patterns; -- get patterns from configuration
    '%f[%(%[][%(%[]%s*[Ee][Dd][Ss]?%.?%s*[%)%]]?$', -- (ed) or (eds): leading '(', case insensitive 'ed', optional 's', '.' and/or ')'
     
    '[,%.%s]%f[e]eds?%.?$', -- ed or eds: without '('or ')'; case sensitive (ED could be initials Ed could be name)
    '%f[%(%[][%(%[]%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.?%s*[%)%]]?$', -- (editor) or (editors): leading '(', case insensitive, optional '.' and/or ')'
    '[,%.%s]%f[Ee][Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.?$', -- editor or editors: without '('or ')'; case insensitive
    -- these patterns match annotations at beginning of name
    '^eds?[%.,;]', -- ed. or eds.: lower case only, optional 's', requires '.'
    '^[%(%[]%s*[Ee][Dd][Ss]?%.?%s*[%)%]]', -- (ed) or (eds): also sqare brackets, case insensitive, optional 's', '.'
    '^[%(%[]?%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%A', -- (editor or (editors: also sq brackets, case insensitive, optional brackets, 's'
    '^[%(%[]?%s*[Ee][Dd][Ii][Tt][Ee][Dd]%A', -- (edited: also sq brackets, case insensitive, optional brackets
    }
     
    if is_set (name) then
    if is_set (name) then
    for _, pattern in ipairs (patterns) do -- spin through patterns table and
    for _, pattern in ipairs (patterns) do -- spin through patterns table and
    Line 1,295: Line 1,385:
    local etal=false; -- return value set to true when we find some form of et al. in an author parameter
    local etal=false; -- return value set to true when we find some form of et al. in an author parameter


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


    last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al.
    last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al.
    first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al.
    first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.
    last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks
    last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks
    if first and not last then -- if there is a firstn without a matching lastn
    if first and not last then -- if there is a firstn without a matching lastn
    table.insert( z.message_tail, { set_error( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
    table.insert( z.message_tail, { set_error( 'first_missing_last', {first_alias, first_alias:gsub('first', 'last')}, true ) } ); -- add this error message
    elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
    elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
    count = count + 1; -- number of times we haven't found last and first
    count = count + 1; -- number of times we haven't found last and first
    Line 1,319: Line 1,409:
    n = n + 1; -- point to next location in the names table
    n = n + 1; -- point to next location in the names table
    if 1 == count then -- if the previous name was missing
    if 1 == count then -- if the previous name was missing
    table.insert( z.message_tail, { set_error( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
    table.insert( z.message_tail, { set_error( 'missing_name', {list_name:match ("(%w+)List"):lower(), i-1}, true ) } ); -- add this error message
    end
    end
    count = 0; -- reset the counter, we're looking for two consecutive missing names
    count = 0; -- reset the counter, we're looking for two consecutive missing names
    Line 1,342: Line 1,432:
    extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support
    extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support
    code 'cbk' or name 'Chavacano'.  Most (all?) of these languages are not used a 'language' codes per se, rather they
    code 'cbk' or name 'Chavacano'.  Most (all?) of these languages are not used a 'language' codes per se, rather they
    are used as sub-domain names: cbk-zam.wikipedia.org.  These names can be found (for the time being) at
    are used as sub-domain names: cbk-zam.wikipedia.org.  A list of language names and codes supported by fetchLanguageNames()
    https://phabricator.wikimedia.org/diffusion/ECLD/browse/master/LocalNames/LocalNamesEn.php
    can be found at Template:Citation Style documentation/language/doc


    Names but that are included in the list will be found if that name is provided in the |language= parameter.  For example,
    Names that are included in the list will be found if that name is provided in the |language= parameter.  For example,
    if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'.  When names are found
    if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'.  When names are found
    and the associated code is not two or three characters, this function returns only the Wikimedia language name.
    and the associated code is not two or three characters, this function returns only the WikiMedia language name.
     
    Some language names have multiple entries under different codes:
    Aromanian has code rup and code roa-rup
    When this occurs, this function returns the language name and the 2- or 3-character code


    Adapted from code taken from Module:Check ISO 639-1.
    Adapted from code taken from Module:Check ISO 639-1.
    Line 1,358: Line 1,452:
    end
    end


    local ietf_code; -- because some languages have both ietf-like codes and iso 639-like codes
    local ietf_name;
    local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
    local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
    -- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
    -- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
    local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
    local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
     
    for code, name in pairs(languages) do -- scan the list to see if we can find our language
    for code, name in pairs(languages) do -- scan the list to see if we can find our language
    if langlc == mw.ustring.lower(name) then
    if langlc == mw.ustring.lower(name) then
    if 2 ~= code:len() and 3 ~= code:len() then -- two- or three-character codes only; extensions not supported
    if 2 == code:len() or 3 == code:len() then -- two- or three-character codes only; extensions not supported
    return name; -- so return the name but not the code
    return name, code; -- so return the name and the code
    end
    end
    return name, code; -- found it, return name to ensure proper capitalization and the the code
    ietf_code = code; -- remember that we found an ietf-like code and save its name
    ietf_name = name; -- but keep looking for a 2- or 3-char code
    end
    end
    end
    end
    return lang; -- not valid language; return language in original case and nil for the code
    -- didn't find name with 2- or 3-char code; if ietf-like code found return
    return ietf_code and ietf_name or lang; -- associated name; return original language text else
    end
    end


    Line 1,397: Line 1,496:
    local names_table = {}; -- table made from the value assigned to |language=
    local names_table = {}; -- table made from the value assigned to |language=


    local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki
    local this_wiki_name = mw.language.fetchLanguageName(cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name
    local this_wiki_code = this_wiki:getCode() -- get this wiki's language code
    local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, this_wiki_code); -- get this wiki's language name


    names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
    names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list


    for _, lang in ipairs (names_table) do -- reuse lang
    for _, lang in ipairs (names_table) do -- reuse lang
    name = cfg.lang_code_remap[lang:lower()]; -- first see if this is a code that is not supported by MediaWiki but is in remap


    if lang:match ('^%a%a%-') then -- strip ietf language tags from code; TODO: is there a need to support 3-char with tag?
    if name then -- there was a remapped code so
    lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
    if not lang:match ('^%a%a%a?%-x%-%a+$') then -- if not a private ietf tag
    end
    lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip ietf tags from code
    if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code
    end
    name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code
    else
    if not is_set (name) then
    if lang:match ('^%a%a%-') then -- strip ietf tags from code; TODO: is there a need to support 3-char with tag?
    name = cfg.lang_code_remap[lang]; -- not supported by MediaWiki; is it in remap?
    lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
    end
    if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code
    name = mw.language.fetchLanguageName (lang:lower(), cfg.this_wiki_code); -- get language name if |language= is a proper code
    end
    end
    end
    end
     
    if is_set (name) then -- if |language= specified a valid code
    if is_set (name) then -- if |language= specified a valid code
    code = lang:lower(); -- save it
    code = lang:lower(); -- save it
    else
    else
    name, code = get_iso639_code (lang, this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
    name, code = get_iso639_code (lang, cfg.this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
    end
    end
    Line 1,424: Line 1,525:
    name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names
    name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names


    if this_wiki_code ~= code then -- when the language is not the same as this wiki's language
    if cfg.this_wiki_code ~= code then -- when the language is not the same as this wiki's language
    if 2 == code:len() then -- and is a two-character code
    if 2 == code:len() then -- and is a two-character code
    add_prop_cat ('foreign_lang_source' .. code, {name, code}) -- categorize it
    add_prop_cat ('foreign_lang_source' .. code, {name, code}); -- categorize it; code appended to allow for multiple language categorization
    else -- or is a recognized language (but has a three-character code)
    else -- or is a recognized language (but has a three-character code)
    add_prop_cat ('foreign_lang_source_2' .. code, {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
    add_prop_cat ('foreign_lang_source_2' .. code, {code}); -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
    end
    end
    elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
    add_prop_cat ('local_lang_source', {name, code}); -- categorize it
    end
    end
    else
    else
    Line 1,441: Line 1,544:
    code = #language_list -- reuse code as number of languages in the list
    code = #language_list -- reuse code as number of languages in the list
    if 2 >= code then
    if 2 >= code then
    name = table.concat (language_list, ' and ') -- insert '<space>and<space>' between two language names
    name = table.concat (language_list, cfg.messages['parameter-pair-separator']) -- insert '<space>and<space>' between two language names
    elseif 2 < code then
    elseif 2 < code then
    language_list[code] = 'and ' .. language_list[code]; -- prepend last name with 'and<space>'
    name = table.concat (language_list, ', '); -- and concatenate with '<comma><space>' separators
    name = table.concat (language_list, ', ') -- and concatenate with '<comma><space>' separators
    name = name:gsub (', ([^,]+)$', cfg.messages['parameter-final-separator'] .. '%1'); -- replace last '<comma><space>' separator with '<comma><space>and<space>' separator
    end
    end
    if this_wiki_name == name then
    if this_wiki_name == name then
    Line 1,546: Line 1,649:


    local function is_pdf (url)
    local function is_pdf (url)
    return url:match ('%.pdf$') or url:match ('%.PDF$') or url:match ('%.pdf[%?#]') or url:match ('%.PDF[%?#]');
    return url:match ('%.pdf$') or url:match ('%.PDF$') or
    url:match ('%.pdf[%?#]') or url:match ('%.PDF[%?#]') or
    url:match ('%.PDF&#035') or url:match ('%.pdf&#035');
    end
    end


    Line 1,574: Line 1,679:




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


    Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag
    Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag
    Line 1,597: Line 1,702:
    ]]
    ]]


    local function get_display_authors_editors (max, count, list_name, etal)
    local function get_display_names (max, count, list_name, etal)
    if is_set (max) then
    if is_set (max) then
    if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
    if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
    Line 1,605: Line 1,710:
    max = tonumber (max); -- make it a number
    max = tonumber (max); -- make it a number
    if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
    if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
    add_maint_cat ('disp_auth_ed', cfg.special_case_translation [list_name]);
    add_maint_cat ('disp_name', cfg.special_case_translation [list_name]);
    end
    end
    else -- not a valid keyword or number
    else -- not a valid keyword or number
    Line 1,706: Line 1,811:


    vparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (do it here because et al. might have a period)
    vparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (do it here because et al. might have a period)
    v_name_table = get_v_name_table (vparam, v_name_table, v_link_table); -- names are separated by commas
    v_name_table = get_v_name_table (vparam, v_name_table, v_link_table); -- names are separated by commas


    for i, v_name in ipairs(v_name_table) do
    for i, v_name in ipairs(v_name_table) do
    Line 1,809: Line 1,914:


    This function is used to validate a parameter's assigned value for those parameters that have only a limited number
    This function is used to validate a parameter's assigned value for those parameters that have only a limited number
    of allowable values (yes, y, true, no, etc).  When the parameter value has not been assigned a value (missing or empty
    of allowable values (yes, y, true, live, dead, etc).  When the parameter value has not been assigned a value (missing
    in the source template) the function returns true.  If the parameter value is one of the list of allowed values returns
    or empty in the source template) the function returns the value specified by ret_val.  If the parameter value is one
    true; else, emits an error message and returns false.
    of the list of allowed values returns the translated value; else, emits an error message and returns the value
    specified by ret_val.


    ]]
    ]]


    local function is_valid_parameter_value (value, name, possible)
    local function is_valid_parameter_value (value, name, possible, ret_val)
    if not is_set (value) then
    if not is_set (value) then
    return true; -- an empty parameter is ok
    return ret_val; -- an empty parameter is ok
    elseif in_array(value:lower(), possible) then
    elseif in_array (value, possible) then
    return true;
    return cfg.keywords_xlate[value]; -- return translation of parameter keyword
    else
    else
    table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message
    table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message
    return false
    return ret_val;
    end
    end
    end
    end
    Line 1,869: Line 1,975:
    end
    end


    local vol = '';
    if 'podcast' == cite_class and is_set (issue) then
    return wrap_msg ('issue', {sepc, issue}, lower);
    end
     
    local vol = ''; -- here for all cites except magazine
    if is_set (volume) then
    if is_set (volume) then
    if (4 < mw.ustring.len(volume)) then
    if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')then -- volume value is all digits or all uppercase roman numerals
    vol = substitute (cfg.messages['j-vol'], {sepc, volume});
    vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- render in bold face
    else
    elseif (4 < mw.ustring.len(volume)) then -- not all digits or roman numerals and longer than 4 characters
    vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)});
    vol = substitute (cfg.messages['j-vol'], {sepc, volume}); -- not bold
    add_prop_cat ('long_vol');
    else -- four or less characters
    vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- bold
    end
    end
    end
    end
    Line 1,925: Line 2,038:
    if is_journal then
    if is_journal then
    return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
    return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
    elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
    elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
    return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
    return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
    elseif not nopp then
    elseif not nopp then
    Line 1,938: Line 2,051:




    --[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
    --[[--------------------------< I N S O U R C E _ L O C _ G E T >----------------------------------------------
     
    returns one of the in-source locators: page, pages, or at.


    Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the  
    If any of these are interwiki links to wikisource, returns the label portion of the interwikilink as plain text
    save snapshot url or to calendar pagesWhen the archive url is 'https://web.archive.org/save/' (or http://...)
    for use in COinSThis COinS thing is done because here we convert an interwiki link to and external link and
    archive.org saves a snapshot of the target page in the urlThat is something that Wikipedia should not allow
    add an icon span around that; get_coins_pages() doesn't know about the spanTODO: should it? 
    unwitting readers to do.


    When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own
    TODO: add support for sheet and sheets?; streamline;
    algorithm or provides a calendar 'search' result.  [[WP:ELNO]] discourages links to search results.


    This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
    TODO: make it so that this function returns only one of the three as the single in-source (the return value assigned
    |archive-date= and an error message when:
    to a new name)?
    |archive-url= holds an archive.org save command url
    |archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
    correct place
    otherwise returns |archive-url= and |archive-date=


    There are two mostly compatible archive.org urls:
    ]]
    //web.archive.org/<timestamp>... -- the old form
    //web.archive.org/web/<timestamp>... -- the new form


    The old form does not support or map to the new form when it contains a display flag.  There are four identified flags
    local function insource_loc_get (page, pages, at)
    ('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
    local ws_url, ws_label, coins_pages, L; -- for wikisource interwikilinks; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
    we don't check for these specific flags but we do check the form.


    This function supports a preview mode.  When the article is rendered in preview mode, this funct may return a modified
    if is_set (page) then
    archive url:
    if is_set (pages) or is_set(at) then
    for save command errors, return undated wildcard (/*/)
    pages = ''; -- unset the others
    for timestamp errors when the timestamp has a wildcard, return the url unmodified
    at = '';
    for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)
    end
    extra_text_in_page_check (page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.


    ]=]
    ws_url, ws_label, L = wikisource_url_make (page); -- make ws url from |page= interwiki link; link portion L becomes tool tip label
    if ws_url then
    page = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
    page = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
    coins_pages = ws_label;
    end
    elseif is_set (pages) then
    if is_set (at) then
    at = ''; -- unset
    end
    extra_text_in_page_check (pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.


    local function archive_url_check (url, date)
    ws_url, ws_label, L = wikisource_url_make (pages); -- make ws url from |pages= interwiki link; link portion L becomes tool tip label
    local err_msg = ''; -- start with the error message empty
    if ws_url then
    local path, timestamp, flag; -- portions of the archive.or url
    pages = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
    pages = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
    coins_pages = ws_label;
    end
    elseif is_set (at) then
    ws_url, ws_label, L = wikisource_url_make (at); -- make ws url from |at= interwiki link; link portion L becomes tool tip label
    if ws_url then
    at = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
    at = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
    coins_pages = ws_label;
    end
    end
    if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url
    return page, pages, at, coins_pages;
    return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
    end
    end
     
     
     
    --[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
     
    Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the
    save snapshot url or to calendar pages.  When the archive url is 'https://web.archive.org/save/' (or http://...)
    archive.org saves a snapshot of the target page in the url.  That is something that Wikipedia should not allow
    unwitting readers to do.


    if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
    When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own
    err_msg = 'save command';
    algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results.
    url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
    elseif url:match('//liveweb%.archive%.org/') then
    err_msg = 'liveweb';
    else
    path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation
    if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
    err_msg = 'timestamp';
    if '*' ~= flag then
    url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
    end
    elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
    err_msg = 'path';
    elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
    err_msg = 'flag';
    elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
    err_msg = 'flag';
    else
    return url, date; -- return archiveURL and ArchiveDate
    end
    end
    -- if here, something not right so
    table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and
    if is_set (Frame:preprocess('{{REVISIONID}}')) then
    return '', ''; -- return empty strings for archiveURL and ArchiveDate
    else
    return url, date; -- preview mode so return archiveURL and ArchiveDate
    end
    end


    This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
    |archive-date= and an error message when:
    |archive-url= holds an archive.org save command url
    |archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
    correct place
    otherwise returns |archive-url= and |archive-date=


    --[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
    There are two mostly compatible archive.org urls:
    //web.archive.org/<timestamp>... -- the old form
    //web.archive.org/web/<timestamp>... -- the new form


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


    ]]
    This function supports a preview mode.  When the article is rendered in preview mode, this funct may return a modified
    archive url:
    for save command errors, return undated wildcard (/*/)
    for timestamp errors when the timestamp has a wildcard, return the url unmodified
    for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)


    local function citation0( config, args)
    ]=]
    --[[
    Load Input Parameters
    The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
    ]]
    local A = argument_wrapper( args );
    local i


    -- Pick out the relevant fields from the arguments.  Different citation templates
    local function archive_url_check (url, date)
    -- define different field names for the same underlying things.
    local err_msg = ''; -- start with the error message empty
     
    local path, timestamp, flag; -- portions of the archive.or url
    -- set default parameter values defined by |mode= parameter.
    local Mode = A['Mode'];
    if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url
    if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then
    return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
    Mode = '';
    end
    end


    local author_etal;
    if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
    local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
    err_msg = 'save command';
    local Authors;
    url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
    local NameListFormat = A['NameListFormat'];
    elseif url:match('//liveweb%.archive%.org/') then
    local Collaboration = A['Collaboration'];
    err_msg = 'liveweb';
     
    else
    do -- to limit scope of selected
    path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation
    local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
    if 1 == selected then
    if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
    a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
    err_msg = 'timestamp';
    elseif 2 == selected then
    if '*' ~= flag then
    NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
    url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
    a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
    elseif 3 == selected then
    Authors = A['Authors']; -- use content of |authors=
    if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
    add_maint_cat ('authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO:
    end
    end
    elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
    err_msg = 'path';
    elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
    err_msg = 'flag';
    elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
    err_msg = 'flag';
    else
    return url, date; -- return archiveURL and ArchiveDate
    end
    end
    if is_set (Collaboration) then
    author_etal = true; -- so that |display-authors=etal not required
    end
    end
    end
    -- if here, something not right so
    table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and
    if is_set (Frame:preprocess('{{REVISIONID}}')) then
    return '', ''; -- return empty strings for archiveURL and ArchiveDate
    else
    return url, date; -- preview mode so return archiveURL and ArchiveDate
    end
    end


    local Others = A['Others'];


    local editor_etal;
    --[[--------------------------< P L A C E _ C H E C K >--------------------------------------------------------
    local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
     
    local Editors;
    check |place=, |publication-place=, |location= to see if these params include digits.  This function added because
    many editors mis-use location to specify the in-source location (|page(s)= and |at= are supposed to do that)
     
    returns the original parameter value without modification; added maint cat when parameter value contains digits


    do -- to limit scope of selected
    ]]
    local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
     
    if 1 == selected then
    local function place_check (param_val)
    e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
    if not is_set (param_val) then -- parameter empty or omitted
    elseif 2 == selected then
    return param_val; -- return that empty state
    NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
    end
    e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
    elseif 3 == selected then
    if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
    Editors = A['Editors']; -- use content of |editors=
    add_maint_cat ('location'); -- yep, add maint cat
    add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged
    end
    end
    end
    return param_val; -- and done
    end


    local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
    local Translators; -- assembled translators name list
    t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=


    local interviewers_list = {};
    --[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
    local Interviewers = A['Interviewers']
     
    if is_set (Interviewers) then -- add a maint cat if the |interviewers= is used
    This is the main function doing the majority of the citation formatting.
    add_maint_cat ('interviewers'); -- because use of this parameter is discouraged
     
    else
    ]]
    interviewers_list = extract_names (args, 'InterviewerList'); -- else, process preferred interviewers parameters
    end


    local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
    local function citation0( config, args)
    local Contributors; -- assembled contributors name list
    --[[
    local Contribution = A['Contribution'];
    Load Input Parameters
    if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
    The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
    c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
    ]]
    local A = argument_wrapper( args );
    if 0 < #c then
    local i
    if not is_set (Contribution) then -- |contributor= requires |contribution=
     
    table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message
    -- Pick out the relevant fields from the arguments.  Different citation templates
    c = {}; -- blank the contributors' table; it is used as a flag later
    -- define different field names for the same underlying things.
    end
     
    if 0 == #a then -- |contributor= requires |author=
    local Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], '');
    table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message
     
    c = {}; -- blank the contributors' table; it is used as a flag later
    local author_etal;
    local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
    local Authors;
     
    local NameListFormat = is_valid_parameter_value (A['NameListFormat'], A:ORIGIN('NameListFormat'), cfg.keywords_lists['name-list-format'], '');
    local Collaboration = A['Collaboration'];
     
    do -- to limit scope of selected
    local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
    if 1 == selected then
    a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
    elseif 2 == selected then
    NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
    a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
    elseif 3 == selected then
    Authors = A['Authors']; -- use content of |authors=
    if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
    add_maint_cat ('authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO:
    end
    end
    end
    end
    else -- if not a book cite
    if is_set (Collaboration) then
    if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
    author_etal = true; -- so that |display-authors=etal not required
    table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message
    end
    end
    Contribution = nil; -- unset
    end
    end


    if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc'
    local Others = A['Others'];
    NameListFormat = ''; -- anything else, set to empty string
    end


    local Year = A['Year'];
    local editor_etal;
    local PublicationDate = A['PublicationDate'];
    local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
    local OrigYear = A['OrigYear'];
    local Editors;
    local Date = A['Date'];
    local LayDate = A['LayDate'];
    ------------------------------------------------- Get title data
    local Title = A['Title'];
    local ScriptTitle = A['ScriptTitle'];
    local BookTitle = A['BookTitle'];
    local Conference = A['Conference'];
    local TransTitle = A['TransTitle'];
    local TitleNote = A['TitleNote'];
    local TitleLink = A['TitleLink'];
    link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set


    local Chapter = A['Chapter'];
    do -- to limit scope of selected
    local ScriptChapter = A['ScriptChapter'];
    local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
    local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
    if 1 == selected then
    local TransChapter = A['TransChapter'];
    e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
    local TitleType = A['TitleType'];
    elseif 2 == selected then
    local Degree = A['Degree'];
    NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
    local Docket = A['Docket'];
    e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
    local ArchiveFormat = A['ArchiveFormat'];
    elseif 3 == selected then
    Editors = A['Editors']; -- use content of |editors=
    add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged
    end
    end


    local ArchiveDate;
    local translator_etal;
    local ArchiveURL;
    local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
    local Translators; -- assembled translators name list
    t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
     
    local interviewer_etal;
    local interviewers_list = {};
    local Interviewers; -- used later
    interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters


    ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
    local contributor_etal;
    local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
    local DeadURL = A['DeadURL']
    local Contributors; -- assembled contributors name list
    if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes'
    local Contribution = A['Contribution'];
    DeadURL = ''; -- anything else, set to empty string
    if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
    c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
    if 0 < #c then
    if not is_set (Contribution) then -- |contributor= requires |contribution=
    table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message
    c = {}; -- blank the contributors' table; it is used as a flag later
    end
    if 0 == #a then -- |contributor= requires |author=
    table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message
    c = {}; -- blank the contributors' table; it is used as a flag later
    end
    end
    else -- if not a book cite
    if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
    table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message
    end
    end
    Contribution = nil; -- unset
    end


    local URL = A['URL']
    if is_set (Others) then
    local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
    if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
    local ChapterURL = A['ChapterURL'];
    add_maint_cat ('others');
    local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
    end
    local ConferenceFormat = A['ConferenceFormat'];
    end
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
    local Periodical = A['Periodical'];
    local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter


    local Series = A['Series'];
    local Year = A['Year'];
    local PublicationDate = A['PublicationDate'];
    local OrigYear = A['OrigYear'];
    local Date = A['Date'];
    local LayDate = A['LayDate'];
    ------------------------------------------------- Get title data
    local Title = A['Title'];
    local ScriptTitle = A['ScriptTitle'];
    local BookTitle = A['BookTitle'];
    local Conference = A['Conference'];
    local TransTitle = A['TransTitle'];
    local TitleNote = A['TitleNote'];
    local TitleLink = A['TitleLink'];
    link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set
     
    local Chapter = A['Chapter'];
    local ScriptChapter = A['ScriptChapter'];
    local ScriptChapterOrigin = A:ORIGIN ('ScriptChapter');
    local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
    local TransChapter = A['TransChapter'];
    local TitleType = A['TitleType'];
    local Degree = A['Degree'];
    local Docket = A['Docket'];
    local ArchiveFormat = A['ArchiveFormat'];
     
    local ArchiveDate;
    local ArchiveURL;
     
    ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
    local Volume;
    local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');
    local Issue;
     
    local Page;
    local Pages;
    local At;


    if in_array (config.CitationClass, cfg.templates_using_volume) then
    local URL = A['URL']
    Volume = A['Volume'];
    local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
    end
    local ChapterURL = A['ChapterURL'];
    -- conference & map books do not support issue
    local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
    if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then
    local ConferenceFormat = A['ConferenceFormat'];
    Issue = hyphen_to_dash (A['Issue']);
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
    local Periodical = A['Periodical'];
    local Periodical_origin = '';
    if is_set (Periodical) then
    Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
    local i;
    Periodical, i = strip_apostrophe_markup (Periodical); -- strip appostrophe markup so that metadata isn't contaminated
    if i then -- non-zero when markup was stripped so emit an error message
    table.insert( z.message_tail, {set_error ('apostrophe_markup', {Periodical_origin}, true)});
    end
    end
     
    local ScriptPeriodical = A['ScriptPeriodical'];
    local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
    -- web and news not tested for now because of
    -- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
    if not (is_set (Periodical) or is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
    -- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
    local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
    if p[config.CitationClass]  then
    table.insert( z.message_tail, {set_error ('missing_periodical', {config.CitationClass, p[config.CitationClass]}, true)});
    end
    end
     
    local TransPeriodical =  A['TransPeriodical'];
     
    local Series = A['Series'];
    local Volume;
    local Issue;
    local Page;
    local Pages;
    local At;
     
    if 'citation' == config.CitationClass then
    if is_set (Periodical) then
    if not in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals'
    Volume = A['Volume']; -- but does for all other 'periodicals'
    end
    elseif is_set (ScriptPeriodical) then
    if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
    Volume = A['Volume']; -- but does for all other 'periodicals'
    end
    else
    Volume = A['Volume']; -- and does for non-'periodical' cites
    end
    elseif in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
    Volume = A['Volume'];
    end
     
    if 'citation' == config.CitationClass then
    if is_set (Periodical) and in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals'
    is_set (ScriptPeriodical) and in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals'
    Issue = hyphen_to_dash (A['Issue']);
    end
    elseif in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
    if not (in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (is_set (Periodical) or is_set (ScriptPeriodical))) then
    Issue = hyphen_to_dash (A['Issue']);
    end
    end
    end
    local Position = '';
    local Position = '';
    if not in_array (config.CitationClass, cfg.templates_not_using_page) then
    if not in_array (config.CitationClass, cfg.templates_not_using_page) then
    Line 2,184: Line 2,415:


    local Edition = A['Edition'];
    local Edition = A['Edition'];
    local PublicationPlace = A['PublicationPlace']
    local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
    local Place = A['Place'];
    local Place = place_check (A['Place'], A:ORIGIN('Place'));
    local PublisherName = A['PublisherName'];
    local PublisherName = A['PublisherName'];
    local RegistrationRequired = A['RegistrationRequired'];
    local PublisherName_origin = A:ORIGIN('PublisherName');
    if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then
    if is_set (PublisherName) then
    RegistrationRequired=nil;
    local i=0;
    end
    PublisherName, i = strip_apostrophe_markup (PublisherName); -- strip appostrophe markup so that metadata isn't contaminated; publisher is never italicized


    local SubscriptionRequired = A['SubscriptionRequired'];
    if i then -- non-zero when markup was stripped so emit an error message
    if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then
    table.insert( z.message_tail, {set_error ('apostrophe_markup', {PublisherName_origin}, true)});
    SubscriptionRequired=nil;
    end
    end
    end


    local UrlAccess = A['UrlAccess'];
    local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
    if not is_valid_parameter_value (UrlAccess, 'url-access', cfg.keywords ['url-access']) then
    UrlAccess = nil;
    end
    if not is_set(URL) and is_set(UrlAccess) then
    if not is_set(URL) and is_set(UrlAccess) then
    UrlAccess = nil;
    UrlAccess = nil;
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } );
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } );
    end
    end
     
    if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set
    local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
    table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message
    if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then
    SubscriptionRequired = nil; -- unset; prefer |access= over |subscription=
    ChapterUrlAccess = nil;
    end
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}, true ) } );
    if is_set (UrlAccess) and is_set (RegistrationRequired) then -- these are not the same but contradictory so if both are set
    table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'registration')}, true ) } ); -- add error message
    RegistrationRequired = nil; -- unset; prefer |access= over |registration=
    end
    end


    local ChapterUrlAccess = A['ChapterUrlAccess'];
    local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
    if not is_valid_parameter_value (ChapterUrlAccess, 'chapter-url-access', cfg.keywords ['url-access']) then -- same as url-access
    if not is_set(A['MapURL']) and is_set(MapUrlAccess) then
    ChapterUrlAccess = nil;
    MapUrlAccess = nil;
    end
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'map-url'}, true ) } );
    if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then
    ChapterUrlAccess = nil;
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'chapter-url'}, true ) } );
    end
    end


    Line 2,235: Line 2,457:
    local ID = A['ID'];
    local ID = A['ID'];
    local ASINTLD = A['ASINTLD'];
    local ASINTLD = A['ASINTLD'];
    local IgnoreISBN = A['IgnoreISBN'];
    local IgnoreISBN = is_valid_parameter_value (A['IgnoreISBN'], A:ORIGIN('IgnoreISBN'), cfg.keywords_lists['yes_true_y'], nil);
    if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then
    IgnoreISBN = nil; -- anything else, set to empty string
    end
    local Embargo = A['Embargo'];
    local Embargo = A['Embargo'];
    local Class = A['Class']; -- arxiv class identifier
    local Class = A['Class']; -- arxiv class identifier


    local ID_list = extract_ids( args );
    local ID_list = extract_ids( args );
    if is_set (DoiBroken) and not ID_list['DOI'] then
    table.insert( z.message_tail, { set_error( 'doibroken_missing_doi', A:ORIGIN('DoiBroken'))});
    end
    local ID_access_levels = extract_id_access_levels( args, ID_list );
    local ID_access_levels = extract_id_access_levels( args, ID_list );


    Line 2,255: Line 2,477:
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL


    local LastAuthorAmp = A['LastAuthorAmp'];
    local LastAuthorAmp = is_valid_parameter_value (A['LastAuthorAmp'], A:ORIGIN('LastAuthorAmp'), cfg.keywords_lists['yes_true_y'], nil);
    if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then
    LastAuthorAmp = nil; -- set to empty string
    end


    local no_tracking_cats = A['NoTracking'];
    local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
    if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then
    no_tracking_cats = nil; -- set to empty string
    end


    --local variables that are not cs1 parameters
    --local variables that are not cs1 parameters
    Line 2,271: Line 2,487:
    local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
    local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification


    local DF = A['DF']; -- date format set in cs1|2 template
    local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
    if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword
    if not is_set (DF) then
    DF = ''; -- not valid, set to empty string
    DF = cfg.global_df; -- local df if present overrides global df set by {{use xxx date}} template
    end
    end


    local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
    local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
    local PostScript;
    local PostScript;
    local Ref;
    local Ref;
    sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass);
    sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass);
    use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text
    use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text


    --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
    --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
    Line 2,296: Line 2,512:


    -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
    -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
    select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category
    select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category


    local NoPP = A['NoPP']  
    local coins_pages;
    if is_set (NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_y']) then
    NoPP = true;
    Page, Pages, At, coins_pages = insource_loc_get (Page, Pages, At);
    else
     
    NoPP = nil; -- unset, used as a flag later
    local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);
    end


    if is_set(Page) then
    if is_set (PublicationPlace) and is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
    if is_set(Pages) or is_set(At) then
    add_prop_cat ('location test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
    Pages = ''; -- unset the others
    if PublicationPlace == Place then
    At = '';
    Place = ''; -- unset; don't need both if they are the same
    end
    end
    extra_text_in_page_check (Page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
    elseif not is_set (PublicationPlace) and is_set (Place) then -- when only |place= (|location=) is set ...
    elseif is_set(Pages) then
    PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
    if is_set(At) then
    end
    At = ''; -- unset
    end
    extra_text_in_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
    end


    -- both |publication-place= and |place= (|location=) allowed if different
    -- if not is_set(PublicationPlace) and is_set(Place) then -- both |publication-place= and |place= (|location=) allowed if different
    if not is_set(PublicationPlace) and is_set(Place) then
    -- PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
    PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
    -- end
    end
    --
    if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
    if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
    --[[
    --[[
    Line 2,330: Line 2,540:
    |encyclopedia and |title then map |title to |article and |encyclopedia to |title
    |encyclopedia and |title then map |title to |article and |encyclopedia to |title
    |encyclopedia and |article then map |encyclopedia to |title
    |encyclopedia and |article then map |encyclopedia to |title
    |encyclopedia then map |encyclopedia to |title
     
    |trans-title maps to |trans-chapter when |title is re-mapped
    |trans-title maps to |trans-chapter when |title is re-mapped
    |url maps to |chapterurl when |title is remapped
    |url maps to |chapterurl when |title is remapped
    Line 2,342: Line 2,551:


    if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
    if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
    if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
    if is_set (Periodical) then -- Periodical is set when |encyclopedia is set
    if is_set(Title) or is_set (ScriptTitle) then
    if is_set(Title) or is_set (ScriptTitle) then
    if not is_set(Chapter) then
    if not is_set(Chapter) then
    Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
    Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
    ScriptChapter = ScriptTitle;
    ScriptChapter = ScriptTitle;
    ScriptChapterOrigin = A:ORIGIN('ScriptTitle')
    TransChapter = TransTitle;
    TransChapter = TransTitle;
    ChapterURL = URL;
    ChapterURL = URL;
    Line 2,363: Line 2,573:
    ScriptTitle = '';
    ScriptTitle = '';
    end
    end
    else -- |title not set
    elseif is_set (Chapter) then -- |title not set
    Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
    Title = Periodical; -- |encyclopedia set and |article set so map |encyclopedia to |title
    Periodical = ''; -- redundant so unset
    Periodical = ''; -- redundant so unset
    end
    end
    Line 2,384: Line 2,594:
    if (config.CitationClass == "mailinglist") then
    if (config.CitationClass == "mailinglist") then
    Periodical = A ['MailingList'];
    Periodical = A ['MailingList'];
    elseif 'mailinglist' == A:ORIGIN('Periodical') then
    elseif 'mailinglist' == Periodical_origin then
    Periodical = ''; -- unset because mailing list is only used for cite mailing list
    Periodical = ''; -- unset because mailing list is only used for cite mailing list
    end
    end
    Line 2,417: Line 2,627:
    Chapter = A['Map'];
    Chapter = A['Map'];
    ChapterURL = A['MapURL'];
    ChapterURL = A['MapURL'];
    ChapterUrlAccess = UrlAccess;
    ChapterURLorigin = A:ORIGIN('MapURL');
    TransChapter = A['TransMap'];
    TransChapter = A['TransMap'];
    ChapterURLorigin = A:ORIGIN('MapURL');
    ScriptChapter = A['ScriptMap']
    ScriptChapterOrigin = A:ORIGIN('ScriptMap')
     
    ChapterUrlAccess = MapUrlAccess;
    ChapterFormat = A['MapFormat'];
    ChapterFormat = A['MapFormat'];
     
    Cartography = A['Cartography'];
    Cartography = A['Cartography'];
    if is_set( Cartography ) then
    if is_set( Cartography ) then
    Line 2,461: Line 2,674:
    -- assemble a table of parts concatenated later into Series
    -- assemble a table of parts concatenated later into Series
    if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
    if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
    if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
    if is_set(SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
    if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
    if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
    Issue = ''; -- unset because this is not a unique parameter
    Issue = ''; -- unset because this is not a unique parameter
    Line 2,467: Line 2,680:
    Chapter = Title; -- promote title parameters to chapter
    Chapter = Title; -- promote title parameters to chapter
    ScriptChapter = ScriptTitle;
    ScriptChapter = ScriptTitle;
    -- ScriptChapterOrigin = 'title';
    ScriptChapterOrigin = A:ORIGIN('ScriptTitle');
    ChapterLink = TitleLink; -- alias episodelink
    ChapterLink = TitleLink; -- alias episodelink
    TransChapter = TransTitle;
    TransChapter = TransTitle;
    Line 2,497: Line 2,712:
    -- end of {{cite episode}} stuff
    -- end of {{cite episode}} stuff


    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data.
    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.
    do
    do
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then
    if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates
    if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates
    table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message
    table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message
    end
    if 'arxiv' == config.CitationClass then
    Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string
    end
    end


    if 'biorxiv' == config.CitationClass then
    Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
    Periodical = 'bioRxiv'; -- set to bioRxiv for COinS; after that, must be set to empty string
    end
     
    if 'citeseerx' == config.CitationClass then
    Periodical = 'CiteSeerX'; -- set to CiteSeerX for COinS; after that, must be set to empty string
    end
    end
    end
    end
    end
    Line 2,648: Line 2,853:
    end
    end
    end
    end
     
    if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites
    if 'none' == Title and
    Title = ''; -- set title to empty string
    in_array (config.CitationClass, {'journal', 'citation'}) and
    add_maint_cat ('untitled');
    (is_set (Periodical) or is_set (ScriptPeriodical)) and
    ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
    Title = ''; -- set title to empty string
    add_maint_cat ('untitled');
    end
    end


    check_for_url ({ -- add error message when any of these parameters contains a URL
    check_for_url ({ -- add error message when any of these parameters hold a URL
    ['title']=Title,
    ['title']=Title,
    [A:ORIGIN('Chapter')]=Chapter,
    [A:ORIGIN('Chapter')]=Chapter,
    [A:ORIGIN('Periodical')]=Periodical,
    [Periodical_origin] = Periodical,
    [A:ORIGIN('PublisherName')] = PublisherName
    [PublisherName_origin] = PublisherName
    });
    });


    Line 2,681: Line 2,889:
    -- this is the function call to COinS()
    -- this is the function call to COinS()
    local OCinSoutput = COinS({
    local OCinSoutput = COinS({
    ['Periodical'] = Periodical,
    ['Periodical'] = strip_apostrophe_markup (Periodical), -- no markup in the metadata
    ['Encyclopedia'] = Encyclopedia,
    ['Encyclopedia'] = strip_apostrophe_markup (Encyclopedia),
    ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
    ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
    ['Degree'] = Degree; -- cite thesis only
    ['Degree'] = Degree; -- cite thesis only
    Line 2,693: Line 2,901:
    ['Volume'] = Volume,
    ['Volume'] = Volume,
    ['Issue'] = Issue,
    ['Issue'] = Issue,
    ['Pages'] = get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
    ['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
    ['Edition'] = Edition,
    ['Edition'] = Edition,
    ['PublisherName'] = PublisherName,
    ['PublisherName'] = PublisherName, -- any apostrophe markup already removed
    ['URL'] = first_set ({ChapterURL, URL}, 2),
    ['URL'] = first_set ({ChapterURL, URL}, 2),
    ['Authors'] = coins_author,
    ['Authors'] = coins_author,
    Line 2,702: Line 2,910:
    }, config.CitationClass);
    }, config.CitationClass);


    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data.
    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data.
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, or CiteSeerX now unset so it isn't displayed
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn now unset so it isn't displayed
    Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
    Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
    end
    end
    Line 2,710: Line 2,918:
    if 'newsgroup' == config.CitationClass then
    if 'newsgroup' == config.CitationClass then
    if is_set (PublisherName) then
    if is_set (PublisherName) then
    PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil ));
    PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, PublisherName_origin, nil ));
    end
    end
    end
    end


    -- Now perform various field substitutions.
    -- Now perform various field substitutions.
    Line 2,731: Line 2,937:


    do -- do editor name list first because the now unsupported coauthors used to modify control table
    do -- do editor name list first because the now unsupported coauthors used to modify control table
    control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal);
    control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal);
    last_first_list, EditorCount = list_people(control, e, editor_etal);
    last_first_list, EditorCount = list_people(control, e, editor_etal);


    if is_set (Editors) then
    if is_set (Editors) then
    Editors, editor_etal = name_has_etal (Editors, editor_etal, false, 'editors'); -- find and remove variations on et al.
    if editor_etal then
    if editor_etal then
    Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal
    Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal
    Line 2,750: Line 2,957:
    end
    end
    do -- now do interviewers
    do -- now do interviewers
    control.maximum = #interviewers_list; -- number of interviewerss
    control.maximum , interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal);
    Interviewers = list_people(control, interviewers_list, false); -- et al not currently supported
    Interviewers = list_people (control, interviewers_list, interviewer_etal);
    end
    end
    do -- now do translators
    do -- now do translators
    control.maximum = #t; -- number of translators
    control.maximum , translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal);
    Translators = list_people(control, t, false); -- et al not currently supported
    Translators = list_people (control, t, translator_etal);
    end
    end
    do -- now do contributors
    do -- now do contributors
    control.maximum = #c; -- number of contributors
    control.maximum , contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal);
    Contributors = list_people(control, c, false); -- et al not currently supported
    Contributors = list_people (control, c, contributor_etal);
    end
    end
    do -- now do authors
    do -- now do authors
    control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal);
    control.maximum , author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal);


    last_first_list = list_people(control, a, author_etal);
    last_first_list = list_people(control, a, author_etal);


    if is_set (Authors) then
    if is_set (Authors) then
    Authors, author_etal = name_has_etal (Authors, author_etal, false); -- find and remove variations on et al.
    Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
    if author_etal then
    if author_etal then
    Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
    Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
    Line 2,791: Line 2,998:


    -- special case for chapter format so no error message or cat when chapter not supported
    -- special case for chapter format so no error message or cat when chapter not supported
    if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or
    if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia))) then
    ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
    ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
    end
    end


    if not is_set(URL) then
    if not is_set(URL) then
    if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist
    if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist
    table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
    ('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website=
    table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
    end
    end
    Line 2,809: Line 3,017:


    local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
    local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
    DeadURL = DeadURL:lower(); -- used later when assembling archived text
    UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
    if is_set( ArchiveURL ) then
    if is_set( ArchiveURL ) then
    if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it
    if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it
    Line 2,815: Line 3,023:
    OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages
    OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages
    OriginalFormat = ChapterFormat; -- and original |chapter-format=
    OriginalFormat = ChapterFormat; -- and original |chapter-format=
    if 'no' ~= DeadURL then
     
    if 'live' ~= UrlStatus then
    ChapterURL = ArchiveURL -- swap-in the archive's url
    ChapterURL = ArchiveURL -- swap-in the archive's url
    ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages
    ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages
    Line 2,826: Line 3,035:
    OriginalFormat = Format; -- and original |format=
    OriginalFormat = Format; -- and original |format=
    OriginalAccess = UrlAccess;
    OriginalAccess = UrlAccess;
    if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
     
    if 'live' ~= UrlStatus then -- if URL set then archive-url applies to it
    URL = ArchiveURL -- swap-in the archive's url
    URL = ArchiveURL -- swap-in the archive's url
    URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
    URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
    Line 2,835: Line 3,045:
    end
    end


    if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia
    if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) then
    local chap_param;
    local chap_param;
    if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
    if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
    Line 2,845: Line 3,055:
    chap_param = A:ORIGIN ('ChapterURL')
    chap_param = A:ORIGIN ('ChapterURL')
    elseif is_set (ScriptChapter) then
    elseif is_set (ScriptChapter) then
    chap_param = A:ORIGIN ('ScriptChapter')
    chap_param = ScriptChapterOrigin;
    else is_set (ChapterFormat)
    else is_set (ChapterFormat)
    chap_param = A:ORIGIN ('ChapterFormat')
    chap_param = A:ORIGIN ('ChapterFormat')
    Line 2,861: Line 3,071:
    local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
    local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
    if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
    if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
    if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title
    if in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
    no_quotes = true; -- then render it unquoted
    no_quotes = true; -- then render it unquoted
    end
    end
    end
    end


    Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
    Chapter = format_chapter_title (ScriptChapter, ScriptChapterOrigin, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
    if is_set (Chapter) then
    if is_set (Chapter) then
    Chapter = Chapter .. ChapterFormat ;
    Chapter = Chapter .. ChapterFormat ;
    Line 2,894: Line 3,104:
    end
    end
    if is_set(TitleLink) and is_set(Title) then
    if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
    Title = make_wikilink (TitleLink, Title);
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) or
    end
    ('map' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical))) then -- special case for cite map when the map is in a periodical treat as an article
     
    if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) or
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or
    ('map' == config.CitationClass and is_set (Periodical)) then -- special case for cite map when the map is in a periodical treat as an article
    Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
    Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
    Title = wrap_style ('quoted-title', Title);
    Title = wrap_style ('quoted-title', Title);
    Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    TransTitle= wrap_style ('trans-quoted-title', TransTitle );
    TransTitle= wrap_style ('trans-quoted-title', TransTitle );
    elseif 'report' == config.CitationClass then -- no styling for cite report
    elseif 'report' == config.CitationClass then -- no styling for cite report
    Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
    TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
    else
    else
    Title = wrap_style ('italic-title', Title);
    Title = wrap_style ('italic-title', Title);
    Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    TransTitle = wrap_style ('trans-italic-title', TransTitle);
    TransTitle = wrap_style ('trans-italic-title', TransTitle);
    end
    end
    Line 2,922: Line 3,128:
    end
    end
    end
    end
     
    if is_set(Title) then
    if is_set(Title) then
    if not is_set(TitleLink) and is_set(URL) then
    if not is_set (TitleLink) and is_set (URL) then
    Title = external_link (URL, Title, URLorigin, UrlAccess) .. TransTitle .. TransError .. Format;
    Title = external_link( URL, Title, URLorigin, UrlAccess ) .. TransTitle .. TransError .. Format;
    URL = ''; -- unset these because no longer needed
    URL = ''; -- unset these because no longer needed
    Format = "";
    Format = "";
    elseif is_set (TitleLink) and not is_set (URL) then
    local ws_url;
    ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
    if ws_url then
    Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
    Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
    Title = Title .. TransTitle .. TransError;
    else
    Title = make_wikilink (TitleLink, Title) .. TransTitle .. TransError;
    end
    else
    else
    Title = Title .. TransTitle .. TransError;
    local ws_url, ws_label;
    ws_url, ws_label, L = wikisource_url_make (Title); -- make ws url from |title= interwiki link; link portion L becomes tool tip label
    if ws_url then
    Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup
    Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
    Title = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
    Title = Title .. TransTitle .. TransError;
    else
    Title = Title .. TransTitle .. TransError;
    end
    end
    end
    else
    else
    Line 3,024: Line 3,248:
    end
    end


    Series = is_set(Series) and (sepc .. " " .. Series) or "";
    Series = is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation
    OrigYear = is_set (OrigYear) and wrap_msg ('origyear', OrigYear) or '';
     
    Agency = is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";
    Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
     
    Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);
    Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);


    ------------------------------------ totally unrelated data
    ------------------------------------ totally unrelated data
    if is_set(Via) then
    Via = is_set (Via) and  wrap_msg ('via', Via) or '';
    Via = " " .. wrap_msg ('via', Via);
    end
     
    --[[
    Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link
    note is displayed. There are no error messages for this condition.
    ]]
    if is_set (SubscriptionRequired) then
    SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
    elseif is_set (RegistrationRequired) then
    SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
    else
    SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
    end


    if is_set(AccessDate) then
    if is_set(AccessDate) then
    Line 3,083: Line 3,290:
    local Archived
    local Archived
    if is_set(ArchiveURL) then
    if is_set(ArchiveURL) then
    local arch_text;
    if not is_set(ArchiveDate) then
    if not is_set(ArchiveDate) then
    ArchiveDate = set_error('archive_missing_date');
    ArchiveDate = set_error('archive_missing_date');
    end
    end
    if "no" == DeadURL then
    if "live" == UrlStatus then
    local arch_text = cfg.messages['archived'];
    arch_text = cfg.messages['archived'];
    if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
    Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
    Archived = sepc .. " " .. substitute( cfg.messages['archived-live'],
    { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } );
    { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } );
    if not is_set(OriginalURL) then
    if not is_set (OriginalURL) then
    Archived = Archived .. " " .. set_error('archive_missing_url');    
    Archived = Archived .. " " .. set_error('archive_missing_url');    
    end
    end
    elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped'
    elseif is_set(OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
    local arch_text = cfg.messages['archived-dead'];
    if in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
    if sepc ~= "." then arch_text = arch_text:lower() end
    arch_text = cfg.messages['archived-unfit'];
    if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then
    if sepc ~= "." then arch_text = arch_text:lower() end
    Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled
    Archived = sepc .. " " .. arch_text .. ArchiveDate; -- format already styled
    if 'bot: unknown' == DeadURL then
    if 'bot: unknown' == UrlStatus then
    add_maint_cat ('bot:_unknown'); -- and add a category if not already added
    add_maint_cat ('bot:_unknown'); -- and add a category if not already added
    else
    else
    add_maint_cat ('unfit'); -- and add a category if not already added
    add_maint_cat ('unfit'); -- and add a category if not already added
    end
    end
    else -- DeadURL is empty, 'yes', 'true', or 'y'
    else -- UrlStatus is empty, 'dead'
    arch_text = cfg.messages['archived-dead'];
    if sepc ~= "." then arch_text = arch_text:lower() end
    Archived = sepc .. " " .. substitute( arch_text,
    Archived = sepc .. " " .. substitute( arch_text,
    { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
    { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
    end
    end
    else
    else -- OriginalUrl not set
    local arch_text = cfg.messages['archived-missing'];
    arch_text = cfg.messages['archived-missing'];
    if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
    Archived = sepc .. " " .. substitute( arch_text,  
    Archived = sepc .. " " .. substitute( arch_text,  
    Line 3,163: Line 3,373:
    -- Several of the above rely upon detecting this as nil, so do it last.
    -- Several of the above rely upon detecting this as nil, so do it last.
    if is_set(Periodical) then
    if (is_set (Periodical) or is_set (ScriptPeriodical) or is_set (TransPeriodical)) then
    if is_set(Title) or is_set(TitleNote) then  
    if is_set(Title) or is_set(TitleNote) then  
    Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)  
    Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
    else  
    else  
    Periodical = wrap_style ('italic-title', Periodical)
    Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
    end
    end
    end
    end
    Line 3,175: Line 3,385:
    the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
    the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
    ]]
    ]]
    if "speech" == config.CitationClass then -- cite speech only
    if "speech" == config.CitationClass then -- cite speech only
    TitleNote = " (Speech)"; -- annotate the citation
    TitleNote = " (Speech)"; -- annotate the citation
    if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter  
    if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter  
    if is_set (Conference) then -- and if |event= is set
    if is_set (Conference) then -- and if |event= is set
    Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
    Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
    end
    end
    end
    end
    Line 3,212: Line 3,422:
    elseif 'episode' == config.CitationClass then -- special case for cite episode
    elseif 'episode' == config.CitationClass then -- special case for cite episode
    tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc );
    tcommon = safe_join( {Title, TitleNote, TitleType, Series, Language, Edition, Publisher}, sepc );


    else -- all other CS1 templates
    else -- all other CS1 templates
    Line 3,225: Line 3,435:
    end
    end
    local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
    local idcommon;
    if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript
    idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Lay, Quote }, sepc );
    else
    idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Lay, Quote }, sepc );
    end
    local text;
    local text;
    local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
    local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
    Line 3,251: Line 3,467:
    if (sepc ~= '.') then
    if (sepc ~= '.') then
    in_text = in_text:lower() -- lowercase for cs2
    in_text = in_text:lower() -- lowercase for cs2
    end
    end
    end
    if EditorCount <= 1 then
    post_text = " (" .. cfg.messages['editor'] .. ")"; -- be consistent with no-author, no-date case
    else
    else
    if EditorCount <= 1 then
    post_text = " (" .. cfg.messages['editors'] .. ")";
    post_text = ", " .. cfg.messages['editor'];
    end
    else
    post_text = ", " .. cfg.messages['editors'];
    end
    end  
    Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
    Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
    end
    end
    Line 3,299: Line 3,514:
    if is_set(PostScript) and PostScript ~= sepc then
    if is_set(PostScript) and PostScript ~= sepc then
    text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc.
    text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc.
    text = text:sub(1,-sepc:len()-1);
    text = text:sub(1,-sepc:len()-1);
    end
    end
    Line 3,351: Line 3,566:
    end
    end


    table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation
    table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation


    if #z.message_tail ~= 0 then
    if 0 ~= #z.message_tail then
    table.insert (render, ' ');
    table.insert (render, ' ');
    for i,v in ipairs( z.message_tail ) do
    for i,v in ipairs( z.message_tail ) do
    Line 3,366: Line 3,581:
    end
    end


    if #z.maintenance_cats ~= 0 then
    if 0 ~= #z.maintenance_cats then
    table.insert (render, '<span class="citation-comment" style="display:none; color:#33aa33; margin-left:0.3em">');
    local maint_msgs = {}; -- here we collect all of the maint messages
    for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
    for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
    table.insert (render, v);
    local maint = {}; -- here we assemble a maintenence message
    table.insert (render, ' (');
    table.insert (maint, v); -- maint msg is the category name
    table.insert (render, make_wikilink (':Category:' .. v, 'link'));
    table.insert (maint, ' ('); -- open the link text
    table.insert (render, ') ');
    table.insert (maint, make_wikilink (':Category:' .. v, 'link')); -- add the link
    table.insert (maint, ')'); -- and close it
    table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table
    end
    end
    table.insert (render, '</span>');
    table.insert (render, substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs, ' '))); -- wrap the group of maint message with proper presentation and save
    end
    end
    no_tracking_cats = no_tracking_cats:lower();
    -- no_tracking_cats = no_tracking_cats:lower();
    if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
    -- if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
    if not no_tracking_cats then
    for _, v in ipairs( z.error_categories ) do
    for _, v in ipairs( z.error_categories ) do
    table.insert (render, make_wikilink ('Category:' .. v));
    table.insert (render, make_wikilink ('Category:' .. v));
    Line 3,409: Line 3,627:
    local state;
    local state;
    if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- limited parameter sets allowed for these templates
    if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- limited parameter sets allowed for these templates
    state = whitelist.limited_basic_arguments[name];
    state = whitelist.limited_basic_arguments[name];
    if true == state then return true; end -- valid actively supported parameter
    if true == state then return true; end -- valid actively supported parameter
    Line 3,471: Line 3,689:
    ]]
    ]]


    local function missing_pipe_check (value)
    local function missing_pipe_check (parameter, value)
    local capture;
    local capture;
    value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc  
    value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc  


    capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes
    capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
    if capture and validate (capture) then -- if the capture is a valid parameter name
    if capture and validate (capture) then -- if the capture is a valid parameter name
    add_maint_cat ('missing_pipe');
    table.insert( z.message_tail, {set_error ('missing_pipe',parameter)});
    end
    end
     
     
    --[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >--------------------------------------
     
    look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked
     
    ]]
     
    local function has_extraneous_punc (param, value)
    if cfg.punct_skip[param] then
    return; -- parameter name found in the skip table so done
    end
    if value:match ('[,;:]$') then
    add_maint_cat ('extra_punct'); -- has extraneous punctuation; add maint cat
    end
    end
    end
    end




    --[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------
    --[[--------------------------< C I T A T I O N >--------------------------------------------------------------


    This is used by templates such as {{cite book}} to create the actual citation text.
    This is used by templates such as {{cite book}} to create the actual citation text.
    Line 3,488: Line 3,723:
    ]]
    ]]


    function cs1.citation(frame)
    local function citation(frame)
    Frame = frame; -- save a copy incase we need to display an error message in preview mode
    Frame = frame; -- save a copy incase we need to display an error message in preview mode
    local pframe = frame:getParent()
    local pframe = frame:getParent()
    Line 3,535: Line 3,770:
    is_wikilink = utilities.is_wikilink;
    is_wikilink = utilities.is_wikilink;
    make_wikilink = utilities.make_wikilink;
    make_wikilink = utilities.make_wikilink;
    strip_apostrophe_markup = utilities.strip_apostrophe_markup;


    z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
    z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
    Line 3,588: Line 3,824:
    else
    else
    error_text, error_state = set_error( 'parameter_ignored', {param}, true ); -- suggested param not supported by this template
    error_text, error_state = set_error( 'parameter_ignored', {param}, true ); -- suggested param not supported by this template
    v = ''; -- unset
    end
    end
    end
    end
    Line 3,604: Line 3,841:
    end
    end
    end
    end
    missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe?
    missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe?
    -- TODO: is this the best place for this translation?
    -- TODO: is this the best place for this translation?
    args[k] = v;
    args[k] = v;
    Line 3,615: Line 3,852:
    if 'string' == type (k) then -- don't evaluate positional parameters
    if 'string' == type (k) then -- don't evaluate positional parameters
    has_invisible_chars (k, v);
    has_invisible_chars (k, v);
    has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
    end
    end
    end
    end
    return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})});
    return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})});
    end
    end


    return cs1;
    --[[--------------------------< E X P O R T E D  F U N C T I O N S >------------------------------------------
    ]]
     
    return {citation = citation};