跳转到内容

Module:Citation/CS1:修订间差异

轻之舟百科,让知识轻装启航
删除的内容 添加的内容
enwiki>Trappist the monk
无编辑摘要
标签:已被回退
CaelLab-import​(留言 | 贡献)
huifu bei enwiki daoru dingti de banben (shangyiban zhwiki>Shizhao)
标签:手工回退
 
第1行: 第1行:
--[[--------------------------< 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 >-----------------
require ('strict');

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

each of these counts against the Lua upvalue limit

]]
]]


local validation; -- functions in Module:Citation/CS1/Date_validation

local utilities; -- functions in Module:Citation/CS1/Utilities
local z = {}; -- table of tables in Module:Citation/CS1/Utilities

local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers
local metadata; -- functions in Module:Citation/CS1/COinS
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
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 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)
--[[------------------< P A G E S C O P E V A R I A B L E S >---------------
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);
declare variables here that have page-wide scope that are not brought in from
links.set_selected_modules (utilities, errors);
other modules; that are created here and used here
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;

local added_deprecated_cat; -- boolean flag so that the category is added only once
local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category
local added_generic_name_errs; -- boolean flag so we only emit one generic name error / category and stop testing names once an error is encountered
local added_numeric_name_errs; -- boolean flag so we only emit one numeric name error / category and stop testing names once an error is encountered
local added_numeric_name_maint; -- boolean flag so we only emit one numeric name maint category and stop testing names once a category has been emitted
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
local is_sandbox; -- true when using sandbox modules to render citation
local url_was_archive_today; -- boolean flag set to true when has_archive_today_url() has unset |url= because it held a deprecated archive.today url


--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------

Locates and returns the first set value in a table of values where the order established in the table,
left-to-right (or top-to-bottom), is the order in which the values are evaluated. Returns nil if none are set.

This version replaces the original 'for _, val in pairs do' and a similar version that used ipairs. With the pairs
version the order of evaluation could not be guaranteed. With the ipairs version, a nil value would terminate
the for-loop before it reached the actual end of the list.

]]

local function first_set (list, count)
local i = 1;
while i <= count do -- loop through all items in list
if utilities.is_set( list[i] ) then
return list[i]; -- return the first set list member
end
i = i + 1; -- point to next
end
end


--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------

Adds a single Vancouver system error message to the template's output regardless of how many error actually exist.
To prevent duplication, added_vanc_errs is nil until an error message is emitted.

added_vanc_errs is a Boolean declared in page scope variables above

]]

local function add_vanc_error (source, position)
if added_vanc_errs then return end
added_vanc_errs = true; -- note that we've added this category
utilities.set_message ('err_vancouver', {source, position});
end


--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------

does this thing that purports to be a URI scheme seem to be a valid scheme? The scheme is checked to see if it
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
Scheme names consist of a sequence of characters beginning with a
letter and followed by any combination of letters, digits, plus
("+"), period ("."), or hyphen ("-").

returns true if it does, else false

]]

local function is_scheme (scheme)
return scheme and scheme:match ('^%a[%a%d%+%.%-]*:'); -- true if scheme is set and matches the pattern
end


--[=[-------------------------< I S _ D O M A I N _ N A M E >--------------------------------------------------

Does this thing that purports to be a domain name seem to be a valid domain name?

Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
BNF defined here: https://tools.ietf.org/html/rfc4234
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
see also [[Single-letter second-level domain]]
list of TLDs: https://www.iana.org/domains/root/db

RFC 952 (modified by RFC 1123) requires the first and last character of a hostname to be a letter or a digit
(see http://tools.ietf.org/html/rfc952 §GRAMMATICAL HOST TABLE SPECIFICATION §§B. Lexical grammar <name>; see
http://tools.ietf.org/html/rfc1123#section-2). Between the first and last characters the name may use letters,
digits, and the hyphen.

Also allowed are IPv4 addresses. IPv6 not supported

domain is expected to be stripped of any path so that the last character in the last character of the TLD. tld
is two or more alpha characters. Any preceding '//' (from splitting a URL with a scheme) will be stripped
here. Perhaps not necessary but retained in case it is necessary for IPv4 dot decimal.

There are several tests:
the first character of the whole domain name including subdomains must be a letter or a digit
internationalized domain name (ASCII characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the TLD) see https://tools.ietf.org/html/rfc3490
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
two-character SL domains in gTLDs (where the gTLD is two or more letters)
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
IPv4 dot-decimal address format; TLD not allowed

returns true if domain appears to be a proper name and TLD or IPv4 address, else false

]=]

local function is_domain_name (domain)
if not domain then
return false; -- if not set, abandon
end
first_set = utilities.first_set;
domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once
hyphen_to_dash = utilities.hyphen_to_dash;

is_set = utilities.is_set;
local sl_domain = domain:match ('([^%.]+)%.[^%.]+$') or domain; -- test the second level domain name; ignore subdomains some (rarely) include chars not letter-digit-hyphen
in_array = utilities.in_array;

substitute = utilities.substitute;
if not (sl_domain:match ('^%w') and sl_domain:match ('%w$') and -- first and last characters must be letter or digit
sl_domain:match ('^[%w%-]+$')) then -- all other characters must be letters, digits, or hyphen-minus
return false;
end

if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource
return false;
end

local patterns = { -- patterns that look like URLs
'%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
'%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
'%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
'%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
'%f[%w][%w]%.%a%a$', -- one character hostname and ccTLD (2 chars)
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
'[%a%d]+%:?' -- IPv6 address
}

for _, pattern in ipairs (patterns) do -- loop through the patterns list
if domain:match (pattern) then
return true; -- if a match then we think that this thing that purports to be a URL is a URL
end
end

for _, d in ipairs (cfg.single_letter_2nd_lvl_domains_t) do -- look for single letter second level domain names for these top level domains
if domain:match ('%f[%w][%w]%.' .. d) then
return true
end
end
return false; -- no matches, we don't know what this thing is
end


--[[--------------------------< I S _ U R L >------------------------------------------------------------------

returns true if the scheme and domain parts of a URL appear to be a valid URL; else false.

This function is the last step in the validation process. This function is separate because there are cases that
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
wikilinks.

]]

local function is_url (scheme, domain)
if utilities.is_set (scheme) then -- if scheme is set check it and domain
return is_scheme (scheme) and is_domain_name (domain);
else
return is_domain_name (domain); -- scheme not set when URL is protocol-relative
end
end


--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------

Split a URL into a scheme, authority indicator, and domain.

First remove Fully Qualified Domain Name terminator (a dot following TLD) (if any) and any path(/), query(?) or fragment(#).

If protocol-relative URL, return nil scheme and domain else return nil for both scheme and domain.

When not protocol-relative, get scheme, authority indicator, and domain. If there is an authority indicator (one
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.

Any URL that does not have news: scheme must have authority indicator (//). TODO: are there other common schemes
like news: that don't use authority indicator?

Strip off any port and path;

]]

local function split_url (url_str)
local scheme, authority, domain;
has_invisible_chars = utilities.has_invisible_chars;
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
kern_quotes = utilities.kern_quotes;

pend_separator = utilities.pend_separator;
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol-relative URL
safe_join = utilities.safe_join;
domain = url_str:match ('^//(%S*)')
wrap_style = utilities.wrap_style;
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name
wrap_msg = utilities.wrap_msg;
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
if utilities.is_set (authority) then
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
if utilities.is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
return scheme; -- return scheme only making domain nil which will cause an error message
end
else
if not scheme:match ('^news:') then -- except for news:..., MediaWiki won't link URLs that do not have authority indicator; TODO: a better way to do this test?
return scheme; -- return scheme only making domain nil which will cause an error message
end
end
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
end
make_external_link = links.make_external_link;
return scheme, domain;
make_internal_link = links.make_internal_link;
end
check_for_external_link = links.check_for_external_link;


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

checks the content of |title-link=, |series-link=, |author-link=, etc. for properly formatted content: no wikilinks, no URLs

Link parameters are to hold the title of a Wikipedia article, so none of the WP:TITLESPECIALCHARACTERS are allowed:
# < > [ ] | { } _
except the underscore which is used as a space in wiki URLs and # which is used for section links

returns false when the value contains any of these characters.

When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid URL (the
|<param>-link= parameter is ok); else false when value appears to be a valid URL (the |<param>-link= parameter is NOT ok).

]]

local function link_param_ok (value)
local scheme, domain;
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
return false;
end

scheme, domain = split_url (value); -- get scheme or nil and domain or nil from URL;
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid URL
end


--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------

Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.

|<title>= may be wiki-linked but not when |<param>-link= has a value. This function emits an error message when
that condition exists

check <link> for inter-language interwiki-link prefix. prefix must be a MediaWiki-recognized language
code and must begin with a colon.

]]

local function link_title_ok (link, lorig, title, torig)
local orig;
if utilities.is_set (link) then -- don't bother if <param>-link doesn't have a value
if not link_param_ok (link) then -- check |<param>-link= markup
orig = lorig; -- identify the failing link parameter
elseif title:find ('%[%[') then -- check |title= for wikilink markup
orig = torig; -- identify the failing |title= parameter
elseif link:match ('^%a+:') then -- if the link is what looks like an interwiki
local prefix = link:match ('^(%a+):'):lower(); -- get the interwiki prefix

if cfg.inter_wiki_map[prefix] then -- if prefix is in the map, must have preceding colon
orig = lorig; -- flag as error
end
end
end

if utilities.is_set (orig) then
link = ''; -- unset
utilities.set_message ('err_bad_paramlink', orig); -- URL or wikilink in |title= with |title-link=;
end
add_maint_cat = errors.add_maint_cat;
return link; -- link if ok, empty string else
append_error = errors.append_error;
end
make_error_tail = errors.make_error_tail;

reset_error = errors.reset_error;

set_error = errors.set_error;
--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
select_one = errors.select_one;

throw_error = errors.throw_error;
Determines whether a URL string appears to be valid.

First we test for space characters. If any are found, return false. Then split the URL into scheme and domain
portions, or for protocol-relative (//example.com) URLs, just the domain. Use is_url() to validate the two
portions of the URL. If both are valid, or for protocol-relative if domain is valid, return true, else false.

Because it is different from a standard URL, and because this module used external_link() to make external links
that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name
is at https://tools.ietf.org/html/rfc5536#section-3.1.4

]]

local function check_url( url_str )
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper URL
return false;
end
local scheme, domain;

scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from URL;
extract_ids = identifiers.extract_ids;
if 'news:' == scheme then -- special case for newsgroups
build_id_list = identifiers.build_id_list;
return domain:match('^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$');
is_embargoed = identifiers.is_embargoed;
end
extract_id_access_levels = identifiers.extract_id_access_levels;
get_people = people.get_people;
return is_url (scheme, domain); -- return true if value appears to be a valid URL
format_people = people.format_people;
end


--[=[-------------------------< I S _ P A R A M E T E R _ E X T _ W I K I L I N K >----------------------------

Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
non-space characters following the opening bracket appear to be a URL. The test will also find external wikilinks
that use protocol-relative URLs. Also finds bare URLs.

The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs. The tests that
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
is possible as might be [[en://Hus]].

]=]

local function is_parameter_ext_wikilink (value)
local scheme, domain;

if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext. wikilink with scheme and domain: [xxxx://yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol-relative ext. wikilink: [//yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
elseif value:match ('^//%S+') or value:match ('%s//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; authority indicator (//) must be be preceded nothing or by whitespace
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain
else
return false; -- didn't find anything that is obviously a URL
end

return is_url (scheme, domain); -- return true if value appears to be a valid URL
end


--[[--------------------------< I S _ A R C H I V E _ T O D A Y _ U R L >--------------------------------------

archive.today (and .ph, .is, .md, .li, .fo, .vn) are deprecated. See Wikipedia:Requests_for_comment/Archive.is_RFC_5
(Special:Permalink/1339352976)

<val> is a string that may or may not be a url

]]

local function is_archive_today_url (val)
if is_parameter_ext_wikilink (val) then -- is <val> a url?
local tld = val:match ('archive%.(%l+)/'); -- get the tld; real archive.today urls have a '/' after the tld
return tld and cfg.archive_today_tlds_t[tld]; -- return true if <tld> is one of the archive.today tlds; nil else
end
end


--[[--------------------------< H A S _ A R C H I V E _ T O D A Y _ U R L >------------------------------------

blank any parameter that holds one of the archive.today tlds (.today, .ph, .is, .md, .li, .fo, .vn) and also
blank parameters that are dependent on the offending parameter.

input <cite_args_t> is a table of all of this template's parameters This function modifies <cite_args_t>
when |url= or its alias |URL= hold an archive.today url, this function sets the flag <url_was_archive_today>
which is used later to suppress the missing url error message from {{citation}} when it has |website=<summat>
or from the templates {{cite web}}, {{cite podcast}}, {{cite mailing list}} which all require a url.

returns nothing

]]

local function has_archive_today_url (cite_args_t)
local unset_params_t = {}; -- to hold a sequence of parameters to unset from cite_args_t

for p, v in pairs (cite_args_t) do -- look at each parameter in the template
if is_archive_today_url (v:lower()) then -- if it has a parameter with an archive.today url
table.insert (unset_params_t, p); -- add the url-holding parameter name to our list of parameters to unset (may or may not be a legitimate url parameter)
if 'url' == p:lower() then -- if this parameter is |url= or |URL=
url_was_archive_today = true; -- set a flag so that cite web / podcast / mailinglist don't emit a missing url error message
end

if p:match ('archive%-?url') and ('usurped' == cite_args_t['url-status'] or 'unfit' == cite_args_t['url-status']) then -- if |archive-url=archive.today and |url-status=unfit/usurped
url_was_archive_today = true; -- set a flag so that cite web / podcast / mailinglist don't emit a missing url error message
table.insert (unset_params_t, 'url'); -- add the url parameter name to our list of parameters to unset (may or may not be a legitimate url parameter)
table.insert (unset_params_t, 'URL'); -- this one because both are possible
utilities.set_message ('err_url_suppressed'); -- emit supplemental error message
end

if cfg.dependencies_t[p] then -- if this url-holding parameter (<p>) has dependencies
for _, dependent in ipairs (cfg.dependencies_t[p]) do -- loop through the url-holding parameter's dependency sequence
table.insert (unset_params_t, dependent); -- add dependent parameter to the list to be unset
end
end
end
end

if 0 < #unset_params_t then -- when there are parameters to unset
if not is_preview_mode then -- when in preview mode do not suppress any parameters
for _, unset_param in ipairs (unset_params_t) do -- loop through the sequence
cite_args_t[unset_param] = nil; -- and unset the url-holding parameter and its dependent parameters to avoid parameter-requires-other-parameter errors
end
end
utilities.set_message ('maint_deprecated_archive'); -- add a maintenance message
end
end


--[[-------------------------< C H E C K _ F O R _ U R L >-----------------------------------------------------

loop through a list of parameters and their values. Look at the value and if it has an external link, emit an error message.

]]

local function check_for_url (parameter_list, error_list)
for k, v in pairs (parameter_list) do -- for each parameter in the list
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a URL add an error message
table.insert (error_list, utilities.wrap_style ('parameter', k));
end
end
end


--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------

Escape sequences for content that will be used for URL descriptions

]]

local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then
utilities.set_message ('err_wikilink_in_url', {});
end
COinS = coins.COinS;
return str:gsub( '[%[%]\n]', {
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end


--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------

Format an external link with error checking

]]

local function external_link (URL, label, source, access)
local domain;
local path;
local base_url;

if not utilities.is_set (label) then
label = URL;
if utilities.is_set (source) then
utilities.set_message ('err_bare_url_missing_title', {utilities.wrap_style ('parameter', source)});
else
error (cfg.messages["bare_url_no_origin"]); -- programmer error; valid parameter name does not have matching meta-parameter
end
end
if not check_url (URL) then
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)});
end
script_concatenate = languages.script_concatenate;
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path
language_parameter = languages.language_parameter;
if path then -- if there is a path portion
path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); -- replace '[' and ']' with their percent-encoded values
URL = table.concat ({domain, path}); -- and reassemble
end


base_url = table.concat ({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL

if utilities.is_set (access) then -- access level (subscription, registration, limited)
base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
end

return base_url;
end
end



--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
--[[--------------------------< 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
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. Only one error message is emitted regardless of the number of deprecated
offending parameter name to the error message.
parameters in the citation.

added_deprecated_cat is a Boolean declared in page scope variables above


]]
]]


local function deprecated_parameter(name)
local function deprecated_parameter (name)
append_error ('deprecated_params', {name});
if not added_deprecated_cat then
added_deprecated_cat = true; -- note that we've added this category
utilities.set_message ('err_deprecated_params', {name}); -- add error message
end
end
end


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


]]
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------


local function discard_parameter (name, label, new_value)
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
if is_set (name) then
mark contained in a |title= or |chapter= parameter's value.
append_error ('parameter_discarded', label);

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)
Double single quotes (italic or bold wiki-markup) are not kerned.

Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks.

Call this function for chapter titles, for website titles, etc.; not for book titles.

]=]

local function kern_quotes (str)
local wl_type, label, link;

wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
str = utilities.substitute (cfg.presentation['kern-left'], str);
str = utilities.substitute (cfg.presentation['kern-right'], str);
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
str = utilities.substitute (cfg.presentation['kern-left'], str);
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
str = utilities.substitute (cfg.presentation['kern-right'], str);
end

else -- plain text or [[L|D]]; text in label variable
label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)

local cap = mw.ustring.match (label, "^([\"\'][^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
if utilities.is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-left'], cap);
end
cap = mw.ustring.match (label, "^(.+[^\'][\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
if utilities.is_set (cap) then
label = utilities.substitute (cfg.presentation['kern-right'], cap);
end
if 2 == wl_type then
str = utilities.make_wikilink (link, label); -- reassemble the wikilink
else
str = label;
end
end
end
return str;
return new_value;
end
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
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
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.
|script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
in italic markup.

Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate RTL languages from the English left to right.

|script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO 639-1 language code and a colon:
|script-title=ja:*** *** (where * represents a Japanese character)
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
|script-title=ja : *** ***
|script-title=ja: *** ***
|script-title=ja :*** ***
Spaces preceding the prefix are allowed: |script-title = ja:*** ***

The prefix is checked for validity. If it is a valid ISO 639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute
is not added. At this time there is no error message for this condition.

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


]]
]]


local function format_script_value (script_value, script_param)
local function sanitized_parameter_value (value, name, key, default)
if not is_set (value) then
local lang=''; -- initialize to empty string
return value; -- an empty parameter is ok
local name;
elseif in_array (value:lower(), cfg.keywords[key]) then
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
return value;
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
if not utilities.is_set (lang) then
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing title part']}); -- prefix without 'title'; add error message
return ''; -- script_value was just the prefix so return empty string
end
-- if we get this far we have prefix and script
name = cfg.lang_tag_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code?
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
-- is prefix one of these language codes?
if utilities.in_array (lang, cfg.script_lang_codes) then
utilities.add_prop_cat ('script', {name, lang})
else
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['unknown language code']}); -- unknown script-language; add error message
end
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
else
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['invalid language code']}); -- invalid language code; add error message
lang = ''; -- invalid so set lang to empty string
end
else
else
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing prefix']}); -- no language code prefix; add error message
append_error ('invalid_param_val', {name, value}); -- not an allowed value so add error message
return default;
end
end
script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL

return script_value;
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 >------------------------------

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

Initially for |title= and |script-title=, this function concatenates those two parameter values after the script
value has been wrapped in <bdi> tags.


]]
]]


local function script_concatenate (title, script, script_param)
local function extra_text_in_parameter_check (value, type)
if utilities.is_set (script) then
local good_patterns = cfg.extra_text_pattern[type]['good'];
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
local bad_patterns = cfg.extra_text_pattern[type]['bad'];
if utilities.is_set (script) then
title = title .. ' ' .. script; -- concatenate title and script title
for _, pattern in pairs (good_patterns) do
if value:match (pattern) then
return;
end
end
end
end
return title;
for _, pattern in pairs (bad_patterns) do
end
if value:match (pattern) then

add_maint_cat ('extra_text', type);

return;
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------

Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
configuration taking one argument. Supports lower case text for {{citation}} templates. Additional text taken
from citation_config.messages - the reason this function is similar to but separate from wrap_style().

]]

local function wrap_msg (key, str, lower)
if not utilities.is_set ( str ) then
return "";
end
if true == lower then
local msg;
msg = cfg.messages[key]:lower(); -- set the message to lower case before
return utilities.substitute ( msg, str ); -- including template text
else
return utilities.substitute ( cfg.messages[key], str );
end
end


--[[----------------< W I K I S O U R C E _ U R L _ M A K E >-------------------

Makes a Wikisource URL from Wikisource interwiki-link. Returns the URL and appropriate
label; nil else.

str is the value assigned to |chapter= (or aliases) or |title= or |title-link=

]]

local function wikisource_url_make (str)
local wl_type, D, L;
local ws_url, ws_label;
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});

wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)

if 0 == wl_type then -- not a wikilink; might be from |title-link=
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if utilities.is_set (str) then
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title
});
ws_label = str; -- label for the URL
end
elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]]
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if utilities.is_set (str) then
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title
});
ws_label = str; -- label for the URL
end
elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]])
str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if utilities.is_set (str) then
ws_label = D; -- get ws article name from display portion of interwiki link
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title without namespace from link portion of wikilink
});
end
end
end
end

if ws_url then
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent-encoding of fragment marker
end

return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil
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
--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
we get the date used in the metadata.

Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
and |trans-<periodical>= into a single Periodical meta-parameter.


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 function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
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 not utilities.is_set (periodical) then
if is_set (Year) then
periodical = ''; -- to be safe for concatenation
if is_set (Date) then -- both |date= and |year= not normally needed;
local mismatch = year_date_check (Year, Date)
else
if 0 == mismatch then -- |year= does not match a year-value in |date=
periodical = utilities.wrap_style ('italic-title', periodical); -- style
append_error ('date_year_mismatch', {origin});
end
elseif 1 == mismatch then -- |year= matches year-value in |date=

add_maint_cat ('date_year');
periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
end

if utilities.is_set (trans_periodical) then
trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical);
if utilities.is_set (periodical) then
periodical = periodical .. ' ' .. trans_periodical;
else -- here when trans-periodical without periodical or script-periodical
periodical = trans_periodical;
utilities.set_message ('err_trans_missing_title', {'periodical'});
end
end
anchor_year = Year; -- Year first for legacy citations and for YMD dates that require disambiguation
end
end


if is_set (error_message) then
return periodical;
append_error ('bad_date', {error_message}); -- add this error message
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 (script_chapter, script_chapter_source, chapter, trans_chapter, trans_chapter_source, chapter_url, chapter_url_source, no_quotes, access)
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
if ws_url then
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
chapter = ws_label;
end
end
return anchor_year;

if not utilities.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 = utilities.wrap_style ('quoted-title', chapter);
end
end

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

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

if utilities.is_set (trans_chapter) then
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
if utilities.is_set (chapter) then
chapter = chapter .. ' ' .. trans_chapter;
else -- here when trans_chapter without chapter or script-chapter
chapter = trans_chapter;
utilities.set_message ('err_trans_missing_title', {trans_chapter_source:match ('trans%-?(.+)')}); -- when no chapter, get matching name from trans-<param>
end
end

return chapter;
end
end


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

仅为保持兼容性而设置。理论上可以直接调用discard_parameter()丢弃相关参数。
--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------

This function searches a parameter's value for non-printable or invisible characters.
The search stops at the first match.

