求真百科歡迎當事人提供第一手真實資料,洗刷冤屈,終結網路霸凌。

變更

前往: 導覽搜尋

模块:Citation/CS1

移除 21,413 位元組, 5 年前
測試
local z = { error_categories = {}; -- for categorizing citations that contain errors error_ids cs1 = {}; message_tail = {}; maintenance_cats = {}; -- for categorizing citations that aren't erroneous per se, but could use a little work properties_cats = {}; -- for categorizing citations based on certain properties, language of source for instance}
--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
]]
local dates, year_date_check -- functions in Module:Citation/CS1/Date_validation
local cfg = {}; dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- table of configuration tables that are defined functions in Module:Citation/CS1/ConfigurationDate_validationlocal whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist date_name_xlate
local is_set, in_array, substitute, error_comment, set_error, select_one, --[[--------------------------< I S _ S E T >------------------------------------------------------------------functions in Module:Citation/CS1/Utilities add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink;
Returns true if argument is setlocal z ={}; false otherwise. Argument is 'set' when it exists ( -- tables in Module:Citation/CS1/Utilities local extract_ids, extract_id_access_levels, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configurationlocal whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist  --[[--------------------------< P A G E S C O P E V A R I A B L E S >-------------------------------------- delare variables here that have page-wide scope that are not nil) or when it is not an empty string.brought in from other modules; thatare created hereThis function is global because it is called from both this module and from Date validationused here
]]
function is_set( var ) return not (var == nil or var =local added_deprecated_cat; -- boolean flag so that the category is added only oncelocal added_prop_cats = {}; -- list of property categories that have been added to z.properties_catslocal added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category local Frame; -- holds the module'');s frame tableend
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
end
--[[--------------------------< I N _ A R R A Y >--------------------------------------------------------------
Whether needle --[[--------------------------< A D D _ P R O P _ C A T >-------------------------------------------------------- Adds a category to z.properties_cats using names from the configuration file with additional text if any. foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languagesmay be categorized but multiples of the same language are not categorized. added_prop_cats is a table declared in haystackpage scope variables above
]]
local function in_arrayadd_prop_cat ( needlekey, haystack arguments) if needle not added_prop_cats [key] then added_prop_cats [key] =true; -- note that we've added this category key = nil thenkey:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname return falsetable.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
end
for n,v in ipairs( haystack ) do
if v == needle then
return n;
end
end
return false;
end
--[[--------------------------< S U B S T I T U T E >----------------------------------------------------------
Populates numbered arguments in a message string using an argument table.--[[--------------------------< 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.
local function substitute( msg, args ) return args and mw.message.newRawMessage( msg, args ):plain() or msg;endadded_vanc_errs is a boolean declared in page scope variables above
--[[--------------------------< E R R O R _ C O M M E N T >----------------------------------------------------]]
Wraps error messages with css markup according to the state of hidden. ]]local function error_commentadd_vanc_error ( content, hidden source) return substitute( hidden and cfg.presentation['hiddenif not added_vanc_errs then added_vanc_errs = true; --errornote that we'] or cfgve added this category table.presentation[insert( z.message_tail, { set_error( 'visible-errorvancouver'], content {source}, true ) } ); end
end
--[[--------------------------< S E T _ E R R O R >--------------------------------------------------------------
Sets an error condition and returns the appropriate error message. The actual placement of the error message in the output isthe responsibility of the calling function.--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
]]local function set_error( error_id, arguments, raw, prefix, suffix ) local error_state = cfg.error_conditions[ error_id ]; prefix = prefix or ""; suffix = suffix or ""; does this thing that purports to be a uri scheme seem to be a valid scheme? The scheme is checked to see if error_state == nil thenit error( cfgis in agreement with http://tools.messages['undefined_error'] ); elseif is_set( error_stateietf.category ) then table.insert( z.error_categories, error_stateorg/html/std66#section-3.category );1 which says: endScheme names consist of a sequence of characters beginning with a local message = substitute( error_state.message letter and followed by any combination of letters, digits, arguments ); plus message = message .. " ([[" .. cfg.messages['help page link'] .. +"#" .. error_state.anchor .. "|), period (" .. cfg.messages['help page label'] .. "]])"; z.error_ids[ error_id ] = true; if in_array( error_id, { 'bare_url_missing_title', 'trans_missing_title' } ) and z.error_ids['citation_missing_title'] then return '', false; end message = table.concator hyphen ({ prefix, message, suffix }"-"); if raw == true then return message, error_state.hidden; end return error_comment( message, error_state.hidden );end
--[[--------------------------< A D D _ M A I N T _ C A T >------------------------------------------------------ Adds a category to z.maintenance_cats using names from the configuration file with additional text returns true if any.To prevent duplicationit does, the added_maint_cats table lists the categories by key that have been added to z.maintenance_cats.else false
]]
local added_maint_cats = {} -- list of maintenance categories that have been added to z.maintenance_catslocal function add_maint_cat is_scheme (key, argumentsscheme) if not added_maint_cats return scheme and scheme:match ('^%a[key] then added_maint_cats [key%a%d%+%.%-] = true; -- note that we*:'ve added this category table.insert( z.maintenance_cats, substitute (cfg.maint_cats [key], arguments)); -- make name then add to table endtrue if scheme is set and matches the pattern
end
--[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------
Adds a category to z.properties_cats using names from the configuration file with additional text if any.--[=[-------------------------< 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?
local added_prop_cats = {} Syntax defined here: http://tools.ietf.org/html/rfc1034#section-- list of property categories that have been added to z3.5BNF defined here: https://tools.ietf.properties_catsorg/html/rfc4234local function add_prop_cat (key, arguments)Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15; if not added_prop_cats see also [key] then added_prop_cats [key] = true; Single-letter second- note that we've added this categorylevel domain]] table.insert( zlist of tlds: https://www.properties_cats, substitute (cfgiana.prop_cats [key], arguments)); -- make name then add to table endendorg/domains/root/db
--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit. Betweenthe first and last characters the name may use letters, digits, and the hyphen.
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 emittedAlso 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. tldis two or more alpha characters. Any preceding '//' (from splitting a url with a scheme) will be strippedhere. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal.
local added_vanc_errs; 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-- flag so we only emit one Vancouver error / categorylocal function add_vanc_error ASCII Compatible Encoding (ACE) prefix xn-- in the tld)see https://tools.ietf.org/html/rfc3490 if not added_vanc_errs then added_vanc_errs = true; single-letter/digit second- note that we've added this categorylevel domains in the .org and .cash TLDs table q, x, and z SL domains in the .insert( zcom TLD i and q SL domains in the .message_tail, { set_errornet TLD single-letter SL domains in the ccTLDs ( 'vancouver', {}, true where the ccTLD is two letters) } two-character SL domains in gTLDs (where the gTLD is two or more letters); endthree-plus-character SL domains in gTLDs (where the gTLD is two or more letters)end 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
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------]=]
does this thing that purports local function is_domain_name (domain) if not domain then return false; -- if not set, abandon end domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once if not domain:match ('^[%a%d]') then -- first character must be letter or digit return false; end -- Do most common case first if domain:match ('%f[%a%d][%a%d][%a uri scheme seem to be %d%-]+[%a%d]%.%a%a valid scheme? The scheme is checked to see if it+$') then -- three or more character hostname.hostname or hostname.tld return true;is in agreement elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with httpACE prefix return true; elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character//toolsdigit .ietfcash hostname return true; elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character/html/std66#sectiondigit .org hostname return true; elseif domain:match ('%f[%a][qxz]%.com$') then --3assigned one character .com hostname (x.1 which sayscom times out 2015-12-10) return true; elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10) return true; Scheme names consist of elseif domain:match ('%f[%a%d][%a%d]%.%a sequence of characters beginning with %a$') then -- one character hostname and cctld (2 chars) letter and followed by any combination of letters, digits, plus return true; elseif domain:match ("'%f[%a%d][%a%d][%a%d]%.%a%a+"$'), period then -- two character hostname and tld return true; elseif domain:match ("'^%d%d?%d?%."%d%d?%d?%.%d%d?%d?%.%d%d?%d?'), or hyphen ("then --").IPv4 address return true; else return false; endend
returns true if it does, else false
]]--[[--------------------------< 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 thatare not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted externalwikilinks. ]] local function is_scheme is_url (scheme, domain) if is_set (scheme) then -- if scheme is set check it and domain return is_scheme (scheme ) and scheme:match is_domain_name (domain); else return is_domain_name ('^%a[%a%d%+%.%-]*:'domain); -- true if scheme not set when url is set and matches the patternprotocol relative end
end
--[=[--------------------------< I S _ D O M A P L I N T _ N A M E U R L >------------------------------------------------------------ Split a url into a scheme, authority indicator, and domain.
Does this thing that purports to be First remove Fully Qualified Domain Name terminator (a domain name seem to be a valid domain namedot following tld) (if any) and any path(/), query(?) or fragment(#).
Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5BNF defined here: https://tools.ietf.org/html/rfc4234Single 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 If protocol relative url, return nil scheme and domain else return nil for both scheme and domain]]list of tlds: https://www.iana.org/domains/root/db
rfc952 (modified by rfc 1123) requires the first When not protocol relative, get scheme, authority indicator, and last character of a hostname to be a letter or a digitdomain. BetweenIf there is an authority indicator (onethe first and last or more '/' characters immediately following the name may use lettersscheme's colon), digits, and the hyphenmake sure that there are only 2.
Also allowed are IPv4 addresses. IPv6 not supportedStrip off any port and path;
]] local function split_url (url_str) local scheme, authority, domain is expected to be stripped of any ; url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path so that the last character in (/), query(?), fragment (#) (the last character capture prevents false replacement of the tld. tld'//')  if url_str:match ('^//%S*') then -- if there is two or more alpha characters. Any preceding what appears to be a protocol relative url domain = url_str:match ('^//(%S*)' ) elseif url_str:match (from splitting '%S-:/*%S+') then -- if there is what appears to be a url scheme, optional authority indicator, and domain name scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing; if 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 domain = domain:gsub ('(%a ):%d+', '%1'); -- strip port number if present end return scheme) will be stripped, domain;here. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal.end
There are several tests:
the first character of the whole domain name including subdomains must be a letter or a digit
single-letter/digit second-level domains in the .org TLD
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--[[--------------------------< 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
local function is_domain_name (domain) if not domain then return false; -- if not set, abandon end domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have Link parameters are to do it once if not domain:match ('^[%hold the title of a%d]') then -- first character must be letter or digit return false; end if domainwikipedia article so none of the WP:match ('%f[%a%d][%a%d]%.org$') then -- one character .org hostname return true; elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10) return true; elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10) return true; elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix return true; elseif domainTITLESPECIALCHARACTERS are allowed:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname return true; elseif domain:match ('%f# < > [%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars) return true;| { } _ elseif domain:match ('%f[%a%d][%a%d][%except the underscore which is used as a%d]%.%a%a+$') then -- two character hostname space in wiki urls and tld return true; elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$') then -- three or more character hostname.hostname or hostname.tld return true; elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address return true; else return false; endend# 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 |< I S _ U R L param>------------------------------------------------------------------link= parameter is NOT ok).
returns true if the scheme and domain parts of a url appear to be a valid url; else false.]]
This local function is the last step in the validation process. This function is separate because there are cases thatare not covered by split_urllink_param_ok (value) local scheme, for example is_parameter_ext_wikilinkdomain; if value:find ('[<>%[%]|{}]') which is looking for bracketted externalthen -- if any prohibited characters return false;wikilinks. end
]] local function is_url ( scheme, domain) if is_set = split_url (schemevalue) then ; -- if get scheme is set check it or nil and domain return is_scheme (scheme) and is_domain_name (domain)or nil from url; else return is_domain_name not is_url (scheme, domain); -- scheme not set when return true if value DOES NOT appear to be a valid url is protocol relative end
end
--[[--------------------------< S P L I N K _ T I T L E _ U R L O K >------------------------------------------------------------
Split a url into a scheme, authority indicator, Use link_param_ok() to validate |<param>-link= value and domain.If protocol relative url, return nil scheme and domain else return nil for both scheme and domainits matching |<title>= value.
When |<title>= may be wikilinked but not protocol relative, get scheme, authority indicator, and domainwhen |<param>-link= has a value. If there is This function emits an authority indicator (oneerror message whenor more '/' characters following the scheme's colon), make sure that there are only 2.condition exists
]]
local function split_url link_title_ok (url_str) local schemelink, authoritylorig, domain; url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$'title, '%1'torig)local orig; -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
if url_str:match is_set ('^//%S*'link) then -- don't bother if there is what appears to be <param>-link doesn't have a protocol relative urlvalue domain = url_str:match ('^//(%S*)') elseif url_str:match if not link_param_ok ('%S-:/*%S+'link) then -- if there is what appears to be a scheme, optional authority indicator, and domain namecheck |<param>-link= markup scheme, authority, domain orig = url_str:match ('(%S-:)(/*)(%S+)')lorig; -- extract identify the scheme, authority indicator, and domain portionsfailing link parameter authority = authorityelseif title:gsub find ('//', '', 1); -- replace place 1 pair of %[%['/' with nothing; if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) thencheck |title= for wikilink markup return schemeorig = torig; -- return scheme only making domain nil which will cause an error messageidentify the failing |title= parameter
end
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
end
return scheme, domain;
end
 --[[--------------------------< 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 is_set (theorig) then|<param>-link= parameter is ok); else false when value appears to be a valid url table.insert(the |<param>-link= parameter is NOT ok)z]] local function link_param_ok (value) local schememessage_tail, domain; if value:find { set_error('[<>%[%]|{bad_paramlink', orig)}]') then ; --url or wikilink in |title= with |title- if any prohibited characters return falselink=;
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
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 scheme, domain;
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from url; if 'news:' == scheme then -- special case for newsgroups return domain:match('^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$'); end
return is_url (scheme, domain); -- return true if value appears to be a valid url
end
local function is_parameter_ext_wikilink (value)
local scheme, domain;
 
value = value:gsub ('([^%s/])/[%a%d].*', '%1'); -- strip path information (the capture prevents false replacement of '//')
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*%.%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz] scheme, domain = split_url (value:match ('%f[%[]%[(//(%S*%.%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*%.%S+') then -- if protocol relative bare url: //yyyyy.zzz; may have leading or trailing plain text scheme, domain = split_url (value:match ('(//(%S*%.%S+)')); -- what is left should be the domain
else
return false; -- didn't find anything that is obviously a url
--[[--------------------------< S A F E _ F O R _ I T A U R L I C S >------------------------------------------------------
Protects a string Escape sequences for content that will be wrapped in wiki italic markup '' ... '' Note: We cannot use <i> used for italics, as the expected behavior for italics specified by ''...'' in the title is thatthey will be inverted (i.e. unitalicized) in the resulting references. In addition, <i> and '' tend to interactpoorly under Mediawiki's HTML tidy.URL descriptions
]]
local function safe_for_italics( str ) if not is_set(str) then return str; else if str:sub(1,1) == "'" then str = "<span></span>" .. str; end if str:sub(-1,-1) == "'" then str = str .. "<span></span>"; end -- Remove newlines as they break italics. return str:gsub( '\n', ' ' ); endend --[[--------------------------< 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
table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } );
end
end
--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------
 
Applies styling to various parameters. Supplied string is wrapped using a message_list configuration taking one
argument; protects italic styled parameters. Additional text taken from citation_config.presentation - the reason
this function is similar to but separate from wrap_msg().
 
]]
 
local function wrap_style (key, str)
if not is_set( str ) then
return "";
elseif in_array( key, { 'italic-title', 'trans-italic-title' } ) then
str = safe_for_italics( str );
end
 
return substitute( cfg.presentation[key], {str} );
end
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
]]
local function external_link( URL, label, source , access)
local error_str = "";
local domain;
local path;
local base_url;
if not is_set( label ) then
label = URL;
error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str;
end
return table domain, path = URL:match ('^([/%.concat%-%+:%a%d]+)([/%?#].*)$'); -- split the url into scheme plus domain and path if path then -- if there is a path portion path = path:gsub ('[%[%]]', { "["'[']='%5b', [']']='%5d'}); -- replace '[' and ']' with their percent encoded values URL=domain..path; -- and reassemble end if is_set (access) then -- access level (subscription, " "registration, limited) label = safe_for_url( label ), "]", error_str });end -- replace square brackets and newlines
base_url = table.concat ( --assemble external link with access signal { '<span class="plainlinks">[[-------------', --opening css and url markup URL, --the url ' ', --the required space label, '<span style="padding-left:0.15em">', --signal spacing css cfg.presentation[access], --the appropriate icon '</span>', --close signal spacing span ']< E X T E R N A L _ L I N K _ I D /span>' ----------------------------------------------close url markup and plain links span Formats a wiki style external link ]] local function external_link_id(options }) local url_string = options.id; if options.encode == true or options.encode == nil thenelse url_string base_url = mwtable.uri.encodeconcat({ "[", URL, " ", safe_for_url( url_string label ), "]" });-- no signal markup
end
return mw.ustringtable.formatconcat( '[%s%s%s \<span title\=\"%s\"\>%s%s%s\<\/span\>]', options.prefix, url_string, options.suffix or ""{ base_url, options.link, options.label, options.separator or "&nbsp;", mw.text.nowiki(options.id) error_str });
end
 
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
offending parameter name to the error message. Only one error message is emitted regardless of the number of deprecated
parameters in the citation.
 
