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

imported>Liangent
无编辑摘要
imported>Antigng
修复显而易见的bug(无需共识)
 
(未显示18个用户的103个中间版本)
第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 cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
}
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist
 
local dates, year_date_check; -- functions in Module:Citation/CS1/Date_validation
local add_maint_cat, append_error, make_error_tail, reset_error, set_error, select_one, throw_error;     
-- 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
 
local function load_modules (module_path, module_suffix)
cfg = mw.loadData (module_path .. 'Configuration' .. module_suffix);
whitelist = mw.loadData (module_path .. 'Whitelist' .. module_suffix);
local validation = require (module_path .. 'Date_validation' .. module_suffix);
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);


-- Include translation message hooks, ID and error handling configuration settings.
utilities.set_selected_modules (cfg);
-- Note that require has tested to be significantly faster than loadData for this
links.set_selected_modules (utilities, errors);
-- usage. This might be a side effect of the unnecessary cloning described
errors.set_selected_modules (cfg, utilities, links);
-- in bugzilla 47300.
identifiers.set_selected_modules (cfg, utilities, errors, links, validation);
local cfg = require( 'Module:Citation/CS1/Configuration' );
people.set_selected_modules (cfg, utilities, errors, links);
coins.set_selected_modules (cfg, utilities, links);
languages.set_selected_modules (utilities, errors);


-- Contains a list of all recognized parameters
dates = validation.dates; -- imported functions
local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
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;


-- LOCAL
function is_zh( str )
    return not not str:find( '[\128-\255]' )
end
end
-- END LOCAL


-- Whether variable is set or not
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
function is_set( var )
 
    return not (var == nil or var == '');
Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
offending parameter name to the error message. 
 
]]
 
local function deprecated_parameter (name)
append_error ('deprecated_params', {name});
end
end


-- First set variable or nil if none
--[[--------------------------< D I S C A R D _ P A R A M E T E R >--------------------------------------------
function first_set(...)
 
    local list = {...};
]]
    for _, var in pairs(list) do
 
        if is_set( var ) then
local function discard_parameter (name, label, new_value)
            return var;
if is_set (name) then
        end
append_error ('parameter_discarded', label);
    end
end
return new_value;
end
end


-- Whether needle is in haystack
--[[--------------------------< S A N I T I Z E D _ P A R A M E T E R _ V A L U E >------------------------
function inArray( needle, haystack )
 
    if needle == nil then
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
        return false;
of allowable values (e.g. yes, y, true, no, etc). If the parameter value is empty or is in the list of allowed values,
    end
the function returns the value; else, it emits an error message and returns the default value.
    for n,v in ipairs( haystack ) do
 
        if v == needle then
]]
            return n;
 
        end
local function sanitized_parameter_value (value, name, key, default)
    end
if not is_set (value) then
    return false;
return value; -- an empty parameter is ok
elseif in_array (value:lower(), cfg.keywords[key]) then
return value;
else
append_error ('invalid_param_val', {name, value}); -- not an allowed value so add error message
return default;
end
end
end


-- Populates numbered arguments in a message string using an argument table.
--[[--------------------------< 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 substitute( msg, args )
 
    return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
]]
 
local function extra_text_in_parameter_check (value, type)
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


-- Wraps a string using a message_list configuration taking one argument
--[[--------------------------< V A L I D A T E _ D A T E >-------------------------------------------------------
function wrap( key, str )
 
    if not is_set( str ) then
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
        return "";
we get the date used in the metadata.
    elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
 
        str = safeforitalics( str );
Date validation supporting code is in Module:Citation/CS1/Date_validation
    end
]]
    return substitute( cfg.messages[key], {str} );
 
local function validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, origin)
local error_message = '';
-- 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,
['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year}, COinS_date);
 
if is_set (Year) then
if is_set (Date) then -- both |date= and |year= not normally needed;  
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
 
if is_set (error_message) then
append_error ('bad_date', {error_message}); -- add this error message
end
return anchor_year;
end
end


--[[
--[[--------------------------< D I S C A R D _ C H A P T E R >-------------------------------------------------------
Argument wrapper.  This function provides support for argument
仅为保持兼容性而设置。理论上可以直接调用discard_parameter()丢弃相关参数。
mapping defined in the configuration file so that multiple names
can be transparently aliased to single internal variable.
]]
]]
function argument_wrapper( args )
    local origin = {};
local function discard_chapter (args)
   
local chap_param;
    return setmetatable({
if is_set (args['Chapter']) then -- get a parameter name from one of these chapter related meta-parameters
        ORIGIN = function( self, k )
chap_param = args:ORIGIN ('Chapter');
            local dummy = self[k]; --force the variable to be loaded.
elseif is_set (args['TransChapter']) then
            return origin[k];
chap_param = args:ORIGIN ('TransChapter');
        end
elseif is_set (args['ChapterURL']) then
    },
chap_param = args:ORIGIN ('ChapterURL');
    {
elseif is_set (args['ScriptChapter']) then
        __index = function ( tbl, k )
chap_param = args:ORIGIN ('ScriptChapter')
            if origin[k] ~= nil then
elseif is_set (args['ChapterFormat']) then
                return nil;
chap_param = args:ORIGIN ('ChapterFormat')
            end
elseif is_set (args['ChapterUrlAccess']) then
           
chap_param = args:ORIGIN ('ChapterUrlAccess')
            local args, list, v = args, cfg.aliases[k];
end
           
if is_set (chap_param) then -- if we found one
            if list == nil then
append_error ('chapter_ignored', {chap_param}); -- add error message
                error( cfg.messages['unknown_argument_map'] );
end
            elseif type( list ) == 'string' then
                v, origin[k] = args[list], list;
            else
                v, origin[k] = selectone( args, list, 'redundant_parameters' );
                if origin[k] == nil then
                    origin[k] = '';  --Empty string, not nil;
                end
            end
           
            if v == nil then
                v = cfg.defaults[k] or "";
                origin[k] = '';  --Empty string, not nil;
            end
           
            tbl = rawset( tbl, k, v );
            return v;
        end,
    });
end
end


-- Checks that parameter name is valid using the whitelist
--[[--------------------------< C R E A T E _ U R L _ O B J E C T >------------------------------------------
function validate( name )
 
    name = tostring( name );
]]
   
 
    -- Normal arguments
local function create_url_object (url, source, fmt, fmt_source, access, access_source)
    if whitelist.basic_arguments[ name ] then
return {
        return true;
['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 '',
    -- Arguments with numbers in them
['access-origin'] = is_set (access_source) and access_source or '',
    name = name:gsub( "%d+", "#" );
['format'] = is_set (fmt) and fmt or '',
    if whitelist.numbered_arguments[ name ] then
['format-origin'] = is_set (fmt_source) and fmt_source or '',
        return true;
['access-text'] = ''
    end
}
   
    -- Not found, argument not supported.
    return false
end
end


-- Formats a comment for error trapping
--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
function errorcomment( content, hidden )
 
    return wrap( hidden and 'hidden-error' or 'visible-error', content );
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
 
]]
 
local function set_titletype (cite_class, title_type)
if 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


--[[
--[[--------------------------< S E T _ N O _ T R A C K I N G _ C A T S >-----------------------------------------
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.
check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
 
]]
]]
function seterror( error_id, arguments, raw, prefix, suffix )
 
    local error_state = cfg.error_conditions[ error_id ];
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);
    prefix = prefix or "";
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
    suffix = suffix or "";
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
   
return true; -- set no_tracking_cats
    if error_state == nil then
end
        error( cfg.messages['undefined_error'] );
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
    elseif is_set( error_state.category ) then
if this_page.text:match (v) then -- test page name against each pattern
        table.insert( z.error_categories, error_state.category );
return true; -- set no_tracking_cats; bail out if one is found
    end
end
   
end
    local message = substitute( error_state.message, arguments );
return false;
   
else
    message = message .. " ([[" .. cfg.messages['help page link'] ..
return true;
        "#" .. error_state.anchor .. "|" ..
end
        cfg.messages['help page label'] .. "]])";
   
    z.error_ids[ error_id ] = true;
    if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
            and z.error_ids['citation_missing_title'] then
        return '', false;
    end
   
    message = table.concat({ prefix, message, suffix });
   
    if raw == true then
        return message, error_state.hidden;
    end      
       
    return errorcomment( message, error_state.hidden );
end
end


-- Formats a wiki style external link
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
function externallinkid(options)
 
    local url_string = options.id;
Set style settings for CS1 citation templates. Returns separator and postscript settings
    if options.encode == true or options.encode == nil then
 
        url_string = mw.uri.encode( url_string );
]]
    end
 
    return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
local function set_cs1_style (ps)
        options.link, options.label, options.separator or "&nbsp;",
if not is_set (ps) then -- unless explicitely set to something
        options.prefix, url_string, options.suffix or "",
