模块:Citation/CS1:修订间差异

imported>Liangent
无编辑摘要
imported>Antigng
修复显而易见的bug(无需共识)
 
(未显示21个用户的163个中间版本)
第1行: 第1行:
local z = {
--[[--------------------------< I M P O R T E D _  F U N C T I O N S _ A N D _ V A R I B L E S >-----------------
    error_categories = {};
]]
    error_ids = {};
    message_tail = {};
}


local SEEN = {};
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
local DATA = {};
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist


-- LOCAL
local dates, year_date_check; -- functions in Module:Citation/CS1/Date_validation
local wikitextLC = require( 'Module:WikitextLC' );
local add_maint_cat, append_error, make_error_tail, reset_error, set_error, select_one, throw_error;     
-- END LOCAL
-- error-related functions in Module:Citation/CS1/Error
local first_set, hyphen_to_dash, is_set, in_array, substitute; -- simple functions in Module:Citation/CS1/Utilities
local has_invisible_chars, kern_quotes, pend_separator, safe_join, wrap_style, wrap_msg;
-- style-related functions in Module:Citation/CS1/Utilities
local check_for_external_link, make_external_link, make_internal_link; -- link-related functions in Module:Citation/CS1/Links
local extract_ids, build_id_list, is_embargoed, extract_id_access_levels; -- functions in Module:Citation/CS1/Identifiers
local get_people, format_people; -- functions in Module:Citation/CS1/People
local COinS; -- functions in Module:Citation/CS1/COinS
local script_concatenate, language_parameter; -- functions in Module:Citation/CS1/Language


-- Include translation message hooks, ID and error handling configuration settings.
local function load_modules (module_path, module_suffix)
local cfg = require( 'Module:Citation/CS1/Configuration' );
cfg = mw.loadData (module_path .. 'Configuration' .. module_suffix);
whitelist = mw.loadData (module_path .. 'Whitelist' .. module_suffix);
-- Contains a list of all recognized parameters
local validation = require (module_path .. 'Date_validation' .. module_suffix);
local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
local identifiers = require (module_path .. 'Identifiers' .. module_suffix);
local utilities = require (module_path .. 'Utilities' .. module_suffix);
local people = require (module_path .. 'People' .. module_suffix);
local links = require (module_path .. 'Links' .. module_suffix);
local errors = require (module_path .. 'Error' .. module_suffix);
local coins = require (module_path .. 'COinS' .. module_suffix);
local languages = require (module_path .. 'Language' .. module_suffix);
 
utilities.set_selected_modules (cfg);
links.set_selected_modules (utilities, errors);
errors.set_selected_modules (cfg, utilities, links);
identifiers.set_selected_modules (cfg, utilities, errors, links, validation);
people.set_selected_modules (cfg, utilities, errors, links);
coins.set_selected_modules (cfg, utilities, links);
languages.set_selected_modules (utilities, errors);
 
dates = validation.dates; -- imported functions
year_date_check = validation.year_date_check;
first_set = utilities.first_set;
hyphen_to_dash = utilities.hyphen_to_dash;
is_set = utilities.is_set;
in_array = utilities.in_array;
substitute = utilities.substitute;
has_invisible_chars = utilities.has_invisible_chars;
kern_quotes = utilities.kern_quotes;
pend_separator = utilities.pend_separator;
safe_join = utilities.safe_join;
wrap_style = utilities.wrap_style;
wrap_msg = utilities.wrap_msg;
make_external_link = links.make_external_link;
make_internal_link = links.make_internal_link;
check_for_external_link = links.check_for_external_link;
add_maint_cat = errors.add_maint_cat;
append_error = errors.append_error;
make_error_tail = errors.make_error_tail;
reset_error = errors.reset_error;
set_error = errors.set_error;
select_one = errors.select_one;
throw_error = errors.throw_error;
extract_ids = identifiers.extract_ids;
build_id_list = identifiers.build_id_list;
is_embargoed = identifiers.is_embargoed;
extract_id_access_levels = identifiers.extract_id_access_levels;
get_people = people.get_people;
format_people = people.format_people;
COinS = coins.COinS;
script_concatenate = languages.script_concatenate;
language_parameter = languages.language_parameter;


-- Populates numbered arguments in a message string using
-- an argument table.
function substitute( message, arguments )
    if arguments == nil then
        return message;
    end
   
    message = message .. " ";
    for k, v in ipairs( arguments ) do
        v = v:gsub( "%%", "%%%%" );
        message = message:gsub( "$" .. k .. "(%D)", v .. "%1" );
    end   
    message = message:sub(1,-2);
    return message;
end
end


-- Wraps a string using a message_list configuration taking one argument
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
function wrap( message_key, str )
 
    if str == nil or str == "" then
Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
        return "";
offending parameter name to the error message. 
    end
 
    if message_key == 'italic-title' or
]]
            message_key == 'trans-italic-title' then
 
        str = safeforitalics( str );
local function deprecated_parameter (name)
    end
append_error ('deprecated_params', {name});
    return substitute( cfg.message_list[message_key], {str} );
end
end


--[[
--[[--------------------------< D I S C A R D _ P A R A M E T E R >--------------------------------------------
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 )
    DATA = args;
    local tbl = {};
   
    local mt = {
        __index = function ( tbl, k )           
            if SEEN[k] then
                return nil;
            end
           
            local list = cfg.argument_map[k];                   


            if list == nil then
local function discard_parameter (name, label, new_value)
                error( cfg.message_list['unknown_argument_map'] );
if is_set (name) then
            elseif type( list ) == 'string' then
append_error ('parameter_discarded', label);
                v = DATA[list];
end
            else                   
return new_value;
                v = selectone( DATA, cfg.argument_map[k],
                    'redundant_parameters' );
            end
            if v == nil then
                v = cfg.default_values[k];
            end
            SEEN[k] = true;
            tbl = rawset( tbl, k, v );
           
            return v;
        end,
    }
    return setmetatable( tbl, mt );
end
end


-- Checks that parameter name is valid using the whitelist
--[[--------------------------< S A N I T I Z E D _ P A R A M E T E R _ V A L U E >------------------------
function validate( name )
 
    name = tostring( name );
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
   
of allowable values (e.g. yes, y, true, no, etc). If the parameter value is empty or is in the list of allowed values,
    -- Normal arguments
the function returns the value; else, it emits an error message and returns the default value.
    if whitelist.basic_arguments[ name ] then
 
        return true;
]]
    end
 
   
local function sanitized_parameter_value (value, name, key, default)
    -- Arguments with numbers in them
if not is_set (value) then
    name = name:gsub( "%d+", "#" );
return value; -- an empty parameter is ok
    if whitelist.numbered_arguments[ name ] then
elseif in_array (value:lower(), cfg.keywords[key]) then
        return true;
return value;
    end
else
   
append_error ('invalid_param_val', {name, value}); -- not an allowed value so add error message
    -- Not found, argument not supported.
return default;
    return false
end
end
end


-- Formats a comment for error trapping
--[[--------------------------< E X T R A _ T E X T _ I N _ P A R A M E T E R _ C H E C K >------------------------------
function errorcomment( content, hidden )
 
    if hidden then  
]]
        return wrap( 'hidden-error', content );
 
    else
local function extra_text_in_parameter_check (value, type)
        return wrap( 'visible-error', content );
    end      
local good_patterns = cfg.extra_text_pattern[type]['good'];
local bad_patterns = cfg.extra_text_pattern[type]['bad'];
for _, pattern in pairs (good_patterns) do
if value:match (pattern) then
return;
end
end
for _, pattern in pairs (bad_patterns) do
if value:match (pattern) then
add_maint_cat ('extra_text', type);
return;
end
end
end
end


--[[
--[[--------------------------< V A L I D A T E _ D A T E >-------------------------------------------------------
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.
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
]]
]]
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
local function validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, origin)
        error( cfg.message_list['undefined_error'] );
local error_message = '';
    end
-- AirDate has been promoted to Date so not necessary to check it
   
anchor_year, error_message = dates ({['access-date']=AccessDate, ['archive-date']=ArchiveDate, ['date']=Date, ['doi-broken-date']=DoiBroken,
    if error_state.category ~= nil and error_state.category ~= "" then
['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year}, COinS_date);
        table.insert( z.error_categories, error_state.category );
    end
   
    local message = error_state.message;
    message = substitute( message, arguments );


    message = wikiescape(message) .. " ([[" .. cfg.message_list['help page link'] ..
if is_set (Year) then
        "#" .. error_state.anchor .. "|" ..
if is_set (Date) then -- both |date= and |year= not normally needed;
        cfg.message_list['help page label'] .. "]])";
local mismatch = year_date_check (Year, Date)
if 0 == mismatch then -- |year= does not match a year-value in |date=
append_error ('date_year_mismatch', {origin});
elseif 1 == mismatch then -- |year= matches year-value in |date=
add_maint_cat ('date_year');
end
end
anchor_year = Year; -- Year first for legacy citations and for YMD dates that require disambiguation
end


    z.error_ids[ error_id ] = true;
if is_set (error_message) then
    if (error_id == 'bare_url_missing_title' or error_id == 'trans_missing_title')
append_error ('bad_date', {error_message}); -- add this error message
            and z.error_ids['citation_missing_title'] then
end
        return '', false;
return anchor_year;
    end
   
    message = prefix .. message .. suffix;
   
    if raw == true then
        return message, error_state.hidden;
    end      
       
    return errorcomment( message, error_state.hidden );
end
end


-- This returns a string with HTML character entities for wikitext markup characters.
--[[--------------------------< D I S C A R D _ C H A P T E R >-------------------------------------------------------
function wikiescape(text)
仅为保持兼容性而设置。理论上可以直接调用discard_parameter()丢弃相关参数。
    text = text:gsub( '[&\'%[%]{|}]', {   
]]
            ['&'] = '&#38;',   
            ["'"] = '&#39;',   
local function discard_chapter (args)
            ['['] = '&#91;',   
local chap_param;
            [']'] = '&#93;',   
if is_set (args['Chapter']) then -- get a parameter name from one of these chapter related meta-parameters
            ['{'] = '&#123;',   
chap_param = args:ORIGIN ('Chapter');
            ['|'] = '&#124;',   
elseif is_set (args['TransChapter']) then
            ['}'] = '&#125;' } );
chap_param = args:ORIGIN ('TransChapter');
    return text;
elseif is_set (args['ChapterURL']) then
chap_param = args:ORIGIN ('ChapterURL');
elseif is_set (args['ScriptChapter']) then
chap_param = args:ORIGIN ('ScriptChapter')
elseif is_set (args['ChapterFormat']) then
chap_param = args:ORIGIN ('ChapterFormat')
elseif is_set (args['ChapterUrlAccess']) then
chap_param = args:ORIGIN ('ChapterUrlAccess')
end
if is_set (chap_param) then -- if we found one
append_error ('chapter_ignored', {chap_param}); -- add error message
end
end
end


-- Formats a wiki style external link
--[[--------------------------< C R E A T E _ U R L _ O B J E C T >------------------------------------------
function externallinkid(options)
 
    local sep = options.separator or "&nbsp;"
]]
    options.suffix = options.suffix or ""
 
    local url_string = options.id
local function create_url_object (url, source, fmt, fmt_source, access, access_source)
    if options.encode == true or options.encode == nil then
return {
        url_string = mw.uri.encode( url_string );
['url'] = is_set (url) and url or '',
    end
['origin'] = is_set (source) and source or '',
   
['access'] = is_set (access) and sanitized_parameter_value (access, access_source, 'url-access', '') or '',
    return "[[" .. options.link .. "|" .. options.label .. "]]" .. sep .. "[" ..
['access-origin'] = is_set (access_source) and access_source or '',
            options.prefix .. url_string .. options.suffix .. " " .. mw.text.nowiki(options.id) .. "]"
['format'] = is_set (fmt) and fmt or '',
['format-origin'] = is_set (fmt_source) and fmt_source or '',
['access-text'] = ''
}
end
end


-- Formats a wiki style internal link
--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
function internallinkid(options)
 
    local sep = options.separator or "&nbsp;"
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
    options.suffix = options.suffix or ""
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
    return "[[" .. options.link .. "|" .. options.label .. "]]" .. sep .. "[[" ..
 
            options.prefix .. options.id .. options.suffix .. "|" .. mw.text.nowiki(options.id) .. "]]"
]]
 
local function set_titletype (cite_class, title_type)
if is_set (title_type) then
if 'none' == title_type then
title_type = ''; -- if |type=none then type parameter not displayed
end
return title_type; -- if |type= has been set to any other value use that value
end
 
return cfg.title_types[cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
end


-- Format an external link with error checking
--[[--------------------------< S E T _ N O _ T R A C K I N G _ C A T S >-----------------------------------------
function externallink( URL, label )
    local error_str = "";
    if label == nil or label == "" then
        label = URL;
        error_str = seterror( 'bare_url_missing_title', {}, false, " " );
    end
    if not checkurl( URL ) then
        error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
    end


    return "[" .. URL .. ' ' .. safeforurl( label ) .. "]" .. error_str;
check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
 
]]
 
local function set_no_tracking_cats (no_tracking, no_tracking_source, this_page)
local no_tracking_cats = sanitized_parameter_value (no_tracking, no_tracking_source, 'yes_true_y', nil);
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
return true; -- set no_tracking_cats
end
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
if this_page.text:match (v) then -- test page name against each pattern
return true; -- set no_tracking_cats; bail out if one is found
end
end
return false;
else
return true;
end
end
end


-- Formats a link to Amazon
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
function amazon(id, domain)
 
    if ( nil == domain ) then  
Set style settings for CS1 citation templates. Returns separator and postscript settings
        domain = "com"
 
    elseif ( "jp" == domain or "uk" == domain ) then
]]
        domain = "co." .. domain
 
    end
local function set_cs1_style (ps)
    local handler = cfg.id_handlers['ASIN'];
if not is_set (ps) then -- unless explicitely set to something
    return externallinkid({link = handler.link,
ps = '.'; -- terminate the rendered citation with a period
        label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
end
        encode=handler.encode, separator = handler.separator})
return '.', ps; -- separator is a full stop
end
 
--[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------
 
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
 
]]
 
local function set_cs2_style (ps, ref)
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
ps = ''; -- make sure it isn't nil
end
if not is_set (ref) then -- if |ref= is not set
ref = 'harv'; -- set default |ref=harv
end
return ',', ps, ref; -- separator is a comma
end
end


-- Formats a DOI and checks for DOI errors.
--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
function doi(id, inactive)
 
    local cat = ""
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
    local handler = cfg.id_handlers['DOI'];
rendered style.
   
 
    local text;
]]
    if ( inactive ~= nil ) then
 
        text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
