跳转到内容

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

来自大巴扎百科
←上一编辑
imported>Antigng
imported>Liangent
无编辑摘要
imported>Antigng
修复显而易见的bug（无需共识）
 
（未显示18个用户的97个中间版本）
第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);
 
utilities.set_selected_modules (cfg);
links.set_selected_modules (utilities, errors);
errors.set_selected_modules (cfg, utilities, links);
identifiers.set_selected_modules (cfg, utilities, errors, links, validation);
people.set_selected_modules (cfg, utilities, errors, links);
coins.set_selected_modules (cfg, utilities, links);
languages.set_selected_modules (utilities, errors);
 
dates = validation.dates; -- imported functions
year_date_check = validation.year_date_check;
first_set = utilities.first_set;
hyphen_to_dash = utilities.hyphen_to_dash;
is_set = utilities.is_set;
in_array = utilities.in_array;
substitute = utilities.substitute;
has_invisible_chars = utilities.has_invisible_chars;
kern_quotes = utilities.kern_quotes;
pend_separator = utilities.pend_separator;
safe_join = utilities.safe_join;
wrap_style = utilities.wrap_style;
wrap_msg = utilities.wrap_msg;
make_external_link = links.make_external_link;
make_internal_link = links.make_internal_link;
check_for_external_link = links.check_for_external_link;
add_maint_cat = errors.add_maint_cat;
append_error = errors.append_error;
make_error_tail = errors.make_error_tail;
reset_error = errors.reset_error;
set_error = errors.set_error;
select_one = errors.select_one;
throw_error = errors.throw_error;
extract_ids = identifiers.extract_ids;
build_id_list = identifiers.build_id_list;
is_embargoed = identifiers.is_embargoed;
extract_id_access_levels = identifiers.extract_id_access_levels;
get_people = people.get_people;
format_people = people.format_people;
COinS = coins.COinS;
script_concatenate = languages.script_concatenate;
language_parameter = languages.language_parameter;


-- 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
return new_value;
end
 
--[[--------------------------< S A N I T I Z E D _ P A R A M E T E R _ V A L U E >------------------------
 
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
of allowable values (e.g. yes, y, true, no, etc). If the parameter value is empty or is in the list of allowed values,
the function returns the value; else, it emits an error message and returns the default value.
 
]]
 
local function sanitized_parameter_value (value, name, key, default)
if not is_set (value) then
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
end


-- Whether needle is in haystack
--[[--------------------------< 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 inArray( needle, haystack )
 
if needle == nil then
]]
return false;
 
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
end
for n,v in ipairs( haystack ) do
if v == needle then
for _, pattern in pairs (bad_patterns) do
return n;
if value:match (pattern) then
add_maint_cat ('extra_text', type);
return;
end
end
end
end
return false;
end
end


--[[
--[[--------------------------< V A L I D A T E _ D A T E >-------------------------------------------------------
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
 
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
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
details of which parameter caused the error message are not provided. Only one error message is emitted regardless of the number of deprecated parameters in the citation.
we get the date used in the metadata.
 
Date validation supporting code is in Module:Citation/CS1/Date_validation
]]
]]
function deprecated_parameter()
 
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
local function validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, origin)
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
local error_message = '';
-- table.insert( z.message_tail, { seterror( 'deprecated_params', {error_message}, true ) } ); -- add error message
-- AirDate has been promoted to Date so not necessary to check it
table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } ); -- add error message
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
end
end


-- Populates numbered arguments in a message string using an argument table.
if is_set (error_message) then
function substitute( msg, args )
append_error ('bad_date', {error_message}); -- add this error message
-- return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
end
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
return anchor_year;
end
end


--[[
--[[--------------------------< D I S C A R D _ C H A P T E R >-------------------------------------------------------
Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value.
仅为保持兼容性而设置。理论上可以直接调用discard_parameter()丢弃相关参数。
This function will positive kern  either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
]]
]]
function kern_quotes (str)
local left='<span style="padding-left:0.2em;">%1</span>'; -- spacing to use when title contains leading single or double quote mark
local right='<span style="padding-right:0.2em;">%1</span>'; -- spacing to use when title contains trailing single or double quote mark
if str:match ("^[\"\'][^\']") then
local function discard_chapter (args)
str = string.gsub( str, "^[\"\']", left, 1 ); -- replace (captured) leading single or double quote with left-side <span>
local chap_param;
if is_set (args['Chapter']) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = args:ORIGIN ('Chapter');
elseif is_set (args['TransChapter']) then
chap_param = args:ORIGIN ('TransChapter');
elseif is_set (args['ChapterURL']) then
chap_param = args:ORIGIN ('ChapterURL');
elseif is_set (args['ScriptChapter']) then
chap_param = args:ORIGIN ('ScriptChapter')
elseif is_set (args['ChapterFormat']) then
chap_param = args:ORIGIN ('ChapterFormat')
elseif is_set (args['ChapterUrlAccess']) then
chap_param = args:ORIGIN ('ChapterUrlAccess')
end
end
if str:match ("[^\'][\"\']$") then
if is_set (chap_param) then -- if we found one
str = string.gsub( str, "[\"\']$", right, 1 ); -- replace (captured) trailing single or double quote with right-side <span>
append_error ('chapter_ignored', {chap_param}); -- add error message
end
end
return str;
end
end


-- Wraps a string using a message_list configuration taking one argument
--[[--------------------------< C R E A T E _ U R L _ O B J E C T >------------------------------------------
function wrap( key, str, lower )
 
if not is_set( str ) then
]]
return "";
 
elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
local function create_url_object (url, source, fmt, fmt_source, access, access_source)
str = safeforitalics( str );
return {
end
['url'] = is_set (url) and url or '',
if lower == true then
['origin'] = is_set (source) and source or '',
return substitute( cfg.messages[key]:lower(), {str} );
['access'] = is_set (access) and sanitized_parameter_value (access, access_source, 'url-access', '') or '',
else
['access-origin'] = is_set (access_source) and access_source or '',
return substitute( cfg.messages[key], {str} );
['format'] = is_set (fmt) and fmt or '',
end
['format-origin'] = is_set (fmt_source) and fmt_source or '',
['access-text'] = ''
}
end
end


--[[
--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
Argument wrapper.  This function provides support for argument
 
mapping defined in the configuration file so that multiple names
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
can be transparently aliased to single internal variable.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
 
]]
]]
function argument_wrapper( args )
 
local origin = {};
local function set_titletype (cite_class, title_type)
if is_set (title_type) then
return setmetatable({
if 'none' == title_type then
ORIGIN = function( self, k )
title_type = ''; -- if |type=none then type parameter not displayed
local dummy = self[k]; --force the variable to be loaded.
return origin[k];
end
end
},
return title_type; -- if |type= has been set to any other value use that value
{
end
__index = function ( tbl, k )
 
if origin[k] ~= nil then
return cfg.title_types[cite_class] or ''; -- set template's default title type; else empty string for concatenation
return nil;
end
local args, list, v = args, cfg.aliases[k];
if type( list ) == 'table' then
v, origin[k] = selectone( args, list, 'redundant_parameters' );
if origin[k] == nil then
origin[k] = ''; -- Empty string, not nil
end
elseif list ~= nil then
v, origin[k] = args[list], list;
else
-- maybe let through instead of raising an error?
-- v, origin[k] = args[k], k;
error( cfg.messages['unknown_argument_map'] );
end
-- Empty strings, not nil;
if v == nil then
v = cfg.defaults[k] or '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
end


--[[
--[[--------------------------< S E T _ N O _ T R A C K I N G _ C A T S >-----------------------------------------
Looks for a parameter's name in the whitelist.
 
check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories


Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
]]
]]
function validate( name )
 
local name = tostring( name );
local function set_no_tracking_cats (no_tracking, no_tracking_source, this_page)
local state = whitelist.basic_arguments[ name ];
local no_tracking_cats = sanitized_parameter_value (no_tracking, no_tracking_source, 'yes_true_y', nil);
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
-- Normal arguments
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
if true == state then return true; end -- valid actively supported parameter
return true; -- set no_tracking_cats
if false == state then
end
deprecated_parameter (); -- parameter is deprecated but still supported
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
return true;
if this_page.text:match (v) then -- test page name against each pattern
end
return true; -- set no_tracking_cats; bail out if one is found
end
-- Arguments with numbers in them
end
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
return false;
state = whitelist.numbered_arguments[ name ];
else
if true == state then return true; end -- valid actively supported parameter
if false == state then
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
return true;
end
end
return false; -- Not supported because not found or name is set to nil
end
end


-- Formats a comment for error trapping
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
function errorcomment( content, hidden )
 
return wrap( hidden and 'hidden-error' or 'visible-error', content );
Set style settings for CS1 citation templates. Returns separator and postscript settings
end


--[[
Sets an error condition and returns the appropriate error message.  The actual placement
of the error message in the output is the responsibility of the calling function.
]]
]]
function seterror( error_id, arguments, raw, prefix, suffix )
 
local error_state = cfg.error_conditions[ error_id ];
local function set_cs1_style (ps)
if not is_set (ps) then -- unless explicitely set to something
prefix = prefix or "";
ps = '.'; -- terminate the rendered citation with a period
suffix = suffix or "";
if error_state == nil then
error( cfg.messages['undefined_error'] );
elseif is_set( error_state.category ) then
table.insert( z.error_categories, error_state.category );
end
local message = substitute( error_state.message, arguments );
message = message .. " ([[" .. cfg.messages['help page link'] ..
"#" .. error_state.anchor .. "|" ..
cfg.messages['help page label'] .. "]])";
z.error_ids[ error_id ] = true;
if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
and z.error_ids['citation_missing_title'] then
return '', false;
end
end
return '.', ps; -- separator is a full stop
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 2 _ S T Y L E >----------------------------------------------------
function externallinkid(options)
 
local url_string = options.id;
Set style settings for CS2 citation templates. Returns separator, postscript, ref 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]',
options.link, options.label, options.separator or "&nbsp;",
options.prefix, url_string, options.suffix or "",
mw.text.nowiki(options.id)
);
end


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


-- Format an external link with error checking
local function set_cs2_style (ps, ref)
function externallink( URL, label, source )
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
local error_str = "";
ps = ''; -- make sure it isn't nil
if not is_set( label ) then
label = URL;
if is_set( source ) then
error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
else
error( cfg.messages["bare_url_no_origin"] );
end
end
end
if not checkurl( URL ) then
if not is_set (ref) then -- if |ref= is not set
error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
ref = 'harv'; -- set default |ref=harv
end
end
return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
return ',', ps, ref; -- separator is a comma
end
end


-- Formats a link to Amazon
--[[--------------------------< 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 amazon(id, domain)
 
if not is_set(domain) then
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
domain = "com"
rendered style.
elseif ( "jp" == domain or "uk" == domain ) then
domain = "co." .. domain
end
local handler = cfg.id_handlers['ASIN'];
return externallinkid({link = handler.link,
label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
encode=handler.encode, separator = handler.separator})
end


--[[
format and error check arXiv identifier.  There are two valid forms of the identifier:
the first form, valid only between date codes 9108 and 0703 is:
arXiv:<archive>.<class>/<date code><number><version>
where:
<archive> is a string of alpha characters - may be hyphenated; no other punctuation
<class> is a string of alpha characters - may be hyphenated; no other punctuation
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
first digit of YY for this form can only 9 and 0
<number> is a three-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
the second form, valid from April 2007 is:
arXiv:<date code>.<number><version>
where:
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
<number> is a four-digit number
<version> is a 1 or more digit number preceded with a lowercase v; no spaces
]]
]]