This function will detect the visible replacement character when it is part of the Wikisource.

Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers
(gallery, math, pre, ref) and identifies them with a slightly different error message.
See also coins_cleanup().

Output of this function is an error message that identifies the character or the
Unicode group, or the stripmarker that was detected along with its position (or,
for multi-byte characters, the position of its first byte) in the parameter value.

]]
]]

local function has_invisible_chars (param, v)
local function discard_chapter (args)
local chap_param;
local position; -- position of invisible char or starting position of stripmarker
if is_set (args['Chapter']) then -- get a parameter name from one of these chapter related meta-parameters
local capture; -- used by stripmarker detection to hold name of the stripmarker
chap_param = args:ORIGIN ('Chapter');
local stripmarker; -- boolean set true when a stripmarker is found
elseif is_set (args['TransChapter']) then

chap_param = args:ORIGIN ('TransChapter');
capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true
elseif is_set (args['ChapterURL']) then
if capture == v then -- if same there are no Unicode characters
chap_param = args:ORIGIN ('ChapterURL');
return;
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 is_set (chap_param) then -- if we found one

append_error ('chapter_ignored', {chap_param}); -- add error message
for _, invisible_char in ipairs (cfg.invisible_chars) do
local char_name = invisible_char[1]; -- the character or group name
local pattern = invisible_char[2]; -- the pattern used to find it
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
if position and (cfg.invisible_defs.zwj == capture) then -- if we found a zero-width joiner character
if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts
position = nil; -- unset position
elseif cfg.emoji_t[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
position = nil; -- unset position
end
end
if position then
if utilities.in_array(capture, {'nowiki', 'math', 'templatestyles'}) then -- nowiki, math and templatestyles stripmarkers (not an error condition)
stripmarker = true; -- set a flag
elseif true == stripmarker and cfg.invisible_defs.del == capture then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
position = nil; -- unset; for now, ignore linter warning
else
local err_msg;
if capture and not (cfg.invisible_defs.del == capture or cfg.invisible_defs.zwj == capture) then
err_msg = utilities.substitute (cfg.messages.invisible_1, {capture, char_name}); -- <capture> here is stripmarker name
else
err_msg = utilities.substitute (cfg.messages.invisible_2, char_name);
end

utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}); -- add error message
return; -- and done with this parameter
end
end
end
end
end
end


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

--[[-------------------< 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 function create_url_object (url, source, fmt, fmt_source, access, access_source)
return {
local origin = {};
['url'] = is_set (url) and url or '',
['origin'] = is_set (source) and source or '',
return setmetatable({
['access'] = is_set (access) and sanitized_parameter_value (access, access_source, 'url-access', '') or '',
ORIGIN = function ( self, k )
['access-origin'] = is_set (access_source) and access_source or '',
local dummy = self[k]; -- force the variable to be loaded; for now, ignore linter warning
['format'] = is_set (fmt) and fmt or '',
return origin[k];
['format-origin'] = is_set (fmt_source) and fmt_source or '',
end
['access-text'] = ''
},
{
}
__index = function ( tbl, k )
if origin[k] ~= nil then
return nil;
end
local v;
local list = cfg.aliases[k];
if type( list ) == 'table' then
v, origin[k] = utilities.select_one ( args, list, 'err_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'] .. ': ' .. k);
end
-- Empty strings, not nil;
if v == nil then
v = '';
origin[k] = '';
end
rawset( tbl, k, v );
return v;
end,
});
end
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.
--[[--------------------------< N O W R A P _ D A T E >-------------------------
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).

When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
When date 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

DOES NOT yet support MMMM YYYY or any of the date ranges.

]]

local function nowrap_date (date)
local cap;
local cap2;

if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = utilities.substitute (cfg.presentation['nowrap1'], date);
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
end
return date;
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)
local function set_titletype (cite_class, title_type)
if utilities.is_set (title_type) then
if is_set (title_type) then
if 'none' == cfg.keywords_xlate[title_type] then
if 'none' == title_type then
title_type = ''; -- if |type=none then type parameter not displayed
title_type = ''; -- if |type=none then type parameter not displayed
end
end
第958行: 第231行:
end
end


return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
return cfg.title_types[cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
end


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


check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
--[[--------------------------< S A F E _ J O I N >-----------------------------

Joins a sequence of strings together while checking for duplicate separation characters.


]]
]]


local function safe_join( tbl, duplicate_char )
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);
local f = {}; -- create a function table appropriate to type of 'duplicate character'
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
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
f.gsub = string.gsub
return true; -- set no_tracking_cats
f.match = string.match
f.sub = string.sub
else -- for multi-byte characters use the ustring library functions
f.gsub = mw.ustring.gsub
f.match = mw.ustring.match
f.sub = mw.ustring.sub
end
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
local str = ''; -- the output string
return true; -- set no_tracking_cats; bail out if one is found
for _, value in ipairs( tbl ) do
if value == nil then value = ''; end
if str == '' then -- if output string is empty
str = value; -- assign value to it (first time through the loop)
elseif value ~= '' then
local comp; -- what does 'comp' mean?
if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
else
comp = value;
end
-- typically duplicate_char is sepc
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
-- Because individual string segments often (always?) begin with terminal punct for the
-- preceding segment: 'First element' .. 'sepc next element' .. etc.?
local trim = false;
local end_chr = f.sub(str, -1, -1); -- get the last character of the output string
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
if end_chr == duplicate_char then -- if same as separator
str = f.sub(str, 1, -2); -- remove it
elseif end_chr == "'" then -- if it might be wiki-markup
if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
elseif f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
trim = true; -- why? why do this and next differently from previous?
elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
trim = true; -- same question
end
elseif end_chr == "]" then -- if it might be wiki-markup
if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
trim = true;
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
trim = true;
elseif f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
trim = true;
elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
trim = true;
end
elseif end_chr == " " then -- if last char of output string is a space
if f.sub(str, -2, -1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
str = f.sub(str, 1, -3); -- remove them both
end
end

if trim then
if value ~= comp then -- value does not equal comp when value contains HTML markup
local dup2 = duplicate_char;
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows HTML markup
else
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character
end
end
end
end
str = str .. value; -- add it to the output string
end
end
return false;
else
return true;
end
end
return str;
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
--[[--------------------------< I S _ S U F F I X >-----------------------------

returns true if suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
Puncutation not allowed.


]]
]]


local function is_suffix (suffix)
local function set_cs1_style (ps, ref)
if not is_set (ps) then -- unless explicitely set to something
if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
ps = '.'; -- terminate the rendered citation with a period
return true;
end
end
if not is_set(ref) then -- if |ref= is not set
return false;
ref = 'harv'; -- set default |ref=harv
end
return '.', ps, ref; -- separator is a full stop
end
end


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


Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------

For Vancouver style, author/editor names are supposed to be rendered in Latin
(read ASCII) characters. When a name uses characters that contain diacritical
marks, those characters are to be converted to the corresponding Latin
character. When a name is written using a non-Latin alphabet or logogram, that
name is to be transliterated into Latin characters. The module doesn't do this
so editors may/must.

This test allows |first= and |last= names to contain any of the letters defined
in the four Unicode Latin character sets
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F

|lastn= also allowed to contain hyphens, spaces, and apostrophes.
(http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods

This original test:
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$")
or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
was written outside of the code editor and pasted here because the code editor
gets confused between character insertion point and cursor position. The test has
been rewritten to use decimal character escape sequence for the individual bytes
of the Unicode characters so that it is not necessary to use an external editor
to maintain this code.

\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
\195\152-\195\182 – Ø-ö (U+00D8-U+00F6 – C0 controls)
\195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B)
\199\132-\201\143 – DŽ-ɏ (U+01C4-U+024F – Latin extended B)


]]
]]


local function is_good_vanc_name (last, first, suffix, position)
local function set_cs2_style (ps, ref)
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
if not suffix then
ps = ''; -- make sure it isn't nil
if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix
first = first:match ('(.-)[,%s]+'); -- get name/initials
suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix
end
end
end
if utilities.is_set (suffix) then
if not is_set (ref) then -- if |ref= is not set
ref = 'harv'; -- set default |ref=harv
if not is_suffix (suffix) then
add_vanc_error (cfg.err_msg_supl.suffix, position);
return false; -- not a name with an appropriate suffix
end
end
end
return ',', ps, ref; -- separator is a comma
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143\225\184\128-\225\187\191%-%s%']*$") or
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143\225\184\128-\225\187\191%-%s%'%.]*$") then
add_vanc_error (cfg.err_msg_supl['non-Latin char'], position);
return false; -- not a string of Latin characters; Vancouver requires Romanization
end;
return true;
end
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
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
rendered style.

Attempts to convert names to initials in support of |name-list-style=vanc.

Names in |firstn= may be separated by spaces or hyphens, or for initials, a period.
See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.

Vancouver style requires family rank designations (Jr, II, III, etc.) to be rendered
as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
This code only accepts and understands generational suffix in the Vancouver format
because Roman numerals look like, and can be mistaken for, initials.

This function uses ustring functions because firstname initials may be any of the
Unicode Latin characters accepted by is_good_vanc_name ().


]]
]]


local function reduce_to_initials (first, position)
local function get_settings_from_cite_class (ps, ref, cite_class)
local sep;
if first:find (',', 1, true) then
return first; -- commas not allowed; abandon
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, ref = set_cs1_style (ps, ref);
end
end


return sep, ps, ref -- return them all
local name, suffix = mw.ustring.match (first, "^(%u+) ([%dJS][%drndth]+)$");

if not name then -- if not initials and a suffix
name = mw.ustring.match (first, "^(%u+)$"); -- is it just initials?
end

if name then -- if first is initials with or without suffix
if 3 > mw.ustring.len (name) then -- if one or two initials
if suffix then -- if there is a suffix
if is_suffix (suffix) then -- is it legitimate?
return first; -- one or two initials and a valid suffix so nothing to do
else
add_vanc_error (cfg.err_msg_supl.suffix, position); -- one or two initials with invalid suffix so error message
return first; -- and return first unmolested
end
else
return first; -- one or two initials without suffix; nothing to do
end
end
end -- if here then name has 3 or more uppercase letters so treat them as a word

local initials_t = {}; -- table to hold initials
local i = 1; -- counter for number of initials

local names_t = mw.text.split (first, '[%s%-]+'); -- split into a sequence of names and possible suffix

while names_t[i] do -- loop through the sequence
if 1 < i and names_t[i]:match ('[%dJS][%drndth]+%.?$') then -- if not the first name, and looks like a suffix (may have trailing dot)
names_t[i] = names_t[i]:gsub ('%.', ''); -- remove terminal dot if present
if is_suffix (names_t[i]) then -- if a legitimate suffix
table.insert (initials_t, ' ' .. names_t[i]); -- add a separator space, insert at end of initials sequence
break; -- and done because suffix must fall at the end of a name
end -- no error message if not a suffix; possibly because of Romanization
end
if 3 > i then
table.insert (initials_t, mw.ustring.sub (names_t[i], 1, 1)); -- insert the initial at end of initials sequence
end
i = i + 1; -- bump the counter
end
return table.concat (initials_t); -- Vancouver format does not include spaces.
end
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
--[[--------------------------< I N T E R W I K I _ P R E F I X E N _ G E T >----------------------------------
config.CitationClass from the template's #invoke: to establish style.

extract interwiki prefixen from <value>. Returns two one or two values:
false – no prefixen
nil – prefix exists but not recognized
project prefix, language prefix – when value has either of:
:<project>:<language>:<article>
:<language>:<project>:<article>
project prefix, nil – when <value> has only a known single-letter prefix
nil, language prefix – when <value> has only a known language prefix

accepts single-letter project prefixen: 'd' (wikidata), 's' (wikisource), and 'w' (wikipedia) prefixes; at this
writing, the other single-letter prefixen (b (wikibook), c (commons), m (meta), n (wikinews), q (wikiquote), and
v (wikiversity)) are not supported.


]]
]]


local function interwiki_prefixen_get (value, is_link)
local function set_style (mode, mode_source, ps, ref, quote, cite_class)
local sep;
if not value:find (':%l+:') then -- if no prefix
mode = sanitized_parameter_value (mode, mode_source, 'mode', ''):lower();
return false; -- abandon; boolean here to distinguish from nil fail returns later
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, ref = set_cs1_style (ps, ref);
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
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
local prefix_patterns_linked_t = { -- sequence of valid interwiki and inter project prefixen
'^%[%[:([dsw]):(%l%l+):', -- wikilinked; project and language prefixes
'^%[%[:(%l%l+):([dsw]):', -- wikilinked; language and project prefixes
'^%[%[:([dsw]):', -- wikilinked; project prefix
'^%[%[:(%l%l+):', -- wikilinked; language prefix
}
local prefix_patterns_unlinked_t = { -- sequence of valid interwiki and inter project prefixen
'^:([dsw]):(%l%l+):', -- project and language prefixes
'^:(%l%l+):([dsw]):', -- language and project prefixes
'^:([dsw]):', -- project prefix
'^:(%l%l+):', -- language prefix
}
local cap1, cap2;
for _, pattern in ipairs ((is_link and prefix_patterns_linked_t) or prefix_patterns_unlinked_t) do
cap1, cap2 = value:match (pattern);
if cap1 then
break; -- found a match so stop looking
end
end
end
return sep, ps, ref
if cap1 and cap2 then -- when both then :project:language: or :language:project: (both forms allowed)
if 1 == #cap1 then -- length == 1 then :project:language:
if cfg.inter_wiki_map[cap2] then -- is language prefix in the interwiki map?
return cap1, cap2; -- return interwiki project and interwiki language
end
else -- here when :language:project:
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
return cap2, cap1; -- return interwiki project and interwiki language
end
end
return nil; -- unknown interwiki language
elseif not (cap1 or cap2) then -- both are nil?
return nil; -- we got something that looks like a project prefix but isn't; return fail
elseif 1 == #cap1 then -- here when one capture
return cap1, nil; -- length is 1 so return project, nil language
else -- here when one capture and its length it more than 1
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
return nil, cap1; -- return nil project, language
end
end
end
end


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

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

Formats a list of people (authors, contributors, editors, interviewers, translators)

names in the list will be linked when
|<name>-link= has a value
|<name>-mask- does NOT have a value; masked names are presumed to have been
rendered previously so should have been linked there

when |<name>-mask=0, the associated name is not rendered


]]
]]


local function list_people (control, people, etal)
local function swap_urls (url_object, chapter_url_object, archive_url_object, dead_url)
local original_url_object = create_url_object ();
local sep;
local is_dead = in_array (dead_url, cfg.keywords['deadurl-live']); -- used later when assembling archived text
local namesep;
local format = control.format;
local maximum = control.maximum;
local name_list = {};

if 'vanc' == format then -- Vancouver-like name styling?
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between names is a comma
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
else
sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
end
if is_set (archive_url_object['url']) then
if sep:sub (-1, -1) ~= " " then sep = sep .. " " end
if is_set (url_object['url']) then
if utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names
original_url_object = url_object;
if not is_dead then
for i, person in ipairs (people) do
url_object = archive_url_object;
if utilities.is_set (person.last) then
local mask = person.mask;
local one;
local sep_one = sep;

if utilities.is_set (maximum) and i > maximum then
etal = true;
break;
end
end
elseif is_set (chapter_url_object['url']) then -- URL not set so if chapter-url is set apply archive url to it
original_url_object = chapter_url_object;
if mask then
if not is_dead then
local n = tonumber (mask); -- convert to a number if it can be converted; nil else
chapter_url_object = archive_url_object;
if n then
one = 0 ~= n and string.rep("&mdash;", n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name
person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil
else
one = mask; -- replace name with mask text (must include name-list separator)
sep_one = " "; -- modify name-list separator
end
else
one = person.last; -- get surname
local first = person.first -- get given name
if utilities.is_set (first) then
if ("vanc" == format) then -- if Vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first, nil, i) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials (first, i); -- attempt to convert first name(s) to initials
end
end
one = one .. namesep .. first;
end
end
if utilities.is_set (person.link) then
one = utilities.make_wikilink (person.link, one); -- link author/editor
end

if one then -- if <one> has a value (name, mdash replacement, or mask text replacement)
local proj, tag = interwiki_prefixen_get (one, true); -- get the interwiki prefixen if present
if 'w' == proj and ('Wikipedia' == mw.site.namespaces.Project['name']) then
proj = nil; -- for stuff like :w:de:<article>, :w is unnecessary TODO: maint cat?
end
if proj then
local proj_name = ({['d'] = cfg.messages.wikidata, ['s'] = cfg.messages.wikisource, ['w'] = cfg.messages.wikipedia})[proj]; -- :w (wikipedia) for linking from a non-wikipedia project
if proj_name then
one = one .. utilities.wrap_style ('interproj', proj_name); -- add resized leading space, brackets, static text, language name
utilities.add_prop_cat ('interproj-linked-name', proj); -- categorize it; <proj> is sort key
tag = nil; -- unset; don't do both project and language
end
end
if tag == cfg.this_wiki_code then
tag = nil; -- stuff like :en:<article> at en.wiki is pointless TODO: maint cat?
end
if tag then
local lang = cfg.lang_tag_remap[tag] or cfg.mw_languages_by_tag_t[tag];
if lang then -- error messaging done in extract_names() where we know parameter names
one = one .. utilities.wrap_style ('interwiki', lang); -- add resized leading space, brackets, static text, language name
utilities.add_prop_cat ('interwiki-linked-name', tag); -- categorize it; <tag> is sort key
end
end

table.insert (name_list, one); -- add it to the list of names
table.insert (name_list, sep_one); -- add the proper name-list separator
end
end
end
end
end
end
return original_url_object, url_object, chapter_url_object;