local function get_settings_from_cite_class (ps, ref, cite_class)
        table.insert( z.error_categories, "Pages with DOIs inactive since " .. selectyear(inactive) );       
local sep;
        inactive = " (" .. cfg.message_list['inactive'] .. " " .. inactive .. ")"
if (cite_class == 'citation') then -- for citation templates (CS2)
    else
sep, ps, ref = set_cs2_style (ps, ref);
        text = externallinkid({link = handler.link, label = handler.label,
else -- not a citation template so CS1
            prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
sep, ps = set_cs1_style (ps);
        inactive = ""
end
    end
 
    if ( string.sub(id,1,3) ~= "10." ) then     
return sep, ps, ref -- return them all
        cat = seterror( 'bad_doi' );
    end
    return text .. inactive .. cat
end
end


-- Formats an OpenLibrary link, and checks for associated errors.
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
function openlibrary(id)
 
    local code = id:sub(-1,-1)
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
    local handler = cfg.id_handlers['OL'];
config.CitationClass from the template's #invoke: to establish style.
    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})
local function set_style (mode, mode_source, ps, ref, quote, cite_class)
    elseif ( code == "M" ) then
local sep;
        return externallinkid({link=handler.link, label=handler.label,
mode = sanitized_parameter_value (mode, mode_source, 'mode', ''):lower();
            prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
            encode = handler.encode})
sep, ps, ref = set_cs2_style (ps, ref);
    elseif ( code == "W" ) then
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
        return externallinkid({link=handler.link, label=handler.label,
sep, ps = set_cs1_style (ps);
            prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
else -- anything but cs1 or cs2
            encode = handler.encode})
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass
    else
end
        return externallinkid({link=handler.link, label=handler.label,
if 'none' == ps:lower() or is_set (quote) then -- if assigned value is 'none' then set it to empty string
            prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
ps = ''; -- also cs1|2 does not supply terminal punctuation when |quote= is set
            encode = handler.encode}) ..
end
            ' ' .. seterror( 'bad_ol' );
    end
return sep, ps, ref
end
end