function arxiv (id)
local function get_settings_from_cite_class (ps, ref, cite_class)
local handler = cfg.id_handlers['ARXIV'];
local sep;
local year, month, version;
if (cite_class == 'citation') then -- for citation templates (CS2)
local err_cat = ""
sep, ps, ref = set_cs2_style (ps, ref);
else -- not a citation template so CS1
year, month, version = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d([v%d]*)$"); -- test for the 9108-0703 format
sep, ps = set_cs1_style (ps);
if not year then -- arXiv id is not proper 9108-0703 form
year, month, version = id:match("^(%d%d)([01]%d)%.%d%d%d%d([v%d]*)$"); -- test for the 0704- format
if not year then
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- arXiv id doesn't match either format
else -- id is the 0704- format
year = tonumber(year);
month = tonumber(month);
if ((7 > year) or (1 > month and 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
((7 == year) and (4 > month)) or -- when year is 07, is month invalid (before April)?
is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
end
end
else -- id is the 9108-0703 format; are the date values ok
year = tonumber(year);
month = tonumber(month);
if ((91 > year and 7 < year) or (1 > month and 12 < month)) or -- if invalid year or invalid month
((91 == year and 8 > month) or (7 == year and 3 < month)) or -- if years ok, are starting and ending months ok?
is_set (version) and nil == version:match("v%d+") then -- is version proper format of single 'v' followed by digits?
err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message
end
end
end


return externallinkid({link = handler.link, label = handler.label,
return sep, ps, ref -- return them all
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
end


--[[
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
 
1. Remove all blanks.
Establish basic style settings to be used when rendering the citation. Uses |mode= if set and valid or uses
2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
config.CitationClass from the template's #invoke: to establish style.
3. If there is a hyphen in the string:
a. Remove it.
b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
1. All these characters should be digits, and there should be six or less. (not done in this function)
2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.


Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
]]
]]


function normalize_lccn (lccn)
local function set_style (mode, mode_source, ps, ref, quote, cite_class)
lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
local sep;
 
mode = sanitized_parameter_value (mode, mode_source, 'mode', ''):lower();
if nil ~= string.find (lccn,'/') then
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it
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
end
return sep, ps, ref
end


local prefix
--[[--------------------------< S W A P _ U R L S >--------------------------------------------------------------
local suffix
prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix


if nil ~= suffix then -- if there was a hyphen
]]
suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
 
lccn=prefix..suffix; -- reassemble the lccn
local function swap_urls (url_object, chapter_url_object, archive_url_object, dead_url)
end
local original_url_object = create_url_object ();
local is_dead = in_array (dead_url, cfg.keywords['deadurl-live']); -- used later when assembling archived text
return lccn;
if is_set (archive_url_object['url']) then
if is_set (url_object['url']) then
original_url_object = url_object;
if not is_dead then
url_object = archive_url_object;
end
elseif is_set (chapter_url_object['url']) then -- URL not set so if chapter-url is set apply archive url to it
original_url_object = chapter_url_object;
if not is_dead then
chapter_url_object = archive_url_object;
end
end
end
end
return original_url_object, url_object, chapter_url_object;
end


--[[
--[[--------------------------< F O R M A T _ U R L _ A C C E S S _ T E X T >---------------------------------------
Format LCCN link and do simple error checking. LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/


length = 8 then all digits
从x-url-access系列参数生成相应的图标；兼容既有registration, subscription参数，优先级x-url-access > subscription > registration。
length = 9 then lccn[1] is alpha
length = 10 then lccn[1] and lccn[2] are both alpha or both digits
length = 11 then lccn[1] is alpha, lccn[2] and lccn[3] are both alpha or both digits
length = 12 then lccn[1] and lccn[2] are both alpha


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


id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes)
local function format_url_access_text (url_object, subscription_required, registration_required)
local len = id:len(); -- get the length of the lccn
local access_text = '';
 
local redundant = false;
if 8 == len then
local access = url_object['access'];
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
local reg = false;
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
local sub = false;
if is_set (access) then
if (access == 'limited') then
access_text = cfg.presentation['limited']; -- 有限度免费访问
elseif (access == 'registration') then
access_text = cfg.presentation['registration']; -- 需要免费注册
reg = true;
elseif (access == 'subscription') then
access_text = cfg.presentation['subscription']; -- 需要付费订阅
sub = true;
else
access_text = '';
end
end
elseif 9 == len then -- LCCN should be adddddddd
if is_set (subscription_required) or is_set (registration_required) then
if nil == id:match("%a%d%d%d%d%d%d%d%d") then -- does it match our pattern?
redundant = true;
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
end
end
elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd
else
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ...
if is_set (subscription_required) then
if nil == id:match("^%a%a%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
access_text = cfg.presentation['subscription']; -- 需要免费注册
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
sub = true;
if is_set (registration_required) then
redundant = true;
end
end
elseif is_set (registration_required) then
access_text = cfg.presentation['registration']; -- 需要付费订阅
reg = true
else
access_text = '';
end
end
elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd
end
if not (id:match("^%a%a%a%d%d%d%d%d%d%d%d") or id:match("^%a%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns
if is_set (url_object ['url']) then
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
url_object['access-text'] = access_text;
end
if sub then
elseif 12 == len then -- LCCN should be aadddddddddd
add_maint_cat ('subscription');
if not id:match("^%a%a%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
elseif reg then
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
add_maint_cat ('registration');
end
end
else
else
err_cat = ' ' .. seterror( 'bad_lccn' ); -- wrong length, set an error message
-- 预留报错
end
end
return redundant;
end


if not is_set (err_cat) and nil ~= lccn:find ('%s') then
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------
err_cat = ' ' .. seterror( 'bad_lccn' ); -- lccn contains a space, set an error message
end


return externallinkid({link = handler.link, label = handler.label,
returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
or formatted issue, or an empty string if neither are set.
end


--[[
Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
]]
]]
function pmid(id)
local test_limit = 30000000; -- update this value as PMIDs approach
local handler = cfg.id_handlers['PMID'];
local err_cat =  ''; -- presume that PMID is valid
if id:match("[^%d]") then -- if PMID has anything but digits
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
if not is_set (volume) and not is_set (issue) then
else -- PMID is only digits
return '';
local id_num = tonumber(id); -- convert id to a number for range testing
end
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
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
end
end
return externallinkid({link = handler.link, label = handler.label,
local vol = '';
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
if is_set (volume) then
 
if (6 < mw.ustring.len (volume)) then
--[[
vol = wrap_msg ('j-vol', {sepc, volume}, lower);
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
else
in the future, returns true; otherwise, returns false because the embargo has expired or |embargo= not set in this cite.
vol = wrap_style ('vol-bold', hyphen_to_dash (volume));
]]
function is_embargoed(embargo)
if is_set(embargo) then
local lang = mw.getContentLanguage();
local good1, embargo_date, good2, todays_date;
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then --is embargo date is in the future?
return true; -- still embargoed
end
end
end
end
return false; -- embargo expired or |embargo= not set
if is_set (issue) then
return vol .. wrap_msg ('j-issue', issue, lower);
end
return vol;
end
end


--[[
--[[-------------------------< F O R M A T _ I N S O U R C E _ L O C A T I O N >----------------------------------
Format a PMC, do simple error checking, and check for embargoed articles.


The embargo parameter takes a date for a value. If the embargo date is in the future
Build insource_location meta-parameter from |page(s)= , |sheet(s)= , |at= and other relevant parameters.
the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.


PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
]]
function pmc(id, embargo)
 
local test_limit = 5000000; -- update this value as PMCs approach
local function format_insource_location (page, pages, sheet, sheets, at, minutes, time, time_caption, section, sections, inset, cite_class, origin, sepc, nopp, lower)
local handler = cfg.id_handlers['PMC'];
local text = '';
local err_cat = ''; -- presume that PMC is valid
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


if id:match("[^%d]") then -- if PMC has anything but digits
local is_journal = 'journal' == cite_class or (cite_class == 'map' and 'journal' == origin);
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
if is_set (page) then
else -- PMC is only digits
if is_journal then
local id_num = tonumber(id); -- convert id to a number for range testing
text = wrap_msg ('j-page(s)', page, lower);
if 1 > id_num or test_limit < id_num then -- if PMC is outside test limit boundaries
elseif not is_set (nopp) then
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
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
end
end
if is_embargoed(embargo) then
if is_set (minutes) then
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; --still embargoed so no external link
text = pend_separator (wrap_msg ('minutes', minutes, lower), sepc, true) .. text;
else
else
text = externallinkid({link = handler.link, label = handler.label, --no embargo date, ok to link to article
if is_set (time) then
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
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
end
return text;
return text;
end
end


-- Formats a DOI and checks for DOI errors.
--[[-------------------------< F O R M A T _ P U B L I S H E R >------------------------------------------


-- DOI names contain two parts: prefix and suffix separated by a forward slash.
]]
--  Prefix: directory indicator '10.' followed by a registrant code
--  Suffix: character string of any length chosen by the registrant


-- This function checks a DOI name for: prefix/suffix.  If the doi name contains spaces or endashes,
local function format_publisher (publisher_name, publication_place, periodical, cite_class, sepc)
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.
local publisher = '';
 
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.
 
function doi(id, inactive)
local cat = ""
local handler = cfg.id_handlers['DOI'];
local text;
if is_set (publisher_name) then
if is_set(inactive) then
if is_set (publication_place) then
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
publisher = publication_place .. ': ' .. publisher_name;
text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
if is_set(inactive_year) then
table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
else
else
table.insert( z.error_categories, "Pages with inactive DOIs" ); -- when inactive doesn't contain a recognizable year
publisher = publisher_name;
end
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
elseif is_set (publication_place) then
else
publisher = publication_place;
text = externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
inactive = ""
end
end
 
if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
if is_set (publisher) then
cat = ' ' .. seterror( 'bad_doi' );
if is_set (periodical) and
not in_array (cite_class, {'encyclopaedia', 'web', 'pressrelease', 'podcast'}) then
publisher = ' (' .. publisher .. ')';
else
publisher = pend_separator (publisher, sepc, true);
end
end
end
return text .. inactive .. cat
return publisher;
end
end


-- Formats an OpenLibrary link, and checks for associated errors.
--[[-------------------------< F O R M A T _ L I N K >-------------------------------------------------
function openlibrary(id)
 
local code = id:sub(-1,-1)
Format an external link that may or may not be raw.
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_external_link (text, url_object, sepc)
encode = handler.encode})
if is_set (text) then
elseif ( code == "M" ) then
if is_set (url_object['url']) then
return externallinkid({link=handler.link, label=handler.label,
text = make_external_link (url_object['url'], text, url_object['origin']);
prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
end
encode = handler.encode})
text = pend_separator (text .. url_object['format'], sepc, true);
elseif ( code == "W" ) then
elseif is_set (url_object['url']) then
return externallinkid({link=handler.link, label=handler.label,
text = make_external_link (url_object['url'], nil, url_object['origin']);
prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
encode = handler.encode})
else
return externallinkid({link=handler.link, label=handler.label,
prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
encode = handler.encode}) ..
' ' .. seterror( 'bad_ol' );
end
end
return text;
end
end


--[[
--[[-------------------------< F O R M A T _ C O N F E R E N C E >----------------------------------------
Validate and format an issn.  This code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
digits with a space.  When that condition occurred, the resulting link looked like this:


|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
This code now prevents that by inserting a hyphen at the issn midpoint.  It also validates the issn for length and makes sure that the checkdigit agrees
with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
]]
]]
function issn(id)
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
local handler = cfg.id_handlers['ISSN'];
local text;
local valid_issn = true;


id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn
local function format_conference (conference, conference_url_object, periodical, cite_class, sepc)
local  conf_text = format_external_link (conference, conference_url_object, sepc);
if 'speech' == cite_class and is_set (periodical) then
-- if cite speech, periodical (perhaps because of an included |website= or |journal= parameter) is set;
conf_text = pend_separator (conf_text, sepc, false); -- then add appropriate punctuation to the end of the conference variable if set.
end
return conf_text;
end


if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
valid_issn=false; -- wrong length or improper character
else
valid_issn=is_valid_isxn(id, 8); -- validate issn
end


if true == valid_issn then
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
parameter (chapter_url_source used for error messages).
else
id = issn_copy; -- if not valid, use the show the invalid issn with error message
end
text = externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
if false == valid_issn then
text = text .. ' ' .. seterror( 'bad_issn' ) -- add an error message if the issn is invalid
end
return text
end


--[[
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
]]
]]
function set_titletype(cite_class, title_type)
 
if is_set(title_type) then
local function format_chapter_title (scriptchapter, chapter, transchapter, chapter_url_object, no_quotes, cite_class, title_type, sepc)
if "none" == title_type then
local chapter_error = '';
title_type = ""; -- if |type=none then type parameter not displayed
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
return title_type; -- if |type= has been set to any other value use that value
end
end


if "AV-media-notes" == cite_class or "DVD-notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
return "Media notes"; -- display AV media notes / DVD media notes annotation


elseif "podcast" == cite_class then -- if this citation is cite podcast
if is_set (transchapter) then
return "Podcast"; -- display podcast annotation
transchapter = wrap_style ('trans-quoted-title', transchapter);
 
if is_set (chapter) then
elseif "pressrelease" == cite_class then -- if this citation is cite press release
chapter = chapter ..  ' ' .. transchapter;
return "Press release"; -- display press release annotation
else -- here when transchapter without chapter or script-chapter
 
chapter = transchapter;
elseif "techreport" == cite_class then -- if this citation is cite techreport
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
return "Technical report"; -- display techreport annotation
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;
elseif "thesis" == cite_class then -- if this citation is cite thesis (degree option handled after this function returns)
if is_set (chapter) then
return "Thesis"; -- display simple thesis annotation (without |degree= modification)
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
end
return chapter;
end
end


--[[
--[[--------------------------< F O R M A T _ M A I N _ T I T L E >------------------------------------------
Determines whether a URL string is valid
 
Format the five title parameters: |script-title=, |title=, |trans-title=, |title-link=, and |url= into a single Title meta-
parameter (url_origin and title_link_origin used for error messages).


At present the only check is whether the string appears to
be prefixed with a URI scheme.  It is not determined whether
the URI scheme is valid or whether the URL is otherwise well
formed.
]]
]]
function checkurl( url_str )
-- Protocol-relative or URL scheme
return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
end


-- Removes irrelevant text and dashes from ISBN number
local function format_main_title (title, title_link, title_link_origin, script_title, trans_title, url_object, no_chapter_format, cite_class, periodical)
-- Similar to that used for Special:BookSources
if is_set (title_link) and is_set (title) then
function cleanisbn( isbn_str )
title = make_internal_link (title_link, title, title_link_origin);
return isbn_str:gsub( "[^-0-9X]", "" );
end
end
if no_chapter_format or
('map' == cite_class and is_set (periodical)) then -- special case for cite map when the map is in a periodical treat as an article
title = kern_quotes (title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
title = wrap_style ('quoted-title', title);
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title= wrap_style ('trans-quoted-title', trans_title );
elseif 'report' == cite_class then -- no styling for cite report
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title= wrap_style ('trans-quoted-title', trans_title ); -- for cite report, use this form for trans-title
else
title = wrap_style ('italic-title', title);
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title = wrap_style ('trans-italic-title', trans_title);
end


-- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
local trans_error = '';
--TODO: Fix so this code supports urls like this:
if is_set (trans_title) then
-- http://www.history.navy.mil/download/va125153.pdf#page=13 %w/:\.
if is_set (title) then
function get_coins_pages (pages)
trans_title = ' ' .. trans_title;
if not is_set (pages) then return pages; end -- if no page numbers then we're done
else
trans_error = ' ' .. set_error ('trans_missing_title', {'title'});
end
end
while true do
title = title .. trans_title;
pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
if nil == pattern then break; end -- no more urls
if is_set (title) then
pattern = pattern:gsub("([%^%$%(%)%%%.%[%]%*%+%-%?])", "%%%1"); -- pattern is not a literal string; escape lua's magic pattern characters
if not is_set (title_link) and is_set (url_object['url']) then  
pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
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
end
pages = pages:gsub("[%[%]]", ""); -- remove the brackets
return title, url_object;
pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
return pages;
end
end


--[[
--[[--------------------------< F O R M A T  _ F O R M A T >--------------------------------------------------------
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
 
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
Applies css style to |format=, |chapter-format=, etc.  Also emits an error message if the format parameter does
spaces and other non-isxn characters.
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 is_valid_isxn (isxn_str, len)
 
local temp = 0;
local function format_format (args)
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes
for _, url_object in pairs (args) do
len = len+1; -- adjust to be a loop counter
if is_set (url_object['format']) then
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
url_object['format'] = wrap_style ('format', url_object['format']); -- add leading space, parenthases, resize
if v == string.byte( "X" ) then -- if checkdigit is X
if not is_set (url_object['url']) then
temp = temp + 10*( len - i ); -- it represents 10 decimal
url_object['format'] = url_object['format'] .. set_error ('format_missing_url', {url_object['format-origin'], url_object['origin']});
else
-- add an error message
temp = temp + tonumber( string.char(v) )*(len-i);
end
elseif is_set (url_object['url']) then
if url_object['url']:match ('%.pdf[%?#]?') or url_object['url']:match ('%.PDF[%?#]?') then
-- format is not set so if url is a pdf file then
url_object['format'] = wrap_style ('format', 'PDF'); -- set format to pdf
end
end
end
end
end
return temp % 11 == 0; -- returns true if calculation result is zero
end
end


-- Determines whether an ISBN string is valid
--[[--------------------------< F O R M A T _ A C C E S S D A T E >----------------------------------------------
function checkisbn( isbn_str )
 
if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
]]
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
local len = isbn_str:len();
if len ~= 10 and len ~= 13 then
return false;
end


if len == 10 then
local function format_accessdate (accessdate, sepc, lower)
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
if is_set (accessdate) then -- first, wrap in nowrap span if date in appropriate format
return is_valid_isxn(isbn_str, 10);
if accessdate:match ('^%d%d%d%d%-%d%d%-%d%d$') then
else
accessdate = wrap_style ('nowrap1', accessdate); -- when accessdate is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
local temp = 0;
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
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
local cap, cap2 = string.match (accessdate, '^(.*)%s+(%d%d%d%d)$');
isbn_str = { isbn_str:byte(1, len) };
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
for i, v in ipairs( isbn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
end
end
return temp % 10 == 0;
accessdate = ' ' .. wrap_msg ('retrieved', accessdate, lower); -- add retrieved text
accessdate = wrap_style ('accessdate', {sepc, accessdate}); -- allow editors to hide accessdates
end
end
return accessdate;
end
end


-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
--[[--------------------------< F O R M A T _ I D >----------------------------------------------------
function removewikilink( str )
]]
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end


-- Escape sequences for content that will be used for URL descriptions
local function format_id (id, docket, sepc, lower)
function safeforurl( str )
id = pend_separator (id, sepc, true);
do return str end -- LOCAL HACK https://en.wikipedia.org/w/index.php?title=Module_talk:Citation/CS1&diff=552318417&oldid=552202448
return pend_separator (wrap_msg ('docket', docket, lower), sepc, true) .. id;
if str:match( "%[%[.-%]%]" ) ~= nil then
table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
end
return str:gsub( '[%[%]\n]', {
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end
end


-- Converts a hyphen to a dash
--[[--------------------------< F O R M A T _ Q U O T E >----------------------------------------------
function hyphentodash( str )
]]
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
return str;
end
return str:gsub( '-', '–' );
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
local function format_quote (quote, sepc)
function safeforitalics( str )
if is_set (quote) then
--[[ Note: We cannot use <i> for italics, as the expected behavior for
if quote:sub (1, 1) == '"' and quote:sub (-1, -1) == '"' then -- if first and last characters of quote are quote marks
italics specified by ''...'' in the title is that they will be inverted
quote = quote:sub (2, -2); -- strip them off
(i.e. unitalicized) in the resulting references.  In addition, <i> and ''
end
tend to interact poorly under Mediawiki's HTML tidy. ]]
return pend_separator (wrap_style ('quoted-text', quote), sepc, true); -- wrap in <q>...</q> tags
if not is_set(str) then
return str;
else
if str:sub(1,1) == "'" then str = "<span />" .. str; end
if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
-- Remove newlines as they break italics.
return str:gsub( '\n', ' ' );
end
end
return '';
end
end


--[[
--[[--------------------------< F O R M A T _ A R C H I V E >------------------------------------------
Joins a sequence of strings together while checking for duplicate separation characters.


TODO: safejoin() has a flaw where it won't remove the duplicate character from a |title= / |url= combination.
This is because by the time we get here, |title=http://somesite.com and |title=Document Title. have been combined:
[http://somesite.com and ''Document Title.'']
so that now, the last character is not sepc but is ] (unless sepc == ']' which breaks the external link)
]]
]]
function safejoin( tbl, duplicate_char )
 
--[[
local function format_archive (archive_url_object, original_url_object, archive_date, dead_url, sepc, lower)
Note: we use string functions here, rather than ustring functions.
local archived = '';
if is_set (archive_url_object['url']) then
This has considerably faster performance and should work correctly as
if not is_set (archive_date) then
long as the duplicate_char is strict ASCII.  The strings
archive_date = set_error ('archive_missing_date');
in tbl may be ASCII or UTF8.
end
]]
if in_array (dead_url, cfg.keywords['deadurl-live']) then
local arch_text = cfg.messages['archived'];
local str = '';
if (lower) then arch_text = arch_text:lower(); end;
local comp = '';
archived = pend_separator (wrap_msg ('archived-not-dead', {make_external_link (archive_url_object['url'], arch_text, archive_url_object['origin']) .. archive_url_object['format'], archive_date }, lower), sepc, true);
local end_chr = '';
if not is_set (original_url_object['url']) then
local trim;
archived = archived .. ' ' .. set_error ('archive_missing_url');  
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
end
elseif is_set (original_url_object['url']) then -- dead_url is not live, so it should be empty, dead or unfit
if comp:sub(1,1) == duplicate_char then
if in_array (dead_url, cfg.keywords['deadurl-unfit']) then
trim = false;
archived = pend_separator (wrap_msg('archived-unfit', archive_date, lower), sepc, true);
end_chr = str:sub(-1,-1);
-- format already styled
-- str = str .. "<HERE(enchr=" .. end_chr.. ")"
else -- dead_url is empty or dead
if end_chr == duplicate_char then
archived = pend_separator (wrap_msg ('archived-dead',
str = str:sub(1,-2);
{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);
elseif end_chr == "'" then
-- format already styled
if str:sub(-3,-1) == duplicate_char .. "''" then
str = str:sub(1, -4) .. "''";
elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
trim = true;
elseif str:sub(-4,-1) == duplicate_char .. "]''" then
trim = true;
end
elseif end_chr == "]" then
if str:sub(-3,-1) == duplicate_char .. "]]" then
trim = true;
elseif str:sub(-2,-1) == duplicate_char .. "]" then
trim = true;
end
elseif end_chr == " " then
if str:sub(-2,-1) == duplicate_char .. " " then
str = str:sub(1,-3);
end
end
 
if trim then
if value ~= comp then
local dup2 = duplicate_char;
if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
else
value = value:sub( 2, -1 );
end
end
end
end
str = str .. value;
else
archived = pend_separator (wrap_msg ('archived-missing',
{set_error ('archive_missing_url'), archive_date }, lower), sepc, true);
end
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
end
return str;
return archived;
end
end
 
--[[--------------------------< F O R M A T _ L A Y >---------------------------------------------------
 
]]


-- Attempts to convert names to initials.
local function format_lay (lay_url_object, lay_date, lay_source, sepc, lower)
function reducetoinitials(first)
local lay = '';
local initials = {}
if is_set (lay_url_object['url']) then
local i = 0; -- counter for number of initials
if is_set (lay_date) then lay_date = ' (' .. lay_date .. ')' end
for word in string.gmatch(first, "%S+") do
if is_set (lay_source) then
table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
lay_source = wrap_msg ('lay source', lay_source, lower);
i = i + 1; -- bump the counter
else
if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit
lay_source = '';
end
local lay_sum = cfg.messages['lay summary'];
if lower then
lay_sum = lay_sum:lower();
end
lay = pend_separator (make_external_link (lay_url_object['url'], lay_sum, lay_url_object['origin']) .. lay_url_object['format'] .. lay_source .. lay_date, sepc, true);
else -- Test if |lay-format= is given without giving a |lay-url=
lay = pend_separator (lay_url_object['format'], sepc, true); -- if set and LayURL not set, then LayFormat has error message
end
end
return table.concat(initials) -- Vancouver format does not include spaces.
return lay;
end
end


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


local count = #text / 2;
local function format_periodical (periodical, title, title_note, sepc)
if count > 0 then  
if is_set (periodical) then
if count > 1 and is_set(lastauthoramp) and not etal then
if is_set (title) or is_set (title_note) then  
text[#text-2] = " & ";
return pend_separator (wrap_style ('italic-title', periodical), sepc, true);
else
return wrap_style ('italic-title', periodical);
end
end
text[#text] = nil;
end
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
end
return '';
-- 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.
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
function anchorid( options )
return "CITEREF" .. table.concat( options );
end


--[[
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
Gets name list from the input arguments


Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year.
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
find |last4= and |last5= then the search is done.


This function emits an error message when there is a |firstn= without a matching |lastn=.  When there are 'holes' in the list of last names, |last1= and |last3=
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
]]
]]
--Original function
function extractnames(args, list_name)
    local names = {};
    local i = 1;
    local last;
    while true do
        last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
        if not is_set(last) then
            -- just in case someone passed in an empty parameter
            break;
        end
        names[i] = {
            last = last,
            first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
        };
        i = i + 1;
    end
    return names;
end


--[[ Broken.  Editor CITEREF IDs are broken by this code (no editor list). Author CITEREF ID render correctly
local function anchor_id (namelist, year)
function extractnames(args, list_name)
local names={}; -- a table for the one to four names and year
local names = {}; -- table of names
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
local i = 1; -- loop counter/indexer
names[i] = v.last  
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
if i == 4 then break end -- if four then done
end
local err_msg_list_name = list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary
table.insert (names, year); -- add the year at the end
 
local id = table.concat (names); -- concatenate names and year for CITEREF id
while true do
if is_set (id) then -- if concatenation is not an empty string
names[i] = -- search through args for name components beginning at 1
return 'CITEREF' .. id; -- add the CITEREF portion
{
else
last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ),
return ''; -- return an empty string; no reason to include CITEREF id in this citation
first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
};
if names[i].first and not names[i].last then -- if there is a firstn without a matching lastn
names[i].first = nil; -- set first to nil so we don't confuse the implicit et al message code
table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
break; -- and done because lastn not found
elseif not names[i].first and not names[i].last then -- if both firstn and lastn aren't found, are we done?
count = count + 1; -- number of times we haven't found last and first
if 2 == count then -- two missing names and we give up
break; -- normal exit or there is a two-name hole in the list; can't tell which
end
else -- last with or without a first
if 1 == count then -- if the previous name was missing
table.insert( z.message_tail, { seterror( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
i = i + 1; -- bump to the next name
end
end
return names; -- all done, return our list of names
end
end
]]


--[[--------------------------< F O R M A T _ C I T A T I O N >--------------------------------------------


]]


-- Populates ID table from arguments using configuration settings
local function format_citation (body, cite_class, ref, namelist, year, ocins_output, no_tracking_cats)
function extractids( args )
local options = {};
local id_list = {};
for k, v in pairs( cfg.id_handlers ) do
if is_set (cite_class) and cite_class ~= 'citation' then
v = selectone( args, v.parameters, 'redundant_parameters' );
options.class = 'citation ' .. cite_class; -- class=citation required for blue highlight when used with |ref=
if is_set(v) then id_list[k] = v; end
else
options.class = 'citation';
end
end
return id_list;
end
-- Takes a table of IDs and turns it into a table of formatted ID outputs.
function buildidlist( id_list, options )
local new_list, handler = {};
function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
if is_set (ref) and ref:lower() ~= 'none' then -- set reference anchor if appropriate
local id = ref
for k, v in pairs( id_list ) do
if ('harv' == ref ) then
-- fallback to read-only cfg
id = anchor_id (namelist, year); -- go make the CITEREF anchor
handler = setmetatable( { ['id'] = v }, fallback(k) );
if handler.mode == 'external' then
table.insert( new_list, {handler.label, externallinkid( handler ) } );
elseif handler.mode == 'internal' then
table.insert( new_list, {handler.label, internallinkid( handler ) } );
elseif handler.mode ~= 'manual' then
error( cfg.messages['unknown_ID_mode'] );
elseif k == 'DOI' then
table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
elseif k == 'ARXIV' then
table.insert( new_list, {handler.label, arxiv( v ) } );
elseif k == 'ASIN' then
table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
elseif k == 'LCCN' then
table.insert( new_list, {handler.label, lccn( v ) } );
elseif k == 'OL' then
table.insert( new_list, {handler.label, openlibrary( v ) } );
elseif k == 'PMC' then
table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
elseif k == 'PMID' then
table.insert( new_list, {handler.label, pmid( v ) } );
elseif k == 'ISSN' then
table.insert( new_list, {handler.label, issn( v ) } );
elseif k == 'ISBN' then
local ISBN = internallinkid( handler );
if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
end
table.insert( new_list, {handler.label, ISBN } );
else
error( cfg.messages['unknown_manual_ID'] );
end
end
options.id = id;
end
end
function comp( a, b ) -- used in following table.sort()
if string.len (body:gsub ('<span[^>/]*>.-</span>', ''):gsub ('%b<>','')) <= 2 then
return a[1] < b[1];
reset_error ({'err_cats'});
body = set_error ('empty_citation');
reset_error ({'msg_tail'});
end
end
table.sort( new_list, comp );
local text;
for k, v in ipairs( new_list ) do
new_list[k] = v[2];
if is_set (options.id) then
end
text = wrap_style ('citation-with-id', {mw.uri.anchorEncode (options.id), mw.text.nowiki (options.class), body});
else
text = wrap_style ('citation-no-id', {mw.text.nowiki (options.class), body});
end
text = text .. wrap_style ('OCinS', ocins_output);
text = text .. make_error_tail (no_tracking_cats); -- append error/maintenance messages/categories to the citation
return new_list;
return text;
end
end
 
 
-- Chooses one matching parameter from a list of parameters to consider
--[[--------------------------< D E D U C E _ C I T A T I O N _ C L A S S >--------------------------------------
-- Generates an error if more than one match is present.
 
function selectone( args, possible, error_condition, index )
如果citation_class为citation（{{citation}}），根据periodical系列参数的设置情况推断实际的引用类型。
local value = nil;
 
local selected = '';
]]
local error_list = {};
 
local function deduce_citation_class (A, naive_class)
local deduced_class;
local periodical = A['Periodical'];
local origin = A:ORIGIN ('Periodical');
if index ~= nil then index = tostring(index); end
for cite_class, aliases in pairs (cfg.periodical.parameters) do
if cite_class ~= '_general' then
-- Handle special case of "#" replaced by empty string
for _, aliase in pairs (aliases) do
if index == '1' then
if origin == aliase then
for _, v in ipairs( possible ) do
deduced_class = cite_class;
v = v:gsub( "#", "" );
if is_set(args[v]) then
if value ~= nil and selected ~= v then
table.insert( error_list, v );
else
value = args[v];
selected = v;
end
end
end
end
end
end
end
end
for _, v in ipairs( possible ) do
if (naive_class == 'citation') then
if index ~= nil then
if is_set (deduced_class) then
v = v:gsub( "#", index );
return deduced_class, true;
end
end
if is_set(args[v]) then
elseif (naive_class ~= deduced_class) then
if value ~= nil and selected ~=  v then
local check_list = cfg.periodical.compatibility[naive_class];
table.insert( error_list, v );
if is_set (check_list) then
else
if is_set (check_list['drop']) and in_array (deduced_class, check_list['drop']) then
value = args[v];
A['Periodical'] = discard_parameter (periodical, origin, nil);
selected = v;
elseif is_set (check_list['warn']) and in_array (deduced_class, check_list['warn']) then
append_error ('periodical', {origin, naive_class, deduced_class, check_list['suggest']});
end
end
end
end
end
end
return naive_class, false;
if #error_list > 0 then
local error_str = "";
for _, k in ipairs( error_list ) do
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
error_str = error_str .. wrap( 'parameter', k );
end
if #error_list > 1 then
error_str = error_str .. cfg.messages['parameter-final-separator'];
else
error_str = error_str .. cfg.messages['parameter-pair-separator'];
end
error_str = error_str .. wrap( 'parameter', selected );
table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
end
return value, selected;
end
end


-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
 
-- the citation information.
--[[--------------------------< A R G U M E N T _ W R A P P E R >----------------------------------------------
function COinS(data)
 
if 'table' ~= type(data) or nil == next(data) then
Argument wrapper.  This function provides support for argument mapping defined in the configuration file so that
return '';
multiple names can be transparently aliased to single internal variable.
end
 
]]
 
local function argument_wrapper (args)
local origin = {};
local ctx_ver = "Z39.88-2004";
return setmetatable ({
ORIGIN = function (self, k)
-- treat table strictly as an array with only set values.
local dummy = self[k]; --force the variable to be loaded.
local OCinSoutput = setmetatable( {}, {
return origin[k];
__newindex = function(self, key, value)
if is_set(value) then
rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
end
end
end
});
},
{
if is_set(data.Chapter) then
__index = function (tbl, k)
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
if origin[k] ~= nil then
OCinSoutput["rft.genre"] = "bookitem";
return nil;
OCinSoutput["rft.btitle"] = data.Chapter;
OCinSoutput["rft.atitle"] = data.Title;
elseif is_set(data.Periodical) then
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
OCinSoutput["rft.genre"] = "article";
OCinSoutput["rft.jtitle"] = data.Periodical;
OCinSoutput["rft.atitle"] = data.Title;
else
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
OCinSoutput["rft.genre"] = "book"
OCinSoutput["rft.btitle"] = data.Title;
end
OCinSoutput["rft.place"] = data.PublicationPlace;
OCinSoutput["rft.date"] = data.Date;
OCinSoutput["rft.series"] = data.Series;
OCinSoutput["rft.volume"] = data.Volume;
OCinSoutput["rft.issue"] = data.Issue;
OCinSoutput["rft.pages"] = data.Pages;
OCinSoutput["rft.edition"] = data.Edition;
OCinSoutput["rft.pub"] = data.PublisherName;
for k, v in pairs( data.ID_list ) do
local id, value = cfg.id_handlers[k].COinS;
if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
if string.sub( id or "", 1, 4 ) == 'info' then
OCinSoutput["rft_id"] = table.concat{ id, "/", v };
else
OCinSoutput[ id ] = value;
end
end
local last, first;
for k, v in ipairs( data.Authors ) do
last, first = v.last, v.first;
if k == 1 then
if is_set(last) then
OCinSoutput["rft.aulast"] = last;
end
end
if is_set(first) then  
OCinSoutput["rft.aufirst"] = first;
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
end
end
if is_set(last) and is_set(first) then
-- Empty strings, not nil;
OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
if v == nil then
elseif is_set(last) then
v = cfg.defaults[k] or '';
OCinSoutput["rft.au"] = last;
origin[k] = '';
end
end
end
tbl = rawset (tbl, k, v);
OCinSoutput.rft_id = data.URL;
return v;
OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
end,
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


--[[
--[[--------------------------< D O _ C I T A T I O N >---------------------------------------------------------
This is the main function doing the majority of the citation
 
formatting.
This is the main function doing the majority of the citation formatting.
 
]]
]]
function citation0( config, args, frame ) -- LOCAL
 
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
Load Input Parameters
The argument_wrapper facilitates the mapping of multiple
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
aliases to single internal variable.
]]
]]
local A = argument_wrapper( args );
local A = argument_wrapper (args);
local citation_class, did_duduction = deduce_citation_class (A, config.CitationClass);


local i
local PPrefix = A['PPrefix']
local PPPrefix = A['PPPrefix']
if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
-- LOCAL
local PSuffix = A['PSuffix']
local PPSuffix = A['PPSuffix']
if ( nil ~= A['NoPP'] ) then PPSuffix = "" PSuffix = "" end
-- END LOCAL
-- Pick out the relevant fields from the arguments.  Different citation templates
-- Pick out the relevant fields from the arguments.  Different citation templates
-- define different field names for the same underlying things.
-- define different field names for the same underlying things.
local Authors = A['Authors'];
------------------------------------------------- Get dates
local a = extractnames( args, 'AuthorList' );
 
local Coauthors = A['Coauthors'];
local Others = A['Others'];
local Editors = A['Editors'];
local e = extractnames( args, 'EditorList' );
 
local Year = A['Year'];
local Year = A['Year'];
local PublicationDate = A['PublicationDate'];
local PublicationDate = A['PublicationDate'];
local OrigYear = A['OrigYear'];
local OrigYear = A['OrigYear'];
local Date = A['Date'];
local Date = A['Date'];
local Dateorigin = A:ORIGIN ('Date');
local LayDate = A['LayDate'];
local LayDate = A['LayDate'];
------------------------------------------------- Get title data
------------------------------------------------- Get title data
local Title = A['Title'];
local Title = A['Title'];
local BookTitle = A['BookTitle'];
local ScriptTitle = A['ScriptTitle'];
local Conference = A['Conference'];
local Conference = A['Conference'];
local TransTitle = A['TransTitle'];
local TransTitle = A['TransTitle'];
local TitleNote = A['TitleNote'];
local TitleNote = A['TitleNote'];
local TitleLink = A['TitleLink'];
local TitleLink = A['TitleLink'];
local Chapter = A['Chapter'];
local TitleLinkorigin = A:ORIGIN ('TitleLink');
local ChapterLink = A['ChapterLink'];
local TransChapter = A['TransChapter'];
local TitleType = A['TitleType'];
local Degree = A['Degree'];
local Docket = A['Docket'];
local ArchiveURL = A['ArchiveURL'];
local URL = A['URL']
local URLorigin = A:ORIGIN('URL');
local ChapterURL = A['ChapterURL'];
local ChapterURLorigin = A:ORIGIN('ChapterURL');
local ConferenceURL = A['ConferenceURL'];
local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
local Periodical = A['Periodical'];
local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN ('Periodical'); -- get the name of the periodical parameter


local Series = A['Series'];
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 Volume = A['Volume'];
local Issue = A['Issue'];
local Issue = A['Issue'];
local Position = '';
local Page = A['Page'];
local Page = A['Page'];
local Pages = hyphentodash( A['Pages'] );
local Pages = hyphen_to_dash (A['Pages']);
local At = A['At'];
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 Edition = A['Edition'];
local PublicationPlace = A['PublicationPlace']
local PublicationPlace = A['PublicationPlace']
第1,239行： 第1,089行：
local PublisherName = A['PublisherName'];
local PublisherName = A['PublisherName'];
local RegistrationRequired = A['RegistrationRequired'];
local RegistrationRequired = sanitized_parameter_value (A['RegistrationRequired'], A:ORIGIN ('RegistrationRequired'), 'yes_true_y', nil);
local SubscriptionRequired = A['SubscriptionRequired'];
local SubscriptionRequired = sanitized_parameter_value (A['SubscriptionRequired'], A:ORIGIN ('SubscriptionRequired'), 'yes_true_y', nil);
local Via = A['Via'];
local Via = A['Via'];
local AccessDate = A['AccessDate'];
local AccessDate = A['AccessDate'];
local ArchiveDate = A['ArchiveDate'];
local ArchiveDate = A['ArchiveDate'];
local Agency = A['Agency'];
local Agency = A['Agency'];
local DeadURL = A['DeadURL']
local DeadURL = sanitized_parameter_value (A['DeadURL'], A:ORIGIN ('DeadURL'), 'deadurl', '');
 
local Language = A['Language'];
local Language = A['Language'];
local Format = A['Format'];
local Ref = A['Ref'];
local DoiBroken = A['DoiBroken'];
local DoiBroken = A['DoiBroken'];
local ID = A['ID'];
local ID = A['ID'];
local ASINTLD = A['ASINTLD'];
local ASINTLD = A['ASINTLD'];
local IgnoreISBN = A['IgnoreISBN'];
local IgnoreISBN = sanitized_parameter_value (A['IgnoreISBN'], A:ORIGIN ('IgnoreISBN'), 'yes_true_y', nil);
local Embargo = A['Embargo'];
local Embargo = A['Embargo'];
local Class = A['Class']; -- arxiv class identifier


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


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


local LastAuthorAmp = A['LastAuthorAmp'];
local no_tracking_cats = set_no_tracking_cats (A['NoTracking'], A:ORIGIN ('NoTracking'), this_page);
local no_tracking_cats = A['NoTracking'];
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


--these are used by cite interview
-- check for insource-location-related parameters like |page=, |pages= or |at=. 请注意section参数有歧义，如果section跟书有关系，上面已经被清空了，这里不纳入检查。
local Callsign = A['Callsign'];
select_one (args, {'at', 'time', 'minutes'}, 'redundant_parameters');
local City = A['City'];
select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'time', 'minutes', 'sheet', 'sheets'}, 'redundant_parameters');
local Cointerviewers = A['Cointerviewers']; -- deprecated
if is_set (Section) then
local Interviewer = A['Interviewer']; -- deprecated
select_one (args, {'at', 'section', 'sections'}, 'redundant_parameters');
local Program = A['Program'];
 
--local variables that are not cs1 parameters
local page_type; -- is this needed?  Doesn't appear to be used anywhere;
local use_lowercase = ( sepc ~= '.' );
local this_page = mw.title.getCurrentTitle(); --Also used for COinS and for language
local anchor_year; -- used in the CITEREF identifier
local COinS_date; -- used in the COinS metadata
 
-- Set postscript default.
if not is_set (PostScript) then -- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
if (config.CitationClass ~= "citation") then -- this template is not a citation template
PostScript = '.'; -- must be a cite xxx template so set postscript to default (period)
end
else
else
if PostScript:lower() == 'none' then -- if |postscript=none then
select_one (args, {'at', 'sections'}, 'redundant_parameters');
PostScript = ''; -- no postscript
end
end
 
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories.
if not is_set(no_tracking_cats) then -- ignore if we are already not going to categorize this page
for k, v in pairs( cfg.uncategorized_namespaces ) do -- otherwise, spin through the list of namespaces we don't include in error categories
if this_page.nsText == v then -- if we find one
no_tracking_cats = "true"; -- set no_tracking_cats
break; -- and we're done
end
end
end
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);


-- check for extra |page=, |pages= or |at= parameters.
if is_set (Page) then
if is_set(Page) then
if is_set (Pages) or is_set (At) then
if is_set(Pages) or is_set(At) then
Pages = ''; -- unset the others
Page = Page .. " " .. seterror('extra_pages'); -- add error message
Pages = ''; -- unset the others
At = '';
At = '';
end
end
elseif is_set(Pages) then
extra_text_in_parameter_check (Page, 'page'); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
if is_set(At) then
elseif is_set (Pages) then
Pages = Pages .. " " .. seterror('extra_pages'); -- add error messages
if is_set (At) then
At = ''; -- unset
At = ''; -- unset
end
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
end


-- both |publication-place= and |place= (|location=) allowed if different
-- both |publication-place= and |place= (|location=) allowed if different
if not is_set(PublicationPlace) and is_set(Place) then
if not is_set (PublicationPlace) and is_set (Place) then
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
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'];
--[[
--[[
第1,341行： 第1,196行：


|trans_title maps to |trans_chapter when |title is re-mapped
|trans_title maps to |trans_chapter when |title is re-mapped
|url maps to |chapterurl when |title is remapped


All other combinations of |encyclopedia, |title, and |article are not modified
All other combinations of |encyclopedia, |title, and |article are not modified
]]
]]
if ( config.CitationClass == "encyclopaedia" ) then
 
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
local Encyclopedia;
if is_set(Title) then
local Entry = A['Entry'];
if not is_set(Chapter) then
 
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
if (citation_class == 'encyclopaedia') then -- test code for citation
TransChapter = TransTitle;
local entry_redundant = false
Title = Periodical;
Encyclopedia = Periodical;
Periodical = ''; -- redundant so unset
if is_set (Periodical) then
TransTitle = ''; -- redundant so unset
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
end
else -- |title not set
TitleLink = '';
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
entry_redundant = is_set (Entry);
Periodical = ''; -- redundant so unset
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
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
end
 
--special cases for citation.
-- Special case for cite report.
if (config.CitationClass == "citation") then -- for citation templates
local Docket = A['Docket'];
if not is_set (Ref) then -- if |ref= is not set
if citation_class == 'report' then
Ref = "harv"; -- set default |ref=harv
if is_set (Docket) then
end
if is_set (ID) then
if not is_set (sepc) then -- if |separator= is not set
select_one (args, {'id', 'docket'}, 'redundant_parameters');
sepc = ','; -- set citation separator to its default (comma)
end
end
ID = Docket; -- for cite report when |docket= is set, overwrite ID even if |id= is set
else -- not a citation template
Docket = '';
if not is_set (sepc) then -- if |separator= has not been set
sepc = '.'; -- set cite xxx separator to its default (period)
end
end
end
elseif citation_class ~= 'thesis' then
 
discard_parameter (Docket, A:ORIGIN ('Docket'), '');
-- check for special case where |separator=none
if 'none' == sepc:lower() then -- if |separator=none
sepc = ''; -- then set it to an empty string
end
end


-- Special case for cite techreport.
-- Special case for cite techreport.
if (config.CitationClass == "techreport") then -- special case for cite techreport
local Num = A['Number'];
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
if citation_class == 'techreport' then -- special case for cite techreport
if not is_set(ID) then -- can we use ID for the "number"?
if is_set (Num) then -- cite techreport uses 'number', which other citations alias to 'issue'
ID = Issue; -- yes, use it
if not is_set (ID) then -- can we use ID for the "number"?
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
ID = Num; -- yes, use it
else -- can't use ID so emit error message
else -- ID has a value so emit error message
ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
select_one (args, {'id', 'number'}, 'redundant_parameters');
end
end
end
end
elseif not is_set (Issue) then
Num = discard_parameter (Num, A:ORIGIN ('Number'), nil);
end
end


-- special case for cite interview
-- special case for cite interview
if (config.CitationClass == "interview") then
local Callsign = A['Callsign'];
if is_set(Program) then
local City = A['City'];
local Program = A['Program'];
 
if (citation_class == 'interview') then
if is_set (Program) then
ID = ' ' .. Program;
ID = ' ' .. Program;
end
end
if is_set(Callsign) then
if is_set (Callsign) then
if is_set(ID) then
if is_set (ID) then
ID = ID .. sepc .. ' ' .. Callsign;
ID = ID .. pend_separator (Callsign, sepc, true);
else
else
ID = ' ' .. Callsign;
ID = ' ' .. Callsign;
end
end
end
end
if is_set(City) then
if is_set (City) then
if is_set(ID) then
if is_set (ID) then
ID = ID .. sepc .. ' ' .. City;
ID = ID .. pend_separator (City, sepc, true);
else
else
ID = ' ' .. City;
ID = ' ' .. City;
第1,412行： 第1,295行：
end
end


if is_set(Interviewer) then
if is_set (Others) then
if is_set(TitleType) then
Others = wrap_msg ('interview', {TitleType, Others}, use_lowercase);
Others = ' ' .. TitleType .. ' with ' .. Interviewer;
TitleType = '';
TitleType = '';
else
Others = ' ' .. 'Interview with ' .. Interviewer;
end
if is_set(Cointerviewers) then
Others = Others .. sepc .. ' ' .. Cointerviewers;
end
else
Others = '(Interview)';
end
end
else
Callsign = discard_parameter (Callsign, A:ORIGIN ('Callsign'), nil );
City = discard_parameter (City, A:ORIGIN ('City'), nil );
Program = discard_parameter (Program, A:ORIGIN ('Program'), nil);
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}}.


--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
local BookTitle = A['BookTitle'];
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
if 'conference' == citation_class then
if not is_embargoed(Embargo) then
if is_set (BookTitle) then
URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
ChapterURLobject = URLobject;
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
URLobject = create_url_object ();
TransChapter = TransTitle;
TransTitle = '';
Chapter = Title;
Title = BookTitle;
end
else
BookTitle = discard_parameter (BookTitle, A:ORIGIN ('BookTitle'), nil);
if 'speech' == citation_class then
TitleNote = discard_parameter (TitleNote, A:ORIGIN ('TitleNote'), TitleType);
-- override whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
TitleType = ''; -- annotate the citation
else
Conference = discard_parameter (Conference, A:ORIGIN ('Conference'), '');
-- not cite conference or cite speech so make sure this is empty string
end
end
end
end


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
-- cite map oddities
--TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
local Cartography = A['Cartography'];
if is_set(BookTitle) then
local Scale = A['Scale'];
Chapter = Title;
ChapterLink = TitleLink;
if citation_class == 'map' then
TransChapter = TransTitle;
Chapter = A['Map'];
Title = BookTitle;
TransChapter = A['TransMap'];
TitleLink = '';
ChapterURLobject = create_url_object (A['MapURL'], A:ORIGIN ('MapURL'), A['MapFormat'], A:ORIGIN ('MapFormat'), A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'));
TransTitle = '';
Cartography = pend_separator (wrap_msg ('cartography', Cartography, use_lowercase), sepc, true);
Scale = pend_separator (Scale, sepc, true);
else
Cartography = discard_parameter (Cartography, A:ORIGIN ('Cartography'), '');
Scale = discard_parameter (Scale, A:ORIGIN ('Scale'), '');
discard_parameter (A['Map'], A:ORIGIN ('Map'), nil);
discard_parameter (A['MapURL'], A:ORIGIN ('MapURL'), nil);
discard_parameter (A['TransMap'], A:ORIGIN ('TransMap'), nil);
discard_parameter (A['MapFormat'], A:ORIGIN ('MapFormat'), nil);
discard_parameter (A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'), nil);
end
end


-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
--[[ -- {{cite episode}} is not currently supported by this module
if 'episode' == citation_class or 'serial' == citation_class then
if config.CitationClass == "episode" then
local AirDate = A['AirDate'];
local AirDate = A['AirDate'];
local SeriesLink = A['SeriesLink'];
local SeriesLink = A['SeriesLink'];
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];
local Network = A['Network'];
local Network = A['Network'];
local Station = A['Station'];
local Station = A['Station'];
local s, n = {}, {};
local s, n = {}, {};
local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
-- 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(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
if is_set (AirDate) then
if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
if not is_set (Date) then -- promote airdate to date
if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
Date = AirDate;
if is_set(Network) then table.insert(n, Network); end
Dateorigin = A:ORIGIN ('AirDate');
if is_set(Station) then table.insert(n, Station); end
else
select_one (args, {'date', 'air-date', 'airdate'}, 'redundant_parameters');
Date = Date or AirDate;
Chapter = Title;
ChapterLink = TitleLink;
TransChapter = TransTitle;
Title = Series;
TitleLink = SeriesLink;
TransTitle = '';
Series = table.concat(s, Sep);
ID = table.concat(n, Sep);
end
-- end of {{cite episode}} stuff]]
 
-- legacy: promote concatenation of |day=, |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
if not is_set(Date) then
Date = Year; -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if is_set(Date) then
local Month = A['Month'];
if is_set(Month) then
Date = Date .. '.' .. Month; -- LOCAL
local Day = A['Day']
if is_set(Day) then Date = Date .. '.' .. Day end -- LOCAL
end
end
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
end
end
end


if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
if 'episode' == citation_class then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];


if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
select_one (args, {'season', 'series-number', 'series-no', 'seriesnumber', 'seriesno'}, 'redundant_parameters');
-- add error message
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
end
-- 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


--[[
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
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
Chapter = make_internal_link (ChapterLink, Chapter, ChapterLinkorigin);
we get the date used in the metadata.
-- ok to wikilink
 
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
Date validation supporting code is in Module:Citation/CS1/Date_validation
Series = make_internal_link (ChapterLink, Series, ChapterLinkorigin);
]]
-- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
end
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
URLobject = create_url_object (); -- unset
if is_set(error_message) then
TransTitle = '';
table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } ); -- add this error message
ScriptTitle = '';
else -- now oddities that are cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if is_set (Series) and is_set (SeriesLink) then
Series = make_internal_link (SeriesLink, Series, A:ORIGIN ('SeriesLink'));
end
Series = wrap_style ('italic-title', Series); -- series is italicized
end
end
end
-- end of {{cite episode}} stuff


-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
 
if 'arxiv' == citation_class then
-- COinS metadata (see <http://ocoins.info/>) for
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
-- automated parsing of citation information.
append_error ('arxiv_missing', {}); -- add error message
local OCinSoutput = COinS{
elseif is_set (Series) then -- series is an alias of version
['Periodical'] = Periodical,
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
['Chapter'] = Chapter,
Series = ''; -- unset
['Title'] = Title,
deprecated_parameter ('version'); -- deprecated parameter but only for cite arxiv
['PublicationPlace'] = PublicationPlace,
end
['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
['Series'] = Series,
if first_set ({AccessDate, At, URLobject['format'], Page, Pages, PublisherName, URLobject['url'], -- a crude list of parameters that are not supported by cite arxiv
['Volume'] = Volume,
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
['Issue'] = Issue,
ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
['Pages'] = get_coins_pages (first_set(Page, Pages, At)), -- pages stripped of external links
ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']},27) then
['Edition'] = Edition,
append_error ('arxiv_params_not_supported', {}); -- add error message
['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
AccessDate= ''; -- set these to empty string; not supported in cite arXiv
Chapter = Title;
PublisherName = ''; -- (if the article has been published, use cite journal, or other)
ChapterLink = TitleLink;
URLobject = create_url_object ();
TransChapter = TransTitle;
Page = ''; Pages = ''; At = '';
Title = '';
TitleLink = '';
TransTitle = '';
end
--[[ Hide unfinished cite newsgroup code so that long delayed update can take place
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername and ID
if 'newsgroup' == config.CitationClass then
if is_set (PublisherName) then
PublisherName = '[Newsgroup]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
end
end
Periodical = 'arXiv'; -- periodical not allowed in cite arxiv; if article has been published, use cite journal
-- set to arXiv for COinS; after that, must be set to empty string
end
end
]]
 
-- legacy: promote concatenation of |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
 
if not is_set (Date) then
-- Now perform various field substitutions.
if is_set (Year) then
-- We also add leading spaces and surrounding markup and punctuation to the
Date = Year;
-- various parts of the citation, but only when they are non-nil.
Dateorigin = A:ORIGIN ('Year'); -- promote Year to Date
if not is_set(Authors) then
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
local Maximum = tonumber( A['DisplayAuthors'] );
elseif is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate;
-- Preserve old-style implicit et al.
Dateorigin = A:ORIGIN ('PublicationDate'); -- promote PublicationDate to Date
if not is_set(Maximum) and #a == 9 then
PublicationDate = '';
Maximum = 8;
table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
elseif not is_set(Maximum) then
Maximum = #a + 1;
end
end
else
local control = {
if is_set (PublicationDate) and PublicationDate ~= Date then
sep = A["AuthorSeparator"] .. " ",
PublicationDate = wrap_msg ('publication-date', PublicationDate, use_lowercase);
namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
else
format = A["AuthorFormat"],
PublicationDate = ''; -- if PublicationDate is same as Date, don't display in rendered citation
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
end
Authors = listpeople(control, a)
end
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } ); -- emit error message
end
end


local EditorCount
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
if not is_set(Editors) then
local anchor_year = validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, Dateorigin);
local Maximum = tonumber( A['DisplayEditors'] );
-- used in the CITEREF identifier
-- Preserve old-style implicit et al.
if not is_set(Maximum) and #e == 4 then
Maximum = 3;
table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
elseif not is_set(Maximum) then
Maximum = #e + 1;
end
 
local control = {
sep = A["EditorSeparator"] .. " ",
namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
format = A['EditorFormat'],
maximum = Maximum,
lastauthoramp = LastAuthorAmp
};


Editors, EditorCount = listpeople(control, e);
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
else
-- 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
EditorCount = 1;
Embargo = is_embargoed (Embargo); --
end


local Cartography = "";
if citation_class == 'journal' and not is_set (URLobject['url']) and is_set (ID_list['PMC']) then
local Scale = "";
if not is_set (Embargo) then -- if not embargoed or embargo has expired
if config.CitationClass == "map" then
URLobject['url'] =cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
if not is_set( Authors ) and is_set( PublisherName ) then
URLobject['origin'] = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
Authors = PublisherName;
PublisherName = "";
end
end
Cartography = A['Cartography'];
if is_set( Cartography ) then
Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
end
Scale = A['Scale'];
if is_set( Scale ) then
Scale = sepc .. " " .. Scale;
end
end
end
if  not is_set(URL) and
if  not is_set (URLobject['url']) then
not is_set(ChapterURL) and
if in_array (citation_class, cfg.args_support['templates_requiring_url']) then
not is_set(ArchiveURL) and
append_error ('cite_web_url', {});
not is_set(ConferenceURL) and
not is_set(TranscriptURL) then
-- Test if cite web or cite podcast |url= is missing or empty
if inArray(config.CitationClass, {"web","podcast"}) then
table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
end
end
-- Test if accessdate is given without giving a URL
-- Test if accessdate is given without giving a URL
if is_set(AccessDate) then
if is_set (AccessDate) and not is_set (ChapterURLobject['url']) then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
append_error ('accessdate_missing_url', {});
AccessDate = '';
AccessDate = '';
end
-- Test if format is given without giving a URL
if is_set(Format) then
Format = Format .. seterror( 'format_missing_url' );
end
end
end
end
 
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-- Test if citation has no title
-- Test if citation has no title
if not is_set(Chapter) and
if not is_set (Title) and
not is_set(Title) and
not is_set (TransTitle) and
not is_set(Periodical) and
not is_set (ScriptTitle) then
not is_set(Conference) and
if 'episode' == citation_class then -- special case for cite episode; TODO: is there a better way to do this?
not is_set(TransTitle) and
append_error ('citation_missing_title', {'series'});
not is_set(TransChapter) then
table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
end
Format = is_set(Format) and " (" .. Format .. ")" or "";
local OriginalURL = URL
DeadURL = DeadURL:lower();
if is_set( ArchiveURL ) then
if ( DeadURL ~= "no" ) then
URL = ArchiveURL
URLorigin = A:ORIGIN('ArchiveURL')
end
end
-- Format chapter / article title
 
-- LOCAL
if not is_set(Language) or Language:lower() == 'zh' or Language:sub( 1, 3 ):lower() == 'zh-' then
xLCFlags = 'zh;zh-hans;zh-hant'
else
xLCFlags = 'R'
end
if is_set(Chapter) then
Chapter = '-{' .. xLCFlags .. '|' .. Chapter .. '}-'
end
if is_set(Title) then
Title = '-{' .. xLCFlags .. '|' .. Title .. '}-'
end
-- END LOCAL
 
if is_set(Chapter) and is_set(ChapterLink) then
Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
end
if is_set(Periodical) and is_set(Title) then
Chapter = wrap( 'italic-title', Chapter );
TransChapter = wrap( 'trans-italic-title', TransChapter );
else
Chapter = kern_quotes (Chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
Chapter = wrap( 'quoted-title', Chapter );
TransChapter = wrap( 'trans-quoted-title', TransChapter );
end
local TransError = ""
if is_set(TransChapter) then
if not is_set(Chapter) then
TransError = " " .. seterror( 'trans_missing_chapter' );
else
TransChapter = " " .. TransChapter;
end
end
Chapter = Chapter .. TransChapter;
if is_set(Chapter) then
if not is_set(ChapterLink) then
if is_set(ChapterURL) then
Chapter = externallink( ChapterURL, Chapter ) .. TransError;
if not is_set(URL) then
Chapter = Chapter .. Format;
Format = "";
end
elseif is_set(URL) then
Chapter = externallink( URL, Chapter ) .. TransError .. Format;
URL = "";
Format = "";
else
else
Chapter = Chapter .. TransError;
append_error ('citation_missing_title', {'title'});
end
elseif is_set(ChapterURL) then
Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) ..
TransError;
else
Chapter = Chapter .. TransError;
end
if is_set(Title) and is_zh(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 = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
Title = wrap( 'quoted-title', Title );
TransTitle = wrap( 'trans-quoted-title', TransTitle );
--[[ Hide unfinished cite newsgroup code so that long delayed update can take place
elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast","newsgroup"}) and
]] elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
not is_set(Chapter) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
Title = wrap( 'quoted-title', Title );
TransTitle = wrap( 'trans-quoted-title', TransTitle );
else
Title = wrap( 'italic-title', Title );
TransTitle = wrap( 'trans-italic-title', TransTitle );
end
TransError = "";
if is_set(TransTitle) then
if not is_set(Title) then
TransError = " " .. seterror( 'trans_missing_title' );
else
TransTitle = " " .. TransTitle;
end
end
Title = Title .. TransTitle;
if is_set(Title) then
if not is_set(TitleLink) and is_set(URL) then
Title = externallink( URL, Title ) .. TransError .. Format  
URL = "";
Format = "";
else
Title = Title .. TransError;
end
end
if is_set(Place) then
Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
end
if is_set(Conference) then
if is_set(ConferenceURL) then
Conference = externallink( ConferenceURL, Conference );
end
Conference = sepc .. " " .. Conference
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
end
if not is_set(Position) then
local Minutes = A['Minutes'];
if is_set(Minutes) then
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
else
local Time = A['Time'];
if is_set(Time) then
local TimeCaption = A['TimeCaption']
if not is_set(TimeCaption) then
TimeCaption = cfg.messages['event'];
if sepc ~= '.' then
TimeCaption = TimeCaption:lower();
end
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
end
else
Position = " " .. Position;
At = '';
end
end
if not is_set(Page) then
if 'none' == Title and citation_class == 'journal' then -- special case for journal cites
if is_set(Pages) then
Title = ''; -- set title to empty string
if is_set(Periodical) and
add_maint_cat ('untitled');
not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
Pages = ": " .. Pages;
elseif tonumber(Pages) ~= nil then
Pages = sepc .." " .. PPrefix .. Pages;
else
Pages = sepc .." " .. PPPrefix .. Pages;
end
end
else
if is_set(Periodical) and
not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
Page = ": " .. Page;
else
Page = sepc .." " .. PPrefix .. Page;
end
end
end
At = is_set(At) and (sepc .. " " .. At) or "";
Position = is_set(Position) and (sepc .. " " .. Position) or "";
if config.CitationClass == 'map' then
local Section = A['Section'];
local Inset = A['Inset'];
if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
if is_set( Section ) then
Section = ", " .. wrap( 'section', Section, true );
end
if is_set( Inset ) then
Inset = ", " .. wrap( 'inset', Inset, true );
end
else
if is_set( Section ) then
Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
if is_set( Inset ) then
Inset = ", " .. wrap( 'inset', Inset, true );
end
elseif is_set( Inset ) then
Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
end
end
At = At .. Section .. Inset;
end


--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them. If a match is found,
check_for_external_link ({ -- add error message when any of these parameters contains a URL
use that value; if not, then use the value that was provided with the language parameter.
['title'] = Title,
[A:ORIGIN ('Chapter')] = Chapter,
[A:ORIGIN ('Periodical')] = Periodical,
[A:ORIGIN ('PublisherName')] = PublisherName,
});
 
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
-- 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
-- is the article title, and Chapter is a section within the article. So, we remap
Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English).
local coins_chapter = Chapter; -- default assuming that remapping not required
]]
local coins_title = Title; -- et tu
if is_set (Language) then
if 'encyclopaedia' == citation_class then
-- local name = mw.language.fetchLanguageName( Language:lower(), "en" ); -- experiment: this seems to return correct ISO 639-1 language names
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
local name = cfg.iso639_1[Language:lower()]; -- get the language name if Language parameter has a valid iso 639-1 code
coins_chapter = Title; -- remap
if nil == name then
coins_title = Periodical;
Language=" " .. wrap( 'language', Language ); -- no match, use parameter's value
else
if 0 == this_page.namespace and 'en' ~= Language:lower() then --found a match; is this page main / article space and English not the language?
Language=" " .. wrap( 'language', name .. '[[Category:Articles with ' .. name .. '-language external links]]' ); -- in main space and not English: categorize
else
Language=" " .. wrap( 'language', name ); --not in mainspace or language is English so don't categorize
end
end
end
else
Language=""; -- language not specified so make sure this is an empty string;
end
end


Others = is_set(Others) and (sepc .. " " .. Others) or "";
-- this is the function call to COinS()
 
local OCinSoutput = COinS ({
-- handle type parameter for those CS1 citations that have default values
['Periodical'] = Periodical,
['Encyclopedia'] = Encyclopedia,
['Chapter'] = coins_chapter,
['ScriptChapter'] = ScriptChapter,
['Map'] = Map,
['Degree'] = Degree; -- cite thesis only
['Title'] = coins_title,
['ScriptTitle'] = ScriptTitle,
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Season'] = COinS_date.rftssn,
['Chron'] =  COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['Pages'] = first_set ({Sheet, Sheets, Page, Pages, At}, 5),
['Edition'] = Edition,
['PublisherName'] = PublisherName,
['URL'] = first_set ({ChapterURLobject['url'], URLobject['url']}, 2),
['Authors'] = NameList,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);


if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "podcast", "pressrelease", "techreport", "thesis"}) then
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
TitleType = set_titletype (config.CitationClass, TitleType);
if 'arxiv' == citation_class then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
Periodical = '';
TitleType = Degree .. " thesis";
end
end
end


if is_set(TitleType) then -- if type parameter is specified
-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
if 'newsgroup' == citation_class then
end
if is_set (PublisherName) then
 
PublisherName = wrap_msg ('newsgroup', make_external_link ('news:' .. PublisherName, PublisherName, A:ORIGIN ('PublisherName')), use_lowercase);
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
Series = is_set(Series) and (sepc .. " " .. Series) or "";
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
 
if is_set(Volume) then
if ( mw.ustring.len(Volume) > 4 )
  then Volume = sepc .." " .. Volume;
  else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
end
end
end
end


--[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
-- Now perform various field substitutions.
if is_set(Volume) then
-- We also add leading spaces and surrounding markup and punctuation to the
if ( mw.ustring.len(Volume) > 4 )
-- various parts of the citation, but only when they are non-nil.
  then Volume = sepc .. " " .. Volume;
  else
  Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
  if is_set(Series) then Volume = sepc .. Volume;
  end
end
end
]]
------------------------------------ totally unrelated data
--[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition.
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
]]
-- an error message if the associated url is not set, or an empty string for concatenation
if is_set(Via) then
format_format ({ArchiveURLobject, ConferenceURLobject, URLobject, LayURLobject, TranscriptURLobject, ChapterURLobject});
Via = " " .. wrap( 'via', Via );
end
 
if is_set(SubscriptionRequired) then
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
elseif is_set(RegistrationRequired) then
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
end
 
if is_set(AccessDate) then
local retrv_text = " " .. cfg.messages['retrieved']
if (sepc ~= ".") then retrv_text = retrv_text:lower() end
AccessDate = '<span class="reference-accessdate">' .. sepc
.. substitute( retrv_text, {AccessDate} ) .. '</span>'
end
if is_set(ID) then ID = sepc .." ".. ID; end
-- special case for chapter format so no error message or cat when chapter not supported
  if "thesis" == config.CitationClass and is_set(Docket) then
if format_url_access_text (URLobject, SubscriptionRequired, RegistrationRequired) then
ID = sepc .." Docket ".. Docket .. ID;
select_one (args, {'url-access', 'urlaccess', 'registration', 'subscription'}, 'redundant_parameters');
end
end -- 只需其一
format_url_access_text (ChapterURLobject, nil, nil);


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


if is_set(Quote) then
Others = pend_separator (Others, sepc, true);
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
Others = pend_separator (wrap_msg ('translated', Translators, use_lowercase), sepc, true) .. Others;
Quote = Quote:sub(2,-2);
end
Quote = sepc .." " .. wrap( 'quoted-text', Quote );  
PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
end
local Archived
if 'speech' ~= citation_class then  
if is_set(ArchiveURL) then
TitleNote = pend_separator (TitleNote, sepc, true);
if not is_set(ArchiveDate) then
ArchiveDate = seterror('archive_missing_date');
end
if "no" == DeadURL then
local arch_text = cfg.messages['archived'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
{ externallink( ArchiveURL, arch_text ), ArchiveDate } );
if not is_set(OriginalURL) then
Archived = Archived .. " " .. seterror('archive_missing_url');  
end
elseif is_set(OriginalURL) then
local arch_text = cfg.messages['archived-dead'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,
{ externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
else
local arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,  
{ seterror('archive_missing_url'), ArchiveDate } );
end
else
Archived = ""
end
end
local Lay
Edition = wrap_msg ('edition', Edition, use_lowercase);
if is_set(LayURL) then
Series = pend_separator (Series, sepc, true);
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
OrigYear = wrap_msg ('orig year', OrigYear, use_lowercase);
if is_set(LaySource) then
Agency = pend_separator (Agency, sepc, true);
LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
Volume = format_volume_issue (Volume, Issue, citation_class, Periodical_origin, sepc, use_lowercase);
else
 
LaySource = "";
------------------------------------ totally unrelated data
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
Via = wrap_msg ('via', Via, use_lowercase);
if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
AccessDate = format_accessdate (AccessDate, sepc, use_lowercase);
elseif is_set(TranscriptURL) then
ID = format_id (ID, Docket, sepc, use_lowercase);
Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
ID_list = build_id_list (ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class});
 
local URL = '';
if is_set (URLobject['url']) then
URL = ' ' .. make_external_link (URLobject['url'], nil, URLobject['origin']) .. URLobject['access-text'];
end
end
local Publisher;
local Format = URLobject['format'];
if is_set(Periodical) and
Quote = format_quote (Quote, sepc);
not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
local Archived = format_archive (ArchiveURLobject, OriginalURLobject, ArchiveDate, DeadURL, sepc, use_lowercase);
if is_set(PublisherName) then
local Lay = format_lay (LayURLobject, LayDate, LaySource, sepc, use_lowercase);
if is_set(PublicationPlace) then
Transcript = format_external_link (Transcript, TranscriptURLobject, sepc);
Publisher = PublicationPlace .. ": " .. PublisherName;
local Publisher = format_publisher (PublisherName, PublicationPlace, Periodical, citation_class, sepc);
else
 
Publisher = PublisherName; 
local use_in = is_set (Chapter) and (not has_contributors);
end
Authors, Editors, Contributors = format_people (Authors, Editors, Contributors, multiple_editors, use_in, sepc);
elseif is_set(PublicationPlace) then
Publisher= PublicationPlace;
else
Publisher = "";
end
if is_set(PublicationDate) then
if is_set(Publisher) then
Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
else
Publisher = PublicationDate;
end
end
if is_set(Publisher) then
Publisher = " (" .. Publisher .. ")";
end
else
if is_set(PublicationDate) then
PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
end
if is_set(PublisherName) then
if is_set(PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
else
Publisher = sepc .. " " .. PublisherName .. PublicationDate; 
end
elseif is_set(PublicationPlace) then
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
else
Publisher = PublicationDate;
end
end
-- Several of the above rely upon detecting this as nil, so do it last.
-- Several of the above rely upon detecting this as nil, so do it last.
if is_set(Periodical) then
Periodical = format_periodical (Periodical, Title, TitleNote, sepc);
if is_set(Title) or is_set(TitleNote) then
Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )
else
Periodical = wrap( 'italic-title', Periodical )
end
end
 
--[[
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
]]
if "speech" == config.CitationClass then -- cite speech only
TitleNote = " (Speech)"; -- annotate the citation
if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
if is_set (Conference) then -- and if |event= is set
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
end
end
end


-- Piece all bits together at last.  Here, all should be non-nil.
-- Piece all bits together at last.  Here, all should be non-nil.
第2,082行： 第1,643行：
-- not to keep reassigning to the same string variable over and over.
-- not to keep reassigning to the same string variable over and over.


local tcommon
local tcommon;
if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
local tcommon2; -- used for book cite when |contributor= is set
if is_set(Others) then Others = Others .. sepc .. " " end
tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series,  
if citation_class == 'journal' and is_set (Periodical) then
Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
Others = pend_separator (Others, sepc, false);
else  
tcommon = safe_join ({Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Edition, Publisher, Agency}, sepc);
tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language,
Volume, Issue, Others, Cartography, 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
end
if #ID_list > 0 then
if #ID_list > 0 then
ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
ID_list = safe_join ({sepc .. ' ',  table.concat (ID_list, sepc .. ' '), ID}, sepc);
else
else
ID_list = ID;
ID_list = ID;
end
end
local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
-- LOCAL
local text;
local xDate;
local pgtext = Position .. Page .. Pages .. At;
if (is_set (Periodical) and is_set (Date) and
not in_array (citation_class, {'encyclopaedia', 'web'}))
if is_set(Authors) then
or (in_array (citation_class, {'book', 'news'})) then
if is_set(Coauthors) then
if in_array (citation_class, {'journal', 'citation'}) and is_set (Volume) then
Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
xDate = safe_join ({Date .. ',' .. Volume, Insource_location, PublicationDate, OrigYear, AccessDate}, sepc);
end
if is_set(Date) then
Date = " ("..Date..")" .. OrigYear .. sepc .. " "
elseif string.sub(Authors,-1,-1) == sepc then
Authors = Authors .. " "
else
else
Authors = Authors .. sepc .. " "
xDate = safe_join ({Date, Insource_location, PublicationDate, OrigYear, AccessDate}, sepc);
end
end
if is_set(Editors) then
Insource_location = ''
local in_text = " ";
else
local post_text = "";
xDate = safe_join ({Date, PublicationDate, OrigYear, AccessDate}, sepc);
if is_set(Chapter) then
end
in_text = in_text .. cfg.messages['in'] .. " "
xDate = pend_separator (xDate, sepc, true);
else
-- END LOCAL
if EditorCount <= 1 then
 
post_text = ", " .. cfg.messages['editor'];
local idcommon = safe_join ({URL, xDate, ID_list, Archived, Via, Lay, Language, Quote}, sepc);
else
local text;
post_text = ", " .. cfg.messages['editors'];
if is_set (Authors) then
end
if is_set (Contributors) then
end
text = safe_join ({Contributors, Chapter, tcommon, Authors, Place, Editors, tcommon2, Insource_location, idcommon }, sepc);
if (sepc ~= '.') then in_text = in_text:lower() end
Editors = in_text .. Editors .. post_text;
if (string.sub(Editors,-1,-1) == sepc)
then Editors = Editors .. " "
else Editors = Editors .. sepc .. " "
end
end
text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
text = safejoin( {text, pgtext, idcommon}, sepc );
elseif is_set(Editors) then
if is_set(Date) then
if EditorCount <= 1 then
Editors = Editors .. ", " .. cfg.messages['editor'];
else
Editors = Editors .. ", " .. cfg.messages['editors'];
end
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
else
else
if EditorCount <= 1 then
text = safe_join ({Authors, Chapter, Place, Editors, tcommon, Insource_location, idcommon }, sepc);
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
else
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end
end
text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
text = safejoin( {text, pgtext, idcommon}, sepc );
else
else
if is_set(Date) then
text = safe_join ({Editors, Chapter, Place, tcommon, Insource_location, idcommon}, sepc);
if ( string.sub(tcommon,-1,-1) ~= sepc )
  then Date = sepc .." " .. Date .. OrigYear
  else Date = " " .. Date .. OrigYear
end
end
if config.CitationClass=="journal" and is_set(Periodical) then
text = safejoin( {Chapter, Place, tcommon}, sepc );
text = safejoin( {text, pgtext, Date, idcommon}, sepc );
else
text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
text = safejoin( {text, pgtext, idcommon}, sepc );
end
end
end
if is_set(PostScript) and PostScript ~= sepc then
if is_set (PostScript) and PostScript ~= sepc then
text = safejoin( {text, sepc}, sepc ); --Deals with italics, spaces, etc.
text = safe_join ({text, sepc}, sepc); --Deals with italics, spaces, etc.
text = text:sub(1,-sepc:len()-1);
text = text:sub (1, -sepc:len()-1);
-- text = text:sub(1,-2); --Remove final separator (assumes that sepc is only one character)
end
end
text = safejoin( {text, PostScript}, sepc );
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 >--------------------------------------------------------------
local options = {};
Looks for a parameter's name in the whitelist.
 
Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
]]
options.class = "citation " .. config.CitationClass;
else
options.class = "citation";
end
if is_set(Ref) and Ref:lower() ~= "none" then
local id = Ref
if ( "harv" == Ref ) then
local names = {} --table of last names & year
if #a > 0 then
for i,v in ipairs(a) do
names[i] = v.last
if i == 4 then break end
end
elseif #e > 0 then
for i,v in ipairs(e) do
names[i] = v.last
if i == 4 then break end
end
end
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
id = anchorid(names)
end
options.id = id;
end
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
z.error_categories = {};
text = seterror('empty_citation');
z.message_tail = {};
end
if is_set(options.id) then
text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
else
text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
end


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


-- This is used by templates such as {{cite book}} to create the actual citation text.
--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
function z.citation(frame)
 
local pframe = frame:getParent()
This is used by templates such as {{cite book}} to create the actual citation text.
 
]]
 
function citation (frame)
local pframe = frame:getParent();
local module_path = 'Module:Citation/CS1/'
local module_suffix = frame:getTitle():gsub ('^Module:Citation/CS1', '');
if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then -- did the {{#invoke:}} use sandbox version?
load_modules (module_path, module_suffix);
cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); -- load sandbox versions of Configuration and Whitelist and ...
whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- ... sandbox version of date validation code
else -- otherwise
cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ...
whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
dates = require('Module:Citation/CS1/Date_validation').dates -- ... live version of date validation code
end
local args = {};
local args = {};
local suggestions = {};
local suggestions = {};
local error_text, error_state;
local error_reported = false;


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


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

2022年6月5日 (日) 14:33的最新版本

此模块的文档可以在模块:Citation/CS1/doc创建 

--[[--------------------------< 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 >-----------------
]]

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);

	utilities.set_selected_modules (cfg);
	links.set_selected_modules (utilities, errors);
	errors.set_selected_modules (cfg, utilities, links);
	identifiers.set_selected_modules (cfg, utilities, errors, links, validation);
	people.set_selected_modules (cfg, utilities, errors, links);
	coins.set_selected_modules (cfg, utilities, links);
	languages.set_selected_modules (utilities, errors);

	dates = validation.dates;													-- imported functions
	year_date_check = validation.year_date_check;
	
	first_set = utilities.first_set;
	hyphen_to_dash = utilities.hyphen_to_dash;
	is_set = utilities.is_set;
	in_array = utilities.in_array;
	substitute = utilities.substitute;
	
	has_invisible_chars = utilities.has_invisible_chars;
	kern_quotes = utilities.kern_quotes;
	pend_separator = utilities.pend_separator;
	safe_join = utilities.safe_join;
	wrap_style = utilities.wrap_style;
	wrap_msg = utilities.wrap_msg;
	
	make_external_link = links.make_external_link;
	make_internal_link = links.make_internal_link;
	check_for_external_link = links.check_for_external_link;
	
	add_maint_cat = errors.add_maint_cat;
	append_error = errors.append_error;
	make_error_tail = errors.make_error_tail;
	reset_error = errors.reset_error;
	set_error = errors.set_error;
	select_one = errors.select_one;
	throw_error = errors.throw_error;
	
	extract_ids = identifiers.extract_ids;
	build_id_list = identifiers.build_id_list;
	is_embargoed = identifiers.is_embargoed;
	extract_id_access_levels = identifiers.extract_id_access_levels;
	
	get_people = people.get_people;
	format_people = people.format_people;
	
	COinS = coins.COinS;
	
	script_concatenate = languages.script_concatenate;
	language_parameter = languages.language_parameter;

end

--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------

Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
offending parameter name to the error message.  

]]

local function deprecated_parameter (name)
	append_error ('deprecated_params', {name});						
end

--[[--------------------------< D I S C A R D _ P A R A M E T E R >--------------------------------------------

]]

local function discard_parameter (name, label, new_value)
	if is_set (name) then
		append_error ('parameter_discarded', label);
	end
	return new_value;
end

--[[--------------------------< S A N I T I Z E D _ P A R A M E T E R _ V A L U E >------------------------

This function is used to validate a parameter's assigned value for those parameters that have only a limited number
of allowable values (e.g. yes, y, true, no, etc). If the parameter value is empty or is in the list of allowed values, 
the function returns the value; else, it emits an error message and returns the default value.

]]

local function sanitized_parameter_value (value, name, key, default)
	if not is_set (value) then
		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

--[[--------------------------< 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 >------------------------------

]]

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

--[[--------------------------< V A L I D A T E _ D A T E >-------------------------------------------------------

Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.

Date validation supporting code is in Module:Citation/CS1/Date_validation
]]

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

--[[--------------------------< D I S C A R D _ C H A P T E R >-------------------------------------------------------
仅为保持兼容性而设置。理论上可以直接调用discard_parameter()丢弃相关参数。
]]
	
local function discard_chapter (args)
	local chap_param;
	if is_set (args['Chapter']) then											-- get a parameter name from one of these chapter related meta-parameters
		chap_param = args:ORIGIN ('Chapter');
	elseif is_set (args['TransChapter']) then
		chap_param = args:ORIGIN ('TransChapter');
	elseif is_set (args['ChapterURL']) then
		chap_param = args:ORIGIN ('ChapterURL');
	elseif is_set (args['ScriptChapter']) then
		chap_param = args:ORIGIN ('ScriptChapter')
	elseif is_set (args['ChapterFormat']) then
		chap_param = args:ORIGIN ('ChapterFormat')
	elseif is_set (args['ChapterUrlAccess']) then
		chap_param = args:ORIGIN ('ChapterUrlAccess')	
	end
	if is_set (chap_param) then													-- if we found one
		append_error ('chapter_ignored', {chap_param});							-- add error message
	end
end

--[[--------------------------< C R E A T E _ U R L _ O B J E C T >------------------------------------------

]]

local function create_url_object (url, source, fmt, fmt_source, access, access_source)
	return {
		['url'] = is_set (url) and url or '',
		['origin'] = is_set (source) and source or '',
		['access'] = is_set (access) and sanitized_parameter_value (access, access_source, 'url-access', '') or '',
		['access-origin'] = is_set (access_source) and access_source or '',
		['format'] = is_set (fmt) and fmt or '',
		['format-origin'] = is_set (fmt_source) and fmt_source or '',
		['access-text'] = ''
	}
end

--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------

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

--[[--------------------------< S E T _ N O _ T R A C K I N G _ C A T S >-----------------------------------------

check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories

]]

local function set_no_tracking_cats (no_tracking, no_tracking_source, this_page)
	local no_tracking_cats = sanitized_parameter_value (no_tracking, no_tracking_source, 'yes_true_y', nil);
	if not is_set (no_tracking_cats) then										-- ignore if we are already not going to categorize this page
		if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
			return true;														-- set no_tracking_cats
		end
		for _,v in ipairs (cfg.uncategorized_subpages) do						-- cycle through page name patterns
			if this_page.text:match (v) then									-- test page name against each pattern
				return true;													-- set no_tracking_cats; bail out if one is found
			end
		end
		return false;
	else
		return true;
	end
end

--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------

Set style settings for CS1 citation templates. Returns separator and postscript settings

]]

local function set_cs1_style (ps)
	if not is_set (ps) then														-- unless explicitely set to something
		ps = '.';																-- terminate the rendered citation with a period
	end
	return '.', ps;																-- separator is a full stop
end

--[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------

Set style settings for CS2 citation templates. Returns separator, postscript, ref settings

]]

local function set_cs2_style (ps, ref)
	if not is_set (ps) then														-- if |postscript= has not been set, set cs2 default
		ps = '';																-- make sure it isn't nil
	end
	if not is_set (ref) then													-- if |ref= is not set
		ref = 'harv';															-- set default |ref=harv
	end
	return ',', ps, ref;														-- separator is a comma
end

--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------

When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
rendered style.

]]

local function get_settings_from_cite_class (ps, ref, cite_class)
	local sep;
	if (cite_class == 'citation') then											-- for citation templates (CS2)
		sep, ps, ref = set_cs2_style (ps, ref);
	else																		-- not a citation template so CS1
		sep, ps = set_cs1_style (ps);
	end

	return sep, ps, ref															-- return them all
end

--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------

Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
config.CitationClass from the template's #invoke: to establish style.

]]

local function set_style (mode, mode_source, ps, ref, quote, cite_class)
	local sep;
	mode = sanitized_parameter_value (mode, mode_source, 'mode', ''):lower();
	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

--[[--------------------------< S W A P _ U R L S >--------------------------------------------------------------

]]

local function swap_urls (url_object, chapter_url_object, archive_url_object, dead_url)
	local original_url_object = create_url_object ();
	local is_dead = in_array (dead_url, cfg.keywords['deadurl-live']);			-- used later when assembling archived text
	
	if is_set (archive_url_object['url']) then
		if is_set (url_object['url']) then
			original_url_object = url_object;											
			if not is_dead then													
				url_object = archive_url_object;
			end
		elseif is_set (chapter_url_object['url']) then 							-- URL not set so if chapter-url is set apply archive url to it
			original_url_object = chapter_url_object;							
			if not is_dead then
				chapter_url_object = archive_url_object;						
			end
		end
	end
	return original_url_object, url_object, chapter_url_object;
end

--[[--------------------------< F O R M A T  _ U R L _ A C C E S S _ T E X T >---------------------------------------

从x-url-access系列参数生成相应的图标；兼容既有registration, subscription参数，优先级x-url-access > subscription > registration。

]]

local function format_url_access_text (url_object, subscription_required, registration_required)
	local access_text = '';
	local redundant = false;
	local access = url_object['access'];
	local reg = false;
	local sub = false;
	if is_set (access) then
		if (access == 'limited') then
			access_text = cfg.presentation['limited'];							-- 有限度免费访问
		elseif (access == 'registration') then
			access_text = cfg.presentation['registration'];						-- 需要免费注册
			reg = true;
		elseif (access == 'subscription') then
			access_text = cfg.presentation['subscription'];						-- 需要付费订阅
			sub = true;
		else
			access_text = '';	
		end
		if is_set (subscription_required) or is_set (registration_required) then
			redundant = true;
		end
	else
		if is_set (subscription_required) then
			access_text = cfg.presentation['subscription'];						-- 需要免费注册
			sub = true;
			if is_set (registration_required) then
				redundant = true;
			end
		elseif is_set (registration_required) then
			access_text = cfg.presentation['registration'];						-- 需要付费订阅
			reg = true
		else
			access_text = '';													
		end
	end
	if is_set (url_object ['url']) then
		url_object['access-text'] = access_text;
		if sub then
			add_maint_cat ('subscription');
		elseif reg then
			add_maint_cat ('registration');
		end
	else
																				-- 预留报错	
	end
	return redundant;
end

--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------

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.

]]
	
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
	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

--[[-------------------------< F O R M A T _ I N S O U R C E _ L O C A T I O N >----------------------------------

Build insource_location meta-parameter from |page(s)= , |sheet(s)= , |at= and other relevant parameters.

]]

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

--[[-------------------------< F O R M A T _ P U B L I S H E R >------------------------------------------

]]

local function format_publisher (publisher_name, publication_place, periodical, cite_class, sepc)
	local publisher = '';
	
	if is_set (publisher_name) then
		if is_set (publication_place) then
			publisher = publication_place .. ': ' .. publisher_name;
		else
			publisher = publisher_name;  
		end
	elseif is_set (publication_place) then
		publisher = publication_place;
	end
	
	if is_set (publisher) then
		if is_set (periodical) and
			not in_array (cite_class, {'encyclopaedia', 'web', 'pressrelease', 'podcast'}) then
			publisher = ' (' .. publisher .. ')';
		else
			publisher = pend_separator (publisher, sepc, true);	
		end
	end
	return publisher;
end

--[[-------------------------< F O R M A T _ L I N K >-------------------------------------------------

Format an external link that may or may not be raw.

]]

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

--[[-------------------------< F O R M A T _ C O N F E R E N C E >----------------------------------------

]]

local function format_conference (conference, conference_url_object, periodical, cite_class, sepc)
	local  conf_text = format_external_link (conference, conference_url_object, sepc);
	if 'speech' == cite_class and is_set (periodical) then
																				-- if cite speech, periodical (perhaps because of an included |website= or |journal= parameter) is set; 
		conf_text = pend_separator (conf_text, sepc, false);					-- then add appropriate punctuation to the end of the conference variable if set.
	end
	return conf_text;
end

--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------

Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).

]]