local count = #name_list / 2; -- (number of names + number of separators) divided by 2
if 0 < count then
if 1 < count and not etal then
if 'amp' == format then
name_list[#name_list-2] = " & "; -- replace last separator with ampersand text
elseif 'and' == format then
if 2 == count then
name_list[#name_list-2] = cfg.presentation.sep_nl_and; -- replace last separator with 'and' text
else
name_list[#name_list-2] = cfg.presentation.sep_nl_end; -- replace last separator with '(sep) and' text
end
end
end
name_list[#name_list] = nil; -- erase the last separator
end

local result = table.concat (name_list); -- construct list
if etal and utilities.is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
result = result .. sep .. cfg.messages['et al']; -- we've got a last-first list and etal so add et al.
end
return result, count; -- return name-list string and count of number of names (count used for editor names only)
end
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。
--[[--------------------< M A K E _ C I T E R E F _ 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 make_citeref_id (namelist, year)
local function format_url_access_text (url_object, subscription_required, registration_required)
local access_text = '';
local names={}; -- a table for the one to four names and year
local redundant = false;
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
local access = url_object['access'];
names[i] = v.last
local reg = false;
if i == 4 then break end -- if four then done
local sub = false;
end
if is_set (access) then
table.insert (names, year); -- add the year at the end
if (access == 'limited') then
local id = table.concat(names); -- concatenate names and year for CITEREF id
access_text = cfg.presentation['limited']; -- 有限度免费访问
if utilities.is_set (id) then -- if concatenation is not an empty string
elseif (access == 'registration') then
return "CITEREF" .. id; -- add the CITEREF portion
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
else
if is_set (subscription_required) then
return ''; -- return an empty string; no reason to include CITEREF id in this citation
access_text = cfg.presentation['subscription']; -- 需要免费注册
end
sub = true;
end
if is_set (registration_required) then

redundant = true;

--[[--------------------------< C I T E _ C L A S S _A T T R I B U T E _M A K E >------------------------------

construct <cite> tag class attribute for this citation.

<cite_class> – config.CitationClass from calling template
<mode> – value from |mode= parameter

]]

local function cite_class_attribute_make (cite_class, mode)
local class_t = {};
table.insert (class_t, 'citation'); -- required for blue highlight
if 'citation' ~= cite_class then
table.insert (class_t, cite_class); -- identify this template for user css
table.insert (class_t, utilities.is_set (mode) and mode or 'cs1'); -- identify the citation style for user css or javascript
else
table.insert (class_t, utilities.is_set (mode) and mode or 'cs2'); -- identify the citation style for user css or javascript
end
for _, prop_key in ipairs (z.prop_keys_t) do
table.insert (class_t, prop_key); -- identify various properties for user css or javascript
end

return table.concat (class_t, ' '); -- make a big string and done
end


--[[---------------------< N A M E _ H A S _ E T A L >--------------------------

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

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

]]

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

if utilities.is_set (name) then -- name can be nil in which case just return
local patterns = cfg.et_al_patterns; -- get patterns from configuration
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
if name:match (pattern) then -- if this 'et al' pattern is found in name
name = name:gsub (pattern, ''); -- remove the offending text
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
if not nocat then -- no categorization for |vauthors=
utilities.set_message ('err_etal', {param}); -- and set an error if not added
end
end
end
elseif is_set (registration_required) then
access_text = cfg.presentation['registration']; -- 需要付费订阅
reg = true
else
access_text = '';
end
end
end
end
if is_set (url_object ['url']) then

url_object['access-text'] = access_text;
return name, etal;
if sub then
end
add_maint_cat ('subscription');

elseif reg then

add_maint_cat ('registration');
--[[---------------------< N A M E _ I S _ N U M E R I C >----------------------

Add an error message and category when <name> parameter value does not contain letters.

Add a maintenance category when <name> parameter value has numeric characters mixed with characters that are
not numeric characters; could be letters and/or punctuation characters.

This function will only emit one error and one maint message for the current template. Does not emit both error
and maint messages/categories for the same parameter value.

returns nothing

]]

local function name_is_numeric (name, name_alias, list_name)
local patterns = {
'^%D+%d', -- <name> must have digits preceded by other characters
'^%D*%d+%D+', -- <name> must have digits followed by other characters
}

if not added_numeric_name_errs and mw.ustring.match (name, '^[%A]+$') then -- if we have not already set an error message and <name> does not have any alpha characters
utilities.set_message ('err_numeric_names', name_alias); -- add an error message
added_numeric_name_errs = true; -- set the flag so we emit only one error message
return; -- when here no point in further testing; abandon
end

if not added_numeric_name_maint then -- if we have already set a maint message
for _, pattern in ipairs (patterns) do -- spin through list of patterns
if mw.ustring.match (name, pattern) then -- digits preceded or followed by anything but digits; %D+ includes punctuation
utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
added_numeric_name_maint = true; -- set the flag so we emit only one maint message
return; -- when here no point in further testing; abandon
end
end
end
else
-- 预留报错
end
end
return redundant;
end
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
--[[-----------------< N A M E _ H A S _ M U L T _ N A M E S >------------------
or formatted issue, or an empty string if neither are set.

Evaluates the content of last/surname (authors etc.) parameters for multiple names.
Multiple names are indicated if there is more than one comma or any "unescaped"
semicolons. Escaped semicolons are ones used as part of selected HTML entities.
If the condition is met, the function adds the multiple name maintenance category.

Same test for first except that commas should not appear in given names (MOS:JR says
that the generational suffix does not take a separator character). Titles, degrees,
postnominals, affiliations, all normally comma separated don't belong in a citation.

<name> – name parameter value
<list_name> – AuthorList, EditorList, etc
<limit> – number of allowed commas; 1 (default) for surnames; 0 for given names

returns nothing


]]
]]

local function name_has_mult_names (name, list_name, limit)
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
if not is_set (volume) and not is_set (issue) then
local _, commas, semicolons, nbsps;
return '';
limit = limit and limit or 1;
end
if utilities.is_set (name) then
_, commas = name:gsub (',', ''); -- count the number of commas
if 'magazine' == cite_class or (cite_class =='map' and 'magazine' == origin) then
_, semicolons = name:gsub (';', ''); -- count the number of semicolons
if is_set (volume) and is_set (issue) then
-- nbsps probably should be its own separate count rather than merged in
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
-- some way with semicolons because Lua patterns do not support the
elseif is_set (volume) then
-- grouping operator that regex does, which means there is no way to add
return wrap_msg ('vol', {sepc, volume}, lower);
-- more entities to escape except by adding more counts with the new
else
-- entities
return wrap_msg ('issue', {sepc, issue}, lower);
_, nbsps = name:gsub ('&nbsp;',''); -- count nbsps
-- There is exactly 1 semicolon per &nbsp; entity, so subtract nbsps
-- from semicolons to 'escape' them. If additional entities are added,
-- they also can be subtracted.
if limit < commas or 0 < (semicolons - nbsps) then
utilities.set_message ('maint_mult_names', cfg.special_case_translation [list_name]); -- add a maint message
end
end
end
end
end
local vol = '';


--[=[-------------------------< I S _ G E N E R I C >----------------------------------------------------------

Compares values assigned to various parameters according to the string provided as <item> in the function call.
<item> can have on of two values:
'generic_names' – for name-holding parameters: |last=, |first=, |editor-last=, etc
'generic_titles' – for |title=

There are two types of generic tests. The 'accept' tests look for a pattern that should not be rejected by the
'reject' test. For example,
|author=[[John Smith (author)|Smith, John]]
would be rejected by the 'author' reject test. But piped wikilinks with 'author' disambiguation should not be
rejected so the 'accept' test prevents that from happening. Accept tests are always performed before reject
tests.

Each of the 'accept' and 'reject' sequence tables hold tables for en.wiki (['en']) and local.wiki (['local'])
that each can hold a test sequence table The sequence table holds, at index [1], a test pattern, and, at index
[2], a boolean control value. The control value tells string.find() or mw.ustring.find() to do plain-text search (true)
or a pattern search (false). The intent of all this complexity is to make these searches as fast as possible so
that we don't run out of processing time on very large articles.

Returns
true when a reject test finds the pattern or string
false when an accept test finds the pattern or string
nil else

]=]

local function is_generic (item, value)
local str_lower = { -- use string.lower() for en.wiki (['en']) and use mw.ustring.lower() or local.wiki (['local'])
['en'] = string.lower,
['local'] = mw.ustring.lower,
}
local str_find = { -- use string.find() for en.wiki (['en']) and use mw.ustring.find() or local.wiki (['local'])
['en'] = string.find,
['local'] = mw.ustring.find,
}

local function test (val, test_t, wiki) -- local function to do the testing; <wiki> selects lower() and find() functions
val = test_t[2] and str_lower[wiki](value) or val; -- when <test_t[2]> set to 'true', plaintext search using lowercase value
return str_find[wiki] (val, test_t[1], 1, test_t[2]); -- return nil when not found or matched
end
if is_set (volume) then
local test_types_t = {'accept', 'reject'}; -- test accept patterns first, then reject patterns
if (6 < mw.ustring.len (volume)) then
local wikis_t = {'en', 'local'}; -- do tests for each of these keys; en.wiki first, local.wiki second
vol = wrap_msg ('j-vol', {sepc, volume}, lower);

else
for _, test_type in ipairs (test_types_t) do -- for each test type
vol = wrap_style ('vol-bold', hyphen_to_dash (volume));
for _, generic_value in pairs (cfg.special_case_translation[item][test_type]) do -- spin through the list of generic value fragments to accept or reject
for _, wiki in ipairs (wikis_t) do
if generic_value[wiki] then
if test (value, generic_value[wiki], wiki) then -- go do the test
return ('reject' == test_type); -- param value rejected, return true; false else
end
end
end
end
end
end
end
if is_set (issue) then
end
return vol .. wrap_msg ('j-issue', issue, lower);


--[[--------------------------< N A M E _ I S _ G E N E R I C >------------------------------------------------

calls is_generic() to determine if <name> is a 'generic name' listed in cfg.generic_names; <name_alias> is the
parameter name used in error messaging

]]

local function name_is_generic (name, name_alias)
if not added_generic_name_errs and is_generic ('generic_names', name) then
utilities.set_message ('err_generic_name', name_alias); -- set an error message
added_generic_name_errs = true;
end
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 >----------------------------------


Build insource_location meta-parameter from |page(s)= , |sheet(s)= , |at= and other relevant parameters.
--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------

This function calls various name checking functions used to validate the content of the various name-holding 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 function name_checks (last, first, list_name, last_alias, first_alias)
local accept_name;
local text = '';

if utilities.is_set (last) then
if is_set (sheet) then
if 'journal' == origin then
last, accept_name = utilities.has_accept_as_written (last); -- remove accept-this-as-written markup when it wraps all of <last>
text = wrap_msg ('j-sheet', sheet, lower);

else
if not accept_name then -- <last> not wrapped in accept-as-written markup
text = wrap_msg ('sheet', {sepc, sheet}, lower);
name_has_mult_names (last, list_name); -- check for multiple names in the parameter
end
name_is_numeric (last, last_alias, list_name); -- check for names that have no letters or are a mix of digits and other characters
elseif is_set (sheets) then
name_is_generic (last, last_alias); -- check for names found in the generic names list
if 'journal' == origin then
text = wrap_msg ('j-sheets', sheets, lower);
else
text = wrap_msg ('sheets', {sepc, sheets}, lower);
end
end
end
end


local is_journal = 'journal' == cite_class or (cite_class == 'map' and 'journal' == origin);
if utilities.is_set (first) then
if is_set (page) then
first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first>
if is_journal then

text = wrap_msg ('j-page(s)', page, lower);
if not accept_name then -- <first> not wrapped in accept-as-written markup
elseif not is_set (nopp) then
name_has_mult_names (first, list_name, 0); -- check for multiple names in the parameter; 0 is number of allowed commas in a given name
text = wrap_msg ('p-prefix', {sepc, page}, lower);
name_is_numeric (first, first_alias, list_name); -- check for names that have no letters or are a mix of digits and other characters
else
name_is_generic (first, first_alias); -- check for names found in the generic names list
text = wrap_msg ('nopp', {sepc, page}, lower);
end
end
elseif is_set (pages) then
local wl_type, D = utilities.is_wikilink (first);
if 0 ~= wl_type then
if is_journal then
text = wrap_msg ('j-page(s)', pages, lower);
first = D;
elseif tonumber (pages) ~= nil and not is_set (nopp) then -- if pages is only digits, assume a single page number
utilities.set_message ('err_bad_paramlink', first_alias);
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

return last, first; -- done
end


--[[----------------------< E X T R A C T _ N A M E S >-------------------------

Gets name list from the input arguments

Searches through args in sequential order to find |lastn= and |firstn= parameters
(or their aliases), and their matching link and mask parameters. Stops searching
when both |lastn= and |firstn= are not found in args after two sequential attempts:
found |last1=, |last2=, and |last3= but doesn't find |last4= and |last5= then the
search is done.

This function emits an error message when there is a |firstn= without a matching
|lastn=. When there are 'holes' in the list of last names, |last1= and |last3=
are present but |last2= is missing, an error message is emitted. |lastn= is not
required to have a matching |firstn=.

When an author or editor parameter contains some form of 'et al.', the 'et al.'
is stripped from the parameter and a flag (etal) returned that will cause list_people()
to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps
'et al.' out of the template's metadata. When this occurs, an error is emitted.

]]

local function extract_names(args, list_name)
local names = {}; -- table of names
local last; -- individual name components
local first;
local link;
local mask;
local i = 1; -- loop counter/indexer
local n = 1; -- output table indexer
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
local etal = false; -- return value set to true when we find some form of et al. in an author parameter

local last_alias, first_alias, link_alias; -- selected parameter aliases used in error messaging
while true do
last, last_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'err_redundant_parameters', i ); -- search through args for name components beginning at 1
first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i );
link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i );
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
if is_set (minutes) then
if last then -- error check |lastn= alias for unknown interwiki link prefix; done here because this is where we have the parameter name
text = pend_separator (wrap_msg ('minutes', minutes, lower), sepc, true) .. text;
local project, language = interwiki_prefixen_get (last, true); -- true because we expect interwiki links in |lastn= to be wikilinked
else
if nil == project and nil == language then -- when both are nil
if is_set (time) then
utilities.set_message ('err_bad_paramlink', last_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
if not is_set (time_caption) then
last = utilities.remove_wiki_link (last); -- remove wikilink markup; show display value only
text = pend_separator (wrap_msg ('event', time, lower), sepc, true) .. text;
end
end
else
text = pend_separator (time_caption .. ' ' .. time .. text, sepc, true);
if link then -- error check |linkn= alias for unknown interwiki link prefix
local project, language = interwiki_prefixen_get (link, false); -- false because wiki links in |author-linkn= is an error
if nil == project and nil == language then -- when both are nil
utilities.set_message ('err_bad_paramlink', link_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
link = nil; -- unset so we don't link
link_alias = nil;
end
end
last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al.
first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.
last, first = name_checks (last, first, list_name, last_alias, first_alias); -- multiple names, extraneous annotation, etc. checks

if first and not last then -- if there is a firstn without a matching lastn
local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias
utilities.set_message ('err_first_missing_last', {
first_alias, -- param name of alias missing its mate
first_alias:gsub (alias, {['first'] = 'last', ['given'] = 'surname'}), -- make param name appropriate to the alias form
}); -- add this error message
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
count = count + 1; -- number of times we haven't found last and first
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 -- we have last with or without a first
link = link_title_ok (link, link_alias, last, last_alias); -- check for improper wiki-markup

if first then
link = link_title_ok (link, link_alias, first, first_alias); -- check for improper wiki-markup
end

names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only)
n = n + 1; -- point to next location in the names table
if 1 == count then -- if the previous name was missing
utilities.set_message ('err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}); -- add this error message
end
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
end
i = i + 1; -- point to next args location
end
end
text = text .. pend_separator (at, sepc, true);
return names, etal; -- all done, return our list of names and the etal flag
text = text .. pend_separator (wrap_msg ('inset', inset, lower), sepc, true);
if is_set (sections) then
text = text .. pend_separator (wrap_msg ('sections', sections, lower), sepc, true);
elseif is_set (section) then
text = text .. pend_separator (wrap_msg ('section', section, lower), sepc, true);
end
return text;
end
end


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


]]
--[[--------------------------< N A M E _ T A G _ G E T >------------------------------------------------------


local function format_publisher (publisher_name, publication_place, periodical, cite_class, sepc)
attempt to decode |language=<lang_param> and return language name and matching tag; nil else.
local publisher = '';

This function looks for:
<lang_param> as a tag in cfg.lang_tag_remap{}
<lang_param> as a name in cfg.lang_name_remap{}
if is_set (publisher_name) then
<lang_param> as a name in cfg.mw_languages_by_name_t
if is_set (publication_place) then
<lang_param> as a tag in cfg.mw_languages_by_tag_t
publisher = publication_place .. ': ' .. publisher_name;
when those fail, presume that <lang_param> is an IETF-like tag that MediaWiki does not recognize. Strip all
else
script, region, variant, whatever subtags from <lang_param> to leave just a two or three character language tag
publisher = publisher_name;
and look for the new <lang_param> in cfg.mw_languages_by_tag_t{}

on success, returns name (in properly capitalized form) and matching tag (in lowercase); on failure returns nil

]]

local function name_tag_get (lang_param)
local lang_param_lc = mw.ustring.lower (lang_param); -- use lowercase as an index into the various tables
local name;
local tag;

name = cfg.lang_tag_remap[lang_param_lc]; -- assume <lang_param_lc> is a tag; attempt to get remapped language name
if name then -- when <name>, <lang_param> is a tag for a remapped language name
if cfg.lang_name_remap[name:lower()][2] ~= lang_param_lc then
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
return name, cfg.lang_name_remap[name:lower()][2]; -- so return name and tag from lang_name_remap[name]; special case to xlate sr-ec and sr-el to sr-cyrl and sr-latn
end
end
elseif is_set (publication_place) then
return name, lang_param_lc; -- so return <name> from remap and <lang_param_lc>
publisher = publication_place;
end
end

tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- still assuming that <lang_param_lc> is a tag; strip script, region, variant subtags
name = cfg.lang_tag_remap[tag]; -- attempt to get remapped language name with language subtag only
if name then -- when <name>, <tag> is a tag for a remapped language name
return name, tag; -- so return <name> from remap and <tag>
end

if cfg.lang_name_remap[lang_param_lc] then -- not a remapped tag, assume <lang_param_lc> is a name; attempt to get remapped language tag
return cfg.lang_name_remap[lang_param_lc][1], cfg.lang_name_remap[lang_param_lc][2]; -- for this <lang_param_lc>, return a (possibly) new name and appropriate tag
end

name = cfg.mw_languages_by_tag_t[lang_param_lc]; -- assume that <lang_param_lc> is a tag; attempt to get its matching language name
if name then
if is_set (publisher) then
if is_set (periodical) and
return name, lang_param_lc; -- <lang_param_lc> is a tag so return it and <name>
not in_array (cite_class, {'encyclopaedia', 'web', 'pressrelease', 'podcast'}) then
end
publisher = ' (' .. publisher .. ')';
else
tag = cfg.mw_languages_by_name_t[lang_param_lc]; -- assume that <lang_param_lc> is a language name; attempt to get its matching tag
publisher = pend_separator (publisher, sepc, true);
if tag then
return cfg.mw_languages_by_tag_t[tag], tag; -- <lang_param_lc> is a name so return the name from the table and <tag>
end

tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- is <lang_param_lc> an IETF-like tag that MediaWiki doesn't recognize? <tag> gets the language subtag; nil else

if tag then
name = cfg.mw_languages_by_tag_t[tag]; -- attempt to get a language name using the shortened <tag>
if name then
return name, tag; -- <lang_param_lc> is an unrecognized IETF-like tag so return <name> and language subtag
end
end
end
end
return publisher;
end
end


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


Format an external link that may or may not be raw.
--[[-------------------< L A N G U A G E _ P A R A M E T E R >------------------

Gets language name from a provided two- or three-character ISO 639 code. If a code
is recognized by MediaWiki, use the returned name; if not, then use the value that
was provided with the language parameter.

When |language= contains a recognized language (either code or name), the page is
assigned to the category for that code: Category:Norwegian-language sources (no).
For valid three-character code languages, the page is assigned to the single category
for '639-2' codes: Category:CS1 ISO 639-2 language sources.

Languages that are the same as the local wiki are not categorized. MediaWiki does
not recognize three-character equivalents of two-character codes: code 'ar' is
recognized but code 'ara' is not.

This function supports multiple languages in the form |language=nb, French, th
where the language names or codes are separated from each other by commas with
optional space characters.


]]
]]


local function language_parameter (lang)
local function format_external_link (text, url_object, sepc)
if is_set (text) then
local tag; -- some form of IETF-like language tag; language subtag with optional region, sript, vatiant, etc subtags
if is_set (url_object['url']) then
local lang_subtag; -- ve populates |language= with mostly unecessary region subtags that MediaWiki does not recognize; this is the base language subtag
text = make_external_link (url_object['url'], text, url_object['origin']);
local name; -- the language name
local language_list = {}; -- table of language names to be rendered

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

for _, lang in ipairs (names_t) do -- reuse lang here because we don't yet know if lang is a language name or a language tag; for now, ignore linter warning
name, tag = name_tag_get (lang); -- attempt to get name/tag pair for <lang>; <name> has proper capitalization; <tag> is lowercase

if utilities.is_set (tag) then
lang_subtag = tag:gsub ('^(%a%a%a?)%-.*', '%1'); -- for categorization, strip any IETF-like tags from language tag

if cfg.this_wiki_code ~= lang_subtag then -- when the language is not the same as this wiki's language
if 2 == lang_subtag:len() then -- and is a two-character tag
utilities.add_prop_cat ('foreign-lang-source', {name, tag}, lang_subtag); -- categorize it; tag appended to allow for multiple language categorization
else -- or is a recognized language (but has a three-character tag)
utilities.add_prop_cat ('foreign-lang-source-2', {lang_subtag}, lang_subtag); -- categorize it differently TODO: support multiple three-character tag categories per cs1|2 template?
end
elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
utilities.add_prop_cat ('local-lang-source', {name, lang_subtag}); -- categorize it
end
else
name = lang; -- return whatever <lang> has so that we show something
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
end
end
text = pend_separator (text .. url_object['format'], sepc, true);
elseif is_set (url_object['url']) then
table.insert (language_list, name);
text = make_external_link (url_object['url'], nil, url_object['origin']);
end
end
return text;
name = utilities.make_sep_list (#language_list, language_list);
if (1 == #language_list) and (lang_subtag == cfg.this_wiki_code) then -- when only one language, find lang name in this wiki lang name; for |language=en-us, 'English' in 'American English'
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
end
return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)'
--[[ TODO: should only return blank or name rather than full list
so we can clean up the bunched parenthetical elements Language, Type, Format
]]
end
end


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

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

Gets the default CS style configuration for the given mode.
Returns default separator and either postscript as passed in or the default.
In CS1, the default postscript and separator are '.'.
In CS2, the default postscript is the empty string and the default separator is ','.


]]
]]


local function set_cs_style (postscript, mode)
local function format_conference (conference, conference_url_object, periodical, cite_class, sepc)
local conf_text = format_external_link (conference, conference_url_object, sepc);
if utilities.is_set(postscript) then
if 'speech' == cite_class and is_set (periodical) then
-- emit a maintenance message if user postscript is the default cs1 postscript
-- if cite speech, periodical (perhaps because of an included |website= or |journal= parameter) is set;
-- we catch the opposite case for cs2 in set_style
conf_text = pend_separator (conf_text, sepc, false); -- then add appropriate punctuation to the end of the conference variable if set.
if mode == 'cs1' and postscript == cfg.presentation['ps_' .. mode] then
utilities.set_message ('maint_postscript');
end
else
postscript = cfg.presentation['ps_' .. mode];
end
end
return conf_text;
return cfg.presentation['sep_' .. mode], postscript;
end
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-
--[[--------------------------< S E T _ S T Y L E >-----------------------------
parameter (chapter_url_source used for error messages).

Sets the separator and postscript styles. Checks the |mode= first and the
#invoke CitationClass second. Removes the postscript if postscript == none.


]]
]]


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

if cfg.keywords_xlate[postscript:lower()] == 'none' then
-- emit a maintenance message if user postscript is the default cs2 postscript
-- we catch the opposite case for cs1 in set_cs_style
if 'cs2' == mode or ('cs1' ~= mode and 'citation' == cite_class) then -- {{citation |title=Title |mode=cs1 |postscript=none}} should not emit maint message
utilities.set_message ('maint_postscript');
end
end
postscript = '';
end
end
return sep, postscript
end


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


if is_set (transchapter) then
--[=[-------------------------< I S _ P D F >-----------------------------------
transchapter = wrap_style ('trans-quoted-title', transchapter);

if is_set (chapter) then
Determines if a URL has the file extension that is one of the PDF file extensions
chapter = chapter .. ' ' .. transchapter;
used by [[MediaWiki:Common.css]] when applying the PDF icon to external links.
else -- here when transchapter without chapter or script-chapter

chapter = transchapter;
returns true if file extension is one of the recognized extensions, else false
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});

]=]

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


--[[--------------------------< S T Y L E _ 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 style_format (format, url, fmt_param, url_param)
if utilities.is_set (format) then
format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize
if not utilities.is_set (url) then
utilities.set_message ('err_format_missing_url', {fmt_param, url_param}); -- add an error message
end
end
elseif is_pdf (url) then -- format is not set so if URL is a PDF file then
format = utilities.wrap_style ('format', 'PDF'); -- set format to PDF
else
format = ''; -- empty string for concatenation
end
end
if is_set (chapter_url_object['url']) then
return format;
chapter = make_external_link (chapter_url_object['url'], chapter, chapter_url_object['origin']) .. chapter_url_object['access-text'];
end
-- adds bare_url_missing_title error if appropriate

end

chapter = chapter .. chapter_error;
--[[---------------------< G E T _ D I S P L A Y _ N A M E S >------------------

if is_set (chapter) then
Returns a number that defines the number of names displayed for author and editor
if 'map' == cite_class and is_set (title_type) then
name lists and a Boolean flag to indicate when et al. should be appended to the name list.
chapter = chapter .. ' ' .. title_type;

When the value assigned to |display-xxxxors= is a number greater than or equal to zero,
return the number and the previous state of the 'etal' flag (false by default
but may have been set to true if the name list contains some variant of the text 'et al.').

When the value assigned to |display-xxxxors= is the keyword 'etal', return a number
that is one greater than the number of authors in the list and set the 'etal' flag true.
This will cause the list_people() to display all of the names in the name list followed by 'et al.'

In all other cases, returns nil and the previous state of the 'etal' flag.

inputs:
max: A['DisplayAuthors'] or A['DisplayEditors'], etc; a number or some flavor of etal
count: #a or #e
list_name: 'authors' or 'editors'
etal: author_etal or editor_etal

This function sets an error message when |display-xxxxors= value greater than or equal to number of names but
not when <max> comes from {{cs1 config}} global settings. When using global settings, <param> is set to the
keyword 'cs1 config' which is used to supress the normal error. Error is suppressed because it is to be expected
that some citations in an article will have the same or fewer names that the limit specified in {{cs1 config}}.

]]

local function get_display_names (max, count, etal, param)
if utilities.is_set (max) then
if 'etal' == cfg.keywords_xlate[max:lower():gsub("[ '%.]", '')] then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
max = count + 1; -- number of authors + 1 so display all author name plus et al.
etal = true; -- overrides value set by extract_names()
elseif max:match ('^%d+$') then -- if is a string of numbers
max = tonumber (max); -- make it a number
if (max >= count) and ('cs1 config' ~= param) then -- error when local |display-xxxxors= value greater than or equal to number of names; not an error when using global setting
utilities.set_message ('err_disp_name', {param, max}); -- add error message
max = nil;
end
else -- not a valid keyword or number
utilities.set_message ('err_disp_name', {param, max}); -- add error message
max = nil; -- unset; as if |display-xxxxors= had not been set
end
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 max, etal;
return chapter;
end
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-
--[[----------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >---------------
parameter (url_origin and title_link_origin used for error messages).

Adds error if |page=, |pages=, |quote-page=, |quote-pages= has what appears to be
some form of p. or pp. abbreviation in the first characters of the parameter content.

check page for extraneous p, p., pp, pp., pg, pg. at start of parameter value:
good pattern: '^P[^%.P%l]' matches when page begins PX or P# but not Px
where x and X are letters and # is a digit
bad pattern: '^[Pp][PpGg]' matches when page begins pp, pP, Pp, PP, pg, pG, Pg, PG


]]
]]


local function format_main_title (title, title_link, title_link_origin, script_title, trans_title, url_object, no_chapter_format, cite_class, periodical)
local function extra_text_in_page_check (val, name)
if is_set (title_link) and is_set (title) then
if not val:match (cfg.vol_iss_pg_patterns.good_ppattern) then
title = make_internal_link (title_link, title, title_link_origin);
for _, pattern in ipairs (cfg.vol_iss_pg_patterns.bad_ppatterns) do -- spin through the selected sequence table of patterns
if val:match (pattern) then -- when a match, error so
utilities.set_message ('err_extra_text_pages', name); -- add error message
return; -- and done
end
end
end
end