added_deprecated_cat is a boolean declared in page scope variables above
]]
local page_in_deprecated_cat; -- sticky flag so that the category is added only once
local function deprecated_parameter(name)
if not page_in_deprecated_cat added_deprecated_cat then page_in_deprecated_cat added_deprecated_cat = true; -- note that we've added this category
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
end
end
--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
--[=[-------------------------< K E R N _ Q U O T E S >-------------------------------------------------------- Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value. 
This function will positive kern either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
Double single quotes (italic or bold wikimarkup) are not kerned.
 
Replaces unicode quotemarks 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 cap='';
local cap2='';
local wl_type, label, link;
 
wl_type, label, link = is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
cap, cap2 if 1 == str:wl_type then -- [[D]] simple wikilink with or without quote marks if mw.ustring.match (str, '%[%[[\"^(“”\'‘’].+[\"“”\'‘’]%]%]')then -- leading and trailing quote marks str = substitute (cfg.presentation['kern-wl-both'], str); elseif mw.ustring.match (str, '%[%[[^\"“”\'‘’].+%]%]')"); then -- match leading double or single quote but not double single quotesmarks str = substitute (cfg.presentation['kern-wl-left'], str); if is_set elseif mw.ustring.match (capstr, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks str = substitute (cfg.presentation['kern-leftwl-right'], {capstr); end  else -- plain text or [[L|D]]; text in label variable label= mw.ustring.gsub (label, cap2}'[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark) end label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup) if is_set (cap) then label = substitute (cfg.presentation['kern-left'], {cap, cap2}); end cap, cap2 = str:mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup) if is_set (cap) then str label = substitute (cfg.presentation['kern-right'], {cap, cap2}); end if 2 == wl_type then str = make_wikilink (link, label); -- reassemble the wikilink else str = label; end
end
return str;
end
 
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
end
-- if we get this far we have prefix and script
name = mw.language.fetchLanguageName( lang, mw.getContentLanguage():getCode() "en" ); -- get language name so that we can use it to categorize
if is_set (name) then -- is prefix a proper ISO 639-1 language code?
script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script
-- is prefix one of these language codes?
if in_array (lang, {'ar', 'bg', 'bs', 'dv', 'el', 'fa', 'he', 'hy', 'ja', 'ka', 'ko', 'ku', 'mk', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}cfg.script_lang_codes) then
add_prop_cat ('script_with_name', {name, lang})
else
lang = ''; -- invalid so set lang to empty string
end
end
if is_set(script_value) then
script_value = '-{R|' .. script_value .. '}-';
end
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
return script_value;
end
 
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
local function script_concatenate (title, script)
if is_set(title) then
title = '-{zh;zh-hans;zh-hant|' .. title .. '}-';
end
if is_set (script) then
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
--[[--------------------------< I S F O R M A T _ C H A P T E R _ T I T L I A S _ U S E D >-----------------------------------------------------
This function is used by select_one() to determine if one of a list of alias Format the four chapter parameters is in the argument listprovided by the template. Input: args – pointer to the arguments table from calling template alias – one of the list of possible aliases in the aliases lists from Module:Citation/CS1/Configuration index – for enumerated parameters|script-chapter=, |chapter=, |trans-chapter=, identifies which oneand |chapter-url= into a single Chapter meta- enumerated – true/false flag parameter (chapter_url_source used choose how enumerated aliases are examined value – value associated with an alias that has previously been selected; nil if not yet selected selected – the alias that has previously been selected; nil if not yet selected error_list – list of aliases that are duplicates of the alias already selected Returns: value – value associated with alias we selected or that was previously selected or nil if an alias not yet selected selected – the alias we selected or the alias that was previously selected or nil if an alias not yet selectedfor error messages).
]]
local function is_alias_used format_chapter_title (argsscriptchapter, aliaschapter, indextranschapter, enumeratedchapterurl, valuechapter_url_source, selectedno_quotes, error_listaccess) local chapter_error = ''; if enumerated not is_set (chapter) then -- is this a test for an enumerated parameters? alias chapter = alias:gsub ('#', index); -- replace '#' with the value in indexto be safe for concatenation
else
alias if false = alias:gsub = no_quotes then chapter = kern_quotes ('#', ''chapter); -- remove if necessary, separate chapter title'#s leading and trailing quote marks from Module provided quote marks chapter = wrap_style (' if it existsquoted-title', chapter); end
end
if is_setchapter = script_concatenate (args[alias]chapter, scriptchapter) then -- alias <bdi> tags, lang atribute, categorization, etc; must be done after title is in the template's argument listwrapped  if value ~= nil and selected ~= alias is_set (transchapter) then -- if we have already selected one of the aliases local skip; for _, v in ipairs transchapter = wrap_style (error_list) do 'trans-quoted- spin through the error list to see if wetitle've added this alias, transchapter); if v == alias is_set (chapter) then skip chapter = truechapter .. ' ' .. transchapter; break; else -- has been added so stop looking end end if not skip then -- has not been added so table.insert( error_list, alias ); -here when transchapter without chapter or script- add error alias to the error listchapter end else value chapter = args[alias]transchapter; -- not yet selected an alias, so select this one selected chapter_error = alias' ' .. set_error ('trans_missing_title', {'chapter'});
end
end
return value, selected; -- return newly selected alias, or previously selected alias
end
if is_set (chapterurl) then
chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
end
--[[--------------------------< S E L E C T _ O N E >---------------------------------------------------------- return chapter .. chapter_error;end
Chooses one matching parameter from a list of parameters to consider. The list of parameters to consider is just
names. For parameters that may be enumerated, the position of the numerator in the parameter name is identified
by the '#' so |author-last1= and |author1-last= are represented as 'author-last#' and 'author#-last'.
Because enumerated parameter |--[[--------------------------<paramH A S _ I N V I S I B L E _ C H A R S >1= is an alias of |<param>= we must test for both possibilities.----------------------------------------
This function searches a parameter's value for nonprintable or invisible characters. The search stops at the
first match.
Generates an error if more than one match This function will detect the visible replacement character when it is presentpart 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().
local function select_one( args, aliases_list, error_condition, index ) local value = nil; -- Detects but ignores the value assigned to character pattern that results from the selected parameter local selected = ''; -- the name transclusion of the parameter we have chosen local error_list = {{'}};templates.
if index ~= nil then index = tostringOutput of this function is an error message that identifies the character or the Unicode group, or the stripmarkerthat was detected along with its position (indexor, for multi-byte characters, the position of its first byte); endin theparameter value.
for _, alias in ipairs( aliases_list ) do -- for each alias in the aliases list if alias:match ('#') then -- if this alias can be enumerated if '1' == index then -- when index is 1 test for enumerated and non-enumerated aliases value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); -- first test for non-enumerated alias end value, selected = is_alias_used (args, alias, index, true, value, selected, error_list); -- test for enumerated alias else value, selected = is_alias_used (args, alias, index, false, value, selected, error_list); --test for non-enumerated alias end end]]
local function has_invisible_chars (param, v) if #error_list > 0 and local position = 'none' ~= error_condition then ; -- position of invisible char or starting position of stripmarker local dummy; -- for cases where this code end of matching string; not used but required to hold end position when a capture is returned local capture; -- used outside by stripmarker detection to hold name of extract_names()the stripmarker local error_str i= ""1; for _ local stripmarker, k in ipairsapostrophe; capture = string.match ( error_list v, '[%w%p ]*') do; -- Test for values that are simple ASCII text and bypass other tests if true if error_str ~capture == "" v then error_str -- if same there are no unicode characters return; end  while cfg.invisible_chars[i] do local char= error_str .cfg. invisible_chars[i][1] -- the character or group name local pattern=cfg.messagesinvisible_chars[i]['parameter2] --separator'] endthe pattern used to find it error_str position, dummy, capture = error_str mw.ustring. wrap_style find (v, pattern) -- see if the parameter value contains characters that match the pattern if position and (char == 'parameterzero width joiner') then -- if we found a zero width joiner character if mw.ustring.find (v, kcfg.indic_script)then -- its ok if one of the indic scripts position = nil; -- unset position end end if #error_list > 1 position then if 'nowiki' == capture or 'math' == capture then -- nowiki, math stripmarker (not an error condition) stripmarker = true; -- set a flag elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker position = nil; -- unset error_str else local err_msg; if capture then err_msg = error_str .capture . cfg.messages['parameter-final-separator'].. char; else error_str err_msg = error_str char .. cfg' ' .. 'character'; end  table.insert( z.messages[message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } ); -pair-separator']add error message return; -- and done with this parameter end
end
error_str i= error_str .. wrap_style ('parameter', selected); table.insert( z.message_tail, { set_error( error_condition, {error_str}, true ) } )i+1; -- bump our index
end
return value, selected;
end
--[[--------------------------< F O A R G U M A E N T _ C H W R A P T P E R _ T I T L E >----------------------------------------------
Format Argument wrapper. This function provides support for argument mapping defined in the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a configuration file so thatmultiple names can be transparently aliased to single Chapter meta-parameter (chapter_url_source used for error messages)internal variable.
]]
local function format_chapter_title argument_wrapper(scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotesargs ) local chapter_error origin = ''{};
if not is_set return setmetatable(chapter) then{ chapter ORIGIN = ''; -- to be safe for concatenation else if false == no_quotes thenfunction( self, k ) chapter local dummy = kern_quotes (chapter)self[k]; -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marksforce the variable to be loaded. chapter = wrap_style ('quoted-title', chapter)return origin[k];
end
end}, { chapter __index = script_concatenate function (chaptertbl, scriptchapterk ) -- <bdi> tags if origin[k] ~= nil then return nil; end local args, lang atributelist, categorizationv = args, etccfg.aliases[k]; must be done after title is wrapped if is_set type(transchapterlist ) == 'table' then transchapter v, origin[k] = wrap_style select_one(args, list, 'trans-quoted-titleredundant_parameters', transchapter); if is_set (chapter) origin[k] == nil then chapter origin[k] = chapter .. ' ' .. transchapter; else -- here when transchapter without chapter or script-chapterEmpty string, not nil end chapter elseif list ~= transchapternil then v, origin[k] = args[list], list; else -- maybe let through instead of raising an error? chapter_error -- v, origin[k] = ' ' args[k], k; error( cfg.. set_error (messages['trans_missing_titleunknown_argument_map', {'chapter'}] ); end end -- Empty strings, not nil; if is_set (chapterurl) v == nil then chapter v = cfg.defaults[k] or ''; origin[k] = ''; end tbl = external_link rawset(chapterurltbl, chapterk, chapter_url_sourcev ); -- adds bare_url_missing_title error if appropriate return v; end, return chapter .. chapter_error});
end
--[[--------------------------< 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 nonprintable or invisible characters. The search stops at thefirst match.--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
This function will detect the visible replacement character when it is part Looks for a parameter's name in one of the wikisourceseveral whitelists.
Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (galleryParameters in the whitelist can have three values: true - active, mathsupported parameters false - deprecated, pre, ref)supported parameters nil - unsupported parameters and identifies them with a slightly different error message. See also coins_cleanup().]]
Detects but ignores the character pattern that results from the transclusion of {local function validate( name, cite_class ) local name = tostring( name ); local state; if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}} ) then -- limited parameter sets allowed for these templates state = whitelist.limited_basic_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
Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker if 'arxiv' == cite_class then -- basic parameters unique to these templates state = whitelist.arxiv_basic_arguments[name];that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the end if 'biorxiv' == cite_class then state = whitelist.biorxiv_basic_arguments[name]; end if 'citeseerx' == cite_class thenparameter value state = whitelist.citeseerx_basic_arguments[name]; end
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 -- limited enumerated parameters list name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) state = whitelist.limited_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
local function has_invisible_chars (param, v) return false; -- not supported because not found or name is set to nil end -- end limited parameter-set templates local position state = ''whitelist.basic_arguments[ name ]; -- position of invisible char or starting position of stripmarkerall other templates; all normal parameters allowed local dummyif true == state then return true; end -- end of matching stringvalid actively supported parameter if false == state then deprecated_parameter (name); not used -- parameter is deprecated but required to hold still supported return true; end position when a capture is returned local capture; -- used by stripmarker detection to hold name of the stripmarkerall enumerated parameters allowed local iname =1name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last# local stripmarker, apostrophestate = whitelist.numbered_arguments[ name ];
while cfg.invisible_chars[i] do local char=cfg.invisible_chars[i][1] -- the character or group name local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern if position then-- if 'nowiki' == capture or 'math' =true = capture or ('ref' == capture and 'quote' == param) state then -- nowiki, math, or quote param and ref stripmarker (not an error condition) if 'nowiki' == capture or 'math' == capture then -- nowiki, math stripmarker (not an error condition) stripmarker = return true; -- set a flag elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker position = nil; -- unsetvalid actively supported parameter elseif 'apostrophe' if false == char state then -- apostrophe template uses &zwj;, hair space and zero-width space apostrophe = true; elseif true == apostrophe and in_array deprecated_parameter (char, {'zero width joiner', 'zero width space', 'hair space'}) then position = nil; -- unset else local err_msg; if capture then err_msg = capture .. ' ' .. cfg.invisible_chars[i][3] or char; else err_msg = cfg.invisible_chars[i][3] or (char .. ' character'); end  table.insert( z.message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } name); -- add error message return; -- and done with this parameter endis deprecated but still supported end i=i+1return true; -- bump our index
end
return false; -- not supported because not found or name is set to nil
end
--[[--------------------------< A R G U M E N T _ O W R A P P _ D A T E R >-------------------------------------------------------- When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or isMMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
Argument wrapper. This function provides DOES NOT yet support for argument mapping defined in MMMM YYYY or any of the configuration file so thatmultiple names can be transparently aliased to single internal variabledate ranges.
]]
local function argument_wrappernowrap_date ( args date) local origin cap= {}''; local cap2='';  if date:match("^%d%d%d%d%-%d%d%-%d%d$") then date = substitute (cfg.presentation['nowrap1'], date);
return setmetatableelseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ({"^%d%d?%s*%a+%s+%d%d%d%d$") then ORIGIN cap, cap2 = functionstring.match ( selfdate, k "^(.*)%s+(%d%d%d%d)$"); local dummy date = selfsubstitute (cfg.presentation[k'nowrap2'], {cap, cap2}); end return date; end  --force [[--------------------------< 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 variable special case where it is desirable to be loadedomit 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 return origin[k]title_type = ""; -- if |type=none then type parameter not displayed
end
}, { __index = function ( tbl, k ) return title_type; -- if origin[k] ~|type= nil thenhas been set to any other value use that value return nil; end local args, list, v = args, return cfg.aliasestitle_types [kcite_class]; if type( list ) == 'table' then v, origin[k] = select_one( args, list, or 'redundant_parameters' ); if origin[k] == nil then origin[k] = ' -- set template's default title type; -- Empty else empty string, not nilfor concatenation end elseif list ~= nil then v, origin--[k] = args[list], list; else -- maybe let through instead of raising an error? -- v, origin[k] = args[k], k; error( cfg.messages['unknown_argument_map'] ); end -- Empty strings, not nil; if v == nil then v = cfg.defaults[k] or ''; origin[k] = ''; end tbl = rawset( tbl, k, v ); return v; end, });end--------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------
--[[--------------------------< V A L I D A T E >--------------------------------------------------------------Looks for Converts a parameter's name in the whitelist.hyphen to a dash
Parameters in the whitelist can have three values:
true - active, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
]]
local function validatehyphen_to_dash( name str ) 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 not is_set(namestr); -- parameter is deprecated but still supported return true; end -- Arguments with numbers in them name = nameor str:gsubmatch( "[%[%d+", "#]{}<>]" ); -- replace digit(s) with # (last25 becomes last# state ~= whitelist.numbered_arguments[ name ]; if true == state nil then return true; end -- valid actively supported parameter if false == state then deprecated_parameter (name); -- parameter is deprecated but still supported return truestr; end return falsestr:gsub( '-', '–' ); -- Not supported because not found or name is set to nil
end
-- Formats a wiki style internal linklocal function internal_link_id(options) return mw.ustring.format( '[[%s%s%s|\--------------------------<span title\=\"%s\"\S A F E _ J O I N >%s\<\/span\>%s%s]]', options.prefix, options.id, options.suffix or "", options.link, options.label, options.separator or "&nbsp;", mw.text.nowiki(options.id) );end------------------------------------------------------------
 --[[--------------------------< N O W R A P _ D A T E >-------------------------------------------------------- When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or isMMMM 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 Joins a sequence of the date rangesstrings together while checking for duplicate separation characters.
]]
local function nowrap_date safe_join(datetbl, duplicate_char ) local cap='';--[[ local cap2='';  if dateNote:match("^%d%d%d%d%-%d%d%-%d%d$") then date = substitute (cfgwe use string functions here, rather than ustring functions.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$") thenThis has considerably faster performance and should work correctly as cap, cap2 = string.match (date, "^( long as the duplicate_char is strict ASCII.*)%s+(%d%d%d%d)$"); The strings date = substitute (cfg in tbl may be ASCII or UTF8.presentation['nowrap2'], {cap, cap2}); end]]
return datelocal str = '';end --[[--------------------------< IS _ V A L I D _ I S X N >--------------------------- -------------------------- ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in check_isbn().If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,spaces and other non-isxn characters. ]] local function is_valid_isxn (isxn_str, len)output string local temp comp = 0; isxn_str = { isxn_str:byte(1, len) }''; -- make a table of byte values what does '0comp' → 0x30 .. mean? local end_chr = '9' → 0x39, 'X' → 0x58; len = len+1local trim; -- adjust to be a loop counter for i_, v value in ipairs( isxn_str tbl ) do -- loop through all of the bytes and calculate the checksum if v value == nil then value = ''; end if str == string.byte( "X" ) '' then -- if checkdigit output string is X empty str = value; -- assign value to it (compares first time through the byte loop) elseif value of ~= 'X' which is 0x58)then temp = temp + 10*if value:sub( len - i 1,1); == '<' then -- it represents 10 decimalSpecial case of values enclosed in spans and other markup. else temp comp = temp + tonumbervalue:gsub( string.char(v"%b<>", "" ) )*; -- remove html markup (len<span>string</span> -i> string) else comp = value; end end -- typically duplicate_char is sepc return temp % 11 if comp:sub(1,1) == 0; duplicate_char then -- returns true if calculation result is zeroend first charactier same as duplicate_char? why test first character? --[[ Because individual string segments often (always?) begin with terminal punct for th -- preceding segment: 'First element' .. 'sepc next element' .. etc? trim = false; end_chr = str:sub(-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 = str:sub(1,-2); --remove it elseif end_chr == "'" then --if it might be wikimarkup if str:sub(-3,-1) == duplicate_char .. "''" then --if last three chars of str are sepc'' str = str:sub(1, -4) .. "''"; --remove them and add back '' elseif str:sub(-5,-< IS _ V A L I D _ I S X N _ 1 3 >---------) == duplicate_char .. "]]''" then --if last five chars of str are sepc]]'' trim = true; --why? why do this and next differently from previous? elseif str:sub(-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 wikimarkup if str:sub(-3,-1) == duplicate_char .. "]]" then --if last three chars of str are sepc]] wikilink trim = true; elseif str:sub(-3,-1) == duplicate_char .. '"]' then --if last three chars of str are sepc"] quoted external link trim = true; elseif str:sub(-2,-1) == duplicate_char .. "]" then --if last two chars of str are sepc] external link trim = true; elseif str:sub(-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 str:sub(-2,-1) == duplicate_char .. " " then --if last two chars of str are <sepc><space> str = str:sub(1,-3); --remove them both end end
ISBN if trim then if value ~= comp then --13 and ISMN validator code calculates checksum across all 13 isbn/ismn digits including the check digitvalue does not equal comp when value contains html markup local dup2 = duplicate_char; if dup2:match( "%A" ) then dup2 = "%" ..dup2; end -- if duplicate_char not a letter then escape itIf the number is valid value = value:gsub( "(%b<>)" .. dup2, the result will be 0. Before calling this function"%1", isbn1 ) -13/ismn must be checked for length- remove duplicate_char if it follows html markup elseand stripped of dashes value = value:sub( 2, spaces and other non-isxn1 ); --13 charactersremove duplicate_char when it is first character end end end str = str ..value; --add it to the output string end end return str;]]end
local function is_valid_isxn_13 (isxn_str)
local temp=0;
isxn_str = { isxn_str:byte(1, 13) }; -- make a table of byte values '0' → 0x30 .. '9' → 0x39
for i, v in ipairs( isxn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) ); -- multiply odd index digits by 1, even index digits by 3 and sum; includes check digit
end
return temp % 10 == 0; -- sum modulo 10 is zero when isbn-13/ismn is correct
end
--[[--------------------------< C H E C K I S _ S U F F I S B N X >------------------------------------------------------------
Determines whether an ISBN string returns true is validsuffix is properly formed Jr, Sr, or ordinal in the range 2–9. Puncutation not allowed.
]]
local function check_isbnis_suffix ( isbn_str suffix) if nil ~= isbn_str:matchin_array ("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digitssuffix, hyphens{'Jr', or the uppercase X isbn_str = isbn_str:gsub( "-"'Sr', "" ):gsub( " "'2nd', "" '3rd'}); -- remove hyphens and spaces local len = isbn_str:len(); if len ~= 10 and len ~= 13 then return false; end  if len == 10 then if isbn_str:match( "^%d*X?$" ) == nil then return false; end return is_valid_isxn(isbn_str, 10); else local temp = 0; if isbn_stror suffix:match( "'^97[89]%d*dth$" ') == nil then return false; end -- isbn13 begins with 978 or 979; ismn begins with 979 return is_valid_isxn_13 (isbn_str)true;
end
return false;
end
--[[--------------------------< C H E C K _ I S M N >------------------------------------------------------------
Determines whether an ISMN string is valid. Similar to isbn-13, ismn is 13 digits begining 979-0[[--------------------------< I S _ G O O D _ V A N C _ N A M E >------------------------------------------... and uses thesame check digit calculations. See http://www.ismn-international.org/download/Web_ISMN_Users_Manual_2008-6.pdfsection 2, pages 9–12.
]]For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a nameuses characters that contain diacritical marks, those characters are to 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.These things are not currently possible in this module so are left to the editor to do.
local function ismn (id)This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets local handler = cfg[http://www.unicode.org/charts/PDF/U0000.id_handlers['ISMN'pdf C0 Controls and Basic Latin];0041–005A, 0061–007A local text;[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF local valid_ismn = true;[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F id=id[http:gsub( "[%s//www.unicode.org/charts/PDF/U0180.pdf Latin Extended- B]"0180–01BF, "" ); -- strip spaces, hyphens, and endashes from the ismn01C4–024F
if 13 ~|lastn= id:lenalso allowed to contain hyphens, spaces, and apostrophes. () or idhttp:match( "^9790%d*$" //www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) |firstn== nil then -- ismn must be 13 digits also allowed to contain hyphens, spaces, apostrophes, and begin 9790 valid_ismn = false; else valid_ismn=is_valid_isxn_13 (id); -- validate ismn endperiods
-- text This original test: if nil = internal_link_id({link = handlermw.link, label = handlerustring.labelfind (last, "^[A-Za-zÀ-ÖØ-öø- use this (or external version) when there is some place to link toƿDŽ-ɏ%- prefix%s%']*$") or nil ==handlermw.prefix,id=id,separator=handlerustring.separatorfind (first, encode=handler.encode}) text="^[[" A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.. handler.link .. "|" .. handler.label .. "]+[2-6%a]*$" ) thenwas written ouside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position.. handler.separator .. id; -- because no place The test has been rewritten to use decimal character escape sequence for the individual bytes of the unicode characters so that it is not necessaryto link use an external editor to yetmaintain this code.
if false == valid_ismn then text = text .. ' ' .. set_error\195\128-\195\150 – À-Ö ( 'bad_ismn' U+00C0–U+00D6 – C0 controls) \195\152-\195\182 – Ø- add an error message if the issn is invalidö (U+00D8-U+00F6 – C0 controls) end \195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B) return text;end\199\132-\201\143 – DŽ-ɏ (U+01C4-U+024F – Latin extended B)
--[[--------------------------< I S S N >----------------------------------------------------------------------]]
Validate and format an issnlocal function is_good_vanc_name (last, first) local first, suffix = first:match ('(. This code fixes the case where an editor -),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has included an ISSN in the citation but has separated the two groups of fourdigits with something that looks like a space. When that condition occurredgenerational suffix, the resulting link looked like this:get it
|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327] if is_set (suffix) then if not is_suffix (suffix) then add_vanc_error ('suffix'); return false; -- can't have spaces in not a name with an external linkappropriate suffix end endThis code now prevents that by inserting a hyphen at the issn midpoint if nil == mw. It also validates the issn for length and makes sure that the checkdigit agreeswith the calculated valueustring. Incorrect length find (8 digits)last, characters other than 0"^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-9 and X, %s%']*$") or checkdigit / calculated value mismatch will all cause a check issnerror message nil == mw. The issn is always displayed with a hyphenustring.find (first, even if the issn was given as "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then add_vanc_error ('non-Latin character'); return false; -- not a single group string of 8 digits.latin characters; Vancouver requires Romanization end; return true;end
]]
local function issn(id, e) local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate local handler; local text; local valid_issn = true; if e then handler = cfg.id_handlers['EISSN']; else handler = cfg.id_handlers['ISSN']; end--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
id=id:gsub( "[%sAttempts to convert names to initials in support of |name- –]", "" ); list-- strip spaces, hyphens, and endashes from the issnformat=vanc.
if 8 ~Names in |firstn= id:len() may be separated by spaces or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits longhyphens, containing only 0-9 or X in the last position valid_issn=false; -- wrong length or improper character else valid_issn=is_valid_isxn(idfor initials, 8); -- validate issn enda period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
if true == valid_issn then id = string.subVancouver style requires family rank designations ( idJr, 1II, 4 ) .. "-" .. string.sub( idIII, 5 etc); -- if validto be rendered as Jr, display correctly formatted version else id = issn_copy; -- if not valid2nd, use the show the invalid issn with error message end text = external_link_id({link = handler.link3rd, label = handleretc.label, prefix=handler See http://www.prefix,id=id,separator=handlerncbi.separator, encode=handlernlm.encode}) if false == valid_issn then text = text 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.. set_error( 'bad_issn' ) -- add an error message if the issn is invalid end return textend
--[[--------------------------< A M A Z O N >------------------------------------------------------------------ Formats a link to Amazon. Do simple error checking: asin must This function uses ustring functions because firstname initials may be mix any of 10 numeric or uppercase alphathe unicode Latin characters. If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digitisbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=.Error message if not 10 characters, if not isbn10, if mixed and first character is a digitaccepted by is_good_vanc_name ().
]]
local function amazonreduce_to_initials(id, domainfirst) local err_cat name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
if not id:name then -- if not initials and a suffix name = mw.ustring.match(first, "^[%d(%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]+)$") then err_cat = ' ' .. set_error ('bad_asin'); -- asin is not a mix of 10 uppercase alpha and numeric charactersit just intials? end  elseif name then -- if first is initials with or without suffix if id:match3 > mw.ustring.len ("^%d%d%d%d%d%d%d%d%d[%dX]$"name) then -- if 10-digit numeric (one or 9 digits with terminal X)two initials if check_isbnsuffix then -- if there is a suffix if is_suffix ( id suffix) then -- is it legitimate? return first; -- see if asin value is isbn10one or two initials and a valid suffix so nothing to do add_maint_cat else add_vanc_error ('ASINsuffix'); -- one or two initials with invalid suffix so error message return first; -- and return first unmolested end elseif not is_set (err_cat) thenelse err_cat = ' ' .. set_error ('bad_asin')return first; -- asin is not isbn10one or two initials without suffix; nothing to do
end
elseif not id:match("^%u[%d%u]+$") then
err_cat = ' ' .. set_error ('bad_asin'); -- asin doesn't begin with uppercase alpha
end
end if not is_set(domain) then domain = "com"; elseif in_array (domain, {'jp', 'uk'}) then -- Japan, United Kingdom domain = "co." .. domain; elseif in_array (domain, {'au', 'br', 'mx'}) if here then -- Australia, Brazil, Mexico domain = "com." .. domain; end local handler = cfg.id_handlers['ASIN']; return external_link_id({link=handler.link, label=handler.label, prefix=handler.prefix .. domain .. "/dp/", id=id, encode=handler.encode, separator = handler.separator}) .. err_cat;end --[[--------------------------< A R X I V >--------------------------------------------------------------------name has 3 or more uppercase letters so treat them as a word
See: http://arxiv.org/help/arxiv_identifier
format and error check arXiv identifier. There are three valid forms of the identifier:the first form local initials, names = {}, valid only between date codes 9108 and 0703 is: arXiv:<archive>.<class>/<date code><number><version>where: <archive> is a string of alpha characters - may be hyphenated{}; no other punctuation <class> is a string of alpha characters - may be hyphenated; no other punctuation <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year tables to hold name parts and MM is the month number January = 01 first digit of YY for this form can only 9 and 0initials <number> is a three-digit number <version> is a local i = 1 or more digit number preceded with a lowercase v; no spaces (undocumented) the second form, valid from April 2007 through December 2014 is: arXiv:<date code>.<number><version>where: <date code> is four digits in the form YYMM where YY is the last two digits of the four -digit year and MM is the month number January = 01 <number> is a four-digit counter for number <version> is a 1 or more digit number preceded with a lowercase v; no spacesof initials
the third form, valid from January 2015 is: arXiv:<date code>names = mw.text.<number><version>where: <date code> and <version> are as defined for 0704split (first, '[%s,]+'); --1412 <number> is split into a five-digit number]]table of names and possible suffix
local function arxiv (id, class) local handler = cfg.id_handlerswhile names['ARXIV'i];do -- loop through the table local year, month, version; local err_cat = ''; local text; if id:match("^%a[%a%.%-]+/[90]%d1 < i and names[01i]%d%d%d%d$") or id:match("^%a'[%a%.%-dJS]+/[90]%d[01drndth]+%d%d%d%dv%d+.?$"') then -- test for if not the 9108-0703 format w/ & w/o version yearfirst name, month = id:match("^%a[%and looks like a%.%-]+/suffix ([90]%dmay have trailing dot)( names[01i]%d)%d%d%d= names[v%di]*$"); year = tonumber:gsub (year); month = tonumber(month'%.', ''); if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or -- remove terminal dot if invalid year or invalid monthpresent if is_suffix ((91 == year and 7 > month) or (7 == year and 3 < month)names[i]) then -- if years ok, are starting and ending months ok?a legitimate suffix err_cat = table.insert (initials, ' ' .. set_error( 'bad_arxiv' names[i]); -- set add a separator space, insert at end of initials table break; -- and done because suffix must fall at the end of a name end -- no error messageif not a suffix; possibly because of Romanization
end
elseif id:match("^%d%d[01]%d%.%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%dv%d+$") then -- test for the 0704-1412 w/ & w/o version year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d[v%d]*$"); year = tonumber(year); month = tonumber(month); if ((7 3 > year) or (14 < year) or (1 > month or 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)i then table.insert ((7 == year) and (4 > month)) then --or -- when year is 07initials, is month invalid (before April)? err_cat = ' ' mw.ustring. set_errorsub( 'bad_arxiv' names[i],1,1)); -- set error messageinsert the intial at end of initials table
end
elseif id:match("^%d%d[01]%d%.%d%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$") then -- test for the 1501- format w/ & w/o version year, month i = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$"); year = tonumber(year); month = tonumber(month); if ((15 > year) or (i+1 > month or 12 < month)) then -- is year invalid or is month invalid? (doesn't test for future years) err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message end else err_cat = ' ' .. set_error( 'bad_arxiv' ); -- arXiv id doesn't match any formatbump the counter
end
return table.concat(initials) -- Vancouver format does not include spaces.
end
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
if is_set (class) then class = ' --[[' .. '//arxiv.org/archive/' .. class .. ' ' .. class .. ']]'; -- external link within square brackets, not wikilink else class = ''; -- empty string for concatenation end return text .. class;end----------------------< L I S T _ P E O P L E >-------------------------------------------------------
--[[lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)1. Remove all blanks.2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.3. If there is Formats a hyphen in the string: a. Remove it. b. Inspect the substring following (to the right list of) the people (removed) hyphene. Then (and assuming that steps 1 and 2 have been carried out): 1g. All these characters should be digits, and there should be six or less. (not done in this functionauthors / editors) 2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
Returns a normalized lccn for lccn() to validate. There is no error checking (step 3.b.1) performed in this function.
]]
local function normalize_lccn list_people(lccncontrol, people, etal) lccn local sep; local namesep; local format = control.format local maximum = control.maximum local lastauthoramp = lccn:gsub ("%s", "")control.lastauthoramp; -- 1. strip whitespace local text = {}
if nil ~= string.find (lccn,'/vanc') then lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it end  local prefix local suffix prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix  if nil ~= suffix format then -- if there was a hyphen suffix=string.rep("0", 6 -string.len (suffix)) .. suffix; -Vancouver- 3.b.2 left fill the suffix with 0s if suffix length less than 6 lccn=prefix..suffix; -- reassemble the lccn end return lccn; end --[[Format LCCN link and do simple error checking. LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; therightmost eight are always digits. http:like author//info-uri.info/registry/OAIHandlereditor name styling?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/ length = 8 then all digitslength = 9 then lccn[1] is lower case alphalength = 10 then lccn[1] and lccn[2] are both lower case alpha or both digitslength = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digitslength = 12 then lccn[1] and lccn[2] are both lower case alpha ]] local function lccn(lccn) local handler = cfg.id_handlers['LCCN']; local err_cat = ''; -- presume that LCCN is valid local id = lccn; -- local copy of the lccn  id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes) local len = id:len(); -- get the length of the lccn  if 8 == len then if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) err_cat = ' ' .. set_error( 'bad_lccn' ); -- set an error message end elseif 9 == len then -- LCCN should be adddddddd if nil == id:match("%l%d%d%d%d%d%d%d%d") then -- does it match our pattern? err_cat = ' ' .. set_error( 'bad_lccn' ); -- set an error message end elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ... if nil =sep = id:match("^%l%l%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message end end elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd if not (id:match("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message end elseif 12 == len then name-- LCCN should be aaddddddddddlist separator between authors is a comma if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern err_cat namesep = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message endlast/first separator is a space
else
err_cat sep = ' ;' .. set_error( -- name-list separator between authors is a semicolon namesep = 'bad_lccn, ' ); -- wrong length, set an error messagelast/first separator is <comma><space>
end
 
if not is_set (err_cat) and nil ~= lccn:find ('%s') then
err_cat = ' ' .. set_error( 'bad_lccn' ); -- lccn contains a space, set an error message
end
 
return external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
 
--[[
Format PMID and do simple error checking. PMIDs are sequential numbers beginning at 1 and counting up. This code checks the PMID to see that it
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
]]
 
local function pmid(id)
local test_limit = 30000000; -- update this value as PMIDs approach
local handler = cfg.id_handlers['PMID'];
local err_cat = ''; -- presume that PMID is valid
if idsep:matchsub(-1,-1) ~= "[^%d]") then -- if PMID has anything but digits err_cat sep = ' ' sep .. set_error( 'bad_pmid' ); -- set an error message" " end else -- PMID is only digits local id_num = tonumberif is_set (idmaximum)and maximum < 1 then return "", 0; end -- convert id to a number returned 0 is for range testing if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries err_cat = ' ' .. set_error( 'bad_pmid' )EditorCount; -- set an error message end endnot used for authors
return external_link_idfor i,person in ipairs(people) do if is_set({link = handlerperson.link, label last) then local mask = handlerperson.label,mask local one prefix=handler.prefix,idlocal sep_one =id,separator=handler.separator, encode=handler.encode}) .. err_catsep;end --[[--------------------------< I S _ E M B A R G O E D if is_set (maximum) and i >------------------------------------------------------maximum then Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo etal = against today's date. If embargo date istrue;in the future, returns the content of |embargo= break; otherwise, returns and empty string because the embargo has expired or because|embargo elseif (mask ~= was not set in this cite. ]]nil) then local function is_embargoed n = tonumber(embargomask) if is_set (embargon ~= nil) then local lang one = mwstring.getContentLanguagerep("&mdash;",n); local good1, embargo_date, good2, todays_date; else good1, embargo_date one = pcall( lang.formatDate, lang, 'U', embargo )mask; good2, todays_date sep_one = pcall( lang.formatDate, lang, 'U' )" "; if good1 and good2 then -- if embargo date and today's date are good dates if tonumber( embargo_date ) >= tonumber( todays_date ) then -- is embargo date is in the future? return embargo; -- still embargoedend
else
add_maint_cat one = person.last local first = person.first if is_set(first) then if ( "vanc" == format ) then -- if vancouver format one = one:gsub ('embargo%.', ''); -- 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) then -- and name is all Latin characters; corporate authors not tested first = reduce_to_initials(first) -- attempt to convert first name(s) to initials end end one = one .. namesep .. first; return ''end if is_set(person.link) and person.link ~= control.page_name then one = make_wikilink (person.link, one); -- unset because embargo has expiredlink author/editor if this page is not the author's/editor's page end
end
table.insert( text, one )
table.insert( text, sep_one )
end
end
return ''; -- |embargo= not set return empty string
end
local count = #text / 2; --(number of names + number of separators) divided by 2 if count > 0 then if count > 1 and is_set(lastauthoramp) and not etal then text[[--------------------------< P M C >-------------------------------------------------------------#text-2] = " & "; --replace last separator with ampersand text end text[#text] = nil; --erase the last separator end local result = table.concat(text) --construct list if etal and is_set (result) then --etal may be set by |display-authors=etal but we might not have a last-first list Format a PMC, do simple error checking, and check for embargoed articles result = result .. sep .The embargo parameter takes a date for a value' ' . If the embargo date is in the future the PMC identifier will notbe linked to the article. If the embargo date is today or in the past, or if it is empty or omitted, then thePMC identifier is linked to the article through the link at cfg.id_handlersmessages['PMCet al']; -- we've go a last-first list and etal so add et al.prefix. end return result, countend
PMC embargo date testing is done in function is_embargoed () which is called earlier because when the citation
has |pmc=<value> but does not have a |url= then |title= is linked with the PMC link. Function is_embargoed ()
returns the embargo date if the PMC article is still embargoed, otherwise it returns an empty string.
PMCs are sequential numbers beginning at 1 and counting up. This code checks the PMC to see that it contains only digits and is lessthan test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.--[[--------------------------< 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.
local function pmc(idnamelist is one of the contributor-, embargo) local test_limit = 6000000; author-, or editor- update this value as PMCs approach local handler = cfgname lists chosen in that order.id_handlers['PMC']; local err_cat = ''; -- presume that PMC year is valid local text;Year or anchor_year.
if id:match("[^%d]") then -- if PMC has anything but digits] err_cat = ' ' .. set_errorlocal function anchor_id ( 'bad_pmc' namelist, year); -- set an error message else -- PMC is only digits local id_num names= tonumber(id){}; -- convert id to a number table for range testingthe one to four names and year if 1 > id_num or test_limit < id_num then for i,v in ipairs (namelist) do -- if PMC is outside test limit boundariesloop through the list and take up to the first four last names err_cat names[i] = ' ' v.. set_error( 'bad_pmc' ); -- set an error messagelast 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 (embargoid) then -- if concatenation is PMC is still embargoed?not an empty string text=return "[[CITEREF" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; -- still embargoed so no external linkadd the CITEREF portion
else
text = external_link_id({link = handler.link, label = handler.label, return ''; -- return an empty string; no embargo date or embargo has expired, ok reason to link to article prefix=handler.prefix,include CITEREF id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;in this citation
end
return text;
end
-- Formats a DOI and checks for DOI errors.
-- DOI names contain two parts: prefix and suffix separated by a forward slash.[[--------------------------< N A M E _ H A S _ E T A L >-------------------------------------------------- Prefix: directory indicator '10.' followed by a registrant code-- Suffix: character string of any length chosen by the registrant
-- This function checks a DOI Evaluates the content of author and editor name parameters for: prefix/suffixvariations on the theme of et al. If the doi name contains spaces or endashesfound,-- orthe et al. is removed, if it ends with a period or a comma, this flag is set to true and the function will emit a bad_doi error messagereturns the modified name and the flag.
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so This function never sets the test for spaces, endash,flag to false but returns it's previous state because it may have been set byprevious passes through this function or by the parameters |display-authors=etal or |display- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.editors=etal
]] local function doiname_has_etal (idname, inactiveetal, nocat) local cat = "" local handler = cfg.id_handlers['DOI']; local text; if is_set(inactivename) then -- name can be nil in which case just return local inactive_year etal_pattern = inactive:match("[;,]? *[\"']*%df[%da][Ee][Tt] *[Aa][Ll][%d%d.\") or ''; ]*$" -- try to get variations on the year portion from the inactive date'et al' theme text local others_pattern = "[;,]? *%f[" .. handler.link .. "|" .. handler.label .. "%a]and [Oo]:thers" ; -- and alternate to et al.. id; if is_setname:match (inactive_yearetal_pattern) then -- variants on et al. table.insertname = name:gsub ( z.error_categoriesetal_pattern, ''); -- if found, "自" .. inactive_year .. "年含有不活躍DOI的頁面"remove etal = true; -- set flag (may have been set previously here or by |display-authors=etal) if not nocat then -- no categorization for |vauthors= add_maint_cat ('etal'); -- and add a category if not already added end elseelseif name:match (others_pattern) then -- if not 'et al.', then 'and others'? table.insertname = name:gsub ( z.error_categoriesothers_pattern, "含有不活躍DOI的頁面" ''); -- when inactive doesnif found, remove etal = true; -- set flag (may have been set previously here or by |display-authors=etal) if not nocat then -- no categorization for |vauthors= add_maint_cat ('t contain etal'); -- and add a recognizable yearcategory if not already added end
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
else
text = external_link_id({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
inactive = ""
end
  if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.return name,]$") then etal; -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma cat = ' ' .. set_error( 'bad_doi' ); end return text .. inactive .. cat
end
--[[--------------------------< O P N A M E _ H A S _ E N L I B R D _ M A R Y K U P >--------------------------------------------------------
Formats an OpenLibrary linkEvaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc.These annotation do not belong in author parameters and checks for associated errorsare redundant in editor parameters. If found, the functionadds the editor markup maintenance category.
]]
local function openlibrary(id)
local code = id:match("^%d+([AMW])$"); -- only digits followed by 'A', 'M', or 'W'
local handler = cfg.id_handlers['OL'];
local function name_has_ed_markup (name, list_name) local _, pattern; if ( code local patterns == "A" ) then{ -- these patterns match annotations at end of name return external_link_id'%f[%(%[][%({link=handler%[]%s*[Ee][Dd][Ss]?%.link?%s*[%)%]]?$', -- (ed) or (eds): leading '(', case insensitive 'ed', label=handler.labeloptional 's', prefix=handler.prefix .'. 'authorsand/OLor ')', id=id '[, separator=handler%.%s]%f[e]eds?%.separator?$', encode = handler.encode} -- ed or eds: without '('or ') elseif '; case sensitive ( code == "M" ED could be initials Ed could be name) then return external_link_id'%f[%({link=handler%[][%(%[]%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.link?%s*[%)%]]?$', -- (editor) or (editors): leading '(', label=handler.labelcase insensitive, prefix=handler.prefix .optional '. 'booksand/OLor ')', id=id '[, separator=handler%.%s]%f[Ee][Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%.separator?$', encode = handler.encode} -- editor or editors: without '('or ')'; case insensitive elseif ( code == "W" ) then -- these patterns match annotations at beginning of name return external_link_id({link=handler'^eds?[%.link, label=handler.label;]', prefix=handler -- ed.prefix or eds.: lower case only, optional 's', requires '. 'works/OL '^[%(%[]%s*[Ee][Dd][Ss]?%.?%s*[%)%]]', id=id -- (ed) or (eds): also sqare brackets, case insensitive, separator=handler.separatoroptional 's', encode = handler'.encode}) else' return external_link_id'^[%(%[]?%s*[Ee][Dd][Ii][Tt][Oo][Rr][Ss]?%A', -- ({link=handler.linkeditor or (editors: also sq brackets, case insensitive, label=handler.labeloptional brackets,'s' prefix=handler.prefix .. 'OL^[%(%[]?%s*[Ee][Dd][Ii][Tt][Ee][Dd]%A', id=id -- (edited: also sq brackets, separator=handler.separatorcase insensitive, encode = handler.encodeoptional brackets if is_set (name) .. then for _, pattern in ipairs (patterns) do -- spin through patterns table and if name:match (pattern) then add_maint_cat (' extra_text_names' , cfg.. set_error( 'bad_ol' special_case_translation [list_name]);-- add a maint cat for this template break; end end
end
return name; -- and done
end
--[[--------------------------< N A M E _ H A S S _ M U L T _ N A G M E _ I D S >----------------------------------------------------------
Validate Evaluates the content of author and format a usenet message ideditor (surnames only) parameters for multiple names. Multiple names areindicated if there is more than one comma and or semicolon. Simple error checkingIf found, looks for 'id-left@id-right' not enclosed inthe function adds the multiple name'<' and/(author or '>' angle bracketseditor) maintenance category.
]]
local function message_id name_has_mult_names (idname, list_name) local handler = cfg.id_handlers['USENETID']count, _text = external_link_idif is_set ({link = handler.link, label = handler.label,name) then prefix=handler.prefix_,idcount =idname:gsub ('[;,separator=handler.separator]', encode=handler.encode}''); -- count the number of separator-like characters if not id:match('^.+@.+$') or not id:match('^[^1 <].*[^>]$')count then -- doesn't have '@' param could be |author= or has |editor= so one or first or last separator character is '< or '>'acceptable text = text .. add_maint_cat (' mult_names' , cfg.. set_error( 'bad_message_id' special_case_translation [list_name]) ; -- more than one separator indicates multiple names so add an error message if the message id is invalida maint cat for this template end end return textname; -- and done
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 valueN A M E _ C H E C K S >) for those templates that have defaults.--------------------------------------------------------Also handles the special case where it is desirable This function calls various name checking functions used to omit validate the title type from content of the rendered citation (|type=none)various name-holdingparameters.
]]
local function set_titletype name_checks (cite_classlast, title_typefirst, list_name) if is_set(title_typelast) then if "none" last:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written last = last:match ('^%(%((.*)%)%)$'); -- strip parens else last =name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only) last = title_type name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation end end if is_set (first) then if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written title_type first = ""first:match ('^%(%((.*)%)%)$'); -- if |typestrip parens else first =none then type parameter not displayedname_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation
end
end return title_typelast, first; -- if |type= has been set to any other value use that valuedone
end
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
--[[--------------------------< C L E X T R A C T _ N _ I A M E S B N >----------------------------------------------------------Gets name list from the input arguments
Removes irrelevant text Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and dashes from ISBN numbermask parameters.Similar to that used for SpecialStops searching when both |lastn= and |firstn= are not found in args after two sequential attempts:BookSourcesfound |last1=, |last2=, and |last3= but doesn'tfind |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=.
local function clean_isbnWhen an author or editor parameter contains some form of 'et al.', the 'et al.' is stripped from the parameter and a flag ( isbn_str etal)returned return isbn_str:gsubthat will cause list_people( "[^-0-9X]", "" );to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps 'et al.' out of the end --[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------template's metadata. When this occurs, the page is added to a maintenance category.
Returns a string where all of lua's magic characters have been escaped. This is important because functions like
string.gsub() treat their pattern and replace strings as patterns, not literal strings.
]]
local function escape_lua_magic_chars (argument)
argument = argument:gsub("%%", "%%%%"); -- replace % with %%
argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1"); -- replace all other lua magic pattern characters
return argument;
end
local function extract_names(args, list_name) local names = {}; --[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >---------------------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
Strip wiki italic and bold markup from argument so that it doesn local err_msg_list_name = list_name:match ("(%w+)List") .. 't contaminate COinS metadatas list'; -- modify AuthorList or EditorList for use in error messages if necessary while true do last = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1This function strips common patterns of apostrophe markup first = select_one( args, cfg.aliases[list_name . We presume that editors who have taken the time to. '-First'], 'redundant_parameters', i );markup a title have link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', as a resulti ); mask = select_one( args, provided valid markupcfg.aliases[list_name .. When they don't-Mask'], some single apostrophes are left behind.'redundant_parameters', i );
]] last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al. first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al. last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks if first and not last then -- if there is a firstn without a matching lastn table.insert( z.message_tail, { set_error( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- 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_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup
local function strip_apostrophe_markup (argument) if not is_set (argument) then return argument names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; end  while true do if argument:match ("%'%'%'%'%'") then -- bold italic add this name to our names list (5corporate for |vauthors= only) argumentn =argument:gsub("%'%'%'%'%'", "")n + 1; -- remove all instances of itpoint to next location in the names table elseif argument:match ("%'%'%'%'") if 1 == count then -- italic start and end without content (4)if the previous name was missing argument=argument:gsub table.insert("%'%'%'%'"z.message_tail, ""); elseif argument:match { set_error("%'%missing_name'%'") then , {err_msg_list_name, i-- bold (31}, true ) argument=argument:gsub("%'%'%'", ""} ); elseif argument:match ("%'%'") then -- italic (2)add this error message argument=argument:gsub("%'%'", ""); elseend breakcount = 0; -- reset the counter, we're looking for two consecutive missing names
end
i = i + 1; -- point to next args location
end
return argumentnames, etal; -- all done, return our list of names
end
--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------
Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)-[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
Apostrophe markup Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code. Returns the language name and associated two- or three-character code. Because case of the source may be incorrector different from the case that WikiMedia uses, the name comparisons are done in lower case and when a match isfound, the Wikimedia version (bold, italicsassumed to be correct) is stripped from each value so that returned along with the COinS metadata isn't correupted with stringscode. When there is no match, weof %27%27return the original language name string...]]
mw.language.fetchLanguageNames(<local function make_coins_title (titlewiki language>, script'all')returns a list of languages that in some cases may include if is_set (title) then title = strip_apostrophe_markup (title); extensions. For example, code 'cbk-- strip any apostrophe markup else title=zam' and its associated name 'Chavacano de Zamboanga'; -- if (MediaWiki does not set, make sure title is an empty string end if is_set (script) thensupport script = script:gsub (code '^%l%l%s*:%s*cbk', or name 'Chavacano'); -- remove language prefix if present . Most (script value may now be empty stringall?) script = strip_apostrophe_markup (script); -- strip any apostrophe markup else script=of these languages are not used a 'language'; codes per se, rather theyare used as sub-domain names: cbk- if not set, make sure script is an empty string end if is_set zam.wikipedia.org. These names can be found (title) and is_set (scriptfor the time being) thenat script = ' ' .https://phabricator. script; -- add a space before we concatenate end return title wikimedia.org/diffusion/ECLD/browse/master/LocalNames/LocalNamesEn. script; -- return the concatenationendphp
Names but that are included in the list will be found if that name is provided in the |language= parameter. For example,if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk--[[--------------------------< G E T _ C O I N S _ P A G E S >------------------------------------------------zam'. When names are foundand the associated code is not two or three characters, this function returns only the Wikimedia language name.
Extract page numbers Adapted from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinScode taken from Module:Check ISO 639-1.
]]
local function get_coins_pages get_iso639_code (pageslang, this_wiki_code) local pattern;remap = { if not is_set ['bangla'] = {'Bengali', 'bn'}, -- MediaWiki returns Bangla (the endonym) but we want Bengali (pagesthe exonym) then return pages; end here we remap ['bengali'] = {'Bengali', 'bn'}, -- if no page numbers then MediaWiki doesn't use exonym so here weprovide correct language name and 639-1 code ['bihari'] = {'Bihari', 're donebh'}, -- MediaWiki replace 'Bihari' with 'Bhojpuri' so 'Bihari' cannot be found ['bhojpuri'] = {'Bhojpuri', 'bho'}, -- MediaWiki uses 'bh' as a subdomain name for Bhojpuri wWikipedia: bh.wikipedia.org }
while true doif remap[lang:lower()] then pattern = pagesreturn remap[lang:matchlower("%)][1], remap[lang:lower(%w*:?//[^ )]+%s+)[%w%d2]; -- for this language 'name', return a possibly new name and appropriate code end  local languages = mw.language.*%]"fetchLanguageNames(this_wiki_code, 'all'); -- get a list of language names known to Wikimedia -- pattern ('all' is the opening bracketrequired for North Ndebele, South Ndebele, the url and following spaceOjibwa) local langlc = mw.ustring.lower(slang): "[url "; -- lower case version for comparisons for code, name in pairs(languages) do -- scan the list to see if we can find our language if nil langlc == pattern mw.ustring.lower(name) then break; end -- no more urls pattern if 2 ~= code:len() and 3 ~= escape_lua_magic_chars code:len(pattern)then -- two- or three-character codes only; extensions not supported return name; -- pattern is so return the name but not a literal string; escape lua's magic pattern charactersthe code end pages = pages:gsub(pattern return name, "")code; -- remove as many instances of pattern as possiblefound it, return name to ensure proper capitalization and the the code end
end
pages = pages:gsub("[%[%]]", "")return lang; -- remove the brackets pages = pages:gsub("–", "-" ); -- replace endashes with hyphens pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32not valid language; return language in original case and nil for the like? return pages;code
end
-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
local function remove_wiki_link( str )
return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
end));
end
-- Converts a hyphen to a dashlocal function hyphen_to_dash( str ) if not is_set(str) or str:match( "[%[%]{}--------------------------<L A N G U A G E _ P A R A M E T E R >]" ) ~= nil then return str; end return str:gsub( '-', '–' );end-----------------------------------------
Gets language name from a provided two-or three-[[--------------------------< S A F E _ J O I N >------------------------------------------------------------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.
Joins When |language= contains a sequence of strings together while checking recognized language (either code or name), the page is assigned to the category for duplicate separation charactersthat code: Category:Norwegian-language sources (no). For valid three-character code languages, the page is assignedto 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-characterequivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not.
This function supports multiple languages in the form |language=nb, French, th where the language names or codes areseparated from each other by commas. ]] local function safe_joinlanguage_parameter ( tbllang) local code; -- the two- or three-character language code local name; -- the language name local language_list = {}; -- table of language names to be rendered local names_table = {}; -- table made from the value assigned to |language=  local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki local this_wiki_code = this_wiki:getCode() -- get this wiki's language code local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, duplicate_char this_wiki_code); -- get this wiki's language name  local remap = { ['bh'] = 'Bihari', --MediaWiki uses 'bh' as a subdomain name for Bhojpuri wWikipedia: bh.wikipedia.org [['bn'] = 'Bengali', -- MediaWiki returns Bangla }  names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list  Notefor _, lang in ipairs (names_table) do -- reuse lang  if lang:match ('^%a%a%-') then -- strip ietf language tags from code; TODO: is there a need to support 3-char with tag? lang = lang: we use string functions herematch ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code? end if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code name = mw.language.fetchLanguageName( lang:lower(), rather than ustring functions.this_wiki_code); -- get language name if |language= is a proper code end
This has considerably faster performance and should work correctly as if is_set (name) then -- if |language= specified a valid code long as the duplicate_char is strict ASCII. The strings code = lang:lower(); -- save it in tbl may be ASCII or UTF8. else ]] name, code = get_iso639_code (lang, this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) end
local str if is_set (code) then -- only 2- or 3-character codes name = ''remap[code] or name; -- override wikimedia when they misuse language codes/names  if this_wiki_code ~= code then -- when the output stringlanguage is not the same as this wiki's language local comp if 2 = = code:len() then -- and is a two-character code add_prop_cat ('foreign_lang_source'; .. code, {name, code}) -- categorize it else -- what does 'comp' mean?or is a recognized language (but has a three-character code) local end_chr = add_prop_cat ('foreign_lang_source_2';.. code, {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template local trim; end for _, value in ipairs( tbl ) do end if value == nil then value = else add_maint_cat ('unknown_lang'); -- add maint category if not already added end
if str =table.insert (language_list, name); name = '' then ; -- if output string is emptyso we can reuse it end str code = value; #language_list -- assign value to it (first time through reuse code as number of languages in the loop)list elseif value ~ if 2 >= '' code then if value:sub name = table.concat (1language_list,1' and ') == -- insert '<space>and<space>' between two language names elseif 2 < code then language_list[code] = 'and ' .. language_list[code]; -- Special case of values enclosed in spans prepend last name with 'and other markup.<space>' comp name = value:gsubtable.concat ( "%b<>"language_list, ', "" '); -- remove html markup (and concatenate with '<spancomma>string</spanspace> -> string)' separators else comp = value; end -- typically duplicate_char is sepc if comp:sub(1,1) this_wiki_name == duplicate_char name then return ''; -- if one language and that language is first charactier same as duplicate_char? why test first character? -- Because individual this wiki's return an empty string segments often (always?no annotation) begin with terminal punct for th -- preceding segment: 'First element' end return (" " .. wrap_msg ('sepc next elementlanguage' .. etc? trim = false; end_chr = str:sub(-1,-1name)); -- get the last character of the output string -- str = str .. "<HEREotherwise wrap with '(enchr=" .in . end_chr.. ")" ' -- debug stuff?[[ TODO: should only return blank or name rather than full list if end_chr == duplicate_char then so we can clean up the bunched parenthetical elements Language, Type, Format ]]end  --[[-------------------------- if same as separator str = str:sub(< S E T _ C S 1,_ S T Y L E >------2); -- remove it elseif end_chr == "'" then -- if it might be wikimarkup if str:sub(-3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc'' str = str:sub(1, -4) .. "''"; -- remove them and add back '' elseif str:sub(-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 str:sub(-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 wikimarkup if str:sub(-3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink trim = true; elseif str:sub(-2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link trim = true; elseif str:sub(-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 str:sub(-2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space> str = str:sub(1,-3); -- remove them both end endSet style settings for CS1 citation templates. Returns separator and postscript settings ]]
if trim then if value ~= comp then -- value does not equal comp when value contains html markup local dup2 = duplicate_char; if dup2:matchfunction set_cs1_style ( "%A" ps) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it value = value:gsub( "is_set (%b<>ps)" .. dup2, "%1", 1 ) then -- remove duplicate_char if it follows html markupunless explicitely set to something else value = value:sub( 2, -1 ); -- remove duplicate_char when it is first character end end end str ps = str '.. value'; --add it to terminate the output string endrendered citation with a period end return str'.', ps; -- separator is a full stopend
--[[--------------------------< 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 nameuses characters that contain diacritical marks, those characters are to 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.These things are not currently possible in this module so are left to the editor to do.-[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------
This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets [http://wwwSet style settings for CS2 citation templates.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 hyphensReturns separator, spacespostscript, apostrophes, and periods At the time of this writing, I had to write the 'if nil == mw.ustring.find ...' test ouside of the code editor and paste it herebecause the code editor gets confused between character insertion point and cursor position.ref settings
]]
local function is_good_vanc_name set_cs2_style (lastps, firstref) if nil == mw.ustring.find not is_set (last, "^[Aps) then -Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil if |postscript=has not been set, set cs2 default ps = mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ''; - ɏ%-%s%make sure it isn'%.]*$") thent nil end add_vanc_error if not is_set (ref);then -- if |ref= is not set return falseref = "harv"; -- not a string of latin characters; Vancouver required Romanizationset default |ref=harv end; return true',', ps, ref; -- separator is a comma
end
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
Attempts to convert names to initials in support of |name-list-format=vanc. [[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
Names in When |firstnmode= may be separated by spaces is not set or hyphenswhen its value is invalid, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/use config.CitationClass and parameter values to establish Vancouver rendered style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc. This form is notcurrently supported by this code so correctly formed names like Smith JL 2nd are converted to Smith J2. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/. 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_initialsget_settings_from_cite_class (firstps, ref, cite_class) local sep; if mw.ustring.match(first, cite_class == "^%u%u$citation") then return first end; - - when first contains just two upper-case letters, nothing to do local initials = {} local i = 0; -- counter for number of initials for word in mw.ustring.gmatchcitation templates (first, "[^%s%.%-]+"CS2) do -- names separated by spaces, hyphens, or periods table.insert(initialssep, ps, mw.ustring.subref = set_cs2_style (wordps,1,1ref)) ; else -- Vancouver format does not include full stops.a citation template so CS1 i sep, ps = i + 1; -- bump the counter if 2 <= i then breakset_cs1_style (ps); end -- only two initials allowed in Vancouver system; if 2, quit
end
  return table.concat(initials) sep, ps, ref -- Vancouver format does not include spaces.return them all
end
--[[--------------------------< L I S T _ P E O P L E >-------------------------------------------------------
Formats a list of people (e--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------ Establish basic style settings to be used when rendering the citation.g Uses |mode= if set and valid or usesconfig.CitationClass from the template's #invoke: to establish style. authors / editors)
]]
local function list_peopleset_style (controlmode, peopleps, etalref, list_namecite_class) -- TODO: why is list_name here? not used in this function
local sep;
local namesep; local format if 'cs2' = control.format local maximum = control.maximummode then -- if this template is to be rendered in CS2 (citation) style local lastauthoramp sep, ps, ref = control.lastauthorampset_cs2_style (ps, ref); local text = {}  if elseif 'vanccs1' == format mode then -- Vancouver-like author/editor name styling?if this template is to be rendered in CS1 (cite xxx) style sep , ps = ','set_cs1_style (ps); else -- name-list separator between authors is a commaanything but cs1 or cs2 namesep sep, ps, ref = ' 'get_settings_from_cite_class (ps, ref, cite_class); -- last/first separator is a spaceget settings based on the template's CitationClass elseend sep = if ';none' == ps:lower() then -- name-list separator between authors if assigned value is a semicolon'none' then namesep ps = ', ' ; -- last/first separator is <comma><space>set to empty string
end
if return sep:sub(, ps, refend  -1,-1) ~[= " " then sep = sep .. " " end if is_set (maximum) and maximum [-------------------------< 1 then return "", 0; end I S _ P D F >------------------------------------------------------------------ returned 0 is for EditorCount; not used for authors for i,person in ipairs(people) do Determines if is_set(persona url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.last) thencss]] when local mask = personapplying the pdf icon to external links.mask local one local sep_one = sep; if is_set (maximum) and i > maximum then etal = returns true; break; elseif (mask ~= nil) then local n = tonumber(mask) if (n ~= nil) then file extension is one = string.rep("&mdash;"of the recognized extensions,n) elsefalse one = mask; sep_one ]= " "; end] else one = person.last local first = person.first if is_setfunction is_pdf (firsturl) then if return url:match ( "vanc" == format '%.pdf$') then -- if vancouver format one = oneor url:gsub match ('%.PDF$', ) or url:match ('%.pdf[%?#]'); -- remove periods from surnames (httpor url://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/) if not person.corporate and is_good_vanc_name match (one, first) then -- and name is all Latin characters; corporate authors not tested first = reduce_to_initials(first) -- attempt to convert first name(s) to initials end end one = one .. namesep .. first end if is_set(person'%.link) and person.link ~= control.page_name then one = "PDF[[" .. person.link .. "|" .. one .. "]%?#]" -- link author/editor if this page is not the author's/editor's page end end table.insert( text, one ); table.insert( text, sep_one ) end end
local count --[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------ Applies css style to |format= #text / 2; -, |chapter- format=, etc. Also emits an error message if the format parameter doesnot have a matching url parameter. If the format parameter is not set and the url contains a file extension thatis recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) withthe appropriate styling. ]] local function style_format (number of names + number of separatorsformat, url, fmt_param, url_param) divided by 2 if count > 0 is_set (format) then format = wrap_style ('format', format); -- add leading space, parentheses, resize if count > 1 and not is_set(lastauthorampurl) and not etal then text[#text-2] format = " & "format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- replace last separator with ampersand textadd an error message
end
elseif is_pdf (url) then -- format is not set so if url is a pdf file then format = wrap_style ('format', 'PDF'); -- set format to pdf else text[#text] format = nil''; -- erase the last separatorempty string for concatenation
end
local result = table.concat(text) -- construct list if etal and 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']return format; -- we've go a last-first list and etal so add et al. end return result, count
end
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
Generates --[[--------------------------< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >------------------------ Returns a CITEREF anchor ID if we have at least one number that defines the number of names displayed for author and editor name or lists and a dateboolean flagto indicate when et al. Otherwise returns an empty stringshould be appended to the name list.
namelist When the value assigned to |display-xxxxors= is one a number greater than or equal to zero, return the number andthe previous state of the contributor-, author-, or editor-'etal' flag (false by default but may have been set to true if the name lists chosen in that orderlist containssome variant of the text 'et al. year is Year or anchor_year').
]]local function anchor_id (namelistWhen the value assigned to |display-xxxxors= is the keyword 'etal', year) local names={}; -- return a table for number that is one greater than the one to four names and year for i,v number of authors in ipairs (namelist) do -- loop through the list and take up to set the first four last names names[i] = v'etal' flag true.last if i == 4 then break end -- if four then done end table.insert This will cause the list_people(names, year); -- add to display all ofthe 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 in the CITEREF portion else return name list followed by 'et al.'; -- return an empty string; no reason to include CITEREF id in this citation endend
In all other cases, returns nil and the previous state of the 'etal' flag.
--inputs: max: A['DisplayAuthors'] or A[--------------------------< N A M E _ H A S _ E T A L >---------------------------------------------------- Evaluates the content 'DisplayEditors']; a number or some flavor of author and editor name parameters for variations on the theme of et al. If found,etalthe et al. is removed, count: #a flag is set to true and the function returns the modified name and the flag.or #e This function never sets the flag to false but returns it list_name: 's previous state because it may have been set byprevious passes through this function or by the parameters |display-authors=etal ' or |display-'editors=' etal: author_etal or editor_etal
]]
local function name_has_etal get_display_authors_editors (namemax, count, list_name, etal, nocat)  if is_set (namemax) then -- name can be nil in which case just return local etal_pattern if 'etal' = = max:lower():gsub("[;,]? *[\"']*%f[%a.][Ee][Tt] *[Aa][Ll][%.\", ']*$" ') then -- variations on the :gsub() portion makes 'etal' from a variety of 'et al.' themespellings and stylings local others_pattern max = "[count + 1;,]? *%f[%a]and [Oo]thers"; -- and alternate to et al. if number of authors + 1 so display all author name:match (etal_pattern) then -- variants on plus et al. name = name:gsub (etal_pattern, ''); -- if found, remove etal = true; -- overrides value set flag (may have been set previously here or by |display-authors=etal) if not nocat then -- no categorization for |vauthors= add_maint_cat extract_names('etal'); -- and add a category if not already added end elseif namemax:match (others_pattern'^%d+$') then -- if not 'et al.', then 'and others'?is a string of numbers name max = name:gsub tonumber (others_pattern, ''max); -- if found, removemake it a number etal if max >= true; count then -- set flag (may have been set previously here or by if |display-xxxxors= value greater than or equal to number of authors=etal) if not nocat then -- no categorization for |vauthors=/editors add_maint_cat ('etaldisp_auth_ed', cfg.special_case_translation [list_name]); -- and add a category if not already added
end
else -- not a valid keyword or number
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message
max = nil; -- unset; as if |display-xxxxors= had not been set
end
end
return namemax, etal; --
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'tfind |last4= and |last5= then the search is done.--[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------
This function emits an error message when there is a Adds page to Category:CS1 maint: extra text if |firstnpage= without a matching or |lastnpages=has what appears to be some form of p. When there are 'holes' or pp. abbreviation in the list first characters 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=the parameter content.
When an author or editor parameter contains some form of 'et alcheck Page and Pages for extraneous p, p.', the pp, and pp. at start of parameter value: good pattern: 'et al^P[^%.P%l]' matches when |page(s)= begins PX or P# but not Px where x and X are letters and # is stripped from the parameter and a flag (etal) returneddgiitthat will cause list_people() to add the static 'et al.' text from Module bad pattern:Citation/CS1/Configuration. This keeps 'et al.' out of the template^[Pp][Pp]'matches matches when |page(s metadata. When this occurs, the page is added to a maintenance category.)= begins pp or pP or Pp or PP
]]
local function extract_namesextra_text_in_page_check (args, list_namepage) local names good_pattern = {}'^P[^%.Pp]'; -- table ok to begin with uppercase P: P7 (pg 7 of namessection P) but not p123 (page 123) TODO: add Gg for PG or Pg? local lastbad_pattern = '^[Pp]?[Pp]%.?[ %d]'; -- individual name components  local firstif not page:match (good_pattern) and (page:match (bad_pattern) or page:match ('^[Pp]ages?')) then add_maint_cat ('extra_text'); local link;endend  local mask; local i --[= 1; [-------------------------< G E T _ V _ N A M E _ T A B L E >------------------------------------------ loop counter/indexer local n = 1; -- output table indexer local count = 0; -- used to count the number of times we haven't found  split apart a |lastvauthors= (or alias |veditors= parameter. This function allows for authorscorporate names, |editor-last or alias for editors)wrapped in doubled local etal=falseparentheses to also have commas; -- return value set to true when we find some form in the old version of et althe code, the doubled parnetheses were included in therendered citation and in the metadata. in an Individual author parameternames may be wikilinked
local err_msg_list_name |vauthors= list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary while true do last = select_one( argsJones AB, cfg.aliases[list_name [E.B. '-Last'White|White EB]], 'redundant_parameters', i ); -- search through args for name components beginning at 1 first = select_one( args, cfg.aliases[list_name .. '-First'](Black, 'redundant_parameters'Brown, i ); link = select_one( args, cfg.aliases[list_name and Co.. '-Link'], 'redundant_parameters', i ); mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
last, etal ]= name_has_etal (last, etal, false); -- find and remove variations on et al. first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al.]
if first and not last then -- if there is a firstn without a matching lastnlocal function get_v_name_table (vparam, output_table, output_link_table) table local name_table = mw.text.insertsplit( z.message_tailvparam, { set_error( 'first_missing_last'"%s*, {err_msg_list_name%s*"); -- names are separated by commas local wl_type, i}label, true ) } )link; -- add this error messagewl_type not used here; just a place holder local i = 1; while name_table[i] do elseif not first and not last if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- if both firstn and lastn aren't found, are we done?first segment of corporate with one or more commas; this segment has the opening doubled parens local name = name_table[i]; count i= count i+ 1; -- number of times we havenbump indexer to next segment while name_table[i] do name = name .. ', 't found last and first.. name_table[i]; -- concatenate with previous segments if 2 <= count name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens break; -- two missing names and we give updone reassembling so breakend i=i+1; -- normal exit or there is a two-name hole in the list; can't tell whichbump indexer
end
else -- we have last with or without a first if is_set table.insert (linkoutput_table, name) and false == link_param_ok (link) then ; -- do this test here in case link is missing lastand add corporate name to the output table table.insert( z.message_tailoutput_link_table, { set_error( 'bad_paramlink', list_name:match ("(%w+)List"):lower() .. '-link' .. i )}); -- url or no wikilink in author link; end else names[n] = {last = lastwl_type, first = firstlabel, link = link, mask = mask, corporate=false}is_wikilink (name_table[i]); -- add this name to our names list wl_type is: 0, no wl (corporate for text in label variable); 1, [[D]]; 2, [[L|vauthors= only)D]] n = n + 1table.insert (output_table, label); -- point to next location in the names tableadd this name if 1 == count wl_type then table.insert (output_link_table, label); -- if the previous name was missingsimple wikilink [[D]] else table.insert( z.message_tailoutput_link_table, { set_error( 'missing_name', {err_msg_list_name, i-1}, true ) } link); -- no wikilink or [[L|D]]; add this error messagelink if there is one, else empty string
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
i = i + 1; -- point to next args location end return names, etaloutput_table; -- all done, return our list of names
end
--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------
Populates ID table from arguments using configuration settings. Loops through cfg.id_handlers and searches args forany of the parameters listed in each cfg.id_handlers--['...'].parameters. If found, adds the parameter and value tothe identifier list. Emits redundant error message is more than one alias exists in args[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------
]]This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and|xxxxor-linkn= in args. It then returns a table of assembled names just as extract_names() does.
local function extract_idsAuthor / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional namesmay sometimes be required and because such names will often fail the is_good_vanc_name( args )and other format compliance local id_list = {}; -- list of identifiers found in args for ktests, v are wrapped in pairsdoubled paranethese ( cfg.id_handlers ) do -- k is uc identifier (corporate name as index to cfg.id_handlers; e.g. cfg.id_handlers['ISBN'], v is a table v = select_one( args, v.parameters, 'redundant_parameters' ); -- v.parameters is a table of aliases for k; here we pick one from args if present if is_set(v) then id_list[k] = v; end -- if found in args, add identifier to our list end return id_list;endsuppress the format tests.
--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
Takes This function sets the vancouver error when a table of IDs created by extract_ids() reqired comma is missing and turns it into when there is a table of formatted ID outputsspace between an author's initialsinputs: id_list – table of identifiers built by extract_ids() options – table of various template parameter values used to modify some manually handled identifiers
]]
local function build_id_listparse_vauthors_veditors ( id_listargs, options vparam, list_name) local new_listnames = {}; -- table of names assembled from |vauthors=, handler |author-maskn=, |author-linkn= local v_name_table = {}; local v_link_table = {}; -- when name is wikilinked, targets go in this table local etal = false; -- return value set to true when we find some form of et al. vauthors parameter local last, first, link, mask, suffix; local corporate = false;
function fallbackvparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (kdo it here because et al. might have a period) return { __index v_name_table = functionget_v_name_table (tvparam, v_name_table,iv_link_table) return cfg.id_handlers[k][i] end } end; -- names are separated by commas for ki, v v_name in pairsipairs( id_list v_name_table) do if v_name:match ('^%(%(.+%)%)$') then -- k is uc identifier name as index corporate authors are wrapped in doubled parentheses to cfg.id_handlers; e.g. cfg.id_handlers[supress vanc formatting and error detection first = 'ISBN'], v is a table ; -- fallback set to read-only cfgempty string for concatenation and because it may have been set for previous author/editor handler last = setmetatablev_name:match ( { ['id'] = v }, fallback^%(%((k.+)%) %); if handler.mode == $'external' then) -- remove doubled parntheses table.insertcorporate = true; -- flag used in list_people( new_list, {handler.label, external_link_id( handler ) } ); elseif handlerstring.mode == 'internal' find(v_name, "%s") then table.insertif v_name:find( new_list, {handler.label, internal_link_id( handler ) } )'[; elseif handler%.mode ~= 'manual]' ) then -- look for commonly occurring punctuation characters; error add_vanc_error ( cfg.messages['unknown_ID_modepunctuation'] ); elseif k end local lastfirstTable == 'DOI' then{} tablelastfirstTable = mw.insert( new_list, {handlertext.label, doisplit( vv_name, options.DoiBroken ) } "%s"); elseif k first == 'ARXIV' then table.insert( new_list, {handler.label, arxivremove( v, options.Class ) } lastfirstTable); elseif k == 'ASIN' then -- removes and returns value of last element in table which should be author intials table.insert( new_list, {handler.label, amazonif is_suffix ( v, options.ASINTLD first) } ); then -- if a valid suffix elseif k suffix =first -- save it as a suffix and first = 'LCCN' then table.insertremove( new_list, {handler.label, lccn( v ) } lastfirstTable); -- get what should be the initials from the table elseif k == 'OL' or k == 'OLA' then end -- no suffix error message here because letter combination may be result of Romanization; check for digits? last = table.insertconcat( new_listlastfirstTable, {handler.label, openlibrary( v " ") } ); elseif k == 'PMC' then -- returns a string that is the concatenation of all other names that are not initials tableif mw.insert( new_list, {handlerustring.label, pmcmatch ( vlast, options.Embargo '%a+%s+%u+%s+%a+') } then add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing elseif k == 'PMID' then end tableif mw.ustring.insertmatch ( new_list, {handler.labelv_name, pmid( v ) } ); elseif k == 'ISMN%u %u$' ) then -- this test is in the wrong place TODO: move or replace with a more appropriate test table.insert add_vanc_error ( new_list, {handler.label, ismn( v ) } 'name'); -- matches a space between two intiials end elseif k =else first = 'ISSN' then; -- set to empty string for concatenation and because it may have been set for previous author/editor table.insert( new_list, {handler.label, issn( v ) } )last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this? elseif k == 'EISSN' end if is_set (first) then tableif not mw.ustring.insertmatch ( new_listfirst, {handler.label"^%u?%u$") then -- first shall contain one or two upper-case letters, issnnothing else add_vanc_error ( v, true ) } 'initials'); -- true distinguishes eissn from issntoo many initials; mixed case initials (which may be ok Romanization); hyphenated initials elseif k == 'ISBN' then end local ISBN = internal_link_idis_good_vanc_name ( handler last, first); -- check first and last before restoring the suffix which may have a non-Latin digit if not check_isbn( v ) and not is_set(options.IgnoreISBNsuffix) then ISBN first = ISBN first .. ' ' .. set_error( suffix; -- if there was a suffix concatenate with the initials suffix = 'bad_isbn', {}, false, " ", "" ); -- unset so we don't add this suffix to all subsequent names
end
table.insert( new_list, {handler.label, ISBN } );
elseif k == 'USENETID' then
table.insert( new_list, {handler.label, message_id( v ) } );
else
errorif not corporate then is_good_vanc_name ( cfg.messages[last, 'unknown_manual_ID'] ); end
end
 
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ) or v_link_table[i];
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list
end
function comp( areturn names, b ) etal; -- used in following table.sort() return a[1] < b[1]; end table.sort( new_list, comp ); for kall done, v in ipairs( new_list ) do new_list[k] = v[2]; end return new_list;our list of names
end
--[[--------------------------< C O I N S _ C L E A N U P >----------------------------------------------------
Cleanup parameter values for the metadata by removing or replacing invisible characters and certain html entities.--[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------------------
2015-12-10: there is a bug in mw.text.unstripNoWiki (). It replaced math stripmarkers with Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the appropriate contentauthor name list orwhen it shouldn't. See https:select one of |editors=, |editorn= /editor-lastn= /phabricator.wikimedia.org/T121085 and Wikipedia_talk:Lua#stripmarkers_and_mw.text.unstripNoWiki.28|editor-firstn= or |veditors= as the source of the editor name list.29
TODOOnly one of these appropriate three will be used. The hierarchy is: move the replacement patterns |authorn= (and aliases) highest and |authors= lowest and replacement values into a table in /Configuration similar to the invisiblecharacters table?]]similarly, |editorn= (and aliases) highest and |editors= lowest
local function coins_cleanup (value) value When looking for |authorn= mw.text.unstripNoWiki (value); -- replace nowiki stripmarkers with their content value / |editorn= value:gsub ('<span class="nowrap" style="padding%-left:0%.1em;">&#39;s</span>'parameters, "'s"); -- replace {{'s}} template with simple apostrophe-s value test |xxxxor1= value:gsub ('&zwj;\226\128\138\039\226\128\139', "'"); -- replace {{'}} with simple apostrophe value and |xxxxor2= value:gsub ('\226\128\138\039\226\128\139', "'"); -- replace {{'}} with simple apostrophe (as and all of 2015-12-11their aliases) value = value:gsub ('&nbsp;', ' '); -- replace &nbsp; entity with plain spacestops after the second value = value:gsub test which mimicks the test used in extract_names('\226\128\138', ' '); -- replace hair space with plain spacewhen looking for a hole in the author name list. There may be a better value = value:gsub ('&zwj;'way to do this, I just haven''); -- remove &zwj; entities value = value:gsub ('[\226\128\141\226\128\139]', '') -- remove zero-width joiner, zero-width space value = value:gsub ('[\194\173\009\010\013]', ' '); -- replace soft hyphen, horizontal tab, line feed, carriage return with plain space return value;endt discovered what that way is.
Emits an error message when more than one xxxxor name source is provided.
--[[--------------------------< C O I N S >-------------------------------------------------------------------- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse the citation informationIn this function, vxxxxors = vauthors or veditors; xxxxors = authors or editors as appropriate.
]]
local function COinSselect_author_editor_source (datavxxxxors, classxxxxors, args, list_name)local lastfirst = false; if select_one( args, cfg.aliases[list_name .. 'table-Last' ~], 'none', 1 ) or -- do this twice incase we have a |first1= without a |last1= type; this ... select_one(dataargs, cfg.aliases[list_name .. '-First'], 'none', 1 ) or nil -- ... also catches the case where |first=is used with |vauthors= next select_one(dataargs, cfg.aliases[list_name .. '-Last'], 'none', 2 ) thenor return select_one( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then lastfirst=true;
end
for k, v in pairs if (is_set (datavxxxxors) do -- spin through all of the metadata parameter values if 'ID_list' ~and true = k and 'Authors' ~= k then lastfirst) or -- except these are the ID_list and Author tables (author nowiki stripmarker done when Author table processed) data[k] = coins_cleanup (v);three error conditions end end  local ctx_ver = "Z39.88-2004"; -- treat table strictly as an array with only set values. local OCinSoutput = setmetatable( {}, { __newindex = function(self, key, value) if is_set(value) then rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( remove_wiki_link( value ) ) } ); end end }); if in_array (class, {'arxiv', 'journal', 'news'}) or (in_array (class, {'conference', 'interview', 'map', 'press release', 'web'}vxxxxors) and is_set(data.Periodicalxxxxors)) or ('citation' true == class lastfirst and is_set(data.Periodical) and not is_set (data.Encyclopediaxxxxors)) then OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"local err_name; -- journal metadata identifier if 'arxivAuthorList' == class list_name then -- set genre according to the type of citation template we are renderingfigure out which name should be used in error message OCinSoutput["rft.genre"] err_name = "preprint"; -- cite arxiv elseif 'conferenceauthor' == class then OCinSoutput["rft.genre"] = "conference"; -- cite conference (when Periodical set) elseif 'web' == class then OCinSoutput["rft.genre"] = "unknown"; -- cite web (when Periodical set)
else
OCinSoutput["rft.genre"] err_name = "article"; -- journal and other 'periodicaleditor' articles;
end
OCinSoutput["rfttable.jtitle"] = data.Periodical; -- journal only if is_set insert(data.Map) then OCinSoutput["rftz.atitle"] = data.Map; -- for a map in a periodical else OCinSoutput["rft.atitle"] = data.Title; -- all other 'periodical' article titles end -- these used onlu for periodicals OCinSoutput["rft.ssn"] = data.Season; -- keywords: wintermessage_tail, spring, summer, fall OCinSoutput["rft.chron"] = data.Chron; -- free-form date components OCinSoutput["rft.volume"] = data.Volume; -- does not apply to books OCinSoutput["rft.issue"] = data.Issue; OCinSoutput["rft.pages"] = data.Pages; -- also used in book metadata  elseif 'thesis' ~= class then -- all others except cite thesis are treated as 'book' metadata; genre distinguishes OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"; -- book metadata identifier if 'report' == class or 'techreport' == class then -- cite report and cite techreport OCinSoutput["rft.genre"] = "report"; elseif 'conference' == class then -- cite conference when Periodical not set OCinSoutput["rft.genre"] = "conference"; elseif in_array { set_error(class, {'bookredundant_parameters', 'citation', 'encyclopaedia', 'interview', 'map'}) then if is_set (data.Chapter) then OCinSoutput["rft.genre"] = "bookitem"; OCinSoutput["rft.atitle"] = data.Chapter; -- book chapter, encyclopedia article, interview in a book, or map title else if 'map' == class or 'interview' == class then OCinSoutput["rft.genre"] = 'unknown'; -- standalone map or interview else OCinSoutput["rft.genre"] = 'book'; -- book and encyclopedia end end else --{'audio-visual', 'AV-media-notes', 'DVD-notes', 'episode', 'interview', 'mailinglist', 'map', 'newsgroup', 'podcast', 'press release', 'serial', 'sign', 'speech', 'web'} OCinSoutput["rft.genre"] = "unknown"; end OCinSoutput["rft.btitle"] = data.Title; -- book only OCinSoutput["rft.place"] = data.PublicationPlace; -- book only OCinSoutput["rfterr_name .series"] = data.Series; -- book only OCinSoutput["rft.pages"] = data.Pages; -- book, journal OCinSoutput["rft.edition"] = data.Edition; -- book only OCinSoutput["rft.pub"] = data.PublisherName; -- book and dissertation else -- cite thesis OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:dissertation"; -- dissertation metadata identifier OCinSoutput["rft.title"] = data.Title; -- dissertation (also patent but that is not yet supported) OCinSoutput["rft.degree"] = data.Degree; -- dissertation only OCinSoutput['rft.inst'] = data.PublisherName; -name- book and dissertation end -- and now common list parameters (as much as possible) OCinSoutput["rft.date"] = data.Date; -- book, journal, dissertation for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all? if k == 'ISBN' then v = clean_isbn( v ) end local id = cfg.id_handlers[k].COinS; if string.sub( id or ""}, 1, 4 true ) == 'info' then -- for ids that are in the info:registry OCinSoutput["rft_id"] = table.concat{ id, "/", v }; elseif string.sub (id or "", 1, 3 ) == 'rft' then -- for isbn, issn, eissn, etc that have defined COinS keywords OCinSoutput[ id ] = v; elseif id then -- when cfg.id_handlers[k].COinS is not nil OCinSoutput["rft_id"] = table.concat{ cfg.id_handlers[k].prefix, v }; -- others; provide a url endadd error message
end
--[[ for k, v in pairs( data.ID_list ) do -- what to do about these? For now assume that they are common to all? local id, value = cfg.id_handlers[k].COinS; if k true == 'ISBN' lastfirst then value = clean_isbn( v ); else value = v; end if string.sub( id or "", return 1, 4 ) == 'info' then OCinSoutput["rft_id"] = table.concat{ id, "/", v }; else OCinSoutput[ id ] = value; end end]] local last, first; for k, v in ipairs( data.Authors ) do last, first = coins_cleanup (v.last), coins_cleanup (v.first or ''); -- replace any nowiki strip markers, non-printing or invisible characers if k == 1 then -- for the first return a number indicating which author name onlysource to use if is_set(last) and is_set(firstvxxxxors) then -- set these COinS values if |first= and |last= specify the first author name OCinSoutput["rft.aulast"] = lastreturn 2 end; -- book, journal, dissertation OCinSoutput["rft.aufirst"] = first; -- book, journal, dissertation elseif is_set(last) then OCinSoutput["rft.au"] = last; -- book, journal, dissertation -- otherwise use this form for the first name end else -- for all other authors if is_set(last) and is_set(firstxxxxors) then OCinSoutput["rft.au"] = table.concat{ last, ", ", first }; -- book, journal, dissertation elseif is_set(last) then OCinSoutput["rft.au"] = last; -- book, journal, dissertation return 3 end end end  OCinSoutput.rft_id = data.URL; OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage }; OCinSoutput = setmetatable( OCinSoutput, nil ); -- sort with version string always first, and combine. table.sort( OCinSoutput ); table.insert( OCinSoutput, return 1, "ctx_ver=" .. ctx_ver ); -- such as "Z39.88-2004" no authors so return table.concat(OCinSoutput, "&")1;this allows missing author name test to run in case there is a first without last
end
--[[--------------------------< G E T _ I S O 6 3 9 _ C O V A L I D _ P A R A M E T E R _ V A L U E >------------------------------------------------
Validates language names provided in |language= This function is used to validate a parameter's assigned value for those parameters that have only a limited numberof allowable values (yes, y, true, no, etc). When the parameter if value has not an ISO639-1 codebeen assigned a value (missing or emptyin the source template) the function returns true. Handles If the special case that parameter value is Norwegian whereone of the list of allowed values returnsISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDRtrue; else, emits an error message and returns false.
Returns the language name and associated ISO639-1 code. Because case of the source may be incorrect or different from the case that Wikimediauses, the name comparisons are done in lower case and when a match is found, the Wikimedia version (assumed to be correct) is returned alongwith the code. When there is no match, we return the original language name string.]]
mw.language.fetchLanguageNameslocal function is_valid_parameter_value (value, name, possible) if not is_set (value) will then return a list of languages that aren't part of ISO639true; -1. Names that aren't ISO639-1 but that are includedan empty parameter is ok elseif in_array(value:lower(), possible) thenin the list will be found if that name is provided in the |language= parameter return true; else table.insert( z. For examplemessage_tail, if |language=Samaritan Aramaic{ set_error( 'invalid_param_val', that {name will befound with the associated code 'sam', value}, true ) } ); -- not an ISO639-1 code. When names are found and the associated code is not two characters, this functionallowed value so add error message return false endreturns only the Wikimedia language name.end
Adapted from code taken from Module:Check ISO 639-1.
]]--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------
local This function get_iso639_code terminates a name list (author, contributor, editor) with a separator character (langsepc)and a space if 'norwegian' == lang:lowerwhen the last character is not a sepc character or when the last three characters are not sepc followed by twoclosing square brackets (close of a wikilink) then -- special case related to Wikimedia remap . When either of code 'no' at Extension:CLDR return 'Norwegian'these is true, 'no'; -- Make sure rendered version the name_list is properly capitalizedterminated with asingle space character. ]] end local function terminate_name_list (name_list, sepc) local languages = mw.language.fetchLanguageNamesif (mwstring.getContentLanguagesub (name_list,-3,-1):getCode(), == sepc .. 'all. ') then -- get a list of language names known to Wikimediaif already properly terminated return name_list; -- just return the name list elseif (string.sub ('all' is required for North Ndebelename_list, South Ndebele-1, and Ojibwa-1) local langlc = mw= sepc) or (string.ustring.lowersub (lang); name_list,-3,- lower case version for comparisons for code, name in pairs(languages1) do -- scan the list to see if we can find our language if langlc == mwsepc .ustring.lower(name) then if 2 ~= code:len(']]') then -- ISO639-1 codes onlyif last name in list ends with sepc char return namename_list .. " "; -- so return the name but not the codedon't add another end else return name, codename_list .. sepc .. ' '; -- found it, return otherwise terninate the name to ensure proper capitalization and the ISO639-1 code endlist
end
return lang; -- not valid language; return language in original case and nil for ISO639-1 code
end
--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
Get language name from ISO639-1 code value provided. If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.-[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------
There is an exception. There are three ISO639-1 codes for Norewegian language variants. There are two official variants: Norwegian Bokmål (code 'nb') andNorwegian Nynorsk (code 'nn'). The third, code 'no', is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless. However, it appearsthat on enwiki, editors are for returns the most part unaware concatenation of the nb formatted volume and nn variants (compare page counts for these variants at Category:Articles with non-English-language external links.issue parameters as a single string; or formatted volume Because Norwegian Bokmål is the most common language variantor formatted issue, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that andreturn 'Norwegian' when editors use |language=no. We presume that editors don't know about the variants or can't descriminate between them. See Help talk:Citation Style_1#An ISO 639-1 language name test When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) an empty string ifthe page is a mainspace page and the ISO639-1 code is not 'en'. Similarly, if the parameter is |language=Norwegian, it will be categorized in the same way. This function supports multiple languages in the form |language=nb, French, th where the language names or codes neither are separated from each other by commasset.
]]
 
local function language_parameter (lang)
local code; -- the ISO639-1 two character code
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
local names_table = {}; -- table made from the value assigned to |language=
 
names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
 
for _, lang in ipairs (names_table) do -- reuse lang
 
if lang:match ('^%a%a%-') or 2 == lang:len() then -- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
if lang:match ('^zh-') then
name = mw.language.fetchLanguageName( lang:lower(), lang:lower() );
else
name = mw.language.fetchLanguageName( lang:lower(), mw.getContentLanguage():getCode() ); -- get ISO 639-1 language name if Language is a proper code
end
end
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 (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then if is_set (namevolume) and is_set (issue) then return wrap_msg ('vol-- if Language specified a valid ISO639-1 codeno', {sepc, volume, issue}, lower); elseif is_set (volume) then code = lang:return wrap_msg ('vol', {sepc, volume}, lower(); -- save it
else
namereturn wrap_msg ('issue', {sepc, issue}, code = get_iso639_code (langlower); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
end
end  local vol = ''; if is_set (codevolume) then if 'no' == code (4 < mw.ustring.len(volume)) then name = '挪威语' end; -- override wikimedia when code is 'no' if 'zh' ~vol = code and not code:match substitute (cfg.messages['^zhj-vol') then -- English not the language add_prop_cat ('foreign_lang_source'], {namesepc, codevolume}) end;
else
add_maint_cat vol = substitute (cfg.presentation['unknown_langvol-bold'], {sepc, hyphen_to_dash(volume)}); -- add maint category if not already added
end
table.insert (language_list, name);
name = ''; -- so we can reuse it
end
code = #language_list -- reuse code as number of languages in the list if 2 >= code then name = table.concat is_set (language_list, '及'issue) -- insert '<space>及<space>' between two language names elseif 2 < code then language_list[code] = '及' return vol ..substitute (cfg. language_listmessages[code]; -'j- prepend last name with issue' 及<space>' name = table.concat (language_list], ','issue) -- and concatenate with '<comma><space>' separators;
end
return (" " .. wrap_msg ('language', name))vol; -- otherwise wrap with '(in ...)'
end
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
Set style settings for CS1 citation templates. Returns separator and postscript settings--[[-------------------------< 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
local function set_cs1_style (ps) if not is_set (ps) then -- unless explicitely set to something ps = 'Singular has priority over plural when both are provided.'; -- terminate the rendered citation with a period end return '.', ps; -- separator is a full stopend --[[--------------------------< 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 format_pages_sheets (pspage, refpages, sheet, sheets, cite_class, origin, sepc, nopp, lower) if not 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators if is_set (pssheet) then - if 'journal' == origin then return '', '', wrap_msg ('j- sheet', sheet, lower), ''; else return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), ''; end elseif is_set (sheets) then if |postscript'journal' == has not been setorigin then return '', '', '', wrap_msg ('j-sheets', sheets, lower); else return '', '', '', wrap_msg ('sheets', {sepc, sheets}, set cs2 defaultlower); end ps end end  local is_journal = 'journal' = = cite_class or (in_array (cite_class, {'citation', 'map'}) and 'journal' == origin); if is_set (page) then if is_journal then return substitute (cfg.messages['j-page(s)'], page), '', '', ''; elseif not nopp then return substitute (cfg.messages['p- make sure it isnprefix'], {sepc, page}), '', '', ''; else return substitute (cfg.messages['nopp'], {sepc, page}), '', '', ''t nil; end elseif is_set(pages) then if not is_set is_journal then return substitute (cfg.messages['j-page(s)'], pages), '', '', ''; elseif tonumber(refpages) ~= nil and not nopp then -- if |ref= pages is only digits, assume a single page number return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', ''; elseif not setnopp then return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', ''; ref = "harv"else return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', ''; -- set default |ref=harv end
end
return '','', ps'', ref''; -- separator is a commareturn empty strings
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 establishrendered style.[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
]]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 allowunwitting readers to do.
local When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its ownalgorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results. This function get_settings_from_cite_class (ps, ref, cite_class)looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and|archive-date= and an error message when: local sep;|archive-url= holds an archive.org save command url if |archive-url= is an archive.org url that does not have a complete timestamp (cite_class YYYYMMDDhhmmss 14 digits) in the correct placeotherwise returns |archive-url=and |archive-date= "citation") then  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 funct may return a modifiedarchive url: for citation templates save command errors, return undated wildcard (CS2/*/) sep for timestamp errors when the timestamp has a wildcard, psreturn the url unmodified for timestamp errors when the timestamp does not have a wildcard, ref return with timestamp limited to six digits plus wildcard (/yyyymm*/) ]= set_cs2_style ] local function archive_url_check (psurl, refdate) local err_msg = ''; -- start with the error message empty else local path, timestamp, flag; -- portions of the archive.or url if (not url:match('//web%.archive%.org/')) and (not a citation template so CS1url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url sepreturn url, ps = set_cs1_style (ps)date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
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 = 'save command'; url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL elseif url:match('//liveweb%.archive%.org/') then err_msg = 'liveweb'; else path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here err_msg = 'timestamp'; if '*' ~= flag then url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat) end elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element err_msg = 'path'; elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element) err_msg = 'flag'; elseif 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 = 'flag'; else return sepurl, date; -- return archiveURL and ArchiveDate end end -- if here, something not right so table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, pstrue ) } ); -- add error message and if is_set (Frame:preprocess('{{REVISIONID}}')) then return '', ref ''; -- return them allempty strings for archiveURL and ArchiveDate else return url, date; -- preview mode so return archiveURL and ArchiveDate end
end
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
Establish basic style settings --[[--------------------------< 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 equalsign, compare the alphanumeric string to be used when rendering the citationlist of cs1|2 parameters. Uses If found, then the string is possibly aparameter that is missing its pipe: {{cite ... |modetitle= if set and valid or usesTitle access-date=2016-03-17}} cs1|2 shares some parameter names with xml/html atributes: class=, title=, etc. To prevent false positives xml/htmlconfigtags are removed before the search.CitationClass from  If a missing pipe is detected, this function adds the template's #invoke: to establish stylemissing pipe maintenance category.
]]
local function set_style missing_pipe_check (mode, ps, ref, cite_classvalue) local sepcapture; if value = value:gsub ('%b<>', 'cs2' == mode then ); -- if this template is to be rendered in CS2 (citation) style sepremove xml/html tags because attributes: class=, ps, ref title= set_cs2_style (ps, ref);etc   elseif capture = value:match ('cs1' == mode then -- if this template is to be rendered in CS1 %s+(cite xxx%a[%a%d]+) style sep, ps %s*= set_cs1_style ') or value:match (ps'^(%a[%a%d]+); else -- anything but cs1 or cs2 sep, ps, ref %s*= get_settings_from_cite_class (ps, ref, cite_class'); -- get settings based on the template's CitationClass endfind and categorize parameters with possible missing pipes if 'none' == ps:lowercapture and validate (capture) then -- if assigned value the capture is 'none' thena valid parameter name ps = add_maint_cat ('missing_pipe'); -- set to empty string end return sep, ps, refend
--[=[-------------------------< I S _ P D F >------------------------------------------------------------------
Determines if a url has the file extension that is one of the pdf file extensions used by --[[MediaWiki:Common.css]] whenapplying the pdf icon to external links.--------------------------< C I T A T I O N 0 >------------------------------------------------------------
returns true if file extension This is one the main function doing the majority of the recognized extension, else falsecitation formatting.
]=]
local function is_pdf citation0(urlconfig, args) return url:match ('%--[[ Load Input Parameters The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.pdf[%?# ]]?') or url:match local A = argument_wrapper('%.PDF[%?#]?'args );end local i
--[[--------------------------< S T Y L E _ F O R M A T >----------------------------------------------------Pick out the relevant fields from the arguments. Different citation templates --define different field names for the same underlying things.
Applies css style to -- set default parameter values defined by |formatmode=, |chapter-formatparameter. local Mode =, etc. Also emits an error message A['Mode']; if the format parameter doesnot have a matching url parameteris_valid_parameter_value (Mode, 'mode', cfg. If the format parameter is not set and the url contains a file extension thatkeywords['mode']) thenis recognized as a pdf document by MediaWiki Mode = ''s commons.css, this code will set the format parameter to (PDF) with;the appropriate styling. end
local author_etal; local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= local Authors; local NameListFormat = A['NameListFormat']; local Collaboration = A['Collaboration'];
do -- to limit scope of selected local function style_format selected = select_author_editor_source (formatA['Vauthors'], urlA['Authors'], fmt_paramargs, url_param'AuthorList'); if is_set 1 == selected then a, author_etal = extract_names (formatargs, 'AuthorList') ; -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn= elseif 2 == selected then NameListFormat = 'vanc'; -- override whatever |name-list-format = wrap_style might be a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'formatAuthorList', format); -- add leading spacefetch author list from |vauthors=, parenthases|author-linkn=, resizeand |author-maskn= elseif 3 == selected then Authors = A['Authors']; -- use content of |authors= if not is_set 'authors' == A:ORIGIN(url'Authors') then -- but add a maint cat if the parameter is |authors= format = format .. set_error add_maint_cat ( 'format_missing_urlauthors', {fmt_param, url_param} ); -- because use of this parameter is discouraged; what to do about the aliases is a TODO: end end if is_set (Collaboration) then author_etal = true; --so that |display- add an error messageauthors=etal not required
end
elseif is_pdf (url) then -- format is not set so if url is a pdf file then
format = wrap_style ('format', 'PDF'); -- set format to pdf
else
format = ''; -- empty string for concatenation
end
return format;
end
--[ local Others = A[--------------------------< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >------------------------'Others'];
Returns a number that may or may not limit the length of the author local editor_etal; local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or editor name lists.|veditors= local Editors;
When the value assigned do -- to limit scope of selected local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList'); if 1 == selected then e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |displayeditor-authorsfirstn=, |editor-linkn= is a number greater than or equal to zero, return the number and|editor-maskn=the previous state of the elseif 2 == selected then NameListFormat = 'etalvanc' flag (false by default but may have been set to true if the ; -- override whatever |name -list contains-format= might besome variant e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn= elseif 3 == selected then Editors = A['Editors']; -- use content of the text |editors= add_maint_cat ('et al.editors').; -- but add a maint cat because use of this parameter is discouraged end end
When the value assigned to local t = {}; -- translators list from |displaytranslator-lastn= / translator-authorsfirstn= is the keyword 'etal', return a number that is one greater than thepairsnumber of authors in the local Translators; -- assembled translators name list and set the t = extract_names (args, 'etalTranslatorList' flag true. This will cause the list_people() to display all ofthe names in the name ; -- fetch translator list followed by 'et al.'from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
In all other cases, returns nil and local interviewers_list = {}; local Interviewers = A['Interviewers'] if is_set (Interviewers) then -- add a maint cat if the previous state |interviewers= is used add_maint_cat ('interviewers'); -- because use of the this parameter is discouraged else interviewers_list = extract_names (args, 'etalInterviewerList' flag.); -- else, process preferred interviewers parameters end
]] local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs local Contributors; -- assembled contributors name list local function get_display_authors_editors Contribution = A['Contribution']; if in_array(maxconfig.CitationClass, count{"book", list_name, etal"citation"}) if and not is_set (maxA['Periodical']) then-- |contributor= and |contribution= only supported in book cites if 'etal' c == max:lower():gsubextract_names ("[ '%.]"args, 'ContributorList') then ; -- the :gsub() portion makes 'etal' fetch contributor list from a variety of 'et al.' spellings and stylings max |contributorn= count + 1; / |contributor-lastn=, - number of authors + 1 so display all author name plus et al. etal firstn= true; , -linkn=, - overrides value set by extract_namesmaskn= if 0 < #c then if not is_set (Contribution)then -- |contributor= requires |contribution= elseif max:match table.insert( z.message_tail, { set_error('^%d+$contributor_missing_required_param', 'contribution') then }); -- if is a string of numbersadd missing contribution error message max c = tonumber (max){}; -- make blank the contributors' table; it is used as a numberflag later end if max >0 = count and 'authors' == list_name #a then -- AUTHORS ONLY -- if |display-xxxxorscontributor= requires |author= value greater than or equal to number of authors/editors add_maint_cat table.insert( z.message_tail, { set_error('disp_auth_edcontributor_missing_required_param', list_name'author')}); -- add missing author error message c = {}; -- blank the contributors' table; it is used as a flag later
end
else -- not a valid keyword or number
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message
max = nil; -- unset
end
elseif else -- if not a book cite if select_one (args, cfg.aliases['ContributorList-Last'authors], ' == list_name redundant_parameters', 1 ) then -- AUTHORS ONLY need to clear implicit et al categoryare there contributor name list parameters? table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message max end Contribution = count + 1nil; -- number of authors + 1unset
end
return max, etal;
end
if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------'name-list-format']) then --only accepted value for this parameter is 'vanc' NameListFormat = ''; --anything else, set to empty string end
Adds page to Category:CS1 maint: extra text if |page local Year = A['Year']; local PublicationDate = or |pagesA['PublicationDate']; local OrigYear = has what appears to be some form of p. or pp. A['OrigYear'];abbreviation in the first characters of the parameter content. local Date = A['Date']; local LayDate = A['LayDate'];check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value: ------------------------------------------------- Get title data good pattern: local Title = A['Title'^P]; local ScriptTitle = A[^%.P%l'ScriptTitle']; local BookTitle = A['BookTitle' matches when |page(s)]; local Conference = begins PX or P# but not Px where x and X are letters and # is a dgiitA['Conference']; bad pattern: local TransTitle = A['TransTitle'^]; local TitleNote = A[Pp'TitleNote']; local TitleLink = A[Pp'TitleLink']; link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, ' matches matches title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |page(s)title-link= begins pp or pP or Pp or PPis set
local Chapter = A['Chapter']; local ScriptChapter = A['ScriptChapter']; local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode local TransChapter = A['TransChapter']; local TitleType = A['TitleType']; local Degree = A['Degree']; local Docket = A['Docket']; local ArchiveFormat = A['ArchiveFormat'];
local function extra_text_in_page_check (page)-- local good_pattern = '^P[^%.P%l]'; local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg?-- local bad_pattern = '^[Pp][Pp]'ArchiveDate; local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'ArchiveURL;
if not page:match (good_pattern) and (page:match (bad_pattern) or page:match ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'^], A[Pp]ages?')) then add_maint_cat ('extra_textArchiveDate']); end-- if Page:match ('^[Pp]?[Pp]%.?local DeadURL = A[ %d]') or Page:match (DeadURL'^[Pp]ages?[ %d]') or-- Pages:match if not is_valid_parameter_value (DeadURL, 'dead-url'^[Pp]?[Pp]%, cfg.?keywords [ %d]') or Pages:match (deadurl'^[Pp]ages?[ %d]') then-- set in config.defaults to 'yes' add_maint_cat (DeadURL = 'extra_text'); -- endanything else, set to empty string end
local URL = A['URL']
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local ChapterURL = A['ChapterURL'];
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local ConferenceFormat = A['ConferenceFormat'];
local ConferenceURL = A['ConferenceURL'];
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
local Periodical = A['Periodical'];
local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
--[ local Series = A[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------'Series'];This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and |xxxxor-linkn= in args. It then returns a table of assembled names just as extract_names() does. local Volume; local Issue;Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names local Page;may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance local Pages;tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests. local At;
This function sets the vancouver error when a reqired comma is missing if in_array (config.CitationClass, cfg.templates_using_volume) then Volume = A['Volume']; end -- conference & map books do not support issue if in_array (config.CitationClass, cfg.templates_using_issue) and when there is a space between an authornot (in_array (config.CitationClass, {'s initialsconference', 'map'}) and not is_set (Periodical))then Issue = A['Issue']; end local Position = ''; if not in_array (config.CitationClass, cfg.templates_not_using_page) then Page = A['Page']; Pages = hyphen_to_dash( A['Pages']); At = A['At']; end
local function parse_vauthors_veditors (args, vparam, list_name)Edition = A['Edition']; local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linknPublicationPlace =A['PublicationPlace'] local v_name_table Place = {}A['Place']; local etal PublisherName = falseA['PublisherName']; -- return value set to true when we find some form of et al. vauthors parameter local lastRegistrationRequired = A['RegistrationRequired']; if not is_valid_parameter_value (RegistrationRequired, first'registration', link, mask;cfg.keywords ['yes_true_y']) then local corporate RegistrationRequired= falsenil; end
vparam, etal local SubscriptionRequired = name_has_etal (vparam, etal, true)A['SubscriptionRequired']; -- find and remove variations on et al. do not categorize (do it here because et al. might have a period) if vparam:find not is_valid_parameter_value (SubscriptionRequired, 'subscription'%[%, cfg.keywords [') or vparam:find (yes_true_y'%]%]') then -- no wikilinking vauthors names add_vanc_error () SubscriptionRequired=nil; end v_name_table = mw.text.split(vparam, "%s*,%s*") -- names are separated by commas
for i, v_name in ipairs(v_name_table) do if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parenthese to supress vanc formatting and error detection first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor last local UrlAccess = v_name:match (A['^%(%((.+)%)%)$UrlAccess') corporate = true]; elseif string.find(v_name, "%s") then lastfirstTable = {} lastfirstTable = mw.text.split(v_name, "%s") first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are if not initials if mw.ustring.match is_valid_parameter_value (lastUrlAccess, '%a+%s+%u+%s+%a+url-access') or mw.ustring, cfg.match (v_name, keywords [' %u %u$url-access']) then add_vanc_error (); -- matches last II last; the case when a comma is missing or a space between two intiials end else first UrlAccess = ''nil; -- set to empty string for concatenation and because it may have been set for previous author/editor last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?
end
if not is_set (firstURL) and not mw.ustring.match is_set(first, "^%u?%u$"UrlAccess) then -- first shall contain one or two upper-case letters, nothing else add_vanc_error UrlAccess = nil; table.insert( z.message_tail, { set_error('param_access_requires_param', {'url'}, true ) } );
end
-- this from extract_names ()
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list
end
return names, etal; -- all done, return our list of names
end
if is_set (UrlAccess) and is_set (SubscriptionRequired) then --[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------while not aliases, these are much the same so if both are set table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); --add error message SubscriptionRequired = nil; --unset; prefer |access= over |subscription= end if is_set (UrlAccess) and is_set (RegistrationRequired) then --these are not the same but contradictory so if both are set table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'registration')}, true ) } ); --add error message RegistrationRequired = nil; --unset; prefer |access= over |registration= end
Select one of |authors local ChapterUrlAccess =A['ChapterUrlAccess']; if not is_valid_parameter_value (ChapterUrlAccess, |authorn= / |lastn / firstn='chapter-url-access', or |vauthorscfg.keywords ['url-access']) then -- same as url-access ChapterUrlAccess = as the source of the author name list ornil; end if not is_set(ChapterURL) and is_set(ChapterUrlAccess) thenselect one of |editors ChapterUrlAccess =nil; table.insert( z.message_tail, |editorn= / editor{ set_error( 'param_access_requires_param', {'chapter-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.url'}, true ) } ); end
Only one of these appropriate three will be used. The hierarchy is: |authorn local Via = (and aliases) highest and |authorsA['Via']; local AccessDate = lowest andA['AccessDate'];similarly, |editorn= (and aliases) highest and |editors local Agency = lowestA['Agency'];
When looking for |authorn local Language = / |editornA['Language']; local Format = A['Format']; local ChapterFormat = A['ChapterFormat']; local DoiBroken = parameters, test |xxxxor1A['DoiBroken']; local ID = A['ID']; local ASINTLD = and |xxxxor2A['ASINTLD']; local IgnoreISBN = (and all of their aliases)A['IgnoreISBN']; stops after the secondtest which mimicks the test used in extract_names if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) when looking for a hole in the author name list. There may be a betterthenway IgnoreISBN = nil; -- anything else, set to do this, I just havenempty string end local Embargo = A['Embargo']; local Class = A['Class't discovered what that way is.]; -- arxiv class identifier
Emits an error message when more than one xxxxor name source is provided. local ID_list = extract_ids( args ); local ID_access_levels = extract_id_access_levels( args, ID_list );
In this function, vxxxxors local Quote = vauthors or veditorsA['Quote']; xxxxors = authors or editors as appropriate.
local LayFormat = A['LayFormat']; local LayURL = A['LayURL']; local LaySource = A['LaySource']; local Transcript = A['Transcript']; local TranscriptFormat = A['TranscriptFormat']; local TranscriptURL = A['TranscriptURL'] local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)local lastfirst LastAuthorAmp = falseA['LastAuthorAmp']; if select_onenot is_valid_parameter_value ( argsLastAuthorAmp, cfg.aliases[list_name .. 'last-Lastauthor-amp'], 'none', 1 ) or -- do this twice incase we have a first 1 without a last1 select_one( args, cfg.aliaseskeywords [list_name .. '-Lastyes_true_y'], 'none', 2 ) then lastfirstLastAuthorAmp =truenil; -- set to empty string end
if (is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions (is_set (vxxxxors) and is_set (xxxxors)) or (true == lastfirst and is_set (xxxxors)) then local err_name; if 'AuthorList' == list_name then -- figure out which name should be used in error message err_name no_tracking_cats = A['authorNoTracking']; else err_name = 'editor'; end table.insert if not is_valid_parameter_value ( z.message_tailno_tracking_cats, { set_error( 'redundant_parametersno-tracking', {err_name .cfg. keywords ['-name-list parametersyes_true_y'}, true ) } ])then no_tracking_cats = nil; -- add error messageset to empty string end
if true == lastfirst then return 1 end; -- return a number indicating which author name source to uselocal variables that are not cs1 parameters if is_set (vxxxxors) then return 2 endlocal use_lowercase; -- controls capitalization of certain static text if is_set local this_page = mw.title.getCurrentTitle(xxxxors) then return 3 end; -- also used for COinS and for language return 1local anchor_year; -- no authors so return 1; this allows missing author name test to run used in case there is a first without last the CITEREF identifierend local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
local DF = A['DF']; -- date format set in cs1|2 template
if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword
DF = ''; -- not valid, set to empty string
end
local sepc; --separator between citation elements for CS1 a period, for CS2, a comma local PostScript; local Ref; sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); use_lowercase = ( sepc == ',' ); --------------------------< I S _ V A L I D _ P A R A M E T E R _ V A L U E >------------------------------used to control capitalization for certain static text
This function --check this page to see if it is in one of the namespaces that cs1 is used not supposed to validate a parameter's assigned value for those parameters that have only a limited numberadd to the error categories if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this pageof allowable values if in_array (yes, ythis_page.nsText, cfg.uncategorized_namespaces) then no_tracking_cats = "true"; -- set no_tracking_cats end for _, no, etcv in ipairs (cfg.uncategorized_subpages)do -- cycle through page name patterns if this_page. When the parameter value has not been assigned a value text:match (missing or emptyv) then -- test page name against each patternin the source template) the function refurns no_tracking_cats = "true. If the parameter value "; -- set no_tracking_cats break; -- bail out if one is one of the list of allowed values returnsfound end endtrue; else, emits an error message and returns false. end
]] -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category
local function is_valid_parameter_value (value, name, possible)NoPP = A['NoPP'] if not is_set (valueNoPP) then return true; -- an empty parameter is ok elseif in_arrayand is_valid_parameter_value (value:lower()NoPP, 'nopp', possiblecfg.keywords ['yes_true_y']) then return NoPP = true;
else
table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } )NoPP = nil; -- not an allowed value so add error message return falseunset, used as a flag later
end
end
if is_set(Page) then
if is_set(Pages) or is_set(At) then
Pages = ''; -- unset the others
At = '';
end
extra_text_in_page_check (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_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
end
--[[both |publication--------------------------< 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) place= and a spacewhen the last character is not a sepc character or when the last three characters are not sepc followed by twoclosing square brackets |place= (close of a wikilink). When either of these is true, the name_list is terminated with asingle space character. ]] local function terminate_name_list (name_list, sepc|location=)allowed if different if not is_set(string.sub (name_list,-1,-1PublicationPlace) == sepc) or (string.sub and is_set(name_list,-3,-1) == sepc .. ']]'Place) then -- if last name in list ends with sepc char return name_list .. " "PublicationPlace = Place; -- don't add another else return name_list .. sepc .. ' '; -promote |place= (|location=) to |publication- otherwise terninate the name listplace
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same --[[ Parameter remapping for cite encyclopedia: When the citation has these parameters: |encyclopedia and |title then map |title to |article and |encyclopedia to |title |encyclopedia and |article then map |encyclopedia to |title |encyclopedia then map |encyclopedia to |title |trans-title maps to |trans-chapter when |title is re-mapped |url maps to |chapterurl when |title is remapped All other combinations of |encyclopedia, |title, and |article are not modified ]]
local Encyclopedia = A['Encyclopedia'];
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then --[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >------------------------------------test code for citation if is_set(Periodical) then --Periodical is set when |encyclopedia is set if is_set(Title) or is_set (ScriptTitle) then if not is_set(Chapter) then Chapter = Title; --|encyclopedia and |title are set so map |title to |article and |encyclopedia to |title ScriptChapter = ScriptTitle; TransChapter = TransTitle; ChapterURL = URL; ChapterUrlAccess = UrlAccess;
returns the concatenation of the formatted volume if not is_set (ChapterURL) and issue parameters as a single stringis_set (TitleLink) then Chapter = make_wikilink (TitleLink, Chapter); end Title = Periodical; ChapterFormat = Format; Periodical = ''; -- redundant so unset TransTitle = ''; URL = ''; Format = ''; TitleLink = ''; ScriptTitle = ''; or formatted volume end else -- |title not set Title = Periodical; -- |encyclopedia set and |article set or formatted issue, or an empty string if neither are not set.so map |encyclopedia to |title Periodical = ''; -- redundant so unset end end end
]] -- Special case for cite techreport. local function format_volume_issue if (volume, issue, cite_class, origin, sepc, lowerconfig.CitationClass == "techreport")then -- special case for cite techreport if not is_set (volumeA['Number']) and then -- cite techreport uses 'number', which other citations alias to 'issue' if not is_set (issueID) then -- can we use ID for the "number"? ID = A['Number']; -- yes, use it else -- ID has a value so emit error message return table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); end end
end
  -- special case for cite mailing list if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' config.CitationClass == origin"mailinglist") then if is_set (volume) and is_set (issue) then return wrap_msg (Periodical = A ['vol-noMailingList', {sepc, volume, issue}, lower)]; elseif is_set (volume) then return wrap_msg 'mailinglist' == A:ORIGIN('volPeriodical', {sepc, volume}, lower);then else return wrap_msg (Periodical = 'issue', {sepc, issue}, lower); end -- unset because mailing list is only used for cite mailing list