local function format_chapter_title (scriptchapter, chapter, transchapter, chapter_url_object, no_quotes, cite_class, title_type, sepc)
	local chapter_error = '';
	
	if not is_set (chapter) then
		chapter = '';															-- to be safe for concatenation
	else
		if false == no_quotes then
			chapter = kern_quotes (chapter);									-- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
			chapter = wrap_style ('quoted-title', chapter);
		end
	end

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

	if is_set (transchapter) then
		transchapter = wrap_style ('trans-quoted-title', transchapter);
		if is_set (chapter) then
			chapter = chapter ..  ' ' .. transchapter;
		else																	-- here when transchapter without chapter or script-chapter
			chapter = transchapter;
			chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
		end
	end
	if is_set (chapter_url_object['url']) then
		chapter = make_external_link (chapter_url_object['url'], chapter, chapter_url_object['origin']) .. chapter_url_object['access-text'];		
																				-- adds bare_url_missing_title error if appropriate
	end
	chapter = chapter .. chapter_error;
	
	if is_set (chapter) then
		if 'map' == cite_class and is_set (title_type) then
			chapter = chapter .. ' ' .. title_type;
		end
		chapter = pend_separator (chapter .. chapter_url_object['format'], sepc,  false);
	else																		-- |chapter= not set but |chapter-format= is so ...
		chapter = pend_separator (chapter_url_object['format'], sepc, false);	-- ... ChapterFormat has error message, we want to see it
	end
	
	return chapter;