--[[--------------------------< E X T R A _ T E X T _ I N _ V O L _ I S S _ C H E C K >------------------------

Adds error if |volume= or |issue= has what appears to be some form of redundant 'type' indicator. Applies to
both; this function looks for issue text in both |issue= and |volume= and looks for volume-like text in |voluem=
and |issue=.

For |volume=:
'V.', or 'Vol.' (with or without the dot) abbreviations or 'Volume' in the first characters of the parameter
content (all case insensitive). 'V' and 'v' (without the dot) are presumed to be roman numerals so
are allowed.

For |issue=:
'No.', 'I.', 'Iss.' (with or without the dot) abbreviations, or 'Issue' in the first characters of the
parameter content (all case insensitive); numero styling: 'n°' with degree sign U+00B0, and № precomposed
numero sign U+2116.
Single character values ('v', 'i', 'n') allowed when not followed by separator character ('.', ':', '=', or
whitespace character) – param values are trimmed of whitespace by MediaWiki before delivered to the module.
<val> is |volume= or |issue= parameter value
<name> is |volume= or |issue= parameter name for error message
<selector> is 'v' for |volume=, 'i' for |issue=

sets error message on failure; returns nothing

]]

local function extra_text_in_vol_iss_check (val, name, selector)
if not utilities.is_set (val) then
return;
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
local handler = 'v' == selector and 'err_extra_text_volume' or 'err_extra_text_issue';
trans_title= wrap_style ('trans-quoted-title', trans_title );
local accept_val; -- for now, ignore linter warning
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
val, accept_val = utilities.has_accept_as_written (val);
trans_title= wrap_style ('trans-quoted-title', trans_title ); -- for cite report, use this form for trans-title
--if accept_val then -- if uncomment this, |volume=((vol. 1)) suppresses error
else
-- return;
title = wrap_style ('italic-title', title);
--end
title = script_concatenate (title, script_title); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
trans_title = wrap_style ('trans-italic-title', trans_title);
--val = mw.text.unstripNoWiki (val); -- if uncomment this, |volume=<nowiki>vol. 1</nowiki> shows error
val = val:lower(); -- force parameter value to lower case
for _, pattern in ipairs (cfg.vol_iss_pg_patterns.vi_patterns_t) do -- spin through the sequence table of patterns
if val:match (pattern) then -- when a match, error so
utilities.set_message (handler, name); -- add error message
return; -- and done
end
end
end
end


local trans_error = '';

if is_set (trans_title) then
--[=[-------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
if is_set (title) then

trans_title = ' ' .. trans_title;
split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled
else
parentheses to also have commas; in the old version of the code, the doubled parentheses were included in the
trans_error = ' ' .. set_error ('trans_missing_title', {'title'});
rendered citation and in the metadata. Individual author names may be wikilinked
end

|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.))

]=]

local function get_v_name_table (vparam, output_table, output_link_table)
local _, accept = utilities.has_accept_as_written (vparam);
if accept then
utilities.add_prop_cat ('vanc-accept'); -- add properties category
end
end
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas
local wl_type, label, link; -- wl_type not used here; just a placeholder
title = title .. trans_title;
local i = 1;
if is_set (title) then
while name_table[i] do
if not is_set (title_link) and is_set (url_object['url']) then
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parentheses
title = make_external_link (url_object['url'], title, url_object['origin']) .. url_object['access-text'] .. trans_error .. url_object['format'];
local name = name_table[i];
url_object = create_url_object ();
i = i + 1; -- bump indexer to next segment
while name_table[i] do
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parentheses
break; -- and done reassembling so
end
i = i + 1; -- bump indexer
end
table.insert (output_table, name); -- and add corporate name to the output table
table.insert (output_link_table, ''); -- no wikilink
else
else
title = title .. trans_error;
wl_type, label, link = utilities.is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
table.insert (output_table, label); -- add this name
if 1 == wl_type then
table.insert (output_link_table, label); -- simple wikilink [[D]]
else
table.insert (output_link_table, link); -- no wikilink or [[L|D]]; add this link if there is one, else empty string
end
end
end
end
i = i + 1;
return title, url_object;
end
return output_table;
end
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
--[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------
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
This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and
the appropriate styling.
|xxxxor-linkn= in args. It then returns a table of assembled names just as extract_names() does.

Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
tests, are wrapped in doubled parentheses ((corporate name)) to suppress the format tests.

Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.

This function sets the Vancouver error when a required comma is missing and when there is a space between an author's initials.


]]
]]


local function parse_vauthors_veditors (args, vparam, list_name)
local function format_format (args)
for _, url_object in pairs (args) do
local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn=
if is_set (url_object['format']) then
local v_name_table = {};
url_object['format'] = wrap_style ('format', url_object['format']); -- add leading space, parenthases, resize
local v_link_table = {}; -- when name is wikilinked, targets go in this table
if not is_set (url_object['url']) then
local etal = false; -- return value set to true when we find some form of et al. vauthors parameter
url_object['format'] = url_object['format'] .. set_error ('format_missing_url', {url_object['format-origin'], url_object['origin']});
local last, first, link, mask, suffix;
-- add an error message
local corporate = false;

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

for i, v_name in ipairs(v_name_table) do
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
local accept_name;
v_name, accept_name = utilities.has_accept_as_written (v_name); -- remove accept-this-as-written markup when it wraps all of <v_name>

if accept_name then
last = v_name;
corporate = true; -- flag used in list_people()
elseif string.find(v_name, "%s") then
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
add_vanc_error (cfg.err_msg_supl.punctuation, i);
end
end
elseif is_set (url_object['url']) then
local lastfirst_t = mw.text.split(v_name, "%s+");
if url_object['url']:match ('%.pdf[%?#]?') or url_object['url']:match ('%.PDF[%?#]?') then
first = table.remove (lastfirst_t); -- removes and returns value of last element in table which should be initials or generational suffix
-- format is not set so if url is a pdf file then

url_object['format'] = wrap_style ('format', 'PDF'); -- set format to pdf
if not mw.ustring.match (first, '^%u+$') then -- mw.ustring here so that later we will catch non-Latin characters
suffix = first; -- not initials so assume that whatever we got is a generational suffix
first = table.remove (lastfirst_t); -- get what should be the initials from the table
end
end
last = table.concat (lastfirst_t, ' '); -- returns a string that is the concatenation of all other names that are not initials and generational suffix
if not utilities.is_set (last) then
first = ''; -- unset
last = v_name; -- last empty because something wrong with first
add_vanc_error (cfg.err_msg_supl.name, i);
end
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
add_vanc_error (cfg.err_msg_supl['missing comma'], i); -- matches last II last; the case when a comma is missing
end
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test
add_vanc_error (cfg.err_msg_supl.initials, i); -- matches a space between two initials
end
else
last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?
end
end
if utilities.is_set (first) then
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
add_vanc_error (cfg.err_msg_supl.initials, i); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
end
is_good_vanc_name (last, first, suffix, i); -- check first and last before restoring the suffix which may have a non-Latin digit
if utilities.is_set (suffix) then
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
suffix = ''; -- unset so we don't add this suffix to all subsequent names
end
else
if not corporate then
is_good_vanc_name (last, '', nil, i);
end
end

link = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ) or v_link_table[i];
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate = corporate}; -- add this assembled name to our names list
end
end
return names, etal; -- all done, return our list of names
end
end


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

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

Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
select one of |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.

Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest;
|editorn= (and aliases) highest and |veditors= lowest (support for |editors= withdrawn)

When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
test which mimicks the test used in extract_names() when looking for a hole in the author name list. There may be a better
way to do this, I just haven't discovered what that way is.

Emits an error message when more than one xxxxor name source is provided.

In this function, vxxxxors = vauthors or veditors; xxxxors = authors as appropriate.


]]
]]


local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local function format_accessdate (accessdate, sepc, lower)
if is_set (accessdate) then -- first, wrap in nowrap span if date in appropriate format
local lastfirst = false;
if accessdate:match ('^%d%d%d%d%-%d%d%-%d%d$') then
if utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice in case we have a |first1= without a |last1=; this ...
accessdate = wrap_style ('nowrap1', accessdate); -- when accessdate is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
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
utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
local cap, cap2 = string.match (accessdate, '^(.*)%s+(%d%d%d%d)$');
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
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
lastfirst = true;
end
accessdate = ' ' .. wrap_msg ('retrieved', accessdate, lower); -- add retrieved text
accessdate = wrap_style ('accessdate', {sepc, accessdate}); -- allow editors to hide accessdates
end
end
return accessdate;

if (utilities.is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
(utilities.is_set (vxxxxors) and utilities.is_set (xxxxors)) or
(true == lastfirst and utilities.is_set (xxxxors)) then
utilities.set_message ('err_redundant_parameters',
utilities.substitute (cfg.special_case_translation.name_list_params,
('AuthorList' == list_name) and cfg.special_case_translation.author or cfg.special_case_translation.editor)); -- add error message


end

if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
if utilities.is_set (vxxxxors) then return 2 end;
if utilities.is_set (xxxxors) then return 3 end;
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
end
end


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

--[[--------------------------< I S _ V A L I 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 (yes, y, true, live, dead, etc.). When the parameter value has not been assigned a value (missing
or empty in the source template) the function returns the value specified by ret_val. If the parameter value is one
of the list of allowed values returns the translated value; else, emits an error message and returns the value
specified by ret_val.

TODO: explain <invert>

]]
]]


local function is_valid_parameter_value (value, name, possible, ret_val, invert)
local function format_id (id, docket, sepc, lower)
id = pend_separator (id, sepc, true);
if not utilities.is_set (value) then
return pend_separator (wrap_msg ('docket', docket, lower), sepc, true) .. id;
return ret_val; -- an empty parameter is ok
end

if (not invert and utilities.in_array (value, possible)) then -- normal; <value> is in <possible> table
return cfg.keywords_xlate[value]; -- return translation of parameter keyword
elseif invert and not utilities.in_array (value, possible) then -- invert; <value> is not in <possible> table
return value; -- return <value> as it is
else
utilities.set_message ('err_invalid_param_val', {name, value}); -- not an allowed value so add error message
return ret_val;
end
end
end


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

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

This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
when the last character is not a sepc character or when the last three characters are not sepc followed by two
closing square brackets (close of a wikilink). When either of these is true, the name_list is terminated with a
single space character.

]]
]]


local function terminate_name_list (name_list, sepc)
local function format_quote (quote, sepc)
if is_set (quote) then
if (string.sub (name_list, -3, -1) == sepc .. '. ') then -- if already properly terminated
if quote:sub (1, 1) == '"' and quote:sub (-1, -1) == '"' then -- if first and last characters of quote are quote marks
return name_list; -- just return the name list
quote = quote:sub (2, -2); -- strip them off
elseif (string.sub (name_list, -1, -1) == sepc) or (string.sub (name_list, -3, -1) == sepc .. ']]') then -- if last name in list ends with sepc char
end
return name_list .. " "; -- don't add another
return pend_separator (wrap_style ('quoted-text', quote), sepc, true); -- wrap in <q>...</q> tags
else
return name_list .. sepc .. ' '; -- otherwise terminate the name list
end
end
return '';
end
end


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

--[[-------------------------< 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 (or journal article number) 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, article, cite_class, origin, script_origin, sepc, lower)
if not utilities.is_set (volume) and not utilities.is_set (issue) and not utilities.is_set (article) then
return '';
end


local function format_archive (archive_url_object, original_url_object, archive_date, dead_url, sepc, lower)
-- same condition as in format_pages_sheets()
local archived = '';
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and ('journal' == origin or 'script-journal' == script_origin));
if is_set (archive_url_object['url']) then

if not is_set (archive_date) then
local is_numeric_vol = volume and (volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')); -- is only uppercase roman numerals or only digits?
archive_date = set_error ('archive_missing_date');
local is_long_vol = volume and (4 < mw.ustring.len(volume)); -- is |volume= value longer than 4 characters?
if volume and (not is_numeric_vol and is_long_vol) then -- when not all digits or Roman numerals, is |volume= longer than 4 characters?
utilities.add_prop_cat ('long-vol'); -- yes, add properties cat
end

if is_journal then -- journal-style formatting
local vol = '';

if utilities.is_set (volume) then
if is_numeric_vol then -- |volume= value all digits or all uppercase Roman numerals?
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, volume}); -- render in bold face
elseif is_long_vol then -- not all digits or Roman numerals; longer than 4 characters?
vol = utilities.substitute (cfg.messages['j-vol'], {sepc, utilities.hyphen_to_dash (volume)}); -- not bold
else -- four or fewer characters
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, utilities.hyphen_to_dash (volume)}); -- bold
end
end
end
if in_array (dead_url, cfg.keywords['deadurl-live']) then
vol = vol .. (utilities.is_set (issue) and utilities.substitute (cfg.messages['j-issue'], issue) or '')
local arch_text = cfg.messages['archived'];
vol = vol .. (utilities.is_set (article) and utilities.substitute (cfg.messages['j-article-num'], article) or '')
if (lower) then arch_text = arch_text:lower(); end;
return vol;
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);
end
if not is_set (original_url_object['url']) then
archived = archived .. ' ' .. set_error ('archive_missing_url');
if 'podcast' == cite_class and utilities.is_set (issue) then
return wrap_msg ('issue', {sepc, issue}, lower);
end
if 'conference' == cite_class and utilities.is_set (article) then -- |article-number= supported only in journal and conference cites
if utilities.is_set (volume) and utilities.is_set (article) then -- both volume and article number
return wrap_msg ('vol-art', {sepc, utilities.hyphen_to_dash (volume), article}, lower);
elseif utilities.is_set (article) then -- article number alone; when volume alone, handled below
return wrap_msg ('art', {sepc, article}, lower);
end
end

-- all other types of citation
if utilities.is_set (volume) and utilities.is_set (issue) then
return wrap_msg ('vol-no', {sepc, utilities.hyphen_to_dash (volume), issue}, lower);
elseif utilities.is_set (volume) then
return wrap_msg ('vol', {sepc, utilities.hyphen_to_dash (volume)}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end


--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------

adds static text to one of |page(s)= or |sheet(s)= values and returns it with all of the others set to empty strings.
The return order is:
page, pages, sheet, sheets

Singular has priority over plural when both are provided.

]]

local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, script_origin, sepc, nopp, lower)
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
if utilities.is_set (sheet) then
if 'journal' == origin or 'script-journal' == script_origin then
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
else
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
end
end
elseif is_set (original_url_object['url']) then -- dead_url is not live, so it should be empty, dead or unfit
elseif utilities.is_set (sheets) then
if in_array (dead_url, cfg.keywords['deadurl-unfit']) then
if 'journal' == origin or 'script-journal' == script_origin then
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
archived = pend_separator (wrap_msg('archived-unfit', archive_date, lower), sepc, true);
-- format already styled
else
else -- dead_url is empty or dead
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
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
end
end
end

local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and ('journal' == origin or 'script-journal' == script_origin));
if utilities.is_set (page) then
if is_journal then
return utilities.substitute (cfg.messages['j-page(s)'], page), '', '', '';
elseif not nopp then
return utilities.substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
else
return utilities.substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
end
elseif utilities.is_set (pages) then
if is_journal then
return utilities.substitute (cfg.messages['j-page(s)'], pages), '', '', '';
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
return '', utilities.substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif not nopp then
return '', utilities.substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
else
else
archived = pend_separator (wrap_msg ('archived-missing',
return '', utilities.substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
{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 archived;
return '', '', '', ''; -- return empty strings
end
end


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

--[[--------------------------< I N S O U R C E _ L O C _ G E T >----------------------------------------------

returns one of the in-source locators: page, pages, or at.

If any of these are interwiki links to Wikisource, returns the label portion of the interwiki-link as plain text
for use in COinS. This COinS thing is done because here we convert an interwiki-link to an external link and
add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it?

TODO: add support for sheet and sheets?; streamline;

TODO: make it so that this function returns only one of the three as the single in-source (the return value assigned
to a new name)?


]]
]]


local function insource_loc_get (page, page_orig, pages, pages_orig, at)
local function format_lay (lay_url_object, lay_date, lay_source, sepc, lower)
local lay = '';
local ws_url, ws_label, coins_pages, L; -- for Wikisource interwiki-links; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
if is_set (lay_url_object['url']) then

if utilities.is_set (page) then
if is_set (lay_date) then lay_date = ' (' .. lay_date .. ')' end
if utilities.is_set (pages) or utilities.is_set (at) then
if is_set (lay_source) then
lay_source = wrap_msg ('lay source', lay_source, lower);
pages = ''; -- unset the others
else
at = '';
lay_source = '';
end
end
local lay_sum = cfg.messages['lay summary'];
extra_text_in_page_check (page, page_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
if lower then

lay_sum = lay_sum:lower();
ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label
if ws_url then
page = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
page = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
coins_pages = ws_label;
end
elseif utilities.is_set (pages) then
if utilities.is_set (at) then
at = ''; -- unset
end
extra_text_in_page_check (pages, pages_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.

ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label
if ws_url then
pages = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
pages = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
coins_pages = ws_label;
end
elseif utilities.is_set (at) then
ws_url, ws_label, L = wikisource_url_make (at); -- make ws URL from |at= interwiki link; link portion L becomes tooltip label
if ws_url then
at = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
at = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
coins_pages = ws_label;
end
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 lay;
return page, pages, at, coins_pages;
end
end


--[[--------------------------< I S _ U N I Q U E _ A R C H I V E _ U R L >------------------------------------
--[[--------------------------< F O R M A T _ P E R I O D I C A L >------------------------------------

add error message when |archive-url= value is same as |url= or chapter-url= (or alias...) value

]]
]]


local function is_unique_archive_url (archive, url, c_url, source, date)
local function format_periodical (periodical, title, title_note, sepc)
if utilities.is_set (archive) then
if is_set (periodical) then
if archive == url or archive == c_url then
if is_set (title) or is_set (title_note) then
return pend_separator (wrap_style ('italic-title', periodical), sepc, true);
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)}); -- add error message
else
return '', ''; -- unset |archive-url= and |archive-date= because same as |url= or |chapter-url=
return wrap_style ('italic-title', periodical);
end
end
end
end
return '';

return archive, date;
end
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.
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------


namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year.
Check archive.org URLs to make sure they at least look like they are pointing at valid archives and not to the
save snapshot URL or to calendar pages. When the archive URL is 'https://web.archive.org/save/' (or http://...)
archive.org saves a snapshot of the target page in the URL. That is something that Wikipedia should not allow
unwitting readers to do.


]]
When the archive.org URL does not have a complete timestamp, archive.org chooses a snapshot according to its own
algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results.


local function anchor_id (namelist, year)
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
local names={}; -- a table for the one to four names and year
|archive-date= and an error message when:
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
|archive-url= holds an archive.org save command URL
names[i] = v.last
|archive-url= is an archive.org URL that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
if i == 4 then break end -- if four then done
correct place
otherwise returns |archive-url= and |archive-date=

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

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

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

A secondary function is to return an archive-url timestamp from those archive urls that have them. The timestamp
is used by validation.archive_date_check() to see if the value in |archive-date= matches the timestamp in the
archive url.

]=]

local function archive_url_check (url, date)
local err_msg; -- start with the error message empty
local path, timestamp, flag; -- portions of the archive.org URL
local function is_ts_date_valid (ts, origin_date) -- local function to validate archive url taimestamp date; time ignored
local y, m, d = ts:match ('(%d%d%d%d)(%d%d)(%d%d)'); -- split into parts
if y and validation.is_valid_date (y, m, d) and (tonumber (y) >= 1996) then
return true, tonumber (y) >= origin_date; -- <origin_date> is 1996 for archive.org
end
end
end
table.insert (names, year); -- add the year at the end

local id = table.concat (names); -- concatenate names and year for CITEREF id
if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine URL
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
if is_set (id) then -- if concatenation is not an empty string
return 'CITEREF' .. id; -- add the CITEREF portion
end

if url:match('//web%.archive%.org/save/') then -- if a save command URL, we don't want to allow saving of the target page
err_msg = cfg.err_msg_supl.save;
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
elseif url:match('//liveweb%.archive%.org/') then
err_msg = cfg.err_msg_supl.liveweb;
else
else
return ''; -- return an empty string; no reason to include CITEREF id in this citation
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation
if not path then -- malformed in some way; pattern did not match
err_msg = cfg.err_msg_supl.timestamp;
elseif 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = cfg.err_msg_supl.timestamp;
if '*' ~= flag then
local replacement = timestamp:match ('^%d%d%d%d%d%d') or timestamp:match ('^%d%d%d%d'); -- get the first 6 (YYYYMM) or first 4 digits (YYYY)
if replacement then -- nil if there aren't at least 4 digits (year)
replacement = replacement .. string.rep ('0', 14 - replacement:len()); -- year or yearmo (4 or 6 digits) zero-fill to make 14-digit timestamp
url=url:gsub ('(//web%.archive%.org/[^%d]*)%d[^/]*', '%1' .. replacement .. '*', 1) -- for preview, modify ts to 14 digits plus splat for calendar display
end
end
elseif not is_ts_date_valid (timestamp, 1996) then -- is ymd portion of timestamp a valid date?
err_msg = cfg.err_msg_supl.timestamp;
timestamp = nil; -- unset because invalid
elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element
err_msg = cfg.err_msg_supl.path;
elseif utilities.is_set (flag) and not utilities.is_set (path) then -- flag not allowed with the old form URL (without the 'web/' path element)
err_msg = cfg.err_msg_supl.flag;
elseif utilities.is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
err_msg = cfg.err_msg_supl.flag;
else
return url, date, timestamp; -- return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
end
end
-- if here, something not right so
utilities.set_message ('err_archive_url', {err_msg}); -- add error message and

if is_preview_mode then
return url, date, timestamp; -- preview mode so return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
else
return '', ''; -- return empty strings for ArchiveURL and ArchiveDate
end
end
end
end


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

--[[--------------------------< P L A C E _ C H E C K >--------------------------------------------------------

check |place=, |publication-place=, |location= to see if these params include digits. This function added because
many editors misuse location to specify the in-source location (|page(s)= and |at= are supposed to do that)

returns the original parameter value without modification; added maint cat when parameter value contains digits


]]
]]


local function format_citation (body, cite_class, ref, namelist, year, ocins_output, no_tracking_cats)
local function place_check (param_val)
local options = {};
if not utilities.is_set (param_val) then -- parameter empty or omitted
return param_val; -- return that empty state
end
if is_set (cite_class) and cite_class ~= 'citation' then
if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
options.class = 'citation ' .. cite_class; -- class=citation required for blue highlight when used with |ref=
utilities.set_message ('maint_location'); -- yep, add maint cat
else
options.class = 'citation';
end
end
if is_set (ref) and ref:lower() ~= 'none' then -- set reference anchor if appropriate
return param_val; -- and done
local id = ref
end
if ('harv' == ref ) then

id = anchor_id (namelist, year); -- go make the CITEREF anchor