ps = '.'; -- terminate the rendered citation with a period
        mw.text.nowiki(options.id)
end
    );
return '.', ps; -- separator is a full stop
end
end


-- Formats a wiki style internal link
--[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------
function internallinkid(options)
 
    return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
        options.link, options.label, options.separator or "&nbsp;",
 
        options.prefix, options.id, options.suffix or "",
]]
        mw.text.nowiki(options.id)
 
    );
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


-- Format an external link with error checking
--[[--------------------------< 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 externallink( URL, label, source )
 
    local error_str = "";
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
    if not is_set( label ) then
rendered style.
        label = URL;
 
        if is_set( source ) then
]]
            error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
 
        else
local function get_settings_from_cite_class (ps, ref, cite_class)
            error( cfg.messages["bare_url_no_origin"] );
local sep;
        end           
if (cite_class == 'citation') then -- for citation templates (CS2)
    end
sep, ps, ref = set_cs2_style (ps, ref);
    if not checkurl( URL ) then
else -- not a citation template so CS1
        error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
sep, ps = set_cs1_style (ps);
    end
end
    return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
 
return sep, ps, ref -- return them all
end
end


-- Formats a link to Amazon
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
function amazon(id, domain)
 
    if not is_set(domain) then
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
        domain = "com"
config.CitationClass from the template's #invoke: to establish style.
    elseif ( "jp" == domain or "uk" == domain ) then
 
        domain = "co." .. domain
]]
    end
 
    local handler = cfg.id_handlers['ASIN'];
local function set_style (mode, mode_source, ps, ref, quote, cite_class)
    return externallinkid({link = handler.link,
local sep;
        label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
mode = sanitized_parameter_value (mode, mode_source, 'mode', ''):lower();
        encode=handler.encode, separator = handler.separator})
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
sep, ps, ref = set_cs2_style (ps, ref);
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
sep, ps = set_cs1_style (ps);
else -- anything but cs1 or cs2
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass
end
if 'none' == ps:lower() or is_set (quote) then -- if assigned value is 'none' then set it to empty string
ps = ''; -- also cs1|2 does not supply terminal punctuation when |quote= is set
end
return sep, ps, ref
end
end


-- Formats a DOI and checks for DOI errors.
--[[--------------------------< S W A P _ U R L S >--------------------------------------------------------------
function doi(id, inactive)
 
    local cat = ""
]]
    local handler = cfg.id_handlers['DOI'];
 
   
local function swap_urls (url_object, chapter_url_object, archive_url_object, dead_url)
    local text;
local original_url_object = create_url_object ();
    if is_set(inactive) then
local is_dead = in_array (dead_url, cfg.keywords['deadurl-live']); -- used later when assembling archived text
        text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
        table.insert( z.error_categories, "Pages with DOIs inactive since " .. selectyear(inactive) );       
if is_set (archive_url_object['url']) then
        inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
if is_set (url_object['url']) then
    else
original_url_object = url_object;
        text = externallinkid({link = handler.link, label = handler.label,
if not is_dead then
            prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
url_object = archive_url_object;
        inactive = ""
end
    end
elseif is_set (chapter_url_object['url']) then -- URL not set so if chapter-url is set apply archive url to it
    if ( string.sub(id,1,3) ~= "10." ) then    
original_url_object = chapter_url_object;
        cat = seterror( 'bad_doi' );
if not is_dead then
    end
chapter_url_object = archive_url_object;
    return text .. inactive .. cat
end
end
end
return original_url_object, url_object, chapter_url_object;
end
end


-- Formats an OpenLibrary link, and checks for associated errors.
--[[--------------------------< F O R M A T  _ U R L _ A C C E S S _ T E X T >---------------------------------------
function openlibrary(id)
 
    local code = id:sub(-1,-1)
从x-url-access系列参数生成相应的图标;兼容既有registration, subscription参数,优先级x-url-access > subscription > registration。
    local handler = cfg.id_handlers['OL'];
 
    if ( code == "A" ) then
]]
        return externallinkid({link=handler.link, label=handler.label,
 
            prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
local function format_url_access_text (url_object, subscription_required, registration_required)
            encode = handler.encode})
local access_text = '';
    elseif ( code == "M" ) then
local redundant = false;
        return externallinkid({link=handler.link, label=handler.label,
local access = url_object['access'];
            prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
local reg = false;
            encode = handler.encode})
local sub = false;
    elseif ( code == "W" ) then
if is_set (access) then
        return externallinkid({link=handler.link, label=handler.label,
if (access == 'limited') then
            prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
access_text = cfg.presentation['limited']; -- 有限度免费访问
            encode = handler.encode})
elseif (access == 'registration') then
    else
access_text = cfg.presentation['registration']; -- 需要免费注册
        return externallinkid({link=handler.link, label=handler.label,
reg = true;
            prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
elseif (access == 'subscription') then
            encode = handler.encode}) ..
access_text = cfg.presentation['subscription']; -- 需要付费订阅
            ' ' .. seterror( 'bad_ol' );
sub = true;
    end
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


--[[
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------
Determines whether an URL string is valid
 
returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
or formatted issue, or an empty string if neither are set.


At present the only check is whether the string appears to
be prefixed with a URI scheme.  It is not determined whether
the URI scheme is valid or whether the URL is otherwise well
formed.
]]
]]
function checkurl( url_str )
    -- Protocol-relative or URL scheme
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
    return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
if not is_set (volume) and not is_set (issue) then
return '';
end
if 'magazine' == cite_class or (cite_class =='map' and 'magazine' == origin) then
if is_set (volume) and is_set (issue) then
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
elseif is_set (volume) then
return wrap_msg ('vol', {sepc, volume}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end
local vol = '';
if is_set (volume) then
if (6 < mw.ustring.len (volume)) then
vol = wrap_msg ('j-vol', {sepc, volume}, lower);
else
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


-- Removes irrelevant text and dashes from ISBN number
--[[-------------------------< F O R M A T _ I N S O U R C E _ L O C A T I O N >----------------------------------
-- Similar to that used for Special:BookSources
 
function cleanisbn( isbn_str )
Build insource_location meta-parameter from |page(s)= , |sheet(s)= , |at= and other relevant parameters.
    return isbn_str:gsub( "[^-0-9X]", "" );
 
]]
 
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


-- Determines whether an ISBN string is valid
--[[-------------------------< F O R M A T _ P U B L I S H E R >------------------------------------------
function checkisbn( isbn_str )
 
    isbn_str = cleanisbn( isbn_str ):gsub( "-", "" );
]]
    local len = isbn_str:len();
 
local function format_publisher (publisher_name, publication_place, periodical, cite_class, sepc)
    if len ~= 10 and len ~= 13 then
local publisher = '';
        return false;
    end
if is_set (publisher_name) then
if is_set (publication_place) then
    local temp = 0;
publisher = publication_place .. ': ' .. publisher_name;
    if len == 10 then
else
        if isbn_str:match( "^%d*X?$" ) == nil then return false; end
publisher = publisher_name;
        isbn_str = { isbn_str:byte(1, len) };
end
        for i, v in ipairs( isbn_str ) do
elseif is_set (publication_place) then
            if v == string.byte( "X" ) then
publisher = publication_place;
                temp = temp + 10*( 11 - i );
end
            else
                temp = temp + tonumber( string.char(v) )*(11-i);
if is_set (publisher) then
            end
if is_set (periodical) and
        end
not in_array (cite_class, {'encyclopaedia', 'web', 'pressrelease', 'podcast'}) then
        return temp % 11 == 0;
publisher = ' (' .. publisher .. ')';
    else
else
        if isbn_str:match( "^%d*$" ) == nil then return false; end
publisher = pend_separator (publisher, sepc, true);
        isbn_str = { isbn_str:byte(1, len) };
end
        for i, v in ipairs( isbn_str ) do
end
            temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
return publisher;
        end
        return temp % 10 == 0;
    end
end
end


-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
--[[-------------------------< F O R M A T _ L I N K >-------------------------------------------------
function removewikilink( str )
 
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
Format an external link that may or may not be raw.
        return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
 
    end));
]]
 
local function format_external_link (text, url_object, sepc)
if is_set (text) then
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


-- Escape sequences for content that will be used for URL descriptions
--[[-------------------------< F O R M A T _ C O N F E R E N C E >----------------------------------------
function safeforurl( str )
 
    do return str end -- LOCAL HACK https://en.wikipedia.org/w/index.php?title=Module_talk:Citation/CS1&diff=552318417&oldid=552202448
]]
    if str:match( "%[%[.-%]%]" ) ~= nil then
 
        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
local function format_conference (conference, conference_url_object, periodical, cite_class, sepc)
    end
local  conf_text = format_external_link (conference, conference_url_object, sepc);
   