end

--[[--------------------------< F O R M A T _ M A I N _ T I T L E >------------------------------------------

Format the five title parameters: |script-title=, |title=, |trans-title=, |title-link=, and |url= into a single Title meta-
parameter (url_origin and title_link_origin used for error messages).

]]

local function format_main_title (title, title_link, title_link_origin, script_title, trans_title, url_object, no_chapter_format, cite_class, periodical)
	if is_set (title_link) and is_set (title) then
		title = make_internal_link (title_link, title, title_link_origin);
	end
	if no_chapter_format or
		('map' == cite_class and is_set (periodical)) then						-- special case for cite map when the map is in a periodical treat as an article			
		title = kern_quotes (title);											-- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
		title = wrap_style ('quoted-title', title);
	
		title = script_concatenate (title, script_title);						-- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
		trans_title= wrap_style ('trans-quoted-title', trans_title );
	elseif 'report' == cite_class then											-- no styling for cite report
		title = script_concatenate (title, script_title);						-- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
		trans_title= wrap_style ('trans-quoted-title', trans_title );			-- for cite report, use this form for trans-title
	else
		title = wrap_style ('italic-title', title);
		title = script_concatenate (title, script_title);						-- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
		trans_title = wrap_style ('trans-italic-title', trans_title);
	end

	local trans_error = '';
	if is_set (trans_title) then
		if is_set (title) then
			trans_title = ' ' .. trans_title;
		else
			trans_error = ' ' .. set_error ('trans_missing_title', {'title'});
		end
	end
	
	title = title .. trans_title;
	
	if is_set (title) then
		if not is_set (title_link) and is_set (url_object['url']) then 
			title = make_external_link (url_object['url'], title, url_object['origin']) .. url_object['access-text'] .. trans_error .. url_object['format'];
			url_object = create_url_object ();
		else
			title = title .. trans_error;
		end
	end
	return title, url_object;