--[[--------------------------< I S _ A R C H I V E D _ C O P Y >----------------------------------------------

compares |title= to 'Archived copy' (placeholder added by bots that can't find proper title); if matches, return true; nil else

]]

local function is_archived_copy (title)
title = mw.ustring.lower(title); -- switch title to lower case
if title:find (cfg.special_case_translation.archived_copy.en) then -- if title is 'Archived copy'
return true;
elseif cfg.special_case_translation.archived_copy['local'] then
if mw.ustring.find (title, cfg.special_case_translation.archived_copy['local']) then -- mw.ustring() because might not be Latin script
return true;
end
end
options.id = id;
end
end
end
if string.len (body:gsub ('<span[^>/]*>.-</span>', ''):gsub ('%b<>','')) <= 2 then

reset_error ({'err_cats'});

body = set_error ('empty_citation');
--[[--------------------------< D I S P L A Y _ N A M E S _ S E L E C T >--------------------------------------
reset_error ({'msg_tail'});

for any of the |display-authors=, |display-editors=, etc parameters, select either the local or global setting.
When both are present, look at <local_display_names> value. When the value is some sort of 'et al.'string,
special handling is required.

When {{cs1 config}} has |display-<namelist>= AND this template has |display-<namelist>=etal AND:
the number of names specified by <number_of_names> is:
greater than the number specified in the global |display-<namelist>= parameter (<global_display_names>)
use global |display-<namelist>= parameter value
set overridden maint category
less than or equal to the number specified in the global |display-<namelist>= parameter
use local |display-<namelist>= parameter value

The purpose of this function is to prevent categorizing a template that has fewer names than the global setting
to keep the etal annotation specified by <local_display_names>.

]]

local function display_names_select (global_display_names, local_display_names, param_name, number_of_names)
if global_display_names and utilities.is_set (local_display_names) then -- when both
if 'etal' == local_display_names:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
number_of_names = tonumber (number_of_names); -- convert these to numbers for comparison
local global_display_names_num = tonumber (global_display_names); -- <global_display_names> not set when parameter value is not digits

if number_of_names > global_display_names_num then -- template has more names than global config allows to be displayed?
utilities.set_message ('maint_overridden_setting'); -- set a maint message because global is overriding local |display-<namelist>=etal
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
else
return local_display_names, param_name; -- return local because fewer names so let <local_display_names> control
end
end
-- here when <global_display_names> and <local_display_names> both numbers; <global_display_names> controls
utilities.set_message ('maint_overridden_setting'); -- set a maint message
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
end
end
-- here when only one of <global_display_names> or <local_display_names> set
local text;
if global_display_names then
return global_display_names, 'cs1 config'; -- return global with spoof parameter name (for get_display_names())
if is_set (options.id) then
text = wrap_style ('citation-with-id', {mw.uri.anchorEncode (options.id), mw.text.nowiki (options.class), body});
else
else
text = wrap_style ('citation-no-id', {mw.text.nowiki (options.class), body});
return local_display_names, param_name; -- return local
end
end
text = text .. wrap_style ('OCinS', ocins_output);
text = text .. make_error_tail (no_tracking_cats); -- append error/maintenance messages/categories to the citation
return text;
end
end


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


如果citation_class为citation({{citation}}),根据periodical系列参数的设置情况推断实际的引用类型。
--[[--------------------------< M O D E _ S E T >--------------------------------------------------------------

fetch global mode setting from {{cs1 config}} (if present) or from |mode= (if present); global setting overrides
local |mode= parameter value. When both are present, emit maintenance message


]]
]]


local function mode_set (Mode, Mode_origin)
local function deduce_citation_class (A, naive_class)
local mode;
local deduced_class;
local periodical = A['Periodical'];
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}}; nil when empty or assigned value invalid
local origin = A:ORIGIN ('Periodical');
mode = is_valid_parameter_value (cfg.global_cs1_config_t['Mode'], 'cs1 config: mode', cfg.keywords_lists['mode'], ''); -- error messaging 'param' here is a hoax
else
mode = is_valid_parameter_value (Mode, Mode_origin, cfg.keywords_lists['mode'], '');
end

if cfg.global_cs1_config_t['Mode'] and utilities.is_set (Mode) then -- when template has |mode=<something> which global setting has overridden
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end
return mode;
end


--[[--------------------------< Q U O T E _ M A K E >----------------------------------------------------------

create quotation from |quote=, |trans-quote=, and/or script-quote= with or without |quote-page= or |quote-pages=

when any of those three quote parameters are set, this function unsets <PostScript>. When none of those parameters
are set, |quote-page= and |quote-pages= are unset to nil so that they are not included in the template's metadata

]]

local function quote_make (quote, trans_quote, script_quote, quote_page, quote_pages, nopp, sepc, postscript)
if utilities.is_set (quote) or utilities.is_set (trans_quote) or utilities.is_set (script_quote) then

if utilities.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
end
quote = kern_quotes (quote); -- kern if needed
quote = utilities.wrap_style ('quoted-text', quote ); -- wrap in <q>...</q> tags
for cite_class, aliases in pairs (cfg.periodical.parameters) do
if utilities.is_set (script_quote) then
if cite_class ~= '_general' then
quote = script_concatenate (quote, script_quote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
for _, aliase in pairs (aliases) do
end
if origin == aliase then

deduced_class = cite_class;
if utilities.is_set (trans_quote) then
if trans_quote:sub(1, 1) == '"' and trans_quote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
trans_quote = trans_quote:sub(2, -2); -- strip them off
end
quote = quote .. " " .. utilities.wrap_style ('trans-quoted-title', trans_quote );
end

if utilities.is_set (quote_page) or utilities.is_set (quote_pages) then -- add page prefix
local quote_prefix = '';
if utilities.is_set (quote_page) then
extra_text_in_page_check (quote_page, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
if not nopp then
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_page});
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_page});
end
elseif utilities.is_set (quote_pages) then
extra_text_in_page_check (quote_pages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
if tonumber(quote_pages) ~= nil and not nopp then -- if only digits, assume single page
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_pages});
elseif not nopp then
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, quote_pages});
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_pages});
end
end
end
end
quote = quote_prefix .. ": " .. quote;
else
quote = sepc .. " " .. quote;
end
end

postscript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
elseif utilities.is_set (quote_page) or utilities.is_set (quote_pages) then
quote_page = nil; -- unset; these require |quote=; TODO: error message?
quote_pages = nil;
end
end

return quote, quote_page, quote_pages, postscript;
end


--[[--------------------------< C H E C K _ P U B L I S H E R _ N A M E >--------------------------------------

look for variations of '<text>: <text>' that might be '<location>: <publisher>' in |publisher= parameter value.
when found, emit a maintenance message; return nil else

<publisher> is the value assigned to |publisher= or |institution=

]]

local function check_publisher_name (publisher)
local patterns_t = {
'^[%w%s]+%s*:%s*[%w%s]+$', -- plain text <location>: <publisher>
'^%[+[%w%s:|]+%]+%s*:%s*[%w%s]+$', -- partially wikilinked [[<location>]]: <publisher>
'^[%w%s]+%s*:%s*%[+[%w%s:|]+%]+$', -- partially wikilinked <location>: [[<publisher>]]
'^%[+[%w%s:|]+%]+%s*:%s*%[+[%w%s:|]+%]+$', -- wikilinked [[<location>]]: [[<publisher>]]
}
if (naive_class == 'citation') then
for _, pattern in ipairs (patterns_t) do -- spin through the patterns_t sequence
if is_set (deduced_class) then
if mw.ustring.match (publisher, pattern) then -- does this pattern match?
return deduced_class, true;
utilities.set_message ('maint_publisher_location'); -- set a maint message
end
return; -- and done
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
end
end
return naive_class, false;
end
end




--[[--------------------------< I S _ P A G E _ A R T _ N U M >------------------------------------------------
--[[--------------------------< 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
compare the trailing (rightmost) characters of the |doi= value against the whole value assigned to |page(s)=.
multiple names can be transparently aliased to single internal variable.

return boolean true when:
|page(s)= has exactly 8 digits and a dot between the fourth and fifth digits matches the trailing 9 characters
of the |doi= value: |page=12345678 → |page=1234.5678 matches |doi=10.xxxx/yyyy1234.5678
|page(s)= is 5 or more characters and matches |doi= values's trailing characters
|page(s)= begins with a lowercase 'e' and |page(s)= without the 'e' matches |doi= values's trailing
characters: |page=e12345 → |page=12345 matches |doi=10.xxxx/yyyy12345
|page(s)= begins with a uppercase 'CD' followed by (typically) six digits matches |doi= values that ends with
'CDxxxxxx.pubx' (where 'x' is any single digit)

return nil when |page(s)= values:
are ranges separated by underscore, hyphen, emdash, endash, figure dash, or minus character
are comma- or semicolon-separated lists of pages
have external urls (has text 'http')
are digit-only values less than 10000
do not match |doi= values's trailing characters


]]
]]


local function is_page_art_num (page, doi)
local function argument_wrapper (args)
local origin = {};
if not (utilities.is_set (page) and utilities.is_set (doi)) then -- both required
return; -- abandon; nothing to do
end

if page:match ('[,;_−–—‒%-]') then -- when |page(s)= might be a page range or a separated list of pages
return; -- abandon
end

page = page:lower(); -- because doi names are case insensitive
doi = doi:lower(); -- force these to lowercase for testing
return setmetatable ({
if page:match ('http') then -- when |page(s)= appears to hold a url
ORIGIN = function (self, k)
return; -- abandon
local dummy = self[k]; --force the variable to be loaded.
end
return origin[k];

if tonumber (page) then -- is |page(s)= digits only
if 10000 > tonumber (page) then -- when |page(s)= less than 10000
return; -- abandon
end
end
},
{
if doi:match (page .. '$') then -- digits only page number match the last digits in |doi=?
__index = function (tbl, k)
return true;
if origin[k] ~= nil then
end
return nil;

if 8 == page:len() then -- special case when |page(s)= is exactly 8 digits
local dot_page = page:gsub ('(%d%d%d%d)(%d%d%d%d)', '%1.%2'); -- make a |page=xxxx.yyyy version commonly used in |doi=
if doi:match (dot_page .. '$') then -- 8-digit dotted page number match the last characters in |doi=?
return true;
end
end
end
local args, list, v = args, cfg.aliases[k];
else -- here when |page(s)= is alpha-numeric
if type (list) == 'table' then
if 4 < page:len() then -- when |page(s)= is five or more characters
v, origin[k] = select_one (args, list, 'redundant_parameters');
if doi:match (page .. '$') then -- alpha-numeric page match the last characters in |doi=?
if origin[k] == nil then
return true;
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
-- Empty strings, not nil;
local epage = page:match ('^e([%w]+)$'); -- if first character of |page= is 'e', remove it
if v == nil then
if epage and doi:match (epage .. '$') then -- page number match the last characters in |doi=?
v = cfg.defaults[k] or '';
return true;
origin[k] = '';
end
end
tbl = rawset (tbl, k, v);
local cdpage = page:match ('^cd%d+$'); -- if first characters of |page= are 'CD' and last characters are digits (typically 6 digits)
return v;
if cdpage and doi:match (cdpage .. '%.pub%d$') then -- page number matches doi 'CDxxxxxx.pubx' where 'x' is a digit
end,
return true;
});
end
end
end
end
end


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

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


This is the main function doing the majority of the citation formatting.
This is the main function doing the majority of the citation formatting.
第2,878行: 第967行:
]]
]]


local function citation0( config, args )
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 aliases to single internal variable.
The argument_wrapper facilitates the mapping of multiple 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);


-- 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.
------------------------------------------------- Get dates

local author_etal;
local Year = A['Year'];
local PublicationDate = A['PublicationDate'];
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local Authors;
local OrigYear = A['OrigYear'];
local NameListStyle;
local Date = A['Date'];
local Dateorigin = A:ORIGIN ('Date');
if cfg.global_cs1_config_t['NameListStyle'] then -- global setting in {{cs1 config}} overrides local |name-list-style= parameter value; nil when empty or assigned value invalid
local LayDate = A['LayDate'];
NameListStyle = is_valid_parameter_value (cfg.global_cs1_config_t['NameListStyle'], 'cs1 config: name-list-style', cfg.keywords_lists['name-list-style'], ''); -- error messaging 'param' here is a hoax
------------------------------------------------- Get title data
else
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
end

if cfg.global_cs1_config_t['NameListStyle'] and utilities.is_set (A['NameListStyle']) then -- when template has |name-list-style=<something> which global setting has overridden
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end

local Collaboration = A['Collaboration'];

do -- to limit scope of selected
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
if 1 == selected then
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
elseif 2 == selected then
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
a, author_etal = parse_vauthors_veditors (args, A['Vauthors'], 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
elseif 3 == selected then
Authors = A['Authors']; -- use content of |people= or |credits=; |authors= is deprecated; TODO: constrain |people= and |credits= to cite av media, episode, serial?
end
if utilities.is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end

local editor_etal;
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=

do -- to limit scope of selected
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
if 1 == selected then
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
elseif 2 == selected then
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
end
end
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= and |script-chapter= aliases
local Chapter_origin = A:ORIGIN ('Chapter');
local ScriptChapter = A['ScriptChapter'];
local ScriptChapter_origin = A:ORIGIN ('ScriptChapter');

local Contribution; -- because contribution is required for contributor(s)
if 'contribution' == Chapter_origin then -- is there a |contribution= parameter?
Contribution = Chapter; -- get the name of the contribution
elseif 'script-contribution' == ScriptChapter_origin then -- no, so is there a |script-contribution= parameter?
Contribution = ScriptChapter; -- get the name of the contribution
end
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not (utilities.is_set (A['Periodical']) or utilities.is_set (A['ScriptPeriodical'])) then -- |contributor= and |contribution= only supported in book cites
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
if 0 < #c then
if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=
utilities.set_message ('err_contributor_missing_required_param', 'contribution'); -- add missing contribution error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
if 0 == #a then -- |contributor= requires |author=
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
else -- if not a book cite
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
end
Contribution = nil; -- unset
end

local Title = A['Title'];
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 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 auto_select = ''; -- default is auto
local accept_link;
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
auto_select = TitleLink; -- remember selection for later
TitleLink = ''; -- treat as if |title-link= would have been empty
end

TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set

local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
if 'map' == config.CitationClass and 'section' == Chapter_origin then
Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}}
Chapter = ''; -- unset for now; will be reset later from |map= if present
end

local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN('Periodical');
local ScriptPeriodical = A['ScriptPeriodical'];
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
local TransPeriodical = A['TransPeriodical'];
local TransPeriodical_origin = A:ORIGIN ('TransPeriodical');
local ConferenceURLobject = create_url_object (A['ConferenceURL'], A:ORIGIN ('ConferenceURL'), A['ConferenceFormat'], A:ORIGIN ('ConferenceFormat'));
local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
local ArchiveURLobject = create_url_object (A['ArchiveURL'], A:ORIGIN ('ArchiveURL'), A['ArchiveFormat'], A:ORIGIN ('ArchiveFormat'));
local ScriptEncyclopedia = A['ScriptEncyclopedia'];
local URLobject = create_url_object (A['URL'], A:ORIGIN ('URL'), A['Format'], A:ORIGIN ('Format'),A['UrlAccess'], A:ORIGIN ('UrlAccess'));
local TransEncyclopedia = A['TransEncyclopedia'];
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'];
if (utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or ('citation' == config.CitationClass and (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))))
local Issue = A['Issue'];
and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then
local param;
local Page = A['Page'];
local Pages = hyphen_to_dash (A['Pages']);
if utilities.is_set (Periodical) then -- get a parameter name from one of these periodical related meta-parameters
local At = A['At'];
Periodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = Periodical_origin -- get parameter name for error messaging
elseif utilities.is_set (TransPeriodical) then
TransPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = TransPeriodical_origin; -- get parameter name for error messaging
elseif utilities.is_set (ScriptPeriodical) then
ScriptPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = ScriptPeriodical_origin; -- get parameter name for error messaging
end


if not in_array (citation_class, cfg.args_support['templates_using_volume']) then
if utilities.is_set (param) then -- if we found one
Volume = discard_parameter (Volume, A:ORIGIN ('Volume'), nil);
utilities.set_message ('err_periodical_ignored', {param}); -- emit an error message
end
end
end
if not in_array (citation_class, cfg.args_support['templates_using_issue']) then

if utilities.is_set (Periodical) then
if (A:ORIGIN ('Issue') ~= 'number') then
Issue = discard_parameter (Issue, A:ORIGIN ('Issue'), nil);
local i;
else
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
Issue = nil;
if i then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
end
end
end
end
if in_array (citation_class, cfg.args_support['templates_not_using_page']) then

Page = discard_parameter (Page, A:ORIGIN ('Page'), nil);
if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
Pages = discard_parameter (Pages, A:ORIGIN ('Pages'), nil);
if utilities.is_set (A ['MailingList']) then
At = discard_parameter (At, A:ORIGIN ('At'), nil);
if utilities.is_set (Periodical) then -- both set emit an error TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')});
end
Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
Periodical_origin = A:ORIGIN('MailingList');
end
end
end

local Minutes = A['Minutes'];
-- web and news not tested for now because of
local Time = A['Time'];
-- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
local TimeCaption = A['TimeCaption'];
if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
-- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
if not in_array (citation_class, cfg.args_support['templates_involving_time']) then
local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
Minutes = discard_parameter (Minutes, A:ORIGIN ('Minutes'), nil);
if p[config.CitationClass] then
Time = discard_parameter (Time, A:ORIGIN ('Time'), nil);
utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]});
TimeCaption = discard_parameter (TimeCaption, A:ORIGIN ('TimeCaption'), nil);
end
end
end
local Volume;
local Sheet = A['Sheet'];
local Sheets = A['Sheets'];
if 'citation' == config.CitationClass then
local Section = A['Section'];
if utilities.is_set (Periodical) then
local Sections = A['Sections'];
if not utilities.in_array (Periodical_origin, cfg.citation_no_volume_t) then -- {{citation}} does not render |volume= when these parameters are used
local Inset = A['Inset'];
Volume = A['Volume']; -- but does for all other 'periodicals'
end
if not ('map' == citation_class) then
elseif utilities.is_set (ScriptPeriodical) then
Sheet = discard_parameter (Sheet, A:ORIGIN ('Sheet'), nil);
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
Sheets = discard_parameter (Sheets, A:ORIGIN ('Sheets'), nil);
Volume = A['Volume']; -- but does for all other 'periodicals'
Sections = discard_parameter (Sections, A:ORIGIN ('Sections'), nil);
end
Inset = discard_parameter (Inset, A:ORIGIN ('Inset'), nil);
else
Volume = A['Volume']; -- and does for non-'periodical' cites
end
elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
Volume = A['Volume'];
end
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');

local Issue;
if 'citation' == config.CitationClass then
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, cfg.citation_issue_t) then -- {{citation}} may render |issue= when these parameters are used
Issue = A['Issue'];
elseif utilities.is_set (ScriptPeriodical) and utilities.in_array (ScriptPeriodical_origin, cfg.citation_issue_t) then
Issue = A['Issue'];
end
elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
Issue = A['Issue'];
end
end
end
--[[
local ArticleNumber;
不知道哪个“天才”想出来的点子,现行引用模板里,section一个参数多个涵义。
在书籍类引用中,section是章节名称,在地图引用中,section是地图的区域编号。
所以一旦知道citation_class不是地图,就可以丢弃上述几乎全部参数,
唯独section参数需要留到检查章节相关参数时一并进行检查。
]]


local Chapter = '';
if utilities.in_array (config.CitationClass, {'journal', 'conference'})
local ScriptChapter = '';
or ('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin)) then
local TransChapter = '';
ArticleNumber = A['ArticleNumber'];
local ChapterURLobject;
else
local no_chapter_format = in_array (citation_class, cfg.args_support['templates_not_using_chapter_format']);
local param_orig = A:ORIGIN ('ArticleNumber');
if utilities.is_set (param_orig) then -- when |article-number= set
if in_array (citation_class, cfg.args_support['templates_not_using_chapter']) then
utilities.set_message ('err_parameter_ignored', {param_orig}); -- emit an ignored parameter error message
ChapterURLobject = create_url_object ();
discard_chapter (A);
if not ('map' == citation_class) then
Section = discard_parameter (Section, A:ORIGIN ('Section'), nil);
end
end
end

extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');
Issue = utilities.hyphen_to_dash (Issue);

local Page;
local Pages;
local At;
local QuotePage;
local QuotePages;
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then
Page = A['Page'];
Pages = utilities.hyphen_to_dash (A['Pages']);
At = A['At'];
QuotePage = A['QuotePage'];
QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
else
else
Chapter = A['Chapter'];
local param_orig = first_set ({A:ORIGIN ('Page'), A:ORIGIN ('Pages'), A:ORIGIN ('At'), A:ORIGIN ('QuotePage'), A:ORIGIN ('QuotePages')}, 5);
ScriptChapter = A['ScriptChapter'];
if param_orig then -- when any of the in-source locator params are set
TransChapter = A['TransChapter'];
utilities.set_message ('err_parameter_ignored', {param_orig}); -- emit an ignored parameter error message
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
end
end

local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);

local Mode = mode_set (A['Mode'], A:ORIGIN('Mode'));

-- separator character and postscript
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
local Quote;
Quote, QuotePage, QuotePages, PostScript = quote_make (A['Quote'], A['TransQuote'], A['ScriptQuote'], QuotePage, QuotePages, NoPP, sepc, PostScript);

local Edition = A['Edition'];
local Edition = A['Edition'];
local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
local PublicationPlace = A['PublicationPlace']
local Place = A['Place'];
local PublisherName = A['PublisherName'];
local PublisherName = A['PublisherName'];
local RegistrationRequired = sanitized_parameter_value (A['RegistrationRequired'], A:ORIGIN ('RegistrationRequired'), 'yes_true_y', nil);
local PublisherName_origin = A:ORIGIN('PublisherName');
local SubscriptionRequired = sanitized_parameter_value (A['SubscriptionRequired'], A:ORIGIN ('SubscriptionRequired'), 'yes_true_y', nil);
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then
local i;
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized
if i and (0 < i) then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
end
end
local Via = A['Via'];
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then
local AccessDate = A['AccessDate'];
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'});
local ArchiveDate = A['ArchiveDate'];
end
local Agency = A['Agency'];
local DeadURL = sanitized_parameter_value (A['DeadURL'], A:ORIGIN ('DeadURL'), 'deadurl', '');


local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
local Language = A['Language'];
local Newsgroup_origin = A:ORIGIN('Newsgroup');
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);
if 'newsgroup' == config.CitationClass then
local ID_access_levels = extract_id_access_levels (args, ID_list);
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
end


local LaySource = A['LaySource'];
PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
local Transcript = A['Transcript'];
end

if 'book' == config.CitationClass or 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
local accept;
PublisherName, accept = utilities.has_accept_as_written (PublisherName); -- check for and remove accept-as-written markup from |publisher= wrapped
if not accept then -- when no accept-as-written markup
check_publisher_name (PublisherName); -- emit maint message when |publisher= might be prefixed with publisher's location
end
end


local no_tracking_cats = set_no_tracking_cats (A['NoTracking'], A:ORIGIN ('NoTracking'), this_page);
local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL?
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
local Quote = A['Quote'];
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then
local sepc, PostScript, Ref = set_style (A['Mode'], A:ORIGIN ('Mode'), A['PostScript'], A['Ref'], Quote, config.CitationClass);
UrlAccess = nil;
if is_set (Quote) and is_set (A['PostScript']) then
utilities.set_message ('err_param_access_requires_param', 'url');
select_one (args, {'postscript', 'quote', 'quotation'}, 'redundant_parameters');
end
end
local use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text
local ChapterURL = A['ChapterURL'];
local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then
ChapterUrlAccess = nil;
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')});
end


-- check for insource-location-related parameters like |page=, |pages= or |at=. 请注意section参数有歧义,如果section跟书有关系,上面已经被清空了,这里不纳入检查。
local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
select_one (args, {'at', 'time', 'minutes'}, 'redundant_parameters');
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then
select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'time', 'minutes', 'sheet', 'sheets'}, 'redundant_parameters');
MapUrlAccess = nil;
if is_set (Section) then
utilities.set_message ('err_param_access_requires_param', {'map-url'});
select_one (args, {'at', 'section', 'sections'}, 'redundant_parameters');
else
select_one (args, {'at', 'sections'}, 'redundant_parameters');
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);


