Module:Citation/CS1: Difference between revisions

    From Nonbinary Wiki
    m>Mr. Stradivarius
    (revert to version from March 30, 2014 - the update was causing Lua to exceed the 10-second execution limit on e.g. Karnataka)
    m>Trappist the monk
    (Disabled get_coins_pages() while debugging;)
    Line 1: Line 1:
    local z = {
    local z = {
        error_categories = {};
    error_categories = {};
        error_ids = {};
    error_ids = {};
        message_tail = {};
    message_tail = {};
    }
    }
    -- Include translation message hooks, ID and error handling configuration settings.
    --local cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' );
    -- Contains a list of all recognized parameters
    --local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
    --local dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- location of date validation code


    -- Whether variable is set or not
    -- Whether variable is set or not
    function is_set( var )
    function is_set( var )
        return not (var == nil or var == '');
    return not (var == nil or var == '');
    end
    end


    -- First set variable or nil if none
    -- First set variable or nil if none
    function first_set(...)
    function first_set(...)
        local list = {...};
    local list = {...};
        for _, var in pairs(list) do
    for _, var in pairs(list) do
            if is_set( var ) then
    if is_set( var ) then
                return var;
    return var;
            end
    end
        end
    end
    end
    end


    -- Whether needle is in haystack
    -- Whether needle is in haystack
    function inArray( needle, haystack )
    function inArray( needle, haystack )
        if needle == nil then
    if needle == nil then
            return false;
    return false;
        end
    end
        for n,v in ipairs( haystack ) do
    for n,v in ipairs( haystack ) do
            if v == needle then
    if v == needle then
                return n;
    return n;
            end
    end
        end
    end
        return false;
    return false;
    end
    end


    Line 44: Line 36:
    Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
    Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
    |coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
    |coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
    details of which parameter caused the error message are not provided.  Only one error message is emitted regarless of the number of deprecated parameters in the citation.
    details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
    ]]
    ]]
    function deprecated_parameter()
    function deprecated_parameter()
    Line 81: Line 73:
    -- Wraps a string using a message_list configuration taking one argument
    -- Wraps a string using a message_list configuration taking one argument
    function wrap( key, str, lower )
    function wrap( key, str, lower )
        if not is_set( str ) then
    if not is_set( str ) then
            return "";
    return "";
        elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
    elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
            str = safeforitalics( str );
    str = safeforitalics( str );
        end
    end
        if lower == true then
    if lower == true then
            return substitute( cfg.messages[key]:lower(), {str} );
    return substitute( cfg.messages[key]:lower(), {str} );
        else
    else
            return substitute( cfg.messages[key], {str} );
    return substitute( cfg.messages[key], {str} );
        end      
    end
    end
    end


    Line 99: Line 91:
    ]]
    ]]
    function argument_wrapper( args )
    function argument_wrapper( args )
        local origin = {};
    local origin = {};
       
        return setmetatable({
    return setmetatable({
            ORIGIN = function( self, k )
    ORIGIN = function( self, k )
                local dummy = self[k]; --force the variable to be loaded.
    local dummy = self[k]; --force the variable to be loaded.
                return origin[k];
    return origin[k];
            end
    end
        },
    },
        {
    {
            __index = function ( tbl, k )
    __index = function ( tbl, k )
                if origin[k] ~= nil then
    if origin[k] ~= nil then
                    return nil;
    return nil;
                end
    end
               
                local args, list, v = args, cfg.aliases[k];
    local args, list, v = args, cfg.aliases[k];
               
                if type( list ) == 'table' then
    if type( list ) == 'table' then
                    v, origin[k] = selectone( args, list, 'redundant_parameters' );
    v, origin[k] = selectone( args, list, 'redundant_parameters' );
                    if origin[k] == nil then
    if origin[k] == nil then
                        origin[k] = ''; -- Empty string, not nil
    origin[k] = ''; -- Empty string, not nil
                    end
    end
                elseif list ~= nil then
    elseif list ~= nil then
                    v, origin[k] = args[list], list;
    v, origin[k] = args[list], list;
                else
    else
                    -- maybe let through instead of raising an error?
    -- maybe let through instead of raising an error?
                    -- v, origin[k] = args[k], k;
    -- v, origin[k] = args[k], k;
                    error( cfg.messages['unknown_argument_map'] );
    error( cfg.messages['unknown_argument_map'] );
                end
    end
               
                -- Empty strings, not nil;
    -- Empty strings, not nil;
                if v == nil then
    if v == nil then
                    v = cfg.defaults[k] or '';
    v = cfg.defaults[k] or '';
                    origin[k] = '';
    origin[k] = '';
                end
    end
               
                tbl = rawset( tbl, k, v );
    tbl = rawset( tbl, k, v );
                return v;
    return v;
            end,
    end,
        });
    });
    end
    end


    Line 173: Line 165:
    -- Formats a comment for error trapping
    -- Formats a comment for error trapping
    function errorcomment( content, hidden )
    function errorcomment( content, hidden )
        return wrap( hidden and 'hidden-error' or 'visible-error', content );
    return wrap( hidden and 'hidden-error' or 'visible-error', content );
    end
    end


    Line 181: Line 173:
    ]]
    ]]
    function seterror( error_id, arguments, raw, prefix, suffix )
    function seterror( error_id, arguments, raw, prefix, suffix )
        local error_state = cfg.error_conditions[ error_id ];
    local error_state = cfg.error_conditions[ error_id ];
       
        prefix = prefix or "";
    prefix = prefix or "";
        suffix = suffix or "";
    suffix = suffix or "";
       
        if error_state == nil then
    if error_state == nil then
            error( cfg.messages['undefined_error'] );
    error( cfg.messages['undefined_error'] );
        elseif is_set( error_state.category ) then
    elseif is_set( error_state.category ) then
            table.insert( z.error_categories, error_state.category );
    table.insert( z.error_categories, error_state.category );
        end
    end
       
        local message = substitute( error_state.message, arguments );
    local message = substitute( error_state.message, arguments );
       
        message = message .. " ([[" .. cfg.messages['help page link'] ..  
    message = message .. " ([[" .. cfg.messages['help page link'] ..  
            "#" .. error_state.anchor .. "|" ..
    "#" .. error_state.anchor .. "|" ..
            cfg.messages['help page label'] .. "]])";
    cfg.messages['help page label'] .. "]])";
       
        z.error_ids[ error_id ] = true;
    z.error_ids[ error_id ] = true;
        if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
    if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
                and z.error_ids['citation_missing_title'] then
    and z.error_ids['citation_missing_title'] then
            return '', false;
    return '', false;
        end
    end
       
        message = table.concat({ prefix, message, suffix });
    message = table.concat({ prefix, message, suffix });
       
        if raw == true then
    if raw == true then
            return message, error_state.hidden;
    return message, error_state.hidden;
        end      
    end
           
        return errorcomment( message, error_state.hidden );
    return errorcomment( message, error_state.hidden );
    end
    end


    -- Formats a wiki style external link
    -- Formats a wiki style external link
    function externallinkid(options)
    function externallinkid(options)
        local url_string = options.id;
    local url_string = options.id;
        if options.encode == true or options.encode == nil then
    if options.encode == true or options.encode == nil then
            url_string = mw.uri.encode( url_string );
    url_string = mw.uri.encode( url_string );
        end
    end
        return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
    return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
            options.link, options.label, options.separator or " ",
    options.link, options.label, options.separator or " ",
            options.prefix, url_string, options.suffix or "",
    options.prefix, url_string, options.suffix or "",
            mw.text.nowiki(options.id)
    mw.text.nowiki(options.id)
        );
    );
    end
    end


    -- Formats a wiki style internal link
    -- Formats a wiki style internal link
    function internallinkid(options)
    function internallinkid(options)
        return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
    return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
            options.link, options.label, options.separator or " ",
    options.link, options.label, options.separator or " ",
            options.prefix, options.id, options.suffix or "",
    options.prefix, options.id, options.suffix or "",
            mw.text.nowiki(options.id)
    mw.text.nowiki(options.id)
        );
    );
    end
    end


    -- Format an external link with error checking
    -- Format an external link with error checking
    function externallink( URL, label, source )
    function externallink( URL, label, source )
        local error_str = "";
    local error_str = "";
        if not is_set( label ) then
    if not is_set( label ) then
            label = URL;
    label = URL;
            if is_set( source ) then
    if is_set( source ) then
                error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
    error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
            else
    else
                error( cfg.messages["bare_url_no_origin"] );
    error( cfg.messages["bare_url_no_origin"] );
            end          
    end
        end
    end
        if not checkurl( URL ) then
    if not checkurl( URL ) then
            error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
    error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
        end
    end
        return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
    return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
    end
    end


    -- Formats a link to Amazon
    -- Formats a link to Amazon
    function amazon(id, domain)
    function amazon(id, domain)
        if not is_set(domain) then  
    if not is_set(domain) then  
            domain = "com"
    domain = "com"
        elseif ( "jp" == domain or "uk" == domain ) then
    elseif ( "jp" == domain or "uk" == domain ) then
            domain = "co." .. domain
    domain = "co." .. domain
        end
    end
        local handler = cfg.id_handlers['ASIN'];
    local handler = cfg.id_handlers['ASIN'];
        return externallinkid({link = handler.link,
    return externallinkid({link = handler.link,
            label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
    label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
            encode=handler.encode, separator = handler.separator})
    encode=handler.encode, separator = handler.separator})
    end
     
    --[[
    format and error check arXiv identifier.  There are two valid forms of the identifier:
    the first form, valid only between date codes 9108 and 0703 is:
    arXiv:<archive>.<class>/<date code><number><version>
    where:
    <archive> is a string of alpha characters - may be hyphenated; no other punctuation
    <class> is a string of alpha characters - may be hyphenated; no other punctuation
    <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
    first digit of YY for this form can only 9 and 0
    <number> is a three-digit number
    <version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
    the second form, valid from April 2007 is:
    arXiv:<date code>.<number><version>
    where:
    <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
    <number> is a four-digit number
    <version> is a 1 or more digit number preceded with a lowercase v; no spaces
    ]]
     
    function arxiv (id)
    local handler = cfg.id_handlers['ARXIV'];
    local year, month, version;
    local err_cat = ""
    year, month, version = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d([v%d]*)$"); -- test for the 9108-0703 format
    if not year then -- arXiv id is not proper 9108-0703 form
    year, month, version = id:match("^(%d%d)([01]%d)%.%d%d%d%d([v%d]*)$"); -- test for the 0704- format
    if not year then
    err_cat = ' ' .. seterror( 'bad_arxiv' ); -- arXiv id doesn't match either format
    else -- id is the 0704- format
    year = tonumber(year);
    month = tonumber(month);
    if ((7 > year) or (1 > month and 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
    ((7 == year) and (4 > month)) or -- when year is 07, is month invalid (before April)?
    is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
    err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
    end
    end
    else -- id is the 9108-0703 format; are the date values ok
    year = tonumber(year);
    month = tonumber(month);
    if ((91 > year and 7 < year) or (1 > month and 12 < month)) or -- if invalid year or invalid month
    ((91 == year and 8 > month) or (7 == year and 3 < month)) or -- if years ok, are starting and ending months ok?
    is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
    err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
    end
    end
     
    return externallinkid({link = handler.link, label = handler.label,
    prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
    end
    end
    --[[
    lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
    1. Remove all blanks.
    2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
    3. If there is a hyphen in the string:
    a. Remove it.
    b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
    1. All these characters should be digits, and there should be six or less. (not done in this function)
    2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
    Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
    ]]
    function normalize_lccn (lccn)
    lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
    if nil ~= string.find (lccn,'/') then
    lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it
    end
    local prefix
    local suffix
    prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix
    if nil ~= suffix then -- if there was a hyphen
    suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
    lccn=prefix..suffix; -- reassemble the lccn
    end
    return lccn;
    end


    --[[
    --[[
    Line 276: Line 353:


    ]]
    ]]
    function lccn(id)
    function lccn(lccn)
    local handler = cfg.id_handlers['LCCN'];
    local handler = cfg.id_handlers['LCCN'];
    local err_cat =  ''; -- presume that LCCN is valid
    local err_cat =  ''; -- presume that LCCN is valid
    local id = lccn; -- local copy of the lccn


    id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes)
    local len = id:len(); -- get the length of the lccn
    local len = id:len(); -- get the length of the lccn


    Line 306: Line 385:
    else
    else
    err_cat = ' ' .. seterror( 'bad_lccn' ); -- wrong length, set an error message
    err_cat = ' ' .. seterror( 'bad_lccn' ); -- wrong length, set an error message
    end
    if not is_set (err_cat) and nil ~= lccn:find ('%s') then
    err_cat = ' ' .. seterror( 'bad_lccn' ); -- lccn contains a space, set an error message
    end
    end


    return externallinkid({link = handler.link, label = handler.label,
    return externallinkid({link = handler.link, label = handler.label,
    prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
    prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
    end
    end


    Line 336: Line 419:
    --[[
    --[[
    Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
    Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
    in the future, returns true; otherwse, returns false because the embargo has expired or |embargo= not set in this cite.
    in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
    ]]
    ]]
    function is_embargoed(embargo)
    function is_embargoed(embargo)
    Line 366: Line 449:
    local handler = cfg.id_handlers['PMC'];
    local handler = cfg.id_handlers['PMC'];
    local err_cat =  ''; -- presume that PMC is valid
    local err_cat =  ''; -- presume that PMC is valid
       
    local text;
    local text;


    Line 400: Line 483:


    function doi(id, inactive)
    function doi(id, inactive)
        local cat = ""
    local cat = ""
        local handler = cfg.id_handlers['DOI'];
    local handler = cfg.id_handlers['DOI'];
       
        local text;
    local text;
    if is_set(inactive) then
    if is_set(inactive) then
    local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
    local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
    Line 427: Line 510:
    -- Formats an OpenLibrary link, and checks for associated errors.
    -- Formats an OpenLibrary link, and checks for associated errors.
    function openlibrary(id)
    function openlibrary(id)
        local code = id:sub(-1,-1)
    local code = id:sub(-1,-1)
        local handler = cfg.id_handlers['OL'];
    local handler = cfg.id_handlers['OL'];
        if ( code == "A" ) then
    if ( code == "A" ) then
            return externallinkid({link=handler.link, label=handler.label,
    return externallinkid({link=handler.link, label=handler.label,
                prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
    prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
                encode = handler.encode})
    encode = handler.encode})
        elseif ( code == "M" ) then
    elseif ( code == "M" ) then
            return externallinkid({link=handler.link, label=handler.label,
    return externallinkid({link=handler.link, label=handler.label,
                prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
    prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
                encode = handler.encode})
    encode = handler.encode})
        elseif ( code == "W" ) then
    elseif ( code == "W" ) then
            return externallinkid({link=handler.link, label=handler.label,
    return externallinkid({link=handler.link, label=handler.label,
                prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
    prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
                encode = handler.encode})
    encode = handler.encode})
        else
    else
            return externallinkid({link=handler.link, label=handler.label,
    return externallinkid({link=handler.link, label=handler.label,
                prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
    prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
                encode = handler.encode}) ..  
    encode = handler.encode}) ..  
                ' ' .. seterror( 'bad_ol' );
    ' ' .. seterror( 'bad_ol' );
        end
    end
    end
    end


    Line 465: Line 548:
    local valid_issn = true;
    local valid_issn = true;


    id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and ndashes from the issn
    id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn


    if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 didgits long, containing only 0-9 or X in the last position
    if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position
    valid_issn=false; -- wrong length or improper character
    valid_issn=false; -- wrong length or improper character
    else
    else
    Line 491: Line 574:
    --[[
    --[[
    This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
    This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
    Also handles the special case where it is desireable to omit the title type from the rendered citation (|type=none).
    Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
    ]]
    ]]
    function set_titletype(cite_class, title_type)
    function set_titletype(cite_class, title_type)
    Line 501: Line 584:
    end
    end


    if "AV media notes" == cite_class or "DVD notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
    if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
    return "Media notes"; -- display AV media notes / DVD media notes annotation
    return "Media notes"; -- display AV media notes / DVD media notes annotation


    Line 527: Line 610:
    ]]
    ]]
    function checkurl( url_str )
    function checkurl( url_str )
        -- Protocol-relative or URL scheme
    -- Protocol-relative or URL scheme
        return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
    return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
    end
    end


    Line 534: Line 617:
    -- Similar to that used for Special:BookSources
    -- Similar to that used for Special:BookSources
    function cleanisbn( isbn_str )
    function cleanisbn( isbn_str )
        return isbn_str:gsub( "[^-0-9X]", "" );
    return isbn_str:gsub( "[^-0-9X]", "" );
    end
    end


    -- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
    -- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
    --TODO: Fix so this code supports urls like this:
    -- http://www.history.navy.mil/download/va125153.pdf#page=13 %w/:\.
    function get_coins_pages (pages)
    function get_coins_pages (pages)
    if not is_set (pages) then return pages; end -- if no page numbers then we're done
    if not is_set (pages) then return pages; end -- if no page numbers then we're done
        while true do
    while true do
    pattern = pages:match("%[([%w/:\.]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
    pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
    if nil == pattern then break; end -- no more urls
    if nil == pattern then break; end -- no more urls
    pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
    pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
    Line 548: Line 633:
    pages = pages:gsub("[%[%]]", ""); -- remove the brackets
    pages = pages:gsub("[%[%]]", ""); -- remove the brackets
    pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
    pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
    pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc) with hyphens; do we need to replace numerical entities like &#32; and the like?
    pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
    return pages;
    return pages;
    end
    end
    Line 597: Line 682:
    -- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
    -- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
    function removewikilink( str )
    function removewikilink( str )
        return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
            return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
    return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
        end));
    end));
    end
    end


    -- Escape sequences for content that will be used for URL descriptions
    -- Escape sequences for content that will be used for URL descriptions
    function safeforurl( str )
    function safeforurl( str )
        if str:match( "%[%[.-%]%]" ) ~= nil then  
    if str:match( "%[%[.-%]%]" ) ~= nil then  
            table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
    table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
        end
    end
       
        return str:gsub( '[%[%]\n]', {  
    return str:gsub( '[%[%]\n]', {
            ['['] = '&#91;',
    ['['] = '&#91;',
            [']'] = '&#93;',
    [']'] = '&#93;',
            ['\n'] = ' ' } );
    ['\n'] = ' ' } );
    end
    end


    -- Converts a hyphen to a dash
    -- Converts a hyphen to a dash
    function hyphentodash( str )
    function hyphentodash( str )
        if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
    if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
            return str;
    return str;
        end  
    end
        return str:gsub( '-', '–' );
    return str:gsub( '-', '–' );
    end
    end


    -- Protects a string that will be wrapped in wiki italic markup '' ... ''
    -- Protects a string that will be wrapped in wiki italic markup '' ... ''
    function safeforitalics( str )
    function safeforitalics( str )
        --[[ Note: We can not use <i> for italics, as the expected behavior for
    --[[ Note: We cannot use <i> for italics, as the expected behavior for
        italics specified by ''...'' in the title is that they will be inverted
    italics specified by ''...'' in the title is that they will be inverted
        (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
    (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
        tend to interact poorly under Mediawiki's HTML tidy. ]]
    tend to interact poorly under Mediawiki's HTML tidy. ]]
       
        if not is_set(str) then
    if not is_set(str) then
            return str;
    return str;
        else
    else
            if str:sub(1,1) == "'" then str = "<span />" .. str; end
    if str:sub(1,1) == "'" then str = "<span />" .. str; end
            if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
    if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
           
            -- Remove newlines as they break italics.
    -- Remove newlines as they break italics.
            return str:gsub( '\n', ' ' );
    return str:gsub( '\n', ' ' );
        end
    end
    end
    end


    --[[
    --[[
    Joins a sequence of strings together while checking for duplicate separation
    Joins a sequence of strings together while checking for duplicate separation characters.
    characters.
     
    TODO: safejoin() has a flaw where it won't remove the duplicate character from a |title= / |url= combination.
    This is because by the time we get here, |title=http://somesite.com and |title=Document Title. have been combined:
    [http://somesite.com and ''Document Title.'']
    so that now, the last character is not sepc but is ] (unless sepc == ']' which breaks the external link)
    ]]
    ]]
    function safejoin( tbl, duplicate_char )
    function safejoin( tbl, duplicate_char )
        --[[
    --[[
        Note: we use string functions here, rather than ustring functions.
    Note: we use string functions here, rather than ustring functions.
       
        This has considerably faster performance and should work correctly as  
    This has considerably faster performance and should work correctly as  
        long as the duplicate_char is strict ASCII.  The strings
    long as the duplicate_char is strict ASCII.  The strings
        in tbl may be ASCII or UTF8.
    in tbl may be ASCII or UTF8.
        ]]
    ]]
       
        local str = '';
    local str = '';
        local comp = '';
    local comp = '';
        local end_chr = '';
    local end_chr = '';
        local trim;
    local trim;
        for _, value in ipairs( tbl ) do
    for _, value in ipairs( tbl ) do
            if value == nil then value = ''; end
    if value == nil then value = ''; end
           
            if str == '' then
    if str == '' then
                str = value;
    str = value;
            elseif value ~= '' then
    elseif value ~= '' then
                if value:sub(1,1) == '<' then
    if value:sub(1,1) == '<' then
                    -- Special case of values enclosed in spans and other markup.
    -- Special case of values enclosed in spans and other markup.
                    comp = value:gsub( "%b<>", "" );
    comp = value:gsub( "%b<>", "" );
                else
    else
                    comp = value;
    comp = value;
                end
    end
               
                if comp:sub(1,1) == duplicate_char then
    if comp:sub(1,1) == duplicate_char then
                    trim = false;
    trim = false;
                    end_chr = str:sub(-1,-1);
    end_chr = str:sub(-1,-1);
                    -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
    -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
                    if end_chr == duplicate_char then
    if end_chr == duplicate_char then
                        str = str:sub(1,-2);
    str = str:sub(1,-2);
                    elseif end_chr == "'" then
    elseif end_chr == "'" then
                        if str:sub(-3,-1) == duplicate_char .. "''" then
    if str:sub(-3,-1) == duplicate_char .. "''" then
                            str = str:sub(1, -4) .. "''";
    str = str:sub(1, -4) .. "''";
                        elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
                            trim = true;
    trim = true;
                        elseif str:sub(-4,-1) == duplicate_char .. "]''" then
    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
                            trim = true;
    trim = true;
                        end
    end
                    elseif end_chr == "]" then
    elseif end_chr == "]" then
                        if str:sub(-3,-1) == duplicate_char .. "]]" then
    if str:sub(-3,-1) == duplicate_char .. "]]" then
                            trim = true;
    trim = true;
                        elseif str:sub(-2,-1) == duplicate_char .. "]" then
    elseif str:sub(-2,-1) == duplicate_char .. "]" then
                            trim = true;
    trim = true;
                        end
    end
                    elseif end_chr == " " then
    elseif end_chr == " " then
                        if str:sub(-2,-1) == duplicate_char .. " " then
    if str:sub(-2,-1) == duplicate_char .. " " then
                            str = str:sub(1,-3);
    str = str:sub(1,-3);
                        end
    end
                    end
    end


                    if trim then
    if trim then
                        if value ~= comp then  
    if value ~= comp then  
                            local dup2 = duplicate_char;
    local dup2 = duplicate_char;
                            if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
    if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
                           
                            value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
    value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
                        else
    else
                            value = value:sub( 2, -1 );
    value = value:sub( 2, -1 );
                        end
    end
                    end
    end
                end
    end
                str = str .. value;
    str = str .. value;
            end
    end
        end
    end
        return str;
    return str;
    end   
    end   


    -- Attempts to convert names to initials.
    -- Attempts to convert names to initials.
    function reducetoinitials(first)
    function reducetoinitials(first)
        local initials = {}
    local initials = {}
        for word in string.gmatch(first, "%S+") do
    local i = 0; -- counter for number of initials
            table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
    for word in string.gmatch(first, "%S+") do
        end
    table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
        return table.concat(initials) -- Vancouver format does not include spaces.
    i = i + 1; -- bump the counter
    if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit
    end
    return table.concat(initials) -- Vancouver format does not include spaces.
    end
    end


    -- Formats a list of people (e.g. authors / editors)  
    -- Formats a list of people (e.g. authors / editors)  
    function listpeople(control, people)
    function listpeople(control, people)
        local sep = control.sep;
    local sep = control.sep;
        local namesep = control.namesep
    local namesep = control.namesep
        local format = control.format
    local format = control.format
        local maximum = control.maximum
    local maximum = control.maximum
        local lastauthoramp = control.lastauthoramp;
    local lastauthoramp = control.lastauthoramp;
        local text = {}
    local text = {}
        local etal = false;
    local etal = false;
       
        if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
        if maximum ~= nil and maximum < 1 then return "", 0; end
    if maximum ~= nil and maximum < 1 then return "", 0; end
       
        for i,person in ipairs(people) do
    for i,person in ipairs(people) do
            if is_set(person.last) then
    if is_set(person.last) then
                local mask = person.mask
    local mask = person.mask
                local one
    local one
                local sep_one = sep;
    local sep_one = sep;
                if maximum ~= nil and i > maximum then
    if maximum ~= nil and i > maximum then
                    etal = true;
    etal = true;
                    break;
    break;
                elseif (mask ~= nil) then
    elseif (mask ~= nil) then
                    local n = tonumber(mask)
    local n = tonumber(mask)
                    if (n ~= nil) then
    if (n ~= nil) then
                        one = string.rep("&mdash;",n)
    one = string.rep("&mdash;",n)
                    else
    else
                        one = mask;
    one = mask;
                        sep_one = " ";
    sep_one = " ";
                    end
    end
                else
    else
                    one = person.last
    one = person.last
                    local first = person.first
    local first = person.first
                    if is_set(first) then  
    if is_set(first) then  
                        if ( "vanc" == format ) then first = reducetoinitials(first) end
    if ( "vanc" == format ) then first = reducetoinitials(first) end
                        one = one .. namesep .. first  
    one = one .. namesep .. first  
                    end
    end
                    if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
    if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
                    if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end -- check for url in author link;
    if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end -- check for url in author link;
                end
    end
                table.insert( text, one )
    table.insert( text, one )
                table.insert( text, sep_one )
    table.insert( text, sep_one )
            end
    end
        end
    end


        local count = #text / 2;
    local count = #text / 2;
        if count > 0 then  
    if count > 0 then  
            if count > 1 and is_set(lastauthoramp) and not etal then
    if count > 1 and is_set(lastauthoramp) and not etal then
                text[#text-2] = " & ";
    text[#text-2] = " & ";
            end
    end
            text[#text] = nil;  
    text[#text] = nil;  
        end
    end
       
        local result = table.concat(text) -- construct list
    local result = table.concat(text) -- construct list
        if etal then  
    if etal then  
            local etal_text = cfg.messages['et al'];
    local etal_text = cfg.messages['et al'];
            result = result .. " " .. etal_text;
    result = result .. " " .. etal_text;
        end
    end
       
        -- if necessary wrap result in <span> tag to format in Small Caps
    -- if necessary wrap result in <span> tag to format in Small Caps
        if ( "scap" == format ) then result =  
    if ( "scap" == format ) then result =  
            '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
        end  
    end  
        return result, count
    return result, count
    end
    end


    -- Generates a CITEREF anchor ID.
    -- Generates a CITEREF anchor ID.
    function anchorid( options )
    function anchorid( options )
        return "CITEREF" .. table.concat( options );
    return "CITEREF" .. table.concat( options );
    end
    end


    -- Gets name list from the input arguments
    --[[
    Gets name list from the input arguments
     
    Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
    Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
    find |last4= and |last5= then the search is done.
     
    This function emits an error message when there is a |firstn= without a matching |lastn=.  When there are 'holes' in the list of last names, |last1= and |last3=
    are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
    ]]
    function extractnames(args, list_name)
    function extractnames(args, list_name)
        local names = {};
    local names = {}; -- table of names
        local i = 1;
    local i = 1; -- loop counter/indexer
        local last;
    local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
       
        while true do
    local err_msg_list_name = list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary
            last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
     
            if not is_set(last) then
    while true do
                -- just in case someone passed in an empty parameter
    names[i] = -- search through args for name components beginning at 1
                break;
    {
            end
    last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ),
            names[i] = {
    first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
                last = last,
    link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
                first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
    mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
                link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
    };
                mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
    if names[i].first and not names[i].last then -- if there is a firstn without a matching lastn
            };
    names[i].first = nil; -- set first to nil so we don't confuse the implicit et al message code
            i = i + 1;
    table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
        end
    break; -- and done because lastn not found
        return names;
    elseif not names[i].first and not names[i].last then -- if both firstn and lastn aren't found, are we done?
    count = count + 1; -- number of times we haven't found last and first
    if 2 == count then -- two missing names and we give up
    break; -- normal exit or there is a two-name hole in the list; can't tell which
    end
    else -- last with or without a first
    if 1 == count then -- if the previous name was missing
    table.insert( z.message_tail, { seterror( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
    end
    count = 0; -- reset the counter, we're looking for two consecutive missing names
    end
     
    i = i + 1; -- bump to the next name
    end
    return names; -- all done, return our list of names
    end
    end


    -- Populates ID table from arguments using configuration settings
    -- Populates ID table from arguments using configuration settings
    function extractids( args )
    function extractids( args )
        local id_list = {};
    local id_list = {};
        for k, v in pairs( cfg.id_handlers ) do  
    for k, v in pairs( cfg.id_handlers ) do
            v = selectone( args, v.parameters, 'redundant_parameters' );
    v = selectone( args, v.parameters, 'redundant_parameters' );
            if is_set(v) then id_list[k] = v; end
    if is_set(v) then id_list[k] = v; end
        end
    end
        return id_list;
    return id_list;
    end
    end


    -- Takes a table of IDs and turns it into a table of formatted ID outputs.
    -- Takes a table of IDs and turns it into a table of formatted ID outputs.
    function buildidlist( id_list, options )
    function buildidlist( id_list, options )
        local new_list, handler = {};
    local new_list, handler = {};
       
        function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
    function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
       
        for k, v in pairs( id_list ) do
    for k, v in pairs( id_list ) do
            -- fallback to read-only cfg
    -- fallback to read-only cfg
            handler = setmetatable( { ['id'] = v }, fallback(k) );
    handler = setmetatable( { ['id'] = v }, fallback(k) );
           
            if handler.mode == 'external' then
    if handler.mode == 'external' then
                table.insert( new_list, {handler.label, externallinkid( handler ) } );
    table.insert( new_list, {handler.label, externallinkid( handler ) } );
            elseif handler.mode == 'internal' then
    elseif handler.mode == 'internal' then
                table.insert( new_list, {handler.label, internallinkid( handler ) } );
    table.insert( new_list, {handler.label, internallinkid( handler ) } );
            elseif handler.mode ~= 'manual' then
    elseif handler.mode ~= 'manual' then
                error( cfg.messages['unknown_ID_mode'] );
    error( cfg.messages['unknown_ID_mode'] );
            elseif k == 'DOI' then
    elseif k == 'DOI' then
                table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
    table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
            elseif k == 'ASIN' then
    elseif k == 'ARXIV' then
                table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
    table.insert( new_list, {handler.label, arxiv( v ) } );
            elseif k == 'LCCN' then
    elseif k == 'ASIN' then
                table.insert( new_list, {handler.label, lccn( v ) } );
    table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
            elseif k == 'OL' then
    elseif k == 'LCCN' then
                table.insert( new_list, {handler.label, openlibrary( v ) } );
    table.insert( new_list, {handler.label, lccn( v ) } );
            elseif k == 'PMC' then
    elseif k == 'OL' then
                table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
    table.insert( new_list, {handler.label, openlibrary( v ) } );
            elseif k == 'PMID' then
    elseif k == 'PMC' then
                table.insert( new_list, {handler.label, pmid( v ) } );
    table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
            elseif k == 'ISSN' then
    elseif k == 'PMID' then
            table.insert( new_list, {handler.label, issn( v ) } );
    table.insert( new_list, {handler.label, pmid( v ) } );
            elseif k == 'ISBN' then
    elseif k == 'ISSN' then
                local ISBN = internallinkid( handler );
    table.insert( new_list, {handler.label, issn( v ) } );
                if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
    elseif k == 'ISBN' then
                    ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
    local ISBN = internallinkid( handler );
                end
    if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
                table.insert( new_list, {handler.label, ISBN } );              
    ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
            else
    end
                error( cfg.messages['unknown_manual_ID'] );
    table.insert( new_list, {handler.label, ISBN } );
            end
    else
        end
    error( cfg.messages['unknown_manual_ID'] );
       
    end
        function comp( a, b ) -- used in following table.sort()
    end
            return a[1] < b[1];
        end
    function comp( a, b ) -- used in following table.sort()
       
    return a[1] < b[1];
        table.sort( new_list, comp );
    end
        for k, v in ipairs( new_list ) do
            new_list[k] = v[2];
    table.sort( new_list, comp );
        end
    for k, v in ipairs( new_list ) do
       
    new_list[k] = v[2];
        return new_list;
    end
    return new_list;
    end
    end
        
        
    Line 881: Line 998:
    -- Generates an error if more than one match is present.
    -- Generates an error if more than one match is present.
    function selectone( args, possible, error_condition, index )
    function selectone( args, possible, error_condition, index )
        local value = nil;
    local value = nil;
        local selected = '';
    local selected = '';
        local error_list = {};
    local error_list = {};
       
        if index ~= nil then index = tostring(index); end
    if index ~= nil then index = tostring(index); end
       
        -- Handle special case of "#" replaced by empty string
    -- Handle special case of "#" replaced by empty string
        if index == '1' then
    if index == '1' then
            for _, v in ipairs( possible ) do
    for _, v in ipairs( possible ) do
                v = v:gsub( "#", "" );
    v = v:gsub( "#", "" );
                if is_set(args[v]) then
    if is_set(args[v]) then
                    if value ~= nil and selected ~= v then
    if value ~= nil and selected ~= v then
                        table.insert( error_list, v );
    table.insert( error_list, v );
                    else
    else
                        value = args[v];
    value = args[v];
                        selected = v;
    selected = v;
                    end
    end
                end
    end
            end      
    end
        end
    end
       
        for _, v in ipairs( possible ) do
    for _, v in ipairs( possible ) do
            if index ~= nil then
    if index ~= nil then
                v = v:gsub( "#", index );
    v = v:gsub( "#", index );
            end
    end
            if is_set(args[v]) then
    if is_set(args[v]) then
                if value ~= nil and selected ~=  v then
    if value ~= nil and selected ~=  v then
                    table.insert( error_list, v );
    table.insert( error_list, v );
                else
    else
                    value = args[v];
    value = args[v];
                    selected = v;
    selected = v;
                end
    end
            end
    end
        end
    end
       
        if #error_list > 0 then
    if #error_list > 0 then
            local error_str = "";
    local error_str = "";
            for _, k in ipairs( error_list ) do
    for _, k in ipairs( error_list ) do
                if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
    if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
                error_str = error_str .. wrap( 'parameter', k );
    error_str = error_str .. wrap( 'parameter', k );
            end
    end
            if #error_list > 1 then
    if #error_list > 1 then
                error_str = error_str .. cfg.messages['parameter-final-separator'];
    error_str = error_str .. cfg.messages['parameter-final-separator'];
            else
    else
                error_str = error_str .. cfg.messages['parameter-pair-separator'];
    error_str = error_str .. cfg.messages['parameter-pair-separator'];
            end
    end
            error_str = error_str .. wrap( 'parameter', selected );
    error_str = error_str .. wrap( 'parameter', selected );
            table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
        end
    end
       
        return value, selected;
    return value, selected;
    end
    end


    Line 937: Line 1,054:
    -- the citation information.
    -- the citation information.
    function COinS(data)
    function COinS(data)
        if 'table' ~= type(data) or nil == next(data) then
    if 'table' ~= type(data) or nil == next(data) then
            return '';
    return '';
        end
    end
       
        local ctx_ver = "Z39.88-2004";
    local ctx_ver = "Z39.88-2004";
       
        -- treat table strictly as an array with only set values.
    -- treat table strictly as an array with only set values.
        local OCinSoutput = setmetatable( {}, {
    local OCinSoutput = setmetatable( {}, {
            __newindex = function(self, key, value)
    __newindex = function(self, key, value)
                if is_set(value) then
    if is_set(value) then
                    rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
    rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
                end
    end
            end
    end
        });
    });
       
        if is_set(data.Chapter) then
    if is_set(data.Chapter) then
            OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
            OCinSoutput["rft.genre"] = "bookitem";
    OCinSoutput["rft.genre"] = "bookitem";
            OCinSoutput["rft.btitle"] = data.Chapter;
    OCinSoutput["rft.btitle"] = data.Chapter;
            OCinSoutput["rft.atitle"] = data.Title;
    OCinSoutput["rft.atitle"] = data.Title;
        elseif is_set(data.Periodical) then
    elseif is_set(data.Periodical) then
            OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
    OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
            OCinSoutput["rft.genre"] = "article";
    OCinSoutput["rft.genre"] = "article";
            OCinSoutput["rft.jtitle"] = data.Periodical;
    OCinSoutput["rft.jtitle"] = data.Periodical;
            OCinSoutput["rft.atitle"] = data.Title;
    OCinSoutput["rft.atitle"] = data.Title;
        else
    else
            OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
            OCinSoutput["rft.genre"] = "book"
    OCinSoutput["rft.genre"] = "book"
            OCinSoutput["rft.btitle"] = data.Title;
    OCinSoutput["rft.btitle"] = data.Title;
        end
    end
       
        OCinSoutput["rft.place"] = data.PublicationPlace;
    OCinSoutput["rft.place"] = data.PublicationPlace;
        OCinSoutput["rft.date"] = data.Date;
    OCinSoutput["rft.date"] = data.Date;
        OCinSoutput["rft.series"] = data.Series;
    OCinSoutput["rft.series"] = data.Series;
        OCinSoutput["rft.volume"] = data.Volume;
    OCinSoutput["rft.volume"] = data.Volume;
        OCinSoutput["rft.issue"] = data.Issue;
    OCinSoutput["rft.issue"] = data.Issue;
        OCinSoutput["rft.pages"] = data.Pages;
    OCinSoutput["rft.pages"] = data.Pages;
        OCinSoutput["rft.edition"] = data.Edition;
    OCinSoutput["rft.edition"] = data.Edition;
        OCinSoutput["rft.pub"] = data.PublisherName;
    OCinSoutput["rft.pub"] = data.PublisherName;
       
        for k, v in pairs( data.ID_list ) do
    for k, v in pairs( data.ID_list ) do
            local id, value = cfg.id_handlers[k].COinS;
    local id, value = cfg.id_handlers[k].COinS;
            if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
    if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
            if string.sub( id or "", 1, 4 ) == 'info' then
    if string.sub( id or "", 1, 4 ) == 'info' then
                OCinSoutput["rft_id"] = table.concat{ id, "/", v };
    OCinSoutput["rft_id"] = table.concat{ id, "/", v };
            else
    else
                OCinSoutput[ id ] = value;
    OCinSoutput[ id ] = value;
            end
    end
        end
    end
       
        local last, first;
    local last, first;
        for k, v in ipairs( data.Authors ) do
    for k, v in ipairs( data.Authors ) do
            last, first = v.last, v.first;
    last, first = v.last, v.first;
            if k == 1 then
    if k == 1 then
                if is_set(last) then
    if is_set(last) then
                    OCinSoutput["rft.aulast"] = last;
    OCinSoutput["rft.aulast"] = last;
                end
    end
                if is_set(first) then  
    if is_set(first) then  
                    OCinSoutput["rft.aufirst"] = first;
    OCinSoutput["rft.aufirst"] = first;
                end
    end
            end
    end
            if is_set(last) and is_set(first) then
    if is_set(last) and is_set(first) then
                OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
    OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
            elseif is_set(last) then
    elseif is_set(last) then
                OCinSoutput["rft.au"] = last;
    OCinSoutput["rft.au"] = last;
            end
    end
        end
    end
       
        OCinSoutput.rft_id = data.URL;
    OCinSoutput.rft_id = data.URL;
        OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
    OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
        OCinSoutput = setmetatable( OCinSoutput, nil );
    OCinSoutput = setmetatable( OCinSoutput, nil );
       
        -- sort with version string always first, and combine.
    -- sort with version string always first, and combine.
        table.sort( OCinSoutput );
    table.sort( OCinSoutput );
        table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
    table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
        return table.concat(OCinSoutput, "&");
    return table.concat(OCinSoutput, "&");
    end
    end


    Line 1,020: Line 1,137:
    ]]
    ]]
    function citation0( config, args)
    function citation0( config, args)
        --[[  
    --[[  
        Load Input Parameters
    Load Input Parameters
        The argment_wrapper facillitates the mapping of multiple
    The argument_wrapper facilitates the mapping of multiple
        aliases to single internal variable.
    aliases to single internal variable.
        ]]
    ]]
        local A = argument_wrapper( args );
    local A = argument_wrapper( args );


        local i  
    local i  
        local PPrefix = A['PPrefix']
    local PPrefix = A['PPrefix']
        local PPPrefix = A['PPPrefix']
    local PPPrefix = A['PPPrefix']
        if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
    if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
       
        -- Pick out the relevant fields from the arguments.  Different citation templates
    -- Pick out the relevant fields from the arguments.  Different citation templates
        -- define different field names for the same underlying things.  
    -- define different field names for the same underlying things.
        local Authors = A['Authors'];
    local Authors = A['Authors'];
        local a = extractnames( args, 'AuthorList' );
    local a = extractnames( args, 'AuthorList' );


        local Coauthors = A['Coauthors'];
    local Coauthors = A['Coauthors'];
        local Others = A['Others'];
    local Others = A['Others'];
        local Editors = A['Editors'];
    local Editors = A['Editors'];
        local e = extractnames( args, 'EditorList' );
    local e = extractnames( args, 'EditorList' );


        local Year = A['Year'];
    local Year = A['Year'];
        local PublicationDate = A['PublicationDate'];
    local PublicationDate = A['PublicationDate'];
        local OrigYear = A['OrigYear'];
    local OrigYear = A['OrigYear'];
        local Date = A['Date'];
    local Date = A['Date'];
        local LayDate = A['LayDate'];
    local LayDate = A['LayDate'];
        ------------------------------------------------- Get title data
    ------------------------------------------------- Get title data
        local Title = A['Title'];
    local Title = A['Title'];
        local BookTitle = A['BookTitle'];
    local BookTitle = A['BookTitle'];
        local Conference = A['Conference'];
    local Conference = A['Conference'];
        local TransTitle = A['TransTitle'];
    local TransTitle = A['TransTitle'];
        local TitleNote = A['TitleNote'];
    local TitleNote = A['TitleNote'];
        local TitleLink = A['TitleLink'];
    local TitleLink = A['TitleLink'];
        local Chapter = A['Chapter'];
    local Chapter = A['Chapter'];
        local ChapterLink = A['ChapterLink'];
    local ChapterLink = A['ChapterLink'];
        local TransChapter = A['TransChapter'];
    local TransChapter = A['TransChapter'];
        local TitleType = A['TitleType'];
    local TitleType = A['TitleType'];
        local Degree = A['Degree'];
    local Degree = A['Degree'];
        local Docket = A['Docket'];
    local Docket = A['Docket'];
        local ArchiveURL = A['ArchiveURL'];
    local ArchiveURL = A['ArchiveURL'];
        local URL = A['URL']
    local URL = A['URL']
        local URLorigin = A:ORIGIN('URL');
    local URLorigin = A:ORIGIN('URL');
        local ChapterURL = A['ChapterURL'];
    local ChapterURL = A['ChapterURL'];
        local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
        local ConferenceURL = A['ConferenceURL'];
    local ConferenceURL = A['ConferenceURL'];
        local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
        local Periodical = A['Periodical'];
    local Periodical = A['Periodical'];


    local Series = A['Series'];
    local Series = A['Series'];
        local Volume = A['Volume'];
    local Volume = A['Volume'];
        local Issue = A['Issue'];
    local Issue = A['Issue'];
        local Position = '';
    local Position = '';
        local Page = A['Page'];
    local Page = A['Page'];
        local Pages = hyphentodash( A['Pages'] );
    local Pages = hyphentodash( A['Pages'] );
        local At = A['At'];
    local At = A['At'];


        local Edition = A['Edition'];
    local Edition = A['Edition'];
        local PublicationPlace = A['PublicationPlace']
    local PublicationPlace = A['PublicationPlace']
        local Place = A['Place'];
    local Place = A['Place'];
       
        local PublisherName = A['PublisherName'];
    local PublisherName = A['PublisherName'];
        local RegistrationRequired = A['RegistrationRequired'];
    local RegistrationRequired = A['RegistrationRequired'];
        local SubscriptionRequired = A['SubscriptionRequired'];
    local SubscriptionRequired = A['SubscriptionRequired'];
        local Via = A['Via'];
    local Via = A['Via'];
        local AccessDate = A['AccessDate'];
    local AccessDate = A['AccessDate'];
        local ArchiveDate = A['ArchiveDate'];
    local ArchiveDate = A['ArchiveDate'];
        local Agency = A['Agency'];
    local Agency = A['Agency'];
        local DeadURL = A['DeadURL']
    local DeadURL = A['DeadURL']
        local Language = A['Language'];
    local Language = A['Language'];
        local Format = A['Format'];
    local Format = A['Format'];
        local Ref = A['Ref'];
    local Ref = A['Ref'];
    local DoiBroken = A['DoiBroken'];
    local DoiBroken = A['DoiBroken'];
    local ID = A['ID'];
    local ID = A['ID'];
        local ASINTLD = A['ASINTLD'];
    local ASINTLD = A['ASINTLD'];
        local IgnoreISBN = A['IgnoreISBN'];
    local IgnoreISBN = A['IgnoreISBN'];
        local Embargo = A['Embargo'];
    local Embargo = A['Embargo'];


        local ID_list = extractids( args );
    local ID_list = extractids( args );
       
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
        local Quote = A['Quote'];
    -- special case for cite newsgroup which uses |id= for a usenet article or post id
        local PostScript = A['PostScript'];
    -- |id= is not included in COinS so here we convert it to an ID that will be included in COinS
    if ('newsgroup' == config.CitationClass) and (is_set (ID)) then
    ID_list['USENETID']=ID; -- add this new 'id' to the list of IDs
    ID = ''; -- and unset
    end
    ]]
    local Quote = A['Quote'];
    local PostScript = A['PostScript'];


        local LayURL = A['LayURL'];
    local LayURL = A['LayURL'];
        local LaySource = A['LaySource'];
    local LaySource = A['LaySource'];
        local Transcript = A['Transcript'];
    local Transcript = A['Transcript'];
        local TranscriptURL = A['TranscriptURL']  
    local TranscriptURL = A['TranscriptURL']  
        local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
        local sepc = A['Separator'];
    local sepc = A['Separator'];


        local LastAuthorAmp = A['LastAuthorAmp'];
    local LastAuthorAmp = A['LastAuthorAmp'];
        local no_tracking_cats = A['NoTracking'];
    local no_tracking_cats = A['NoTracking'];


    --these are used by cite interview
    --these are used by cite interview
    Line 1,121: Line 1,245:


    --local variables that are not cs1 parameters
    --local variables that are not cs1 parameters
        local page_type; -- is this needed?  Doesn't appear to be used anywhere;
    local page_type; -- is this needed?  Doesn't appear to be used anywhere;
        local use_lowercase = ( sepc ~= '.' );
    local use_lowercase = ( sepc ~= '.' );
        local this_page = mw.title.getCurrentTitle(); --Also used for COinS and for language
    local this_page = mw.title.getCurrentTitle(); --Also used for COinS and for language
    local anchor_year; -- used in the CITEREF identifier
    local anchor_year; -- used in the CITEREF identifier
    local COinS_date; -- used in the COinS metadata
    local COinS_date; -- used in the COinS metadata
    Line 1,142: Line 1,266:
    for k, v in pairs( cfg.uncategorized_namespaces ) do -- otherwise, spin through the list of namespaces we don't include in error categories
    for k, v in pairs( cfg.uncategorized_namespaces ) do -- otherwise, spin through the list of namespaces we don't include in error categories
    if this_page.nsText == v then -- if we find one
    if this_page.nsText == v then -- if we find one
    no_tracking_cats = "true"; -- set no_trackin_cats
    no_tracking_cats = "true"; -- set no_tracking_cats
    break; -- and we're done
    break; -- and we're done
                end
    end
            end
    end
        end
    end


    -- check for extra |page=, |pages= or |at= parameters.  
    -- check for extra |page=, |pages= or |at= parameters.  
        if is_set(Page) then
    if is_set(Page) then
            if is_set(Pages) or is_set(At) then
    if is_set(Pages) or is_set(At) then
                Page = Page .. " " .. seterror('extra_pages'); -- add error message
    Page = Page .. " " .. seterror('extra_pages'); -- add error message
                Pages = ''; -- unset the others
    Pages = ''; -- unset the others
                At = '';
    At = '';
            end
    end
        elseif is_set(Pages) then
    elseif is_set(Pages) then
            if is_set(At) then
    if is_set(At) then
                Pages = Pages .. " " .. seterror('extra_pages'); -- add error messages
    Pages = Pages .. " " .. seterror('extra_pages'); -- add error messages
                At = ''; -- unset
    At = ''; -- unset
            end
    end
        end  
    end


    -- both |publication-place= and |place= (|location=) allowed if different
    -- both |publication-place= and |place= (|location=) allowed if different
        if not is_set(PublicationPlace) and is_set(Place) then
    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
       
    --[[
    --[[
    Parameter remapping for cite encyclopedia:
    Parameter remapping for cite encyclopedia:
    Line 1,211: Line 1,335:
    end
    end


    -- check for specital case where |separator=none
    -- check for special case where |separator=none
    if 'none' == sepc:lower() then -- if |separator=none
    if 'none' == sepc:lower() then -- if |separator=none
    sepc = ''; -- then set it to a empty string
    sepc = ''; -- then set it to an empty string
    end
    end


    Line 1,325: Line 1,449:
    end
    end
    elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
    elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
    Date = PublicationDate; -- promonte PublicationDate to Date
    Date = PublicationDate; -- promote PublicationDate to Date
    PublicationDate = ''; -- unset, no longer needed
    PublicationDate = ''; -- unset, no longer needed
    end
    end
    Line 1,347: Line 1,471:
    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.


        -- COinS metadata (see <http://ocoins.info/>) for
    -- COinS metadata (see <http://ocoins.info/>) for
        -- automated parsing of citation information.
    -- automated parsing of citation information.
        local OCinSoutput = COinS{
    local OCinSoutput = COinS{
            ['Periodical'] = Periodical,
    ['Periodical'] = Periodical,
            ['Chapter'] = Chapter,
    ['Chapter'] = Chapter,
            ['Title'] = Title,
    ['Title'] = Title,
            ['PublicationPlace'] = PublicationPlace,
    ['PublicationPlace'] = PublicationPlace,
            ['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
    ['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
            ['Series'] = Series,
    ['Series'] = Series,
            ['Volume'] = Volume,
    ['Volume'] = Volume,
            ['Issue'] = Issue,
    ['Issue'] = Issue,
            ['Pages'] = get_coins_pages (first_set(Page, Pages, At)), -- pages stripped of external links
    -- ['Pages'] = get_coins_pages (first_set(Page, Pages, At)), -- pages stripped of external links
            ['Edition'] = Edition,
    ['Pages'] = first_set(Page, Pages, At),
            ['PublisherName'] = PublisherName,
    ['Edition'] = Edition,
            ['URL'] = first_set( URL, ChapterURL ),
    ['PublisherName'] = PublisherName,
            ['Authors'] = a,
    ['URL'] = first_set( URL, ChapterURL ),
            ['ID_list'] = ID_list,
    ['Authors'] = a,
            ['RawPage'] = this_page.prefixedText,
    ['ID_list'] = ID_list,
        };
    ['RawPage'] = this_page.prefixedText,
    };
     
    if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
    Chapter = Title;
    ChapterLink = TitleLink;
    TransChapter = TransTitle;
    Title = '';
    TitleLink = '';
    TransTitle = '';
    end
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
    -- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername and ID
    if 'newsgroup' == config.CitationClass then
    if is_set (PublisherName) then
    PublisherName = '[Newsgroup]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
    end
    end
    ]]


        if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
            Chapter = Title;
            ChapterLink = TitleLink;
            TransChapter = TransTitle;
            Title = '';
            TitleLink = '';
            TransTitle = '';
        end


        -- Now perform various field substitutions.
    -- Now perform various field substitutions.
        -- We also add leading spaces and surrounding markup and punctuation to the
    -- We also add leading spaces and surrounding markup and punctuation to the
        -- various parts of the citation, but only when they are non-nil.
    -- various parts of the citation, but only when they are non-nil.
        if not is_set(Authors) then
    if not is_set(Authors) then
            local Maximum = tonumber( A['DisplayAuthors'] );
    local Maximum = tonumber( A['DisplayAuthors'] );
           
            -- Preserve old-style implicit et al.
    -- Preserve old-style implicit et al.
            if not is_set(Maximum) and #a == 9 then  
    if not is_set(Maximum) and #a == 9 then  
                Maximum = 8;
    Maximum = 8;
                table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
    table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
            elseif not is_set(Maximum) then
    elseif not is_set(Maximum) then
                Maximum = #a + 1;
    Maximum = #a + 1;
            end
    end
               
            local control = {  
    local control = {  
                sep = A["AuthorSeparator"] .. " ",
    sep = A["AuthorSeparator"] .. " ",
                namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
    namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
                format = A["AuthorFormat"],
    format = A["AuthorFormat"],
                maximum = Maximum,
    maximum = Maximum,
                lastauthoramp = LastAuthorAmp
    lastauthoramp = LastAuthorAmp
            };
    };
           
            -- If the coauthor field is also used, prevent ampersand and et al. formatting.
    -- If the coauthor field is also used, prevent ampersand and et al. formatting.
            if is_set(Coauthors) then
    if is_set(Coauthors) then
                control.lastauthoramp = nil;
    control.lastauthoramp = nil;
                control.maximum = #a + 1;
    control.maximum = #a + 1;
            end
    end
           
            Authors = listpeople(control, a)  
    Authors = listpeople(control, a)  
        end
    end


    if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
    if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
    Line 1,411: Line 1,545:
    end
    end


        local EditorCount
    local EditorCount
        if not is_set(Editors) then
    if not is_set(Editors) then
            local Maximum = tonumber( A['DisplayEditors'] );
    local Maximum = tonumber( A['DisplayEditors'] );
            -- Preserve old-style implicit et al.
    -- Preserve old-style implicit et al.
            if not is_set(Maximum) and #e == 4 then  
    if not is_set(Maximum) and #e == 4 then  
                Maximum = 3;
    Maximum = 3;
                table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
    table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
            elseif not is_set(Maximum) then
    elseif not is_set(Maximum) then
                Maximum = #e + 1;
    Maximum = #e + 1;
            end
    end


            local control = {  
    local control = {  
                sep = A["EditorSeparator"] .. " ",
    sep = A["EditorSeparator"] .. " ",
                namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
    namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
                format = A['EditorFormat'],
    format = A['EditorFormat'],
                maximum = Maximum,
    maximum = Maximum,
                lastauthoramp = LastAuthorAmp
    lastauthoramp = LastAuthorAmp
            };
    };


            Editors, EditorCount = listpeople(control, e);
    Editors, EditorCount = listpeople(control, e);
        else
    else
            EditorCount = 1;
    EditorCount = 1;
        end
    end


        local Cartography = "";
    local Cartography = "";
        local Scale = "";
    local Scale = "";
        if config.CitationClass == "map" then
    if config.CitationClass == "map" then
            if not is_set( Authors ) and is_set( PublisherName ) then
    if not is_set( Authors ) and is_set( PublisherName ) then
                Authors = PublisherName;
    Authors = PublisherName;
                PublisherName = "";
    PublisherName = "";
            end
    end
            Cartography = A['Cartography'];
    Cartography = A['Cartography'];
            if is_set( Cartography ) then
    if is_set( Cartography ) then
                Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
    Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
            end      
    end
            Scale = A['Scale'];
    Scale = A['Scale'];
            if is_set( Scale ) then
    if is_set( Scale ) then
                Scale = sepc .. " " .. Scale;
    Scale = sepc .. " " .. Scale;
            end      
    end
        end
    end
       
        if  not is_set(URL) and
    if  not is_set(URL) and
            not is_set(ChapterURL) and
    not is_set(ChapterURL) and
            not is_set(ArchiveURL) and
    not is_set(ArchiveURL) and
            not is_set(ConferenceURL) and
    not is_set(ConferenceURL) and
            not is_set(TranscriptURL) then
    not is_set(TranscriptURL) then
           
            -- Test if cite web or cite podcast |url= is missing or empty  
    -- Test if cite web or cite podcast |url= is missing or empty  
    if inArray(config.CitationClass, {"web","podcast"}) then
    if inArray(config.CitationClass, {"web","podcast"}) then
    table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
    table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
    end
    end
           
            -- Test if accessdate is given without giving a URL
    -- Test if accessdate is given without giving a URL
            if is_set(AccessDate) then
    if is_set(AccessDate) then
                table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
    table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
                AccessDate = '';
    AccessDate = '';
            end
    end
           
            -- Test if format is given without giving a URL
    -- Test if format is given without giving a URL
            if is_set(Format) then
    if is_set(Format) then
                Format = Format .. seterror( 'format_missing_url' );
    Format = Format .. seterror( 'format_missing_url' );
            end
    end
        end
    end
       
        -- Test if citation has no title
    -- Test if citation has no title
        if  not is_set(Chapter) and
    if  not is_set(Chapter) and
            not is_set(Title) and
    not is_set(Title) and
            not is_set(Periodical) and
    not is_set(Periodical) and
            not is_set(Conference) and
    not is_set(Conference) and
            not is_set(TransTitle) and
    not is_set(TransTitle) and
            not is_set(TransChapter) then
    not is_set(TransChapter) then
            table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
        end
    end
       
        Format = is_set(Format) and " (" .. Format .. ")" or "";
    Format = is_set(Format) and " (" .. Format .. ")" or "";
       
        local OriginalURL = URL
    local OriginalURL = URL
        DeadURL = DeadURL:lower();
    DeadURL = DeadURL:lower();
        if is_set( ArchiveURL ) then
    if is_set( ArchiveURL ) then
            if ( DeadURL ~= "no" ) then
    if ( DeadURL ~= "no" ) then
                URL = ArchiveURL
    URL = ArchiveURL
                URLorigin = A:ORIGIN('ArchiveURL')
    URLorigin = A:ORIGIN('ArchiveURL')
            end
    end
        end
    end
       
        -- Format chapter / article title
    -- Format chapter / article title
        if is_set(Chapter) and is_set(ChapterLink) then  
    if is_set(Chapter) and is_set(ChapterLink) then  
            Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
    Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
        end
    end
        if is_set(Periodical) and is_set(Title) then
    if is_set(Periodical) and is_set(Title) then
            Chapter = wrap( 'italic-title', Chapter );
    Chapter = wrap( 'italic-title', Chapter );
            TransChapter = wrap( 'trans-italic-title', TransChapter );
    TransChapter = wrap( 'trans-italic-title', TransChapter );
        else
    else
    Chapter = kern_quotes (Chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
    Chapter = kern_quotes (Chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
            Chapter = wrap( 'quoted-title', Chapter );
    Chapter = wrap( 'quoted-title', Chapter );
            TransChapter = wrap( 'trans-quoted-title', TransChapter );
    TransChapter = wrap( 'trans-quoted-title', TransChapter );
        end
    end
       
        local TransError = ""
    local TransError = ""
        if is_set(TransChapter) then
    if is_set(TransChapter) then
            if not is_set(Chapter) then
    if not is_set(Chapter) then
                TransError = " " .. seterror( 'trans_missing_chapter' );
    TransError = " " .. seterror( 'trans_missing_chapter' );
            else
    else
                TransChapter = " " .. TransChapter;
    TransChapter = " " .. TransChapter;
            end
    end
        end
    end
       
        Chapter = Chapter .. TransChapter;
    Chapter = Chapter .. TransChapter;
       
        if is_set(Chapter) then
    if is_set(Chapter) then
            if not is_set(ChapterLink) then
    if not is_set(ChapterLink) then
                if is_set(ChapterURL) then
    if is_set(ChapterURL) then
                    Chapter = externallink( ChapterURL, Chapter ) .. TransError;
    Chapter = externallink( ChapterURL, Chapter ) .. TransError;
                    if not is_set(URL) then
    if not is_set(URL) then
                        Chapter = Chapter .. Format;
    Chapter = Chapter .. Format;
                        Format = "";
    Format = "";
                    end
    end
                elseif is_set(URL) then  
    elseif is_set(URL) then  
                    Chapter = externallink( URL, Chapter ) .. TransError .. Format;
    Chapter = externallink( URL, Chapter ) .. TransError .. Format;
                    URL = "";
    URL = "";
                    Format = "";
    Format = "";
                else
    else
                    Chapter = Chapter .. TransError;
    Chapter = Chapter .. TransError;
                end          
    end
            elseif is_set(ChapterURL) then
    elseif is_set(ChapterURL) then
                Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) ..  
    Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) ..  
                    TransError;
    TransError;
            else
    else
                Chapter = Chapter .. TransError;
    Chapter = Chapter .. TransError;
            end
    end
            Chapter = Chapter .. sepc .. " " -- with end-space
    Chapter = Chapter .. sepc .. " " -- with end-space
        elseif is_set(ChapterURL) then
    elseif is_set(ChapterURL) then
            Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
    Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
        end      
    end
       
        -- Format main title.
    -- Format main title.
        if is_set(TitleLink) and is_set(Title) then
    if is_set(TitleLink) and is_set(Title) then
            Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
    Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
        end
    end
       
        if is_set(Periodical) then
    if is_set(Periodical) then
    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( 'quoted-title', Title );
    Title = wrap( 'quoted-title', Title );
            TransTitle = wrap( 'trans-quoted-title', TransTitle );
    TransTitle = wrap( 'trans-quoted-title', TransTitle );
        elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
                not is_set(Chapter) then
    elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast","newsgroup"}) and
    ]] elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
    not is_set(Chapter) then
    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( 'quoted-title', Title );
    Title = wrap( 'quoted-title', Title );
            TransTitle = wrap( 'trans-quoted-title', TransTitle );
    TransTitle = wrap( 'trans-quoted-title', TransTitle );
        else
    else
            Title = wrap( 'italic-title', Title );
    Title = wrap( 'italic-title', Title );
            TransTitle = wrap( 'trans-italic-title', TransTitle );
    TransTitle = wrap( 'trans-italic-title', TransTitle );
        end
    end
       
        TransError = "";
    TransError = "";
        if is_set(TransTitle) then
    if is_set(TransTitle) then
            if not is_set(Title) then
    if not is_set(Title) then
                TransError = " " .. seterror( 'trans_missing_title' );
    TransError = " " .. seterror( 'trans_missing_title' );
            else
    else
                TransTitle = " " .. TransTitle;
    TransTitle = " " .. TransTitle;
            end
    end
        end
    end
       
        Title = Title .. TransTitle;
    Title = Title .. TransTitle;
       
        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 = externallink( URL, Title ) .. TransError .. Format      
    Title = externallink( URL, Title ) .. TransError .. Format  
                URL = "";
    URL = "";
                Format = "";
    Format = "";
            else
    else
                Title = Title .. TransError;
    Title = Title .. TransError;
            end
    end
        end
    end
       
        if is_set(Place) then
    if is_set(Place) then
            Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
    Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
        end
    end
       
        if is_set(Conference) then
    if is_set(Conference) then
            if is_set(ConferenceURL) then
    if is_set(ConferenceURL) then
                Conference = externallink( ConferenceURL, Conference );
    Conference = externallink( ConferenceURL, Conference );
            end
    end
            Conference = sepc .. " " .. Conference
    Conference = sepc .. " " .. Conference
        elseif is_set(ConferenceURL) then
    elseif is_set(ConferenceURL) then
            Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
    Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
        end
    end
       
        if not is_set(Position) then
    if not is_set(Position) then
            local Minutes = A['Minutes'];
    local Minutes = A['Minutes'];
            if is_set(Minutes) then
    if is_set(Minutes) then
                Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
    Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
            else
    else
                local Time = A['Time'];
    local Time = A['Time'];
                if is_set(Time) then
    if is_set(Time) then
                    local TimeCaption = A['TimeCaption']
    local TimeCaption = A['TimeCaption']
                    if not is_set(TimeCaption) then
    if not is_set(TimeCaption) then
                        TimeCaption = cfg.messages['event'];
    TimeCaption = cfg.messages['event'];
                        if sepc ~= '.' then
    if sepc ~= '.' then
                            TimeCaption = TimeCaption:lower();
    TimeCaption = TimeCaption:lower();
                        end
    end
                    end
    end
                    Position = " " .. TimeCaption .. " " .. Time;
    Position = " " .. TimeCaption .. " " .. Time;
                end
    end
            end
    end
        else
    else
            Position = " " .. Position;
    Position = " " .. Position;
            At = '';
    At = '';
        end
    end
       
        if not is_set(Page) then
    if not is_set(Page) then
            if is_set(Pages) then
    if is_set(Pages) then
                if is_set(Periodical) and
    if is_set(Periodical) and
                    not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
    not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
                    Pages = ": " .. Pages;
    Pages = ": " .. Pages;
                elseif tonumber(Pages) ~= nil then
    elseif tonumber(Pages) ~= nil then
                    Pages = sepc .." " .. PPrefix .. Pages;
    Pages = sepc .." " .. PPrefix .. Pages;
                else
    else
                    Pages = sepc .." " .. PPPrefix .. Pages;
    Pages = sepc .." " .. PPPrefix .. Pages;
                end
    end
            end
    end
        else
    else
            if is_set(Periodical) and
    if is_set(Periodical) and
                not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
    not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
                Page = ": " .. Page;
    Page = ": " .. Page;
            else
    else
                Page = sepc .." " .. PPrefix .. Page;
    Page = sepc .." " .. PPrefix .. Page;
            end
    end
        end
    end
       
        At = is_set(At) and (sepc .. " " .. At) or "";
    At = is_set(At) and (sepc .. " " .. At) or "";
        Position = is_set(Position) and (sepc .. " " .. Position) or "";
    Position = is_set(Position) and (sepc .. " " .. Position) or "";
        if config.CitationClass == 'map' then
    if config.CitationClass == 'map' then
            local Section = A['Section'];
    local Section = A['Section'];
            local Inset = A['Inset'];
    local Inset = A['Inset'];
            if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
    if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
                if is_set( Section ) then
    if is_set( Section ) then
                    Section = ", " .. wrap( 'section', Section, true );
    Section = ", " .. wrap( 'section', Section, true );
                end
    end
                if is_set( Inset ) then
    if is_set( Inset ) then
                    Inset = ", " .. wrap( 'inset', Inset, true );
    Inset = ", " .. wrap( 'inset', Inset, true );
                end
    end
            else
    else
                if is_set( Section ) then
    if is_set( Section ) then
                    Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
    Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
                    if is_set( Inset ) then
    if is_set( Inset ) then
                        Inset = ", " .. wrap( 'inset', Inset, true );
    Inset = ", " .. wrap( 'inset', Inset, true );
                    end
    end
                elseif is_set( Inset ) then
    elseif is_set( Inset ) then
                    Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
    Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
                end          
    end
            end          
    end
            At = At .. Section .. Inset;      
    At = At .. Section .. Inset;
        end  
    end


    --[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found,  
    --[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found,  
    Line 1,691: Line 1,827:
    -- handle type parameter for those CS1 citations that have default values
    -- handle type parameter for those CS1 citations that have default values


    if inArray(config.CitationClass, {"AV media notes", "DVD notes", "podcast", "pressrelease", "techreport", "thesis"}) then
    if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "podcast", "pressrelease", "techreport", "thesis"}) then
    TitleType = set_titletype (config.CitationClass, TitleType);
    TitleType = set_titletype (config.CitationClass, TitleType);
    if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
    if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
    Line 1,703: Line 1,839:


    TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
    TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
        Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
    Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
        Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
    Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
        Series = is_set(Series) and (sepc .. " " .. Series) or "";
    Series = is_set(Series) and (sepc .. " " .. Series) or "";
        OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
        Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
    Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";


        if is_set(Volume) then
    if is_set(Volume) then
            if ( mw.ustring.len(Volume) > 4 )
    if ( mw.ustring.len(Volume) > 4 )
              then Volume = sepc .." " .. Volume;
      then Volume = sepc .." " .. Volume;
              else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
      else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
            end
    end
        end
    end


    --[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
    --[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
        if is_set(Volume) then
    if is_set(Volume) then
            if ( mw.ustring.len(Volume) > 4 )
    if ( mw.ustring.len(Volume) > 4 )
              then Volume = sepc .. " " .. Volume;
      then Volume = sepc .. " " .. Volume;
              else
      else
                  Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
      Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
                  if is_set(Series) then Volume = sepc .. Volume;
      if is_set(Series) then Volume = sepc .. Volume;
                  end
      end
            end
    end
        end
    end
    ]]  
    ]]
        ------------------------------------ totally unrelated data
    ------------------------------------ totally unrelated data
        --[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
    --[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
        behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
    behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
       
        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.
    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(Via) then
    if is_set(Via) then
            Via = " " .. wrap( 'via', Via );
    Via = " " .. wrap( 'via', Via );
        end
    end


    if is_set(SubscriptionRequired) then
    if is_set(SubscriptionRequired) then
            SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
    SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
        elseif is_set(RegistrationRequired) then
    elseif is_set(RegistrationRequired) then
            SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
    SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
        end
    end


        if is_set(AccessDate) then
    if is_set(AccessDate) then
            local retrv_text = " " .. cfg.messages['retrieved']
    local retrv_text = " " .. cfg.messages['retrieved']
            if (sepc ~= ".") then retrv_text = retrv_text:lower() end
    if (sepc ~= ".") then retrv_text = retrv_text:lower() end
            AccessDate = '<span class="reference-accessdate">' .. sepc
    AccessDate = '<span class="reference-accessdate">' .. sepc
                .. substitute( retrv_text, {AccessDate} ) .. '</span>'
    .. substitute( retrv_text, {AccessDate} ) .. '</span>'
        end
    end
       
        if is_set(ID) then ID = sepc .." ".. ID; end
    if is_set(ID) then ID = sepc .." ".. ID; end
       if "thesis" == config.CitationClass and is_set(Docket) then
       if "thesis" == config.CitationClass and is_set(Docket) then
    ID = sepc .." Docket ".. Docket .. ID;
    ID = sepc .." Docket ".. Docket .. ID;
    end
    end


       
        ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );
    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );


        if is_set(URL) then
    if is_set(URL) then
            URL = " " .. externallink( URL, nil, URLorigin );
    URL = " " .. externallink( URL, nil, URLorigin );
        end
    end


        if is_set(Quote) then
    if is_set(Quote) then
            if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
    if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
                Quote = Quote:sub(2,-2);
    Quote = Quote:sub(2,-2);
            end
    end
            Quote = sepc .." " .. wrap( 'quoted-text', Quote );  
    Quote = sepc .." " .. wrap( 'quoted-text', Quote );  
            PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
    PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
        end
    end
       
        local Archived
    local Archived
        if is_set(ArchiveURL) then
    if is_set(ArchiveURL) then
            if not is_set(ArchiveDate) then
    if not is_set(ArchiveDate) then
                ArchiveDate = seterror('archive_missing_date');
    ArchiveDate = seterror('archive_missing_date');
            end
    end
            if "no" == DeadURL then
    if "no" == DeadURL then
                local arch_text = cfg.messages['archived'];
    local arch_text = cfg.messages['archived'];
                if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
                Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
    Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
                    { externallink( ArchiveURL, arch_text ), ArchiveDate } );
    { externallink( ArchiveURL, arch_text ), ArchiveDate } );
                if not is_set(OriginalURL) then
    if not is_set(OriginalURL) then
                    Archived = Archived .. " " .. seterror('archive_missing_url');                              
    Archived = Archived .. " " .. seterror('archive_missing_url');  
                end
    end
            elseif is_set(OriginalURL) then
    elseif is_set(OriginalURL) then
                local arch_text = cfg.messages['archived-dead'];
    local arch_text = cfg.messages['archived-dead'];
                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,
                    { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
    { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
            else
    else
                local arch_text = cfg.messages['archived-missing'];
    local arch_text = cfg.messages['archived-missing'];
                if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
                Archived = sepc .. " " .. substitute( arch_text,  
    Archived = sepc .. " " .. substitute( arch_text,  
                    { seterror('archive_missing_url'), ArchiveDate } );
    { seterror('archive_missing_url'), ArchiveDate } );
            end
    end
        else
    else
            Archived = ""
    Archived = ""
        end
    end
       
        local Lay
    local Lay
        if is_set(LayURL) then
    if is_set(LayURL) then
            if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
    if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
            if is_set(LaySource) then  
    if is_set(LaySource) then  
                LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
    LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
            else
    else
                LaySource = "";
    LaySource = "";
            end
    end
            if sepc == '.' then
    if sepc == '.' then
                Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
    Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
            else
    else
                Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
    Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
            end          
    end
        else
    else
            Lay = "";
    Lay = "";
        end
    end
       
        if is_set(Transcript) then
    if is_set(Transcript) then
            if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
    if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
        elseif is_set(TranscriptURL) then
    elseif is_set(TranscriptURL) then
            Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
    Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
        end
    end
       
        local Publisher;
    local Publisher;
        if is_set(Periodical) and
    if is_set(Periodical) and
            not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
    not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
            if is_set(PublisherName) then
    if is_set(PublisherName) then
                if is_set(PublicationPlace) then
    if is_set(PublicationPlace) then
                    Publisher = PublicationPlace .. ": " .. PublisherName;
    Publisher = PublicationPlace .. ": " .. PublisherName;
                else
    else
                    Publisher = PublisherName;   
    Publisher = PublisherName;   
                end
    end
            elseif is_set(PublicationPlace) then
    elseif is_set(PublicationPlace) then
                Publisher= PublicationPlace;
    Publisher= PublicationPlace;
            else  
    else  
                Publisher = "";
    Publisher = "";
            end
    end
            if is_set(PublicationDate) then
    if is_set(PublicationDate) then
                if is_set(Publisher) then
    if is_set(Publisher) then
                    Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
    Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
                else
    else
                    Publisher = PublicationDate;
    Publisher = PublicationDate;
                end
    end
            end
    end
            if is_set(Publisher) then
    if is_set(Publisher) then
                Publisher = " (" .. Publisher .. ")";
    Publisher = " (" .. Publisher .. ")";
            end
    end
        else
    else
            if is_set(PublicationDate) then
    if is_set(PublicationDate) then
                PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
    PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
            end
    end
            if is_set(PublisherName) then
    if is_set(PublisherName) then
                if is_set(PublicationPlace) then
    if is_set(PublicationPlace) then
                    Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
    Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
                else
    else
                    Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
    Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
                end          
    end
            elseif is_set(PublicationPlace) then  
    elseif is_set(PublicationPlace) then  
                Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
    Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
            else  
    else  
                Publisher = PublicationDate;
    Publisher = PublicationDate;
            end
    end
        end
    end
       
        -- Several of the above rely upon detecting this as nil, so do it last.
    -- Several of the above rely upon detecting this as nil, so do it last.
        if is_set(Periodical) then
    if is_set(Periodical) then
            if is_set(Title) or is_set(TitleNote) then  
    if is_set(Title) or is_set(TitleNote) then  
                Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
    Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
            else  
    else  
                Periodical = wrap( 'italic-title', Periodical )
    Periodical = wrap( 'italic-title', Periodical )
            end
    end
        end
    end


    --[[
    --[[
    Line 1,884: Line 2,020:
    end
    end


        -- Piece all bits together at last.  Here, all should be non-nil.
    -- Piece all bits together at last.  Here, all should be non-nil.
        -- We build things this way because it is more efficient in LUA
    -- We build things this way because it is more efficient in LUA
        -- not to keep reassigning to the same string variable over and over.
    -- not to keep reassigning to the same string variable over and over.


        local tcommon
    local tcommon
        if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
    if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
            if is_set(Others) then Others = Others .. sepc .. " " end
    if is_set(Others) then Others = Others .. sepc .. " " end
            tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series,  
    tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series,  
                Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
    Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
        else  
    else  
            tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language,  
    tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language,  
                Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
    Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
        end
    end
       
        if #ID_list > 0 then
    if #ID_list > 0 then
            ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
    ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
        else
    else
            ID_list = ID;
    ID_list = ID;
        end
    end
       
        local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
    local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
        local text;
    local text;
        local pgtext = Position .. Page .. Pages .. At;
    local pgtext = Position .. Page .. Pages .. At;
       
        if is_set(Authors) then
    if is_set(Authors) then
            if is_set(Coauthors) then
    if is_set(Coauthors) then
                Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
    Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
            end
    end
            if is_set(Date) then
    if is_set(Date) then
                Date = " ("..Date..")" .. OrigYear .. sepc .. " "
    Date = " ("..Date..")" .. OrigYear .. sepc .. " "
            elseif string.sub(Authors,-1,-1) == sepc then
    elseif string.sub(Authors,-1,-1) == sepc then
                Authors = Authors .. " "
    Authors = Authors .. " "
            else
    else
                Authors = Authors .. sepc .. " "
    Authors = Authors .. sepc .. " "
            end
    end
            if is_set(Editors) then
    if is_set(Editors) then
                local in_text = " ";
    local in_text = " ";
                local post_text = "";
    local post_text = "";
                if is_set(Chapter) then
    if is_set(Chapter) then
                    in_text = in_text .. cfg.messages['in'] .. " "
    in_text = in_text .. cfg.messages['in'] .. " "
                else
    else
                    if EditorCount <= 1 then
    if EditorCount <= 1 then
                        post_text = ", " .. cfg.messages['editor'];
    post_text = ", " .. cfg.messages['editor'];
                    else
    else
                        post_text = ", " .. cfg.messages['editors'];
    post_text = ", " .. cfg.messages['editors'];
                    end
    end
                end  
    end  
                if (sepc ~= '.') then in_text = in_text:lower() end
    if (sepc ~= '.') then in_text = in_text:lower() end
                Editors = in_text .. Editors .. post_text;
    Editors = in_text .. Editors .. post_text;
                if (string.sub(Editors,-1,-1) == sepc)
    if (string.sub(Editors,-1,-1) == sepc)
                    then Editors = Editors .. " "
    then Editors = Editors .. " "
                    else Editors = Editors .. sepc .. " "
    else Editors = Editors .. sepc .. " "
                end
    end
            end
    end
            text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
    text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
            text = safejoin( {text, pgtext, idcommon}, sepc );
    text = safejoin( {text, pgtext, idcommon}, sepc );
        elseif is_set(Editors) then
    elseif is_set(Editors) then
            if is_set(Date) then
    if is_set(Date) then
                if EditorCount <= 1 then
    if EditorCount <= 1 then
                    Editors = Editors .. ", " .. cfg.messages['editor'];
    Editors = Editors .. ", " .. cfg.messages['editor'];
                else
    else
                    Editors = Editors .. ", " .. cfg.messages['editors'];
    Editors = Editors .. ", " .. cfg.messages['editors'];
                end
    end
                Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
    Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
            else
    else
                if EditorCount <= 1 then
    if EditorCount <= 1 then
                    Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
    Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
                else
    else
                    Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
    Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
                end
    end
            end
    end
            text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
    text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
            text = safejoin( {text, pgtext, idcommon}, sepc );
    text = safejoin( {text, pgtext, idcommon}, sepc );
        else
    else
            if is_set(Date) then
    if is_set(Date) then
                if ( string.sub(tcommon,-1,-1) ~= sepc )
    if ( string.sub(tcommon,-1,-1) ~= sepc )
                  then Date = sepc .." " .. Date .. OrigYear
      then Date = sepc .." " .. Date .. OrigYear
                  else Date = " " .. Date .. OrigYear
      else Date = " " .. Date .. OrigYear
                end
    end
            end
    end
            if config.CitationClass=="journal" and is_set(Periodical) then
    if config.CitationClass=="journal" and is_set(Periodical) then
                text = safejoin( {Chapter, Place, tcommon}, sepc );
    text = safejoin( {Chapter, Place, tcommon}, sepc );
                text = safejoin( {text, pgtext, Date, idcommon}, sepc );
    text = safejoin( {text, pgtext, Date, idcommon}, sepc );
            else
    else
                text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
    text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
                text = safejoin( {text, pgtext, idcommon}, sepc );
    text = safejoin( {text, pgtext, idcommon}, sepc );
            end
    end
        end
    end
       
    if is_set(PostScript) and PostScript ~= sepc then
    if is_set(PostScript) and PostScript ~= sepc then
    text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
    text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
    text = text:sub(1,-sepc:len()-1);
    text = text:sub(1,-sepc:len()-1);
    -- text = text:sub(1,-2); --Remove final separator (assumes that sepc is only one character)
    -- text = text:sub(1,-2); --Remove final separator (assumes that sepc is only one character)
    end  
    end
       
        text = safejoin( {text, PostScript}, sepc );
    text = safejoin( {text, PostScript}, sepc );


        -- Now enclose the whole thing in a <span/> element
    -- Now enclose the whole thing in a <span/> element
        local options = {};
    local options = {};
       
        if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
    if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
            options.class = "citation " .. config.CitationClass;
    options.class = "citation " .. config.CitationClass;
        else
    else
            options.class = "citation";
    options.class = "citation";
        end
    end
       
        if is_set(Ref) and Ref:lower() ~= "none" then
    if is_set(Ref) and Ref:lower() ~= "none" then
            local id = Ref
    local id = Ref
            if ( "harv" == Ref ) then
    if ( "harv" == Ref ) then
                local names = {} --table of last names & year
    local names = {} --table of last names & year
                if #a > 0 then
    if #a > 0 then
                    for i,v in ipairs(a) do  
    for i,v in ipairs(a) do  
                        names[i] = v.last  
    names[i] = v.last  
                        if i == 4 then break end
    if i == 4 then break end
                    end
    end
                elseif #e > 0 then
    elseif #e > 0 then
                    for i,v in ipairs(e) do  
    for i,v in ipairs(e) do  
                        names[i] = v.last  
    names[i] = v.last  
                        if i == 4 then break end              
    if i == 4 then break end
                    end
    end
                end
    end
    names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
    names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
                id = anchorid(names)
    id = anchorid(names)
            end
    end
            options.id = id;
    options.id = id;
        end
    end
       
        if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
    if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
            z.error_categories = {};
    z.error_categories = {};
            text = seterror('empty_citation');
    text = seterror('empty_citation');
            z.message_tail = {};
    z.message_tail = {};
        end
    end
       
        if is_set(options.id) then  
    if is_set(options.id) then  
            text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
        else
    else
            text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
        end      
    end


        local empty_span = '<span style="display:none;">&nbsp;</span>';
    local empty_span = '<span style="display:none;">&nbsp;</span>';
       
        -- Note: Using display: none on then COinS span breaks some clients.
    -- Note: Using display: none on then COinS span breaks some clients.
        local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
    local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
        text = text .. OCinS;
    text = text .. OCinS;
       
        if #z.message_tail ~= 0 then
    if #z.message_tail ~= 0 then
            text = text .. " ";
    text = text .. " ";
            for i,v in ipairs( z.message_tail ) do
    for i,v in ipairs( z.message_tail ) do
                if is_set(v[1]) then
    if is_set(v[1]) then
                    if i == #z.message_tail then
    if i == #z.message_tail then
                        text = text .. errorcomment( v[1], v[2] );
    text = text .. errorcomment( v[1], v[2] );
                    else
    else
                        text = text .. errorcomment( v[1] .. "; ", v[2] );
    text = text .. errorcomment( v[1] .. "; ", v[2] );
                    end
    end
                end
    end
            end
    end
        end
    end
       
        no_tracking_cats = no_tracking_cats:lower();
    no_tracking_cats = no_tracking_cats:lower();
        if inArray(no_tracking_cats, {"", "no", "false", "n"}) then
    if inArray(no_tracking_cats, {"", "no", "false", "n"}) then
            for _, v in ipairs( z.error_categories ) do
    for _, v in ipairs( z.error_categories ) do
                text = text .. '[[Category:' .. v ..']]';
    text = text .. '[[Category:' .. v ..']]';
            end
    end
        end
    end
       
        return text
    return text
    end
    end


    -- 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.
    function z.citation(frame)
    function z.citation(frame)
        local pframe = frame:getParent()
    local pframe = frame:getParent()
       
        if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then -- did the {{#invoke:}} use sandbox version?
    if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then -- did the {{#invoke:}} use sandbox version?
        cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); -- load sandbox versions of Configuration and Whitelist and ...
    cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); -- load sandbox versions of Configuration and Whitelist and ...
        whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
    whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
        dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- ... sandbox version of date validation code
    dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- ... sandbox version of date validation code
        else -- otherwise
    else -- otherwise
        cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ...
    cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ...
        whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
    whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
        dates = require('Module:Citation/CS1/Date_validation').dates -- ... live version of date validation code
    dates = require('Module:Citation/CS1/Date_validation').dates -- ... live version of date validation code
    end
    end
        local args = {};
    local args = {};
        local suggestions = {};
    local suggestions = {};
        local error_text, error_state;
    local error_text, error_state;


        local config = {};
    local config = {};
        for k, v in pairs( frame.args ) do
    for k, v in pairs( frame.args ) do
            config[k] = v;
    config[k] = v;
            args[k] = v;      
    args[k] = v;  
        end  
    end


        for k, v in pairs( pframe.args ) do
    for k, v in pairs( pframe.args ) do
            if v ~= '' then
    if v ~= '' then
                if not validate( k ) then          
    if not validate( k ) then
                    error_text = "";
    error_text = "";
                    if type( k ) ~= 'string' then
    if type( k ) ~= 'string' then
                        -- Exclude empty numbered parameters
    -- Exclude empty numbered parameters
                        if v:match("%S+") ~= nil then
    if v:match("%S+") ~= nil then
                            error_text, error_state = seterror( 'text_ignored', {v}, true );
    error_text, error_state = seterror( 'text_ignored', {v}, true );
                        end
    end
                    elseif validate( k:lower() ) then  
    elseif validate( k:lower() ) then  
                        error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
                    else
    else
                        if #suggestions == 0 then
    if #suggestions == 0 then
                            suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
    suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
                        end
    end
                        if suggestions[ k:lower() ] ~= nil then
    if suggestions[ k:lower() ] ~= nil then
                            error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
                        else
    else
                            error_text, error_state = seterror( 'parameter_ignored', {k}, true );
    error_text, error_state = seterror( 'parameter_ignored', {k}, true );
                        end
    end
                    end                
    end  
                    if error_text ~= '' then
    if error_text ~= '' then
                        table.insert( z.message_tail, {error_text, error_state} );
    table.insert( z.message_tail, {error_text, error_state} );
                    end              
    end
                end
    end
                args[k] = v;
    args[k] = v;
            elseif args[k] ~= nil or (k == 'postscript') then
    elseif args[k] ~= nil or (k == 'postscript') then
                args[k] = v;
    args[k] = v;
            end      
    end
        end  
    end
       
        return citation0( config, args)
    return citation0( config, args)
    end
    end


    return z
    return z

    Revision as of 14:02, 24 August 2014

    Documentation for this module may be created at Module:Citation/CS1/doc

    local z = {
    	error_categories = {};
    	error_ids = {};
    	message_tail = {};
    }
    
    -- Whether variable is set or not
    function is_set( var )
    	return not (var == nil or var == '');
    end
    
    -- First set variable or nil if none
    function first_set(...)
    	local list = {...};
    	for _, var in pairs(list) do
    		if is_set( var ) then
    			return var;
    		end
    	end
    end
    
    -- Whether needle is in haystack
    function inArray( needle, haystack )
    	if needle == nil then
    		return false;
    	end
    	for n,v in ipairs( haystack ) do
    		if v == needle then
    			return n;
    		end
    	end
    	return false;
    end
    
    --[[
    Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
    |coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
    details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
    ]]
    function deprecated_parameter()
    	if true ~= Page_in_deprecated_cat then	-- if we haven't been here before then set a 
    		Page_in_deprecated_cat=true;		-- sticky flag so that if there are more than one deprecated parameter the category is added only once
    --		table.insert( z.message_tail, { seterror( 'deprecated_params', {error_message}, true ) } );		-- add error message
    		table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } );		-- add error message
    	end
    end
    
    -- Populates numbered arguments in a message string using an argument table.
    function substitute( msg, args )
    --	return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
    	return args and mw.message.newRawMessage( msg, args ):plain() or msg;
    end
    
    --[[
    Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value.
    This function will positive kern  either single or double quotes:
    	"'Unkerned title with leading and trailing single quote marks'"
    	" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
    ]]
    function kern_quotes (str)
    	local left='<span style="padding-left:0.2em;">%1</span>';		-- spacing to use when title contains leading single or double quote mark
    	local right='<span style="padding-right:0.2em;">%1</span>';		-- spacing to use when title contains trailing single or double quote mark
    	
    	if  str:match ("^[\"\'][^\']") then
    		str = string.gsub( str, "^[\"\']", left, 1 );				-- replace (captured) leading single or double quote with left-side <span>
    	end
    	if str:match ("[^\'][\"\']$") then
    		str = string.gsub( str, "[\"\']$", right, 1 );			-- replace (captured) trailing single or double quote with right-side <span>
    	end
    	return str;
    end
    
    -- Wraps a string using a message_list configuration taking one argument
    function wrap( key, str, lower )
    	if not is_set( str ) then
    		return "";
    	elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
    		str = safeforitalics( str );
    	end
    	if lower == true then
    		return substitute( cfg.messages[key]:lower(), {str} );
    	else
    		return substitute( cfg.messages[key], {str} );
    	end		
    end
    
    --[[
    Argument wrapper.  This function provides support for argument 
    mapping defined in the configuration file so that multiple names
    can be transparently aliased to single internal variable.
    ]]
    function argument_wrapper( args )
    	local origin = {};
    	
    	return setmetatable({
    		ORIGIN = function( self, k )
    			local dummy = self[k]; --force the variable to be loaded.
    			return origin[k];
    		end
    	},
    	{
    		__index = function ( tbl, k )
    			if origin[k] ~= nil then
    				return nil;
    			end
    			
    			local args, list, v = args, cfg.aliases[k];
    			
    			if type( list ) == 'table' then
    				v, origin[k] = selectone( args, list, 'redundant_parameters' );
    				if origin[k] == nil then
    					origin[k] = ''; -- Empty string, not nil
    				end
    			elseif list ~= nil then
    				v, origin[k] = args[list], list;
    			else
    				-- maybe let through instead of raising an error?
    				-- v, origin[k] = args[k], k;
    				error( cfg.messages['unknown_argument_map'] );
    			end
    			
    			-- Empty strings, not nil;
    			if v == nil then
    				v = cfg.defaults[k] or '';
    				origin[k] = '';
    			end
    			
    			tbl = rawset( tbl, k, v );
    			return v;
    		end,
    	});
    end
    
    --[[
    Looks for a parameter's name in the whitelist.
    
    Parameters in the whitelist can have three values:
    	true - active, supported parameters
    	false - deprecated, supported parameters
    	nil - unsupported parameters
    ]]
    function validate( name )
    	local name = tostring( name );
    	local state = whitelist.basic_arguments[ name ];
    	
    	-- Normal arguments
    	if true == state then return true; end		-- valid actively supported parameter
    	if false == state then
    		deprecated_parameter ();				-- parameter is deprecated but still supported
    		return true;
    	end
    	
    	-- Arguments with numbers in them
    	name = name:gsub( "%d+", "#" );				-- replace digit(s) with # (last25 becomes last#
    	state = whitelist.numbered_arguments[ name ];
    	if true == state then return true; end		-- valid actively supported parameter
    	if false == state then
    		deprecated_parameter ();				-- parameter is deprecated but still supported
    		return true;
    	end
    	
    	return false;								-- Not supported because not found or name is set to nil
    end
    
    -- Formats a comment for error trapping
    function errorcomment( content, hidden )
    	return wrap( hidden and 'hidden-error' or 'visible-error', content );
    end
    
    --[[
    Sets an error condition and returns the appropriate error message.  The actual placement
    of the error message in the output is the responsibility of the calling function.
    ]]
    function seterror( error_id, arguments, raw, prefix, suffix )
    	local error_state = cfg.error_conditions[ error_id ];
    	
    	prefix = prefix or "";
    	suffix = suffix or "";
    	
    	if error_state == nil then
    		error( cfg.messages['undefined_error'] );
    	elseif is_set( error_state.category ) then
    		table.insert( z.error_categories, error_state.category );
    	end
    	
    	local message = substitute( error_state.message, arguments );
    	
    	message = message .. " ([[" .. cfg.messages['help page link'] .. 
    		"#" .. error_state.anchor .. "|" ..
    		cfg.messages['help page label'] .. "]])";
    	
    	z.error_ids[ error_id ] = true;
    	if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
    			and z.error_ids['citation_missing_title'] then
    		return '', false;
    	end
    	
    	message = table.concat({ prefix, message, suffix });
    	
    	if raw == true then
    		return message, error_state.hidden;
    	end		
    		
    	return errorcomment( message, error_state.hidden );
    end
    
    -- Formats a wiki style external link
    function externallinkid(options)
    	local url_string = options.id;
    	if options.encode == true or options.encode == nil then
    		url_string = mw.uri.encode( url_string );
    	end
    	return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
    		options.link, options.label, options.separator or "&nbsp;",
    		options.prefix, url_string, options.suffix or "",
    		mw.text.nowiki(options.id)
    	);
    end
    
    -- Formats a wiki style internal link
    function internallinkid(options)
    	return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
    		options.link, options.label, options.separator or "&nbsp;",
    		options.prefix, options.id, options.suffix or "",
    		mw.text.nowiki(options.id)
    	);
    end
    
    -- Format an external link with error checking
    function externallink( URL, label, source )
    	local error_str = "";
    	if not is_set( label ) then
    		label = URL;
    		if is_set( source ) then
    			error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
    		else
    			error( cfg.messages["bare_url_no_origin"] );
    		end			
    	end
    	if not checkurl( URL ) then
    		error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
    	end
    	return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
    end
    
    -- Formats a link to Amazon
    function amazon(id, domain)
    	if not is_set(domain) then 
    		domain = "com"
    	elseif ( "jp" == domain or "uk" == domain ) then
    		domain = "co." .. domain
    	end
    	local handler = cfg.id_handlers['ASIN'];
    	return externallinkid({link = handler.link,
    		label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
    		encode=handler.encode, separator = handler.separator})
    end
    
    --[[
    format and error check arXiv identifier.  There are two valid forms of the identifier:
    the first form, valid only between date codes 9108 and 0703 is:
    	arXiv:<archive>.<class>/<date code><number><version>
    where:
    	<archive> is a string of alpha characters - may be hyphenated; no other punctuation
    	<class> is a string of alpha characters - may be hyphenated; no other punctuation
    	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
    		first digit of YY for this form can only 9 and 0
    	<number> is a three-digit number
    	<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
    	
    the second form, valid from April 2007 is:
    	arXiv:<date code>.<number><version>
    where:
    	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
    	<number> is a four-digit number
    	<version> is a 1 or more digit number preceded with a lowercase v; no spaces
    ]]
    
    function arxiv (id)
    	local handler = cfg.id_handlers['ARXIV'];
    	local year, month, version;
    	local err_cat = ""
    	
    	year, month, version = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d([v%d]*)$");				-- test for the 9108-0703 format
    	if not year then		-- arXiv id is not proper 9108-0703 form
    		year, month, version = id:match("^(%d%d)([01]%d)%.%d%d%d%d([v%d]*)$");	-- test for the 0704- format
    		if not year then	
    			err_cat = ' ' .. seterror( 'bad_arxiv' );							-- arXiv id doesn't match either format
    		else	-- id is the 0704- format
    			year = tonumber(year);
    			month = tonumber(month);
    			if ((7 > year) or (1 > month and 12 < month)) or					-- is year invalid or is month invalid? (doesn't test for future years)
    				((7 == year) and (4 > month)) or								-- when year is 07, is month invalid (before April)?
    				is_set (version) and nil == version:match("v%d+") then			-- is version proper format of single 'v' followed by digits?
    					err_cat = ' ' .. seterror( 'bad_arxiv' );					-- set error message
    			end
    		end
    	else	-- id is the 9108-0703 format; are the date values ok
    		year = tonumber(year);
    		month = tonumber(month);
    		if ((91 > year and 7 < year) or (1 > month and 12 < month)) or			-- if invalid year or invalid month
    			((91 == year and 8 > month) or (7 == year and 3 < month)) or 		-- if years ok, are starting and ending months ok?
    				is_set (version) and nil == version:match("v%d+") then			-- is version proper format of single 'v' followed by digits?
    					err_cat = ' ' .. seterror( 'bad_arxiv' );					-- set error message
    		end
    	end
    
    	return externallinkid({link = handler.link, label = handler.label,
    			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
    end
    
    --[[
    lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
    1. Remove all blanks.
    2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
    3. If there is a hyphen in the string:
    	a. Remove it.
    	b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
    		1. All these characters should be digits, and there should be six or less. (not done in this function)
    		2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
    
    Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
    ]]
    
    function normalize_lccn (lccn)
    	lccn = lccn:gsub ("%s", "");									-- 1. strip whitespace
    
    	if nil ~= string.find (lccn,'/') then
    		lccn = lccn:match ("(.-)/");								-- 2. remove forward slash and all character to the right of it
    	end
    
    	local prefix
    	local suffix
    	prefix, suffix = lccn:match ("(.+)%-(.+)");						-- 3.a remove hyphen by splitting the string into prefix and suffix
    
    	if nil ~= suffix then											-- if there was a hyphen
    		suffix=string.rep("0", 6-string.len (suffix)) .. suffix;	-- 3.b.2 left fill the suffix with 0s if suffix length less than 6
    		lccn=prefix..suffix;										-- reassemble the lccn
    	end
    	
    	return lccn;
    	end
    
    --[[
    Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
    rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
    
    length = 8 then all digits
    length = 9 then lccn[1] is alpha
    length = 10 then lccn[1] and lccn[2] are both alpha or both digits
    length = 11 then lccn[1] is alpha, lccn[2] and lccn[3] are both alpha or both digits
    length = 12 then lccn[1] and lccn[2] are both alpha
    
    ]]
    function lccn(lccn)
    	local handler = cfg.id_handlers['LCCN'];
    	local err_cat =  '';								-- presume that LCCN is valid
    	local id = lccn;									-- local copy of the lccn
    
    	id = normalize_lccn (id);							-- get canonical form (no whitespace, hyphens, forward slashes)
    	local len = id:len();								-- get the length of the lccn
    
    	if 8 == len then
    		if id:match("[^%d]") then						-- if LCCN has anything but digits (nil if only digits)
    			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
    		end
    	elseif 9 == len then								-- LCCN should be adddddddd
    		if nil == id:match("%a%d%d%d%d%d%d%d%d") then			-- does it match our pattern?
    			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
    		end
    	elseif 10 == len then								-- LCCN should be aadddddddd or dddddddddd
    		if id:match("[^%d]") then							-- if LCCN has anything but digits (nil if only digits) ...
    			if nil == id:match("^%a%a%d%d%d%d%d%d%d%d") then	-- ... see if it matches our pattern
    				err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
    			end
    		end
    	elseif 11 == len then								-- LCCN should be aaadddddddd or adddddddddd
    		if not (id:match("^%a%a%a%d%d%d%d%d%d%d%d") or id:match("^%a%d%d%d%d%d%d%d%d%d%d")) then	-- see if it matches one of our patterns
    			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
    		end
    	elseif 12 == len then								-- LCCN should be aadddddddddd
    		if not id:match("^%a%a%d%d%d%d%d%d%d%d%d%d") then	-- see if it matches our pattern
    			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
    		end
    	else
    		err_cat = ' ' .. seterror( 'bad_lccn' );		-- wrong length, set an error message
    	end
    
    	if not is_set (err_cat) and nil ~= lccn:find ('%s') then
    		err_cat = ' ' .. seterror( 'bad_lccn' );		-- lccn contains a space, set an error message
    	end
    
    	return externallinkid({link = handler.link, label = handler.label,
    			prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
    end
    
    --[[
    Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
    contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
    ]]
    function pmid(id)
    	local test_limit = 30000000;						-- update this value as PMIDs approach
    	local handler = cfg.id_handlers['PMID'];
    	local err_cat =  '';								-- presume that PMID is valid
    	
    	if id:match("[^%d]") then							-- if PMID has anything but digits
    		err_cat = ' ' .. seterror( 'bad_pmid' );		-- set an error message
    	else												-- PMID is only digits
    		local id_num = tonumber(id);					-- convert id to a number for range testing
    		if 1 > id_num or test_limit < id_num then		-- if PMID is outside test limit boundaries
    			err_cat = ' ' .. seterror( 'bad_pmid' );	-- set an error message
    		end
    	end
    	
    	return externallinkid({link = handler.link, label = handler.label,
    			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
    end
    
    --[[
    Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
    in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
    ]]
    function is_embargoed(embargo)
    	if is_set(embargo) then
    		local lang = mw.getContentLanguage();
    		local good1, embargo_date, good2, todays_date;
    		good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
    		good2, todays_date = pcall( lang.formatDate, lang, 'U' );
    	
    		if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then	--is embargo date is in the future?
    			return true;	-- still embargoed
    		end
    	end
    	return false;			-- embargo expired or |embargo= not set
    end
    
    --[[
    Format a PMC, do simple error checking, and check for embargoed articles.
    
    The embargo parameter takes a date for a value. If the embargo date is in the future
    the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
    the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.
    
    PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
    than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
    ]]
    function pmc(id, embargo)
    	local test_limit = 5000000;							-- update this value as PMCs approach
    	local handler = cfg.id_handlers['PMC'];
    	local err_cat =  '';								-- presume that PMC is valid
    	
    	local text;
    
    	if id:match("[^%d]") then							-- if PMC has anything but digits
    		err_cat = ' ' .. seterror( 'bad_pmc' );			-- set an error message
    	else												-- PMC is only digits
    		local id_num = tonumber(id);					-- convert id to a number for range testing
    		if 1 > id_num or test_limit < id_num then		-- if PMC is outside test limit boundaries
    			err_cat = ' ' .. seterror( 'bad_pmc' );		-- set an error message
    		end
    	end
    	
    	if is_embargoed(embargo) then
    		text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat;	--still embargoed so no external link
    	else
    		text = externallinkid({link = handler.link, label = handler.label,			--no embargo date, ok to link to article
    			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
    	end
    	return text;
    end
    
    -- Formats a DOI and checks for DOI errors.
    
    -- DOI names contain two parts: prefix and suffix separated by a forward slash.
    --  Prefix: directory indicator '10.' followed by a registrant code
    --  Suffix: character string of any length chosen by the registrant
    
    -- This function checks a DOI name for: prefix/suffix.  If the doi name contains spaces or endashes,
    -- or, if it ends with a period or a comma, this function will emit a bad_doi error message.
    
    -- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
    -- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.
    
    function doi(id, inactive)
    	local cat = ""
    	local handler = cfg.id_handlers['DOI'];
    	
    	local text;
    	if is_set(inactive) then
    		local inactive_year = inactive:match("%d%d%d%d") or '';		-- try to get the year portion from the inactive date
    		text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
    		if is_set(inactive_year) then
    			table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
    		else
    			table.insert( z.error_categories, "Pages with inactive DOIs" );	-- when inactive doesn't contain a recognizable year
    		end
    		inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")" 
    	else 
    		text = externallinkid({link = handler.link, label = handler.label,
    			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
    		inactive = "" 
    	end
    
    	if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then	-- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
    		cat = ' ' .. seterror( 'bad_doi' );
    	end
    	return text .. inactive .. cat 
    end
    
    -- Formats an OpenLibrary link, and checks for associated errors.
    function openlibrary(id)
    	local code = id:sub(-1,-1)
    	local handler = cfg.id_handlers['OL'];
    	if ( code == "A" ) then
    		return externallinkid({link=handler.link, label=handler.label,
    			prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
    			encode = handler.encode})
    	elseif ( code == "M" ) then
    		return externallinkid({link=handler.link, label=handler.label,
    			prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
    			encode = handler.encode})
    	elseif ( code == "W" ) then
    		return externallinkid({link=handler.link, label=handler.label,
    			prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
    			encode = handler.encode})
    	else
    		return externallinkid({link=handler.link, label=handler.label,
    			prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
    			encode = handler.encode}) .. 
    			' ' .. seterror( 'bad_ol' );
    	end
    end
    
    --[[
    Validate and format an issn.  This code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
    digits with a space.  When that condition occurred, the resulting link looked like this:
    
    	|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
    	
    This code now prevents that by inserting a hyphen at the issn midpoint.  It also validates the issn for length and makes sure that the checkdigit agrees
    with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
    error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
    ]]
    function issn(id)
    	local issn_copy = id;		-- save a copy of unadulterated issn; use this version for display if issn does not validate
    	local handler = cfg.id_handlers['ISSN'];
    	local text;
    	local valid_issn = true;
    
    	id=id:gsub( "[%s-–]", "" );									-- strip spaces, hyphens, and endashes from the issn
    
    	if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then		-- validate the issn: 8 digits long, containing only 0-9 or X in the last position
    		valid_issn=false;										-- wrong length or improper character
    	else
    		valid_issn=is_valid_isxn(id, 8);						-- validate issn
    	end
    
    	if true == valid_issn then
    		id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 );	-- if valid, display correctly formatted version
    	else
    		id = issn_copy;											-- if not valid, use the show the invalid issn with error message
    	end
    	
    	text = externallinkid({link = handler.link, label = handler.label,
    		prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
     
    	if false == valid_issn then
    		text = text .. ' ' .. seterror( 'bad_issn' )			-- add an error message if the issn is invalid
    	end 
    	
    	return text
    end
    
    --[[
    This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
    Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
    ]]
    function set_titletype(cite_class, title_type)
    	if is_set(title_type) then
    		if "none" == title_type then
    			title_type = "";					-- if |type=none then type parameter not displayed
    		end
    		return title_type;						-- if |type= has been set to any other value use that value
    	end
    
    	if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then		-- if this citation is cite AV media notes or cite DVD notes
    		return "Media notes";					-- display AV media notes / DVD media notes annotation
    
    	elseif "podcast" == cite_class then			-- if this citation is cite podcast
    		return "Podcast";						-- display podcast annotation
    
    	elseif "pressrelease" == cite_class then	-- if this citation is cite press release
    		return "Press release";					-- display press release annotation
    
    	elseif "techreport" == cite_class then		-- if this citation is cite techreport
    		return "Technical report";				-- display techreport annotation
    	
    	elseif "thesis" == cite_class then			-- if this citation is cite thesis (degree option handled after this function returns)
    			return "Thesis";					-- display simple thesis annotation (without |degree= modification)
    	end
    end
    
    --[[
    Determines whether a URL string is valid
    
    At present the only check is whether the string appears to 
    be prefixed with a URI scheme.  It is not determined whether 
    the URI scheme is valid or whether the URL is otherwise well 
    formed.
    ]]
    function checkurl( url_str )
    	-- Protocol-relative or URL scheme
    	return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
    end
    
    -- Removes irrelevant text and dashes from ISBN number
    -- Similar to that used for Special:BookSources
    function cleanisbn( isbn_str )
    	return isbn_str:gsub( "[^-0-9X]", "" );
    end
    
    -- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
    --TODO: Fix so this code supports urls like this:
    --	http://www.history.navy.mil/download/va125153.pdf#page=13 %w/:\.
    function get_coins_pages (pages)
    	if not is_set (pages) then return pages; end			-- if no page numbers then we're done
    	
    	while true do
    		pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]");	-- pattern is the opening bracket, the url and following space(s): "[url "
    		if nil == pattern then break; end					-- no more urls
    		pages = pages:gsub(pattern, "");					-- remove as many instances of pattern as possible
    	end
    	pages = pages:gsub("[%[%]]", "");						-- remove the brackets
    	pages = pages:gsub("–", "-" );							-- replace endashes with hyphens
    	pages = pages:gsub("&%w+;", "-" );						-- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
    	return pages;
    end
    
    --[[
    ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
    If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
    spaces and other non-isxn characters.
    ]]
    function is_valid_isxn (isxn_str, len)
    	local temp = 0;
    	isxn_str = { isxn_str:byte(1, len) };	-- make a table of bytes
    	len = len+1;							-- adjust to be a loop counter
    	for i, v in ipairs( isxn_str ) do		-- loop through all of the bytes and calculate the checksum
    		if v == string.byte( "X" ) then		-- if checkdigit is X
    			temp = temp + 10*( len - i );	-- it represents 10 decimal
    		else
    			temp = temp + tonumber( string.char(v) )*(len-i);
    		end
    	end
    	return temp % 11 == 0;					-- returns true if calculation result is zero
    end
    
    -- Determines whether an ISBN string is valid
    function checkisbn( isbn_str )
    	if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end		-- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
    	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" );	-- remove hyphens and spaces
    	local len = isbn_str:len();
     
    	if len ~= 10 and len ~= 13 then
    		return false;
    	end
    
    	if len == 10 then
    		if isbn_str:match( "^%d*X?$" ) == nil then return false; end
    		return is_valid_isxn(isbn_str, 10);
    	else
    		local temp = 0;
    		if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end	-- isbn13 begins with 978 or 979
    		isbn_str = { isbn_str:byte(1, len) };
    		for i, v in ipairs( isbn_str ) do
    			temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
    		end
    		return temp % 10 == 0;
    	end
    end
    
    -- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
    function removewikilink( str )
    	return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
    		return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
    	end));
    end
    
    -- Escape sequences for content that will be used for URL descriptions
    function safeforurl( str )
    	if str:match( "%[%[.-%]%]" ) ~= nil then 
    		table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
    	end
    	
    	return str:gsub( '[%[%]\n]', {	
    		['['] = '&#91;',
    		[']'] = '&#93;',
    		['\n'] = ' ' } );
    end
    
    -- Converts a hyphen to a dash
    function hyphentodash( str )
    	if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
    		return str;
    	end	
    	return str:gsub( '-', '–' );
    end
    
    -- Protects a string that will be wrapped in wiki italic markup '' ... ''
    function safeforitalics( str )
    	--[[ Note: We cannot use <i> for italics, as the expected behavior for
    	italics specified by ''...'' in the title is that they will be inverted
    	(i.e. unitalicized) in the resulting references.  In addition, <i> and ''
    	tend to interact poorly under Mediawiki's HTML tidy. ]]
    	
    	if not is_set(str) then
    		return str;
    	else
    		if str:sub(1,1) == "'" then str = "<span />" .. str; end
    		if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
    		
    		-- Remove newlines as they break italics.
    		return str:gsub( '\n', ' ' );
    	end
    end
    
    --[[
    Joins a sequence of strings together while checking for duplicate separation characters.
    
    TODO: safejoin() has a flaw where it won't remove the duplicate character from a |title= / |url= combination.
    This is because by the time we get here, |title=http://somesite.com and |title=Document Title. have been combined:
    	[http://somesite.com and ''Document Title.'']
    so that now, the last character is not sepc but is ] (unless sepc == ']' which breaks the external link)
    ]]
    function safejoin( tbl, duplicate_char )
    	--[[
    	Note: we use string functions here, rather than ustring functions.
    	
    	This has considerably faster performance and should work correctly as 
    	long as the duplicate_char is strict ASCII.  The strings
    	in tbl may be ASCII or UTF8.
    	]]
    	
    	local str = '';
    	local comp = '';
    	local end_chr = '';
    	local trim;
    	for _, value in ipairs( tbl ) do
    		if value == nil then value = ''; end
    		
    		if str == '' then
    			str = value;
    		elseif value ~= '' then
    			if value:sub(1,1) == '<' then
    				-- Special case of values enclosed in spans and other markup.
    				comp = value:gsub( "%b<>", "" );
    			else
    				comp = value;
    			end
    			
    			if comp:sub(1,1) == duplicate_char then
    				trim = false;
    				end_chr = str:sub(-1,-1);
    				-- str = str .. "<HERE(enchr=" .. end_chr.. ")"
    				if end_chr == duplicate_char then
    					str = str:sub(1,-2);
    				elseif end_chr == "'" then
    					if str:sub(-3,-1) == duplicate_char .. "''" then
    						str = str:sub(1, -4) .. "''";
    					elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
    						trim = true;
    					elseif str:sub(-4,-1) == duplicate_char .. "]''" then
    						trim = true;
    					end
    				elseif end_chr == "]" then
    					if str:sub(-3,-1) == duplicate_char .. "]]" then
    						trim = true;
    					elseif str:sub(-2,-1) == duplicate_char .. "]" then
    						trim = true;
    					end
    				elseif end_chr == " " then
    					if str:sub(-2,-1) == duplicate_char .. " " then
    						str = str:sub(1,-3);
    					end
    				end
    
    				if trim then
    					if value ~= comp then 
    						local dup2 = duplicate_char;
    						if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
    						
    						value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
    					else
    						value = value:sub( 2, -1 );
    					end
    				end
    			end
    			str = str .. value;
    		end
    	end
    	return str;
    end  
    
    -- Attempts to convert names to initials.
    function reducetoinitials(first)
    	local initials = {}
    	local i = 0;										-- counter for number of initials
    	for word in string.gmatch(first, "%S+") do
    		table.insert(initials, string.sub(word,1,1))	-- Vancouver format does not include full stops.
    		i = i + 1;										-- bump the counter 
    		if 2 <= i then break; end						-- only two initials allowed in Vancouver system; if 2, quit
    	end
    	return table.concat(initials)						-- Vancouver format does not include spaces.
    end
    
    -- Formats a list of people (e.g. authors / editors) 
    function listpeople(control, people)
    	local sep = control.sep;
    	local namesep = control.namesep
    	local format = control.format
    	local maximum = control.maximum
    	local lastauthoramp = control.lastauthoramp;
    	local text = {}
    	local etal = false;
    	
    	if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
    	if maximum ~= nil and maximum < 1 then return "", 0; end
    	
    	for i,person in ipairs(people) do
    		if is_set(person.last) then
    			local mask = person.mask
    			local one
    			local sep_one = sep;
    			if maximum ~= nil and i > maximum then
    				etal = true;
    				break;
    			elseif (mask ~= nil) then
    				local n = tonumber(mask)
    				if (n ~= nil) then
    					one = string.rep("&mdash;",n)
    				else
    					one = mask;
    					sep_one = " ";
    				end
    			else
    				one = person.last
    				local first = person.first
    				if is_set(first) then 
    					if ( "vanc" == format ) then first = reducetoinitials(first) end
    					one = one .. namesep .. first 
    				end
    				if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
    				if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end	-- check for url in author link;
    			end
    			table.insert( text, one )
    			table.insert( text, sep_one )
    		end
    	end
    
    	local count = #text / 2;
    	if count > 0 then 
    		if count > 1 and is_set(lastauthoramp) and not etal then
    			text[#text-2] = " & ";
    		end
    		text[#text] = nil; 
    	end
    	
    	local result = table.concat(text) -- construct list
    	if etal then 
    		local etal_text = cfg.messages['et al'];
    		result = result .. " " .. etal_text;
    	end
    	
    	-- if necessary wrap result in <span> tag to format in Small Caps
    	if ( "scap" == format ) then result = 
    		'<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    	end 
    	return result, count
    end
    
    -- Generates a CITEREF anchor ID.
    function anchorid( options )
    	return "CITEREF" .. table.concat( options );
    end
    
    --[[
    Gets name list from the input arguments
    
    Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
    Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
    find |last4= and |last5= then the search is done.
    
    This function emits an error message when there is a |firstn= without a matching |lastn=.  When there are 'holes' in the list of last names, |last1= and |last3=
    are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
    ]]
    function extractnames(args, list_name)
    	local names = {};			-- table of names
    	local i = 1;				-- loop counter/indexer
    	local count = 0;			-- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
    	
    	local err_msg_list_name = list_name:match ("(%w+)List") .. 's list';		-- modify AuthorList or EditorList for use in error messages if necessary
    
    	while true do
    		names[i] =				-- search through args for name components beginning at 1
    			{
    			last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ),
    			first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
    			link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
    			mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
    			};
    		if names[i].first and not names[i].last then							-- if there is a firstn without a matching lastn
    			names[i].first = nil;												-- set first to nil so we don't confuse the implicit et al message code
    			table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } );	-- add this error message
    			break;																-- and done because lastn not found
    		elseif not names[i].first and not names[i].last then					-- if both firstn and lastn aren't found, are we done?
    			count = count + 1;													-- number of times we haven't found last and first
    			if 2 == count then													-- two missing names and we give up
    				break;															-- normal exit or there is a two-name hole in the list; can't tell which
    			end
    		else																	-- last with or without a first
    			if 1 == count then													-- if the previous name was missing
    				table.insert( z.message_tail, { seterror( 'missing_name', {err_msg_list_name, i-1}, true ) } );		-- add this error message
    			end
    			count = 0;															-- reset the counter, we're looking for two consecutive missing names
    		end
    
    		i = i + 1;																-- bump to the next name
    	end
    	return names;																-- all done, return our list of names
    end
    
    -- Populates ID table from arguments using configuration settings
    function extractids( args )
    	local id_list = {};
    	for k, v in pairs( cfg.id_handlers ) do	
    		v = selectone( args, v.parameters, 'redundant_parameters' );
    		if is_set(v) then id_list[k] = v; end
    	end
    	return id_list;
    end
    
    -- Takes a table of IDs and turns it into a table of formatted ID outputs.
    function buildidlist( id_list, options )
    	local new_list, handler = {};
    	
    	function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
    	
    	for k, v in pairs( id_list ) do
    		-- fallback to read-only cfg
    		handler = setmetatable( { ['id'] = v }, fallback(k) );
    		
    		if handler.mode == 'external' then
    			table.insert( new_list, {handler.label, externallinkid( handler ) } );
    		elseif handler.mode == 'internal' then
    			table.insert( new_list, {handler.label, internallinkid( handler ) } );
    		elseif handler.mode ~= 'manual' then
    			error( cfg.messages['unknown_ID_mode'] );
    		elseif k == 'DOI' then
    			table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
    		elseif k == 'ARXIV' then
    			table.insert( new_list, {handler.label, arxiv( v ) } ); 
    		elseif k == 'ASIN' then
    			table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } ); 
    		elseif k == 'LCCN' then
    			table.insert( new_list, {handler.label, lccn( v ) } );
    		elseif k == 'OL' then
    			table.insert( new_list, {handler.label, openlibrary( v ) } );
    		elseif k == 'PMC' then
    			table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
    		elseif k == 'PMID' then
    			table.insert( new_list, {handler.label, pmid( v ) } );
    		elseif k == 'ISSN' then
    			table.insert( new_list, {handler.label, issn( v ) } );
    		elseif k == 'ISBN' then
    			local ISBN = internallinkid( handler );
    			if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
    				ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
    			end
    			table.insert( new_list, {handler.label, ISBN } );				
    		else
    			error( cfg.messages['unknown_manual_ID'] );
    		end
    	end
    	
    	function comp( a, b )	-- used in following table.sort()
    		return a[1] < b[1];
    	end
    	
    	table.sort( new_list, comp );
    	for k, v in ipairs( new_list ) do
    		new_list[k] = v[2];
    	end
    	
    	return new_list;
    end
      
    -- Chooses one matching parameter from a list of parameters to consider
    -- Generates an error if more than one match is present.
    function selectone( args, possible, error_condition, index )
    	local value = nil;
    	local selected = '';
    	local error_list = {};
    	
    	if index ~= nil then index = tostring(index); end
    	
    	-- Handle special case of "#" replaced by empty string
    	if index == '1' then
    		for _, v in ipairs( possible ) do
    			v = v:gsub( "#", "" );
    			if is_set(args[v]) then
    				if value ~= nil and selected ~= v then
    					table.insert( error_list, v );
    				else
    					value = args[v];
    					selected = v;
    				end
    			end
    		end		
    	end
    	
    	for _, v in ipairs( possible ) do
    		if index ~= nil then
    			v = v:gsub( "#", index );
    		end
    		if is_set(args[v]) then
    			if value ~= nil and selected ~=  v then
    				table.insert( error_list, v );
    			else
    				value = args[v];
    				selected = v;
    			end
    		end
    	end
    	
    	if #error_list > 0 then
    		local error_str = "";
    		for _, k in ipairs( error_list ) do
    			if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
    			error_str = error_str .. wrap( 'parameter', k );
    		end
    		if #error_list > 1 then
    			error_str = error_str .. cfg.messages['parameter-final-separator'];
    		else
    			error_str = error_str .. cfg.messages['parameter-pair-separator'];
    		end
    		error_str = error_str .. wrap( 'parameter', selected );
    		table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    	end
    	
    	return value, selected;
    end
    
    -- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
    -- the citation information.
    function COinS(data)
    	if 'table' ~= type(data) or nil == next(data) then
    		return '';
    	end
    	
    	local ctx_ver = "Z39.88-2004";
    	
    	-- treat table strictly as an array with only set values.
    	local OCinSoutput = setmetatable( {}, {
    		__newindex = function(self, key, value)
    			if is_set(value) then
    				rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
    			end
    		end
    	});
    	
    	if is_set(data.Chapter) then
    		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    		OCinSoutput["rft.genre"] = "bookitem";
    		OCinSoutput["rft.btitle"] = data.Chapter;
    		OCinSoutput["rft.atitle"] = data.Title;
    	elseif is_set(data.Periodical) then
    		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
    		OCinSoutput["rft.genre"] = "article";
    		OCinSoutput["rft.jtitle"] = data.Periodical;
    		OCinSoutput["rft.atitle"] = data.Title;
    	else
    		OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    		OCinSoutput["rft.genre"] = "book"
    		OCinSoutput["rft.btitle"] = data.Title;
    	end
    	
    	OCinSoutput["rft.place"] = data.PublicationPlace;
    	OCinSoutput["rft.date"] = data.Date;
    	OCinSoutput["rft.series"] = data.Series;
    	OCinSoutput["rft.volume"] = data.Volume;
    	OCinSoutput["rft.issue"] = data.Issue;
    	OCinSoutput["rft.pages"] = data.Pages;
    	OCinSoutput["rft.edition"] = data.Edition;
    	OCinSoutput["rft.pub"] = data.PublisherName;
    	
    	for k, v in pairs( data.ID_list ) do
    		local id, value = cfg.id_handlers[k].COinS;
    		if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
    		if string.sub( id or "", 1, 4 ) == 'info' then
    			OCinSoutput["rft_id"] = table.concat{ id, "/", v };
    		else
    			OCinSoutput[ id ] = value;
    		end
    	end
    	
    	local last, first;
    	for k, v in ipairs( data.Authors ) do
    		last, first = v.last, v.first;
    		if k == 1 then
    			if is_set(last) then
    				OCinSoutput["rft.aulast"] = last;
    			end
    			if is_set(first) then 
    				OCinSoutput["rft.aufirst"] = first;
    			end
    		end
    		if is_set(last) and is_set(first) then
    			OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
    		elseif is_set(last) then
    			OCinSoutput["rft.au"] = last;
    		end
    	end
    	
    	OCinSoutput.rft_id = data.URL;
    	OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
    	OCinSoutput = setmetatable( OCinSoutput, nil );
    	
    	-- sort with version string always first, and combine.
    	table.sort( OCinSoutput );
    	table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
    	return table.concat(OCinSoutput, "&");
    end
    
    --[[
    This is the main function doing the majority of the citation
    formatting.
    ]]
    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 
    	local PPrefix = A['PPrefix']
    	local PPPrefix = A['PPPrefix']
    	if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
    	
    	-- Pick out the relevant fields from the arguments.  Different citation templates
    	-- define different field names for the same underlying things.	
    	local Authors = A['Authors'];
    	local a = extractnames( args, 'AuthorList' );
    
    	local Coauthors = A['Coauthors'];
    	local Others = A['Others'];
    	local Editors = A['Editors'];
    	local e = extractnames( args, 'EditorList' );
    
    	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 BookTitle = A['BookTitle'];
    	local Conference = A['Conference'];
    	local TransTitle = A['TransTitle'];
    	local TitleNote = A['TitleNote'];
    	local TitleLink = A['TitleLink'];
    	local Chapter = A['Chapter'];
    	local ChapterLink = A['ChapterLink'];
    	local TransChapter = A['TransChapter'];
    	local TitleType = A['TitleType'];
    	local Degree = A['Degree'];
    	local Docket = A['Docket'];
    	local ArchiveURL = A['ArchiveURL'];
    	local URL = A['URL']
    	local URLorigin = A:ORIGIN('URL');
    	local ChapterURL = A['ChapterURL'];
    	local ChapterURLorigin = A:ORIGIN('ChapterURL');
    	local ConferenceURL = A['ConferenceURL'];
    	local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
    	local Periodical = A['Periodical'];
    
    	local Series = A['Series'];
    	local Volume = A['Volume'];
    	local Issue = A['Issue'];
    	local Position = '';
    	local Page = A['Page'];
    	local Pages = hyphentodash( A['Pages'] );	
    	local At = A['At'];
    
    	local Edition = A['Edition'];
    	local PublicationPlace = A['PublicationPlace']
    	local Place = A['Place'];
    	
    	local PublisherName = A['PublisherName'];
    	local RegistrationRequired = A['RegistrationRequired'];
    	local SubscriptionRequired = A['SubscriptionRequired'];
    	local Via = A['Via'];
    	local AccessDate = A['AccessDate'];
    	local ArchiveDate = A['ArchiveDate'];
    	local Agency = A['Agency'];
    	local DeadURL = A['DeadURL']
    	local Language = A['Language'];
    	local Format = A['Format'];
    	local Ref = A['Ref'];
    	local DoiBroken = A['DoiBroken'];
    	local ID = A['ID'];
    	local ASINTLD = A['ASINTLD'];
    	local IgnoreISBN = A['IgnoreISBN'];
    	local Embargo = A['Embargo'];
    
    	local ID_list = extractids( args );
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
    	-- special case for cite newsgroup which uses |id= for a usenet article or post id
    	-- |id= is not included in COinS so here we convert it to an ID that will be included in COinS
    	if ('newsgroup' == config.CitationClass) and (is_set (ID)) then
    		ID_list['USENETID']=ID;			-- add this new 'id' to the list of IDs
    		ID = '';						-- and unset
    	end
    ]]	
    	local Quote = A['Quote'];
    	local PostScript = A['PostScript'];
    
    	local LayURL = A['LayURL'];
    	local LaySource = A['LaySource'];
    	local Transcript = A['Transcript'];
    	local TranscriptURL = A['TranscriptURL'] 
    	local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
    	local sepc = A['Separator'];
    
    	local LastAuthorAmp = A['LastAuthorAmp'];
    	local no_tracking_cats = A['NoTracking'];
    
    --these are used by cite interview
    	local Callsign = A['Callsign'];
    	local City = A['City'];
    	local Cointerviewers = A['Cointerviewers'];			-- deprecated
    	local Interviewer = A['Interviewer'];				-- deprecated
    	local Program = A['Program'];
    
    --local variables that are not cs1 parameters
    	local page_type;									-- is this needed?  Doesn't appear to be used anywhere;
    	local use_lowercase = ( sepc ~= '.' );
    	local this_page = mw.title.getCurrentTitle();		--Also used for COinS and for language
    	local anchor_year;									-- used in the CITEREF identifier
    	local COinS_date;									-- used in the COinS metadata
    
    -- Set postscript default.
    	if not is_set (PostScript) then						-- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
    		if (config.CitationClass ~= "citation") then	-- this template is not a citation template
    			PostScript = '.';							-- must be a cite xxx template so set postscript to default (period)
    		end
    	else
    		if PostScript:lower() == 'none' then			-- if |postscript=none then
    			PostScript = '';							-- no postscript
    		end
    	end
    
    --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories.
    	if not is_set(no_tracking_cats) then				-- ignore if we are already not going to categorize this page
    		for k, v in pairs( cfg.uncategorized_namespaces ) do	-- otherwise, spin through the list of namespaces we don't include in error categories
    			if this_page.nsText == v then				-- if we find one
    				no_tracking_cats = "true";				-- set no_tracking_cats
    				break;									-- and we're done
    			end
    		end
    	end
    
    -- check for extra |page=, |pages= or |at= parameters. 
    	if is_set(Page) then
    		if is_set(Pages) or is_set(At) then
    			Page = Page .. " " .. seterror('extra_pages');	-- add error message
    			Pages = '';										-- unset the others
    			At = '';
    		end
    	elseif is_set(Pages) then
    		if is_set(At) then
    			Pages = Pages .. " " .. seterror('extra_pages');	-- add error messages
    			At = '';											-- unset
    		end
    	end	
    
    -- both |publication-place= and |place= (|location=) allowed if different
    	if not is_set(PublicationPlace) and is_set(Place) then
    		PublicationPlace = Place;							-- promote |place= (|location=) to |publication-place
    	end
    	
    	if PublicationPlace == Place then Place = ''; end		-- don't need both if they are the same
    	
    --[[
    Parameter remapping for cite encyclopedia:
    When the citation has these parameters:
    	|encyclopedia and |title then map |title to |article and |encyclopedia to |title
    	|encyclopedia and |article then map |encyclopedia to |title
    	|encyclopedia then map |encyclopedia to |title
    
    	|trans_title maps to |trans_chapter when |title is re-mapped
    
    All other combinations of |encyclopedia, |title, and |article are not modified
    ]]
    	if ( config.CitationClass == "encyclopaedia" ) then
    		if is_set(Periodical) then					-- Periodical is set when |encyclopedia is set
    			if is_set(Title) then
    				if not is_set(Chapter) then
    					Chapter = Title;				-- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
    					TransChapter = TransTitle;
    					Title = Periodical;
    					Periodical = '';				-- redundant so unset
    					TransTitle = '';				-- redundant so unset
    				end
    			else									-- |title not set
    				Title = Periodical;					-- |encyclopedia set and |article set or not set so map |encyclopedia to |title
    				Periodical = '';					-- redundant so unset
    			end
    		end
    	end
    
    --special cases for citation.
    	if (config.CitationClass == "citation") then		-- for citation templates
    		if not is_set (Ref) then						-- if |ref= is not set
    			Ref = "harv";								-- set default |ref=harv
    		end
    		if not is_set (sepc) then						-- if |separator= is not set
    			sepc = ',';									-- set citation separator to its default (comma)
    		end
    	else												-- not a citation template
    		if not is_set (sepc) then						-- if |separator= has not been set
    			sepc = '.';									-- set cite xxx separator to its default (period)
    		end
    	end
    
    -- check for special case where |separator=none
    	if 'none' == sepc:lower() then						-- if |separator=none
    		sepc = '';										-- then set it to an empty string
    	end
    
    -- Special case for cite techreport.
    	if (config.CitationClass == "techreport") then	-- special case for cite techreport
    		if is_set(Issue) then						-- cite techreport uses 'number', which other citations aliase to 'issue'
    			if not is_set(ID) then					-- can we use ID for the "number"?
    				ID = Issue;							-- yes, use it
    				Issue = "";							-- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
    			else									-- can't use ID so emit error message
    				ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
    			end
    		end	
    	end
    
    -- special case for cite interview
    	if (config.CitationClass == "interview") then
    		if is_set(Program) then
    			ID = ' ' .. Program;
    		end
    		if is_set(Callsign) then
    			if is_set(ID) then
    				ID = ID .. sepc .. ' ' .. Callsign;
    			else
    				ID = ' ' .. Callsign;
    			end
    		end
    		if is_set(City) then
    			if is_set(ID) then
    				ID = ID .. sepc .. ' ' .. City;
    			else
    				ID = ' ' .. City;
    			end
    		end
    
    		if is_set(Interviewer) then
    			if is_set(TitleType) then
    				Others = ' ' .. TitleType .. ' with ' .. Interviewer;
    				TitleType = '';
    			else
    				Others = ' ' .. 'Interview with ' .. Interviewer;
    			end
    			if is_set(Cointerviewers) then
    				Others = Others .. sepc .. ' ' .. Cointerviewers;
    			end
    		else
    			Others = '(Interview)';
    		end
    	end
    
    --Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
    	if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
    		if not is_embargoed(Embargo) then
    			URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC'];	-- set url to be the same as the PMC external link if not embargoed
    			URLorigin = cfg.id_handlers['PMC'].parameters[1];		-- set URLorigin to parameter name for use in error message if citation is missing a |title=
    		end
    	end
    
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
    --TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
    	if is_set(BookTitle) then
    		Chapter = Title;
    		ChapterLink = TitleLink;
    		TransChapter = TransTitle;
    		Title = BookTitle;
    		TitleLink = '';
    		TransTitle = '';
    	end
    
    -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
    --[[	-- {{cite episode}} is not currently supported by this module
    	if config.CitationClass == "episode" then
    		local AirDate = A['AirDate'];
    		local SeriesLink = A['SeriesLink'];
    		local Season = A['Season'];
    		local SeriesNumber = A['SeriesNumber'];
    		local Network = A['Network'];
    		local Station = A['Station'];
    		local s, n = {}, {};
    		local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
    		
    		if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
    		if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
    		if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
    		if is_set(Network) then table.insert(n, Network); end
    		if is_set(Station) then table.insert(n, Station); end
    		
    		Date = Date or AirDate;
    		Chapter = Title;
    		ChapterLink = TitleLink;
    		TransChapter = TransTitle;
    		Title = Series;
    		TitleLink = SeriesLink;
    		TransTitle = '';
    		
    		Series = table.concat(s, Sep);
    		ID = table.concat(n, Sep);
    	end
    -- end of {{cite episode}} stuff]]
    
    -- legacy: promote concatenation of |day=, |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
    	if not is_set(Date) then
    		Date = Year;						-- promote Year to Date
    		Year = nil;							-- make nil so Year as empty string isn't used for CITEREF
    		if is_set(Date) then
    			local Month = A['Month'];
    			if is_set(Month) then
    				Date = Month .. " " .. Date;
    				local Day = A['Day']
    				if is_set(Day) then Date = Day .. " " .. Date end
    			end
    		elseif is_set(PublicationDate) then	-- use PublicationDate when |date= and |year= are not set
    			Date = PublicationDate;			-- promote PublicationDate to Date
    			PublicationDate = '';			-- unset, no longer needed
    		end
    	end
    
    	if PublicationDate == Date then PublicationDate = ''; end	-- if PublicationDate is same as Date, don't display in rendered citation
    
    
    --[[
    Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
    we get the date used in the metadata.
    
    Date validation supporting code is in Module:Citation/CS1/Date_validation
    ]]
    	anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
    		['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
    	if is_set(error_message) then
    		table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } );	-- add this error message
    	end
    
    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
    
    	-- COinS metadata (see <http://ocoins.info/>) for
    	-- automated parsing of citation information.
    	local OCinSoutput = COinS{
    		['Periodical'] = Periodical,
    		['Chapter'] = Chapter,
    		['Title'] = Title,
    		['PublicationPlace'] = PublicationPlace,
    		['Date'] = first_set(COinS_date, Date),		-- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
    		['Series'] = Series,
    		['Volume'] = Volume,
    		['Issue'] = Issue,
    --		['Pages'] = get_coins_pages (first_set(Page, Pages, At)),	-- pages stripped of external links
    		['Pages'] = first_set(Page, Pages, At),
    		['Edition'] = Edition,
    		['PublisherName'] = PublisherName,
    		['URL'] = first_set( URL, ChapterURL ),
    		['Authors'] = a,
    		['ID_list'] = ID_list,
    		['RawPage'] = this_page.prefixedText,
    	};
    
    	if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
    		Chapter = Title;
    		ChapterLink = TitleLink;
    		TransChapter = TransTitle;
    		Title = '';
    		TitleLink = '';
    		TransTitle = '';
    	end
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
    -- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername and ID
    	if 'newsgroup' == config.CitationClass then
    		if is_set (PublisherName) then
    			PublisherName = '[Newsgroup]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
    		end
    	end
    ]]
    
    
    	-- Now perform various field substitutions.
    	-- We also add leading spaces and surrounding markup and punctuation to the
    	-- various parts of the citation, but only when they are non-nil.
    	if not is_set(Authors) then
    		local Maximum = tonumber( A['DisplayAuthors'] );
    		
    		-- Preserve old-style implicit et al.
    		if not is_set(Maximum) and #a == 9 then 
    			Maximum = 8;
    			table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
    		elseif not is_set(Maximum) then
    			Maximum = #a + 1;
    		end
    			
    		local control = { 
    			sep = A["AuthorSeparator"] .. " ",
    			namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
    			format = A["AuthorFormat"],
    			maximum = Maximum,
    			lastauthoramp = LastAuthorAmp
    		};
    		
    		-- If the coauthor field is also used, prevent ampersand and et al. formatting.
    		if is_set(Coauthors) then
    			control.lastauthoramp = nil;
    			control.maximum = #a + 1;
    		end
    		
    		Authors = listpeople(control, a) 
    	end
    
    	if not is_set(Authors) and is_set(Coauthors) then	-- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
    		table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } );	-- emit error message
    	end
    
    	local EditorCount
    	if not is_set(Editors) then
    		local Maximum = tonumber( A['DisplayEditors'] );
    		-- Preserve old-style implicit et al.
    		if not is_set(Maximum) and #e == 4 then 
    			Maximum = 3;
    			table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
    		elseif not is_set(Maximum) then
    			Maximum = #e + 1;
    		end
    
    		local control = { 
    			sep = A["EditorSeparator"] .. " ",
    			namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
    			format = A['EditorFormat'],
    			maximum = Maximum,
    			lastauthoramp = LastAuthorAmp
    		};
    
    		Editors, EditorCount = listpeople(control, e);
    	else
    		EditorCount = 1;
    	end
    
    	local Cartography = "";
    	local Scale = "";
    	if config.CitationClass == "map" then
    		if not is_set( Authors ) and is_set( PublisherName ) then
    			Authors = PublisherName;
    			PublisherName = "";
    		end
    		Cartography = A['Cartography'];
    		if is_set( Cartography ) then
    			Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
    		end		
    		Scale = A['Scale'];
    		if is_set( Scale ) then
    			Scale = sepc .. " " .. Scale;
    		end		
    	end
    	
    	if  not is_set(URL) and
    		not is_set(ChapterURL) and
    		not is_set(ArchiveURL) and
    		not is_set(ConferenceURL) and
    		not is_set(TranscriptURL) then
    		
    		-- Test if cite web or cite podcast |url= is missing or empty 
    		if inArray(config.CitationClass, {"web","podcast"}) then	
    			table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
    		end
    		
    		-- Test if accessdate is given without giving a URL
    		if is_set(AccessDate) then
    			table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
    			AccessDate = '';
    		end
    		
    		-- Test if format is given without giving a URL
    		if is_set(Format) then
    			Format = Format .. seterror( 'format_missing_url' );
    		end
    	end
    	
    	-- Test if citation has no title
    	if  not is_set(Chapter) and
    		not is_set(Title) and
    		not is_set(Periodical) and
    		not is_set(Conference) and
    		not is_set(TransTitle) and
    		not is_set(TransChapter) then
    		table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    	end
    	
    	Format = is_set(Format) and " (" .. Format .. ")" or "";
    	
    	local OriginalURL = URL
    	DeadURL = DeadURL:lower();
    	if is_set( ArchiveURL ) then
    		if ( DeadURL ~= "no" ) then
    			URL = ArchiveURL
    			URLorigin = A:ORIGIN('ArchiveURL')
    		end
    	end
    	
    	-- Format chapter / article title
    	if is_set(Chapter) and is_set(ChapterLink) then 
    		Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
    	end
    	if is_set(Periodical) and is_set(Title) then
    		Chapter = wrap( 'italic-title', Chapter );
    		TransChapter = wrap( 'trans-italic-title', TransChapter );
    	else
    		Chapter = kern_quotes (Chapter);				-- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
    		Chapter = wrap( 'quoted-title', Chapter );
    		TransChapter = wrap( 'trans-quoted-title', TransChapter );
    	end
    	
    	local TransError = ""
    	if is_set(TransChapter) then
    		if not is_set(Chapter) then
    			TransError = " " .. seterror( 'trans_missing_chapter' );
    		else
    			TransChapter = " " .. TransChapter;
    		end
    	end
    	
    	Chapter = Chapter .. TransChapter;
    	
    	if is_set(Chapter) then
    		if not is_set(ChapterLink) then
    			if is_set(ChapterURL) then
    				Chapter = externallink( ChapterURL, Chapter ) .. TransError;
    				if not is_set(URL) then
    					Chapter = Chapter .. Format;
    					Format = "";
    				end
    			elseif is_set(URL) then 
    				Chapter = externallink( URL, Chapter ) .. TransError .. Format;
    				URL = "";
    				Format = "";
    			else
    				Chapter = Chapter .. TransError;
    			end			
    		elseif is_set(ChapterURL) then
    			Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. 
    				TransError;
    		else
    			Chapter = Chapter .. TransError;
    		end
    		Chapter = Chapter .. sepc .. " " -- with end-space
    	elseif is_set(ChapterURL) then
    		Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
    	end		
    	
    	-- Format main title.
    	if is_set(TitleLink) and is_set(Title) then
    		Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
    	end
    	
    	if is_set(Periodical) then
    		Title = kern_quotes (Title);				-- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
    		Title = wrap( 'quoted-title', Title );
    		TransTitle = wrap( 'trans-quoted-title', TransTitle );
    --[[ Hide unfinished cite newsgroup code so that long delayed update can take place
    	elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast","newsgroup"}) and
    ]]	elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
    			not is_set(Chapter) then
    		Title = kern_quotes (Title);				-- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
    		Title = wrap( 'quoted-title', Title );
    		TransTitle = wrap( 'trans-quoted-title', TransTitle );
    	else
    		Title = wrap( 'italic-title', Title );
    		TransTitle = wrap( 'trans-italic-title', TransTitle );
    	end
    	
    	TransError = "";
    	if is_set(TransTitle) then
    		if not is_set(Title) then
    			TransError = " " .. seterror( 'trans_missing_title' );
    		else
    			TransTitle = " " .. TransTitle;
    		end
    	end
    	
    	Title = Title .. TransTitle;
    	
    	if is_set(Title) then
    		if not is_set(TitleLink) and is_set(URL) then 
    			Title = externallink( URL, Title ) .. TransError .. Format	   
    			URL = "";
    			Format = "";
    		else
    			Title = Title .. TransError;
    		end
    	end
    	
    	if is_set(Place) then
    		Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
    	end
    	
    	if is_set(Conference) then
    		if is_set(ConferenceURL) then
    			Conference = externallink( ConferenceURL, Conference );
    		end
    		Conference = sepc .. " " .. Conference
    	elseif is_set(ConferenceURL) then
    		Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
    	end
    	
    	if not is_set(Position) then
    		local Minutes = A['Minutes'];
    		if is_set(Minutes) then
    			Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
    		else
    			local Time = A['Time'];
    			if is_set(Time) then
    				local TimeCaption = A['TimeCaption']
    				if not is_set(TimeCaption) then
    					TimeCaption = cfg.messages['event'];
    					if sepc ~= '.' then
    						TimeCaption = TimeCaption:lower();
    					end
    				end
    				Position = " " .. TimeCaption .. " " .. Time;
    			end
    		end
    	else
    		Position = " " .. Position;
    		At = '';
    	end
    	
    	if not is_set(Page) then
    		if is_set(Pages) then
    			if is_set(Periodical) and
    				not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
    				Pages = ": " .. Pages;
    			elseif tonumber(Pages) ~= nil then
    				Pages = sepc .." " .. PPrefix .. Pages;
    			else
    				Pages = sepc .." " .. PPPrefix .. Pages;
    			end
    		end
    	else
    		if is_set(Periodical) and
    			not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
    			Page = ": " .. Page;
    		else
    			Page = sepc .." " .. PPrefix .. Page;
    		end
    	end
    	
    	At = is_set(At) and (sepc .. " " .. At) or "";
    	Position = is_set(Position) and (sepc .. " " .. Position) or "";
    	if config.CitationClass == 'map' then
    		local Section = A['Section'];
    		local Inset = A['Inset'];
    		if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
    			if is_set( Section ) then
    				Section = ", " .. wrap( 'section', Section, true );
    			end
    			if is_set( Inset ) then
    				Inset = ", " .. wrap( 'inset', Inset, true );
    			end
    		else
    			if is_set( Section ) then
    				Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
    				if is_set( Inset ) then
    					Inset = ", " .. wrap( 'inset', Inset, true );
    				end
    			elseif is_set( Inset ) then
    				Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
    			end			
    		end			
    		At = At .. Section .. Inset;		
    	end	
    
    	--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found, 
    	use that value; if not, then use the value that was provided with the language parameter.
    	
    	Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English).
    	]]
    	if is_set (Language) then
    --		local name = mw.language.fetchLanguageName( Language:lower(), "en" );	-- experiment: this seems to return correct ISO 639-1 language names
    		local name = cfg.iso639_1[Language:lower()];		-- get the language name if Language parameter has a valid iso 639-1 code
    		if nil == name then
    			Language=" " .. wrap( 'language', Language );	-- no match, use parameter's value
    		else
    			if 0 == this_page.namespace and 'en' ~= Language:lower() then	--found a match; is this page main / article space and English not the language?
    				Language=" " .. wrap( 'language', name .. '[[Category:Articles with ' .. name .. '-language external links]]' );	-- in main space and not English: categorize
    			else
    				Language=" " .. wrap( 'language', name );	--not in mainspace or language is English so don't categorize
    			end
    		end
    	else
    		Language="";	-- language not specified so make sure this is an empty string;
    	end
    
    	Others = is_set(Others) and (sepc .. " " .. Others) or "";
    
    -- handle type parameter for those CS1 citations that have default values
    
    	if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "podcast", "pressrelease", "techreport", "thesis"}) then
    		TitleType = set_titletype (config.CitationClass, TitleType);
    		if is_set(Degree) and "Thesis" == TitleType then	-- special case for cite thesis
    			TitleType = Degree .. " thesis";
    		end
    	end
    
    	if is_set(TitleType) then					-- if type parameter is specified
    		TitleType = " (" .. TitleType .. ")";	-- display it in parentheses
    	end
    
    	TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
    	Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
    	Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
    	Series = is_set(Series) and (sepc .. " " .. Series) or "";
    	OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
    	Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
    
    	if is_set(Volume) then
    		if ( mw.ustring.len(Volume) > 4 )
    		  then Volume = sepc .." " .. Volume;
    		  else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
    		end
    	end
    
    --[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
    	if is_set(Volume) then
    		if ( mw.ustring.len(Volume) > 4 )
    		  then Volume = sepc .. " " .. Volume;
    		  else
    			  Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
    			  if is_set(Series) then Volume = sepc .. Volume;
    			  end
    		end
    	end
    ]]	
    	------------------------------------ totally unrelated data
    	--[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
    	behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
    	
    	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(Via) then
    		Via = " " .. wrap( 'via', Via );
    	end
    
    	if is_set(SubscriptionRequired) then
    		SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
    	elseif is_set(RegistrationRequired) then
    		SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
    	end
    
    	if is_set(AccessDate) then
    		local retrv_text = " " .. cfg.messages['retrieved']
    		if (sepc ~= ".") then retrv_text = retrv_text:lower() end
    		AccessDate = '<span class="reference-accessdate">' .. sepc
    			.. substitute( retrv_text, {AccessDate} ) .. '</span>'
    	end
    	
    	if is_set(ID) then ID = sepc .." ".. ID; end
       	if "thesis" == config.CitationClass and is_set(Docket) then
    		ID = sepc .." Docket ".. Docket .. ID;
    	end
    
    	
    	ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );
    
    	if is_set(URL) then
    		URL = " " .. externallink( URL, nil, URLorigin );
    	end
    
    	if is_set(Quote) then
    		if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
    			Quote = Quote:sub(2,-2);
    		end
    		Quote = sepc .." " .. wrap( 'quoted-text', Quote ); 
    		PostScript = "";							-- CS1 does not supply terminal punctuation when |quote= is set
    	end
    	
    	local Archived
    	if is_set(ArchiveURL) then
    		if not is_set(ArchiveDate) then
    			ArchiveDate = seterror('archive_missing_date');
    		end
    		if "no" == DeadURL then
    			local arch_text = cfg.messages['archived'];
    			if sepc ~= "." then arch_text = arch_text:lower() end
    			Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
    				{ externallink( ArchiveURL, arch_text ), ArchiveDate } );
    			if not is_set(OriginalURL) then
    				Archived = Archived .. " " .. seterror('archive_missing_url');							   
    			end
    		elseif is_set(OriginalURL) then
    			local arch_text = cfg.messages['archived-dead'];
    			if sepc ~= "." then arch_text = arch_text:lower() end
    			Archived = sepc .. " " .. substitute( arch_text,
    				{ externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
    		else
    			local arch_text = cfg.messages['archived-missing'];
    			if sepc ~= "." then arch_text = arch_text:lower() end
    			Archived = sepc .. " " .. substitute( arch_text, 
    				{ seterror('archive_missing_url'), ArchiveDate } );
    		end
    	else
    		Archived = ""
    	end
    	
    	local Lay
    	if is_set(LayURL) then
    		if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
    		if is_set(LaySource) then 
    			LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
    		else
    			LaySource = "";
    		end
    		if sepc == '.' then
    			Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
    		else
    			Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
    		end			
    	else
    		Lay = "";
    	end
    	
    	if is_set(Transcript) then
    		if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
    	elseif is_set(TranscriptURL) then
    		Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
    	end
    	
    	local Publisher;
    	if is_set(Periodical) and
    		not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
    		if is_set(PublisherName) then
    			if is_set(PublicationPlace) then
    				Publisher = PublicationPlace .. ": " .. PublisherName;
    			else
    				Publisher = PublisherName;  
    			end
    		elseif is_set(PublicationPlace) then
    			Publisher= PublicationPlace;
    		else 
    			Publisher = "";
    		end
    		if is_set(PublicationDate) then
    			if is_set(Publisher) then
    				Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
    			else
    				Publisher = PublicationDate;
    			end
    		end
    		if is_set(Publisher) then
    			Publisher = " (" .. Publisher .. ")";
    		end
    	else
    		if is_set(PublicationDate) then
    			PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
    		end
    		if is_set(PublisherName) then
    			if is_set(PublicationPlace) then
    				Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
    			else
    				Publisher = sepc .. " " .. PublisherName .. PublicationDate;  
    			end			
    		elseif is_set(PublicationPlace) then 
    			Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
    		else 
    			Publisher = PublicationDate;
    		end
    	end
    	
    	-- Several of the above rely upon detecting this as nil, so do it last.
    	if is_set(Periodical) then
    		if is_set(Title) or is_set(TitleNote) then 
    			Periodical = sepc .. " " .. wrap( 'italic-title', Periodical ) 
    		else 
    			Periodical = wrap( 'italic-title', Periodical )
    		end
    	end
    
    --[[
    Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
    the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
    ]]
    	if "speech" == config.CitationClass then				-- cite speech only
    		TitleNote = " (Speech)";							-- annotate the citation
    		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
    				Conference = Conference .. sepc .. " ";		-- then add appropriate punctuation to the end of the Conference variable before rendering
    			end
    		end
    	end
    
    	-- Piece all bits together at last.  Here, all should be non-nil.
    	-- We build things this way because it is more efficient in LUA
    	-- not to keep reassigning to the same string variable over and over.
    
    	local tcommon
    	if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
    		if is_set(Others) then Others = Others .. sepc .. " " end
    		tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, 
    			Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
    	else 
    		tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language, 
    			Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
    	end
    	
    	if #ID_list > 0 then
    		ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
    	else
    		ID_list = ID;
    	end
    	
    	local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
    	local text;
    	local pgtext = Position .. Page .. Pages .. At;
    	
    	if is_set(Authors) then
    		if is_set(Coauthors) then
    			Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
    		end
    		if is_set(Date) then
    			Date = " ("..Date..")" .. OrigYear .. sepc .. " "
    		elseif string.sub(Authors,-1,-1) == sepc then
    			Authors = Authors .. " "
    		else
    			Authors = Authors .. sepc .. " "
    		end
    		if is_set(Editors) then
    			local in_text = " ";
    			local post_text = "";
    			if is_set(Chapter) then
    				in_text = in_text .. cfg.messages['in'] .. " "
    			else
    				if EditorCount <= 1 then
    					post_text = ", " .. cfg.messages['editor'];
    				else
    					post_text = ", " .. cfg.messages['editors'];
    				end
    			end 
    			if (sepc ~= '.') then in_text = in_text:lower() end
    			Editors = in_text .. Editors .. post_text;
    			if (string.sub(Editors,-1,-1) == sepc)
    				then Editors = Editors .. " "
    				else Editors = Editors .. sepc .. " "
    			end
    		end
    		text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
    		text = safejoin( {text, pgtext, idcommon}, sepc );
    	elseif is_set(Editors) then
    		if is_set(Date) then
    			if EditorCount <= 1 then
    				Editors = Editors .. ", " .. cfg.messages['editor'];
    			else
    				Editors = Editors .. ", " .. cfg.messages['editors'];
    			end
    			Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
    		else
    			if EditorCount <= 1 then
    				Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
    			else
    				Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
    			end
    		end
    		text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
    		text = safejoin( {text, pgtext, idcommon}, sepc );
    	else
    		if is_set(Date) then
    			if ( string.sub(tcommon,-1,-1) ~= sepc )
    			  then Date = sepc .." " .. Date .. OrigYear
    			  else Date = " " .. Date .. OrigYear
    			end
    		end
    		if config.CitationClass=="journal" and is_set(Periodical) then
    			text = safejoin( {Chapter, Place, tcommon}, sepc );
    			text = safejoin( {text, pgtext, Date, idcommon}, sepc );
    		else
    			text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
    			text = safejoin( {text, pgtext, idcommon}, sepc );
    		end
    	end
    	
    	if is_set(PostScript) and PostScript ~= sepc then
    		text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
    		text = text:sub(1,-sepc:len()-1);
    --		text = text:sub(1,-2);	--Remove final separator (assumes that sepc is only one character)
    	end	
    	
    	text = safejoin( {text, PostScript}, sepc );
    
    	-- Now enclose the whole thing in a <span/> element
    	local options = {};
    	
    	if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
    		options.class = "citation " .. config.CitationClass;
    	else
    		options.class = "citation";
    	end
    	
    	if is_set(Ref) and Ref:lower() ~= "none" then
    		local id = Ref
    		if ( "harv" == Ref ) then
    			local names = {} --table of last names & year
    			if #a > 0 then
    				for i,v in ipairs(a) do 
    					names[i] = v.last 
    					if i == 4 then break end
    				end
    			elseif #e > 0 then
    				for i,v in ipairs(e) do 
    					names[i] = v.last 
    					if i == 4 then break end				
    				end
    			end
    			names[ #names + 1 ] = first_set(Year, anchor_year);	-- Year first for legacy citations
    			id = anchorid(names)
    		end
    		options.id = id;
    	end
    	
    	if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
    		z.error_categories = {};
    		text = seterror('empty_citation');
    		z.message_tail = {};
    	end
    	
    	if is_set(options.id) then 
    		text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    	else
    		text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    	end		
    
    	local empty_span = '<span style="display:none;">&nbsp;</span>';
    	
    	-- Note: Using display: none on then COinS span breaks some clients.
    	local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
    	text = text .. OCinS;
    	
    	if #z.message_tail ~= 0 then
    		text = text .. " ";
    		for i,v in ipairs( z.message_tail ) do
    			if is_set(v[1]) then
    				if i == #z.message_tail then
    					text = text .. errorcomment( v[1], v[2] );
    				else
    					text = text .. errorcomment( v[1] .. "; ", v[2] );
    				end
    			end
    		end
    	end
    	
    	no_tracking_cats = no_tracking_cats:lower();
    	if inArray(no_tracking_cats, {"", "no", "false", "n"}) then
    		for _, v in ipairs( z.error_categories ) do
    			text = text .. '[[Category:' .. v ..']]';
    		end
    	end
    	
    	return text
    end
    
    -- This is used by templates such as {{cite book}} to create the actual citation text.
    function z.citation(frame)
    	local pframe = frame:getParent()
    	
    	if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then				-- did the {{#invoke:}} use sandbox version?
    		cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' );	-- load sandbox versions of Configuration and Whitelist and ...
    		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
    		dates = require('Module:Citation/CS1/Date_validation/sandbox').dates	-- ... sandbox version of date validation code
    	else																	-- otherwise
    		cfg = mw.loadData( 'Module:Citation/CS1/Configuration' );			-- load live versions of Configuration and Whitelist and ...
    		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
    		dates = require('Module:Citation/CS1/Date_validation').dates		-- ... live version of date validation code
    	end
    	
    	local args = {};
    	local suggestions = {};
    	local error_text, error_state;
    
    	local config = {};
    	for k, v in pairs( frame.args ) do
    		config[k] = v;
    		args[k] = v;	   
    	end	
    
    	for k, v in pairs( pframe.args ) do
    		if v ~= '' then
    			if not validate( k ) then			
    				error_text = "";
    				if type( k ) ~= 'string' then
    					-- Exclude empty numbered parameters
    					if v:match("%S+") ~= nil then
    						error_text, error_state = seterror( 'text_ignored', {v}, true );
    					end
    				elseif validate( k:lower() ) then 
    					error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
    				else
    					if #suggestions == 0 then
    						suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
    					end
    					if suggestions[ k:lower() ] ~= nil then
    						error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
    					else
    						error_text, error_state = seterror( 'parameter_ignored', {k}, true );
    					end
    				end				  
    				if error_text ~= '' then
    					table.insert( z.message_tail, {error_text, error_state} );
    				end				
    			end
    			args[k] = v;
    		elseif args[k] ~= nil or (k == 'postscript') then
    			args[k] = v;
    		end		
    	end	
    	
    	return citation0( config, args)
    end
    
    return z