end

--[[--------------------------< F O R M A T  _ F O R M A T >--------------------------------------------------------

Applies css style to |format=, |chapter-format=, etc.  Also emits an error message if the format parameter does
not have a matching url parameter.  If the format parameter is not set and the url contains a file extension that
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
the appropriate styling.

]]

local function format_format (args)
	for _, url_object in pairs (args) do
		if is_set (url_object['format']) then
			url_object['format'] = wrap_style ('format', url_object['format']);	-- add leading space, parenthases, resize
			if not is_set (url_object['url']) then
				url_object['format'] = url_object['format'] .. set_error ('format_missing_url', {url_object['format-origin'], url_object['origin']});	
																				-- add an error message
			end
		elseif is_set (url_object['url']) then
			if url_object['url']:match ('%.pdf[%?#]?') or url_object['url']:match ('%.PDF[%?#]?') then
																				-- format is not set so if url is a pdf file then
				url_object['format'] = wrap_style ('format', 'PDF');			-- set format to pdf
			end
		end
	end
end

--[[--------------------------< F O R M A T _ A C C E S S D A T E >----------------------------------------------

]]

local function format_accessdate (accessdate, sepc, lower)
	if is_set (accessdate) then																				-- first, wrap in nowrap span if date in appropriate format
		if accessdate:match ('^%d%d%d%d%-%d%d%-%d%d$') then
			accessdate = wrap_style ('nowrap1', accessdate);					-- when accessdate is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
		elseif accessdate:match('^%a+%s*%d%d?,%s+%d%d%d%d$') or accessdate:match ('^%d%d?%s*%a+%s+%d%d%d%d$') then
			local cap, cap2 = string.match (accessdate, '^(.*)%s+(%d%d%d%d)$');
			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
		end
		accessdate =  ' ' .. wrap_msg ('retrieved', accessdate, lower);			-- add retrieved text
		accessdate = wrap_style ('accessdate', {sepc, accessdate});				-- allow editors to hide accessdates
	end
	return accessdate;