--[[
--[[--------------------------< S W A P _ U R L S >--------------------------------------------------------------
Determines whether an 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 )
 
    if url_str:sub(1,2) == "//" then 
local function swap_urls (url_object, chapter_url_object, archive_url_object, dead_url)
        -- Protocol-less URLs
local original_url_object = create_url_object ();
        return true;
local is_dead = in_array (dead_url, cfg.keywords['deadurl-live']); -- used later when assembling archived text
    elseif url_str:match( "^[^/]*:" ) ~= nil then  
        -- Look for ":" prefix and assume it is a URI scheme
if is_set (archive_url_object['url']) then
        return true;
if is_set (url_object['url']) then
    else
original_url_object = url_object;
        -- Anything else is an error
if not is_dead then
        return false;
url_object = archive_url_object;
    end
end
elseif is_set (chapter_url_object['url']) then -- URL not set so if chapter-url is set apply archive url to it
original_url_object = chapter_url_object;
if not is_dead then
chapter_url_object = archive_url_object;
end
end
end
return original_url_object, url_object, chapter_url_object;
end
end


-- Removes irrelevant text and dashes from ISBN number
--[[--------------------------< F O R M A T  _ U R L _ A C C E S S _ T E X T >---------------------------------------
-- Similar to that used for Special:BookSources
 
function cleanisbn( isbn_str )
从x-url-access系列参数生成相应的图标;兼容既有registration, subscription参数,优先级x-url-access > subscription > registration。
    return isbn_str:gsub( "[^-0-9X]", "" );
 
]]
 
local function format_url_access_text (url_object, subscription_required, registration_required)
local access_text = '';
local redundant = false;
local access = url_object['access'];
local reg = false;
local sub = false;
if is_set (access) then
if (access == 'limited') then
access_text = cfg.presentation['limited']; -- 有限度免费访问
elseif (access == 'registration') then
access_text = cfg.presentation['registration']; -- 需要免费注册
reg = true;
elseif (access == 'subscription') then
access_text = cfg.presentation['subscription']; -- 需要付费订阅
sub = true;
else
access_text = '';
end
if is_set (subscription_required) or is_set (registration_required) then
redundant = true;
end
else
if is_set (subscription_required) then
access_text = cfg.presentation['subscription']; -- 需要免费注册
sub = true;
if is_set (registration_required) then
redundant = true;
end
elseif is_set (registration_required) then
access_text = cfg.presentation['registration']; -- 需要付费订阅
reg = true
else
access_text = '';
end
end
if is_set (url_object ['url']) then
url_object['access-text'] = access_text;
if sub then
add_maint_cat ('subscription');
elseif reg then
add_maint_cat ('registration');
end
else
-- 预留报错
end
return redundant;
end
end


-- Determines whether an ISBN string is valid
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------
function checkisbn( isbn_str )
 
    isbn_str = cleanisbn( isbn_str ):gsub( "-", "" );
returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
    local len = isbn_str:len();
or formatted issue, or an empty string if neither are set.
 
    if len ~= 10 and len ~= 13 then
]]
        return false;
    end
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
if not is_set (volume) and not is_set (issue) then
    local temp = 0;
return '';
    if len == 10 then
end
        if isbn_str:match( "^%d*X?$" ) == nil then return false; end
        isbn_str = { isbn_str:byte(1, len) };
if 'magazine' == cite_class or (cite_class =='map' and 'magazine' == origin) then
        for i, v in ipairs( isbn_str ) do
if is_set (volume) and is_set (issue) then
            if v == string.byte( "X" ) then
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
                temp = temp + 10*( 11 - i );
elseif is_set (volume) then
            else
return wrap_msg ('vol', {sepc, volume}, lower);
                temp = temp + tonumber( string.char(v) )*(11-i);
else
            end
return wrap_msg ('issue', {sepc, issue}, lower);
        end
end
        return temp % 11 == 0;
end
    else
        if isbn_str:match( "^%d*$" ) == nil then return false; end
local vol = '';
        isbn_str = { isbn_str:byte(1, len) };
        for i, v in ipairs( isbn_str ) do
if is_set (volume) then
            temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
if (6 < mw.ustring.len (volume)) then
        end
vol = wrap_msg ('j-vol', {sepc, volume}, lower);
        return temp % 10 == 0;
else
    end
vol = wrap_style ('vol-bold', hyphen_to_dash (volume));
end
end
if is_set (issue) then
return vol .. wrap_msg ('j-issue', issue, lower);
end
return vol;
end
end


-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
--[[-------------------------< F O R M A T _ I N S O U R C E _ L O C A T I O N >----------------------------------
function removewikilink( str )
 
    str = str:gsub( "%[%[[^|%]]*|([^%]]*)%]%]", "%1" );
Build insource_location meta-parameter from |page(s)= , |sheet(s)= , |at= and other relevant parameters.
    str = str:gsub( "%[%[([^%]]*)%]%]", "%1" );  
 
    return str
]]
 
local function format_insource_location (page, pages, sheet, sheets, at, minutes, time, time_caption, section, sections, inset, cite_class, origin, sepc, nopp, lower)
local text = '';
if is_set (sheet) then
if 'journal' == origin then
text = wrap_msg ('j-sheet', sheet, lower);
else
text = wrap_msg ('sheet', {sepc, sheet}, lower);
end
elseif is_set (sheets) then
if 'journal' == origin then
text = wrap_msg ('j-sheets', sheets, lower);
else
text = wrap_msg ('sheets', {sepc, sheets}, lower);
end
end
 
local is_journal = 'journal' == cite_class or (cite_class == 'map' and 'journal' == origin);
if is_set (page) then
if is_journal then
text = wrap_msg ('j-page(s)', page, lower);
elseif not is_set (nopp) then
text = wrap_msg ('p-prefix', {sepc, page}, lower);
else
text = wrap_msg ('nopp', {sepc, page}, lower);
end
elseif is_set (pages) then
if is_journal then
text = wrap_msg ('j-page(s)', pages, lower);
elseif tonumber (pages) ~= nil and not is_set (nopp) then -- if pages is only digits, assume a single page number
text = wrap_msg ('p-prefix', {sepc, pages}, lower);
elseif not is_set (nopp) then
text = wrap_msg ('pp-prefix', {sepc, pages}, lower);
else
text = wrap_msg ('nopp', {sepc, pages}, lower);
end
end
if is_set (minutes) then
text = pend_separator (wrap_msg ('minutes', minutes, lower), sepc, true) .. text;
else
if is_set (time) then
if not is_set (time_caption) then
text = pend_separator (wrap_msg ('event', time, lower), sepc, true) .. text;
else
text = pend_separator (time_caption .. ' ' .. time .. text, sepc, true);
end
end
end
text = text .. pend_separator (at, sepc, true);
text = text .. pend_separator (wrap_msg ('inset', inset, lower), sepc, true);
if is_set (sections) then
text = text .. pend_separator (wrap_msg ('sections', sections, lower), sepc, true);
elseif is_set (section) then
text = text .. pend_separator (wrap_msg ('section', section, lower), sepc, true);
end
return text;
end
end


-- Escape sequences for content that will be used for URL descriptions
--[[-------------------------< F O R M A T _ P U B L I S H E R >------------------------------------------
function safeforurl( str )
 
    if str:match( "%[%[.-%]%]" ) ~= nil then  
]]
        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
 
    end
local function format_publisher (publisher_name, publication_place, periodical, cite_class, sepc)
   
local publisher = '';
    return str:gsub( '[%[%]\n]', {   
        ['['] = '&#91;',
if is_set (publisher_name) then
        [']'] = '&#93;',
if is_set (publication_place) then
        ['\n'] = ' ' } );
publisher = publication_place .. ': ' .. publisher_name;
else
publisher = publisher_name; 
end
elseif is_set (publication_place) then
publisher = publication_place;
end
if is_set (publisher) then
if is_set (periodical) and
not in_array (cite_class, {'encyclopaedia', 'web', 'pressrelease', 'podcast'}) then
publisher = ' (' .. publisher .. ')';
else
publisher = pend_separator (publisher, sepc, true);
end
end
return publisher;
end
end


-- Converts a hyphen to a dash
--[[-------------------------< F O R M A T _ L I N K >-------------------------------------------------
function hyphentodash( str )
 
    if str == nil then
Format an external link that may or may not be raw.
        return nil;
 
    end  
]]
    if str:match( "[%[%]{}<>]" ) ~= nil then  
 
        return str;
local function format_external_link (text, url_object, sepc)
    end   
if is_set (text) then
    return str:gsub( '-', '' );
if is_set (url_object['url']) then
text = make_external_link (url_object['url'], text, url_object['origin']);
end
text = pend_separator (text .. url_object['format'], sepc, true);
elseif is_set (url_object['url']) then
text = make_external_link (url_object['url'], nil, url_object['origin']);
end
return text;
end
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
--[[-------------------------< F O R M A T _ C O N F E R E N C E >----------------------------------------
function safeforitalics( str )
 
    --[[ Note: We can not use <i> for italics, as the expected behavior for
]]
    italics specified by ''...'' in the title is that they will be inverted
 
    (i.e. unitalicized) in the resulting references. In addition, <i> and ''
local function format_conference (conference, conference_url_object, periodical, cite_class, sepc)
    tend to interact poorly under Mediawiki's HTML tidy. ]]
local conf_text = format_external_link (conference, conference_url_object, sepc);
   
if 'speech' == cite_class and is_set (periodical) then
    if str == nil or str == '' then
-- if cite speech, periodical (perhaps because of an included |website= or |journal= parameter) is set;  
        return str;
conf_text = pend_separator (conf_text, sepc, false); -- then add appropriate punctuation to the end of the conference variable if set.
    else
end
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
return conf_text;
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
       
        -- Remove newlines as they break italics.
        return str:gsub( '\n', ' ' );
    end
end
end


--[[
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
Joins a sequence of strings together while checking for duplicate separation
 
characters.
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).
 
]]
 
local function format_chapter_title (scriptchapter, chapter, transchapter, chapter_url_object, no_quotes, cite_class, title_type, sepc)
local chapter_error = '';
if not is_set (chapter) then
chapter = ''; -- to be safe for concatenation
else
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
chapter = wrap_style ('quoted-title', chapter);
end
end
 
chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
 
if is_set (transchapter) then
transchapter = wrap_style ('trans-quoted-title', transchapter);
if is_set (chapter) then
chapter = chapter ..  ' ' .. transchapter;
else -- here when transchapter without chapter or script-chapter
chapter = transchapter;
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
end
end
if is_set (chapter_url_object['url']) then
chapter = make_external_link (chapter_url_object['url'], chapter, chapter_url_object['origin']) .. chapter_url_object['access-text'];
-- adds bare_url_missing_title error if appropriate
end
chapter = chapter .. chapter_error;
if is_set (chapter) then
if 'map' == cite_class and is_set (title_type) then
chapter = chapter .. ' ' .. title_type;
end
chapter = pend_separator (chapter .. chapter_url_object['format'], sepc,  false);
else -- |chapter= not set but |chapter-format= is so ...
chapter = pend_separator (chapter_url_object['format'], sepc, false); -- ... ChapterFormat has error message, we want to see it
end
return chapter;
end
 
--[[--------------------------< F O R M A T _ M A I N _ T I T L E >------------------------------------------
 
Format the five title parameters: |script-title=, |title=, |trans-title=, |title-link=, and |url= into a single Title meta-
parameter (url_origin and title_link_origin used for error messages).
 
]]
 
local function format_main_title (title, title_link, title_link_origin, script_title, trans_title, url_object, no_chapter_format, cite_class, periodical)
if is_set (title_link) and is_set (title) then
title = make_internal_link (title_link, title, title_link_origin);
end
if no_chapter_format or
('map' == cite_class and is_set (periodical)) then -- special case for cite map when the map is in a periodical treat as an article
title = kern_quotes (title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
title = wrap_style ('quoted-title', title);
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title= wrap_style ('trans-quoted-title', trans_title );
elseif 'report' == cite_class then -- no styling for cite report
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title= wrap_style ('trans-quoted-title', trans_title ); -- for cite report, use this form for trans-title
else
title = wrap_style ('italic-title', title);
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title = wrap_style ('trans-italic-title', trans_title);
end
 
local trans_error = '';
if is_set (trans_title) then
if is_set (title) then
trans_title = ' ' .. trans_title;
else
trans_error = ' ' .. set_error ('trans_missing_title', {'title'});
end
end
title = title .. trans_title;
if is_set (title) then
if not is_set (title_link) and is_set (url_object['url']) then
title = make_external_link (url_object['url'], title, url_object['origin']) .. url_object['access-text'] .. trans_error .. url_object['format'];
url_object = create_url_object ();
else
title = title .. trans_error;
end
end
return title, url_object;
end
 
--[[--------------------------< F O R M A T  _ F O R M A T >--------------------------------------------------------
 
Applies css style to |format=, |chapter-format=, etc.  Also emits an error message if the format parameter does
not have a matching url parameter.  If the format parameter is not set and the url contains a file extension that
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
the appropriate styling.
 
]]
 
local function format_format (args)
for _, url_object in pairs (args) do
if is_set (url_object['format']) then
url_object['format'] = wrap_style ('format', url_object['format']); -- add leading space, parenthases, resize
if not is_set (url_object['url']) then
url_object['format'] = url_object['format'] .. set_error ('format_missing_url', {url_object['format-origin'], url_object['origin']});
-- add an error message
end
elseif is_set (url_object['url']) then
if url_object['url']:match ('%.pdf[%?#]?') or url_object['url']:match ('%.PDF[%?#]?') then
-- format is not set so if url is a pdf file then
url_object['format'] = wrap_style ('format', 'PDF'); -- set format to pdf
end
end
end
end
 
--[[--------------------------< F O R M A T _ A C C E S S D A T E >----------------------------------------------
 
]]
]]
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
local function format_accessdate (accessdate, sepc, lower)
                    if value ~= comp then
if is_set (accessdate) then -- first, wrap in nowrap span if date in appropriate format
                        local dup2 = duplicate_char;
if accessdate:match ('^%d%d%d%d%-%d%d%-%d%d$') then
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
accessdate = wrap_style ('nowrap1', accessdate); -- when accessdate is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
                       
elseif accessdate:match('^%a+%s*%d%d?,%s+%d%d%d%d$') or accessdate:match ('^%d%d?%s*%a+%s+%d%d%d%d$') then
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
local cap, cap2 = string.match (accessdate, '^(.*)%s+(%d%d%d%d)$');
                    else
accessdate = wrap_style ('nowrap2', {cap, cap2}); -- when accessdate is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
                        value = value:sub( 2, -1 );
end
                    end
accessdate = ' ' .. wrap_msg ('retrieved', accessdate, lower); -- add retrieved text
                end
accessdate = wrap_style ('accessdate', {sepc, accessdate}); -- allow editors to hide accessdates
            end
end
            str = str .. value;
return accessdate;
        end
end
    end
    return str;
end


--[[
--[[--------------------------< F O R M A T _ I D >----------------------------------------------------
Return the year portion of a date string, if possible. 
Returns empty string if the argument can not be interpreted
as a year.
]]
]]
function selectyear( str )
 
    -- Is the input a simple number?
local function format_id (id, docket, sepc, lower)
    local num = tonumber( str );  
id = pend_separator (id, sepc, true);
    if num ~= nil and num > 0 and num < 2100 and num == math.abs(num) then
return pend_separator (wrap_msg ('docket', docket, lower), sepc, true) .. id;
        return str;
    else
        -- Use formatDate to interpret more complicated formats
        local lang = mw.getContentLanguage();
        local good, result;
        good, result = pcall( lang.formatDate, lang, 'Y', str )
        if good then
            return result;
        else
            -- Can't make sense of this input, return blank.
            return "";
        end
    end
end
end


-- Attempts to convert names to initials.
--[[--------------------------< F O R M A T _ Q U O T E >----------------------------------------------
function reducetoinitials(first)
]]
    local initials = {}
 
    for word in string.gmatch(first, "%S+") do
local function format_quote (quote, sepc)
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
if is_set (quote) then
    end
if quote:sub (1, 1) == '"' and quote:sub (-1, -1) == '"' then -- if first and last characters of quote are quote marks
    return table.concat(initials) -- Vancouver format does not include spaces.
quote = quote:sub (2, -2); -- strip them off
end
return pend_separator (wrap_style ('quoted-text', quote), sepc, true); -- wrap in <q>...</q> tags
end
return '';
end
end


-- Formats a list of people (e.g. authors / editors)
--[[--------------------------< F O R M A T _ A R C H I V E >------------------------------------------
function listpeople(control, people)
 
    local sep = control.sep;
]]
    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
    local namesep = control.namesep
    local format = control.format
    local maximum = control.maximum
    local lastauthoramp = control.lastauthoramp;
    local text = {}
    local etal = false;
    if maximum < 1 then return "", 0; end
    for i,person in ipairs(people) do
        if (person.last ~= nil or 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 (first ~= nil and first ~= '') then
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
                    one = one .. namesep .. first
                end
                if (person.link ~= nil and person.link ~= "") then one = "[[" .. person.link .. "|" .. one .. "]]" end
            end
            table.insert( text, one )
            table.insert( text, sep_one )
        end
    end


    local count = #text / 2;
local function format_archive (archive_url_object, original_url_object, archive_date, dead_url, sepc, lower)
    if count > 0 then  
local archived = '';
        if count > 1 and lastauthoramp ~= nil and lastauthoramp ~= "" and not etal then
if is_set (archive_url_object['url']) then
            text[#text-2] = " & ";
if not is_set (archive_date) then
        end
archive_date = set_error ('archive_missing_date');
        text[#text] = nil;  
end
    end
if in_array (dead_url, cfg.keywords['deadurl-live']) then
   
local arch_text = cfg.messages['archived'];
    local result = table.concat(text) -- construct list
if (lower) then arch_text = arch_text:lower(); end;
    if etal then
archived = pend_separator (wrap_msg ('archived-not-dead', {make_external_link (archive_url_object['url'], arch_text, archive_url_object['origin']) .. archive_url_object['format'], archive_date }, lower), sepc, true);
        local etal_text = cfg.message_list['et al'];
if not is_set (original_url_object['url']) then
        result = result .. " " .. etal_text;
archived = archived .. ' ' .. set_error ('archive_missing_url');  
    end
end
   
elseif is_set (original_url_object['url']) then -- dead_url is not live, so it should be empty, dead or unfit
    -- if necessary wrap result in <span> tag to format in Small Caps
if in_array (dead_url, cfg.keywords['deadurl-unfit']) then
    if ( "scap" == format ) then result =  
archived = pend_separator (wrap_msg('archived-unfit', archive_date, lower), sepc, true);
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
-- format already styled
    end  
else -- dead_url is empty or dead
    return result, count
archived = pend_separator (wrap_msg ('archived-dead',
{make_external_link (original_url_object['url'], cfg.messages['original'], original_url_object['origin']) .. original_url_object['access-text'] .. original_url_object['format'], archive_date }, lower), sepc, true);
-- format already styled
end
else
archived = pend_separator (wrap_msg ('archived-missing',
{set_error ('archive_missing_url'), archive_date }, lower), sepc, true);
end
elseif is_set (original_url_object['format']) then
archived = original_url_object['format']; -- if set and archive_url not set archive_format has error message
end
return archived;
end
end


-- Generates a CITEREF anchor ID.
--[[--------------------------< F O R M A T _ L A Y >---------------------------------------------------
function anchorid( options )
 
    return "CITEREF" .. mw.uri.anchorEncode( table.concat( options ) );
]]
 
local function format_lay (lay_url_object, lay_date, lay_source, sepc, lower)
local lay = '';
if is_set (lay_url_object['url']) then
if is_set (lay_date) then lay_date = ' (' .. lay_date .. ')' end
if is_set (lay_source) then
lay_source = wrap_msg ('lay source', lay_source, lower);
else
lay_source = '';
end
local lay_sum = cfg.messages['lay summary'];
if lower then
lay_sum = lay_sum:lower();
end
lay = pend_separator (make_external_link (lay_url_object['url'], lay_sum, lay_url_object['origin']) .. lay_url_object['format'] .. lay_source .. lay_date, sepc, true);
else -- Test if |lay-format= is given without giving a |lay-url=
lay = pend_separator (lay_url_object['format'], sepc, true); -- if set and LayURL not set, then LayFormat has error message
end
return lay;
end
end


-- Gets name list from the input arguments
--[[--------------------------< F O R M A T _ P E R I O D I C A L >------------------------------------
function extractnames(args, list_name)
]]
    local names = {};
 
    local i = 1;
local function format_periodical (periodical, title, title_note, sepc)
    local last;
if is_set (periodical) then
   
if is_set (title) or is_set (title_note) then
    while true do
return pend_separator (wrap_style ('italic-title', periodical), sepc, true);
        last = selectone( args, cfg.argument_map[list_name .. '-Last'], 'redundant_parameters', i );
else
        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
return wrap_style ('italic-title', periodical);
            names[i] = {
end
                last = last,
end
                first = selectone( args, cfg.argument_map[list_name .. '-First'], 'redundant_parameters', i ),
return '';
                link = selectone( args, cfg.argument_map[list_name .. '-Link'], 'redundant_parameters', i ),
                mask = selectone( args, cfg.argument_map[list_name .. '-Mask'], 'redundant_parameters', i )
            }               
        else
            break;
        end
        i = i + 1;
    end
    return names;
end
end


-- Populates ID table from arguments using configuration settings
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
function extractids( args )
    local id_list = {};
   
    for k, v in pairs( cfg.id_handlers ) do   
        id_list[k] = selectone( args, v.parameters, 'redundant_parameters' );
    end


    return id_list;
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
 
namelist is one of the contributor-, author-, or editor-name lists chosen in that order.  year is Year or anchor_year.
 
]]
 
local function anchor_id (namelist, year)
local names={}; -- a table for the one to four names and year
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
names[i] = v.last
if i == 4 then break end -- if four then done
end
table.insert (names, year); -- add the year at the end
local id = table.concat (names); -- concatenate names and year for CITEREF id
if is_set (id) then -- if concatenation is not an empty string
return 'CITEREF' .. id; -- add the CITEREF portion
else
return ''; -- return an empty string; no reason to include CITEREF id in this citation
end
end
end


-- Takes a table of IDs and turns it into a table of formatted ID outputs.
--[[--------------------------< F O R M A T _ C I T A T I O N >--------------------------------------------
function buildidlist( id_list, options )
    local handler;
    local new_list = {};
   
    for k, v in pairs( id_list ) do
        handler = {};
       
        --Becasue cfg is read-only we have to copy it the hard way.
        for k2, v2 in pairs( cfg.id_handlers[k] ) do
            handler[k2] = v2;
        end
        handler['id'] = v;
       
        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
            if k == 'DOI' then
                table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
            elseif k == 'ASIN' then
                table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
            elseif k == 'OL' then
                table.insert( new_list, {handler.label, openlibrary( v ) } );
            elseif k == 'ISBN' then
                local ISBN = internallinkid( handler );
                if not checkisbn( v ) and ( options.IgnoreISBN == nil or options.IgnoreISBN == "" ) then
                    ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
                end
                table.insert( new_list, {handler.label, ISBN } );               
            else
                error( cfg.message_list['unknown_manual_ID'] );
            end           
        else
            error( cfg.message_list['unknown_ID_mode'] );
        end
    end


    function comp( a, b )
]]
        return a[1] < b[1];
    end


    table.sort( new_list, comp );
local function format_citation (body, cite_class, ref, namelist, year, ocins_output, no_tracking_cats)
    for k, v in ipairs( new_list ) do
local options = {};
        new_list[k] = v[2];
    end
if is_set (cite_class) and cite_class ~= 'citation' then
   
options.class = 'citation ' .. cite_class; -- class=citation required for blue highlight when used with |ref=
    return new_list;
else
options.class = 'citation';
end
if is_set (ref) and ref:lower() ~= 'none' then -- set reference anchor if appropriate
local id = ref
if ('harv' == ref ) then
id = anchor_id (namelist, year); -- go make the CITEREF anchor
end
options.id = id;
end
if string.len (body:gsub ('<span[^>/]*>.-</span>', ''):gsub ('%b<>','')) <= 2 then
reset_error ({'err_cats'});
body = set_error ('empty_citation');
reset_error ({'msg_tail'});
end
local text;
if is_set (options.id) then
text = wrap_style ('citation-with-id', {mw.uri.anchorEncode (options.id), mw.text.nowiki (options.class), body});
else
text = wrap_style ('citation-no-id', {mw.text.nowiki (options.class), body});
end
text = text .. wrap_style ('OCinS', ocins_output);
text = text .. make_error_tail (no_tracking_cats); -- append error/maintenance messages/categories to the citation
return text;
end
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 args[v] ~= nil 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
--[[--------------------------< D E D U C E _ C I T A T I O N _ C L A S S >--------------------------------------
        if index ~= nil then
 
            v = v:gsub( "#", index );
如果citation_class为citation({{citation}}),根据periodical系列参数的设置情况推断实际的引用类型。
        end
 
        if args[v] ~= nil then
]]
            if value ~= nil then
                table.insert( error_list, v );
            else
                value = args[v];
                selected = v;
            end
        end
    end


    if #error_list > 0 then
local function deduce_citation_class (A, naive_class)
        local error_str = "";
local deduced_class;
        for _, k in ipairs( error_list ) do
local periodical = A['Periodical'];
            if error_str ~= "" then error_str = error_str .. ", " end
local origin = A:ORIGIN ('Periodical');
            error_str = error_str .. "<code>|" .. k .. "=</code>";
        end
for cite_class, aliases in pairs (cfg.periodical.parameters) do
        if #error_list > 1 then
if cite_class ~= '_general' then
            error_str = error_str .. ", and ";
for _, aliase in pairs (aliases) do
        else
if origin == aliase then
            error_str = error_str .. " and ";
deduced_class = cite_class;
        end
end
        error_str = error_str .. "<code>|" .. selected .. "=</code>";
end
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
end
    end
end
           
    return value, selected;
if (naive_class == 'citation') then
if is_set (deduced_class) then
return deduced_class, true;
end
elseif (naive_class ~= deduced_class) then
local check_list = cfg.periodical.compatibility[naive_class];
if is_set (check_list) then
if is_set (check_list['drop']) and in_array (deduced_class, check_list['drop']) then
A['Periodical'] = discard_parameter (periodical, origin, nil);
elseif is_set (check_list['warn']) and in_array (deduced_class, check_list['warn']) then
append_error ('periodical', {origin, naive_class, deduced_class, check_list['suggest']});
end
end
end
return naive_class, false;
end
end


--[[--------------------------< A R G U M E N T _ W R A P P E R >----------------------------------------------
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.
]]
local 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] = select_one (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;
throw_error ('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
--[[--------------------------< D O _ C I T A T I O N >---------------------------------------------------------
This is the main function doing the majority of the citation formatting.
]]
local function do_citation (config, args)
--local variables that are not cs1 parameters
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
--[[
Load Input Parameters
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
]]
local A = argument_wrapper (args);
local citation_class, did_duduction = deduce_citation_class (A, config.CitationClass);
-- Pick out the relevant fields from the arguments.  Different citation templates
-- define different field names for the same underlying things.
------------------------------------------------- Get dates
local Year = A['Year'];
local PublicationDate = A['PublicationDate'];
local OrigYear = A['OrigYear'];
local Date = A['Date'];
local Dateorigin = A:ORIGIN ('Date');
local LayDate = A['LayDate'];
------------------------------------------------- Get title data
local Title = A['Title'];
local ScriptTitle = A['ScriptTitle'];
local Conference = A['Conference'];
local TransTitle = A['TransTitle'];
local TitleNote = A['TitleNote'];
local TitleLink = A['TitleLink'];
local TitleLinkorigin = A:ORIGIN ('TitleLink');
local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN ('Periodical'); -- get the name of the periodical parameter
local Series = A['Series'];
local ConferenceURLobject = create_url_object (A['ConferenceURL'], A:ORIGIN ('ConferenceURL'), A['ConferenceFormat'], A:ORIGIN ('ConferenceFormat'));
local ArchiveURLobject = create_url_object (A['ArchiveURL'], A:ORIGIN ('ArchiveURL'), A['ArchiveFormat'], A:ORIGIN ('ArchiveFormat'));
local URLobject = create_url_object (A['URL'], A:ORIGIN ('URL'), A['Format'], A:ORIGIN ('Format'),A['UrlAccess'], A:ORIGIN ('UrlAccess'));
local TranscriptURLobject = create_url_object (A['TranscriptURL'], A:ORIGIN ('TranscriptURL'), A['TranscriptFormat'], A:ORIGIN ('TranscriptFormat'));
local LayURLobject = create_url_object (A['LayURL'], A:ORIGIN ('LayURL'), A['LayFormat'], A:ORIGIN ('LayFormat'));
local Volume = A['Volume'];
local Issue = A['Issue'];
local Page = A['Page'];
local Pages = hyphen_to_dash (A['Pages']);
local At = A['At'];
if not in_array (citation_class, cfg.args_support['templates_using_volume']) then
Volume = discard_parameter (Volume, A:ORIGIN ('Volume'), nil);
end
if not in_array (citation_class, cfg.args_support['templates_using_issue']) then
if (A:ORIGIN ('Issue') ~= 'number') then
Issue = discard_parameter (Issue, A:ORIGIN ('Issue'), nil);
else
Issue = nil;
end
end
if in_array (citation_class, cfg.args_support['templates_not_using_page']) then
Page = discard_parameter (Page, A:ORIGIN ('Page'), nil);
Pages = discard_parameter (Pages, A:ORIGIN ('Pages'), nil);
At = discard_parameter (At, A:ORIGIN ('At'), nil);
end
local Minutes = A['Minutes'];
local Time = A['Time'];
local TimeCaption = A['TimeCaption'];
if not in_array (citation_class, cfg.args_support['templates_involving_time']) then
Minutes = discard_parameter (Minutes, A:ORIGIN ('Minutes'), nil);
Time = discard_parameter (Time, A:ORIGIN ('Time'), nil);
TimeCaption = discard_parameter (TimeCaption, A:ORIGIN ('TimeCaption'), nil);
end
local Sheet = A['Sheet'];
local Sheets = A['Sheets'];
local Section = A['Section'];
local Sections = A['Sections'];
local Inset = A['Inset'];
if not ('map' == citation_class) then
Sheet = discard_parameter (Sheet, A:ORIGIN ('Sheet'), nil);
Sheets = discard_parameter (Sheets, A:ORIGIN ('Sheets'), nil);
Sections = discard_parameter (Sections, A:ORIGIN ('Sections'), nil);
Inset = discard_parameter (Inset, A:ORIGIN ('Inset'), nil);
end
--[[
不知道哪个“天才”想出来的点子,现行引用模板里,section一个参数多个涵义。
在书籍类引用中,section是章节名称,在地图引用中,section是地图的区域编号。
所以一旦知道citation_class不是地图,就可以丢弃上述几乎全部参数,
唯独section参数需要留到检查章节相关参数时一并进行检查。
]]
local Chapter = '';
local ScriptChapter = '';
local TransChapter = '';
local ChapterURLobject;
local no_chapter_format = in_array (citation_class, cfg.args_support['templates_not_using_chapter_format']);
if in_array (citation_class, cfg.args_support['templates_not_using_chapter']) then
ChapterURLobject = create_url_object ();
discard_chapter (A);
if not ('map' == citation_class) then
Section = discard_parameter (Section, A:ORIGIN ('Section'), nil);
end
else
Chapter = A['Chapter'];
ScriptChapter = A['ScriptChapter'];
TransChapter = A['TransChapter'];
ChapterURLobject = create_url_object (A['ChapterURL'], A:ORIGIN ('ChapterURL'), A['ChapterFormat'], A:ORIGIN ('ChapterFormat'), A['ChapterUrlAccess'], A:ORIGIN ('ChapterUrlAccess'));
if is_set (Chapter) then
if is_set (Section) then
select_one (args, {'chapter', 'contribution', 'section'}, 'redundant_parameters');
end
else
Chapter = Section;
Section = nil;
end
end
local Edition = A['Edition'];
local PublicationPlace = A['PublicationPlace']
local Place = A['Place'];
local PublisherName = A['PublisherName'];
local RegistrationRequired = sanitized_parameter_value (A['RegistrationRequired'], A:ORIGIN ('RegistrationRequired'), 'yes_true_y', nil);
local SubscriptionRequired = sanitized_parameter_value (A['SubscriptionRequired'], A:ORIGIN ('SubscriptionRequired'), 'yes_true_y', nil);
local Via = A['Via'];
local AccessDate = A['AccessDate'];
local ArchiveDate = A['ArchiveDate'];
local Agency = A['Agency'];
local DeadURL = sanitized_parameter_value (A['DeadURL'], A:ORIGIN ('DeadURL'), 'deadurl', '');
local Language = A['Language'];
local DoiBroken = A['DoiBroken'];
local ID = A['ID'];
local ASINTLD = A['ASINTLD'];
local IgnoreISBN = sanitized_parameter_value (A['IgnoreISBN'], A:ORIGIN ('IgnoreISBN'), 'yes_true_y', nil);
local Embargo = A['Embargo'];
local Class = A['Class']; -- arxiv class identifier
local ID_list = extract_ids (args);
local ID_access_levels = extract_id_access_levels (args, ID_list);
local LaySource = A['LaySource'];
local Transcript = A['Transcript'];
local no_tracking_cats = set_no_tracking_cats (A['NoTracking'], A:ORIGIN ('NoTracking'), this_page);
local Quote = A['Quote'];
local sepc, PostScript, Ref = set_style (A['Mode'], A:ORIGIN ('Mode'), A['PostScript'], A['Ref'], Quote, config.CitationClass);
if is_set (Quote) and is_set (A['PostScript']) then
select_one (args, {'postscript', 'quote', 'quotation'}, 'redundant_parameters');
end
local use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text
-- check for insource-location-related parameters like |page=, |pages= or |at=. 请注意section参数有歧义,如果section跟书有关系,上面已经被清空了,这里不纳入检查。
select_one (args, {'at', 'time', 'minutes'}, 'redundant_parameters');
select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'time', 'minutes', 'sheet', 'sheets'}, 'redundant_parameters');
if is_set (Section) then
select_one (args, {'at', 'section', 'sections'}, 'redundant_parameters');
else
select_one (args, {'at', 'sections'}, 'redundant_parameters');
end
-- Dummy calls simply to get the error messages and categories
local NoPP = sanitized_parameter_value (A['NoPP'], A:ORIGIN ('NoPP'), 'yes_true_y', nil);
if is_set (Page) then
if is_set (Pages) or is_set (At) then
Pages = ''; -- unset the others
At = '';
end
extra_text_in_parameter_check (Page, 'page'); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
elseif is_set (Pages) then
if is_set (At) then
At = ''; -- unset
end
extra_text_in_parameter_check (Pages, 'page'); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
end
-- both |publication-place= and |place= (|location=) allowed if different
if not is_set (PublicationPlace) and is_set (Place) then
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
if is_set (Edition) then
extra_text_in_parameter_check (Edition, 'edition');
end
------------------------------------------------- Get people
local NameListFormat = sanitized_parameter_value (A['NameListFormat'], A:ORIGIN ('NameListFormat'), 'name-list-format', '');
local LastAuthorAmp = sanitized_parameter_value (A['LastAuthorAmp'], A:ORIGIN ('LastAuthorAmp'), 'yes_true_y', nil);
local contributors_valid = in_array (citation_class, cfg.args_support['templates_using_contributor']);
local Authors, Contributors, Editors, Translators, Contribution, NameList, multiple_editors, has_contributors =
get_people (
{
vauthors = A['Vauthors'], authors = A['Authors'], veditors = A['Veditors'], editors = A['Editors'], contribution = A['Contribution'], coauthors = A['Coauthors']
}, {
displayauthors = A['DisplayAuthors'], displayeditors = A['DisplayEditors'], contributorsvalid = contributors_valid,  namelistformat = NameListFormat, lastauthoramp = LastAuthorAmp
}, args, this_page.name
); -- (co-)authors, contributors, editors and translators
local TitleType = set_titletype (citation_class, A['TitleType']); -- handle type parameter for those CS1 citations that have default values
-- special case for cite thesis
local Degree = A['Degree'];
if 'thesis' == citation_class then
if (is_set (Degree)) then
TitleType = wrap_msg ('thesis with type', Degree, use_lowercase);
else
TitleType = wrap_msg ('thesis no type', 'placeholder', use_lowercase);
end
else
Degree = discard_parameter (Degree, A:ORIGIN ('Degree'), nil);
end
local Others = A['Others'];
--[[
--[[
This is the main function foing the majority of the citation
Parameter remapping for cite encyclopedia:
formatting.
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
|url maps to |chapterurl when |title is remapped
 
All other combinations of |encyclopedia, |title, and |article are not modified
 
]]
]]
function citation0( config, args, frame ) -- LOCAL
    --[[
    Load Input Parameters
    The argment_wrapper facillitates the mapping of multiple
    aliases to single internal variable.
    ]]
    local A = argument_wrapper( args );


    local i
local Encyclopedia;
    local PPrefix = A['PPrefix']
local Entry = A['Entry'];
    local PPPrefix = A['PPPrefix']
    if ( nil ~= A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
    -- LOCAL
    local PSuffix = A['PSuffix']
    local PPSuffix = A['PPSuffix']
    if ( nil ~= A['NoPP'] ) then PPSuffix = "" PSuffix = "" end
    -- END LOCAL
   
    -- 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'];
if (citation_class == 'encyclopaedia') then -- test code for citation
    local Others = A['Others'];
local entry_redundant = false
    local Editors = A['Editors'];
Encyclopedia = Periodical;
    local e = extractnames( args, 'EditorList' );
if is_set (Periodical) then
if is_set (Title) or is_set (ScriptTitle) then
Chapter = Title;
ScriptChapter = ScriptTitle;
ScriptTitle = '';
TransChapter = TransTitle;
TransTitle = '';
ChapterURLobject = URLobject;
URLobject = create_url_object ();
if not is_set (ChapterURLobject['url']) and is_set (TitleLink) then
Chapter = make_internal_link (TitleLink, Chapter, TitleLinkorigin);
end
TitleLink = '';
entry_redundant = is_set (Entry);
elseif is_set (Entry) then
Chapter = Entry;
ChapterURLobject = URLobject;
URLobject = create_url_object ();
end
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Periodical = ''; -- redundant so unset
else
if is_set (Title) or is_set (ScriptTitle) then
entry_redundant = is_set (Entry);
else
Title = Entry;
end
end
if entry_redundant then
select_one (args, {'title', 'script-title', 'article', 'entry'}, 'redundant_parameters');
end
else
Entry = discard_parameter (Entry, A:ORIGIN ('Entry'), nil);
end
-- Special case for cite report.
local Docket = A['Docket'];
if citation_class == 'report' then
if is_set (Docket) then
if is_set (ID) then
select_one (args, {'id', 'docket'}, 'redundant_parameters');
end
ID = Docket; -- for cite report when |docket= is set, overwrite ID even if |id= is set
Docket = '';
end
elseif citation_class ~= 'thesis' then
discard_parameter (Docket, A:ORIGIN ('Docket'), '');
end


    local Year = A['Year'];
-- Special case for cite techreport.
    local PublicationDate = A['PublicationDate'];
local Num = A['Number'];
    local OrigYear = A['OrigYear'];
if citation_class == 'techreport' then -- special case for cite techreport
    local Date = A['Date'];
if is_set (Num) then -- cite techreport uses 'number', which other citations alias to 'issue'
    local LayDate = A['LayDate'];
if not is_set (ID) then -- can we use ID for the "number"?
    ------------------------------------------------- Get title data
ID = Num; -- yes, use it
    local Title = A['Title'];
else -- ID has a value so emit error message
    local BookTitle = A['BookTitle'];
select_one (args, {'id', 'number'}, 'redundant_parameters');
    local Conference = A['Conference'];
end
    local TransTitle = A['TransTitle'];
end
    local TitleNote = A['TitleNote'];
elseif not is_set (Issue) then
    local TitleLink = A['TitleLink'];
Num = discard_parameter (Num, A:ORIGIN ('Number'), nil);
    local Chapter = A['Chapter'];
end
    local ChapterLink = A['ChapterLink'];
    local TransChapter = A['TransChapter'];
    local TitleType = A['TitleType'];
    local ArchiveURL = A['ArchiveURL'];
    local URL = A['URL'];
    local ChapterURL = A['ChapterURL'];
    local ConferenceURL = A['ConferenceURL'];
    local Periodical = A['Periodical'];
           
    if ( config.CitationClass == "encyclopaedia" ) then
        if ( Chapter == nil or Chapter == '' ) then   
            if (Title == nil or Title == "") then
                Title = Periodical;
                Periodical = nil;
            else
                Chapter = Title
                TransChapter = TransTitle
                Title = nil
                TransTitle = nil
            end
        end
    end


    local Series = A['Series'];
-- special case for cite interview
    local Volume = A['Volume'];
local Callsign = A['Callsign'];
    local Issue = A['Issue'];
local City = A['City'];
    local Position = nil
local Program = A['Program'];
    local Page, Pages, At, page_type;
   
    Page = A['Page'];
    Pages = hyphentodash( A['Pages'] );
    At = A['At'];
    if Page ~= nil then
        if Pages ~= nil or At ~= nil then
            Page = Page .. " " .. seterror('extra_pages');
            Pages = nil;
            At = nil;
        end
    elseif Pages ~= nil then
        if At ~= nil then
            Pages = Pages .. " " .. seterror('extra_pages');
            At = nil;
        end
    end   
               
    local Edition = A['Edition'];
    local PublicationPlace = A['PublicationPlace']
    local Place = A['Place'];
    if PublicationPlace == nil and Place ~= nil then
        PublicationPlace = Place;
    end
    if PublicationPlace == Place then Place = nil end
   
    local PublisherName = A['PublisherName'];
    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']
if (citation_class == 'interview') then
    local ID = A['ID'];
if is_set (Program) then
    local ASINTLD = A['ASINTLD'];
ID = ' ' .. Program;
    local IgnoreISBN = A['IgnoreISBN']
end
if is_set (Callsign) then
if is_set (ID) then
ID = ID .. pend_separator (Callsign, sepc, true);
else
ID = ' ' .. Callsign;
end
end
if is_set (City) then
if is_set (ID) then
ID = ID .. pend_separator (City, sepc, true);
else
ID = ' ' .. City;
end
end


    local ID_list = extractids( args );
if is_set (Others) then
   
Others = wrap_msg ('interview', {TitleType, Others}, use_lowercase);
    local Quote = A['Quote'];
TitleType = '';
    local PostScript = A['PostScript']
end
    local LaySummary = A['LaySummary']
else
    local LaySource = A['LaySource'];
Callsign = discard_parameter (Callsign, A:ORIGIN ('Callsign'), nil );
    local Transcript = A['Transcript'];
City = discard_parameter (City, A:ORIGIN ('City'), nil );
    local TranscriptURL = A['TranscriptURL'];
Program = discard_parameter (Program, A:ORIGIN ('Program'), nil);
    local sepc = A['Separator']
end
    local LastAuthorAmp = A['LastAuthorAmp']
    local no_tracking_cats = A['NoTracking'] or "";
if is_set (TitleType) then -- if type parameter is specified
TitleType = wrap_msg ('type', TitleType, use_lowercase); -- display it in parentheses
end
-- Account for the oddity that is {{cite conference}} or {{cite speech}}.


    local this_page = mw.title.getCurrentTitle(); --Also used for COinS
local BookTitle = A['BookTitle'];
    if no_tracking_cats == "" then
if 'conference' == citation_class then
        for k, v in pairs( cfg.uncategorized_namespaces ) do
if is_set (BookTitle) then
            if this_page.nsText == v then
ChapterURLobject = URLobject;
                no_tracking_cats = "true";
URLobject = create_url_object ();
                break;
TransChapter = TransTitle;
            end
TransTitle = '';
        end
Chapter = Title;
    end
Title = BookTitle;
end
else
BookTitle = discard_parameter (BookTitle, A:ORIGIN ('BookTitle'), nil);
if 'speech' == citation_class then
TitleNote = discard_parameter (TitleNote, A:ORIGIN ('TitleNote'), TitleType);
-- override 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).
TitleType = ''; -- annotate the citation
else
Conference = discard_parameter (Conference, A:ORIGIN ('Conference'), '');
-- not cite conference or cite speech so make sure this is empty string
end
end


    if ( config.CitationClass == "journal" ) then       
-- cite map oddities
        if (URL == nil or URL == "") then
local Cartography = A['Cartography'];
            if (ID_list['PMC'] ~= nil) then
local Scale = A['Scale'];
                local Embargo = A['Embargo'];
                if Embargo ~= nil then
if citation_class == 'map' then
                    local lang = mw.getContentLanguage();
Chapter = A['Map'];
                    local good1, result1, good2, result2;
TransChapter = A['TransMap'];
                    good1, result1 = pcall( lang.formatDate, lang, 'U', Embargo );
ChapterURLobject = create_url_object (A['MapURL'], A:ORIGIN ('MapURL'), A['MapFormat'], A:ORIGIN ('MapFormat'), A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'));
                    good2, result2 = pcall( lang.formatDate, lang, 'U' );
Cartography = pend_separator (wrap_msg ('cartography', Cartography, use_lowercase), sepc, true);
Scale = pend_separator (Scale, sepc, true);
else
Cartography = discard_parameter (Cartography, A:ORIGIN ('Cartography'), '');
Scale = discard_parameter (Scale, A:ORIGIN ('Scale'), '');
discard_parameter (A['Map'], A:ORIGIN ('Map'), nil);
discard_parameter (A['MapURL'], A:ORIGIN ('MapURL'), nil);
discard_parameter (A['TransMap'], A:ORIGIN ('TransMap'), nil);
discard_parameter (A['MapFormat'], A:ORIGIN ('MapFormat'), nil);
discard_parameter (A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'), nil);
end


                    if good1 and good2 and tonumber( result1 ) < tonumber( result2 ) then  
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
                        URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
if 'episode' == citation_class or 'serial' == citation_class then
                    end
local AirDate = A['AirDate'];
                else
local SeriesLink = A['SeriesLink'];
                    URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];          
local Network = A['Network'];
                end
local Station = A['Station'];
            end
local s, n = {}, {};
        end
-- do common parameters first
    end
if is_set (Network) then table.insert (n, Network); end
if is_set (Station) then table.insert (n, Station); end
ID = table.concat (n, sepc .. ' ');
if is_set (AirDate) then
if not is_set (Date) then -- promote airdate to date
Date = AirDate;
Dateorigin = A:ORIGIN ('AirDate');
else
select_one (args, {'date', 'air-date', 'airdate'}, 'redundant_parameters');
end
end


    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
if 'episode' == citation_class then -- handle the oddities that are strictly {{cite episode}}
   
local Season = A['Season'];
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
local SeriesNumber = A['SeriesNumber'];
    if ( BookTitle ) then
        Chapter = Title
        ChapterLink = TitleLink
        TransChapter = TransTitle
        Title = BookTitle
        TitleLink = nil
        TransTitle = nil
    end
    -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
    if config.CitationClass == "episode" then
        local AirDate = A['AirDate']
        local SeriesLink = A['SeriesLink']
        local Season = A['Season']
        local SeriesNumber = A['SeriesNumber']
        local Network = A['Network']
        local Station = A['Station']
        local s = {}
        if Issue ~= nil then table.insert(s, cfg.message_list["episode"] .. " " .. Issue) Issue = nil end
        if Season ~= nil then table.insert(s, cfg.message_list["season"] .. " " .. Season) end
        if SeriesNumber ~= nil then table.insert(s, cfg.message_list["series"] .. " " .. SeriesNumber) end
        local n = {}
        if Network ~= nil then table.insert(n, Network) end
        if Station ~= nil then table.insert(n, Station) end
        Date = Date or AirDate
        Chapter = Title
        ChapterLink = TitleLink
        TransChapter = TransTitle
        Title = Series
        TitleLink = SeriesLink
        TransTitle = nil
        local Sep = (A["SeriesSeparator"] or A["Separator"]) .. " "
        Series = table.concat(s, Sep)
        ID = table.concat(n, Sep)
    end
   
    -- These data form a COinS tag (see <http://ocoins.info/>) which allows
    -- automated tools to parse the citation information.
    local OCinSdata = {} -- COinS metadata excluding id, bibcode, doi, etc.
    local ctx_ver = "Z39.88-2004"
    OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
    if ( nil ~= Periodical ) then
        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"
        OCinSdata["rft.genre"] = "article"
        OCinSdata["rft.jtitle"] = Periodical
        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
    end
    if ( nil ~= Chapter and "" ~= Chapter) then
        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
        OCinSdata["rft.genre"] = "bookitem"
        OCinSdata["rft.btitle"] = Chapter
        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
    else
        OCinSdata["rft.genre"] = "book"
        if ( nil ~= Title ) then OCinSdata["rft.btitle"] = Title end
    end
    OCinSdata["rft.place"] = PublicationPlace
    OCinSdata["rft.date"] = Date or Year or PublicationDate
    OCinSdata["rft.series"] = Series
    OCinSdata["rft.volume"] = Volume
    OCinSdata["rft.issue"] = Issue
    OCinSdata["rft.pages"] = Page or Pages or At
    OCinSdata["rft.edition"] = Edition
    OCinSdata["rft.pub"] = PublisherName
   
    for k, v in pairs( ID_list ) do
        if k == 'ISBN' then
            v = cleanisbn( v );
        end
        if string.sub( cfg.id_handlers[k].COinS or "info", 1, 4 ) ~= 'info' then
            OCinSdata[ cfg.id_handlers[k].COinS ] = v;
        end
    end
   
    OCinSdata.rft_id = URL or ChapterURL


    local last, first;
if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
    local OCinSauthors = {};
select_one (args, {'season', 'series-number', 'series-no', 'seriesnumber', 'seriesno'}, 'redundant_parameters');
    for k, v in ipairs( a ) do
-- add error message
        last = v.last;
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
        first = v.first;
end
        if k == 1 then
-- assemble a table of parts concatenated later into Series
            if last ~= nil then
if is_set (Season) then table.insert (s, wrap_msg ('season', Season, use_lowercase)); end
                OCinSdata["rft.aulast"] = last;
if is_set (SeriesNumber) then table.insert (s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
            end
if is_set (Issue) then table.insert (s, wrap_msg ('episode', Issue, use_lowercase)); end
            if first ~= nil then
Issue = ''; -- unset because this is not a unique parameter
                OCinSdata["rft.aufirst"] = first;
            end
Chapter = Title; -- promote title parameters to chapter
        end
ScriptChapter = ScriptTitle;
        if last ~= nil and first ~= nil then
local ChapterLink = TitleLink; -- alias episodelink
            table.insert( OCinSauthors, last .. ", " .. first );
local ChapterLinkorigin = TitleLinkorigin;
    elseif last ~= nil then
TransChapter = TransTitle;
            table.insert( OCinSauthors, last );
ChapterURLobject = URLobject;
        end
    end
Title = Series; -- promote series to title
TitleLink = SeriesLink;
TitleLinkorigin = A:ORIGIN ('SeriesLink');
Series = table.concat (s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number


    local OCinSids = {} -- COinS data only for id, bibcode, doi, pmid, etc.
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
    for k, v in pairs( ID_list ) do
Chapter = make_internal_link (ChapterLink, Chapter, ChapterLinkorigin);
        if string.sub( cfg.id_handlers[k].COinS or "", 1, 4 ) == 'info' then
-- ok to wikilink
            OCinSids[ cfg.id_handlers[k].COinS ] = v;
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
        end
Series = make_internal_link (ChapterLink, Series, ChapterLinkorigin);
    end
-- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
end
URLobject = create_url_object (); -- unset
TransTitle = '';
ScriptTitle = '';
else -- now oddities that are cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if is_set (Series) and is_set (SeriesLink) then
Series = make_internal_link (SeriesLink, Series, A:ORIGIN ('SeriesLink'));
end
Series = wrap_style ('italic-title', Series); -- series is italicized
end
end
-- end of {{cite episode}} stuff


    local OCinStitle = "ctx_ver=" .. ctx_ver  -- such as "Z39.88-2004"
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
    for name,value in pairs(OCinSdata) do
if 'arxiv' == citation_class then
        OCinStitle = OCinStitle .. "&" .. name .. "=" .. mw.uri.encode( removewikilink(value) );
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
    end
append_error ('arxiv_missing', {}); -- add error message
    for _, value in ipairs(OCinSauthors) do
elseif is_set (Series) then -- series is an alias of version
        OCinStitle = OCinStitle .. "&rft.au=" .. mw.uri.encode( removewikilink(value) );
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
    end
Series = ''; -- unset
    for name,value in pairs(OCinSids) do
deprecated_parameter ('version'); -- deprecated parameter but only for cite arxiv
        OCinStitle = OCinStitle .. "&rft_id=" .. mw.uri.encode(name .. "/" .. removewikilink(value) );
end
    end
   
if first_set ({AccessDate, At, URLobject['format'], Page, Pages, PublisherName, URLobject['url'], -- a crude list of parameters that are not supported by cite arxiv
    OCinStitle = OCinStitle .. "&rfr_id=info:sid/" .. mw.site.server:match( "[^/]*$" ) .. ":"
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
      .. this_page.prefixedText  -- end COinS data by page's non-encoded pagename
ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']},27) then
append_error ('arxiv_params_not_supported', {}); -- add error message


    if (Periodical ~= nil and Periodical ~= "") and
AccessDate= ''; -- set these to empty string; not supported in cite arXiv
        (Chapter == nil or Chapter == '') and
PublisherName = ''; -- (if the article has been published, use cite journal, or other)
        (Title ~= nil and Title ~= "") then
URLobject = create_url_object ();
            Chapter = Title
Page = ''; Pages = ''; At = '';
            ChapterLink = TitleLink
end
            TransChapter = TransTitle
Periodical = 'arXiv'; -- periodical not allowed in cite arxiv; if article has been published, use cite journal
            Title = nil
-- set to arXiv for COinS; after that, must be set to empty string
            TitleLink = nil
end
            TransTitle = nil           
    end
-- legacy: promote concatenation of |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
if is_set (Year) then
Date = Year;
Dateorigin = A:ORIGIN ('Year'); -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
elseif is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate;
Dateorigin = A:ORIGIN ('PublicationDate'); -- promote PublicationDate to Date
PublicationDate = '';
end
else
if is_set (PublicationDate) and PublicationDate ~= Date then
PublicationDate = wrap_msg ('publication-date', PublicationDate, use_lowercase);
else
PublicationDate = ''; -- if PublicationDate is same as Date, don't display in rendered citation
end
end


    -- Now perform various field substitutions.
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
    -- We also add leading spaces and surrounding markup and punctuation to the
local anchor_year = validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, Dateorigin);
    -- various parts of the citation, but only when they are non-nil.
-- used in the CITEREF identifier
    if ( Authors == nil ) then
        local Maximum = tonumber( A['DisplayAuthors'] );
       
        -- Preserve old-style implicit et al.
        if Maximum == nil and #a == 9 then
            Maximum = 8;
            table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
        elseif Maximum == nil then
            Maximum = #a + 1;
        end
           
        local control = {
            sep = A["AuthorSeparator"] .. " ",
            namesep = (A["AuthorNameSeparator"] or A["NameSeparator"]) .. " ",
            format = A["AuthorFormat"],
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
        }
       
        -- If the coauthor field is also used, prevent ampersand and et al. formatting.
        if Coauthors ~= nil and Coauthors ~= "" then
            control.lastauthoramp = nil;
            control.maximum = #a + 1;
        end
               
        Authors = listpeople(control, a)
    end
    local EditorCount
    if ( Editors == nil ) then
        local Maximum = tonumber( A['DisplayEditors'] );


        -- Preserve old-style implicit et al.
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
        if Maximum == nil and #e == 4 then
-- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date
            Maximum = 3;
Embargo = is_embargoed (Embargo); --
            table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
        elseif Maximum == nil then
            Maximum = #e + 1;
        end


        local control = {
if citation_class == 'journal' and not is_set (URLobject['url']) and is_set (ID_list['PMC']) then
            sep = A["EditorSeparator"] .. " ",
if not is_set (Embargo) then -- if not embargoed or embargo has expired
            namesep = (A["EditorNameSeparator"] or A["NameSeparator"]) .. " ",
URLobject['url'] =cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
            format = A['EditorFormat'],
URLobject['origin'] = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
            maximum = Maximum,
end
            lastauthoramp = LastAuthorAmp
end
            }
if  not is_set (URLobject['url']) then
if in_array (citation_class, cfg.args_support['templates_requiring_url']) then
append_error ('cite_web_url', {});
end
-- Test if accessdate is given without giving a URL
if is_set (AccessDate) and not is_set (ChapterURLobject['url']) then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
append_error ('accessdate_missing_url', {});
AccessDate = '';
end
end


        Editors, EditorCount = listpeople(control, e)
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
    else
-- Test if citation has no title
        EditorCount = 1;
if not is_set (Title) and
    end
not is_set (TransTitle) and
    if ( Date == nil or Date == "") then
not is_set (ScriptTitle) then
--   there's something hinky with how this adds dashes to perfectly-good free-standing years
if 'episode' == citation_class then -- special case for cite episode; TODO: is there a better way to do this?
--[[        Date = Year
append_error ('citation_missing_title', {'series'});
        if ( Date ~= nil ) then
else
            local Month = args.month
append_error ('citation_missing_title', {'title'});
            if ( Month == nil ) then  
end
                local Began = args.began
end
                local Ended = args.ended
                if Began ~= nil and Ended ~= nil then
if 'none' == Title and citation_class == 'journal' then -- special case for journal cites
                    Month = Began .. "&ndash;" .. Ended
Title = ''; -- set title to empty string
                else
add_maint_cat ('untitled');
                    Month = "&ndash;"
end
                end
            end
            Date = Month .. " " .. Date
            local Day = args.day
            if ( Day ~= nil ) then Date = Day .. " " .. Date end
        end
]] -- so let's use the original version for now
        Date = Year
        if ( Date ~= nil and Date ~="") then
            local Month = A['Month']
            if ( Month ~= nil and Month ~= "") then  
                Date = Month .. " " .. Date
                local Day = A['Day']
                if ( Day ~= nil ) then Date = Day .. " " .. Date end
                else Month = ""
            end
            else Date = ""
        end
    end
    if ( PublicationDate == Date or PublicationDate == Year ) then PublicationDate = nil end
    if( (Date == nil or Date == "") and PublicationDate ~= nil ) then
        Date = PublicationDate;
        PublicationDate = nil;
    end  


-- test
check_for_external_link ({ -- add error message when any of these parameters contains a URL
do return PublicationDate .. '$' .. Date end
['title'] = Title,
[A:ORIGIN ('Chapter')] = Chapter,
[A:ORIGIN ('Periodical')] = Periodical,
[A:ORIGIN ('PublisherName')] = PublisherName,
});


    -- Captures the value for Date prior to adding parens or other textual transformations
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
    local DateIn = Date
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
   
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
    if ( URL == nil or URL == '' ) and
-- is the article title, and Chapter is a section within the article.  So, we remap
            ( ChapterURL == nil or ChapterURL == '' ) and
            ( ArchiveURL == nil or ArchiveURL == '' ) and              
local coins_chapter = Chapter; -- default assuming that remapping not required
            ( ConferenceURL == nil or ConferenceURL == '' ) and               
local coins_title = Title; -- et tu
            ( TranscriptURL == nil or TranscriptURL == '' ) then
if 'encyclopaedia' == citation_class then
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
coins_chapter = Title; -- remap
coins_title = Periodical;
end
end


        -- Test if cite web is called without giving a URL
-- this is the function call to COinS()
        if ( config.CitationClass == "web" ) then
local OCinSoutput = COinS ({
            table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
['Periodical'] = Periodical,
        end
['Encyclopedia'] = Encyclopedia,
['Chapter'] = coins_chapter,
['ScriptChapter'] = ScriptChapter,
['Map'] = Map,
['Degree'] = Degree; -- cite thesis only
['Title'] = coins_title,
['ScriptTitle'] = ScriptTitle,
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Season'] = COinS_date.rftssn,
['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['Pages'] = first_set ({Sheet, Sheets, Page, Pages, At}, 5),
['Edition'] = Edition,
['PublisherName'] = PublisherName,
['URL'] = first_set ({ChapterURLobject['url'], URLobject['url']}, 2),
['Authors'] = NameList,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);


        -- Test if accessdate is given without giving a URL
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
        if ( AccessDate ~= nil and AccessDate ~= '' ) then
if 'arxiv' == citation_class then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
Periodical = '';
            AccessDate = nil;
end
        end     
   
        -- Test if format is given without giving a URL
        if ( Format ~= nil and Format ~= '' ) then
            Format = Format .. seterror( 'format_missing_url' );
        end       
    end  


    -- Test if citation has no title
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
    if ( Chapter == nil or Chapter == "" ) and
if 'newsgroup' == citation_class then
            ( Title == nil or Title == "" ) and
if is_set (PublisherName) then
            ( Periodical == nil or Periodical == "" ) and
PublisherName = wrap_msg ('newsgroup', make_external_link ('news:' .. PublisherName, PublisherName, A:ORIGIN ('PublisherName')), use_lowercase);
            ( Conference == nil or Conference == "" ) and
end
            ( TransTitle == nil or TransTitle == "" ) and
end
            ( TransChapter == nil or TransChapter == "" ) then
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    end


    if ( Format ~= nil and Format ~="" ) then
-- Now perform various field substitutions.
        Format = " (" .. Format .. ")" else Format = "" end
-- We also add leading spaces and surrounding markup and punctuation to the
   
-- various parts of the citation, but only when they are non-nil.
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
    if ( ArchiveURL and "" < ArchiveURL ) then
-- an error message if the associated url is not set, or an empty string for concatenation
        if ( DeadURL ~= "no" ) then
format_format ({ArchiveURLobject, ConferenceURLobject, URLobject, LayURLobject, TranscriptURLobject, ChapterURLobject});
            URL = ArchiveURL
        end
-- special case for chapter format so no error message or cat when chapter not supported
    end
if format_url_access_text (URLobject, SubscriptionRequired, RegistrationRequired) then
select_one (args, {'url-access', 'urlaccess', 'registration', 'subscription'}, 'redundant_parameters');
end -- 只需其一
format_url_access_text (ChapterURLobject, nil, nil);


    -- Format chapter / article title
local OriginalURLobject; -- TODO: swap chapter and title here so that archive applies to most specific if both are set?
    if ( Chapter ~= nil and Chapter ~= "" ) and ( ChapterLink and "" < ChapterLink ) then
OriginalURLobject, URLobject, ChapterURLobject =
        Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
swap_urls (URLobject, ChapterURLobject, ArchiveURLobject, DeadURL);
    end
    if ( Periodical and "" < Periodical ) and (Title ~= nil and Title ~= "" ) then
local chapter_no_quotes = false; -- default assume that we will be quoting the chapter parameter value
        Chapter = wrap( 'italic-title', Chapter );
if is_set (Contribution) and has_contributors then -- if this is a contribution with contributor(s)
        TransChapter = wrap( 'trans-italic-title', TransChapter );
if in_array (Contribution:lower(), cfg.keywords['contribution']) then -- and a generic contribution title
    else
chapter_no_quotes = true; -- then render it unquoted
        Chapter = wrap( 'quoted-title', Chapter );
end
        TransChapter = wrap( 'trans-quoted-title', TransChapter );
end
    end
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURLobject, chapter_no_quotes, citation_class, TitleType, sepc);
   
-- Contribution is also in Chapter
    local TransError = ""
-- Format main title.
    if TransChapter ~= "" and Chapter == "" then
Title, URLobject = format_main_title (Title, TitleLink, TitleLinkorigin, ScriptTitle, TransTitle, URLobject, no_chapter_format, citation_class, Periodical);
        TransError = " " .. seterror( 'trans_missing_chapter' );
Place = pend_separator (wrap_msg ('written', Place, use_lowercase), sepc, false);
    end
Conference = format_conference (Conference, ConferenceURLobject, Periodical, citation_class, sepc);
   
local Insource_location = format_insource_location (Page, Pages, Sheet, Sheets, At, Minutes, Time, TimeCaption, Section, Sections, Inset, citation_class, Periodical_origin, sepc, NoPP, use_lowercase);
    if TransChapter ~= "" and Chapter ~= "" then TransChapter = " " .. TransChapter; end
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc
    Chapter = Chapter .. TransChapter
   
    if Chapter ~= "" then
        if ( ChapterLink == nil ) then
            if ( ChapterURL and "" < ChapterURL ) then               
                Chapter = externallink( ChapterURL, Chapter ) .. TransError;
                if URL == nil or URL == "" then
                    Chapter = Chapter .. Format;
                    Format = "";
                end
            elseif ( URL and "" < URL ) then
                Chapter = externallink( URL, Chapter ) .. TransError .. Format;
                URL = nil
                Format = ""
            else
                Chapter = Chapter .. TransError;
            end           
        elseif ChapterURL ~= nil and ChapterURL ~= "" then
            Chapter = Chapter .. " " .. externallink( ChapterURL ) ..
                TransError;
        else
            Chapter = Chapter .. TransError;
        end
        Chapter = Chapter .. sepc .. " " -- with end-space
    elseif ChapterURL ~= nil and ChapterURL ~= "" then
        Chapter = " " .. externallink( ChapterURL ) .. sepc .. " ";
    end       
   
    -- Format main title.
    if ( TitleLink and "" < TitleLink ) then
        if ( Title and "" < Title ) then
            Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
        end
    end


    if ( Periodical and "" < Periodical ) then
Others = pend_separator (Others, sepc, true);
        Title = wrap( 'quoted-title', Title );
Others = pend_separator (wrap_msg ('translated', Translators, use_lowercase), sepc, true) .. Others;
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    elseif ( config.CitationClass == "web"
if 'speech' ~= citation_class then  
            or config.CitationClass == "news"
TitleNote = pend_separator (TitleNote, sepc, true);
            or config.CitationClass == "pressrelease" ) and
end
            Chapter == "" then
        Title = wrap( 'quoted-title', Title );
Edition = wrap_msg ('edition', Edition, use_lowercase);
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
Series = pend_separator (Series, sepc, true);
    else
OrigYear = wrap_msg ('orig year', OrigYear, use_lowercase);
        Title = wrap( 'italic-title', Title );
Agency = pend_separator (Agency, sepc, true);
        TransTitle = wrap( 'trans-italic-title', TransTitle );
Volume = format_volume_issue (Volume, Issue, citation_class, Periodical_origin, sepc, use_lowercase);
    end
   
    local TransError = "";
    if TransTitle ~= "" and Title == "" then
        TransError = " " .. seterror( 'trans_missing_title' );
    end
   
    if TransTitle ~= "" and Title ~= "" then TransTitle = " " .. TransTitle; end
    Title = Title .. TransTitle
   
    if Title ~= "" then
        -- LOCAL
        if Title == 'zh' or Title:sub( 1, 3 ) == 'zh-' then
            Title = wikitextLC.converted( Title, { 'zh-hans', 'zh-hant' } )
        else
            Title = wikitextLC.raw( Title )
        end
        -- END LOCAL
        if ( TitleLink == nil and URL and "" < URL ) then
            Title = externallink( URL, Title ) .. TransError .. Format     
            URL = nil
            Format = ''
        else
            Title = Title .. TransError;
        end
    end


    if ( Place ~= nil and Place ~= "" ) then
------------------------------------ totally unrelated data
        if sepc == '.' then
            Place = " " .. wrap( 'written', Place ) .. sepc .. " ";
Via = wrap_msg ('via', Via, use_lowercase);
        else
AccessDate = format_accessdate (AccessDate, sepc, use_lowercase);
            Place = " " .. substitute( cfg.message_list['written']:lower(), {Place} ) .. sepc .. " ";
ID = format_id (ID, Docket, sepc, use_lowercase);
        end           
ID_list = build_id_list (ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class});
    else
        Place = "";
    end
   
    if ( Conference ~= nil and Conference ~="" ) then
        if ( ConferenceURL ~= nil ) then
            Conference = externallink( ConferenceURL, Conference );
        end
        Conference = " " .. Conference
    elseif ConferenceURL ~= nil and ConferenceURL ~= "" then
        Conference = " " .. externallink( ConferenceURL );
    else
        Conference = ""
    end
    if ( nil ~= Position or nil ~= Page or nil ~= Pages ) then At = nil end
    if ( nil == Position and "" ~= Position ) then
        local Minutes = A['Minutes'];
        if ( nil ~= Minutes ) then
            Position = " " .. Minutes .. " " .. cfg.message_list['minutes'];
        else
            local Time = A['Time'];
            if ( nil ~= Time ) then
                local TimeCaption = A['TimeCaption']
                if TimeCaption == nil then
                    TimeCaption = cfg.message_list['event'];
                    if sepc ~= '.' then
                        TimeCaption = TimeCaption:lower();
                    end
                end               
                Position = " " .. TimeCaption .. " " .. Time
            else
                Position = ""
            end
        end
    else
        Position = " " .. Position
    end
    if ( nil == Page or "" == Page ) then
        Page = ""
        if ( nil == Pages or "" == Pages) then
            Pages = ""
        elseif ( Periodical ~= nil and Periodical ~= "" and
                config.CitationClass ~= "encyclopaedia" and
                config.CitationClass ~= "web" and
                config.CitationClass ~= "book" and
                config.CitationClass ~= "news") then
            Pages = ": " .. Pages
        else
            if ( tonumber(Pages) ~= nil ) then
              Pages = sepc .." " .. PPrefix .. Pages .. PSuffix -- LOCAL
            else Pages = sepc .." " .. PPPrefix .. Pages .. PPSuffix -- LOCAL
            end
        end
    else
        Pages = ""
        if ( Periodical ~= nil and Periodical ~= "" and
            config.CitationClass ~= "encyclopaedia" and
            config.CitationClass ~= "web" and
            config.CitationClass ~= "book" and
            config.CitationClass ~= "news") then
            Page = ": " .. Page
        else
            Page = sepc .." " .. PPrefix .. Page .. PSuffix -- LOCAL
        end
    end
    if ( At ~= nil and At ~="") then At = sepc .. " " .. At
    else At = "" end
    if ( Coauthors == nil ) then Coauthors = "" end
    if ( Others ~= nil and Others ~="" ) then
        Others = sepc .. " " .. Others else Others = "" end
    if ( TitleType ~= nil and TitleType ~="" ) then
        TitleType = " (" .. TitleType .. ")" else TitleType = "" end
    if ( TitleNote ~= nil and TitleNote ~="" ) then
        TitleNote = sepc .. " " .. TitleNote else TitleNote = "" end
    if ( Language ~= nil and Language ~="" ) then
        -- LOCAL
        local languageTemplate = mw.title.new( Language, 'Template' )
        if languageTemplate and languageTemplate.exists then
            Language = ' ' .. frame:expandTemplate{ title = languageTemplate }
        else
            Language = " " .. wrap( 'language', Language )
        end
        -- END LOCAL
        else Language = "" end
    if ( Edition ~= nil and Edition ~="" ) then
        Edition = " " .. wrap( 'edition', Edition ) else Edition = "" end
    if ( Volume ~= nil and Volume ~="" )
    then
        if ( mw.ustring.len(Volume) > 4 )
          then Volume = sepc .." " .. Volume
          else Volume = " <b>" .. hyphentodash(Volume) .. "</b>"
        end
    else Volume = "" end
    if ( Issue ~= nil and Issue ~="" ) then
        Issue = " (" .. Issue .. ")" else Issue = "" end
    if ( Series ~= nil and Series ~="" ) then
        Series = sepc .. " " .. Series else Series = "" end
    if ( OrigYear ~= nil and OrigYear ~="" ) then
        OrigYear = " [" .. OrigYear .. "]" else OrigYear = "" end
    if ( Agency ~= nil and Agency ~="" ) then
        Agency = sepc .. " " .. Agency else Agency = "" end
    ------------------------------------ totally unrelated data
    if ( Date ~= nil ) then Date = Date else Date = "" end
    if ( Via ~= nil and Via ~="" ) then
        Via = " " .. wrap( 'via', Via ) else Via = "" end
    if ( AccessDate ~= nil and AccessDate ~="" )
    then local retrv_text = " " .. cfg.message_list['retrieved']
        if (sepc ~= ".") then retrv_text = retrv_text:lower() end
        AccessDate = '<span class="reference-accessdate">' .. sepc
            .. substitute( retrv_text, {AccessDate} ) .. '</span>'
    else AccessDate = "" end
    if ( SubscriptionRequired ~= nil and
        SubscriptionRequired ~= "" ) then
        SubscriptionRequired = sepc .. " " .. cfg.message_list['subscription'];
    else
        SubscriptionRequired = ""
    end
    if ( ID ~= nil and ID ~="") then ID = sepc .." ".. ID else ID="" end


    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN} );
local URL = '';
if is_set (URLobject['url']) then
URL = ' ' .. make_external_link (URLobject['url'], nil, URLobject['origin']) .. URLobject['access-text'];
end
local Format = URLobject['format'];
Quote = format_quote (Quote, sepc);
local Archived = format_archive (ArchiveURLobject, OriginalURLobject, ArchiveDate, DeadURL, sepc, use_lowercase);
local Lay = format_lay (LayURLobject, LayDate, LaySource, sepc, use_lowercase);
Transcript = format_external_link (Transcript, TranscriptURLobject, sepc);
local Publisher = format_publisher (PublisherName, PublicationPlace, Periodical, citation_class, sepc);


    if ( URL ~= nil and URL ~="") then
local use_in = is_set (Chapter) and (not has_contributors);
        URL = " " .. externallink( URL );
Authors, Editors, Contributors = format_people (Authors, Editors, Contributors, multiple_editors, use_in, sepc);
    else
        URL = ""
-- Several of the above rely upon detecting this as nil, so do it last.
    end
Periodical = format_periodical (Periodical, Title, TitleNote, sepc);


    if ( Quote and Quote ~="" ) then
-- Piece all bits together at lastHere, all should be non-nil.
        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
-- We build things this way because it is more efficient in LUA
            Quote = Quote:sub(2,-2);
-- not to keep reassigning to the same string variable over and over.
        end
       
        Quote = sepc .." " .. wrap( 'quoted-text', Quote );
        PostScript = ""
    else
        if ( PostScript == nil) then PostScript = "" end
        Quote = ""
    end
   
    local Archived
    if ( nil ~= ArchiveURL and "" ~= ArchiveURL ) then
        if ( ArchiveDate == nil or ArchiveDate =="" ) then
            ArchiveDate = seterror('archive_missing_date');
        end
        if ( "no" == DeadURL ) then
            local arch_text = cfg.message_list['archived'];
            if (sepc ~= ".") then arch_text = arch_text:lower() end
            Archived = sepc .. " " .. substitute( cfg.message_list['archived-not-dead'],
                { externallink( ArchiveURL, arch_text ), ArchiveDate } );
            if OriginalURL == nil or OriginalUrl == '' then
                Archived = Archived .. " " .. seterror('archive_missing_url');                             
            end
        else
            if OriginalURL ~= nil and OriginalURL ~= '' then
                local arch_text = cfg.message_list['archived-dead'];
                if (sepc ~= ".") then arch_text = arch_text:lower() end
                Archived = sepc .. " " .. substitute( arch_text,
                    { externallink( OriginalURL, cfg.message_list['original'] ), ArchiveDate } );
            else
                local arch_text = cfg.message_list['archived-missing'];
                if (sepc ~= ".") then arch_text = arch_text:lower() end
                Archived = sepc .. " " .. substitute( arch_text,
                    { seterror('archive_missing_url'), ArchiveDate } );
            end               
        end
    else
        Archived = ""
    end
    local Lay
    if ( nil ~= LaySummary and "" ~= LaySummary ) then
        if ( LayDate ~= nil ) then LayDate = " (" .. LayDate .. ")" else LayDate = "" end
        if ( LaySource ~= nil ) then
            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''"
        else
            LaySource = ""
        end
        if sepc == '.' then
            Lay = sepc .. " " .. externallink( LaySummary, cfg.message_list['lay summary'] ) .. LaySource .. LayDate
        else
            Lay = sepc .. " " .. externallink( LaySummary, cfg.message_list['lay summary']:lower() ) .. LaySource .. LayDate
        end           
    else
        Lay = ""
    end
    if ( nil ~= Transcript and "" ~= Transcript ) then
        if ( TranscriptURL ~= nil ) then Transcript = externallink( TranscriptURL, Transcript ) end
    elseif TranscriptURL ~= nil and TranscriptURL ~= "" then
        Transcript = externallink( TranscriptURL )   
    else
        Transcript = ""
    end
    local Publisher = ""
    if ( Periodical and Periodical ~= "" and
        config.CitationClass ~= "encyclopaedia" and
        config.CitationClass ~= "web" and
        config.CitationClass ~= "pressrelease" ) then
        if ( PublisherName ~= nil and PublisherName ~="" ) then
            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
                Publisher = PublicationPlace .. ": " .. PublisherName;
            else
                Publisher = PublisherName;  
            end           
        elseif (PublicationPlace ~= nil and PublicationPlace ~= '') then
            Publisher= PublicationPlace;
        else
            Publisher = "";
        end
        --[[ LOCAL
        if ( PublicationDate and PublicationDate ~="" ) then
            if Publisher ~= '' then
                Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
            else
                Publisher = PublicationDate;
            end
        end
        ]]
        if Publisher ~= "" then
            Publisher = " (" .. Publisher .. ")";
        end
    else
        --[[ LOCAL
        if ( PublicationDate and PublicationDate ~="" ) then
            PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")"
        else
            PublicationDate = ""
        end
        ]]
        if ( PublisherName ~= nil and PublisherName ~="" ) then
            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName -- LOCAL .. PublicationDate;
            else
                Publisher = sepc .. " " .. PublisherName -- LOCAL .. PublicationDate; 
            end           
        elseif (PublicationPlace ~= nil and PublicationPlace ~= '') then
            Publisher= sepc .. " " .. PublicationPlace -- LOCAL .. PublicationDate;
        else
            Publisher = '' -- LOCAL .. PublicationDate;
        end
    end
    -- Several of the above rely upon detecting this as nil, so do it last.
    if ( Periodical ~= nil and Periodical ~="" ) then
        if ( Title and Title ~= "" ) or ( TitleNote and TitleNote ~= "" ) then
            Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )
        else
            Periodical = wrap( 'italic-title', Periodical )
        end
    else Periodical = "" end


    -- Piece all bits together at last.  Here, all should be non-nil.
local tcommon;
    -- We build things this way because it is more efficient in LUA
local tcommon2; -- used for book cite when |contributor= is set
    -- not to keep reassigning to the same string variable over and over.
if citation_class == 'journal' and is_set (Periodical) then
Others = pend_separator (Others, sepc, false);
tcommon = safe_join ({Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Edition, Publisher, Agency}, sepc);
elseif contributors_valid then -- special cases for book cites where contributors are allowed
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc
tcommon = safe_join ({Title, TitleNote}, sepc); -- author and other stuff will come after this and before tcommon2
tcommon2 = safe_join ({Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
else
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
end
elseif 'map' == citation_class then -- special cases for cite map
if is_set (Chapter) then -- map in a book; TitleType is part of Chapter
tcommon = safe_join ({Title, Format, Edition, Scale, Series, Cartography, Others, Publisher, Volume}, sepc);
elseif is_set (Periodical) then -- map in a periodical
tcommon = safe_join ({Title, TitleType, Format, Periodical, Scale, Series, Cartography, Others, Publisher, Volume}, sepc);
else -- a sheet or stand-alone map
tcommon = safe_join ({Title, TitleType, Format, Edition, Scale, Series, Cartography, Others, Publisher}, sepc);
end
elseif 'episode' == citation_class then -- special case for cite episode
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Transcript, Edition, Publisher}, sepc);
else -- all other CS1 templates
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
end
if #ID_list > 0 then
ID_list = safe_join ({sepc .. ' ',  table.concat (ID_list, sepc .. ' '), ID}, sepc);
else
ID_list = ID;
end
-- LOCAL
local xDate;
if (is_set (Periodical) and is_set (Date) and
not in_array (citation_class, {'encyclopaedia', 'web'}))
or (in_array (citation_class, {'book', 'news'})) then
if in_array (citation_class, {'journal', 'citation'}) and is_set (Volume) then
xDate = safe_join ({Date .. ',' .. Volume, Insource_location, PublicationDate, OrigYear, AccessDate}, sepc);
else
xDate = safe_join ({Date, Insource_location, PublicationDate, OrigYear, AccessDate}, sepc);
end
Insource_location = ''
else
xDate = safe_join ({Date, PublicationDate, OrigYear, AccessDate}, sepc);
end
xDate = pend_separator (xDate, sepc, true);
-- END LOCAL


    local tcommon
local idcommon = safe_join ({URL, xDate, ID_list, Archived, Via, Lay, Language, Quote}, sepc);
    if ( ( (config.CitationClass == "journal") or (config.CitationClass == "citation") )  and
local text;
        Periodical ~= "" ) then
if is_set (Authors) then
        if (Others ~= "") then Others = Others .. sepc .. " " end
if is_set (Contributors) then
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,  
text = safe_join ({Contributors, Chapter, tcommon, Authors, Place, Editors, tcommon2, Insource_location, idcommon }, sepc);
            Edition, Publisher, Agency, Volume, Issue, Place, Position}, sepc ); -- LOCAL
else
    else  
text = safe_join ({Authors, Chapter, Place, Editors, tcommon, Insource_location, idcommon }, sepc);
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series,  
end
            Volume, Issue, Others, Edition, Publisher, Agency, Place, Position}, sepc ); -- LOCAL