if 'speech' == cite_class and is_set (periodical) then
    return str:gsub( '[%[%]\n]', {   
-- if cite speech, periodical (perhaps because of an included |website= or |journal= parameter) is set;  
        ['['] = '&#91;',
conf_text = pend_separator (conf_text, sepc, false); -- then add appropriate punctuation to the end of the conference variable if set.
        [']'] = '&#93;',
end
        ['\n'] = ' ' } );
return conf_text;
end
end


-- Converts a hyphen to a dash
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
function hyphentodash( str )
 
    if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
        return str;
parameter (chapter_url_source used for error messages).
    end  
 
    return str:gsub( '-', '' );
]]
 
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
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
--[[--------------------------< F O R M A T _ M A I N _ T I T L E >------------------------------------------
function safeforitalics( str )
 
    --[[ Note: We can not use <i> for italics, as the expected behavior for
Format the five title parameters: |script-title=, |title=, |trans-title=, |title-link=, and |url= into a single Title meta-
    italics specified by ''...'' in the title is that they will be inverted
parameter (url_origin and title_link_origin used for error messages).
    (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
 
    tend to interact poorly under Mediawiki's HTML tidy. ]]
]]
   
 
    if not is_set(str) then
local function format_main_title (title, title_link, title_link_origin, script_title, trans_title, url_object, no_chapter_format, cite_class, periodical)
        return str;
if is_set (title_link) and is_set (title) then
    else
title = make_internal_link (title_link, title, title_link_origin);
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
end
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; 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
        -- Remove newlines as they break italics.
title = kern_quotes (title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
        return str:gsub( '\n', ' ' );
title = wrap_style ('quoted-title', title);
    end
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
end


--[[
--[[--------------------------< F O R M A T  _ F O R M A T >--------------------------------------------------------
Joins a sequence of strings together while checking for duplicate separation
 
characters.
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.
 
]]
]]
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_format (args)
                    if value ~= comp then  
for _, url_object in pairs (args) do
                        local dup2 = duplicate_char;
if is_set (url_object['format']) then
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
url_object['format'] = wrap_style ('format', url_object['format']); -- add leading space, parenthases, resize
                       
if not is_set (url_object['url']) then
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
url_object['format'] = url_object['format'] .. set_error ('format_missing_url', {url_object['format-origin'], url_object['origin']});
                    else
-- add an error message
                        value = value:sub( 2, -1 );
end
                    end
elseif is_set (url_object['url']) then
                end
if url_object['url']:match ('%.pdf[%?#]?') or url_object['url']:match ('%.PDF[%?#]?') then
            end
-- format is not set so if url is a pdf file then
            str = str .. value;
url_object['format'] = wrap_style ('format', 'PDF'); -- set format to pdf
        end
end
    end
end
    return str;
end
end 
end
 
--[[--------------------------< F O R M A T _ A C C E S S D A T E >----------------------------------------------


--[[
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_accessdate (accessdate, sepc, lower)
    local num = tonumber( str );  
if is_set (accessdate) then -- first, wrap in nowrap span if date in appropriate format
    if num ~= nil and num > 0 and num < 2100 and num == math.floor(num) then
if accessdate:match ('^%d%d%d%d%-%d%d%-%d%d$') then
        return str;
accessdate = wrap_style ('nowrap1', accessdate); -- when accessdate is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
    else
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
        -- Use formatDate to interpret more complicated formats
local cap, cap2 = string.match (accessdate, '^(.*)%s+(%d%d%d%d)$');
        local lang = mw.getContentLanguage();
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
        local good, result;
end
        good, result = pcall( lang.formatDate, lang, 'Y', str )
accessdate = ' ' .. wrap_msg ('retrieved', accessdate, lower); -- add retrieved text
        if good then
accessdate = wrap_style ('accessdate', {sepc, accessdate}); -- allow editors to hide accessdates
            return result;
end
        else
return accessdate;
            -- 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 _ I D >----------------------------------------------------
function reducetoinitials(first)
]]
    local initials = {}
 
    for word in string.gmatch(first, "%S+") do
local function format_id (id, docket, sepc, lower)
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
id = pend_separator (id, sepc, true);
    end
return pend_separator (wrap_msg ('docket', docket, lower), sepc, true) .. id;
    return table.concat(initials) -- Vancouver format does not include spaces.
end
end


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


    local count = #text / 2;
local function format_quote (quote, sepc)
    if count > 0 then  
if is_set (quote) then
        if count > 1 and is_set(lastauthoramp) and not etal then
if quote:sub (1, 1) == '"' and quote:sub (-1, -1) == '"' then -- if first and last characters of quote are quote marks
            text[#text-2] = " & ";
quote = quote:sub (2, -2); -- strip them off
        end
end
        text[#text] = nil;
return pend_separator (wrap_style ('quoted-text', quote), sepc, true); -- wrap in <q>...</q> tags
    end
end
   
return '';
    local result = table.concat(text) -- construct list
    if etal then
        local etal_text = is_zh( result ) and cfg.messages['et al'] or '<i>et al</i>.'; -- LOCAL
        result = result .. " " .. etal_text;
    end
   
    -- if necessary wrap result in <span> tag to format in Small Caps
    if ( "scap" == format ) then result =
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    end  
    return result, count
end
end


-- Generates a CITEREF anchor ID.
--[[--------------------------< F O R M A T _ A R C H I V E >------------------------------------------
function anchorid( options )
 
    return "CITEREF" .. table.concat( options );
]]
 
local function format_archive (archive_url_object, original_url_object, archive_date, dead_url, sepc, lower)
local archived = '';
if is_set (archive_url_object['url']) then
if not is_set (archive_date) then
archive_date = set_error ('archive_missing_date');
end
if in_array (dead_url, cfg.keywords['deadurl-live']) then
local arch_text = cfg.messages['archived'];
if (lower) then arch_text = arch_text:lower(); end;
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);
if not is_set (original_url_object['url']) then
archived = archived .. ' ' .. set_error ('archive_missing_url');  
end
elseif is_set (original_url_object['url']) then -- dead_url is not live, so it should be empty, dead or unfit
if in_array (dead_url, cfg.keywords['deadurl-unfit']) then
archived = pend_separator (wrap_msg('archived-unfit', archive_date, lower), sepc, true);
-- format already styled
else -- dead_url is empty or dead
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


-- Gets name list from the input arguments
--[[--------------------------< F O R M A T _ L A Y >---------------------------------------------------
function extractnames(args, list_name)
 
    local names = {};
]]
    local i = 1;
 
    local last;
local function format_lay (lay_url_object, lay_date, lay_source, sepc, lower)
   
local lay = '';
    while true do
if is_set (lay_url_object['url']) then
        last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
if is_set (lay_date) then lay_date = ' (' .. lay_date .. ')' end
        if not is_set(last) then
if is_set (lay_source) then  
            -- just in case someone passed in an empty parameter
lay_source = wrap_msg ('lay source', lay_source, lower);
            break;
else
        end
lay_source = '';
        names[i] = {
end
            last = last,
local lay_sum = cfg.messages['lay summary'];
            first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
if lower then
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
lay_sum = lay_sum:lower();
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
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);
        i = i + 1;
else -- Test if |lay-format= is given without giving a |lay-url=
    end
lay = pend_separator (lay_url_object['format'], sepc, true); -- if set and LayURL not set, then LayFormat has error message
    return names;
end
return lay;
end
end


-- Populates ID table from arguments using configuration settings
--[[--------------------------< F O R M A T _ P E R I O D I C A L >------------------------------------
function extractids( args )
]]
    local id_list = {};
 
    for k, v in pairs( cfg.id_handlers ) do   
local function format_periodical (periodical, title, title_note, sepc)
        v = selectone( args, v.parameters, 'redundant_parameters' );
if is_set (periodical) then
        if is_set(v) then id_list[k] = v; end
if is_set (title) or is_set (title_note) then
    end
return pend_separator (wrap_style ('italic-title', periodical), sepc, true);
    return id_list;
else
return wrap_style ('italic-title', periodical);
end
end
return '';
end
end


-- Takes a table of IDs and turns it into a table of formatted ID outputs.
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
function buildidlist( id_list, options )
 
    local new_list, handler = {};
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
   
 
    function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
namelist is one of the contributor-, author-, or editor-name lists chosen in that order.  year is Year or anchor_year.
   
 
    for k, v in pairs( id_list ) do
]]
        -- fallback to read-only cfg
 
        handler = setmetatable( { ['id'] = v }, fallback(k) );
local function anchor_id (namelist, year)
       
local names={}; -- a table for the one to four names and year
        if handler.mode == 'external' then
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
            table.insert( new_list, {handler.label, externallinkid( handler ) } );
names[i] = v.last
        elseif handler.mode == 'internal' then
if i == 4 then break end -- if four then done
            table.insert( new_list, {handler.label, internallinkid( handler ) } );
end
        elseif handler.mode ~= 'manual' then
table.insert (names, year); -- add the year at the end
            error( cfg.messages['unknown_ID_mode'] );
local id = table.concat (names); -- concatenate names and year for CITEREF id
        elseif k == 'DOI' then
if is_set (id) then -- if concatenation is not an empty string
            table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
return 'CITEREF' .. id; -- add the CITEREF portion
        elseif k == 'ASIN' then
else
            table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
return ''; -- return an empty string; no reason to include CITEREF id in this citation
        elseif k == 'OL' then
end
            table.insert( new_list, {handler.label, openlibrary( v ) } );
        elseif k == 'ISBN' then
            local ISBN = internallinkid( handler );
            if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
                ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
            end
            table.insert( new_list, {handler.label, ISBN } );              
        else
            error( cfg.messages['unknown_manual_ID'] );
        end
    end
   
    function comp( a, b )
        return a[1] < b[1];
    end
   
    table.sort( new_list, comp );
    for k, v in ipairs( new_list ) do
        new_list[k] = v[2];
    end
   
    return new_list;
end
end
 
 
-- Chooses one matching parameter from a list of parameters to consider
--[[--------------------------< F O R M A T _ C I T A T I O N >--------------------------------------------
-- Generates an error if more than one match is present.
 
function selectone( args, possible, error_condition, index )
]]
    local value = nil;
 
    local selected = '';
local function format_citation (body, cite_class, ref, namelist, year, ocins_output, no_tracking_cats)
    local error_list = {};
local options = {};
   
    if index ~= nil then index = tostring(index); 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=
    -- Handle special case of "#" replaced by empty string
else
    if index == '1' then
options.class = 'citation';
        for _, v in ipairs( possible ) do
end
            v = v:gsub( "#", "" );
            if is_set(args[v]) then
if is_set (ref) and ref:lower() ~= 'none' then -- set reference anchor if appropriate
                if value ~= nil and selected ~= v then
local id = ref
                    table.insert( error_list, v );
if ('harv' == ref ) then
                else
id = anchor_id (namelist, year); -- go make the CITEREF anchor
                    value = args[v];
end
                    selected = v;
options.id = id;
                end
end
            end
        end       
if string.len (body:gsub ('<span[^>/]*>.-</span>', ''):gsub ('%b<>','')) <= 2 then
    end
reset_error ({'err_cats'});
   
body = set_error ('empty_citation');
    for _, v in ipairs( possible ) do
reset_error ({'msg_tail'});
        if index ~= nil then
end
            v = v:gsub( "#", index );
        end
local text;
        if is_set(args[v]) then
            if value ~= nil and selected ~= v then
if is_set (options.id) then
                table.insert( error_list, v );
text = wrap_style ('citation-with-id', {mw.uri.anchorEncode (options.id), mw.text.nowiki (options.class), body});
            else
else
                value = args[v];
text = wrap_style ('citation-no-id', {mw.text.nowiki (options.class), body});
                selected = v;
end
            end
        end
text = text .. wrap_style ('OCinS', ocins_output);
    end
text = text .. make_error_tail (no_tracking_cats); -- append error/maintenance messages/categories to the citation
   
    if #error_list > 0 then
return text;
        local error_str = "";
        for _, k in ipairs( error_list ) do
            if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
            error_str = error_str .. wrap( 'parameter', k );
        end
        if #error_list > 1 then
            error_str = error_str .. cfg.messages['parameter-final-separator'];
        else
            error_str = error_str .. cfg.messages['parameter-pair-separator'];
        end
        error_str = error_str .. wrap( 'parameter', selected );
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    end
   
    return value, selected;
end
end


-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
--[[--------------------------< D E D U C E _ C I T A T I O N _ C L A S S >--------------------------------------
-- the citation information.
 
function COinS(data)
如果citation_class为citation({{citation}}),根据periodical系列参数的设置情况推断实际的引用类型。
    if 'table' ~= type(data) or nil == next(data) then
 
        return '';
]]
    end
 
   
local function deduce_citation_class (A, naive_class)
    local ctx_ver = "Z39.88-2004";
local deduced_class;
   
local periodical = A['Periodical'];
    -- treat table strictly as an array with only set values.
local origin = A:ORIGIN ('Periodical');
    local OCinSoutput = setmetatable( {}, {
        __newindex = function(self, key, value)
for cite_class, aliases in pairs (cfg.periodical.parameters) do
            if is_set(value) then
if cite_class ~= '_general' then
                rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
for _, aliase in pairs (aliases) do
            end
if origin == aliase then
        end
deduced_class = cite_class;
    });
end
   
end
    if is_set(data.Chapter) then
end
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
end
        OCinSoutput["rft.genre"] = "bookitem";
        OCinSoutput["rft.btitle"] = data.Chapter;
if (naive_class == 'citation') then
        OCinSoutput["rft.atitle"] = data.Title;
if is_set (deduced_class) then
    elseif is_set(data.Periodical) then
return deduced_class, true;
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
end
        OCinSoutput["rft.genre"] = "article";
elseif (naive_class ~= deduced_class) then
        OCinSoutput["rft.jtitle"] = data.Periodical;
local check_list = cfg.periodical.compatibility[naive_class];
        OCinSoutput["rft.atitle"] = data.Title;
if is_set (check_list) then
    else
if is_set (check_list['drop']) and in_array (deduced_class, check_list['drop']) then
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
A['Periodical'] = discard_parameter (periodical, origin, nil);
        OCinSoutput["rft.genre"] = "book"
elseif is_set (check_list['warn']) and in_array (deduced_class, check_list['warn']) then
        OCinSoutput["rft.btitle"] = data.Title;
append_error ('periodical', {origin, naive_class, deduced_class, check_list['suggest']});
    end
end
   
end
    OCinSoutput["rft.place"] = data.PublicationPlace;
end
    OCinSoutput["rft.date"] = data.Date;
return naive_class, false;
    OCinSoutput["rft.series"] = data.Series;
    OCinSoutput["rft.volume"] = data.Volume;
    OCinSoutput["rft.issue"] = data.Issue;
    OCinSoutput["rft.pages"] = data.Pages;
    OCinSoutput["rft.edition"] = data.Edition;
    OCinSoutput["rft.pub"] = data.PublisherName;
   
    for k, v in pairs( data.ID_list ) do
        local id, value = cfg.id_handlers[k].COinS;
        if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
        if string.sub( id or "", 1, 4 ) == 'info' then
            OCinSoutput["rft_id"] = table.concat{ id, "/", v };
        else
            OCinSoutput[ id ] = value;
        end
    end
   
    local last, first;
    for k, v in ipairs( data.Authors ) do
        last, first = v.last, v.first;
        if k == 1 then
            if is_set(last) then
                OCinSoutput["rft.aulast"] = last;
            end
            if is_set(first) then  
                OCinSoutput["rft.aufirst"] = first;
            end
        end
        if is_set(last) and is_set(first) then
            OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
        elseif is_set(last) then
            OCinSoutput["rft.au"] = last;
        end
    end
   
    OCinSoutput.rft_id = data.URL;
    OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
    OCinSoutput = setmetatable( OCinSoutput, nil );
   
    -- sort with version string always first, and combine.
    table.sort( OCinSoutput );
    table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
    return table.concat(OCinSoutput, "&");
end
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 is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
   
    -- Pick out the relevant fields from the arguments.  Different citation templates
    -- define different field names for the same underlying things.   
    -- LOCAL
    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 URLorigin = A:ORIGIN('URL');
    local ChapterURL = A['ChapterURL'];
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
    local Periodical = A['Periodical'];
   
    if ( config.CitationClass == "encyclopaedia" ) then
        if not is_set(Chapter) then
            if not is_set(Title) then
                Title = Periodical;
                Periodical = '';
            else
                Chapter = Title
                TransChapter = TransTitle
                Title = '';
                TransTitle = '';
            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 = '';
local Program = A['Program'];
    local Page, Pages, At, page_type;
   
    Page = A['Page'];
    Pages = hyphentodash( A['Pages'] );
    At = A['At'];
   
    if is_set(Page) then
        if is_set(Pages) or is_set(At) then
            Page = Page .. " " .. seterror('extra_pages');
            Pages = '';
            At = '';
        end
    elseif is_set(Pages) then
        if is_set(At) then
            Pages = Pages .. " " .. seterror('extra_pages');
            At = '';
        end
    end   
   
    local Edition = A['Edition'];
    local PublicationPlace = A['PublicationPlace']
    local Place = A['Place'];
   
    if not is_set(PublicationPlace) and is_set(Place) then
        PublicationPlace = Place;
    end
   
    if PublicationPlace == Place then Place = ''; 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'];
    local ID = A['ID'];
    local ASINTLD = A['ASINTLD'];
    local IgnoreISBN = A['IgnoreISBN'];


    local ID_list = extractids( args );
if (citation_class == 'interview') then
   
if is_set (Program) then
    local Quote = A['Quote'];
ID = ' ' .. Program;
    local PostScript = A['PostScript'];
end
    local LayURL = A['LayURL'];
if is_set (Callsign) then
    local LaySource = A['LaySource'];
if is_set (ID) then
    local Transcript = A['Transcript'];
ID = ID .. pend_separator (Callsign, sepc, true);
    local TranscriptURL = A['TranscriptURL']
else
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
ID = ' ' .. Callsign;
    local sepc = A['Separator'];
end
    local LastAuthorAmp = A['LastAuthorAmp'];
end
    local no_tracking_cats = A['NoTracking'];
if is_set (City) then
if is_set (ID) then
ID = ID .. pend_separator (City, sepc, true);
else
ID = ' ' .. City;
end
end


    local this_page = mw.title.getCurrentTitle(); --Also used for COinS
if is_set (Others) then
   
Others = wrap_msg ('interview', {TitleType, Others}, use_lowercase);
    if not is_set(no_tracking_cats) then
TitleType = '';
        for k, v in pairs( cfg.uncategorized_namespaces ) do
end
            if this_page.nsText == v then
else
                no_tracking_cats = "true";
Callsign = discard_parameter (Callsign, A:ORIGIN ('Callsign'), nil );
                break;
City = discard_parameter (City, A:ORIGIN ('City'), nil );
            end
Program = discard_parameter (Program, A:ORIGIN ('Program'), nil);
        end
end
    end
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}}.


    if ( config.CitationClass == "journal" ) then
local BookTitle = A['BookTitle'];
        if not is_set(URL) and is_set(ID_list['PMC']) then
if 'conference' == citation_class then
            local Embargo = A['Embargo'];
if is_set (BookTitle) then
            if is_set(Embargo) then
ChapterURLobject = URLobject;
                local lang = mw.getContentLanguage();
URLobject = create_url_object ();
                local good1, result1, good2, result2;
TransChapter = TransTitle;
                good1, result1 = pcall( lang.formatDate, lang, 'U', Embargo );
TransTitle = '';
                good2, result2 = pcall( lang.formatDate, lang, 'U' );
Chapter = Title;
               
Title = BookTitle;
                if good1 and good2 and tonumber( result1 ) < tonumber( result2 ) then
end
                    URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
else
                    URLorigin = cfg.id_handlers['PMC'].parameters[1];
BookTitle = discard_parameter (BookTitle, A:ORIGIN ('BookTitle'), nil);  
                end
if 'speech' == citation_class then
            else
TitleNote = discard_parameter (TitleNote, A:ORIGIN ('TitleNote'), TitleType);
                URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
-- 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).
                URLorigin = cfg.id_handlers['PMC'].parameters[1];
TitleType = ''; -- annotate the citation
            end
else
        end
Conference = discard_parameter (Conference, A:ORIGIN ('Conference'), '');
    end
-- not cite conference or cite speech so make sure this is empty string
end
end


    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-- cite map oddities
   
local Cartography = A['Cartography'];
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
local Scale = A['Scale'];
    if is_set(BookTitle) then
        Chapter = Title;
if citation_class == 'map' then
        ChapterLink = TitleLink;
Chapter = A['Map'];
        TransChapter = TransTitle;
TransChapter = A['TransMap'];
        Title = BookTitle;
ChapterURLobject = create_url_object (A['MapURL'], A:ORIGIN ('MapURL'), A['MapFormat'], A:ORIGIN ('MapFormat'), A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'));
        TitleLink = '';
Cartography = pend_separator (wrap_msg ('cartography', Cartography, use_lowercase), sepc, true);
        TransTitle = '';
Scale = pend_separator (Scale, sepc, true);
    end
else
    -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
Cartography = discard_parameter (Cartography, A:ORIGIN ('Cartography'), '');
    if config.CitationClass == "episode" then
Scale = discard_parameter (Scale, A:ORIGIN ('Scale'), '');
        local AirDate = A['AirDate'];
discard_parameter (A['Map'], A:ORIGIN ('Map'), nil);
        local SeriesLink = A['SeriesLink'];
discard_parameter (A['MapURL'], A:ORIGIN ('MapURL'), nil);
        local Season = A['Season'];
discard_parameter (A['TransMap'], A:ORIGIN ('TransMap'), nil);
        local SeriesNumber = A['SeriesNumber'];
discard_parameter (A['MapFormat'], A:ORIGIN ('MapFormat'), nil);
        local Network = A['Network'];
discard_parameter (A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'), nil);
        local Station = A['Station'];
end
        local s, n = {}, {};
        local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
       
        if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
        if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
        if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
        if is_set(Network) then table.insert(n, Network); end
        if is_set(Station) then table.insert(n, Station); end
       
        Date = Date or AirDate;
        Chapter = Title;
        ChapterLink = TitleLink;
        TransChapter = TransTitle;
        Title = Series;
        TitleLink = SeriesLink;
        TransTitle = '';
       
        Series = table.concat(s, Sep);
        ID = table.concat(n, Sep);
    end
   
    -- COinS metadata (see <http://ocoins.info/>) for
    -- automated parsing of citation information.
    local OCinSoutput = COinS{
        ['Periodical'] = Periodical,
        ['Chapter'] = Chapter,
        ['Title'] = Title,
        ['PublicationPlace'] = PublicationPlace,
        ['Date'] = first_set(Date, Year, PublicationDate),
        ['Series'] = Series,
        ['Volume'] = Volume,
        ['Issue'] = Issue,
        ['Pages'] = first_set(Page, Pages, At),
        ['Edition'] = Edition,
        ['PublisherName'] = PublisherName,
        ['URL'] = first_set( URL, ChapterURL ),
        ['Authors'] = a,
        ['ID_list'] = ID_list,
        ['RawPage'] = this_page.prefixedText,
    };


    if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
        Chapter = Title;
if 'episode' == citation_class or 'serial' == citation_class then
        ChapterLink = TitleLink;
local AirDate = A['AirDate'];
        TransChapter = TransTitle;
local SeriesLink = A['SeriesLink'];
        Title = '';
local Network = A['Network'];
        TitleLink = '';
local Station = A['Station'];
        TransTitle = '';
local s, n = {}, {};
    end
-- do common parameters first
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


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


        local control = {  
if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
            sep = A["EditorSeparator"] .. " ",
select_one (args, {'season', 'series-number', 'series-no', 'seriesnumber', 'seriesno'}, 'redundant_parameters');
            namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
-- add error message
            format = A['EditorFormat'],
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
            maximum = Maximum,
end
            lastauthoramp = LastAuthorAmp
-- assemble a table of parts concatenated later into Series
        };
if is_set (Season) then table.insert (s, wrap_msg ('season', Season, use_lowercase)); end
if is_set (SeriesNumber) then table.insert (s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
if is_set (Issue) then table.insert (s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter
Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
local ChapterLink = TitleLink; -- alias episodelink
local ChapterLinkorigin = TitleLinkorigin;
TransChapter = TransTitle;
ChapterURLobject = URLobject;
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


        Editors, EditorCount = listpeople(control, e);
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
    else
Chapter = make_internal_link (ChapterLink, Chapter, ChapterLinkorigin);
        EditorCount = 1;
-- ok to wikilink
    end
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
   
Series = make_internal_link (ChapterLink, Series, ChapterLinkorigin);
    if not is_set(Date) then
-- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
        Date = Year;
end
        if is_set(Date) then
URLobject = create_url_object (); -- unset
            local Month = A['Month'];
TransTitle = '';
            if is_set(Month) then
ScriptTitle = '';
                Date = Date .. '.' .. Month; -- LOCAL
                local Day = A['Day']
else -- now oddities that are cite serial
                if is_set(Day) then Date = Date .. '.' .. Month end -- LOCAL
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
            end
if is_set (Series) and is_set (SeriesLink) then
        end
Series = make_internal_link (SeriesLink, Series, A:ORIGIN ('SeriesLink'));
    end
end
   
Series = wrap_style ('italic-title', Series); -- series is italicized
    if inArray(PublicationDate, {Date, Year}) then PublicationDate = ''; end
end
    if not is_set(Date) and is_set(PublicationDate) then
end
        Date = PublicationDate;
-- end of {{cite episode}} stuff
        PublicationDate = '';
    end


    -- Captures the value for Date prior to adding parens or other textual transformations
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
    local DateIn = Date;
if 'arxiv' == citation_class then
   
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
    if not is_set(URL) and
append_error ('arxiv_missing', {}); -- add error message
        not is_set(ChapterURL) and
elseif is_set (Series) then -- series is an alias of version
        not is_set(ArchiveURL) and
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
        not is_set(ConferenceURL) and
Series = ''; -- unset
        not is_set(TranscriptURL) then
deprecated_parameter ('version'); -- deprecated parameter but only for cite arxiv
       
end
        -- Test if cite web is called without giving a URL
        if ( config.CitationClass == "web" ) then
if first_set ({AccessDate, At, URLobject['format'], Page, Pages, PublisherName, URLobject['url'], -- a crude list of parameters that are not supported by cite arxiv
            table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
        end
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
        -- Test if accessdate is given without giving a URL
append_error ('arxiv_params_not_supported', {}); -- add error message
        if is_set(AccessDate) then
            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
            AccessDate = '';
        end
       
        -- Test if format is given without giving a URL
        if is_set(Format) then
            Format = Format .. seterror( 'format_missing_url' );
        end
    end
   
    -- Test if citation has no title
    if  not is_set(Chapter) and
        not is_set(Title) and
        not is_set(Periodical) and
        not is_set(Conference) and
        not is_set(TransTitle) and
        not is_set(TransChapter) then
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    end
   
    Format = is_set(Format) and " (" .. Format .. ")" or "";
   
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
    if ( ArchiveURL and "" < ArchiveURL ) then
        if ( DeadURL ~= "no" ) then
            URL = ArchiveURL
        end
    end
   
    -- Format chapter / article title


    -- LOCAL
AccessDate= ''; -- set these to empty string; not supported in cite arXiv
    if not is_set(Language) or Language:lower() == 'zh' or Language:sub( 1, 3 ):lower() == 'zh-' then
PublisherName = ''; -- (if the article has been published, use cite journal, or other)
        xLCFlags = 'zh;zh-hans;zh-hant'
URLobject = create_url_object ();
    else
Page = ''; Pages = ''; At = '';
        xLCFlags = 'R'
end
    end
Periodical = 'arXiv'; -- periodical not allowed in cite arxiv; if article has been published, use cite journal
    if is_set(Chapter) then
-- set to arXiv for COinS; after that, must be set to empty string
        Chapter = '-{' .. xLCFlags .. '|' .. Chapter .. '}-'
end
    end
    if is_set(Title) then
-- 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.
        Title = '-{' .. xLCFlags .. '|' .. Title .. '}-'
if not is_set (Date) then
    end
if is_set (Year) then
    -- END LOCAL
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


    if is_set(Chapter) and is_set(ChapterLink) then
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
        Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
local anchor_year = validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, Dateorigin);
    end
-- used in the CITEREF identifier
    if is_set(Periodical) and is_set(Title) then
        Chapter = wrap( 'italic-title', Chapter );
        TransChapter = wrap( 'trans-italic-title', TransChapter );
    else
        Chapter = wrap( 'quoted-title', Chapter );
        TransChapter = wrap( 'trans-quoted-title', TransChapter );
    end
   
    local TransError = ""
    if is_set(TransChapter) then
        if not is_set(Chapter) then
            TransError = " " .. seterror( 'trans_missing_chapter' );
        else
            TransChapter = " " .. TransChapter;
        end
    end
   
    Chapter = Chapter .. TransChapter;
   
    if is_set(Chapter) then
        if not is_set(ChapterLink) then
            if is_set(ChapterURL) then
                Chapter = externallink( ChapterURL, Chapter ) .. TransError;
                if not is_set(URL) then
                    Chapter = Chapter .. Format;
                    Format = "";
                end
            elseif is_set(URL) then
                Chapter = externallink( URL, Chapter ) .. TransError .. Format;
                URL = "";
                Format = "";
            else
                Chapter = Chapter .. TransError;
            end           
        elseif is_set(ChapterURL) then
            Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) ..
                TransError;
        else
            Chapter = Chapter .. TransError;
        end
        if is_set(Title) then -- LOCAL
          Chapter = Chapter .. '//' -- LOCAL
        else -- LOCAL
          Chapter = Chapter .. sepc .. " " -- with end-space
        end -- LOCAL
    elseif is_set(ChapterURL) then
        Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
    end       
   
    -- Format main title.
    if is_set(TitleLink) and is_set(Title) then
        Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
    end
   
    if is_set(Periodical) then
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    elseif inArray(config.CitationClass, {"web","news","pressrelease"}) and
            not is_set(Chapter) then
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    else
        Title = wrap( 'italic-title', Title );
        TransTitle = wrap( 'trans-italic-title', TransTitle );
    end
   
    TransError = "";
    if is_set(TransTitle) then
        if not is_set(Title) then
            TransError = " " .. seterror( 'trans_missing_title' );
        else
            TransTitle = " " .. TransTitle;
        end
    end
   
    Title = Title .. TransTitle;
   
    if is_set(Title) then
        if not is_set(TitleLink) and is_set(URL) then
            Title = externallink( URL, Title ) .. TransError .. Format     
            URL = "";
            Format = "";
        else
            Title = Title .. TransError;
        end
    end
   
    if is_set(Place) then
        if sepc == '.' then
            Place = " " .. wrap( 'written', Place ) .. sepc .. " ";
        else
            Place = " " .. substitute( cfg.messages['written']:lower(), {Place} ) .. sepc .. " ";
        end
    end
   
    if is_set(Conference) then
        if is_set(ConferenceURL) then
            Conference = externallink( ConferenceURL, Conference );
        end
        Conference = " " .. Conference
    elseif is_set(ConferenceURL) then
        Conference = " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
    end
   
    if not is_set(Position) then
        local Minutes = A['Minutes'];
        if is_set(Minutes) then
            Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
        else
            local Time = A['Time'];
            if is_set(Time) then
                local TimeCaption = A['TimeCaption']
                if not is_set(TimeCaption) then
                    TimeCaption = cfg.messages['event'];
                    if sepc ~= '.' then
                        TimeCaption = TimeCaption:lower();
                    end
                end
                Position = " " .. TimeCaption .. " " .. Time;
            end
        end
    else
        Position = " " .. Position;
        At = '';
    end
   
    if not is_set(Page) then
        if is_set(Pages) then
            if is_set(Periodical) and
                not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then
                  Pages = ": " .. Pages;
            elseif config.CitationClass == "news" then -- LOCAL
                Pages = ": (" .. Pages .. ")" -- LOCAL
            elseif config.CitationClass == "book" then -- LOCAL
                Pages = ": " .. Pages -- LOCAL
            elseif tonumber(Pages) ~= nil then
                Pages = sepc .." " .. PPrefix .. Pages .. PSuffix; -- LOCAL
            else
                Pages = sepc .." " .. PPPrefix .. Pages .. PPSuffix; -- LOCAL
            end
        end
    else
        if is_set(Periodical) and
            not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then
            Page = ": " .. Page;
        else
        if config.CitationClass == "news" then -- LOCAL
            Page = ": (" .. Page .. ")" -- LOCAL
        elseif config.CitationClass == "news" then -- LOCAL
            Page = ": " .. Page -- LOCAL
        else -- LOCAL
            Page = sepc .." " .. PPrefix .. Page .. PSuffix; -- LOCAL
        end -- LOCAL
        end
    end
   
    At = is_set(At) and (sepc .. " " .. At) or "";
    Others = is_set(Others) and (sepc .. " " .. Others) or "";
    TitleType = is_set(TitleType) and (", " .. TitleType) or ""; -- LOCAL
    TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
    -- LOCAL
    if is_set(Language) then
        local langNameInLang = mw.getContentLanguage():getCode()
        local languageCode = Language:lower()
        if languageCode:sub( 1, 3 ) == 'zh-' then
            langNameInLang = languageCode
        end
        local languageName = mw.language.fetchLanguageName( languageCode, langNameInLang )
        if languageName == '' then
            languageName = Language
        end
        Language = " " .. wrap( 'language', languageName )
    else Language = "" end
    -- END LOCAL
    Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
    Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
    Series = is_set(Series) and (sepc .. " " .. Series) or "";
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
    Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
   
    if is_set(Volume) then
        if ( mw.ustring.len(Volume) > 4 )
          then Volume = sepc .." " .. Volume;
          else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
        end
    end
   
    ------------------------------------ totally unrelated data
    if is_set(Via) then Via = " " .. wrap( 'via', Via ); end
    if is_set(AccessDate) then
        local retrv_text = " " .. cfg.messages['retrieved']
        if (sepc ~= ".") then retrv_text = retrv_text:lower() end
        AccessDate = '<span class="reference-accessdate">' -- LOCAL .. sepc
            .. substitute( retrv_text, {AccessDate} ) .. '</span>'
    end
   
    if is_set(SubscriptionRequired) then
        SubscriptionRequired = sepc .. " " .. cfg.messages['subscription'];
    end
   
    if is_set(ID) then ID = sepc .." ".. ID; end
   
    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN} );


    if is_set(URL) then
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
        URL = " " .. externallink( URL, nil, URLorigin );
-- 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
    end
Embargo = is_embargoed (Embargo); --


    if is_set(Quote) then
if citation_class == 'journal' and not is_set (URLobject['url']) and is_set (ID_list['PMC']) then
        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
if not is_set (Embargo) then -- if not embargoed or embargo has expired
            Quote = Quote:sub(2,-2);
URLobject['url'] =cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
        end
URLobject['origin'] = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
        Quote = sepc .." " .. wrap( 'quoted-text', Quote );
end
        PostScript = "";
end
    elseif PostScript:lower() == "none" then
        PostScript = "";
if not is_set (URLobject['url']) then
    end
if in_array (citation_class, cfg.args_support['templates_requiring_url']) then
   
append_error ('cite_web_url', {});
    local Archived
end
    if is_set(ArchiveURL) then
        if not is_set(ArchiveDate) then
-- Test if accessdate is given without giving a URL
            ArchiveDate = seterror('archive_missing_date');
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?
        end
append_error ('accessdate_missing_url', {});
        if "no" == DeadURL then
AccessDate = '';
            local arch_text = cfg.messages['archived'];
end
            if sepc ~= "." then arch_text = arch_text:lower() end
end
            Archived = substitute( cfg.messages['archived-not-dead'],
                { externallink( ArchiveURL, arch_text ), ArchiveDate } );
            if not is_set(OriginalURL) then
                Archived = Archived .. " " .. seterror('archive_missing_url');                             
            end
        elseif is_set(OriginalURL) then
            local arch_text = cfg.messages['archived-dead'];
            if sepc ~= "." then arch_text = arch_text:lower() end
            Archived = sepc .. " " .. substitute( arch_text,
                { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
        else
            local arch_text = cfg.messages['archived-missing'];
            if sepc ~= "." then arch_text = arch_text:lower() end
            Archived = substitute( arch_text,
                { seterror('archive_missing_url'), ArchiveDate } ); -- LOCAL
        end
    else
        Archived = ""
    end
   
    local Lay
    if is_set(LayURL) then
        if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
        if is_set(LaySource) then
            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
        else
            LaySource = "";
        end
        if sepc == '.' then
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
        else
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
        end           
    else
        Lay = "";
    end
   
    if is_set(Transcript) then
        if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
    elseif is_set(TranscriptURL) then
        Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
    end
   
    local Publisher;
    if is_set(Periodical) and
        not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease"}) then
        if is_set(PublisherName) then
            if is_set(PublicationPlace) then
                Publisher = PublicationPlace .. ": " .. PublisherName;
            else
                Publisher = PublisherName; 
            end
        elseif is_set(PublicationPlace) then
            Publisher= PublicationPlace;
        else
            Publisher = "";
        end
        --[[ LOCAL
        if is_set(PublicationDate) then
            if is_set(Publisher) then
                Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
            else
                Publisher = PublicationDate;
            end
        end
        ]]
        if is_set(Publisher) then
            Publisher = " (" .. Publisher .. ")";
        end
    else
        --[[ LOCAL
        if is_set(PublicationDate) then
            PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
        end
        ]]
        if is_set(PublisherName) then
            if is_set(PublicationPlace) then
                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName -- LOCAL .. PublicationDate;
            else
                Publisher = sepc .. " " .. PublisherName -- LOCAL .. PublicationDate; 
            end           
        elseif is_set(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 is_set(Periodical) then
        if is_set(Title) or is_set(TitleNote) then
            Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
        else
            Periodical = wrap( 'italic-title', Periodical )
        end
    end


    -- Piece all bits together at lastHere, all should be non-nil.
-- At this point fields may be nil if they weren't specified in the template useWe can use that fact.
    -- We build things this way because it is more efficient in LUA
-- Test if citation has no title
    -- not to keep reassigning to the same string variable over and over.
if not is_set (Title) and
not is_set (TransTitle) and
not is_set (ScriptTitle) then
if 'episode' == citation_class then -- special case for cite episode; TODO: is there a better way to do this?
append_error ('citation_missing_title', {'series'});
else
append_error ('citation_missing_title', {'title'});
end
end
if 'none' == Title and citation_class == 'journal' then -- special case for journal cites
Title = ''; -- set title to empty string
add_maint_cat ('untitled');
end


    local tcommon
check_for_external_link ({ -- add error message when any of these parameters contains a URL
    if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
['title'] = Title,
        if is_set(Others) then Others = Others .. sepc .. " " end
[A:ORIGIN ('Chapter')] = Chapter,
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,  
[A:ORIGIN ('Periodical')] = Periodical,
            Edition, Publisher, Agency, Place, Position}, sepc ); -- LOCAL
[A:ORIGIN ('PublisherName')] = PublisherName,
    else
});
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series,  
 
            Volume, Issue, Others, Edition, Publisher, Agency, Place, Position}, sepc ); -- LOCAL
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
    end
-- 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 #ID_list > 0 then
-- is the article title, and Chapter is a section within the article.  So, we remap
        ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
    else
local coins_chapter = Chapter; -- default assuming that remapping not required
        ID_list = ID;
local coins_title = Title; -- et tu
    end  
if 'encyclopaedia' == citation_class then
    -- LOCAL
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
    local xDate = Date
coins_chapter = Title; -- remap
    local pgtext = Page .. Pages .. At
coins_title = Periodical;
    if ( is_set(Periodical) and Date ~= '' and
end
      not inArray(config.CitationClass, {"encyclopaedia","web"}) )
end
      or ( inArray(config.CitationClass, {"book","news"}) ) then
 
        if inArray(config.CitationClass, {"journal","citation"}) and ( Volume ~= '' or Issue ~= '' ) then
-- this is the function call to COinS()
            xDate = xDate .. ',' .. Volume .. Issue
local OCinSoutput = COinS ({
        end
['Periodical'] = Periodical,
        xDate = xDate .. pgtext
['Encyclopedia'] = Encyclopedia,
        pgtext = ''
['Chapter'] = coins_chapter,
    end
['ScriptChapter'] = ScriptChapter,
    if PublicationDate and PublicationDate ~= '' then
['Map'] = Map,
        xDate = xDate .. ' (' .. PublicationDate .. ')'
['Degree'] = Degree; -- cite thesis only
    end
['Title'] = coins_title,
    if OrigYear ~= '' then
['ScriptTitle'] = ScriptTitle,
        xDate = xDate .. OrigYear
['PublicationPlace'] = PublicationPlace,
    end
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
    if AccessDate ~= '' then
['Season'] = COinS_date.rftssn,
        xDate = xDate .. ' ' .. AccessDate
['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?
    end
['Series'] = Series,
    if xDate ~= '' then
['Volume'] = Volume,
        xDate = sepc .. ' ' .. xDate
['Issue'] = Issue,
    end
['Pages'] = first_set ({Sheet, Sheets, Page, Pages, At}, 5),
    -- END LOCAL
['Edition'] = Edition,
   
['PublisherName'] = PublisherName,
    local idcommon = safejoin( { URL, xDate, ID_list, Archived, Via, SubscriptionRequired, Lay, Language, Quote }, sepc ); -- LOCAL
['URL'] = first_set ({ChapterURLobject['url'], URLobject['url']}, 2),
    local text;
['Authors'] = NameList,
    -- LOCAL local pgtext = Page .. Pages .. At;
['ID_list'] = ID_list,
   
['RawPage'] = this_page.prefixedText,
    if is_set(Authors) then
}, config.CitationClass);
        if is_set(Coauthors) then
 
            Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
        end
if 'arxiv' == citation_class then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
    --[[ LOCAL
Periodical = '';
        if is_set(Date) then
end
            Date = " ("..Date..")" .. OrigYear .. sepc .. " "
 
        else]]if string.sub(Authors,-1,-1) == sepc then
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
            Authors = Authors .. " "
if 'newsgroup' == citation_class then
        else
if is_set (PublisherName) then
            Authors = Authors .. sepc .. " "
PublisherName = wrap_msg ('newsgroup', make_external_link ('news:' .. PublisherName, PublisherName, A:ORIGIN ('PublisherName')), use_lowercase);
        end
end
        if is_set(Editors) then
end
            local ed_is_zh = is_zh( Editors ) -- LOCAL
 
            local in_text = ed_is_zh and '' or "In " -- LOCAL
-- Now perform various field substitutions.
            if (sepc ~= '.') then in_text = in_text:lower() end
-- We also add leading spaces and surrounding markup and punctuation to the
            if (string.sub(Editors,-1,-1) == sepc)
-- various parts of the citation, but only when they are non-nil.
                or ed_is_zh -- LOCAL
                then Editors = in_text .. Editors .. " "
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
                else Editors = in_text .. Editors .. sepc .. " "
-- an error message if the associated url is not set, or an empty string for concatenation
            end
format_format ({ArchiveURLobject, ConferenceURLobject, URLobject, LayURLobject, TranscriptURLobject, ChapterURLobject});
            -- LOCAL
            if ed_is_zh then
-- special case for chapter format so no error message or cat when chapter not supported
                Editors = Editors .. ' ' .. cfg.messages['in'] .. sepc .. ' '
if format_url_access_text (URLobject, SubscriptionRequired, RegistrationRequired) then
            end
select_one (args, {'url-access', 'urlaccess', 'registration', 'subscription'}, 'redundant_parameters');
            -- END LOCAL
end -- 只需其一
        end
format_url_access_text (ChapterURLobject, nil, nil);
        text = safejoin( {Authors, Chapter, Editors, tcommon }, sepc ); -- LOCAL
 
        text = safejoin( {text, pgtext, idcommon}, sepc );
local OriginalURLobject; -- TODO: swap chapter and title here so that archive applies to most specific if both are set?
    elseif is_set(Editors) then
OriginalURLobject, URLobject, ChapterURLobject =
        --[[ LOCAL
swap_urls (URLobject, ChapterURLobject, ArchiveURLobject, DeadURL);
        if is_set(Date) then
            if EditorCount <= 1 then
local chapter_no_quotes = false; -- default assume that we will be quoting the chapter parameter value
                Editors = Editors .. ", " .. cfg.messages['editor'];
if is_set (Contribution) and has_contributors then -- if this is a contribution with contributor(s)
            else
if in_array (Contribution:lower(), cfg.keywords['contribution']) then -- and a generic contribution title
                Editors = Editors .. ", " .. cfg.messages['editors'];
chapter_no_quotes = true; -- then render it unquoted
            end
end
            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
end
        else
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURLobject, chapter_no_quotes, citation_class, TitleType, sepc);
        ]]
-- Contribution is also in Chapter
            if EditorCount <= 1 then
-- Format main title.
                Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
Title, URLobject = format_main_title (Title, TitleLink, TitleLinkorigin, ScriptTitle, TransTitle, URLobject, no_chapter_format, citation_class, Periodical);
            else
Place = pend_separator (wrap_msg ('written', Place, use_lowercase), sepc, false);
                Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
Conference = format_conference (Conference, ConferenceURLobject, Periodical, citation_class, sepc);
            end
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);
        --[[ LOCAL
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc
        end
 
        ]]
Others = pend_separator (Others, sepc, true);
        text = safejoin( {Chapter, Editors, tcommon}, sepc ); -- LOCAL
Others = pend_separator (wrap_msg ('translated', Translators, use_lowercase), sepc, true) .. Others;
        text = safejoin( {text, pgtext, idcommon}, sepc );
    else
if 'speech' ~= citation_class then
        --[[ LOCAL
TitleNote = pend_separator (TitleNote, sepc, true);
        if is_set(Date) then
end
            if ( string.sub(tcommon,-1,-1) ~= sepc )
              then Date = sepc .." " .. Date .. OrigYear
Edition = wrap_msg ('edition', Edition, use_lowercase);
              else Date = " " .. Date .. OrigYear
Series = pend_separator (Series, sepc, true);
            end
OrigYear = wrap_msg ('orig year', OrigYear, use_lowercase);
        end
Agency = pend_separator (Agency, sepc, true);
]]
Volume = format_volume_issue (Volume, Issue, citation_class, Periodical_origin, sepc, use_lowercase);
        if config.CitationClass=="journal" and is_set(Periodical) then
 
            text = safejoin( {Chapter, Place, tcommon}, sepc );
------------------------------------ totally unrelated data
            text = safejoin( {text, pgtext, idcommon}, sepc ); -- LOCAL
        else
Via = wrap_msg ('via', Via, use_lowercase);
            text = safejoin( {Chapter, tcommon}, sepc ); -- LOCAL
AccessDate = format_accessdate (AccessDate, sepc, use_lowercase);
            text = safejoin( {text, pgtext, idcommon}, 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});
    end
 
   
local URL = '';
    if is_set(PostScript) and PostScript ~= sepc then
if is_set (URLobject['url']) then
        text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
URL = ' ' .. make_external_link (URLobject['url'], nil, URLobject['origin']) .. URLobject['access-text'];
        text = text:sub(1,-2); --Remove final seperator   
end
    end  
   
local Format = URLobject['format'];
    text = safejoin( {text, PostScript}, sepc );
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);
 
local use_in = is_set (Chapter) and (not has_contributors);
Authors, Editors, Contributors = format_people (Authors, Editors, Contributors, multiple_editors, use_in, sepc);
-- Several of the above rely upon detecting this as nil, so do it last.
Periodical = format_periodical (Periodical, Title, TitleNote, sepc);
 
-- Piece all bits together at last.  Here, all should be non-nil.
-- We build things this way because it is more efficient in LUA
-- not to keep reassigning to the same string variable over and over.
 
local tcommon;
local tcommon2; -- used for book cite when |contributor= is set
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 idcommon = safe_join ({URL, xDate, ID_list, Archived, Via, Lay, Language, Quote}, sepc);
local text;
if is_set (Authors) then
if is_set (Contributors) then
text = safe_join ({Contributors, Chapter, tcommon, Authors, Place, Editors, tcommon2, Insource_location, idcommon }, sepc);
else
text = safe_join ({Authors, Chapter, Place, Editors, tcommon, Insource_location, idcommon }, sepc);
end
else
text = safe_join ({Editors, Chapter, Place, tcommon, Insource_location, idcommon}, sepc);
end
if is_set (PostScript) and PostScript ~= sepc then
text = safe_join ({text, sepc}, sepc);  --Deals with italics, spaces, etc.
text = text:sub (1, -sepc:len()-1);
end
text = safe_join ({text, PostScript}, sepc);
 
-- Now enclose the whole thing in a <cite/> element
return format_citation (text, config.CitationClass, Ref, NameList, anchor_year, OCinSoutput, no_tracking_cats);
end


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


    local empty_span = '<span style="display:none;">&nbsp;</span>';
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="' .. OCinSoutput .. '" 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 is_set(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 inArray(no_tracking_cats, {"", "no", "false", "n"}) then
state = whitelist.numbered_arguments[name];
        for _, v in ipairs( z.error_categories ) do
if true == state then return true; end -- valid actively supported parameter
            text = text .. '[[Category:' .. v ..']]';
if false == state then
        end
deprecated_parameter (name); -- parameter is deprecated but still supported
    end
return true;
   
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()
This is used by templates such as {{cite book}} to create the actual citation text.
   
 
    local args = {};
]]
    local suggestions = {};
    local error_text, error_state;


    local config = {};