end

--[[--------------------------< F O R M A T _ I D >----------------------------------------------------
]]

local function format_id (id, docket, sepc, lower)
	id = pend_separator (id, sepc, true);
	return pend_separator (wrap_msg ('docket', docket, lower), sepc, true) .. id;
end

--[[--------------------------< F O R M A T _ Q U O T E >----------------------------------------------
]]

local function format_quote (quote, sepc)
	if is_set (quote) then
		if quote:sub (1, 1) == '"' and quote:sub (-1, -1) == '"' then			-- if first and last characters of quote are quote marks
			quote = quote:sub (2, -2);											-- strip them off
		end
		return pend_separator (wrap_style ('quoted-text', quote), sepc, true);	-- wrap in <q>...</q> tags
	end
	return '';
end

--[[--------------------------< F O R M A T _ A R C H I V E >------------------------------------------

]]

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

--[[--------------------------< F O R M A T _ L A Y >---------------------------------------------------

]]

local function format_lay (lay_url_object, lay_date, lay_source, sepc, lower)
	local lay = '';
	if is_set (lay_url_object['url']) then
		if is_set (lay_date) then lay_date = ' (' .. lay_date .. ')' end
		if is_set (lay_source) then 
			lay_source = wrap_msg ('lay source', lay_source, lower);
		else
			lay_source = '';
		end
		local lay_sum = cfg.messages['lay summary'];
		if lower then
			lay_sum = lay_sum:lower();
		end
		lay = pend_separator (make_external_link (lay_url_object['url'], lay_sum, lay_url_object['origin']) .. lay_url_object['format'] .. lay_source .. lay_date, sepc, true);
	else 																		-- Test if |lay-format= is given without giving a |lay-url=
		lay = pend_separator (lay_url_object['format'], sepc, true);			-- if set and LayURL not set, then LayFormat has error message
	end
	return lay;