if is_set (Page) then
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
if is_set (Pages) or is_set (At) then
local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
Pages = ''; -- unset the others

At = '';
-- 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 utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if cfg.uncategorized_namespaces[this_page.namespace] then -- is this page's namespace id one of the uncategorized namespace ids?
no_tracking_cats = "true"; -- set no_tracking_cats
end
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.
for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
elseif is_set (Pages) then
if this_page.text:match (v) then -- test page name against each pattern
if is_set (At) then
no_tracking_cats = "true"; -- set no_tracking_cats
break; -- bail out if one is found
At = ''; -- unset
end
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

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

local coins_pages;
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);

local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local Format = A['Format'];
local ChapterFormat = A['ChapterFormat'];
local TransChapter = A['TransChapter'];
local TransChapter_origin = A:ORIGIN ('TransChapter');
local TransTitle = A['TransTitle'];
local ScriptTitle = A['ScriptTitle'];
if is_set (Edition) then
if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn', -- if any of the 'periodical' cites except encyclopedia
extra_text_in_parameter_check (Edition, 'edition');
'map', 'episode'}) or ('conference' == config.CitationClass and utilities.is_set (A['BookTitle'])) or -- {{cite map}} allows |section= but it is alias of |sections= ; {{cite episode}} uses |title= as chapter
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) then
local chap_param;
if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = A:ORIGIN ('Chapter')
elseif utilities.is_set (TransChapter) then
chap_param = A:ORIGIN ('TransChapter')
elseif utilities.is_set (ChapterURL) then
chap_param = A:ORIGIN ('ChapterURL')
elseif utilities.is_set (ScriptChapter) then
chap_param = ScriptChapter_origin;
else utilities.is_set (ChapterFormat)
chap_param = A:ORIGIN ('ChapterFormat')
end

if utilities.is_set (chap_param) then -- if we found one
utilities.set_message ('err_chapter_ignored', {chap_param}); -- add error message
Chapter = ''; -- and set them to empty string to be safe with concatenation
TransChapter = ''; -- for now, ignore linter warnings
ChapterURL = '';
ScriptChapter = '';
ChapterFormat = '';
end
end
end
------------------------------------------------- Get people
--[[
local NameListFormat = sanitized_parameter_value (A['NameListFormat'], A:ORIGIN ('NameListFormat'), 'name-list-format', '');
Parameter remapping for cite encyclopedia:
local LastAuthorAmp = sanitized_parameter_value (A['LastAuthorAmp'], A:ORIGIN ('LastAuthorAmp'), 'yes_true_y', nil);
When the citation has these parameters:
local contributors_valid = in_array (citation_class, cfg.args_support['templates_using_contributor']);
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= for rendering
|encyclopedia= and |article= then map |encyclopedia= to |title= for rendering

|trans-title= maps to |trans-chapter= when |title= is re-mapped
|url= maps to |chapter-url= when |title= is remapped
local Authors, Contributors, Editors, Translators, Contribution, NameList, multiple_editors, has_contributors =
All other combinations of |encyclopedia=, |title=, and |article= are not modified
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
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
local Degree = A['Degree'];
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
if 'thesis' == citation_class then
if utilities.is_set (Encyclopedia) then
if (is_set (Degree)) then
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
TitleType = wrap_msg ('thesis with type', Degree, use_lowercase);
else
else
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('ScriptEncyclopedia')});
TitleType = wrap_msg ('thesis no type', 'placeholder', use_lowercase);
end
Encyclopedia = nil; -- unset these because not supported by this template
ScriptEncyclopedia = nil;
TransEncyclopedia = nil;
end
end
else
elseif utilities.is_set (TransEncyclopedia) then
Degree = discard_parameter (Degree, A:ORIGIN ('Degree'), nil);
utilities.set_message ('err_trans_missing_title', {'encyclopedia'});
end
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
if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) then
|url maps to |chapterurl when |title is remapped
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia
Periodical_origin = A:ORIGIN ('Encyclopedia');
ScriptPeriodical = ScriptEncyclopedia;
ScriptPeriodical_origin = A:ORIGIN ('ScriptEncyclopedia');


All other combinations of |encyclopedia, |title, and |article are not modified
if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then
if not (utilities.is_set (Chapter) or utilities.is_set (ScriptChapter)) then
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= params to |article= params for rendering
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
TransChapter = TransTitle;
ChapterURL = URL;
ChapterURL_origin = URL_origin;
ChapterUrlAccess = UrlAccess;
ChapterFormat = Format;


]]
if utilities.is_set (TitleLink) then

if utilities.is_set (ChapterURL) then
local Encyclopedia;
utilities.set_message ('err_wikilink_in_url');
local Entry = A['Entry'];
else

Chapter = utilities.make_wikilink (TitleLink, Chapter);
if (citation_class == 'encyclopaedia') then -- test code for citation
end
local entry_redundant = false
end
Encyclopedia = Periodical;
Title = Periodical; -- now map |encyclopedia= params to |title= params for rendering
if is_set (Periodical) then
ScriptTitle = ScriptPeriodical or '';
if is_set (Title) or is_set (ScriptTitle) then
TransTitle = TransEncyclopedia or '';
Chapter = Title;
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
ScriptChapter = ScriptTitle;
URL = '';
ScriptTitle = '';
Format = '';
TransChapter = TransTitle;
TitleLink = '';
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
TitleLink = '';
elseif utilities.is_set (Chapter) or utilities.is_set (ScriptChapter) then -- |title= not set
entry_redundant = is_set (Entry);
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= for rendering
elseif is_set (Entry) then
ScriptTitle = ScriptPeriodical or '';
Chapter = Entry;
TransTitle = TransEncyclopedia or '';
ChapterURLobject = URLobject;
Periodical = ''; -- redundant so unset
URLobject = create_url_object ();
ScriptPeriodical = '';
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
-- 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
end


-- special case for cite techreport.
-- Special case for cite techreport.
local ID = A['ID'];
local Num = A['Number'];
if (config.CitationClass == "techreport") then -- special case for cite techreport
if citation_class == 'techreport' then -- special case for cite techreport
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if is_set (Num) then -- cite techreport uses 'number', which other citations alias to 'issue'
if not utilities.is_set (ID) then -- can we use ID for the "number"?
if not is_set (ID) then -- can we use ID for the "number"?
ID = A['Number']; -- yes, use it
ID = Num; -- yes, use it
else -- ID has a value so emit error message
else -- ID has a value so emit error message
select_one (args, {'id', 'number'}, 'redundant_parameters');
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'number')});
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
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
local Callsign = A['Callsign'];
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
local Conference = A['Conference'];
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'];
local BookTitle = A['BookTitle'];
if 'conference' == citation_class then
local TransTitle_origin = A:ORIGIN ('TransTitle');
if is_set (BookTitle) then
if 'conference' == config.CitationClass then
ChapterURLobject = URLobject;
if utilities.is_set (BookTitle) then
URLobject = create_url_object ();
TransChapter = TransTitle;
TransTitle = '';
Chapter = Title;
Chapter = Title;
Chapter_origin = 'title';
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
URL_origin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
TransChapter_origin = TransTitle_origin;
Title = BookTitle;
Title = BookTitle;
ScriptTitle = '';
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
end
else
elseif 'speech' ~= config.CitationClass then
BookTitle = discard_parameter (BookTitle, A:ORIGIN ('BookTitle'), nil);
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
if 'speech' == citation_class then
end
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).
local cs2_lower = function (text) -- if mode is cs2, use lower case
TitleType = ''; -- annotate the citation
if (sepc ~= '.') then
else
return text:lower();
Conference = discard_parameter (Conference, A:ORIGIN ('Conference'), '');
-- not cite conference or cite speech so make sure this is empty string
end
end
return text;
end
end

local use_lowercase = ( sepc == ',' ); -- controls capitalization of certain static text
-- cite map oddities
local Cartography = A['Cartography'];
local Scale = A['Scale'];
if citation_class == 'map' then
-- cite map oddities
local Cartography = "";
local Scale = "";
local Sheet = A['Sheet'] or '';
local Sheets = A['Sheets'] or '';
if config.CitationClass == "map" then
Chapter = A['Map'];
Chapter = A['Map'];
Chapter_origin = A:ORIGIN('Map'); -- for now, ignore linter warning
ChapterURL = A['MapURL'];
ChapterURL_origin = A:ORIGIN('MapURL');
TransChapter = A['TransMap'];
TransChapter = A['TransMap'];
ChapterURLobject = create_url_object (A['MapURL'], A:ORIGIN ('MapURL'), A['MapFormat'], A:ORIGIN ('MapFormat'), A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'));
ScriptChapter = A['ScriptMap']
Cartography = pend_separator (wrap_msg ('cartography', Cartography, use_lowercase), sepc, true);
ScriptChapter_origin = A:ORIGIN('ScriptMap')
Scale = pend_separator (Scale, sepc, true);

else
ChapterUrlAccess = MapUrlAccess;
Cartography = discard_parameter (Cartography, A:ORIGIN ('Cartography'), '');
ChapterFormat = A['MapFormat'];
Scale = discard_parameter (Scale, A:ORIGIN ('Scale'), '');

discard_parameter (A['Map'], A:ORIGIN ('Map'), nil);
Cartography = A['Cartography'];
discard_parameter (A['MapURL'], A:ORIGIN ('MapURL'), nil);
if utilities.is_set ( Cartography ) then
discard_parameter (A['TransMap'], A:ORIGIN ('TransMap'), nil);
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
discard_parameter (A['MapFormat'], A:ORIGIN ('MapFormat'), nil);
end
discard_parameter (A['MapUrlAccess'], A:ORIGIN ('MapUrlAccess'), nil);
Scale = A['Scale'];
if utilities.is_set ( Scale ) then
Scale = sepc .. " " .. Scale;
end
end
end


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

SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set

local Network = A['Network'];
local Network = A['Network'];
local Station = A['Station'];
local Station = A['Station'];
local s, n = {}, {};
local s, n = {}, {};
-- do common parameters first
-- do common parameters first
if utilities.is_set (Network) then table.insert(n, Network); end
if is_set (Network) then table.insert (n, Network); end
if utilities.is_set (Station) then table.insert(n, Station); end
if is_set (Station) then table.insert (n, Station); end
ID = table.concat(n, sepc .. ' ');
ID = table.concat (n, sepc .. ' ');
if is_set (AirDate) then
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
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 Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];
local SeriesNumber = A['SeriesNumber'];


if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set TODO: make a function for this and similar?
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');
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
-- add error message
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
end
end
-- assemble a table of parts concatenated later into Series
-- assemble a table of parts concatenated later into Series
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if is_set (Season) then table.insert (s, wrap_msg ('season', Season, use_lowercase)); end
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
if is_set (SeriesNumber) then table.insert (s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
if is_set (Issue) then table.insert (s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter
Issue = ''; -- unset because this is not a unique parameter
Chapter = Title; -- promote title parameters to chapter
Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
ScriptChapter = ScriptTitle;
local ChapterLink = TitleLink; -- alias episodelink
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
local ChapterLinkorigin = TitleLinkorigin;
ChapterLink = TitleLink; -- alias |episode-link=
TransChapter = TransTitle;
TransChapter = TransTitle;
ChapterURL = URL;
ChapterURLobject = URLobject;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
ChapterFormat = Format;

Title = Series; -- promote series to title
Title = Series; -- promote series to title
TitleLink = SeriesLink;
TitleLink = SeriesLink;
TitleLinkorigin = A:ORIGIN ('SeriesLink');
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
Series = table.concat (s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number


if utilities.is_set (ChapterLink) then
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
Chapter = make_internal_link (ChapterLink, Chapter, ChapterLinkorigin);
if not utilities.is_set (ChapterURL) then -- link but not URL
-- ok to wikilink
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
elseif utilities.is_set (Series) then -- if both are set, URL links episode;
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
Series = utilities.make_wikilink (ChapterLink, Series);
Series = make_internal_link (ChapterLink, Series, ChapterLinkorigin);
-- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
else
utilities.set_message ('err_wikilink_in_url');
end
end
end
URL = ''; -- unset
URLobject = create_url_object (); -- unset
TransTitle = '';
TransTitle = '';
ScriptTitle = '';
ScriptTitle = '';
Format = '';
else -- now oddities that are cite serial
else -- now oddities that are cite serial
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
if is_set (Series) and is_set (SeriesLink) then
Series = utilities.make_wikilink (SeriesLink, Series);
Series = make_internal_link (SeriesLink, Series, A:ORIGIN ('SeriesLink'));
end
end
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
Series = wrap_style ('italic-title', Series); -- series is italicized
end
end
end
end
-- end of {{cite episode}} stuff
-- end of {{cite episode}} stuff


-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
-- handle type parameter for those CS1 citations that have default values
if 'arxiv' == citation_class then
local TitleType = A['TitleType'];
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
local Degree = A['Degree'];
append_error ('arxiv_missing', {}); -- add error message
if utilities.in_array (config.CitationClass, {'AV-media-notes', 'document', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
elseif is_set (Series) then -- series is an alias of version
TitleType = set_titletype (config.CitationClass, TitleType);
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
Series = ''; -- unset
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
deprecated_parameter ('version'); -- deprecated parameter but only for cite arxiv
end
end
end

if utilities.is_set (TitleType) then -- if type parameter is specified
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
-- TODO: Hack on TitleType to fix bunched parentheses problem
end

local Date = A['Date'];
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
local Year = A['Year'];

if utilities.is_set (Year) then
validation.year_check (Year); -- returns nothing; emits maint message when |year= doesn't hold a 'year' value
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
if not utilities.is_set (Date) then
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
Date = Year; -- promote Year to Date
ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']},27) then
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter
append_error ('arxiv_params_not_supported', {}); -- add error message
else
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging
end


AccessDate= ''; -- set these to empty string; not supported in cite arXiv
--[[
PublisherName = ''; -- (if the article has been published, use cite journal, or other)
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
URLobject = create_url_object ();
we get the date used in the metadata.
Page = ''; Pages = ''; At = '';
end
Date validation supporting code is in Module:Citation/CS1/Date_validation
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

local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
if not utilities.is_set (DF) then
DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template
end
end

local ArchiveURL;
local ArchiveDate;
local ArchiveFormat = A['ArchiveFormat'];
local archive_url_timestamp; -- timestamp from wayback machine url
-- 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.
ArchiveURL, ArchiveDate, archive_url_timestamp = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
if not is_set (Date) then
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
if is_set (Year) then
Date = Year;
ArchiveURL, ArchiveDate = is_unique_archive_url (ArchiveURL, URL, ChapterURL, A:ORIGIN('ArchiveURL'), ArchiveDate); -- add error message when URL or ChapterURL == ArchiveURL
Dateorigin = A:ORIGIN ('Year'); -- promote Year to Date

Year = nil; -- make nil so Year as empty string isn't used for CITEREF
local AccessDate = A['AccessDate'];
elseif is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
Date = PublicationDate;
local DoiBroken = A['DoiBroken'];
Dateorigin = A:ORIGIN ('PublicationDate'); -- promote PublicationDate to Date
local Embargo = A['Embargo'];
PublicationDate = '';
local anchor_year; -- used in the CITEREF identifier
do -- create defined block to contain local variables date_parameters_list, mismatch
local date_parameters_list = { -- AirDate has been promoted to Date so not necessary to check it
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
['date'] = {val = Date, name = Date_origin},
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
['year'] = {val = Year, name = A:ORIGIN ('Year')},
};

local error_list = {};
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);

if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;
validation.year_date_check (Year, A:ORIGIN ('Year'), Date, A:ORIGIN ('Date'), error_list);
end
end
else

if is_set (PublicationDate) and PublicationDate ~= Date then
if 0 == #error_list then -- error free dates only; 0 when error_list is empty
PublicationDate = wrap_msg ('publication-date', PublicationDate, use_lowercase);
local modified = false; -- flag
if utilities.is_set (DF) then -- if we need to reformat dates
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
end

if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
modified = true;
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category
end
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
modified = true;
end

if modified then -- if the date_parameters_list values were modified
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values
ArchiveDate = date_parameters_list['archive-date'].val;
Date = date_parameters_list['date'].val;
DoiBroken = date_parameters_list['doi-broken-date'].val;
end

if archive_url_timestamp and utilities.is_set (ArchiveDate) then
validation.archive_date_check (ArchiveDate, archive_url_timestamp, DF); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate
end
else
else
PublicationDate = ''; -- if PublicationDate is same as Date, don't display in rendered citation
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message
end
end
end -- end of do

if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others?
('citation' == config.CitationClass and (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) or -- {{citation}} as an encylopedia citation
('citation' == config.CitationClass and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then -- {{citation}} as a book citation
if utilities.is_set (PublicationPlace) then
if not utilities.is_set (PublisherName) then
local date = COinS_date.rftdate and tonumber (COinS_date.rftdate:match ('%d%d%d%d')); -- get year portion of COinS date (because in Arabic numerals); convert string to number
if date and (1850 <= date) then -- location has no publisher; if date is 1850 or later
utilities.set_message ('maint_location_no_publisher'); -- add maint cat
end
else -- PublisherName has a value
if cfg.keywords_xlate['none'] == PublisherName then -- if that value is 'none' (only for book and encyclopedia citations)
PublisherName = ''; -- unset
end
end
end
end
end


local ID_list_t; -- sequence table of rendered identifiers
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);
local ID_list_coins_t; -- table of identifiers and their values from args; key is same as cfg.id_handlers's key
local Class = A['Class']; -- arxiv class identifier
-- used in the CITEREF identifier
local ID_support = {
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
}


-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS.
ID_list_t, ID_list_coins_t = identifiers.identifier_lists_get (args, {
-- 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
DoiBroken = DoiBroken, -- for |doi=
ASINTLD = A['ASINTLD'], -- for |asin=
Embargo = is_embargoed (Embargo); --
Embargo = Embargo, -- for |pmc=
Class = Class, -- for |arxiv=
CitationClass = config.CitationClass, -- for |arxiv=
Year=anchor_year, -- for |isbn=
}, ID_support);


if citation_class == 'journal' and not is_set (URLobject['url']) and is_set (ID_list['PMC']) then
for _, id in ipairs (ID_list_t) do -- search through the ID_list_t sequence looking for an ISBN identifier string
if id:find ('ISBN', 3, true) then -- plain find, start at index 3 ([[ISBN)
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
if 'citation' == config.CitationClass then -- catch ve/citoid malformed book cites in {{citation}} templates
URLobject['origin'] = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
if utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) then -- when a |work= alias is set
utilities.set_message ('maint_work_isbn'); -- add maint cat
break; -- and abandon
end
elseif ({['journal'] = true, ['magazine'] = true, ['news'] = true, ['web'] = true})[config.CitationClass] then
utilities.set_message ('maint_periodical_has_isbn'); -- add maint cat
break; -- and abandon
end
end
end
end
end

if not is_set (URLobject['url']) then
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, {{cite ssrn}}, before generation of COinS data.
if in_array (citation_class, cfg.args_support['templates_requiring_url']) then
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv=, |citeseerx=, |medrxiv=, |ssrn= required for their templates
append_error ('cite_web_url', {});
if not (args[cfg.id_handlers[config.CitationClass:upper()].parameters[1]] or -- can't use ID_list_coins_t k/v table here because invalid parameters omitted
args[cfg.id_handlers[config.CitationClass:upper()].parameters[2]]) then -- which causes unexpected parameter missing error message
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
end
end

-- Test if accessdate is given without giving a URL
Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['medrxiv'] = 'medRxiv', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
if is_set (AccessDate) and not is_set (ChapterURLobject['url']) then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
end
append_error ('accessdate_missing_url', {});

AccessDate = '';
-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free

if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead
if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled
if identifiers.auto_link_urls[auto_select] then -- manual selection
URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link
URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC
URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed
URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI
URL = identifiers.auto_link_urls['doi'];
URL_origin = cfg.id_handlers['DOI'].parameters[1];
end
end

if utilities.is_set (URL) then -- set when using an identifier-created URL
if utilities.is_set (AccessDate) then -- |access-date= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_accessdate_missing_url'); -- add an error message
AccessDate = ''; -- unset
end

if utilities.is_set (ArchiveURL) then -- |archive-url= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_archive_missing_url'); -- add an error message
ArchiveURL = ''; -- unset
end
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.
-- 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 (Title) and
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
not is_set (TransTitle) and
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
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
end

if 'none' == Title and citation_class == 'journal' then -- special case for journal cites
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
Title = ''; -- set title to empty string
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
add_maint_cat ('untitled');
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
Title = ''; -- set title to empty string
utilities.set_message ('maint_untitled'); -- add maint cat
end
end


check_for_external_link ({ -- add error message when any of these parameters contains a URL
if 'journal' == config.CitationClass
['title'] = Title,
or ('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin)) then
[A:ORIGIN ('Chapter')] = Chapter,
if is_page_art_num (((utilities.is_set (Page) and Page) or (utilities.is_set (Pages) and Pages)) or nil, ID_list_coins_t['DOI']) then -- does |page(s)= look like it holds an article number
[A:ORIGIN ('Periodical')] = Periodical,
utilities.set_message ('maint_page_art_num'); -- add maint cat
[A:ORIGIN ('PublisherName')] = PublisherName,
end
});
end


-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
第3,673行: 第1,526行:
local coins_chapter = Chapter; -- default assuming that remapping not required
local coins_chapter = Chapter; -- default assuming that remapping not required
local coins_title = Title; -- et tu
local coins_title = Title; -- et tu
if 'encyclopaedia' == citation_class then
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) then
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then -- should script-params be considered?
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
coins_chapter = Title; -- remap
coins_chapter = Title; -- remap
coins_title = Periodical;
coins_title = Periodical;
end
end
end
end

local coins_author = a; -- default for coins rft.au
if 0 < #c then -- but if contributor list
coins_author = c; -- use that instead
end
-- this is the function call to COinS()
-- this is the function call to COinS()
local OCinSoutput = metadata.COinS({
local OCinSoutput = COinS ({
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
['Periodical'] = Periodical,
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
['Encyclopedia'] = Encyclopedia,
['Chapter'] = coins_chapter,
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
['ScriptChapter'] = ScriptChapter,
['Map'] = Map,
['Degree'] = Degree; -- cite thesis only
['Degree'] = Degree; -- cite thesis only
['Title'] = coins_title,
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
['ScriptTitle'] = ScriptTitle,
['PublicationPlace'] = PublicationPlace,
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date.* has correctly formatted date values if Date is valid;
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Season'] = COinS_date.rftssn,
['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?
['Quarter'] = COinS_date.rftquarter,
['Chron'] = COinS_date.rftchron,
['Series'] = Series,
['Series'] = Series,
['Volume'] = Volume,
['Volume'] = Volume,
['Issue'] = Issue,
['Issue'] = Issue,
['Pages'] = first_set ({Sheet, Sheets, Page, Pages, At}, 5),
['ArticleNumber'] = ArticleNumber,
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
['Edition'] = Edition,
['Edition'] = Edition,
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
['PublisherName'] = PublisherName,
['URL'] = first_set ({ChapterURL, URL}, 2),
['URL'] = first_set ({ChapterURLobject['url'], URLobject['url']}, 2),
['Authors'] = coins_author,
['Authors'] = NameList,
['ID_list'] = ID_list_coins_t,
['ID_list'] = ID_list,
['RawPage'] = this_page.prefixedText,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);
}, config.CitationClass);


-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, and {{cite ssrn}} AFTER generation of COinS data.
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, medRxiv, or ssrn now unset so it isn't displayed
if 'arxiv' == citation_class then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
Periodical = '';
end
end


-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text
-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
if 'newsgroup' == citation_class then
if is_set (PublisherName) then
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
PublisherName = wrap_msg ('newsgroup', make_external_link ('news:' .. PublisherName, PublisherName, A:ORIGIN ('PublisherName')), use_lowercase);
end
end
end


local Editors;
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
local Contributors; -- assembled contributors name list
local contributor_etal = nil; -- must be intentionally initialized

local Translators; -- assembled translators name list
local translator_etal = nil; -- must be intentionally initialized
local t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=

local Interviewers;
local interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters
local interviewer_etal = nil; -- must be intentionally initialized
-- Now perform various field substitutions.
-- Now perform various field substitutions.
-- We also add leading spaces and surrounding markup and punctuation to the
-- We also add leading spaces and surrounding markup and punctuation to the
-- various parts of the citation, but only when they are non-nil.
-- various parts of the citation, but only when they are non-nil.
do
local last_first_list;
local control = {
format = NameListStyle, -- empty string, '&', 'amp', 'and', or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
mode = Mode
};

do -- do editor name list first because the now unsupported coauthors used to modify control table
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayEditors'], A['DisplayEditors'], A:ORIGIN ('DisplayEditors'), #e);
control.maximum, editor_etal = get_display_names (display_names, #e, editor_etal, param);

Editors, EditorCount = list_people (control, e, editor_etal);

if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
EditorCount = 2; -- spoof to display (eds.) annotation
end
end
do -- now do interviewers
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayInterviewers'], A['DisplayInterviewers'], A:ORIGIN ('DisplayInterviewers'), #interviewers_list);
control.maximum, interviewer_etal = get_display_names (display_names, #interviewers_list, interviewer_etal, param);

Interviewers = list_people (control, interviewers_list, interviewer_etal);
end
do -- now do translators
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayTranslators'], A['DisplayTranslators'], A:ORIGIN ('DisplayTranslators'), #t);
control.maximum, translator_etal = get_display_names (display_names, #t, translator_etal, param);

Translators = list_people (control, t, translator_etal);
end
do -- now do contributors
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayContributors'], A['DisplayContributors'], A:ORIGIN ('DisplayContributors'), #c);
control.maximum, contributor_etal = get_display_names (display_names, #c, contributor_etal, param);

Contributors = list_people (control, c, contributor_etal);
end
do -- now do authors
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayAuthors'], A['DisplayAuthors'], A:ORIGIN ('DisplayAuthors'), #a, author_etal);
control.maximum, author_etal = get_display_names (display_names, #a, author_etal, param);

last_first_list = list_people (control, a, author_etal);

if utilities.is_set (Authors) then
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
if author_etal then
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
end
else
Authors = last_first_list; -- either an author name list or an empty string
end
end -- end of do
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
if utilities.is_set (Authors) and utilities.is_set (Collaboration) then
-- an error message if the associated url is not set, or an empty string for concatenation
Authors = utilities.substitute (cfg.messages['collaboration'], {Authors, Collaboration}); -- add collaboration after et al.
format_format ({ArchiveURLobject, ConferenceURLobject, URLobject, LayURLobject, TranscriptURLobject, ChapterURLobject});
end

end

local ConferenceFormat = A['ConferenceFormat'];
local ConferenceURL = A['ConferenceURL'];
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
Format = style_format (Format, URL, 'format', 'url');

if not utilities.is_set (URL) then
if utilities.in_array (config.CitationClass, {"web", "podcast", "mailinglist"}) or -- |url= required for {{cite web}}, {{cite podcast}}, and {{cite mailing list}}
('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website=
if not url_was_archive_today then -- is <URL> empty/missing because it was a deprecated archive.today url
utilities.set_message ('err_cite_web_url'); -- no; emit an error message for an empty/ missing |url=
end
end
-- do we have |accessdate= without either |url= or |chapter-url=?
if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set;
utilities.set_message ('err_accessdate_missing_url');
AccessDate = '';
end
end

local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');
local OriginalURL
local OriginalURL_origin
local OriginalFormat
local OriginalAccess;
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
if utilities.is_set ( ArchiveURL ) then
if utilities.is_set (ChapterURL) then -- if chapter-url= is set apply archive url to it
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
OriginalURL_origin = ChapterURL_origin; -- name of |chapter-url= parameter for error messages
OriginalFormat = ChapterFormat; -- and original |chapter-format=

if 'live' ~= UrlStatus then
ChapterURL = ArchiveURL -- swap-in the archive's URL
ChapterURL_origin = A:ORIGIN('ArchiveURL') -- name of |archive-url= parameter for error messages
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs
end
elseif utilities.is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
OriginalURL_origin = URL_origin; -- name of URL parameter for error messages
OriginalFormat = Format; -- and original |format=
OriginalAccess = UrlAccess;

if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it
URL = ArchiveURL -- swap-in the archive's URL
URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages
Format = ArchiveFormat or ''; -- swap in archive's format
UrlAccess = nil; -- restricted access levels do not make sense for archived URLs
end
end
elseif utilities.is_set (UrlStatus) then -- if |url-status= is set when |archive-url= is not set
utilities.set_message ('maint_url_status'); -- add maint cat
end

if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) then
else -- otherwise, format chapter / article title
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
end
end
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
Chapter = format_chapter_title (ScriptChapter, ScriptChapter_origin, Chapter, TransChapter, TransChapter_origin, ChapterURL, ChapterURL_origin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
if utilities.is_set (Chapter) then
Chapter = Chapter .. ChapterFormat ;
if 'map' == config.CitationClass and utilities.is_set (TitleType) then
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
Chapter = Chapter .. sepc .. ' ';
elseif utilities.is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ...
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it
end
end

-- Format main title
local plain_title = false;
local accept_title;
Title, accept_title = utilities.has_accept_as_written (Title, true); -- remove accept-this-as-written markup when it wraps all of <Title>
if accept_title and ('' == Title) then -- only support forced empty for now "(())"
Title = cfg.messages['notitle']; -- replace by predefined "No title" message
-- TODO: utilities.set_message ( 'err_redundant_parameters', ...); -- issue proper error message instead of muting
ScriptTitle = ''; -- just mute for now
TransTitle = ''; -- just mute for now
plain_title = true; -- suppress text decoration for descriptive title
utilities.set_message ('maint_untitled'); -- add maint cat
end

if not accept_title then -- <Title> not wrapped in accept-as-written markup
if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title=
Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three
elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ...
not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.)
Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters
end

if utilities.is_set (ArchiveURL) and is_archived_copy (Title) then
utilities.set_message ('maint_archived_copy'); -- add maintenance category before we modify the content of Title
end

if is_generic ('generic_titles', Title) then
utilities.set_message ('err_generic_title'); -- set an error message
end
end

if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'document', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not (utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia))) or
('map' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)))) 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 = utilities.wrap_style ('quoted-title', Title);
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle );
elseif plain_title or ('report' == config.CitationClass) then -- no styling for cite report and descriptive titles (otherwise same as above)
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
else
Title = utilities.wrap_style ('italic-title', Title);
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle);
end

if utilities.is_set (TransTitle) then
if utilities.is_set (Title) then
TransTitle = " " .. TransTitle;
else
utilities.set_message ('err_trans_missing_title', {'title'});
end
end

if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs?
if utilities.is_set (TitleLink) and utilities.is_set (URL) then
utilities.set_message ('err_wikilink_in_url'); -- set an error message because we can't have both
TitleLink = ''; -- unset
end
-- special case for chapter format so no error message or cat when chapter not supported
if not utilities.is_set (TitleLink) and utilities.is_set (URL) then
if format_url_access_text (URLobject, SubscriptionRequired, RegistrationRequired) then
Title = external_link (URL, Title, URL_origin, UrlAccess) .. TransTitle .. Format;
select_one (args, {'url-access', 'urlaccess', 'registration', 'subscription'}, 'redundant_parameters');
URL = ''; -- unset these because no longer needed
Format = ''; -- for now, ignore linter warning
end -- 只需其一
format_url_access_text (ChapterURLobject, nil, nil);
elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then
local ws_url;
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
if ws_url then
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
Title = Title .. TransTitle;
else
Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle;
end
else
local ws_url, ws_label, L; -- Title has italic or quote markup by the time we get here which causes is_wikilink() to return 0 (not a wikilink)
ws_url, ws_label, L = wikisource_url_make (Title:gsub('^[\'"]*(.-)[\'"]*$', '%1')); -- make ws URL from |title= interwiki link (strip italic or quote markup); link portion L becomes tooltip label
if ws_url then
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
Title = Title .. TransTitle;
else
Title = Title .. TransTitle;
end
end
else
Title = TransTitle;
end


local OriginalURLobject; -- TODO: swap chapter and title here so that archive applies to most specific if both are set?
local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
OriginalURLobject, URLobject, ChapterURLobject =
if utilities.is_set (Conference) then
swap_urls (URLobject, ChapterURLobject, ArchiveURLobject, DeadURL);
if utilities.is_set (ConferenceURL) then
Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil );
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif utilities.is_set (ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil );
end

local Position = '';
if not utilities.is_set (Position) then
local Minutes = A['Minutes'];
local Time = A['Time'];

if utilities.is_set (Minutes) then
if utilities.is_set (Time) then --TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'minutes') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'time')});
end
Position = utilities.substitute (cfg.messages.minutes, Minutes);
else
if utilities.is_set (Time) then
local TimeCaption = A['TimeCaption']
if not utilities.is_set (TimeCaption) then
TimeCaption = cs2_lower(cfg.messages['event']);
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
else
Position = " " .. Position;
At = '';
end

Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, ScriptPeriodical_origin, sepc, NoPP, use_lowercase);

At = utilities.is_set (At) and (sepc .. " " .. At) or "";
Position = utilities.is_set (Position) and (sepc .. " " .. Position) or "";
if config.CitationClass == 'map' then
local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier
local Inset = A['Inset'];
if utilities.is_set ( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end

if utilities.is_set ( Sections ) then
if utilities.is_set ( Section ) then
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'sections') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'section')});
end
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
elseif utilities.is_set ( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
end
At = At .. Inset .. Section;
end

local Others = A['Others'];
if utilities.is_set (Others) and 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
if config.CitationClass == "AV-media-notes"
or config.CitationClass == "audio-visual" then -- special maint for AV/M which has a lot of 'false' positives right now
utilities.set_message ('maint_others_avm')
else
utilities.set_message ('maint_others');
end
end
Others = utilities.is_set (Others) and (sepc .. " " .. Others) or "";
local chapter_no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if utilities.is_set (Translators) then
if is_set (Contribution) and has_contributors then -- if this is a contribution with contributor(s)
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc);
if in_array (Contribution:lower(), cfg.keywords['contribution']) then -- and a generic contribution title
end
chapter_no_quotes = true; -- then render it unquoted
if utilities.is_set (Interviewers) then
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc);
end
local TitleNote = A['TitleNote'];
TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or "";
if utilities.is_set (Edition) then
if Edition:match ('%f[%a][Ee]d%n?%.?$') or Edition:match ('%f[%a][Ee]dition$') then -- Ed, ed, Ed., ed., Edn, edn, Edn., edn.
utilities.set_message ('err_extra_text_edition'); -- add error message
end
end
Edition = " " .. wrap_msg ('edition', Edition);
else
Edition = '';
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);
Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
Others = pend_separator (wrap_msg ('translated', Translators, use_lowercase), sepc, true) .. Others;
local Agency = A['Agency'] or ''; -- |agency= is supported by {{cite magazine}}, {{cite news}}, {{cite press release}}, {{cite web}}, and certain {{citation}} templates
if utilities.is_set (Agency) then -- this testing done here because {{citation}} supports 'news' citations
if utilities.in_array (config.CitationClass, {'magazine', 'news', 'pressrelease', 'web'})
or ('citation' == config.CitationClass and (utilities.in_array (Periodical_origin, {"magazine", "newspaper", "work"}) or utilities.in_array (ScriptPeriodical_origin, {"script-magazine", "script-newspaper", "script-work"}))) then
Agency = wrap_msg ('agency', {sepc, Agency}); -- format for rendering
else
Agency = ''; -- unset; not supported
utilities.set_message ('err_parameter_ignored', {'agency'}); -- add error message
end
end
if 'speech' ~= citation_class then
Volume = format_volume_issue (Volume, Issue, ArticleNumber, config.CitationClass, Periodical_origin, ScriptPeriodical_origin, sepc, use_lowercase);
TitleNote = pend_separator (TitleNote, sepc, true);