function citation (frame)
    for k, v in pairs( frame.args ) do
local pframe = frame:getParent();
        config[k] = v;
local module_path = 'Module:Citation/CS1/'
        args[k] = v;      
local module_suffix = frame:getTitle():gsub ('^Module:Citation/CS1', '');
    end   
load_modules (module_path, module_suffix);
local args = {};
local suggestions = {};
local error_reported = false;


    for k, v in pairs( pframe.args ) do
local config = {};
        if v ~= '' then
for k, v in pairs (frame.args) do
            if not validate( k ) then          
config[k] = v;
                error_text = "";
args[k] = v;  
                if type( k ) ~= 'string' then
end
                    -- Exclude empty numbered parameters
 
                    if v:match("%S+") ~= nil then
local capture; -- the single supported capture when matching unknown parameters using patterns
                        error_text, error_state = seterror( 'text_ignored', {v}, true );
for k, v in pairs (pframe.args) do
                    end
if v ~= '' then
                elseif validate( k:lower() ) then  
if not validate (k) then
                    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
error_reported = false;
                else
if type (k) ~= 'string' then
                    if #suggestions == 0 then
-- Exclude empty numbered parameters
                        suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
if v:match ('%S+') ~= nil then
                    end
append_error ('text_ignored', {v});
                    if suggestions[ k:lower() ] ~= nil then
error_reported = true;
                        error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
end
                    else
elseif validate (k:lower()) then  
                        error_text, error_state = seterror( 'parameter_ignored', {k}, true );
append_error ('parameter_ignored_suggest', {k, k:lower()});
                    end
error_reported = true;
                end                
else
                if error_text ~= '' then
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
                    table.insert( z.message_tail, {error_text, error_state} );
suggestions = mw.loadData (module_path .. 'Suggestions' .. module_suffix);
                end              
end
            end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
            args[k] = v;
capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match
        elseif args[k] ~= nil or (k == 'postscript') then
if capture then -- if the pattern matches
            args[k] = v;
param = substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
        end      
append_error ('parameter_ignored_suggest', {k, param});
    end  
-- set the error message
   
error_reported = true;
    return citation0( config, args, frame ) -- LOCAL
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};