else
    end
text = safe_join ({Editors, Chapter, Place, tcommon, Insource_location, idcommon}, sepc);
   
end
    if #ID_list > 0 then
        ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
if is_set (PostScript) and PostScript ~= sepc then
    else
text = safe_join ({text, sepc}, sepc); --Deals with italics, spaces, etc.
        ID_list = ID;
text = text:sub (1, -sepc:len()-1);
    end   
end
    -- LOCAL
    local xPublicationDate;
text = safe_join ({text, PostScript}, sepc);
    if PublicationDate and PublicationDate ~= '' then
        xPublicationDate = ' (' .. PublicationDate .. ') '
    else
        xPublicationDate = ''
    end
    -- END LOCAL
    local idcommon = safejoin( { ID_list, URL, Date .. xPublicationDate .. AccessDate, Archived, Via, SubscriptionRequired, Lay, Language, Quote }, sepc ); -- LOCAL


    local text
-- Now enclose the whole thing in a <cite/> element
    local pgtext = Page .. Pages .. At
return format_citation (text, config.CitationClass, Ref, NameList, anchor_year, OCinSoutput, no_tracking_cats);
   
end
    if ( "" ~= Authors ) then
        if (Coauthors ~= "")
          then Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
        end
        --[[ LOCAL
        if ( "" ~= Date )
          then Date = " ("..Date..")" .. OrigYear .. sepc .. " "
          else
        ]]
            if ( string.sub(Authors,-1,-1) == sepc) --check end character
              then Authors = Authors .. " "
              else Authors = Authors .. sepc .. " "
            end
        --[[ LOCAL
        end
        ]]
        if ( "" ~= Editors) then
            local in_text = " in "
            if (sepc == '.') then in_text = " In " end
            if (string.sub(Editors,-1,-1) == sepc)
                then Editors = in_text .. Editors .. " "
                else Editors = in_text .. Editors .. sepc .. " "
            end
        end
        text = safejoin( {Authors, Chapter, Editors, tcommon }, sepc ); -- LOCAL
        text = safejoin( {text, pgtext, idcommon}, sepc );
    elseif ( "" ~= Editors) then
        --[[ LOCAL
        if ( "" ~= Date ) then
            if EditorCount <= 1 then
                Editors = Editors .. ", " .. cfg.message_list['editor'];
            else
                Editors = Editors .. ", " .. cfg.message_list['editors'];
            end
            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
        else
        ]]
            if EditorCount <= 1 then
                Editors = Editors .. " (" .. cfg.message_list['editor'] .. ")" .. sepc .. " "
            else
                Editors = Editors .. " (" .. cfg.message_list['editors'] .. ")" .. sepc .. " "
            end
        --[[ LOCAL
        end
        ]]
        text = safejoin( {Editors, Chapter, tcommon}, sepc ); -- LOCAL
        text = safejoin( {text, pgtext, idcommon}, sepc );
    else
        --[[ LOCAL
        if ( "" ~= Date ) then
            if ( string.sub(tcommon,-1,-1) ~= sepc )
              then Date = sepc .." " .. Date .. OrigYear
              else Date = " " .. Date .. OrigYear
            end
        end -- endif ""~=Date
        ]]
        if ( config.CitationClass=="journal" and Periodical ) then
          text = safejoin( {Chapter, tcommon}, sepc ); -- LOCAL
          text = safejoin( {text, pgtext, idcommon}, sepc ); -- LOCAL
        else
          text = safejoin( {Chapter, tcommon}, sepc ); -- LOCAL
          text = safejoin( {text, pgtext, idcommon}, sepc );
        end
    end
   
    if PostScript ~= '' and PostScript ~= nil and PostScript ~= sepc then
        text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
        text = text:sub(1,-2); --Remove final seperator   
    end   
   
    text = safejoin( {text, PostScript}, sepc );


    -- Now enclose the whole thing in a <span/> element