end

--[[--------------------------< F O R M A T _ P E R I O D I C A L >------------------------------------
]]

local function format_periodical (periodical, title, title_note, sepc)
	if is_set (periodical) then
		if is_set (title) or is_set (title_note) then 
			return pend_separator (wrap_style ('italic-title', periodical), sepc, true);
		else 
			return wrap_style ('italic-title', periodical);
		end
	end
	return '';
end

--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------

Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.

namelist is one of the contributor-, author-, or editor-name lists chosen in that order.  year is Year or anchor_year.

]]

local function anchor_id (namelist, year)
	local names={};																-- a table for the one to four names and year
	for i,v in ipairs (namelist) do												-- loop through the list and take up to the first four last names
		names[i] = v.last 
		if i == 4 then break end												-- if four then done
	end
	table.insert (names, year);													-- add the year at the end
	local id = table.concat (names);											-- concatenate names and year for CITEREF id
	if is_set (id) then															-- if concatenation is not an empty string
		return 'CITEREF' .. id;													-- add the CITEREF portion
	else
		return '';																-- return an empty string; no reason to include CITEREF id in this citation
	end
end

--[[--------------------------< F O R M A T _ C I T A T I O N >--------------------------------------------

]]

local function format_citation (body, cite_class, ref, namelist, year, ocins_output, no_tracking_cats)
	local options = {};
	
	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=
	else
		options.class = 'citation';
	end
	
	if is_set (ref) and ref:lower() ~= 'none' then								-- set reference anchor if appropriate
		local id = ref
		if ('harv' == ref ) then
			id = anchor_id (namelist, year);									-- go make the CITEREF anchor
		end
		options.id = id;
	end
	
	if string.len (body:gsub ('<span[^>/]*>.-</span>', ''):gsub ('%b<>','')) <= 2 then
		reset_error ({'err_cats'});
		body = set_error ('empty_citation');
		reset_error ({'msg_tail'});
	end
	
	local text;
	
	if is_set (options.id) then
		text = wrap_style ('citation-with-id', {mw.uri.anchorEncode (options.id), mw.text.nowiki (options.class), body});
	else
		text = wrap_style ('citation-no-id', {mw.text.nowiki (options.class), body});
	end	
	
	text = text .. wrap_style ('OCinS', ocins_output);
	text = text .. make_error_tail (no_tracking_cats);							-- append error/maintenance messages/categories to the citation
	
	return text;