if utilities.is_set (AccessDate) then
local retrv_text = " " .. cfg.messages['retrieved'];

AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
retrv_text = cs2_lower(retrv_text); -- if mode is cs2, lower case
AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text

AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
end
end
Edition = wrap_msg ('edition', Edition, use_lowercase);
if utilities.is_set (ID) then ID = sepc .. " " .. ID; end
Series = pend_separator (Series, sepc, true);
OrigYear = wrap_msg ('orig year', OrigYear, use_lowercase);
local Docket = A['Docket'];
Agency = pend_separator (Agency, sepc, true);
if "thesis" == config.CitationClass and utilities.is_set (Docket) then
Volume = format_volume_issue (Volume, Issue, citation_class, Periodical_origin, sepc, use_lowercase);
ID = sepc .. " Docket " .. Docket .. ID;
end
if "report" == config.CitationClass and utilities.is_set (Docket) then -- for cite report when |docket= is set
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set
end


------------------------------------ totally unrelated data
if utilities.is_set (URL) then
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
end
Via = wrap_msg ('via', Via, use_lowercase);
-- We check length of PostScript here because it will have been nuked by
AccessDate = format_accessdate (AccessDate, sepc, use_lowercase);
-- the quote parameters. We'd otherwise emit a message even if there wasn't
ID = format_id (ID, Docket, sepc, use_lowercase);
-- a displayed postscript.
ID_list = build_id_list (ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class});
-- TODO: Should the max size (1) be configurable?
-- TODO: Should we check a specific pattern?
if utilities.is_set(PostScript) and mw.ustring.len(PostScript) > 1 then
utilities.set_message ('maint_postscript')
end
local Archived;
if utilities.is_set (ArchiveURL) then
if not utilities.is_set (ArchiveDate) then -- ArchiveURL set but ArchiveDate not set
utilities.set_message ('err_archive_missing_date'); -- emit an error message
ArchiveURL = ''; -- empty string for concatenation
ArchiveDate = ''; -- empty string for concatenation
end
else
if utilities.is_set (ArchiveDate) then -- ArchiveURL not set but ArchiveDate is set
utilities.set_message ('err_archive_date_missing_url'); -- emit an error message
ArchiveURL = ''; -- empty string for concatenation
ArchiveDate = ''; -- empty string for concatenation
end
end


local URL = '';
if utilities.is_set (ArchiveURL) then
if "live" == UrlStatus then
if is_set (URLobject['url']) then
URL = ' ' .. make_external_link (URLobject['url'], nil, URLobject['origin']) .. URLobject['access-text'];
if utilities.is_set (ArchiveDate) then
Archived = sepc .. ' ' .. utilities.substitute ( cfg.messages['archived-live'],
{ external_link( ArchiveURL, cs2_lower(cfg.messages['archived']), A:ORIGIN('ArchiveURL'), nil) .. ArchiveFormat, ArchiveDate } );
else
Archived = '';
end
if not utilities.is_set (OriginalURL) then
utilities.set_message ('err_archive_missing_url');
Archived = ''; -- empty string for concatenation
end
elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
Archived = sepc .. ' ' .. utilities.substitute ( cs2_lower(cfg.messages['archived-unfit']), ArchiveDate);
if 'bot: unknown' == UrlStatus then
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
else
utilities.add_prop_cat ('unfit'); -- and add a category if not already added
end
else -- UrlStatus is empty, 'dead'
if utilities.is_set (ArchiveDate) then
Archived = sepc .. ' ' .. utilities.substitute ( cs2_lower(cfg.messages['archived-dead']),
{ external_link( OriginalURL, cfg.messages['original'], OriginalURL_origin, OriginalAccess ) .. OriginalFormat, ArchiveDate } );
else
Archived = ''; -- unset for concatenation
end
end
else -- OriginalUrl not set
utilities.set_message ('err_archive_missing_url');
Archived = ''; -- empty string for concatenation
end
elseif utilities.is_set (ArchiveFormat) then
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
else
Archived = '';
end
end
local TranscriptURL = A['TranscriptURL']
local Format = URLobject['format'];
Quote = format_quote (Quote, sepc);
local TranscriptFormat = A['TranscriptFormat'];
local Archived = format_archive (ArchiveURLobject, OriginalURLobject, ArchiveDate, DeadURL, sepc, use_lowercase);
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');
local Lay = format_lay (LayURLobject, LayDate, LaySource, sepc, use_lowercase);
local Transcript = A['Transcript'];
Transcript = format_external_link (Transcript, TranscriptURLobject, sepc);
local TranscriptURL_origin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
local Publisher = format_publisher (PublisherName, PublicationPlace, Periodical, citation_class, sepc);
if utilities.is_set (Transcript) then
if utilities.is_set (TranscriptURL) then
Transcript = external_link( TranscriptURL, Transcript, TranscriptURL_origin, nil );
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif utilities.is_set (TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil );
end


local use_in = is_set (Chapter) and (not has_contributors);
local Publisher = ''; -- initialize to empty string for concatenation
Authors, Editors, Contributors = format_people (Authors, Editors, Contributors, multiple_editors, use_in, sepc);
if utilities.is_set (PublisherName) then
if utilities.is_set (PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName;
else
Publisher = sepc .. " " .. PublisherName;
end
elseif utilities.is_set (PublicationPlace) then
Publisher= sepc .. " " .. PublicationPlace;
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.
Periodical = format_periodical (Periodical, Title, TitleNote, sepc);
if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then
if utilities.is_set (Title) or utilities.is_set (TitleNote) then
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
else
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
end
end
local Language = A['Language'];
if utilities.is_set (Language) then
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc.
else
Language=''; -- language not specified so make sure this is an empty string;
--[[ TODO: need to extract the wrap_msg from language_parameter
so that we can solve parentheses bunching problem with Format/Language/TitleType
]]
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 = TitleType; -- move TitleType to TitleNote so that it renders ahead of |event=
TitleType = ''; -- and unset

if utilities.is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
if utilities.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.
第4,213行: 第1,648行:
local tcommon;
local tcommon;
local tcommon2; -- used for book cite when |contributor= is set
local tcommon2; -- used for book cite when |contributor= is set
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
if citation_class == 'journal' and is_set (Periodical) then

Others = pend_separator (Others, sepc, false);
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites
tcommon = safe_join ({Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Edition, Publisher, Agency}, sepc);
if utilities.is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc.
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
tcommon = safe_join ({Title, TitleNote}, sepc); -- author and other stuff will come after this and before tcommon2
tcommon2 = safe_join ({TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc);
tcommon2 = safe_join ({Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
else
else
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc);
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
end
end
elseif 'map' == citation_class then -- special cases for cite map

elseif 'map' == config.CitationClass 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);
if utilities.is_set (Chapter) then -- map in a book; TitleType is part of Chapter
elseif is_set (Periodical) then -- map in a periodical
tcommon = safe_join ({Title, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc);
tcommon = safe_join ({Title, TitleType, Format, Periodical, Scale, Series, Cartography, Others, Publisher, Volume}, sepc);
elseif utilities.is_set (Periodical) then -- map in a periodical
tcommon = safe_join ({Title, TitleType, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc);
else -- a sheet or stand-alone map
else -- a sheet or stand-alone map
tcommon = safe_join ({Title, TitleType, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc);
tcommon = safe_join ({Title, TitleType, Format, Edition, Scale, Series, Cartography, Others, Publisher}, sepc);
end
end
elseif 'episode' == config.CitationClass then -- special case for cite episode
elseif 'episode' == citation_class then -- special case for cite episode
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Edition, Publisher}, sepc);
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Transcript, Edition, Publisher}, sepc);

else -- all other CS1 templates
else -- all other CS1 templates
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc);
tcommon = safe_join ({Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Volume, Others, Edition, Publisher, Agency}, sepc);
end
end
if #ID_list_t > 0 then
if #ID_list > 0 then
ID_list_t = safe_join( { sepc .. " ", table.concat( ID_list_t, sepc .. " " ), ID }, sepc );
ID_list = safe_join ({sepc .. ' ', table.concat (ID_list, sepc .. ' '), ID}, sepc);
else
else
ID_list_t = ID;
ID_list = ID;
end
end
-- LOCAL
local Via = A['Via'];
local xDate;
Via = utilities.is_set (Via) and wrap_msg ('via', Via) or '';
if (is_set (Periodical) and is_set (Date) and
local idcommon;
not in_array (citation_class, {'encyclopaedia', 'web'}))
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript
or (in_array (citation_class, {'book', 'news'})) then
idcommon = safe_join( { ID_list_t, URL, Archived, Transcript, AccessDate, Via, Quote }, sepc );
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
else
idcommon = safe_join( { ID_list_t, URL, Archived, AccessDate, Via, Quote }, sepc );
xDate = safe_join ({Date, PublicationDate, OrigYear, AccessDate}, sepc);
end
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;
local text;
if is_set (Authors) then

if is_set (Contributors) then
local OrigDate = A['OrigDate'];
text = safe_join ({Contributors, Chapter, tcommon, Authors, Place, Editors, tcommon2, Insource_location, idcommon }, sepc);
OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or '';
if utilities.is_set (Date) then
if utilities.is_set (Authors) or utilities.is_set (Editors) then -- date follows authors or editors when authors not set
Date = " (" .. Date .. ")" .. OrigDate .. sepc .. " "; -- in parentheses
else -- neither of authors and editors set
if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc
Date = " " .. Date .. OrigDate; -- Date does not begin with sepc
else
Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc
end
end
end
if utilities.is_set (Authors) then
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Authors termination
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
end
if utilities.is_set (Editors) then
local in_text = '';
local post_text;
if utilities.is_set (Chapter) and 0 == #c then
in_text = cfg.messages['in'] .. ' ';
in_text = cs2_lower(in_text); -- lowercase for cs2
end
if EditorCount <= 1 then
post_text = ' (' .. cfg.messages['editor'] .. ')'; -- be consistent with no-author, no-date case
else
post_text = ' (' .. cfg.messages['editors'] .. ')';
end
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
end
if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc.
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
by_text = cs2_lower(by_text); -- lowercase for cs2
Authors = by_text .. Authors; -- author follows title so tweak it here
if utilities.is_set (Editors) and utilities.is_set (Date) then -- when Editors make sure that Authors gets terminated
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
end
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
end
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Editors, tcommon2, pgtext, idcommon }, sepc );
else
else
text = safe_join( {Authors, Date, Chapter, Editors, tcommon, pgtext, idcommon }, sepc );
text = safe_join ({Authors, Chapter, Place, Editors, tcommon, Insource_location, idcommon }, sepc);
end
end
elseif utilities.is_set (Editors) then
if utilities.is_set (Date) then
if EditorCount <= 1 then
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editor'];
else
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editors'];
end
else
if EditorCount <= 1 then
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
else
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end
text = safe_join( {Editors, Date, Chapter, tcommon, pgtext, idcommon}, sepc );
else
else
text = safe_join ({Editors, Chapter, Place, tcommon, Insource_location, idcommon}, sepc);
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
text = safe_join( {Chapter, tcommon, pgtext, Date, idcommon}, sepc );
else
text = safe_join( {Chapter, tcommon, Date, pgtext, idcommon}, sepc );
end
end
end