--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
    if ( Year == nil ) then
Looks for a parameter's name in the whitelist.
        if ( DateIn ~= nil and DateIn ~= "" ) then
            Year = selectyear( DateIn )
        elseif( PublicationDate ~= nil and PublicationDate ~= "" ) then
            Year = selectyear( PublicationDate )
        else
            Year = ""
        end
    end
    local classname = "citation"
    if ( config.CitationClass ~= "citation" )
      then classname = "citation " .. (config.CitationClass or "") end
    local options = { class=classname }
    if ( Ref ~= nil ) then
        local id = Ref
        if ( "harv" == Ref ) then
            local names = {} --table of last names & year
            if ( "" ~= Authors ) then
                for i,v in ipairs(a) do
                    names[i] = v.last
                    if i == 4 then break end
                end
            elseif ( "" ~= Editors ) then
                for i,v in ipairs(e) do
                    names[i] = v.last
                    if i == 4 then break end               
                end
            end
            names[ #names + 1 ] = Year;
            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 options.id ~= nil then
        text = '<span id="' .. wikiescape(options.id) ..'" class="' .. wikiescape(options.class) .. '">' .. text .. "</span>";
    else
        text = '<span class="' .. wikiescape(options.class) .. '">' .. text .. "</span>";
    end       


    local empty_span = '<span style="display:none;">&nbsp;</span>';
Parameters in the whitelist can have three values:
   
true - active, supported parameters
    -- Note: Using display: none on then COinS span breaks some clients.
false - deprecated, supported parameters
    local OCinS = '<span title="' .. wikiescape(OCinStitle) .. '" class="Z3988">' .. empty_span .. '</span>';
nil - unsupported parameters
    text = text .. OCinS;
   
]]
    if #z.message_tail ~= 0 then
 
        text = text .. " ";