end
local vol = '';
if is_set (volume) then
if (6 < mw.ustring.len(volume)) then
vol = substitute (cfg.messages['j-vol'], {sepc, volume});
else
vol = wrap_style ('vol-bold', hyphen_to_dash(volume));
end
end
if is_set (issue) then
return vol .. substitute (cfg.messages['j-issue'], issue);
end
return vol;
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 Account for the others set to empty strings.The return order oddity that is: page{{cite conference}}, pages, sheet, sheets Singular has priority over plural when both are providedbefore generation of COinS data]] local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower) if 'mapconference' == cite_class config.CitationClass then -- only cite map supports sheet(s) as in-source locators if is_set (sheetBookTitle) then if 'journal' Chapter = Title;-- ChapterLink =TitleLink; -- |chapterlink= origin thenis deprecated ChapterURL = URL; return '', '', wrap_msg ('j-sheet', sheet, lower), '' ChapterUrlAccess = UrlAccess; elseChapterURLorigin = URLorigin; return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), URLorigin = ''; endChapterFormat = Format; elseif is_set (sheets) then TransChapter = TransTitle; if 'journal' Title =BookTitle; Format = origin then return '', ;-- TitleLink = '', ; TransTitle = '', wrap_msg ('j-sheets', sheets, lower); else return '', '', URL = '', wrap_msg ('sheets', {sepc, sheets}, lower); end
end
elseif 'speech' ~= config.CitationClass then
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end
-- cite map oddities local Cartography = ""; local Scale = ""; local Sheet = A['Sheet'] or ''; local is_journal Sheets = A['Sheets'journal] or ' '; if config.CitationClass == cite_class or "map" then Chapter = A['Map']; ChapterURL = A['MapURL']; ChapterUrlAccess = UrlAccess; TransChapter = A['TransMap']; ChapterURLorigin = A:ORIGIN('MapURL'); ChapterFormat = A['MapFormat']; Cartography = A['Cartography']; if is_set(in_array Cartography ) then Cartography = sepc .. " " .. wrap_msg (cite_class, {'citationcartography', Cartography, use_lowercase); end Scale = A['mapScale']; if is_set( Scale ) then Scale = sepc .. " " .. Scale; end end  -- Account for the oddities that are {{cite episode}}) and {{cite serial}}, before generation of COinS data. if 'episode' == config.CitationClass or 'journalserial' == originconfig.CitationClass then local AirDate = A['AirDate']; local SeriesLink = A['SeriesLink'];  link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series');-- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set
if is_set (page) then if is_journal then return substitute (cfg.messageslocal Network = A['j-page(s)Network'], page), '', '', ''; elseif not nopp then return substitute (cfg.messageslocal Station = A['p-prefixStation'], {sepc, page}), '', '', ''; else return substitute (cfg.messages['nopp']local s, n = {sepc}, page{}), '', '', ''; -- do common parameters first end elseif if is_set(pagesNetwork) then if is_journal then return substitute (cfgtable.messages['j-pageinsert(s)']n, pagesNetwork), '', '', '';end elseif tonumberif is_set(pagesStation) ~= nil and not nopp then -- if pages is only digits, assume a single page number return '', substitute table.insert(cfg.messages['p-prefix'], {sepcn, pages}Station), '', '';end elseif not nopp then return ''ID = table.concat(n, substitute (cfgsepc ..messages['pp-prefix'], {sepc, pages}), '', ''; else return '', substitute if not is_set (Date) and is_set (cfg.messages['nopp'], {sepc, pages}AirDate), '', ''then -- promote airdate to date Date = AirDate;
end
end
return '', '', '', ''; -- return empty strings
end
if 'episode' == config.CitationClass then --handle the oddities that are strictly {{cite episode}} local Season = A['Season']; local SeriesNumber = A[--------------------------< C I T A T I O N 0 >------------------------------------------------------------'SeriesNumber'];
This is the main function doing the majority of the citation formatting if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'season') .. ' and ' ..wrap_style ('parameter', 'seriesno')}, true ) } ); -- 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)); endlocal function citation0 if is_set(SeriesNumber) then table.insert(s, wrap_msg ( config'series', SeriesNumber, argsuse_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 Load Input Parameters The argument_wrapper facilitates the mapping of multiple aliases Chapter = Title; -- promote title parameters to single internal variable.chapter ScriptChapter = ScriptTitle; ChapterLink = TitleLink; -- alias episodelink TransChapter = TransTitle; ChapterURL = URL; ]] ChapterUrlAccess = UrlAccess; local ChapterURLorigin = A :ORIGIN('URL'); Title = Series; -- promote series to title TitleLink = SeriesLink; Series = argument_wrappertable.concat( args s, sepc .. ' '); local i -- this is concatenation of season, seriesno, episode number
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL Chapter = make_wikilink (ChapterLink, Chapter); elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode; Series = make_wikilink (ChapterLink, Series); end URL = ''; -- unset TransTitle = ''; ScriptTitle = ''; else -- now oddities that are cite serial Issue = ''; -- Pick out unset because this parameter no longer supported by the relevant fields from the arguments. Different citation templates/core version of cite serial Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday? if is_set (Series) and is_set (SeriesLink) then Series = make_wikilink (SeriesLink, Series); end Series = wrap_style ('italic-title', Series); -- series is italicized end end -- end of {{cite episode}} stuff  -- define different field names Account for the same underlying thingsoddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data. local author_etal;do local a = if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}; ) then if not is_set (ID_list[config.CitationClass:upper()]) then -- authors list from |lastnarxiv= / or |eprint= required for cite arxiv; |firstnbiorxiv= pairs or & |vauthorsciteseerx=required for their templates table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); local Authors;-- add error message end if 'arxiv' == config.CitationClass then local NameListFormat Periodical = A['NameListFormatarXiv']; -- set to arXiv for COinS; after that, must be set to empty string end
do -- to limit scope of selected local selected = select_author_editor_source (A['Vauthors'], A[ if 'Authorsbiorxiv'], args, 'AuthorList'); if 1 == selected config.CitationClass then a, author_etal Periodical = extract_names (args, 'AuthorListbioRxiv'); -- fetch author list from |authorn= / |lastn= / |firstn=set to bioRxiv for COinS; after that, |author-linkn=, and |author-maskn=must be set to empty string end elseif 2 == selected then NameListFormat = if 'vancciteseerx'; -- override whatever |name-list-format= might be= config.CitationClass then a, author_etal Periodical = parse_vauthors_veditors (args, args.vauthors, 'AuthorListCiteSeerX'); -- fetch author list from |vauthors=set to CiteSeerX for COinS; after that, |author-linkn=, and |author-maskn= elseif 3 == selected thenmust be set to empty string Authors = A['Authors']; -- use content of |authors=end
end
end
local Coauthors -- handle type parameter for those CS1 citations that have default values if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then TitleType = A['Coauthors']set_titletype (config.CitationClass, TitleType); local Others if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis TitleType = ADegree .. ' ' .. cfg.title_types ['Othersthesis']:lower(); end end
local editor_etal;if is_set(TitleType) then -- if type parameter is specified local e TitleType = {}substitute( cfg.messages['type'], TitleType); -- editors list from |editordisplay it in parentheses -lastn= / |editor-firstn= pairs or |veditors=TODO: Hack on TitleType to fix bunched parentheses problem local Editors;end
do -- legacy: promote PublicationDate to limit scope of selectedDate if neither Date nor Year are set. local selected = select_author_editor_source if not is_set (A['Veditors'], A['Editors'], args, 'EditorList'Date);then if 1 == selected then e, editor_etal Date = extract_names (args, 'EditorList')Year; -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=promote Year to Date elseif 2 == selected then NameListFormat Year = 'vanc'nil; -- override whatever |name-list-format= might bemake nil so Year as empty string isn't used for CITEREF e, editor_etal = parse_vauthors_veditors if not is_set (Date) and is_set(args, args.veditors, 'EditorList'PublicationDate); then -- fetch editor list from |veditors=, use PublicationDate when |editor-linkndate=, and |editor-masknyear=are not set elseif 3 Date == selected thenPublicationDate; -- promote PublicationDate to Date Editors PublicationDate = A['Editors']; -- use content of |editors=unset, no longer needed
end
end
local t if PublicationDate = {}; -- translators list from |translator-lastn= / translator-firstnDate then PublicationDate = pairs local Translators; -- assembled translators name list t = extract_names (args, 'TranslatorList'); end -- fetch translator list from |translatorn= / |translator-lastn=if PublicationDate is same as Date, don't display in rendered citation  -firstn=, -linkn=, [[ Go test all of the date-maskn=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 ]] do -- create defined block to contain local c variables error_message, date_parameters_list, mismatch local error_message = {}''; -- contributors list from |contributorAirDate has been promoted to Date so not necessary to check it local date_parameters_list = {['access-date']=AccessDate, ['archive-lastndate']=ArchiveDate, ['date']= / contributorDate, ['doi-broken-firstndate']= pairsDoiBroken, local Contributors; ['embargo']=Embargo, ['lay-date']=LayDate, ['publication- assembled contributors name list local Contribution date']= APublicationDate, ['Contributionyear']=Year};  anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);-- start temporary Julian / Gregorian calendar uncertainty categorization if COinS_date.inter_cal_cat then add_prop_cat ('jul_greg_uncertainty'); end-- end temporary Julian / Gregorian calendar uncertainty categorization  if in_arrayis_set (config.CitationClass, {"book","citation"}Year) and not is_set(A['Periodical']Date) then -- both |contributordate= and |contributionyear= only supported in book citesnot normally needed; c local mismatch = extract_names year_date_check (argsYear, 'ContributorList'Date); if 0 == mismatch then -- fetch contributor list from |contributornyear= / does not match a year-value in |contributordate= if is_set (error_message) then --lastnif there is already an error message error_message =error_message .. ', '; -firstn- tack on this additional message end error_message =, error_message .. '&#124;year= / &#124;date= mismatch'; elseif 1 == mismatch then --linkn|year=, matches year-masknvalue in |date= add_maint_cat ('date_year'); end end if 0 < #c not is_set(error_message) then -- error free dates only local modified = false; -- flag if not is_set (ContributionDF) then -- |contributor= requires |contribution=if we need to reformat dates table.insertmodified = reformat_dates ( z.message_taildate_parameters_list, { set_error( 'contributor_missing_required_param'DF, 'contribution'false)}; -- reformat to DF format, use long month names if appropriate end  if true == date_hyphen_to_dash (date_parameters_list); then -- add missing contribution error messageconvert hyphens to dashes where appropriate c modified = {}true; add_maint_cat ('date_format'); -- blank the contributors' table; it is used as a flag laterhyphens were converted so add maint category
end
-- for those wikis that can and want to have English date names translated to the local language, -- uncomment these three lines. Not supported by en.wiki (for obvious reasons)-- if 0 date_name_xlate (date_parameters_list) then-- modified == #a true;-- end  if modified then -- |contributor= requires |authorif the date_parameters_list values were modified AccessDate =date_parameters_list['access-date']; -- overwrite date holding parameters with modified values table.insert( z.message_tail, { set_error( ArchiveDate = date_parameters_list['contributor_missing_required_paramarchive-date', ]; Date = date_parameters_list['authordate')})]; DoiBroken = date_parameters_list['doi-broken- add missing author error messagedate']; c LayDate = {}date_parameters_list['lay-date']; - PublicationDate = date_parameters_list['publication- blank the contributorsdate' table]; it is used as a flag later
end
else
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
end
else -- if not a book cite if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters? table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message end Contribution = nil; -- unset endof do
-- 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 is_valid_parameter_value embargoed (NameListFormat|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date Embargo = is_embargoed (Embargo);  if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC'name]) then if not is_set (Embargo) then -list-formatif not embargoed or embargo has expired URL=cfg.id_handlers['PMC', cfg].prefix ..keywordsID_list['namePMC']; -list-formatset url to be the same as the PMC external link if not embargoed URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title= if is_set(AccessDate) then -- only accepted value for this parameter access date requires |url=; pmc created url is not |url= table.insert( z.message_tail, { set_error( 'vancaccessdate_missing_url', {}, true ) } ); NameListFormat AccessDate = ''; -- anything else, set to empty stringunset end
local Year = A['Year'];
local PublicationDate = A['PublicationDate'];
local OrigYear = A['OrigYear'];
local Date = A['Date'];
local LayDate = A['LayDate'];
------------------------------------------------- Get title data
local Title = A['Title'];
local ScriptTitle = A['ScriptTitle'];
local BookTitle = A['BookTitle'];
local Conference = A['Conference'];
local TransTitle = A['TransTitle'];
local TitleNote = A['TitleNote'];
local TitleLink = A['TitleLink'];
if is_set (TitleLink) and false == link_param_ok (TitleLink) then
table.insert( z.message_tail, { set_error( 'bad_paramlink', A:ORIGIN('TitleLink'))}); -- url or wikilink in |title-link=;
end
end
local Chapter = A[-- At this point fields may be nil if they weren'Chapter'];t specified in the template use. We can use that fact. local ScriptChapter = A['ScriptChapter']; local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episodeTest if citation has no title local TransChapter = A['TransChapter'];if not is_set(Title) and local TitleType = A['TitleType']; not is_set(TransTitle) and local Degree = A['Degree']; not is_set(ScriptTitle) then local Docket = A[ if 'Docketepisode']; local ArchiveFormat = A['ArchiveFormat']; local ArchiveURL = A['ArchiveURL']; local URL = A['URL'] local URLorigin = A:ORIGIN('URL'); config.CitationClass then -- get name of parameter that holds URL local ChapterURL = A['ChapterURL']special case for cite episode;TODO: is there a better way to do this? local ChapterURLorigin = A:ORIGIN table.insert( z.message_tail, { set_error('ChapterURLcitation_missing_title'); -- get name of parameter that holds ChapterURL local ConferenceFormat = A[, {'ConferenceFormatseries']}, true ) } ); local ConferenceURL = A['ConferenceURL']; else local ConferenceURLorigin = A:ORIGIN table.insert( z.message_tail, { set_error('ConferenceURLcitation_missing_title'); -- get name of parameter that holds ConferenceURL local Periodical = A[, {'Periodical']; local Periodical_origin = A:ORIGIN('Periodicaltitle'}, true ) } ); -- get the name of the periodical parameter end local Series = A['Series'];end
local Volume; local Issue; local Page; local Pages; local At;  if in_array (config.CitationClass, cfg.templates_using_volume) and not ('conferencenone' == config.CitationClass and not is_set (Periodical)) then Volume = A['Volume']; end if in_array (config.CitationClass, cfg.templates_using_issue) Title and not (in_array (config.CitationClass, {'conferencejournal', 'mapcitation'}) and not is_set (Periodical))then Issue = A[and 'Issuejournal']; end local Position = = A:ORIGIN('Periodical'; if not in_array (config.CitationClass, cfg.templates_not_using_page) then-- special case for journal cites Page Title = A['Page']; -- set title to empty string Pages = hyphen_to_dashadd_maint_cat ( A['Pagesuntitled'] ); At = A['At'];
end
local Edition check_for_url ({ -- add error message when any of these parameters contains a URL ['title']= Title, [A[:ORIGIN('EditionChapter')];=Chapter, local PublicationPlace = [A[:ORIGIN('PublicationPlacePeriodical')]=Periodical, local Place = [A[:ORIGIN('PlacePublisherName')]= 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 PublisherName coins_chapter = A['PublisherName']Chapter; -- default assuming that remapping not required local RegistrationRequired coins_title = A['RegistrationRequired']Title; -- et tu if not is_valid_parameter_value (RegistrationRequired, 'registrationencyclopaedia', cfg== config.keywords [CitationClass or ('yes_true_ycitation']== config.CitationClass and is_set (Encyclopedia)) then RegistrationRequired=nil; end local SubscriptionRequired = A['SubscriptionRequired']; if not is_valid_parameter_value is_set (Chapter) and is_set (Title) and is_set (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']Periodical) then -- if all are used then coins_chapter = Title; -- remap SubscriptionRequiredcoins_title =nilPeriodical;
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() local Via OCinSoutput = COinS({ ['Periodical'] = Periodical, ['Encyclopedia'] = Encyclopedia, ['Chapter'] = Amake_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup ['ViaDegree']= Degree; -- cite thesis only local AccessDate ['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup ['PublicationPlace'] = APublicationPlace, ['AccessDateDate']= COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid; local ArchiveDate ['Season'] = ACOinS_date.rftssn, ['ArchiveDateChron']= 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, local Agency ['Issue'] = AIssue, ['AgencyPages'];= get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links local DeadURL ['Edition'] = AEdition, ['DeadURLPublisherName']= PublisherName, if not is_valid_parameter_value ['URL'] = first_set (DeadURL{ChapterURL, URL}, 2), ['Authors'] = coins_author, ['dead-urlID_list'] = ID_list, cfg.keywords ['deadurlRawPage']= this_page.prefixedText, }, config.CitationClass);  -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data. if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then -- we have set rft.jtitle in config.defaults COinS to arXiv, bioRxiv, or CiteSeerX now unset so it isn'yes't displayed DeadURL Periodical = ''; -- anything elseperiodical not allowed in these templates; if article has been published, set use cite journal end  -- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to empty stringinclude some static text if 'newsgroup' == config.CitationClass then if is_set (PublisherName) then PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil ));
end
end
 
 
local Language = A['Language'];-- Now perform various field substitutions. local Format = A['Format'];-- We also add leading spaces and surrounding markup and punctuation to the local ChapterFormat = A['ChapterFormat'];-- various parts of the citation, but only when they are non-nil. local DoiBroken = A['DoiBroken']EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list do local ID = A['ID']last_first_list; local ASINTLD control = A['ASINTLD'];{ local IgnoreISBN format = A['IgnoreISBN']; if not is_valid_parameter_value (IgnoreISBNNameListFormat, 'ignore -isbn-errorempty string or ', cfg.keywords [vanc'yes_true_y']) then IgnoreISBN maximum = nil; , -- as if display-authors or display- anything else, editors not set to empty string end lastauthoramp = LastAuthorAmp, local Embargo page_name = A[this_page.text, -- get current page name so that we don'Embargo'];t wikilink to it via editorlinkn local Class mode = A['Class']Mode }; -- arxiv class identifier
local ID_list do -- do editor name list first because the now unsupported coauthors used to modify control table control.maximum , editor_etal = extract_idsget_display_authors_editors ( args A['DisplayEditors'], #e, 'editors', editor_etal); last_first_list, EditorCount = list_people(control, e, editor_etal);
local Quote if is_set (Editors) then if editor_etal then Editors = AEditors .. ' ' .. cfg.messages['Quoteet al']; -- add et al. to editors parameter beause |display-editors=etal EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation else EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation end else Editors = last_first_list; -- either an author name list or an empty string end
if 1 == EditorCount and (true == editor_etal or 1 < #e) then local LayFormat -- only one editor displayed but includes etal then EditorCount = A['LayFormat']2; -- spoof to display (eds.) annotation local LayURL = A['LayURL']; end local LaySource = A['LaySource']; end local Transcript = A['Transcript']; do -- now do interviewers local TranscriptFormat control.maximum = A['TranscriptFormat']#interviewers_list; -- number of interviewerss local TranscriptURL = A['TranscriptURL'] local TranscriptURLorigin Interviewers = A:ORIGINlist_people('TranscriptURL'control, interviewers_list, false); -- get name of parameter that holds TranscriptURLet al not currently supported end local LastAuthorAmp do -- now do translators control.maximum = A['LastAuthorAmp']#t; -- number of translators if not is_valid_parameter_value Translators = list_people(LastAuthorAmpcontrol, 'last-author-amp't, cfg.keywords ['yes_true_y']false) then LastAuthorAmp = nil; -- set to empty stringet al not currently supported
end
local no_tracking_cats do -- now do contributors control.maximum = A['NoTracking']#c; -- number of contributors if not is_valid_parameter_value Contributors = list_people(no_tracking_catscontrol, 'no-tracking'c, cfg.keywords ['yes_true_y']false) then no_tracking_cats = nil; -- set to empty stringet al not currently supported
end
do -- now do authors
control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal);
--these are used by cite interview local Callsign last_first_list = A['Callsign']; local City = A['City']; local Program = A['Program']list_people(control, a, author_etal);
--local variables that are not cs1 parameters if is_set (Authors) then local use_lowercase Authors, author_etal = name_has_etal (Authors, author_etal, false); -- controls capitalization of certain static textfind and remove variations on et al. if author_etal then local this_page Authors = mwAuthors .. ' ' ..titlecfg.getCurrentTitle()messages['et al']; -- also used for COinS and for languageadd et al. to authors parameter end else local anchor_year Authors = last_first_list; -- used in the CITEREF identifiereither an author name list or an empty string end end -- end of do local COinS_date if is_set (Authors) and is_set (Collaboration) then Authors = {}Authors .. ' (' .. Collaboration .. ')'; -- holds date info extracted from |date= for the COinS metadata by Module:Date verificationadd collaboration after et al. end
-- set default parameter values defined by |mode= parameter. If |mode= is empty or omitted, use CitationClass to set these values
local Mode = A['Mode'];
if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then
Mode = '';
end
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
local PostScript;
local Ref;
sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass);
use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text
--check this page to see apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, -- an error message if it is in one of the namespaces that cs1 associated url is not supposed to add to the set, or an empty string for concatenation ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); Format = style_format (Format, URL, 'format', 'url'); LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url'); TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');  -- special case for chapter format so no error categoriesmessage or cat when chapter not supported if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or ('citation' == config.CitationClass and is_set (no_tracking_catsPeriodical) and not is_set (Encyclopedia))) then ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter- ignore url'); end  if we are already not going to categorize this pageis_set(URL) then if in_array (this_pageconfig.nsTextCitationClass, cfg.uncategorized_namespaces{"web","podcast", "mailinglist"}) then-- |url= required for cite web, cite podcast, and cite mailinglist no_tracking_cats = "table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true") } ); -- set no_tracking_cats
end
for _,v in ipairs (cfg.uncategorized_subpages) -- do we have |accessdate= without either |url= or |chapter-- cycle through page name patternsurl=? if this_page.text:match is_set(AccessDate) and not is_set(vChapterURL) then -- test page name against each pattern no_tracking_cats = "true"; -- ChapterURL may be set when URL is not set no_tracking_cats; break table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); -- bail out if one is found endAccessDate = '';
end
end
local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; DeadURL = DeadURL:lower(); -- check used later when assembling archived text if is_set( ArchiveURL ) then if is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it OriginalURL = ChapterURL; -- save copy of source chapter's url for extra |pagearchive text OriginalURLorigin =, |pagesChapterURLorigin; -- name of chapter-url parameter for error messages OriginalFormat = or ChapterFormat; -- and original |atformat= parameters. (also sheet and sheets while we're at it) select_one( args, { if 'pageno', ~= DeadURL then ChapterURL = ArchiveURL -- swap-in the archive'ps url ChapterURLorigin = A:ORIGIN(', ArchiveURL'pp) -- name of archive-url parameter for error messages ChapterFormat = ArchiveFormat or ', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters; -- swap in archive' s format end elseif is_set (URL)then OriginalURL = URL; -- save copy of original source URL OriginalURLorigin = URLorigin; -- this is a dummy call simply to get the name of url parameter for error message messages OriginalFormat = Format; -- and categoryoriginal |format= OriginalAccess = UrlAccess; local NoPP if 'no' ~= DeadURL then -- if URL set then archive-url applies to it URL = A[ArchiveURL -- swap-in the archive'NoPP'] s url if is_set URLorigin = A:ORIGIN(NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_yArchiveURL']) then -- name of archive url parameter for error messages NoPP Format = trueArchiveFormat or ''; -- swap in archive's format else NoPP UrlAccess = nil; -- unset, used as a flag laterrestricted access levels do not make sense for archived urls end end
end
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia ('citation' == config.CitationClass and is_set (Periodical) and not is_set(PageEncyclopedia)) then local chap_param; if is_set(PagesChapter) then -- get a parameter name from one of these chapter related meta-parameters chap_param = A:ORIGIN ('Chapter') elseif is_set (TransChapter) then chap_param = A:ORIGIN ('TransChapter') or elseif is_set(AtChapterURL) then chap_param = A:ORIGIN ('ChapterURL') Pages elseif is_set (ScriptChapter) then chap_param = A:ORIGIN ('ScriptChapter'; -- unset the others) At else is_set (ChapterFormat) chap_param = A:ORIGIN ('ChapterFormat';) end extra_text_in_page_check if is_set (chap_param) then -- if we found one table.insert( z.message_tail, { set_error(Page'chapter_ignored', {chap_param}, true ) } ); -- add this page error message Chapter = ''; -- and set them to empty string to maint cat if |pagebe safe with concatenation TransChapter = ''; ChapterURL = ''; ScriptChapter = ''; ChapterFormat = ''; end else -- otherwise, format chapter / article title local no_quotes = false; -- default assume that we will be quoting the chapter parameter value begins with what looks like p. or pp. elseif if is_set(PagesContribution) and 0 < #c then -- if this is a contribution with contributor(s) if is_setin_array (Contribution:lower(At), cfg.keywords.contribution) then-- and a generic contribution title At no_quotes = ''true; -- unsetthen render it unquoted end
end
extra_text_in_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
end
-- both |publication-place= and |place Chapter = format_chapter_title (|location=ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess) allowed if different; -- Contribution is also in Chapter if not is_set(PublicationPlaceChapter) then Chapter = Chapter .. ChapterFormat ; if 'map' == config.CitationClass and is_set(PlaceTitleType) then PublicationPlace Chapter = PlaceChapter .. ' ' .. TitleType; -- promote |placemap annotation here; not after title end Chapter = Chapter.. sepc .. ' '; elseif is_set (ChapterFormat) then -- |locationchapter=) to not set but |publicationchapter-placeformat= is so ... Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it end
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
|encyclopedia and |article then map |encyclopedia to |title
|encyclopedia then map |encyclopedia to |title
|trans_title maps to |trans_chapter when -- Format main title. if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title is re= Title = mw.ustring.gsub (Title, '(%.%.%.)%.+$', '%1'); --mappedlimit the number of dots to three |url maps to |chapterurl when |elseif not mw.ustring.find (Title, '%.%s*%a%.') then -- end of title is remappednot a 'dot-(optional space-)letter-dot' initialism All other combinations of |encyclopedia Title = mw.ustring.gsub(Title, |title'%'..sepc..'$', ''); -- remove any trailing separator character end if is_set(TitleLink) and |article are not modifiedis_set(Title) then Title = make_wikilink (TitleLink, Title); end
]] if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) or ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or ('map' == config.CitationClass 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, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped TransTitle= wrap_style ('trans-quoted-title', TransTitle ); elseif 'report' == config.CitationClass then -- no styling for cite report Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title else Title = wrap_style ('italic-title', Title); Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped TransTitle = wrap_style ('trans-italic-title', TransTitle); end
local Encyclopedia TransError = ""; if is_set(TransTitle) then if is_set(Title) then TransTitle = " " .. TransTitle; else TransError = " " .. set_error( 'trans_missing_title', {'title'} ); end end if is_set(Title) then if not is_set(TitleLink) and is_set(URL) then Title = external_link( URL, Title, URLorigin, UrlAccess ) .. TransTitle .. TransError .. Format; URL = A['Encyclopedia']; -- unset these because no longer needed Format = ""; else Title = Title .. TransTitle .. TransError; end else Title = TransTitle .. TransError; end
if is_set( config.CitationClass =Place) then Place = "encyclopaedia" .. wrap_msg ('written', Place, use_lowercase) or ( config.CitationClass == . sepc .. "citation" and is_set (Encyclopedia)) then -- test code for citation; end if is_set(Periodical) then -- Periodical is set when |encyclopedia is set if is_set(Title) or is_set (ScriptTitleConference) then if not is_set(ChapterConferenceURL) then Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title ScriptChapter = ScriptTitle; TransChapter = TransTitle; ChapterURL Conference = URL; if not is_set (ChapterURL) and is_set external_link(TitleLinkConferenceURL, Conference, ConferenceURLorigin, nil ) then Chapter= '[[' .. TitleLink .. '|' .. Chapter .. ']]'; end Title = Periodical; ChapterFormat = Format; Periodical = ''; -- redundant so unset TransTitle = ''; URL = ''; Format = ''; TitleLink = ''; ScriptTitle = ''; end else -- |title not set Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title Periodical = ''; -- redundant so unset end
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil );
end
-- Special case for cite techreport. if not is_set(config.CitationClass == "techreport"Position) then -- special case for cite techreport if is_set(local Minutes = A['NumberMinutes']) 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 local Time = A['NumberTime']; -- yes, use it else -- ID has a value so emit error message table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); end end end
-- special case for cite interview if (config.CitationClass == "interview") then if is_set(Program) then ID = ' ' .. Program; end if is_set(CallsignMinutes) then if is_set(IDTime) then ID = ID table.insert( z. sepc message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. Callsign; else ID = wrap_style ('parameter', ' time' .. Callsign)}, true ) } );
end
Position = " " .. Minutes .. " " .. cfg.messages['minutes']; endelse if is_set(CityTime) then local TimeCaption = A['TimeCaption'] if not is_set(IDTimeCaption) then ID TimeCaption = ID .cfg. messages['event']; if sepc .~= '. ' ' .. Citythen TimeCaption = TimeCaption:lower(); else end end ID Position = ' ' " " .. TimeCaption .. " " .. CityTime;
end
end
else
Position = " " .. Position;
At = '';
end
if is_set(Others) then if is_set Page, Pages, Sheet, Sheets = format_pages_sheets (TitleType) then Others = ' ' .. TitleType .. ' with ' Page, Pages, Sheet, Sheets, config.. Others; TitleType = ''; else Others = ' ' .. 'Interview with ' .. Others; end else Others = '(InterviewCitationClass, Periodical_origin, sepc, NoPP, use_lowercase)'; end end
-- special case for cite mailing list At = is_set(At) and (sepc .. " " .. At) or ""; Position = is_set(Position) and (sepc .. " " .. Position) or ""; if (config.CitationClass == "mailinglist") 'map' then Periodical local Section = A ['MailingListSection']; elseif local Sections = A['mailinglistSections' ]; local Inset =A['Inset']; if is_set( Inset ) then Inset = A:ORIGINsepc .. " " .. wrap_msg ('Periodicalinset', Inset, use_lowercase); end   if is_set( Sections ) then Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); Periodical elseif is_set( Section ) then Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); end At = At .. Inset .. Section; end   if is_set (Language) then Language = language_parameter (Language); --format, categories, name from ISO639- unset because mailing list 1, etc else Language=""; -- language not specified so make sure this is only used for cite mailing listan 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
-- Account for the oddity that is {{cite conference}}, before generation of COinS data Others = is_set(Others) and (sepc .. " " ..Others) or ""; if 'conference' == config.CitationClass then if is_set(BookTitleTranslators) then Chapter = Title;-- ChapterLink Others = TitleLinksepc .. ' ' .. wrap_msg ('translated', Translators, use_lowercase) .. Others; -- |chapterlink= is deprecated ChapterURL = URL; end ChapterURLorigin = URLorigin; if is_set (Interviewers) then URLorigin Others = sepc .. ' ' .. wrap_msg ('interview', Interviewers, use_lowercase) .. Others; ChapterFormat = Format; end TransChapter TitleNote = TransTitleis_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; Title = BookTitle; if is_set (Edition) then Format = if Edition:match ('%f[%a][Ee]d%.?$';-- TitleLink = ) or Edition:match ('%f[%a][Ee]dition$';) then TransTitle = add_maint_cat ('extra_text'; URL = , 'edition');
end
elseif Edition = " " .. wrap_msg ('speechedition' ~= config.CitationClass then, Edition); else Conference Edition = ''; -- not cite conference or cite speech so make sure this is empty string
end
-- cite map oddities local Cartography Series = is_set(Series) and (sepc .. ""; local Scale = .. Series) or ""; local Sheet OrigYear = Ais_set(OrigYear) and (" ['Sheet'" .. OrigYear .. "] ") or ''""; -- TODO: presentation  local Sheets Agency = A['Sheets'] is_set(Agency) and (sepc .. " " .. Agency) or ''""if Volume = format_volume_issue (Volume, Issue, config.CitationClass == "map" then, Periodical_origin, sepc, use_lowercase); Chapter = A['Map']; ChapterURL = A['MapURL']; ------------------------------------ totally unrelated data TransChapter = A['TransMap']; if is_set(Via) then ChapterURLorigin Via = A:ORIGIN" " .. wrap_msg ('MapURLvia', Via); ChapterFormat = A end  --[['MapFormat'] Subscription implies paywall;Registration does not. If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition. Cartography = A['Cartography' ]]; if is_set( Cartography SubscriptionRequired) then Cartography SubscriptionRequired = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); end Scale = Acfg.messages['Scalesubscription']; -- subscription required message if elseif is_set( Scale RegistrationRequired) then Scale SubscriptionRequired = sepc .. " " .. Scalecfg.messages['registration']; -- registration required message else endSubscriptionRequired = ''; -- either or both might be set to something other than yes true y
end
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data. if 'episode' == config.CitationClass or 'serial' == config.CitationClass then local AirDate = A['AirDate']; local SeriesLink = A['SeriesLink']; if is_set (SeriesLink) and false == link_param_ok (SeriesLinkAccessDate) then table.insert( z.message_tail, { set_error( 'bad_paramlink', A:ORIGIN('SeriesLink'))}); end local Network retrv_text = 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 .cfg. messages[' 調用'); if not is_set (Date) and is_set (AirDate) then -- promote airdate to date Date = AirDate; end]
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if 'episode' =date in appropriate format if (sepc ~= config".CitationClass ") then retrv_text = retrv_text:lower() end -- handle the oddities that are strictly {{cite episode}}if mode is cs2, lower case local Season AccessDate = A['Season']; local SeriesNumber = A['SeriesNumber']substitute (retrv_text, AccessDate); -- add retrieved text
if is_set (Season) and is_set AccessDate = substitute (SeriesNumber) then -- these are mutually exclusive so if both are set tablecfg.insert( z.message_tail, { set_error( presentation['redundant_parametersaccessdate'], {wrap_style ('parameter'sepc, 'season') .. ' and ' .. wrap_style ('parameter', 'seriesno')}, true ) AccessDate} ); -- add error messageallow editors to hide accessdates 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 if is_set(ID) then ID = Titlesepc .." ".. ID; -- promote title parameters to chapterend ScriptChapter if "thesis" == ScriptTitle;config.CitationClass and is_set(Docket) then ChapterLink ID = TitleLinksepc .." Docket ".. Docket .. ID; -- alias episodelink TransChapter = TransTitle; end ChapterURL if "report" = URL; ChapterURLorigin = A:ORIGINconfig.CitationClass and is_set('URL'Docket); Title = Series; then -- promote series to title TitleLink for cite report when |docket= SeriesLink;is set Series ID = table.concat(s, sepc .. ' ').. Docket; -- this overwrite ID even if |id= is concatenation of season, seriesno, episode numberset end
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL Chapter ID_list = '[[' .. ChapterLink .. '|' .. Chapter .. ']]'; -- ok to wikilink elseif is_set build_id_list(ChapterLink) and is_set (ChapterURL) then -- if both are setID_list, URL links episode; Series {IdAccessLevels= '[[' .. ChapterLink .. '|' .. Series .. ']]'; -- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly end URL ID_access_levels, DoiBroken = ''; -- unset TransTitle DoiBroken, ASINTLD = ''; ScriptTitle ASINTLD, IgnoreISBN = ''; else -- now oddities that are cite serial Issue IgnoreISBN, Embargo= ''; -- unset because this parameter no longer supported by the citation/core version of cite serial Chapter Embargo, Class = A['Episode']; -- TODO: make |episode= available to cite episode someday? if is_set (Series) and is_set (SeriesLink) then Series = '[[' .. SeriesLink .. '|' .. Series .. ']]'; end Series = wrap_style ('italic-title', SeriesClass} ); -- 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' == config.CitationClass then if not is_set (ID_list['ARXIV']URL) then -- |arxiv= or |eprint= required for cite arxiv table.insert( z.message_tail, { set_error( 'arxiv_missing', {}, true ) } ); -- add error message elseif is_set (Series) then -- series is an alias of version ID_list['ARXIV'] URL = 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 external_link({AccessDate, At, Chapter, Format, Page, Pages, Periodical, PublisherName, URL, -- a crude list of parameters that are not supported by cite arxiv ID_list['ASIN']nil, ID_list['BIBCODE']URLorigin, 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 table.insert( z.message_tail, { set_error( 'arxiv_params_not_supported', {}, true ) } UrlAccess ); -- 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) Chapter = ''; URL = ''; Format = ''; Page = ''; Pages = ''; At = ''; end Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string
end
-- handle type parameter for those CS1 citations that have default values if in_arrayis_set(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}Quote) then TitleType = set_titletype if Quote:sub(config.CitationClass1, TitleType1); if is_set== '"' and Quote:sub(Degree-1,-1) and "Thesis" == TitleType '"' then -- special case for cite thesisif first and last characters of quote are quote marks TitleType Quote = Degree .. "论文"Quote:sub(2,-2); -- strip them off
end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
end
  if is_set(TitleType) then -- if type parameter is specified TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheseslocal Archived 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 (DateArchiveURL) then Date = Year; -- promote Year to Date Year = nil; -- make nil so Year as empty string isn't used for CITEREF if not is_set (Date) and is_set(PublicationDateArchiveDate) then -- use PublicationDate when |date= and |year= are not set Date = PublicationDate; -- promote PublicationDate to Date PublicationDate ArchiveDate = set_error('archive_missing_date'); -- unset, no longer needed