if utilities.is_set (PostScript) and PostScript ~= sepc then
if is_set (PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc ); -- Deals with italics, spaces, etc.
text = safe_join ({text, sepc}, sepc); --Deals with italics, spaces, etc.
text = text:sub (1, -sepc:len()-1);
if '.' == sepc then -- remove final seperator if present
text = text:gsub ('%' .. sepc .. '$', ''); -- dot must be escaped here
else
text = mw.ustring.gsub (text, sepc .. '$', ''); -- using ustring for non-dot sepc (likely a non-Latin character)
end
end
end
text = safe_join( {text, PostScript}, sepc );
text = safe_join ({text, PostScript}, sepc);


-- Now enclose the whole thing in a <cite> element
-- Now enclose the whole thing in a <cite/> element
return format_citation (text, config.CitationClass, Ref, NameList, anchor_year, OCinSoutput, no_tracking_cats);
local options_t = {};
options_t.class = cite_class_attribute_make (config.CitationClass, Mode);

local Ref = is_valid_parameter_value (A['Ref'], A:ORIGIN('Ref'), cfg.keywords_lists['ref'], nil, true); -- nil when |ref=harv; A['Ref'] else

if 'none' ~= cfg.keywords_xlate[(Ref and Ref:lower()) or ''] then
local namelist_t = {}; -- holds selected contributor, author, editor name list
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation

if #c > 0 then -- if there is a contributor list
namelist_t = c; -- select it
elseif #a > 0 then -- or an author list
namelist_t = a;
elseif #e > 0 then -- or an editor list
namelist_t = e;
end
local citeref_id;
if #namelist_t > 0 then -- if there are names in namelist_t
citeref_id = make_citeref_id (namelist_t, year); -- go make the CITEREF anchor
if mw.uri.anchorEncode (citeref_id) == ((Ref and mw.uri.anchorEncode (Ref)) or '') then -- Ref may already be encoded (by {{sfnref}}) so citeref_id must be encoded before comparison
utilities.set_message ('maint_ref_duplicates_default');
end
else
citeref_id = ''; -- unset
end
options_t.id = Ref or citeref_id;
end

if string.len (text:gsub('%b<>', '')) <= 2 then -- remove html and html-like tags; then get length of what remains;
z.error_cats_t = {}; -- blank the categories list
z.error_msgs_t = {}; -- blank the error messages list
OCinSoutput = nil; -- blank the metadata string
text = ''; -- blank the the citation
utilities.set_message ('err_empty_citation'); -- set empty citation message and category
end
local render_t = {}; -- here we collect the final bits for concatenation into the rendered citation

if is_preview_mode and (0 ~= #z.error_msgs_t or 0 ~= #z.maint_cats_t) then -- when in preview mode
if not utilities.is_set (options_t.id) then -- and when this template has not created an anchor ID
math.randomseed (tonumber (mw.getLanguage ('en'):formatDate ('U')) * 10000 + os.clock() * 10000);
options_t.id = 'CITEREF_temp_preview_id_' .. math.random (100000, 999999); -- create temporary anchor ID for preview mode
end
end

if utilities.is_set (options_t.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
options_t.id = mw.uri.anchorEncode(options_t.id); -- do this here; also used when adding preview warning messages
table.insert (render_t, utilities.substitute (cfg.presentation['cite-id'], {options_t.id, mw.text.nowiki(options_t.class), text})); -- when |ref= is set or when there is a namelist
else
table.insert (render_t, utilities.substitute (cfg.presentation['cite'], {mw.text.nowiki(options_t.class), text})); -- when |ref=none or when namelist_t empty and |ref= is missing or is empty
end

if OCinSoutput then -- blanked when citation is 'empty' so don't bother to add boilerplate metadata span
table.insert (render_t, utilities.substitute (cfg.presentation['ocins'], OCinSoutput)); -- format and append metadata to the citation
end

local template_name = cfg.citation_class_map_t[config.CitationClass];
local template_link = '[[Template:' .. template_name .. '|' .. template_name .. ']]';
local msg_prefix = '<code class="cs1-code">{{' .. template_link .. '}}</code>: ';

if 0 ~= #z.error_msgs_t then
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_e, {template_link, options_t.id}));

table.insert (render_t, ' '); -- insert a space between citation and its error messages
table.sort (z.error_msgs_t); -- sort the error messages list; sorting includes wrapping <span> and <code> tags; hidden-error sorts ahead of visible-error

local hidden = true; -- presume that the only error messages emited by this template are hidden
for _, v in ipairs (z.error_msgs_t) do -- spin through the list of error messages
if v:find ('cs1-visible-error', 1, true) then -- look for the visible error class name
hidden = false; -- found one; so don't hide the error message prefix
break; -- and done because no need to look further
end
end

z.error_msgs_t[1] = table.concat ({utilities.error_comment (msg_prefix, hidden), z.error_msgs_t[1]}); -- add error message prefix to first error message to prevent extraneous punctuation
table.insert (render_t, table.concat (z.error_msgs_t, '; ')); -- make a big string of error messages and add it to the rendering
end

if 0 ~= #z.maint_cats_t then
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_m, {template_link, options_t.id}));

table.sort (z.maint_cats_t); -- sort the maintenance messages list

local maint_msgs_t = {}; -- here we collect all of the maint messages

if 0 == #z.error_msgs_t then -- if no error messages
table.insert (maint_msgs_t, msg_prefix); -- insert message prefix in maint message livery
end
for _, v in ipairs( z.maint_cats_t ) do -- append maintenance categories
table.insert (maint_msgs_t, -- assemble new maint message and add it to the maint_msgs_t table
table.concat ({v, ' (', utilities.substitute (cfg.messages[':cat wikilink'], v), ')'})
);
end
table.insert (render_t, utilities.substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs_t, ' '))); -- wrap the group of maint messages with proper presentation and save
end

if not no_tracking_cats then
local sort_key;
local cat_wikilink = 'cat wikilink';
if cfg.enable_sort_keys then -- when namespace sort keys enabled
local namespace_number = mw.title.getCurrentTitle().namespace; -- get namespace number for this wikitext
sort_key = (0 ~= namespace_number and (cfg.name_space_sort_keys[namespace_number] or cfg.name_space_sort_keys.other)) or nil; -- get sort key character; nil for mainspace
cat_wikilink = (not sort_key and 'cat wikilink') or 'cat wikilink sk'; -- make <cfg.messages> key
end

for _, v in ipairs (z.error_cats_t) do -- append error categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
if cfg.id_limits_data_load_fail then -- boolean true when load failed
utilities.set_message ('maint_id_limit_load_fail'); -- done here because this maint cat emits no message
end
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v)); -- no sort keys
end
end

return table.concat (render_t); -- make a big string and done
end
end



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

Looks for a parameter's name in one of several whitelists.


Parameters in the whitelist can have three values:
Parameters in the whitelist can have three values:
第4,471行: 第1,731行:
]]
]]


local function validate (name, cite_class, empty)
local function validate (name)
local name = tostring (name);
local enum_name; -- parameter name with enumerator (if any) replaced with '#'
local state;
local state = whitelist.basic_arguments[name];

local function state_test () -- local function to do testing of state values; operates on the upvalues <state> and <name>
if true == state then return true; end -- valid actively supported parameter
if false == state then
if empty then return nil; end -- empty deprecated parameters are treated as unknowns
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
end
if 'tracked' == state then
local base_name = name:gsub ('%d', ''); -- strip enumerators from parameter names that have them to get the base name
utilities.add_prop_cat ('tracked-param', {base_name}, base_name); -- add a properties category; <base_name> modifies <key>
return true;
end
return nil;
end

if 'string' ~= type (name) or name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted; positional params are 'number' type; not supported
return nil;
end
-- replace enumerator digit(s) with # (|last25= becomes |last#=) (mw.ustring because non-Western 'local' digits)
enum_name = mw.ustring.gsub (name, '%d+$', '#'); -- where enumerator is last charaters in parameter name (these to protect |s2cid=)
enum_name = mw.ustring.gsub (enum_name, '%d+([%-l])', '#%1'); -- where enumerator is in the middle of the parameter name; |author#link= is the oddity

if 'document' == cite_class then -- special case for {{cite document}}
state = whitelist.document_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
if true == state_test () then return true; end
return false;
end

if utilities.in_array (cite_class, whitelist.preprint_template_list_t) then -- limited parameter sets allowed for these templates
state = whitelist.limited_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
if true == state_test () then return true; end

state = whitelist.preprint_arguments_t[cite_class][name]; -- look in the parameter-list for the template identified by cite_class
if true == state_test () then return true; end

return false; -- not supported because not found or name is set to nil
end -- end limited parameter-set templates

if utilities.in_array (cite_class, whitelist.unique_param_template_list_t) then -- template-specific parameters for templates that accept parameters from the basic argument list
state = whitelist.unique_arguments_t[cite_class][name]; -- look in the template-specific parameter-lists for the template identified by cite_class
if true == state_test () then return true; end
end -- if here, fall into general validation

state = whitelist.common_parameters_t[enum_name]; -- all other templates; all normal parameters allowed; this list holds enumerated and nonenumerated parameters
if true == state_test () then return true; end

return false; -- not supported because not found or name is set to nil
end


--[=[-------------------------< I N T E R _ W I K I _ C H E C K >----------------------------------------------

check <value> for inter-language interwiki-link markup. <prefix> must be a MediaWiki-recognized language
code. when these values have the form (without leading colon):
[[<prefix>:link|label]] return label as plain-text
[[<prefix>:link]] return <prefix>:link as plain-text

return value as is else

]=]

local function inter_wiki_check (parameter, value)
local prefix = value:match ('%[%[(%a+):'); -- get an interwiki prefix if one exists
local _;
-- Normal arguments
if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so
if true == state then return true; end -- valid actively supported parameter
utilities.set_message ('err_bad_paramlink', parameter); -- emit an error message
if false == state then
_, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink
deprecated_parameter (name); -- parameter is deprecated but still supported
end
return true;

return value;
end


--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------

Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal
sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a
parameter that is missing its pipe. There are two tests made:
{{cite ... |title=Title access-date=2016-03-17}} -- the first parameter has a value and whitespace separates that value from the missing pipe parameter name
{{cite ... |title=access-date=2016-03-17}} -- the first parameter has no value (whitespace after the first = is trimmed by MediaWiki)
cs1|2 shares some parameter names with XML/HTML attributes: class=, title=, etc. To prevent false positives XML/HTML
tags are removed before the search.

If a missing pipe is detected, this function adds the missing pipe maintenance category.

]]

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

capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
if capture and validate (capture) then -- if the capture is a valid parameter name
utilities.set_message ('err_missing_pipe', parameter);
end
end


--[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >--------------------------------------

look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked

]]

local function has_extraneous_punc (param, value)
if 'number' == type (param) then
return;
end
end
-- Arguments with numbers in them
param = param:gsub ('%d+', '#'); -- enumerated name-list mask params allow terminal punct; normalize
name = name:gsub ('%d+', '#'); -- replace digit(s) with # (last25 becomes last#
if cfg.punct_skip[param] then
state = whitelist.numbered_arguments[name];
return; -- parameter name found in the skip table so done
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
end
return false; -- Not supported because not found or name is set to nil
if value:match ('[,;:]$') then
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
end
if value:match ('^=') then -- sometimes an extraneous '=' character appears ...
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
end
end
end


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


This is used by templates such as {{cite book}} to create the actual citation text.
--[[--------------------------< H A S _ T W L _ U R L >--------------------------------------------------------

look for The Wikipedia Library urls in url-holding parameters. TWL urls are accessible only for readers who are
active extended confirmed Wikipedia editors. This function sets an error message when such urls are discovered
and when appropriate, sets the |<param>-url-access=subscription. returns nothing.

looks for: '.wikipedialibrary.idm.oclc.org'


]]
]]


local function has_twl_url (url_params_t, cite_args_t)
local function citation (frame)
local pframe = frame:getParent();
local url_error_t = {}; -- sequence of url-holding parameters that have a TWL url
local module_path = 'Module:Citation/CS1/'
local module_suffix = frame:getTitle():gsub ('^Module:Citation/CS1', '');
load_modules (module_path, module_suffix);
for param, value in pairs (url_params_t) do
if value:find ('%.wikipedialibrary%.idm%.oclc%.org') then -- has the TWL base url?
table.insert (url_error_t, param); -- add parameter name to the error list
end
end
if 0 ~= #url_error_t then -- non-zero when there are errors
table.sort (url_error_t); -- sor for error messaging
for i, param in ipairs (url_error_t) do
if cfg.url_access_map_t[param] then -- if <param> has a matching -access parameter
cite_args_t[cfg.url_access_map_t[param]] = cfg.keywords_xlate.subscription; -- set |<param>-url-access=subscription
end
url_error_t[i] = utilities.wrap_style ('parameter', param); -- make the parameter pretty for error message
end

utilities.set_message ('err_param_has_twl_url', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
end
end


--[[--------------------------< M I S C _ U R L _ D E T E C T >------------------------------------------------

look for miscellaneous urls that might be converted to, or are duplicates of, identifiers.

]]

local misc_url_patterns_t = {
'idm%.oclc%.org', -- but not wikipedialibrary.idm.oclc.org; has_twl_url()
'https?://citeseerx?%.ist%.psu%.edu/', -- simplified so we catch all citeseer and citeseerx urls except ~/document/... (the 'new' form)
}

local ignore_patterns_t = {
'wikipedialibrary.idm.oclc.org', -- handled by has_twl_url()
'https?://citeseerx?%.ist%.psu%.edu/document', -- 'new'-form citeseerx urls that mostly work; ignore for now
}

local function misc_url_detect (url_params_t)
local ignore_flag = false;

for _, value in pairs (url_params_t) do
for _, ignore_pattern in ipairs (ignore_patterns_t) do
if value:find (ignore_pattern) then -- matches this ignore_pattern?
ignore_flag = true; -- found a pattern to ignore
break; --
end
end

if not ignore_flag then -- if ignore_flag is set then don't bother to test this url <value>
for _, misc_pattern in ipairs (misc_url_patterns_t) do
if value:find (misc_pattern) then -- matches this misc_pattern?
utilities.set_message ('maint_misc_url'); -- found one; set the message
return; -- and done; no need to test other <value>s
end
end
end
ignore_flag = false; -- reset
end
end


--[[--------------------------< H A S _ E X T R A N E O U S _ U R L >------------------------------------------

look for extraneous url parameter values; parameters listed in skip table are not checked

]]

local function has_extraneous_url (non_url_param_t)
local url_error_t = {};
local args = {};
check_for_url (non_url_param_t, url_error_t); -- extraneous url check
local suggestions = {};
if 0 ~= #url_error_t then -- non-zero when there are errors
local error_reported = false;
table.sort (url_error_t);
utilities.set_message ('err_param_has_ext_link', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
end
end


local config = {};

for k, v in pairs (frame.args) do
--[[--------------------------< _ C I T A T I O N >------------------------------------------------------------
config[k] = v;

args[k] = v;
Module entry point
end

frame – from template call (citation()); may be nil when called from another module
args_t – table of all cs1|2 parameters in the template (the parent frame)
config_t – table of template-supplied parameter (the #invoke frame)

]]

local function _citation (frame, args_t, config_t) -- save a copy in case we need to display an error message in preview mode
if not frame then
frame = mw.getCurrentFrame(); -- if called from another module, get a frame for frame-provided functions
end
-- i18n: set the name that your wiki uses to identify sandbox subpages from sandbox template invoke (or can be set here)
local sandbox = ((config_t.SandboxPath and '' ~= config_t.SandboxPath) and config_t.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}}
is_sandbox = nil ~= string.find (frame:getTitle(), sandbox, 1, true); -- is this invoke the sandbox module?
sandbox = is_sandbox and sandbox or ''; -- use i18n sandbox to load sandbox modules when this module is the sandox; live modules else

cfg = mw.loadData ('Module:Citation/CS1/Configuration' .. sandbox); -- load sandbox versions of support modules when {{#invoke:Citation/CS1/sandbox|...}}; live modules else
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist' .. sandbox);
utilities = require ('Module:Citation/CS1/Utilities' .. sandbox);
validation = require ('Module:Citation/CS1/Date_validation' .. sandbox);
identifiers = require ('Module:Citation/CS1/Identifiers' .. sandbox);
metadata = require ('Module:Citation/CS1/COinS' .. sandbox);

utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module

z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
local cite_args_t = {}; -- because args_t is the parent (template) frame args (which cannot be modified); params and their values will be placed here

is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));

local suggestions = {}; -- table where we store suggestions if we need to loadData them
local error_text; -- used as a flag


local capture; -- the single supported capture when matching unknown parameters using patterns
local capture; -- the single supported capture when matching unknown parameters using patterns
for k, v in pairs (pframe.args) do
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
for k, v in pairs (args_t) do -- get parameters from the parent (template) frame
v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string
if v ~= '' then
if v ~= '' then
if not validate (k) then
if cfg.enum_needs_xlation and 'string' == type (k) then -- for wikis that set date_names['local_digits'] to non-western digits
error_reported = false;
k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- translate 'local' digits enumerators to Western 0-9
if type (k) ~= 'string' then
end
-- Exclude empty numbered parameters
if not validate( k, config_t.CitationClass ) then
if type (k) ~= 'string' then -- exclude empty numbered parameters
if v:match ('%S+') ~= nil then
append_error ('text_ignored', {v});
if v:match("%S+") ~= nil then
error_reported = true;
error_text = utilities.set_message ('err_text_ignored', {v});
end
end
elseif validate (k:lower(), config_t.CitationClass) then
elseif validate (k:lower()) then
append_error ('parameter_ignored_suggest', {k, k:lower()});
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, k:lower()}); -- suggest the lowercase version of the parameter
error_reported = true;
else
else
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
suggestions = mw.loadData ('Module:Citation/CS1/Suggestions' .. sandbox); --load sandbox version of suggestion module when {{#invoke:Citation/CS1/sandbox|...}}; live module else
suggestions = mw.loadData (module_path .. 'Suggestions' .. module_suffix);
end
end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
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 capture in pattern else the capture if a match
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
if capture then -- if the pattern matches
param = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
param = substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
append_error ('parameter_ignored_suggest', {k, param});
if validate (param, config_t.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists)
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message
-- set the error message
else
error_reported = true;
break;
error_text = utilities.set_message ('err_parameter_ignored', {k}); -- suggested param not supported by this template
v = ''; -- unset
end
end
end
end
end
if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an explicit suggestion?
if not error_reported then -- couldn't match with a pattern, is there an expicit suggestion?
if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], config_t.CitationClass) then
if suggestions.suggestions[k:lower()] ~= nil then
utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]});
append_error ('parameter_ignored_suggest', {k, suggestions.suggestions[k:lower()]});
error_reported = true;
else
else
utilities.set_message ('err_parameter_ignored', {k});
append_error ('parameter_ignored', {k});
error_reported = true;
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
end
end
end
end
end
end
end
end
args[k] = v;

elseif args[k] ~= nil or (k == 'postscript') then
cite_args_t[k] = v; -- save this parameter and its value
args[k] = v;

end
elseif not utilities.is_set (v) then -- for empty parameters
if not validate (k, config_t.CitationClass, true) then -- is this empty parameter a valid parameter
k = ('' == k) and cfg.err_msg_supl.empty_str or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text
table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list
end
end
end
end
local error_msg;

for k, v in pairs (args) do
if 0 ~= #empty_unknowns then -- create empty unknown error message
utilities.set_message ('err_param_unknown_empty', {
1 == #empty_unknowns and '' or 's',
utilities.make_sep_list (#empty_unknowns, empty_unknowns)
});
end

local non_url_param_t = {}; -- table of parameters and values that are not url-holding parameters
local url_param_t = {}; -- table of url-holding paramters and their values

for k, v in pairs (cite_args_t) do

if 'string' == type (k) then -- don't evaluate positional parameters
if 'string' == type (k) then -- don't evaluate positional parameters
has_invisible_chars (k, v); -- look for invisible characters
error_msg = has_invisible_chars (k, v);
if is_set (error_msg) then
end
append_error ('invisible_char', error_msg);
has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe?
cite_args_t[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label

if 'string' == type (k) then -- when parameter k is not positional
if not cfg.url_skip[k] then -- and not in url skip table
non_url_param_t[k] = v; -- make a parameter/value list for extraneous url check
else -- and is in url skip table (a url-holding parameter)
url_param_t[k] = v; -- make a parameter/value list to check for values that are The Wikipedia Library url
end
end
end
end
end
end

if cfg.suppress_archive_today_urls then
has_archive_today_url (cite_args_t); -- look for and suppress archive.today urls and dependent parameters for all templates
end
has_extraneous_url (non_url_param_t); -- look for url in parameter values where a url does not belong
has_twl_url (url_param_t, cite_args_t); -- look for url-holding parameters that hold a The Wikipedia Library url
misc_url_detect (url_param_t); -- look for url-holding parameters that hold certain miscellaneous urls

return table.concat ({
return table.concat ({
frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1' .. sandbox .. '/styles.css'}),
frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1/styles.css'}),
do_citation (config, args)
citation0 (config_t, cite_args_t)
});
});
end
end


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

Template entry point

]]

local function citation (frame)
local config_t = {}; -- table to store parameters from the module {{#invoke:}}
local args_t = frame:getParent().args; -- get template's preset parameters

for k, v in pairs (frame.args) do -- get parameters from the {{#invoke}} frame
config_t[k] = v;
-- args_t[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
end
return _citation (frame, args_t, config_t)
end



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


return {
return {citation = citation};
citation = citation, -- template entry point
_citation = _citation, -- module entry point
}

2026年11月19日 (四) 16:23的最新版本


此模块及关联的子页面为引文格式1和引文格式2引用模板提供支持。通常来说不应直接调用此模块,而是用CS1与CS2模板调用。

如下文件涉及对CS1与CS2引用模板的支持:

CS1 | CS2模块
线上 沙盒 描述
sysop Module:Citation/CS1 Module:Citation/CS1/sandbox 编辑 渲染及支持功能
Module:Citation/CS1/Configuration Module:Citation/CS1/Configuration/sandbox 编辑 翻译表;错误和标识符处理
Module:Citation/CS1/Whitelist Module:Citation/CS1/Whitelist/sandbox 编辑 现行与已过时不推荐使用的CS1与CS2参数
Module:Citation/CS1/Date validation Module:Citation/CS1/Date validation/sandbox 编辑 日期格式验证函数
Module:Citation/CS1/Identifiers Module:Citation/CS1/Identifiers/sandbox 编辑 支持命名标识符(ISBN、DOI、PMID等)的函数
Module:Citation/CS1/Utilities Module:Citation/CS1/Utilities/sandbox 编辑 常用函数及表
Module:Citation/CS1/COinS Module:Citation/CS1/COinS/sandbox 编辑 支持CS1与CS2模板元数据渲染的函数
Silver padlock Module:Citation/CS1/styles.css Module:Citation/CS1/sandbox/styles.css 编辑 为CS1与CS2模板提供CSS样式
Module:Citation/CS1/Suggestions Module:Citation/CS1/Suggestions/sandbox 编辑 将常见错误参数名映射到有效参数名的列表


其他文档:

测试用例


--[[--------------------------< 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, ref)
	if not is_set (ps) then														-- unless explicitely set to something
		ps = '.';																-- terminate the rendered citation with a period
	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 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, ref = set_cs1_style (ps, ref);
	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, ref = set_cs1_style (ps, ref);
	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.

]]

local 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 table.concat ({
		frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1/styles.css'}),
		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};