end

--[[--------------------------< D E D U C E _ C I T A T I O N _ C L A S S >--------------------------------------

如果citation_class为citation（{{citation}}），根据periodical系列参数的设置情况推断实际的引用类型。

]]

local function deduce_citation_class (A, naive_class)
	local deduced_class;
	local periodical = A['Periodical'];
	local origin = A:ORIGIN ('Periodical');
	
	for cite_class, aliases in pairs (cfg.periodical.parameters) do
		if cite_class ~= '_general' then
			for _, aliase in pairs (aliases) do
				if origin == aliase then
					deduced_class = cite_class;
				end
			end
		end
	end
	
	if (naive_class == 'citation') then
		if is_set (deduced_class) then
			return deduced_class, true;
		end
	elseif (naive_class ~= deduced_class) then
		local check_list = cfg.periodical.compatibility[naive_class];
		if is_set (check_list) then
			if is_set (check_list['drop']) and in_array (deduced_class, check_list['drop']) then
				A['Periodical'] = discard_parameter (periodical, origin, nil);
			elseif is_set (check_list['warn']) and in_array (deduced_class, check_list['warn']) then
				append_error ('periodical', {origin, naive_class, deduced_class, check_list['suggest']});
			end
		end
	end
	return naive_class, false;
end


--[[--------------------------< 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'];
	
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
	|encyclopedia and |title then map |title to |article and |encyclopedia to |title
	|encyclopedia and |article then map |encyclopedia to |title
	|encyclopedia then map |encyclopedia to |title

	|trans_title maps to |trans_chapter when |title is re-mapped
	|url maps to |chapterurl when |title is remapped

All other combinations of |encyclopedia, |title, and |article are not modified

]]

	local Encyclopedia;
	local Entry = A['Entry'];

	if (citation_class == 'encyclopaedia') then									-- test code for citation
		local entry_redundant = false
		Encyclopedia = Periodical;
		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

-- Special case for cite techreport.
	local Num = A['Number'];
	if citation_class == 'techreport' then										-- special case for cite techreport
		if is_set (Num) then													-- cite techreport uses 'number', which other citations alias to 'issue'
			if not is_set (ID) then												-- can we use ID for the "number"?
				ID = Num;														-- yes, use it
			else																-- ID has a value so emit error message
				select_one (args, {'id', 'number'}, 'redundant_parameters');
			end
		end
	elseif not is_set (Issue) then
		Num = discard_parameter (Num, A:ORIGIN ('Number'), nil);
	end

-- special case for cite interview
	local Callsign = A['Callsign'];
	local City = A['City'];
	local Program = A['Program'];

	if (citation_class == 'interview') then
		if is_set (Program) then
			ID = ' ' .. Program;
		end
		if is_set (Callsign) then
			if is_set (ID) then
				ID = ID .. pend_separator (Callsign, sepc, true);
			else
				ID = ' ' .. Callsign;
			end
		end
		if is_set (City) then
			if is_set (ID) then
				ID = ID .. pend_separator (City, sepc, true);
			else
				ID = ' ' .. City;
			end
		end

		if is_set (Others) then
			Others = wrap_msg ('interview', {TitleType, Others}, use_lowercase);
			TitleType = '';
		end
	else
		Callsign = discard_parameter (Callsign, A:ORIGIN ('Callsign'), nil );
		City = discard_parameter (City, A:ORIGIN ('City'), nil );
		Program = discard_parameter (Program, A:ORIGIN ('Program'), nil);
	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}}.

	local BookTitle = A['BookTitle'];
	if 'conference' == citation_class then
		if is_set (BookTitle) then
			ChapterURLobject = URLobject;
			URLobject = create_url_object ();
			TransChapter = TransTitle;
			TransTitle = '';
			Chapter = Title;
			Title = BookTitle;
		end
	else
		BookTitle = discard_parameter (BookTitle, A:ORIGIN ('BookTitle'), nil); 
		if 'speech' == citation_class then
			TitleNote = discard_parameter (TitleNote, A:ORIGIN ('TitleNote'), TitleType);
																				-- override whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
			TitleType = '';														-- annotate the citation
		else
			Conference = discard_parameter (Conference, A:ORIGIN ('Conference'), '');
																				-- not cite conference or cite speech so make sure this is empty string
		end
	end

-- cite map oddities
	local Cartography = A['Cartography'];
	local Scale = A['Scale'];
	
	if citation_class == 'map' then
		Chapter = A['Map'];
		TransChapter = A['TransMap'];
		ChapterURLobject = create_url_object (A['MapURL'], A:ORIGIN ('MapURL'), A['MapFormat'], A:ORIGIN ('MapFormat'), A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'));
		Cartography = pend_separator (wrap_msg ('cartography', Cartography, use_lowercase), sepc, true);
		Scale = pend_separator (Scale, sepc, true);
	else
		Cartography = discard_parameter (Cartography, A:ORIGIN ('Cartography'), '');
		Scale = discard_parameter (Scale, A:ORIGIN ('Scale'), '');
		discard_parameter (A['Map'], A:ORIGIN ('Map'), nil);
		discard_parameter (A['MapURL'], A:ORIGIN ('MapURL'), nil);
		discard_parameter (A['TransMap'], A:ORIGIN ('TransMap'), nil);
		discard_parameter (A['MapFormat'], A:ORIGIN ('MapFormat'), nil);
		discard_parameter (A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'), nil);
	end

-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
	if 'episode' == citation_class or 'serial' == citation_class then
		local AirDate = A['AirDate'];
		local SeriesLink = A['SeriesLink'];
		local Network = A['Network'];
		local Station = A['Station'];
		local s, n = {}, {};
																				-- 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

		if 'episode' == citation_class then										-- handle the oddities that are strictly {{cite episode}}
			local Season = A['Season'];
			local SeriesNumber = A['SeriesNumber'];

			if is_set (Season) and is_set (SeriesNumber) then					-- these are mutually exclusive so if both are set
				select_one (args, {'season', 'series-number', 'series-no', 'seriesnumber', 'seriesno'}, 'redundant_parameters');	
																				-- add error message
				SeriesNumber = '';												-- unset; prefer |season= over |seriesno=
			end
																				-- 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

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

-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
	if 'arxiv' == citation_class then
		if not is_set (ID_list['ARXIV']) then									-- |arxiv= or |eprint= required for cite arxiv
			append_error ('arxiv_missing', {});									-- add error message
		elseif is_set (Series) then												-- series is an alias of version
			ID_list['ARXIV'] = ID_list['ARXIV'] .. Series;						-- concatenate version onto the end of the arxiv identifier
			Series = '';														-- unset
			deprecated_parameter ('version');									-- deprecated parameter but only for cite arxiv
		end
		
		if first_set ({AccessDate, At, URLobject['format'], Page, Pages, PublisherName, URLobject['url'],	-- a crude list of parameters that are not supported by cite arxiv
			ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
			ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
			ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']},27) then
				append_error ('arxiv_params_not_supported', {});				-- add error message

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

	local COinS_date = {};														-- holds date info extracted from |date= for the COinS metadata by Module:Date verification
	local anchor_year = validate_date (AccessDate, ArchiveDate, Date, DoiBroken, Embargo, LayDate, PublicationDate, Year, COinS_date, Dateorigin);
																				-- used in the CITEREF identifier

-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
-- 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
	Embargo = is_embargoed (Embargo);											-- 

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

-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
	-- Test if citation has no title
	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

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

	-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
	-- 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
	-- is the article title, and Chapter is a section within the article.  So, we remap 
	
	local coins_chapter = Chapter;												-- default assuming that remapping not required
	local coins_title = Title;													-- et tu
	if 'encyclopaedia' == citation_class then
		if is_set (Chapter) and is_set (Title) and is_set (Periodical) then		-- if all are used then
			coins_chapter = Title;												-- remap
			coins_title = Periodical;
		end
	end

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

-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
	if 'arxiv' == citation_class then											-- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
		Periodical = '';														
	end

-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
	if 'newsgroup' == citation_class then
		if is_set (PublisherName) then
			PublisherName = wrap_msg ('newsgroup', make_external_link ('news:' .. PublisherName, PublisherName, A:ORIGIN ('PublisherName')), use_lowercase);
		end
	end

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

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

	Others = pend_separator (Others, sepc, true);
	Others = pend_separator (wrap_msg ('translated', Translators, use_lowercase), sepc, true) .. Others;
	
	if 'speech' ~= citation_class then 
		TitleNote = pend_separator (TitleNote, sepc, true);
	end
	
	Edition = wrap_msg ('edition', Edition, use_lowercase);
	Series = pend_separator (Series, sepc, true);
	OrigYear = wrap_msg ('orig year', OrigYear, use_lowercase);
	Agency = pend_separator (Agency, sepc, true);
	Volume = format_volume_issue (Volume, Issue, citation_class, Periodical_origin, sepc, use_lowercase);

	------------------------------------ totally unrelated data
	
	Via = wrap_msg ('via', Via, use_lowercase);
	AccessDate = format_accessdate (AccessDate, sepc, use_lowercase);
	ID = format_id (ID, Docket, sepc, use_lowercase);
	ID_list = build_id_list (ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class});

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

	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

--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
Looks for a parameter's name in the whitelist.

Parameters in the whitelist can have three values:
	true - active, supported parameters
	false - deprecated, supported parameters
	nil - unsupported parameters
	
]]

local function validate (name)
	local name = tostring (name);
	local state = whitelist.basic_arguments[name];
	
	-- Normal arguments
	if true == state then return true; end										-- valid actively supported parameter
	if false == state then
		deprecated_parameter (name);											-- parameter is deprecated but still supported
		return true;
	end
	
	-- Arguments with numbers in them
	name = name:gsub ('%d+', '#');												-- replace digit(s) with # (last25 becomes last#
	state = whitelist.numbered_arguments[name];
	if true == state then return true; end										-- valid actively supported parameter
	if false == state then
		deprecated_parameter (name);											-- parameter is deprecated but still supported
		return true;
	end
	
	return false;								-- Not supported because not found or name is set to nil
end

--[[--------------------------< C I T A T I O N >--------------------------------------------------------------

This is used by templates such as {{cite book}} to create the actual citation text.

]]

function citation (frame)
	local pframe = frame:getParent();
	local module_path = 'Module:Citation/CS1/'
	local module_suffix = frame:getTitle():gsub ('^Module:Citation/CS1', ''); 
	
	load_modules (module_path, module_suffix);
	
	local args = {};
	local suggestions = {};
	local error_reported = false;

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

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

--[[--------------------------< E X P O R T E D   F U N C T I O N S >------------------------------------------
]]

return {citation = citation};
检索自“https://wiki.gnix807.cn/index.php?title=模块:Citation/CS1&oldid=258”