end
end  if PublicationDate "no" == Date DeadURL then PublicationDate local arch_text = cfg.messages['archived']; end -- if PublicationDate is same as Date, don't display in rendered citation --[[Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real datessepc ~= ". This must be done before we do COinS because here is wherewe get the date used in the metadata. Date validation supporting code is in Module" then arch_text = arch_text:Citation/CS1/Date_validationlower() end]] do -- create defined block to contain local variables error_message and mismatch local error_message Archived = ''; -- AirDate has been promoted to Date so not necessary to check it anchor_year, error_message = datessepc .. " " .. substitute({cfg.messages['accessarchived-date']=AccessDate, ['archivenot-datedead']=ArchiveDate, ['date']=Date { external_link( ArchiveURL, ['doi-broken-date']=DoiBrokenarch_text, [A:ORIGIN('embargoArchiveURL']=Embargo), ['lay-date']=LayDatenil ) .. ArchiveFormat, ['publication-date']=PublicationDate, ['year']=YearArchiveDate }, COinS_date);  if is_set (Year) and 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= if is_set (error_messageOriginalURL) then -- if there is already an error message error_message Archived = error_message Archived .. ', '; -- tack on this additional message end error_message = error_message " " .. '&#124;year= / &#124;date= mismatch'; elseif 1 == mismatch then -- |year= matches year-value in |date= add_maint_cat set_error('date_yeararchive_missing_url');
end
elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped'
local arch_text = cfg.messages['archived-dead'];
if sepc ~= "." then arch_text = arch_text:lower() end
if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then
Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled
if 'bot: unknown' == DeadURL then
add_maint_cat ('bot:_unknown'); -- and add a category if not already added
else
add_maint_cat ('unfit'); -- and add a category if not already added
end
else -- DeadURL is empty, 'yes', 'true', or 'y'
Archived = sepc .. " " .. substitute( arch_text,
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
end
else
local arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,
{ set_error('archive_missing_url'), ArchiveDate } );
end
elseif is_set (ArchiveFormat) then Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message else Archived = "" end local Lay = ''; if is_set(LayURL) then if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end if is_set(error_messageLaySource) then tableLaySource = " &ndash; ''" .insert. safe_for_italics( zLaySource) ..message_tail, { set_error( "'bad_date', {error_message}, true ) } )"; else LaySource = ""; -- add this error message
end
if sepc == '.' then Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate else Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate end end elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message end of do
-- 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 config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']Transcript) then if not is_set (EmbargoTranscriptURL) then -- if not embargoed or embargo has expired URLTranscript =cfg.id_handlers['PMC'].prefix .. ID_list['PMC']external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil ); -- set url to be the same as the PMC external link if not embargoed URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif is_set(TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil );
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 titlelocal Publisher; if not is_set(TitlePublicationDate) andthen not PublicationDate = wrap_msg ('published', PublicationDate); end if is_set(TransTitlePublisherName) andthen not if is_set(ScriptTitlePublicationPlace) then if 'episode' Publisher == configsepc .. " " .. PublicationPlace ..CitationClass then -- special case for cite episode; TODO": is there a better way to do this? table" .. PublisherName .insert( z.message_tail, { set_error( 'citation_missing_title', {'series'}, true ) } )PublicationDate; else table Publisher = sepc .. " " .. PublisherName .insert( z.message_tail, { set_errorPublicationDate; end elseif is_set( 'citation_missing_title', {'title'}, true ) } PublicationPlace)then Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; end else Publisher = PublicationDate;
end
-- Several of the above rely upon detecting this as nil, so do it last. if 'none' == Title and in_array is_set(config.CitationClass, {'journal', 'citation'}Periodical) and then if is_set (PeriodicalTitle) and 'journal' == A:ORIGINor is_set('Periodical'TitleNote) then -- special case for journal cites Title Periodical = sepc .. " " .. wrap_style (''; italic-- set title to empty string', Periodical) add_maint_cat else Periodical = wrap_style ('untitleditalic-title', Periodical); end
end
check_for_url ({ -- 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 Handle the oddity that is cite encyclopedia and {{citation speech. This code overrides whatever may be the value assigned to TitleNote (through |encyclopediadepartment=something}}. Here we presume that -- when Periodical, Title, ) and Chapter are all set, then Periodical is the book forces it to be " (encyclopediaSpeech) title, Title" so that -- is the article annotation directly follows the |title, and Chapter is a section within = parameter value in the citation rather than the article|event= parameter value (if provided). So, we remap ]] local coins_chapter if "speech" == Chapter; config.CitationClass then -- default assuming that remapping not requiredcite speech only local coins_title TitleNote = Title" (Speech)"; -- et tuannotate the citation if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter if is_set (Chapter) and is_set (Title) and is_set (PeriodicalConference) then -- and if all are used then|event= is set coins_chapter Conference = TitleConference .. sepc .. " "; -- remapthen add appropriate punctuation to the end of the Conference variable before rendering coins_title = Periodical;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
-- Piece all bits together at last. Here, all should be non-nil. -- We build things this way because it is the function call to COinS()more efficient in LUA local OCinSoutput = COinS({ ['Periodical'] = Periodical, ['Encyclopedia'] = Encyclopedia, ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter not to keep reassigning to the same string variable over and ScriptChapter stripped of bold / italic wikimarkupover.  ['Map'] = Map, local tcommon; ['Degree'] = Degree local tcommon2; -- used for book cite thesis onlywhen |contributor= is set ['Title'] = make_coins_title if in_array(coins_titleconfig.CitationClass, {"journal", ScriptTitle"citation"}), -- Title and ScriptTitle stripped of bold / italic wikimarkupis_set(Periodical) then ['PublicationPlace'] = PublicationPlace, ['Date'] if is_set(Others) then Others = COinS_dateOthers .rftdate, -- COinS_date has correctly formatted date if Date is valid; ['Season'] = COinS_date.rftssn, ['Chron'] = COinS_datesepc .rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?" " end ['Series'] tcommon = Seriessafe_join( {Others, ['Volume'] = VolumeTitle, ['Issue'] = IssueTitleNote, ['Pages'] = get_coins_pages (first_set ({SheetConference, SheetsPeriodical, PageFormat, PagesTitleType, At}Series, 5))Language, -- pages stripped of external links ['Edition'] = Edition, ['PublisherName'] = PublisherNamePublisher, ['URL'] = first_set ({ChapterURLAgency, URLVolume}, 2sepc ), ['Authors'] = coins_author, ['ID_list'] = ID_list, ['RawPage'] = this_page.prefixedText,; }, elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical); then -- Account special cases for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.book cites if 'arxiv' == config.CitationClass is_set (Contributors) then -- when we have set rft.jtitle in COinS to arXivare citing foreword, preface, introduction, now unset so it isn't displayedetc Periodical tcommon = ''safe_join( {Title, TitleNote}, sepc ); -- periodical not allowed in cite arxiv; if article has been published, use cite journal end -- special case for cite newsgroup. Do author and other stuff will come after this after COinS because we are modifying Publishername to include some static textand before tcommon2 if 'newsgroup' tcommon2 == config.CitationClass thensafe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); if is_set (PublisherName) thenelse PublisherName tcommon = substitute safe_join(cfg.messages['newsgroup']{Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, external_link( 'news:' .. PublisherNamePublisher, PublisherNameAgency}, A:ORIGIN('PublisherName') )sepc );
end
end
 
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, Language, Cartography, Others, Publisher, Volume}, sepc );
elseif is_set (Periodical) then -- map in a periodical
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
else -- a sheet or stand-alone map
tcommon = safe_join( {Title, TitleType, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc );
end
elseif 'episode' == config.CitationClass then -- special case for cite episode
tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc );
else -- Now perform various field substitutions.all other CS1 templates tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc ); -- We also add leading spaces and surrounding markup and punctuation to theend -- various parts of the citation, but only when they are non-nil. local EditorCount; -- used only for choosing if #ID_list > 0 then ID_list = safe_join( {edsepc .. " ", table.) or concat(edsID_list, sepc .. " " ), ID }, sepc ) annotation at end of editor name-list; doelse local last_first_listID_list = ID; local maximum; end local control idcommon = safe_join( { format = NameListFormatID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, -- empty string or 'vanc' maximum = nilQuote }, -- as if display-authors or display-editors not setsepc ); lastauthoramp = LastAuthorAmp, local text; page_name local pgtext = this_pagePosition .. Sheet .. Sheets .. Page .. Pages ..text -- get current page name so that we don't wikilink to it via editorlinkn }At;
if is_set(Date) then do if is_set (Authors) or is_set (Editors) then -- do editor name list first because coauthors can modify control tabledate follows authors or editors when authors not set maximum , editor_etal Date = get_display_authors_editors " (A['DisplayEditors'], #e, 'editors', editor_etal" .. Date ..")" .. OrigYear .. sepc .. " "; --[[ Preserve old-style implicit et al.in paranetheses 临时修复"Category:含有旧式缩略标签的引用的页面 in editors"的问题,中文版目前与英文版逻辑不一样,暂时不需要这个分类。等以后更新时再看怎么处理 else --2017.6.23 shizhao neither of authors and editors set if not is_set(maximumstring.sub(tcommon,-1,-1) and #e == 4 sepc) then -- if the last character of tcommon is sepc maximum Date = 3" " .. Date .. OrigYear; -- Date does not begin with sepc else tableDate = sepc .. " " .. Date .insert( z.message_tail, { set_error('implict_etal_editor', {}, true) } )OrigYear; -- Date begins with sepc
end
]] end end control.maximum = maximum if is_set(Authors) then if (not is_set (Date)) then -- when date is set it's in parentheses;no Authors termination last_first_list, EditorCount Authors = list_peopleterminate_name_list (controlAuthors, e, editor_etal, 'editor'sepc); -- when no date, terminate with 0 or 1 sepc and a space end if is_set (Editors) then local in_text = " "; local post_text = ""; if editor_etal is_set(Chapter) and 0 == #c then Editors in_text = Editors .. ' ' in_text .. cfg.messages['et alin']; -- add et al. to editors parameter beause |display-editors. " " if (sepc ~=etal'.') then EditorCount in_text = 2; in_text:lower() -- with et allowercase for cs2 end else if EditorCount <= 1 then post_text = ", " .. cfg., |editors= is multiple namesmessages['editor']; spoof to display (eds.) annotation
else
EditorCount post_text = 2; -- we don", " .. cfg.messages['t know but assume |editors= is multiple names']; spoof to display (eds.) annotation
end
elseend Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space end if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; if (sepc ~= '.') then by_text = by_text:lower() end Editors -- lowercase for cs2 Authors = last_first_listby_text .. Authors; -- either an author name list follows title so tweak it here if is_set (Editors) and is_set (Date) then -- when Editors make sure that Authors gets terminated Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or an empty string1 sepc and a space
end
  if 1 == EditorCount and (true == editor_etal or 1 < #enot is_set (Date)) then -- only one editor displayed but includes etal then when date is set it's in parentheses; no Contributors termination EditorCount Contributors = 2terminate_name_list (Contributors, sepc); -- spoof to display (eds.) annotationterminate with 0 or 1 sepc and a space
end
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
else
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
end
do -- now do translators control.maximum = #t; -- number of translators Translators = list_people elseif is_set(control, t, false, 'translator'Editors); -- et al not currently supportedthen end do -- now do contributorsif is_set(Date) then control.maximum if EditorCount <= #c; -- number of contributors1 then Contributors Editors = list_people(controlEditors .. ", c, false, 'contributor'); -- et al not currently supported end do -- now do authors control" .. cfg.maximum , author_etal = get_display_authors_editors (Amessages['DisplayAuthorseditor'], #a, 'authors', author_etal); else if is_set(Coauthors) then -- if the coauthor field is also used Editors = Editors .. ", prevent ampersand and et al" . formatting. controlcfg.lastauthoramp = nil; control.maximum = #a + 1messages['editors'];
end
else last_first_list if EditorCount <= list_people(control, a, author_etal, 'author');  if is_set (Authors) 1 then Authors, author_etal = name_has_etal (Authors, author_etal, false); -- find and remove variations on et al. if author_etal then Authors Editors = Authors Editors .. ' ' " (" .. cfg.messages['et aleditor']; -- add et al. to authors parameter end. ")" .. sepc .. " "
else
Authors Editors = last_first_list; -- either an author name list or an empty stringEditors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
end
end -- end of do text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); else if not is_setin_array(Authorsconfig.CitationClass, {"journal","citation"}) and is_set(CoauthorsPeriodical) then -- coauthors aren't displayed if one of authors text =safe_join( {Chapter, Place, tcommon, pgtext, authorn=Date, idcommon}, or lastn= isn't specifiedsepc ); else table.inserttext = safe_join( z.message_tail{Chapter, Place, tcommon, Date, { set_error('coauthors_missing_author'pgtext, {idcommon}, true) } sepc ); -- emit error message
end
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 );
-- apply |[xx-]format= styling; at Now enclose the end, these parameters hold correctly styled format annotation,-- an error message if the associated url is not set, or an empty string for concatenationwhole thing in a <cite/> element ArchiveFormat local options = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'){}; ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); Format = style_format if is_set(Format, URL, 'format', 'url'config.CitationClass);and config.CitationClass ~= "citation" then LayFormat options.class = style_format (LayFormat, LayURL, 'lay-format', 'lay-url')config.CitationClass; TranscriptFormat options.class = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl')"citation " .. config.CitationClass -- special case class=citation required for chapter format so no error message or cat blue highlight when chapter not supportedused with |ref= if not (in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) orelse ('citation' == configoptions.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then ChapterFormat class = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url')"citation";
end
if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate
local id = Ref
if ('harv' == Ref ) then
local namelist = {}; -- 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 not is_set(URL) #c > 0 then -- if there is a contributor list namelist = c; --andselect it if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) elseif #a > 0 then -- Test if cite web or cite podcast |urlan author list namelist = is missing a; elseif #e > 0 then -- or empty an editor list table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } ) namelist = e; end if #namelist > 0 then -- Test if accessdate is given without giving a URLthere are names in namelist if is_set id = anchor_id (AccessDatenamelist, year) and not is_set(ChapterURL)then ; -- ChapterURL may be set when go make the others are not set; TODO: move this to a separate test?CITEREF anchor table.insert( z.message_tail, { set_error( else id = 'accessdate_missing_url', {}, true ) } ); -- unset AccessDate = '';end
end
options.id = id;
end
local OriginalURLif string.len(text:gsub("<span[^>/]*>(.-)</span>", OriginalURLorigin"%1"):gsub("%b<>", OriginalFormat; "")) <= 2 then -- TODO: swap chapter remove <span> tags and title here so that archive applies to most specific if both are set?other html-like markup; then get length of what remains DeadURL z.error_categories = DeadURL:lower(){}; -- used later when assembling archived text if is_set= set_error( ArchiveURL 'empty_citation') then; if is_set (URL) then OriginalURL z.message_tail = URL{}; -- save copy of original source URL OriginalURLorigin end local render = URLorigin{}; -- name of url parameter here we collect the final bits for error messagesconcatenation into the rendered citation OriginalFormat = Format; -- and original |format= if 'no' ~= DeadURL is_set(options.id) then -- if URL set then archive-url applies to it URL = ArchiveURL -- swap-here we wrap the rendered citation in the archive's url<cite ...>...</cite> tags URLorigin = A:ORIGIN table.insert (render, substitute (cfg.presentation['ArchiveURLcite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})) ; -- name of archive url parameter for error messageswhen |ref= is set else Format = ArchiveFormat or table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- swap in archive's formatall other cases end   elseif is_set table.insert (render, substitute (ChapterURLcfg.presentation['ocins'], {OCinSoutput})) then ; -- URL not set so if chapter-url is set apply archive url append metadata to itthe citation  OriginalURL if #z.message_tail ~= ChapterURL0 then table.insert (render, ' '); -- save copy of source chapter's url for archive text OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messagesi,v in ipairs( z.message_tail ) do OriginalFormat = ChapterFormat; -- and original |format=if is_set(v[1]) then if 'no' ~i == DeadURL #z.message_tail then table.insert (render, error_comment( v[1], v[2] )); ChapterURL = ArchiveURL -- swap-in the archive's urlelse ChapterURLorigin = A:ORIGIN table.insert (render, error_comment('ArchiveURL'v[1] .. "; ", v[2] )) -- name of archive-url parameter for error messages; ChapterFormat = ArchiveFormat or ''; -- swap in archive's formatend
end
end
end
if in_array#z.maintenance_cats ~= 0 then table.insert (config.CitationClassrender, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) or <span class="citation-comment" style="display:none; color:#33aa33; margin- if any of the left:0.3em">'periodical' cites except encyclopedia); for _, v in ipairs('citation' == configz.CitationClass and is_set (Periodicalmaintenance_cats ) and not is_set do -- append maintenance categories table.insert (Encyclopediarender, v)) then; local chap_paramtable.insert (render, ' ('); if is_set table.insert (render, make_wikilink (Chapter) then -- get a parameter name from one of these chapter related meta-parameters chap_param = A':Category:ORIGIN ('Chapter.. v, 'link')); elseif is_set table.insert (TransChapterrender, ') ') then; end chap_param = A:ORIGIN table.insert (render, 'TransChapter</span>'); end elseif is_set (ChapterURL) then chap_param no_tracking_cats = Ano_tracking_cats:ORIGIN lower('ChapterURL'); elseif is_set if in_array(ScriptChapterno_tracking_cats, {"", "no", "false", "n"}) then chap_param = A:ORIGIN for _, v in ipairs('ScriptChapter'z.error_categories )do else is_set table.insert (ChapterFormat) chap_param = A:ORIGIN render, make_wikilink ('ChapterFormatCategory:'.. v)); end  if is_set for _, v in ipairs(chap_paramz.maintenance_cats ) then do -- if we found oneappend maintenance categories table.insert( z.message_tailrender, { set_errormake_wikilink ( 'chapter_ignoredCategory:', {chap_param}, true .. v) } ); -- add error message Chapter = ''; -- and set them to empty string to be safe with concatenation TransChapter = ''; ChapterURL = ''; ScriptChapter = ''; ChapterFormat = ''; end else -- otherwise for _, format chapter / article title local no_quotes = false; -- default assume that we will be quoting the chapter parameter value if is_set v in ipairs(Contributionz.properties_cats ) and 0 < #c then do -- if this is a contribution with contributor(s)append properties categories if in_array table.insert (render, make_wikilink (Contribution'Category:lower(), cfg' .keywords.contributionv)) then -- and a generic contribution title no_quotes = true; -- then render it unquoted end
end
end
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes); -- Contribution is also in Chapter if is_set (Chapter) then if 'map' == configreturn table.CitationClass and is_set concat (TitleTyperender) then Chapter = Chapter .. ' ' .. TitleType; end Chapter = Chapter .. ChapterFormat .. sepc .. ' '; elseif is_set (ChapterFormat) then --[[------------------------- |chapter= not set but |chapter-format= is so < C S 1 ... Chapter = ChapterFormat .. sepc .. ' '; C I T A T I O N >------------------------------------------------------ ... ChapterFormat has error message, we want to see it end endThis is used by templates such as {{cite book}} to create the actual citation text.
-- Format main title. if is_set(TitleLink) and is_set(Title) then Title = "[[" .. TitleLink .. "|" .. Title .. "]]" end
if in_array(configfunction cs1.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'mailinglist', 'arxiv'}) or ('citation' == config.CitationClass and is_set (Periodicalframe) and not is_set (Encyclopedia)) or ('map' Frame == config.CitationClass and is_set (Periodical)) then frame; -- special case for cite map when the map is in save a periodical treat as copy incase we need to display an articleerror message in preview mode Title local pframe = kern_quotes frame:getParent(Title); -- if necessary local validation, utilities, separate title's leading and trailing quote marks from Module provided quote marks Title = wrap_style ('quoted-title'identifiers, Title)metadata;
Title if nil ~= script_concatenate string.find (Titleframe:getTitle(), ScriptTitle'sandbox', 1, true); then -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrappeddid the {{#invoke:}} use sandbox version? TransTitle cfg = wrap_style mw.loadData ('transModule:Citation/CS1/Configuration/sandbox'); -quoted-titleload sandbox versions of support modules whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox', TransTitle ); elseif utilities = require ('reportModule:Citation/CS1/Utilities/sandbox' ); validation =require ('Module:Citation/CS1/Date_validation/sandbox'); identifiers = config.CitationClass then -- no styling for cite reportrequire ('Module:Citation/CS1/Identifiers/sandbox'); Title metadata = script_concatenate require (Title, ScriptTitle'Module:Citation/CS1/COinS/sandbox'); else -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrappedotherwise TransTitlecfg = wrap_style mw.loadData ('trans-quoted-titleModule:Citation/CS1/Configuration', TransTitle ); -- for cite report, use this form for trans-titleload live versions of support modules else whitelist = mw.loadData ('Module:Citation/CS1/Whitelist'); Title utilities = wrap_style require ('italic-titleModule:Citation/CS1/Utilities', Title); Title validation = script_concatenate require (Title, ScriptTitle'Module:Citation/CS1/Date_validation'); -- <bdi> tags, lang atribute, categorization, etc identifiers = require ('Module:Citation/CS1/Identifiers'); must be done after title is wrapped TransTitle metadata = wrap_style require ('trans-italic-titleModule:Citation/CS1/COinS', TransTitle);
end
TransError = ""utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module if is_setvalidation.set_selected_modules (TransTitlecfg, utilities) then; -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module if is_set metadata.set_selected_modules (Titlecfg, utilities) then; -- so that functions in COinS can see the selected cfg tables and selected Utilities module  TransTitle dates = " " validation.dates; -- imported functions from Module:Citation/CS1/Date validation year_date_check = validation. TransTitleyear_date_check; else reformat_dates = validation.reformat_dates; TransError date_hyphen_to_dash = " " validation.date_hyphen_to_dash; date_name_xlate = validation.date_name_xlate;  is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities in_array = utilities.in_array; substitute = utilities. substitute; error_comment = utilities.error_comment; set_error( 'trans_missing_title', {'title'} )= utilities.set_error; select_one = utilities.select_one; add_maint_cat = utilities.add_maint_cat; wrap_style = utilities.wrap_style; safe_for_italics = utilities.safe_for_italics; is_wikilink = utilities.is_wikilink; make_wikilink = utilities.make_wikilink;  z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities  extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Identifiers end build_id_list = identifiers.build_id_list; endis_embargoed = identifiers.is_embargoed; extract_id_access_levels = identifiers.extract_id_access_levels;
Title make_coins_title = Title metadata.. TransTitlemake_coins_title; -- imported functions from Module:Citation/CS1/COinS if is_set(Title) then if not is_set(TitleLink) and is_set(URL) then Title get_coins_pages = external_link( URL, Title, URLorigin ) .metadata. TransError .. Formatget_coins_pages; URL = ""; Format = ""; else Title COinS = Title metadata.. TransErrorCOinS; end end
if is_set(Place) thenlocal args = {}; -- table where we store all of the template's arguments Place local suggestions = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "{}; -- table where we store suggestions if we need to loadData them endlocal error_text, error_state;
if is_set (Conference) then if is_set (ConferenceURL) then Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin ); end Conference local config = sepc .. " " .. Conference .. ConferenceFormat{}; -- table to store parameters from the module {{#invoke:}} elseif is_setfor k, v in pairs(ConferenceURLframe.args ) thendo Conference config[k] = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin )v;-- end  if not is_set(Position) then local Minutes = Aargs['Minutes'k]= v; -- debug tool that allows us to render a citation from module {{#invoke:}} local Time = A['Time']; end
if is_set(Minutes) then local capture; -- the single supported capture when matching unknown parameters using patterns if is_set (Time) then table.insert( z.message_tail for k, { set_errorv in pairs( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .pframe. wrap_style ('parameter', 'time'args )}, true ) } );do end Position if v ~= " " .. Minutes .. " " .. cfg.messages['minutes']; elsethen if is_setnot validate(Timek, config.CitationClass ) then local TimeCaption error_text = A['TimeCaption']""; if not is_settype(TimeCaptionk ) ~= 'string' then TimeCaption = cfg.messages['event'];-- Exclude empty numbered parameters if sepc v:match("%S+") ~= '.' nil then TimeCaption error_text, error_state = TimeCaption:lowerset_error('text_ignored', {v}, true );
end
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, sepc, NoPP, use_lowercase);  At = is_set(At) and (sepc .. " " .. At) or ""; Position = is_set(Position) and (sepc .. " " .. Position) or ""; if config.CitationClass == 'map' then local Section = A['Section']; local Sections = A['Sections']; local Inset = A['Inset']; if is_set( Inset ) then Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); end   if is_set( Sections ) then Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); elseif is_setvalidate( Section ) then Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); end At = At .. Inset .. Section; end   if 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; end  Others = is_set(Others) and (sepc .. " " .. Others) or ""; if is_set (Translators) then Others = sepc .. ' 由' .. Translators .. '翻译 ' .. Others; end  TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; if is_set (Edition) then if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then add_maint_cat ('extra_text', 'edition'); end Edition = " " .. wrap_msg ('edition', Edition); else Edition = ''; end  Series = is_set(Series) and (sepc .. " " .. Series) or ""; OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";  Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);  ------------------------------------ totally unrelated data if is_set(Via) then Via = " " .. wrap_msg ('via', Via); end --[[Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required linknote is displayed. There are no error messages for this condition. ]] if is_set (SubscriptionRequired) then SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message elseif is_set (RegistrationRequired) then SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message else SubscriptionRequired = ''; -- either or both might be set to something other than yes true y end  if is_set(AccessDate) then local retrv_text = " " .. cfg.messages['retrieved']  AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if 'citation', lower case AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text -- neither of these work; don't know why; it seems that substitute() isn't being called AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates end if is_set(ID) then ID = sepc .." ".. ID; end if "thesis" == config.CitationClass and is_set(Docket) then ID = sepc .." Docket ".. Docket .. ID; end if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set end  ID_list = build_id_list( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} );  if is_set(URL) then URL = " " .. external_link( URL, nil, URLorigin ); end  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 Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set end local Archived if is_set(ArchiveURL) then if not is_set(ArchiveDate) then ArchiveDate = set_error('archive_missing_date'); end if "no" == DeadURL then local arch_text = cfg.messages['archived']; if sepc ~= "." then arch_text = arch_text:lower() end Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL') ) .. ArchiveFormat, ArchiveDate } ); if not is_set(OriginalURL) then Archived = Archived .. " " .. set_error('archive_missing_url'); end elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped' local arch_text = cfg.messages['archived-dead']; if sepc ~= "." then arch_text = arch_text:lower() end if in_array (DeadURL, {'unfit', 'usurped'}) then Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled else -- DeadURL is empty, 'yes', 'true', or 'y' Archived = sepc .. " " .. substitute( arch_text, { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin ) .. OriginalFormat, ArchiveDate } ); -- format already styled end else local arch_text = cfg.messages['archived-missing']; if sepc ~= "." then arch_text = arch_text:lower() end Archived = sepc .. " " .. substitute( arch_text, { set_error('archive_missing_url'), ArchiveDate } ); end elseif is_set (ArchiveFormat) then Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message else Archived = "" end local Lay = ''; if is_set(LayURL) then if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end if is_set(LaySource) then LaySource = " &ndash; ''" .. safe_for_italics(LaySource) .. "''"; else LaySource = ""; end if sepc == '.' then Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate else Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate end elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url= Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message end  if is_set(Transcript) then if is_set(TranscriptURL) then Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin ); end Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; elseif is_set(TranscriptURL) then Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin ); end  local Publisher; if is_set(Periodical) and not in_array(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then if is_set(PublisherName) then if is_set(PublicationPlace) then Publisher = PublicationPlace .. ": " .. PublisherName; else Publisher = PublisherName; end elseif is_set(PublicationPlace) then Publisher= PublicationPlace; else Publisher = ""; end if is_set(Publisher) then Publisher = " (" .. Publisher .. ")"; end else if is_set(PublisherName) then if is_set(PublicationPlace) then Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName; else Publisher = sepc .. " " .. PublisherName; end elseif is_set(PublicationPlace) then Publisher= sepc .. " " .. PublicationPlace; else Publisher = ''; end end -- Several of the above rely upon detecting this as nil, so do it last. if is_set(Periodical) then if is_set(Title) or is_set(TitleNote) then Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical) else Periodical = wrap_style ('italic-title', Periodical) end end --[[Handle the oddity that is cite speech. This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so thatthe annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).]] if "speech" == config.CitationClass then -- cite speech only TitleNote = " (Speech)"; -- annotate the citation if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter if is_set (Conference) then -- and if |event= is set Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering end end end  -- Piece all bits together at last. Here, all should be non-nil. -- We build things this way because it is more efficient in LUA -- not to keep reassigning to the same string variable over and over.  local tcommon; local tcommon2; -- used for book cite when |contributor= is set if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then if is_set(Others) then Others = Others .. sepc .. " " end tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Edition, Publisher, Agency}, sepc ); elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites 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' == 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 ); 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' == config.CitationClass 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 = Date local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; if ( is_set(Periodical) and Date ~= '' and not in_array(config.CitationClass, {"encyclopaedia","web"}) ) or ( in_array(config.CitationClass, {"book","news"}) ) then if in_array(config.CitationClass, {"journal","citation"}) and ( Volume ~= '' or Issue ~= '' ) then xDate = xDate .. ',' .. Volume end xDate = xDate .. pgtext pgtext = '' end if PublicationDate and PublicationDate ~= '' then xDate = xDate .. ' (' .. PublicationDate .. ')' end if OrigYear ~= '' then xDate = xDate .. OrigYear end if AccessDate ~= '' then xDate = xDate .. ' ' .. AccessDate end if xDate ~= '' then xDate = sepc .. ' ' .. xDate end -- END LOCAL local idcommon = safe_join( { URL, xDate, ID_list, Archived, Via, SubscriptionRequired, Lay, Language, Quote }, sepc ); local text;  if is_set(Authors) then if is_set(Coauthors) then if 'vanc' == NameListFormat then -- separate authors and coauthors with proper name-list-separator Authors = Authors .. ', ' .. Coauthors; else Authors = Authors .. '; ' .. Coauthors; end end Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space if is_set(Editors) then local in_text = " "; local post_text = ""; if is_set(Chapter) and 0 == #c then in_text = in_text .. cfg.messages['in'] .. " " if (sepc ~= '.') then in_text = in_textk:lower() end -- lowercase for cs2 else if EditorCount <= 1 then post_text = ", " .. cfg.messages['editor']; else post_text = ", " .. cfg.messages['editors']; end end Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space end if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 Authors = by_text .. Authors; -- author follows title so tweak it here if is_set (Editors) 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 Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space text = safe_join( {Contributors, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc ); else text = safe_join( {Authors, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); end elseif is_set(Editors) then if EditorCount <= 1 then Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " " else Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " " end text = safe_join( {Editors, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); else if config.CitationClass=="journal" and is_set(Periodical) then text = safe_join( {Chapter, Place, tcommon, pgtext, idcommon}, sepc ); else text = safe_join( {Chapter, Place, tcommon, pgtext, idcommon}, sepc ); end 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 local options = {}; if is_set(config.CitationClass) and config.CitationClass ~= "citation" then options.class = config.CitationClass; options.class = "citation " .. config.CitationClass; -- 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 local namelist = {}; -- holds selected contributor, author, editor name list-- local year = first_set (Year, anchor_year); -- Year first for legacy citations and for YMD dates that require disambiguation 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 = c; -- select it elseif #a > 0 then -- or an author list namelist = a; elseif #e > 0 then -- or an editor list namelist = e; end id = anchor_id (namelist, year); -- go make the CITEREF anchor end options.id = id; end if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then z.error_categories = {}; text = set_error('empty_citation'); z.message_tail = {}; end if is_set(options.id) then text = '<cite id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</cite>"; else text = '<cite class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</cite>"; end   local empty_span = '<span style="display:none;">&nbsp;</span>'; -- Note: Using display: none on the COinS span breaks some clients. local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>'; text = text .. OCinS; if #z.message_tail ~= 0 then text = text .. " "; for i,v in ipairs( z.message_tail ) do if is_set(v[1]) then if i == #z.message_tail then text = text .. error_comment( v[1], v[2] ); else text = text .. error_comment( v[1] .. "; ", v[2] ); end end end end  if #z.maintenance_cats ~= 0 then text = text .. '<span class="citation-comment" style="display:none; color:#33aa33">'; for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories text = text .. ' ' .. v .. ' ([[:Category:' .. v ..'|link]])'; end text = text .. '</span>'; -- maintenance mesages (realy just the names of the categories for now) end no_tracking_cats = no_tracking_cats:lower(); if in_array(no_tracking_cats, {"", "no", "false", "n"}) then for _, v in ipairs( z.error_categories ) do text = text .. '[[Category:' .. v ..']]'; end for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories text = text .. '[[Category:' .. v ..']]'; end for _, v in ipairs( z.properties_cats ) do -- append maintenance categories text = text .. '[[Category:' .. v ..']]'; end end return textend --[[--------------------------< 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 nonprintable or invisible characters. The search stops at the first match. Sometime after this module is done with rendering a citation, some C0 control characters are replaced with thereplacement character. That replacement character is not detected by this test though it is visible to readersof the rendered citation. This function will detect the replacement character when it is part of the wikisource. Output of this function is an error message that identifies the character or the Unicode group that the characterbelongs to along with its position in the parameter value. ]]--[[local function has_invisible_chars (param, v) local position = ''; local i=1;  while cfg.invisible_chars[i] do local char=cfg.invisible_chars[i][1] -- the character or group name local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it v = mw.text.unstripNoWiki( v ); -- remove nowiki stripmarkers position = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern if position then table.insert( z.message_tail, { set_error( 'invisible_char', {char, wrap_style ('parameter', param), position}, true ) } ); -- add error message return; -- and done with this parameter end i=i+1; -- bump our index endend]] --[[--------------------------< Z . C I T A T I O N >---------------------------------------------------------- This is used by templates such as {{cite book}} to create the actual citation text. ]] function z.citation(frame) local pframe = frame:getParent() local validation; if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of Configuration and Whitelist and ... whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox'); validation = require ('Module:Citation/CS1/Date_validation/sandbox'); -- ... sandbox version of date validation code  else -- otherwise cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load live versions of Configuration and Whitelist and ... whitelist = mw.loadData ('Module:Citation/CS1/Whitelist'); validation = require ('Module:Citation/CS1/Date_validation'); -- ... live version of date validation code end  dates = validation.dates; -- imported functions year_date_check = validation.year_date_check;  local args = {}; local suggestions = {}; local error_text, error_state;  local config = {}; for k, v in pairs( frame.args ) do config[k] = v; args[k] = v; end   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_text = ""; if type( k ) ~= 'string' then -- Exclude empty numbered parameters if v:match("%S+") ~= nil then error_text, error_state = set_error( 'text_ignored', {v}, true ); end elseif validate( k:lower() ) then error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); else if nil == suggestions.suggestions then -- if this table is nil then we need to load it if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version? suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version else suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version end
end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
else
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
end
end
end
end
missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe?
args[k] = v;
elseif args[k] ~= nil or (k == 'postscript') then
end
return zcs1;
4,010
次編輯