local function validate (name)
        for i,v in ipairs( z.message_tail ) do
local name = tostring (name);
            if v[1] ~= nil and v[1] ~= "" then  
local state = whitelist.basic_arguments[name];
                if i == #z.message_tail then
                    text = text .. errorcomment( v[1], v[2] );
-- Normal arguments
                else
if true == state then return true; end -- valid actively supported parameter
                    text = text .. errorcomment( v[1] .. "; ", v[2] );
if false == state then
                end
deprecated_parameter (name); -- parameter is deprecated but still supported
            end
return true;
        end
end
    end
   
-- Arguments with numbers in them
    no_tracking_cats = no_tracking_cats:lower();
name = name:gsub ('%d+', '#'); -- replace digit(s) with # (last25 becomes last#
    if no_tracking_cats == "" or no_tracking_cats == "no" or
state = whitelist.numbered_arguments[name];
            no_tracking_cats == "false" or no_tracking_cats == "n" then
if true == state then return true; end -- valid actively supported parameter
        for _, v in ipairs( z.error_categories ) do
if false == state then
            text = text .. '[[Category:' .. v ..']]';
deprecated_parameter (name); -- parameter is deprecated but still supported
        end
return true;
    end
end
   
    return text
return false; -- Not supported because not found or name is set to nil
end
end


-- This is used by templates such as {{cite book}} to create the actual citation text.
--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
function z.citation(frame)
    local pframe = frame:getParent()
   
    local args = {};
    local suggestions = {};
    local error_text, error_state;
    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 k == 'postscript' then
            args[k] = v;
        end       
    end   


    local config = {};
This is used by templates such as {{cite book}} to create the actual citation text.
    for k, v in pairs( frame.args ) do
 
        config[k] = v;
]]
        if args[k] == nil and (v ~= '' or k == 'postscript') then
 
            args[k] = v;
function citation (frame)
        end      
local pframe = frame:getParent();
    end  
local module_path = 'Module:Citation/CS1/'
   
local module_suffix = frame:getTitle():gsub ('^Module:Citation/CS1', '');
    return citation0( config, args, frame ) -- LOCAL
load_modules (module_path, module_suffix);
local args = {};
local suggestions = {};
local error_reported = false;
 
local config = {};
for k, v in pairs (frame.args) do
config[k] = v;
args[k] = v;  
end
 
local capture; -- the single supported capture when matching unknown parameters using patterns
for k, v in pairs (pframe.args) do
if v ~= '' then
if not validate (k) then
error_reported = false;
if type (k) ~= 'string' then
-- Exclude empty numbered parameters
if v:match ('%S+') ~= nil then
append_error ('text_ignored', {v});
error_reported = true;
end
elseif validate (k:lower()) then
append_error ('parameter_ignored_suggest', {k, k:lower()});
error_reported = true;
else
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
suggestions = mw.loadData (module_path .. 'Suggestions' .. module_suffix);
end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match
if capture then -- if the pattern matches
param = substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
append_error ('parameter_ignored_suggest', {k, param});
-- set the error message
error_reported = true;
break;
end
end
if not error_reported then -- couldn't match with a pattern, is there an expicit suggestion?
if suggestions.suggestions[k:lower()] ~= nil then
append_error ('parameter_ignored_suggest', {k, suggestions.suggestions[k:lower()]});
error_reported = true;
else
append_error ('parameter_ignored', {k});
error_reported = true;
end
end
end
end
args[k] = v;
elseif args[k] ~= nil or (k == 'postscript') then
args[k] = v;
end
end
local error_msg;
for k, v in pairs (args) do
if 'string' == type (k) then -- don't evaluate positional parameters
error_msg = has_invisible_chars (k, v);
if is_set (error_msg) then
append_error ('invisible_char', error_msg);
end
end
end
return do_citation (config, args)
end
end


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