in.wiki

Изменения

Модуль:Citation/CS1 (посмотреть исходный код)

Версия от 02:41, 4 сентября 2023

91 731 байт убрано ,  2 года назад
м
1 версия импортирована: Импорт из Википедии
Строка 1: Строка 1: −
require ('strict');
+
 
 +
local z = {
 +
error_categories = {}; -- for categorizing citations that contain errors
 +
error_ids = {};
 +
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 >--------------------------------------
 
--[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
−
  −
each of these counts against the Lua upvalue limit
  −
   
]]
 
]]
 +
local dates, year_date_check -- functions in Module:Citation/CS1/Date_validation
   −
local validation; -- functions in Module:Citation/CS1/Date_validation
+
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
 +
local whitelist = {}; -- talbe of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist
   −
local utilities; -- functions in Module:Citation/CS1/Utilities
+
--[[--------------------------< I S _ S E T >------------------------------------------------------------------
−
local z = {}; -- table of tables in Module:Citation/CS1/Utilities
     −
local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers
+
Returns true if argument is set; false otherwise. Argument is 'set' when it exists (not nil) or when it is not an empty string.
−
local metadata; -- functions in Module:Citation/CS1/COinS
+
This function is global because it is called from both this module and from Date validation
−
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
  −
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist
  −
 
  −
 
  −
--[[------------------< P A G E  S C O P E  V A R I A B L E S >---------------
  −
 
  −
declare variables here that have page-wide scope that are not brought in from
  −
other modules; that are created here and used here
      
]]
 
]]
−
 
+
function is_set( var )
−
local added_deprecated_cat; -- Boolean flag so that the category is added only once
+
return not (var == nil or var == '');
−
local added_vanc_errs; -- Boolean flag so we only emit one Vancouver error / category
+
end
−
local added_generic_name_errs; -- Boolean flag so we only emit one generic name error / category and stop testing names once an error is encountered
  −
local Frame; -- holds the module's frame table
  −
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
  −
local is_sandbox; -- true when using sandbox modules to render citation
  −
 
      
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
 
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
   −
Locates and returns the first set value in a table of values where the order established in the table,
+
First set variable or nil if none
−
left-to-right (or top-to-bottom), is the order in which the values are evaluated.  Returns nil if none are set.
  −
 
  −
This version replaces the original 'for _, val in pairs do' and a similar version that used ipairs.  With the pairs
  −
version the order of evaluation could not be guaranteed.  With the ipairs version, a nil value would terminate
  −
the for-loop before it reached the actual end of the list.
      
]]
 
]]
   −
local function first_set (list, count)
+
local function first_set(...)
−
local i = 1;
+
local list = {...};
−
while i <= count do -- loop through all items in list
+
for _, var in pairs(list) do
−
if utilities.is_set( list[i] ) then
+
if is_set( var ) then
−
return list[i]; -- return the first set list member
+
return var;
 
end
 
end
−
i = i + 1; -- point to next
   
end
 
end
 
end
 
end
    +
--[[--------------------------< I N _ A R R A Y >--------------------------------------------------------------
   −
--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------
+
Whether needle is in haystack
−
 
  −
Adds a single Vancouver system error message to the template's output regardless of how many error actually exist.
  −
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
  −
 
  −
added_vanc_errs is a Boolean declared in page scope variables above
      
]]
 
]]
   −
local function add_vanc_error (source, position)
+
local function in_array( needle, haystack )
−
if added_vanc_errs then return end
+
if needle == nil then
−
+
return false;
−
added_vanc_errs = true; -- note that we've added this category
+
end
−
utilities.set_message ('err_vancouver', {source, position});
+
for n,v in ipairs( haystack ) do
 +
if v == needle then
 +
return n;
 +
end
 +
end
 +
return false;
 
end
 
end
    +
--[[--------------------------< S U B S T I T U T E >----------------------------------------------------------
   −
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
+
Populates numbered arguments in a message string using an argument table.
−
 
  −
does this thing that purports to be a URI scheme seem to be a valid scheme?  The scheme is checked to see if it
  −
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
  −
Scheme names consist of a sequence of characters beginning with a
  −
  letter and followed by any combination of letters, digits, plus
  −
  ("+"), period ("."), or hyphen ("-").
  −
 
  −
returns true if it does, else false
      
]]
 
]]
   −
local function is_scheme (scheme)
+
local function substitute( msg, args )
−
return scheme and scheme:match ('^%a[%a%d%+%.%-]*:'); -- true if scheme is set and matches the pattern
+
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
 
end
 
end
    +
--[[--------------------------< E R R O R _ C O M M E N T >----------------------------------------------------
   −
--[=[-------------------------< I S _ D O M A I N _ N A M E >--------------------------------------------------
+
Wraps error messages with css markup according to the state of hidden.
   −
Does this thing that purports to be a domain name seem to be a valid domain name?
+
]]
 +
local function error_comment( content, hidden )
 +
return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['visible-error'], content );
 +
end
   −
Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
+
--[[--------------------------< S E T _ E R R O R >--------------------------------------------------------------
−
BNF defined here: https://tools.ietf.org/html/rfc4234
  −
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
  −
see also [[Single-letter second-level domain]]
  −
list of TLDs: https://www.iana.org/domains/root/db
     −
RFC 952 (modified by RFC 1123) requires the first and last character of a hostname to be a letter or a digit.  Between
+
Sets an error condition and returns the appropriate error message.  The actual placement of the error message in the output is
−
the first and last characters the name may use letters, digits, and the hyphen.
+
the responsibility of the calling function.
   −
Also allowed are IPv4 addresses. IPv6 not supported
+
]]
−
 
+
local function set_error( error_id, arguments, raw, prefix, suffix )
−
domain is expected to be stripped of any path so that the last character in the last character of the TLD.  tld
+
local error_state = cfg.error_conditions[ error_id ];
−
is two or more alpha characters.  Any preceding '//' (from splitting a URL with a scheme) will be stripped
+
−
here.  Perhaps not necessary but retained in case it is necessary for IPv4 dot decimal.
+
prefix = prefix or "";
−
 
+
suffix = suffix or "";
−
There are several tests:
+
−
the first character of the whole domain name including subdomains must be a letter or a digit
+
if error_state == nil then
−
internationalized domain name (ASCII characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the TLD) see https://tools.ietf.org/html/rfc3490
+
error( cfg.messages['undefined_error'] );
−
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
+
elseif is_set( error_state.category ) then
−
q, x, and z SL domains in the .com TLD
+
table.insert( z.error_categories, error_state.category );
−
i and q SL domains in the .net TLD
  −
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
  −
two-character SL domains in gTLDs (where the gTLD is two or more letters)
  −
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
  −
IPv4 dot-decimal address format; TLD not allowed
  −
 
  −
returns true if domain appears to be a proper name and TLD or IPv4 address, else false
  −
 
  −
]=]
  −
 
  −
local function is_domain_name (domain)
  −
if not domain then
  −
return false; -- if not set, abandon
   
end
 
end
 
 
−
domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once
+
local message = substitute( error_state.message, arguments );
 
 
−
if not domain:match ('^[%w]') then -- first character must be letter or digit
+
message = message .. " ([[" .. cfg.messages['help page link'] ..
−
return false;
+
"#" .. error_state.anchor .. "|" ..
 +
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
 
end
 +
 +
message = table.concat({ prefix, message, suffix });
 +
 +
if raw == true then
 +
return message, error_state.hidden;
 +
end
 +
 +
return error_comment( message, error_state.hidden );
 +
end
   −
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource
+
--[[--------------------------< A D D _ M A I N T _ C A T >------------------------------------------------------
−
return false;
  −
end
     −
local patterns = { -- patterns that look like URLs
+
Adds a category to z.maintenance_cats using names from the configuration file with additional text if any.
−
'%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
  −
'%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
  −
'%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
  −
'%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
  −
'%f[%w][%w]%.%a%a$', -- one character hostname and ccTLD (2 chars)
  −
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
  −
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
  −
}
     −
for _, pattern in ipairs (patterns) do -- loop through the patterns list
+
]]
−
if domain:match (pattern) then
  −
return true; -- if a match then we think that this thing that purports to be a URL is a URL
  −
end
  −
end
     −
for _, d in ipairs (cfg.single_letter_2nd_lvl_domains_t) do -- look for single letter second level domain names for these top level domains
+
local function add_maint_cat (key, arguments)
−
if domain:match ('%f[%w][%w]%.' .. d) then
+
table.insert( z.maintenance_cats, substitute (cfg.maint_cats [key], arguments)); -- make name then add to table
−
return true
  −
end
  −
end
  −
return false; -- no matches, we don't know what this thing is
   
end
 
end
    +
--[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------
   −
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
+
Adds a category to z.properties_cats using names from the configuration file with additional text if any.
−
 
  −
returns true if the scheme and domain parts of a URL appear to be a valid URL; else false.
  −
 
  −
This function is the last step in the validation process.  This function is separate because there are cases that
  −
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
  −
wikilinks.
      
]]
 
]]
   −
local function is_url (scheme, domain)
+
local function add_prop_cat (key, arguments)
−
if utilities.is_set (scheme) then -- if scheme is set check it and domain
+
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
−
return is_scheme (scheme) and is_domain_name (domain);
  −
else
  −
return is_domain_name (domain); -- scheme not set when URL is protocol-relative
  −
end
   
end
 
end
    +
--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
   −
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
+
Determines whether a URL string is valid.
   −
Split a URL into a scheme, authority indicator, and domain.
+
At present the only check is whether the string appears to be prefixed with a URI scheme.  It is not determined whether
 +
the URI scheme is valid or whether the URL is otherwise well formed.
   −
First remove Fully Qualified Domain Name terminator (a dot following TLD) (if any) and any path(/), query(?) or fragment(#).
+
]]
   −
If protocol-relative URL, return nil scheme and domain else return nil for both scheme and domain.
+
local function check_url( url_str )
 +
return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil; -- Protocol-relative or URL scheme
 +
end
   −
When not protocol-relative, get scheme, authority indicator, and domain.  If there is an authority indicator (one
+
--[[--------------------------< S A F E _ F O R _ I T A L I C S >----------------------------------------------
−
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.
     −
Any URL that does not have news: scheme must have authority indicator (//). TODO: are there other common schemes
+
Protects a string that will be wrapped in wiki italic markup '' ... ''
−
like news: that don't use authority indicator?
     −
Strip off any port and path;
+
Note: We cannot use <i> for italics, as the expected behavior for italics specified by ''...'' in the title is that
 +
they will be inverted (i.e. unitalicized) in the resulting references.  In addition, <i> and '' tend to interact
 +
poorly under Mediawiki's HTML tidy.
    
]]
 
]]
   −
local function split_url (url_str)
+
local function safe_for_italics( str )
−
local scheme, authority, domain;
+
if not is_set(str) then
−
+
return str;
−
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
+
else
−
 
+
if str:sub(1,1) == "'" then str = "<span />" .. str; end
−
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol-relative URL
+
if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
−
domain = url_str:match ('^//(%S*)')
+
−
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name
+
-- Remove newlines as they break italics.
−
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
+
return str:gsub( '\n', ' ' );
−
if utilities.is_set (authority) then
  −
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
  −
if utilities.is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
  −
return scheme; -- return scheme only making domain nil which will cause an error message
  −
end
  −
else
  −
if not scheme:match ('^news:') then -- except for news:..., MediaWiki won't link URLs that do not have authority indicator; TODO: a better way to do this test?
  −
return scheme; -- return scheme only making domain nil which will cause an error message
  −
end
  −
end
  −
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
   
end
 
end
−
  −
return scheme, domain;
   
end
 
end
    +
--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------
   −
--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------
+
Escape sequences for content that will be used for URL descriptions
   −
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:
+
local function safe_for_url( str )
−
# < > [ ] | { } _
+
if str:match( "%[%[.-%]%]" ) ~= nil then
−
except the underscore which is used as a space in wiki URLs and # which is used for section links
+
table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } );
 +
end
 +
 +
return str:gsub( '[%[%]\n]', {
 +
['['] = '&#91;',
 +
[']'] = '&#93;',
 +
['\n'] = ' ' } );
 +
end
   −
returns false when the value contains any of these characters.
+
--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------
   −
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid URL (the
+
Applies styling to various parameters.  Supplied string is wrapped using a message_list configuration taking one
−
|<param>-link= parameter is ok); else false when value appears to be a valid URL (the |<param>-link= parameter is NOT ok).
+
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 link_param_ok (value)
+
local function wrap_style (key, str)
−
local scheme, domain;
+
if not is_set( str ) then
−
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
+
return "";
−
return false;
+
elseif in_array( key, { 'italic-title', 'trans-italic-title' } ) then
 +
str = safe_for_italics( str );
 
end
 
end
   −
scheme, domain = split_url (value); -- get scheme or nil and domain or nil from URL;
+
return substitute( cfg.presentation[key], {str} );
−
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid URL
   
end
 
end
    +
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
   −
--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------
+
Format an external link with error checking
−
 
  −
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.
  −
 
  −
|<title>= may be wiki-linked but not when |<param>-link= has a value.  This function emits an error message when
  −
that condition exists
  −
 
  −
check <link> for inter-language interwiki-link prefix.  prefix must be a MediaWiki-recognized language
  −
code and must begin with a colon.
      
]]
 
]]
   −
local function link_title_ok (link, lorig, title, torig)
+
local function external_link( URL, label, source )
−
local orig;
+
local error_str = "";
−
if utilities.is_set (link) then -- don't bother if <param>-link doesn't have a value
+
if not is_set( label ) then
−
if not link_param_ok (link) then -- check |<param>-link= markup
+
label = URL;
−
orig = lorig; -- identify the failing link parameter
+
if is_set( source ) then
−
elseif title:find ('%[%[') then -- check |title= for wikilink markup
+
error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
−
orig = torig; -- identify the failing |title= parameter
+
else
−
elseif link:match ('^%a+:') then -- if the link is what looks like an interwiki
+
error( cfg.messages["bare_url_no_origin"] );
−
local prefix = link:match ('^(%a+):'):lower(); -- get the interwiki prefix
+
end
−
 
  −
if cfg.inter_wiki_map[prefix] then -- if prefix is in the map, must have preceding colon
  −
orig = lorig; -- flag as error
  −
end
  −
end
   
end
 
end
−
 
+
if not check_url( URL ) then
−
if utilities.is_set (orig) then
+
error_str = set_error( 'bad_url', {}, false, " " ) .. error_str;
−
link = ''; -- unset
  −
utilities.set_message ('err_bad_paramlink', orig); -- URL or wikilink in |title= with |title-link=;
   
end
 
end
−
+
return table.concat({ "[", URL, " ", safe_for_url( label ), "]", error_str });
−
return link; -- link if ok, empty string else
   
end
 
end
    +
--[[--------------------------< E X T E R N A L _ L I N K _ I D >----------------------------------------------
   −
--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
+
Formats a wiki style external link
−
 
  −
Determines whether a URL string appears to be valid.
  −
 
  −
First we test for space characters.  If any are found, return false.  Then split the URL into scheme and domain
  −
portions, or for protocol-relative (//example.com) URLs, just the domain.  Use is_url() to validate the two
  −
portions of the URL.  If both are valid, or for protocol-relative if domain is valid, return true, else false.
  −
 
  −
Because it is different from a standard URL, and because this module used external_link() to make external links
  −
that work for standard and news: links, we validate newsgroup names here.  The specification for a newsgroup name
  −
is at https://tools.ietf.org/html/rfc5536#section-3.1.4
      
]]
 
]]
   −
local function check_url( url_str )
+
local function external_link_id(options)
−
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper URL
+
local url_string = options.id;
−
return false;
+
if options.encode == true or options.encode == nil then
 +
url_string = mw.uri.encode( url_string );
 
end
 
end
−
local scheme, domain;
+
return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
 +
options.link, options.label, options.separator or "&nbsp;",
 +
options.prefix, url_string, options.suffix or "",
 +
mw.text.nowiki(options.id)
 +
);
 +
end
   −
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from URL;
+
--[[
−
+
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |month=,
−
if 'news:' == scheme then -- special case for newsgroups
+
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
−
return domain:match('^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$');
+
details of which parameter caused the error message are not provided.  Only one error message is emitted regardless of the number of deprecated parameters in the citation.
 +
]]
 +
local function deprecated_parameter(name)
 +
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
 +
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
 +
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
 
end
 
end
−
  −
return is_url (scheme, domain); -- return true if value appears to be a valid URL
   
end
 
end
    +
--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
   −
--[=[-------------------------< I S _ P A R A M E T E R _ E X T _ W I K I L I N K >----------------------------
+
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.
   −
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
+
Call this function for chapter titles, for website titles, etc; not for book titles.
−
non-space characters following the opening bracket appear to be a URL.  The test will also find external wikilinks
  −
that use protocol-relative URLs. Also finds bare URLs.
     −
The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs.  The tests that
+
]]
−
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
  −
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
  −
is possible as might be [[en://Hus]].
     −
]=]
+
local function kern_quotes (str)
 +
local cap='';
 +
local cap2='';
 +
 +
cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes
 +
if is_set (cap) then
 +
str = substitute (cfg.presentation['kern-left'], {cap, cap2});
 +
end
   −
local function is_parameter_ext_wikilink (value)
+
cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
−
local scheme, domain;
+
if is_set (cap) then
−
 
+
str = substitute (cfg.presentation['kern-right'], {cap, cap2});
−
if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext. wikilink with scheme and domain: [xxxx://yyyyy.zzz]
  −
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
  −
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol-relative ext. wikilink: [//yyyyy.zzz]
  −
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
  −
elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text
  −
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
  −
elseif value:match ('//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; may have leading or trailing plain text
  −
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain
  −
else
  −
return false; -- didn't find anything that is obviously a URL
   
end
 
end
−
 
+
return str;
−
return is_url (scheme, domain); -- return true if value appears to be a valid URL
   
end
 
end
    +
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
 +
 +
|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
 +
not be italicized and may be written right-to-left.  The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
 +
in italic markup.
 +
 +
Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate rtl languages from the English left to right.
 +
 +
|script-title= provides a unique feature.  The value in |script-title= may be prefixed with a two-character ISO639-1 language code and a colon:
 +
|script-title=ja:*** *** (where * represents a Japanese character)
 +
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
 +
|script-title=ja : *** ***
 +
|script-title=ja: *** ***
 +
|script-title=ja :*** ***
 +
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
   −
--[[-------------------------< C H E C K _ F O R _ U R L >-----------------------------------------------------
+
The prefix is checked for validity.  If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
 +
know the language the tag contains.  This may help the browser render the script more correctly.  If the prefix is invalid, the lang attribute
 +
is not added.  At this time there is no error message for this condition.
   −
loop through a list of parameters and their values.  Look at the value and if it has an external link, emit an error message.
+
At this writing, only |script-title= is supported.  It is anticipated that additional parameters will be created to use this function.
    +
TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
 
]]
 
]]
   −
local function check_for_url (parameter_list, error_list)
+
local function format_script_value (script_value)
−
for k, v in pairs (parameter_list) do -- for each parameter in the list
+
local lang=''; -- initialize to empty string
−
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a URL add an error message
+
local name;
−
table.insert (error_list, utilities.wrap_style ('parameter', k));
+
if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix
 +
lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
 +
if not is_set (lang) then
 +
return ''; -- script_value was just the prefix so return empty string
 +
end
 +
-- if we get this far we have prefix and script
 +
name = mw.language.fetchLanguageName( lang, "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', 'hy', 'ja', 'ka', 'ko', 'ku', 'he', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then
 +
add_prop_cat ('script_with_name', {name, lang})
 +
else
 +
add_prop_cat ('script')
 +
end
 +
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
 +
else
 +
lang = ''; -- invalid so set lang to empty string
 
end
 
end
 
end
 
end
 +
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
 +
 +
return script_value;
 
end
 
end
    +
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
   −
--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------
+
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
−
 
+
wrapped in <bdi> tags.
−
Escape sequences for content that will be used for URL descriptions
  −
 
   
]]
 
]]
   −
local function safe_for_url( str )
+
local function script_concatenate (title, script)
−
if str:match( "%[%[.-%]%]" ) ~= nil then  
+
if is_set (script) then
−
utilities.set_message ('err_wikilink_in_url', {});
+
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
 +
if is_set (script) then
 +
title = title .. ' ' .. script; -- concatenate title and script title
 +
end
 
end
 
end
−
+
return title;
−
return str:gsub( '[%[%]\n]', {
  −
['['] = '&#91;',
  −
[']'] = '&#93;',
  −
['\n'] = ' ' } );
   
end
 
end
      −
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
+
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
   −
Format an external link with error checking
+
Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
 +
configuration taking one argument.  Supports lower case text for {{citation}} templates.  Additional text taken
 +
from citation_config.messages - the reason this function is similar to but separate from wrap_style().
    
]]
 
]]
   −
local function external_link (URL, label, source, access)
+
local function wrap_msg (key, str, lower)
−
local err_msg = '';
+
if not is_set( str ) then
−
local domain;
+
return "";
−
local path;
  −
local base_url;
  −
 
  −
if not utilities.is_set (label) then
  −
label = URL;
  −
if utilities.is_set (source) then
  −
utilities.set_message ('err_bare_url_missing_title', {utilities.wrap_style ('parameter', source)});
  −
else
  −
error (cfg.messages["bare_url_no_origin"]); -- programmer error; valid parameter name does not have matching meta-parameter
  −
end
   
end
 
end
−
if not check_url (URL) then
+
if true == lower then
−
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)});
+
local msg;
−
end
+
msg = cfg.messages[key]:lower(); -- set the message to lower case before
−
+
str = substitute( msg, {str} ); -- including template text
−
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path
+
return str;
−
if path then -- if there is a path portion
+
else
−
path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); -- replace '[' and ']' with their percent-encoded values
+
return substitute( cfg.messages[key], {str} );
−
URL = table.concat ({domain, path}); -- and reassemble
+
end
−
end
  −
 
  −
base_url = table.concat ({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL
  −
 
  −
if utilities.is_set (access) then -- access level (subscription, registration, limited)
  −
base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
  −
end
  −
 
  −
return base_url;
   
end
 
end
    +
--[[--------------------------< S E L E C T _ O N E >----------------------------------------------------------
   −
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
+
Chooses one matching parameter from a list of parameters to consider
−
 
+
Generates an error if more than one match is present.
−
Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
  −
offending parameter name to the error message.  Only one error message is emitted regardless of the number of deprecated
  −
parameters in the citation.
  −
 
  −
added_deprecated_cat is a Boolean declared in page scope variables above
      
]]
 
]]
   −
local function deprecated_parameter(name)
+
local function select_one( args, possible, error_condition, index )
−
if not added_deprecated_cat then
+
local value = nil;
−
added_deprecated_cat = true; -- note that we've added this category
+
local selected = '';
−
utilities.set_message ('err_deprecated_params', {name}); -- add error message
+
local error_list = {};
 +
 +
if index ~= nil then index = tostring(index); end
 +
 +
-- Handle special case of "#" replaced by empty string
 +
if index == '1' then
 +
for _, v in ipairs( possible ) do
 +
v = v:gsub( "#", "" );
 +
if is_set(args[v]) then
 +
if value ~= nil and selected ~= v then
 +
table.insert( error_list, v );
 +
else
 +
value = args[v];
 +
selected = v;
 +
end
 +
end
 +
end
 
end
 
end
−
end
+
−
 
+
for _, v in ipairs( possible ) do
−
 
+
if index ~= nil then
−
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
+
v = v:gsub( "#", index );
−
 
+
end
−
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
+
if is_set(args[v]) then
−
mark contained in a |title= or |chapter= parameter's value.
+
if value ~= nil and selected ~=  v then
 +
table.insert( error_list, v );
 +
else
 +
value = args[v];
 +
selected = v;
 +
end
 +
end
 +
end
 +
 +
if #error_list > 0 then
 +
local error_str = "";
 +
for _, k in ipairs( error_list ) do
 +
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
 +
error_str = error_str .. wrap_style ('parameter', k);
 +
end
 +
if #error_list > 1 then
 +
error_str = error_str .. cfg.messages['parameter-final-separator'];
 +
else
 +
error_str = error_str .. cfg.messages['parameter-pair-separator'];
 +
end
 +
error_str = error_str .. wrap_style ('parameter', selected);
 +
table.insert( z.message_tail, { set_error( error_condition, {error_str}, true ) } );
 +
end
 +
 +
return value, selected;
 +
end
   −
This function will positive kern either single or double quotes:
+
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
−
"'Unkerned title with leading and trailing single quote marks'"
  −
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
  −
Double single quotes (italic or bold wiki-markup) are not kerned.
     −
Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
+
Format the three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
−
quote marks regardless of the need for kerning.  Unicode quote marks are not replaced in simple [[D]] wikilinks.
+
parameter (chapter_url_source used for error messages).
   −
Call this function for chapter titles, for website titles, etc.; not for book titles.
+
]]
−
 
  −
]=]
  −
 
  −
local function kern_quotes (str)
  −
local cap = '';
  −
local wl_type, label, link;
     −
wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
+
local function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source)
 +
local chapter_error = '';
 
 
−
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
+
if not is_set (chapter) then
−
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
+
chapter = ''; -- just to be safe for concatenation
−
str = utilities.substitute (cfg.presentation['kern-left'], str);
+
if is_set (transchapter) then
−
str = utilities.substitute (cfg.presentation['kern-right'], str);
+
chapter = wrap_style ('trans-quoted-title', transchapter);
−
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
+
chapter_error = " " .. set_error ('trans_missing_chapter');
−
str = utilities.substitute (cfg.presentation['kern-left'], str);
  −
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
  −
str = utilities.substitute (cfg.presentation['kern-right'], str);
   
end
 
end
−
 
+
if is_set (chapterurl) then
−
else -- plain text or [[L|D]]; text in label variable
+
chapter = external_link (chapterurl, chapter, chapter_url_source); -- adds bare_url_missing_title error if appropriate
−
label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
  −
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
  −
 
  −
cap = mw.ustring.match (label, "^([\"\'][^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
  −
if utilities.is_set (cap) then
  −
label = utilities.substitute (cfg.presentation['kern-left'], cap);
   
end
 
end
−
+
return chapter .. chapter_error;
−
cap = mw.ustring.match (label, "^(.+[^\'][\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
+
else -- here when chapter is set
−
if utilities.is_set (cap) then
+
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
−
label = utilities.substitute (cfg.presentation['kern-right'], cap);
+
chapter = wrap_style ('quoted-title', chapter);
 +
if is_set (transchapter) then
 +
transchapter = wrap_style ('trans-quoted-title', transchapter);
 +
chapter = chapter .. ' ' .. transchapter;
 
end
 
end
−
+
if is_set (chapterurl) then
−
if 2 == wl_type then
+
chapter = external_link (chapterurl, chapter); -- adds bare_url_missing_title error if appropriate
−
str = utilities.make_wikilink (link, label); -- reassemble the wikilink
  −
else
  −
str = label;
   
end
 
end
 
end
 
end
−
return str;
+
return chapter;
 
end
 
end
    +
--[[
 +
Argument wrapper.  This function provides support for argument
 +
mapping defined in the configuration file so that multiple names
 +
can be transparently aliased to single internal variable.
 +
]]
   −
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
+
local function argument_wrapper( args )
−
 
+
local origin = {};
−
|script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
+
−
not be italicized and may be written right-to-left.  The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
+
return setmetatable({
−
in italic markup.
+
ORIGIN = function( self, k )
−
 
+
local dummy = self[k]; --force the variable to be loaded.
−
Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate RTL languages from the English left to right.
+
return origin[k];
−
 
  −
|script-title= provides a unique feature.  The value in |script-title= may be prefixed with a two-character ISO 639-1 language code and a colon:
  −
|script-title=ja:*** *** (where * represents a Japanese character)
  −
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
  −
|script-title=ja : *** ***
  −
|script-title=ja: *** ***
  −
|script-title=ja :*** ***
  −
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
  −
 
  −
The prefix is checked for validity.  If it is a valid ISO 639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
  −
know the language the tag contains.  This may help the browser render the script more correctly.  If the prefix is invalid, the lang attribute
  −
is not added.  At this time there is no error message for this condition.
  −
 
  −
Supports |script-title=, |script-chapter=, |script-<periodical>=
  −
 
  −
]]
  −
 
  −
local function format_script_value (script_value, script_param)
  −
local lang=''; -- initialize to empty string
  −
local name;
  −
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
  −
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
  −
if not utilities.is_set (lang) then
  −
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing title part']}); -- prefix without 'title'; add error message
  −
return ''; -- script_value was just the prefix so return empty string
   
end
 
end
−
-- if we get this far we have prefix and script
+
},
−
name = cfg.lang_tag_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
+
{
−
if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code?
+
__index = function ( tbl, k )
−
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
+
if origin[k] ~= nil then
−
-- is prefix one of these language codes?
+
return nil;
−
if utilities.in_array (lang, cfg.script_lang_codes) then
+
end
−
utilities.add_prop_cat ('script', {name, lang})
+
−
else
+
local args, list, v = args, cfg.aliases[k];
−
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['unknown language code']}); -- unknown script-language; add error message
+
 +
if type( list ) == 'table' then
 +
v, origin[k] = select_one( args, list, 'redundant_parameters' );
 +
if origin[k] == nil then
 +
origin[k] = ''; -- Empty string, not nil
 +
end
 +
elseif list ~= nil then
 +
v, origin[k] = args[list], list;
 +
else
 +
-- maybe let through instead of raising an error?
 +
-- v, origin[k] = args[k], k;
 +
error( cfg.messages['unknown_argument_map'] );
 
end
 
end
−
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
+
−
else
+
-- Empty strings, not nil;
−
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['invalid language code']}); -- invalid language code; add error message
+
if v == nil then
−
lang = ''; -- invalid so set lang to empty string
+
v = cfg.defaults[k] or '';
−
end
+
origin[k] = '';
−
else
+
end
−
utilities.set_message ('err_script_parameter', {script_param, cfg.err_msg_supl['missing prefix']}); -- no language code prefix; add error message
+
−
end
+
tbl = rawset( tbl, k, v );
−
script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL
+
return v;
−
 
+
end,
−
return script_value;
+
});
−
end
+
end
−
 
  −
 
  −
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
  −
 
  −
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script
  −
value has been wrapped in <bdi> tags.
      +
--[[
 +
Looks for a parameter's name in the whitelist.
 +
 +
Parameters in the whitelist can have three values:
 +
true - active, supported parameters
 +
false - deprecated, supported parameters
 +
nil - unsupported parameters
 
]]
 
]]
   −
local function script_concatenate (title, script, script_param)
+
local function validate( name )
−
if utilities.is_set (script) then
+
local name = tostring( name );
−
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
+
local state = whitelist.basic_arguments[ name ];
−
if utilities.is_set (script) then
+
−
title = title .. ' ' .. script; -- concatenate title and script title
+
-- Normal arguments
−
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
 +
 +
-- Arguments with numbers in them
 +
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
 +
state = whitelist.numbered_arguments[ name ];
 +
if true == state then return true; end -- valid actively supported parameter
 +
if false == state then
 +
deprecated_parameter (name); -- parameter is deprecated but still supported
 +
return true;
 
end
 
end
−
return title;
+
 +
return false; -- Not supported because not found or name is set to nil
 
end
 
end
      −
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
+
-- Formats a wiki style internal link
 +
local function internal_link_id(options)
 +
return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
 +
options.link, options.label, options.separator or "&nbsp;",
 +
options.prefix, options.id, options.suffix or "",
 +
mw.text.nowiki(options.id)
 +
);
 +
end
 +
 
   −
Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
+
--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------
−
configuration taking one argument. Supports lower case text for {{citation}} templates. Additional text taken
+
 
−
from citation_config.messages - the reason this function is similar to but separate from wrap_style().
+
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or is
 +
MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
 +
 
 +
DOES NOT yet support MMMM YYYY or any of the date ranges.
    
]]
 
]]
   −
local function wrap_msg (key, str, lower)
+
local function nowrap_date (date)
−
if not utilities.is_set ( str ) then
+
local cap='';
−
return "";
+
local cap2='';
 +
 
 +
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
 +
date = substitute (cfg.presentation['nowrap1'], date);
 +
 +
elseif date:match("^%a+%s*%d%d?,%s*%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s*%d%d%d%d$") then
 +
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
 +
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
 
end
 
end
−
if true == lower then
+
−
local msg;
+
return date;
−
msg = cfg.messages[key]:lower(); -- set the message to lower case before
  −
return utilities.substitute ( msg, str ); -- including template text
  −
else
  −
return utilities.substitute ( cfg.messages[key], str );
  −
end
   
end
 
end
    +
--[[--------------------------< IS _ V A L I D _ I S X N >-----------------------------------------------------
   −
--[[----------------< W I K I S O U R C E _ U R L _ M A K E >-------------------
+
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,
−
Makes a Wikisource URL from Wikisource interwiki-link. Returns the URL and appropriate
+
spaces and other non-isxn characters.
−
label; nil else.
  −
 
  −
str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
      
]]
 
]]
   −
local function wikisource_url_make (str)
+
local function is_valid_isxn (isxn_str, len)
−
local wl_type, D, L;
+
local temp = 0;
−
local ws_url, ws_label;
+
isxn_str = { isxn_str:byte(1, len) }; -- make a table of byte values '0' → 0x30 .. '9'  → 0x39, 'X' → 0x58
−
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});
+
len = len+1; -- adjust to be a loop counter
−
 
+
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
−
wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
+
if v == string.byte( "X" ) then -- if checkdigit is X (compares the byte value of 'X' which is 0x58)
−
 
+
temp = temp + 10*( len - i ); -- it represents 10 decimal
−
if 0 == wl_type then -- not a wikilink; might be from |title-link=
+
else
−
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
+
temp = temp + tonumber( string.char(v) )*(len-i);
−
if utilities.is_set (str) then
  −
ws_url = table.concat ({ -- build a Wikisource URL
  −
wikisource_prefix, -- prefix
  −
str, -- article title
  −
});
  −
ws_label = str; -- label for the URL
  −
end
  −
elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]]
  −
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
  −
if utilities.is_set (str) then
  −
ws_url = table.concat ({ -- build a Wikisource URL
  −
wikisource_prefix, -- prefix
  −
str, -- article title
  −
});
  −
ws_label = str; -- label for the URL
  −
end
  −
elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]])
  −
str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
  −
if utilities.is_set (str) then
  −
ws_label = D; -- get ws article name from display portion of interwiki link
  −
ws_url = table.concat ({ -- build a Wikisource URL
  −
wikisource_prefix, -- prefix
  −
str, -- article title without namespace from link portion of wikilink
  −
});
   
end
 
end
 
end
 
end
 +
return temp % 11 == 0; -- returns true if calculation result is zero
 +
end
   −
if ws_url then
  −
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL
  −
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent-encoding of fragment marker
  −
end
     −
return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil
+
--[[--------------------------< C H E C K _ I S B N >------------------------------------------------------------
−
end
  −
 
  −
 
  −
--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
     −
Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
+
Determines whether an ISBN string is valid
−
and |trans-<periodical>= into a single Periodical meta-parameter.
      
]]
 
]]
   −
local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
+
local function check_isbn( isbn_str )
 +
if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end -- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
 +
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
 +
local len = isbn_str:len();
 +
 +
if len ~= 10 and len ~= 13 then
 +
return false;
 +
end
   −
if not utilities.is_set (periodical) then
+
if len == 10 then
−
periodical = ''; -- to be safe for concatenation
+
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
 +
return is_valid_isxn(isbn_str, 10);
 
else
 
else
−
periodical = utilities.wrap_style ('italic-title', periodical); -- style
+
local temp = 0;
−
end
+
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
−
 
+
isbn_str = { isbn_str:byte(1, len) };
−
periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
+
for i, v in ipairs( isbn_str ) do
−
 
+
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
−
if utilities.is_set (trans_periodical) then
  −
trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical);
  −
if utilities.is_set (periodical) then
  −
periodical = periodical .. ' ' .. trans_periodical;
  −
else -- here when trans-periodical without periodical or script-periodical
  −
periodical = trans_periodical;
  −
utilities.set_message ('err_trans_missing_title', {'periodical'});
   
end
 
end
 +
return temp % 10 == 0;
 
end
 
end
−
  −
return periodical;
   
end
 
end
    +
--[[--------------------------< I S S N >----------------------------------------------------------------------
   −
--[[------------------< F O R M A T _ C H A P T E R _ T I T L E >---------------
+
Validate and format an issn.  This code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
 +
digits with a space.  When that condition occurred, the resulting link looked like this:
   −
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=,
+
|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
−
and |chapter-url= into a single chapter meta- parameter (chapter_url_source used
+
−
for error messages).
+
This code now prevents that by inserting a hyphen at the issn midpoint.  It also validates the issn for length and makes sure that the checkdigit agrees
 +
with the calculated value.  Incorrect length (8 digits), characters other than 0-9 and X, or checkdigit / calculated value mismatch will all cause a check issn
 +
error message.  The issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
    
]]
 
]]
   −
local function format_chapter_title (script_chapter, script_chapter_source, chapter, chapter_source, trans_chapter, trans_chapter_source, chapter_url, chapter_url_source, no_quotes, access)
+
local function issn(id)
−
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
+
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
−
if ws_url then
+
local handler = cfg.id_handlers['ISSN'];
−
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
+
local text;
−
chapter = ws_label;
+
local valid_issn = true;
−
end
+
 
 +
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and endashes from the issn
   −
if not utilities.is_set (chapter) then
+
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position
−
chapter = ''; -- to be safe for concatenation
+
valid_issn=false; -- wrong length or improper character
 
else
 
else
−
if false == no_quotes then
+
valid_issn=is_valid_isxn(id, 8); -- validate issn
−
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from module provided quote marks
  −
chapter = utilities.wrap_style ('quoted-title', chapter);
  −
end
   
end
 
end
   −
chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
+
if true == valid_issn then
−
 
+
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
−
if utilities.is_set (chapter_url) then
+
else
−
chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
+
id = issn_copy; -- if not valid, use the show the invalid issn with error message
−
elseif ws_url then
  −
chapter = external_link (ws_url, chapter .. '&nbsp;', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this?
  −
chapter = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
   
end
 
end
−
 
+
−
if utilities.is_set (trans_chapter) then
+
text = external_link_id({link = handler.link, label = handler.label,
−
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
+
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
−
if utilities.is_set (chapter) then
+
−
chapter = chapter .. ' ' .. trans_chapter;
+
if false == valid_issn then
−
else -- here when trans_chapter without chapter or script-chapter
+
text = text .. ' ' .. set_error( 'bad_issn' ) -- add an error message if the issn is invalid
−
chapter = trans_chapter;
+
end  
−
chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>
+
−
utilities.set_message ('err_trans_missing_title', {chapter_source});
+
return text
−
end
  −
end
  −
 
  −
return chapter;
   
end
 
end
    +
--[[--------------------------< A M A Z O N >------------------------------------------------------------------
   −
--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------
+
Formats a link to Amazon.  Do simple error checking: asin must be mix of 10 numeric or uppercase alpha
 +
characters.  If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit
 +
isbn. 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 digit.
   −
This function searches a parameter's value for non-printable or invisible characters.
+
]]
−
The search stops at the first match.
     −
This function will detect the visible replacement character when it is part of the Wikisource.
+
local function amazon(id, domain)
 +
local err_cat = ""
   −
Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers
+
if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
−
(gallery, math, pre, ref) and identifies them with a slightly different error message.
+
err_cat =  ' ' .. set_error ('bad_asin'); -- asin is not a mix of 10 uppercase alpha and numeric characters
−
See also coins_cleanup().
+
else
−
 
+
if id:match("^%d%d%d%d%d%d%d%d%d[%dX]$") then -- if 10-digit numeric (or 9 digits with terminal X)
−
Output of this function is an error message that identifies the character or the
+
if check_isbn( id ) then -- see if asin value is isbn10
−
Unicode group, or the stripmarker that was detected along with its position (or,
+
add_maint_cat ('ASIN');
−
for multi-byte characters, the position of its first byte) in the parameter value.
+
elseif not is_set (err_cat) then
 +
err_cat =  ' ' .. set_error ('bad_asin'); -- asin is not isbn10
 +
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'}) 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="//www.amazon."..domain.."/dp/",id=id,
 +
encode=handler.encode, separator = handler.separator}) .. err_cat;
 +
end
   −
]]
+
--[[--------------------------< A R X I V >--------------------------------------------------------------------
 +
 
 +
See: http://arxiv.org/help/arxiv_identifier
   −
local function has_invisible_chars (param, v)
+
format and error check arXiv identifier.  There are three valid forms of the identifier:
−
local position = ''; -- position of invisible char or starting position of stripmarker
+
the first form, valid only between date codes 9108 and 0703 is:
−
local capture; -- used by stripmarker detection to hold name of the stripmarker
+
arXiv:<archive>.<class>/<date code><number><version>
−
local stripmarker; -- boolean set true when a stripmarker is found
+
where:
 +
<archive> is a string of alpha characters - may be hyphenated; no other punctuation
 +
<class> is a string of alpha characters - may be hyphenated; no other punctuation
 +
<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
 +
first digit of YY for this form can only 9 and 0
 +
<number> is a three-digit number
 +
<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
 +
 +
the second form, valid from April 2007 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 number
 +
<version> is a 1 or more digit number preceded with a lowercase v; no spaces
   −
capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true
+
the third form, valid from January 2015 is:
−
if capture == v then -- if same there are no Unicode characters
+
arXiv:<date code>.<number><version>
−
return;
+
where:
−
end
+
<date code> and <version> are as defined for 0704-1412
 +
<number> is a five-digit number
 +
]]
   −
for _, invisible_char in ipairs (cfg.invisible_chars) do
+
local function arxiv (id, class)
−
local char_name = invisible_char[1]; -- the character or group name
+
local handler = cfg.id_handlers['ARXIV'];
−
local pattern = invisible_char[2]; -- the pattern used to find it
+
local year, month, version;
−
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
+
local err_cat = '';
−
+
local text;
−
if position and (cfg.invisible_defs.zwj == capture) then -- if we found a zero-width joiner character
+
−
if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts
+
if id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$") or id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$") then -- test for the 9108-0703 format w/ & w/o version
−
position = nil; -- unset position
+
year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");
−
elseif cfg.emoji_t[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
+
year = tonumber(year);
−
position = nil; -- unset position
+
month = tonumber(month);
−
end
+
if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or -- if invalid year or invalid month
 +
((91 == year and 7 > month) or (7 == year and 3 < month)) then -- if years ok, are starting and ending months ok?
 +
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
 +
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 > year) or (14 < year) or (1 > month or 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years)
 +
((7 == year) and (4 > month)) then --or -- when year is 07, is month invalid (before April)?
 +
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
 
end
 
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
−
if position then
+
year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$");
−
if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition)
+
year = tonumber(year);
−
('templatestyles' == capture and utilities.in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters
+
month = tonumber(month);
−
stripmarker = true; -- set a flag
+
if ((15 > year) or (1 > month or 12 < month)) then -- is year invalid or is month invalid? (doesn't test for future years)
−
elseif true == stripmarker and cfg.invisible_defs.del == capture then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
+
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- set error message
−
position = nil; -- unset
  −
else
  −
local err_msg;
  −
if capture and not (cfg.invisible_defs.del == capture or cfg.invisible_defs.zwj == capture) then
  −
err_msg = capture .. ' ' .. char_name;
  −
else
  −
err_msg = char_name .. ' ' .. 'character';
  −
end
  −
 
  −
utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}); -- add error message
  −
return; -- and done with this parameter
  −
end
   
end
 
end
 +
else
 +
err_cat = ' ' .. set_error( 'bad_arxiv' ); -- arXiv id doesn't match any format
 
end
 
end
−
end
      +
text = external_link_id({link = handler.link, label = handler.label,
 +
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
   −
--[[-------------------< A R G U M E N T _ W R A P P E R >----------------------
+
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
   −
Argument wrapper. This function provides support for argument mapping defined
+
--[[
−
in the configuration file so that multiple names can be transparently aliased to
+
lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
−
single internal variable.
+
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 a hyphen in the string:
 +
a. Remove it.
 +
b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
 +
1. All these characters should be digits, and there should be six or less. (not done in this function)
 +
2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
    +
Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
 
]]
 
]]
   −
local function argument_wrapper ( args )
+
local function normalize_lccn (lccn)
−
local origin = {};
+
lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace
 +
 
 +
if nil ~= string.find (lccn,'/') 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 then -- if there was a hyphen
 +
suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6
 +
lccn=prefix..suffix; -- reassemble the lccn
 +
end
 
 
−
return setmetatable({
+
return lccn;
−
ORIGIN = function ( self, k )
+
end
−
local dummy = self[k]; -- force the variable to be loaded.
+
 
−
return origin[k];
+
--[[
 +
Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
 +
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
 +
 
 +
length = 8 then all digits
 +
length = 9 then lccn[1] is lower case alpha
 +
length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits
 +
length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits
 +
length = 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
 
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) ...
−
__index = function ( tbl, k )
+
if nil == id:match("^%l%l%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
−
if origin[k] ~= nil then
+
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
−
return nil;
   
end
 
end
−
+
end
−
local args, list, v = args, cfg.aliases[k];
+
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
−
if type( list ) == 'table' then
+
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
−
v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' );
+
end
−
if origin[k] == nil then
+
elseif 12 == len then -- LCCN should be aadddddddddd
−
origin[k] = ''; -- Empty string, not nil
+
if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
−
end
+
err_cat = ' ' .. set_error( 'bad_lccn' ); -- no match, set an error message
−
elseif list ~= nil then
+
end
−
v, origin[k] = args[list], list;
+
else
−
else
+
err_cat = ' ' .. set_error( 'bad_lccn' ); -- wrong length, set an error message
−
-- maybe let through instead of raising an error?
+
end
−
-- v, origin[k] = args[k], k;
  −
error( cfg.messages['unknown_argument_map'] .. ': ' .. k);
  −
end
  −
  −
-- Empty strings, not nil;
  −
if v == nil then
  −
v = '';
  −
origin[k] = '';
  −
end
  −
  −
tbl = rawset( tbl, k, v );
  −
return v;
  −
end,
  −
});
  −
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
   −
--[[--------------------------< N O W R A P _ D A T E >-------------------------
+
return external_link_id({link = handler.link, label = handler.label,
−
 
+
prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
−
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
+
end
−
When date is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span:
  −
<span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
  −
 
  −
DOES NOT yet support MMMM YYYY or any of the date ranges.
      +
--[[
 +
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 nowrap_date (date)
+
local function pmid(id)
−
local cap = '';
+
local test_limit = 30000000; -- update this value as PMIDs approach
−
local cap2 = '';
+
local handler = cfg.id_handlers['PMID'];
−
 
+
local err_cat = ''; -- presume that PMID is valid
−
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
+
−
date = utilities.substitute (cfg.presentation['nowrap1'], date);
+
if id:match("[^%d]") then -- if PMID has anything but digits
−
+
err_cat = ' ' .. set_error( 'bad_pmid' ); -- set an error message
−
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
+
else -- PMID is only digits
−
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
+
local id_num = tonumber(id); -- convert id to a number for range testing
−
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
+
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
 +
err_cat = ' ' .. set_error( 'bad_pmid' ); -- set an error message
 +
end
 
end
 
end
 
 
−
return date;
+
return external_link_id({link = handler.link, label = handler.label,
 +
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
 
end
 
end
    +
--[[--------------------------< I S _ E M B A R G O E D >------------------------------------------------------
   −
--[[--------------------------< S E T _ T I T L E T Y P E >---------------------
+
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date. If embargo date is
−
 
+
in the future, returns the content of |embargo=; otherwise, returns and empty string because the embargo has expired or because
−
This function sets default title types (equivalent to the citation including
+
|embargo= was not set in this cite.
−
|type=<default value>) for those templates that have defaults. Also handles the
  −
special case where it is desirable to omit the title type from the rendered citation
  −
(|type=none).
      
]]
 
]]
   −
local function set_titletype (cite_class, title_type)
+
local function is_embargoed (embargo)
−
if utilities.is_set (title_type) then
+
if is_set (embargo) then
−
if 'none' == cfg.keywords_xlate[title_type] then
+
local lang = mw.getContentLanguage();
−
title_type = ''; -- if |type=none then type parameter not displayed
+
local good1, embargo_date, good2, todays_date;
 +
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
 +
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
 +
 +
if good1 and good2 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 embargoed
 +
else
 +
add_maint_cat ('embargo')
 +
return ''; -- unset because embargo has expired
 +
end
 
end
 
end
−
return title_type; -- if |type= has been set to any other value use that value
   
end
 
end
 +
return ''; -- |embargo= not set return empty string
 +
end
 +
 +
--[[--------------------------< P M C >------------------------------------------------------------------------
   −
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
+
Format a PMC, do simple error checking, and check for embargoed articles.
−
end
      +
The embargo parameter takes a date for a value. If the embargo date is in the future the PMC identifier will not
 +
be linked to the article.  If the embargo date is today or in the past, or if it is empty or omitted, then the
 +
PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.
   −
--[[--------------------------< S A F E _ J O I N >-----------------------------
+
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.
   −
Joins a sequence of strings together while checking for duplicate separation characters.
+
PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
 +
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
    
]]
 
]]
   −
local function safe_join( tbl, duplicate_char )
+
local function pmc(id, embargo)
−
local f = {}; -- create a function table appropriate to type of 'duplicate character'
+
local test_limit = 5000000; -- update this value as PMCs approach
−
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
+
local handler = cfg.id_handlers['PMC'];
−
f.gsub = string.gsub
+
local err_cat = ''; -- presume that PMC is valid
−
f.match = string.match
+
−
f.sub = string.sub
+
local text;
−
else -- for multi-byte characters use the ustring library functions
+
 
−
f.gsub = mw.ustring.gsub
+
if id:match("[^%d]") then -- if PMC has anything but digits
−
f.match = mw.ustring.match
+
err_cat = ' ' .. set_error( 'bad_pmc' ); -- set an error message
−
f.sub = mw.ustring.sub
+
else -- PMC is only digits
 +
local id_num = tonumber(id); -- convert id to a number for range testing
 +
if 1 > id_num or test_limit < id_num then -- if PMC is outside test limit boundaries
 +
err_cat = ' ' .. set_error( 'bad_pmc' ); -- set an error message
 
end
 
end
 +
end
 +
 +
if is_set (embargo) then -- is PMC is still embargoed?
 +
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; -- still embargoed so no external link
 +
else
 +
text = external_link_id({link = handler.link, label = handler.label, -- no embargo date or embargo has expired, ok to link to article
 +
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
 +
end
 +
return text;
 +
end
   −
local str = ''; -- the output string
+
-- Formats a DOI and checks for DOI errors.
−
local comp = ''; -- what does 'comp' mean?
+
 
−
local end_chr = '';
+
-- DOI names contain two parts: prefix and suffix separated by a forward slash.
−
local trim;
+
-- Prefix: directory indicator '10.' followed by a registrant code
−
for _, value in ipairs( tbl ) do
+
-- Suffix: character string of any length chosen by the registrant
−
if value == nil then value = ''; end
+
 
−
+
-- This function checks a DOI name for: prefix/suffix.  If the doi name contains spaces or endashes,
−
if str == '' then -- if output string is empty
+
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.
−
str = value; -- assign value to it (first time through the loop)
  −
elseif value ~= '' then
  −
if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup.
  −
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
  −
else
  −
comp = value;
  −
end
  −
-- typically duplicate_char is sepc
  −
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
  −
--  Because individual string segments often (always?) begin with terminal punct for the
  −
--  preceding segment: 'First element' .. 'sepc next element' .. etc.?
  −
trim = false;
  −
end_chr = f.sub(str, -1, -1); -- get the last character of the output string
  −
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
  −
if end_chr == duplicate_char then -- if same as separator
  −
str = f.sub(str, 1, -2); -- remove it
  −
elseif end_chr == "'" then -- if it might be wiki-markup
  −
if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
  −
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
  −
elseif f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
  −
trim = true; -- why? why do this and next differently from previous?
  −
elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
  −
trim = true; -- same question
  −
end
  −
elseif end_chr == "]" then -- if it might be wiki-markup
  −
if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
  −
trim = true;
  −
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
  −
trim = true;
  −
elseif  f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
  −
trim = true;
  −
elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
  −
trim = true;
  −
end
  −
elseif end_chr == " " then -- if last char of output string is a space
  −
if f.sub(str, -2, -1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
  −
str = f.sub(str, 1, -3); -- remove them both
  −
end
  −
end
     −
if trim then
+
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
−
if value ~= comp then -- value does not equal comp when value contains HTML markup
+
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.
−
local dup2 = duplicate_char;
+
 
−
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
+
local function doi(id, inactive)
−
+
local cat = ""
−
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows HTML markup
+
local handler = cfg.id_handlers['DOI'];
−
else
+
−
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character
+
local text;
−
end
+
if is_set(inactive) then
−
end
+
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
−
end
+
text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
−
str = str .. value; -- add it to the output string
+
if is_set(inactive_year) then
 +
table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
 +
else
 +
table.insert( z.error_categories, "Pages with inactive DOIs" ); -- when inactive doesn't contain a recognizable year
 
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–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
 +
cat = ' ' .. set_error( 'bad_doi' );
 +
end
 +
return text .. inactive .. cat
 +
end
 +
 +
-- Formats an OpenLibrary link, and checks for associated errors.
 +
local function openlibrary(id)
 +
local code = id:match("^%d+([AMW])$"); -- only digits followed by 'A', 'M', or 'W'
 +
local handler = cfg.id_handlers['OL'];
 +
 +
if ( code == "A" ) then
 +
return external_link_id({link=handler.link, label=handler.label,
 +
prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
 +
encode = handler.encode})
 +
elseif ( code == "M" ) then
 +
return external_link_id({link=handler.link, label=handler.label,
 +
prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
 +
encode = handler.encode})
 +
elseif ( code == "W" ) then
 +
return external_link_id({link=handler.link, label=handler.label,
 +
prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
 +
encode = handler.encode})
 +
else
 +
return external_link_id({link=handler.link, label=handler.label,
 +
prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
 +
encode = handler.encode}) ..
 +
' ' .. set_error( 'bad_ol' );
 
end
 
end
−
return str;
   
end
 
end
      −
--[[--------------------------< I S _ S U F F I X >-----------------------------
+
--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------
   −
returns true if suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
+
Validate and format a usenet message id.  Simple error checking, looks for 'id-left@id-right' not enclosed in
−
Puncutation not allowed.
+
'<' and/or '>' angle brackets.
    
]]
 
]]
   −
local function is_suffix (suffix)
+
local function message_id (id)
−
if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
+
local handler = cfg.id_handlers['USENETID'];
−
return true;
+
 
−
end
+
text = external_link_id({link = handler.link, label = handler.label,
−
return false;
+
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
 +
 +
if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then -- doesn't have '@' or has one or first or last character is '< or '>'
 +
text = text .. ' ' .. set_error( 'bad_message_id' ) -- add an error message if the message id is invalid
 +
end  
 +
 +
return text
 
end
 
end
    +
--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
   −
--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------
+
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
 +
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
   −
For Vancouver style, author/editor names are supposed to be rendered in Latin
+
]]
−
(read ASCII) characters.  When a name uses characters that contain diacritical
  −
marks, those characters are to be converted to the corresponding Latin
  −
character. When a name is written using a non-Latin alphabet or logogram, that
  −
name is to be transliterated into Latin characters. The module doesn't do this
  −
so editors may/must.
     −
This test allows |first= and |last= names to contain any of the letters defined
+
local function set_titletype (cite_class, title_type)
−
in the four Unicode Latin character sets
+
if is_set(title_type) then
−
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
+
if "none" == title_type then
−
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
+
title_type = ""; -- if |type=none then type parameter not displayed
−
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F
+
end
−
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
+
return title_type; -- if |type= has been set to any other value use that value
 +
end
   −
|lastn= also allowed to contain hyphens, spaces, and apostrophes.
+
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
−
(http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
+
end
−
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
     −
This original test:
+
--[[--------------------------< C L E A N _ I S B N >----------------------------------------------------------
−
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$")
  −
or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
  −
was written outside of the code editor and pasted here because the code editor
  −
gets confused between character insertion point and cursor position. The test has
  −
been rewritten to use decimal character escape sequence for the individual bytes
  −
of the Unicode characters so that it is not necessary to use an external editor
  −
to maintain this code.
     −
\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
+
Removes irrelevant text and dashes from ISBN number
−
\195\152-\195\182 – Ø-ö (U+00D8-U+00F6 – C0 controls)
+
Similar to that used for Special:BookSources
−
\195\184-\198\191 – ø-ƿ (U+00F8-U+01BF – C0 controls, Latin extended A & B)
  −
\199\132-\201\143 – DŽ-ɏ (U+01C4-U+024F – Latin extended B)
      
]]
 
]]
   −
local function is_good_vanc_name (last, first, suffix, position)
+
local function clean_isbn( isbn_str )
−
if not suffix then
+
return isbn_str:gsub( "[^-0-9X]", "" );
−
if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix
  −
first = first:match ('(.-)[,%s]+'); -- get name/initials
  −
suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix
  −
end
  −
end
  −
if utilities.is_set (suffix) then
  −
if not is_suffix (suffix) then
  −
add_vanc_error (cfg.err_msg_supl.suffix, position);
  −
return false; -- not a name with an appropriate suffix
  −
end
  −
end
  −
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or
  −
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then
  −
add_vanc_error (cfg.err_msg_supl['non-Latin char'], position);
  −
return false; -- not a string of Latin characters; Vancouver requires Romanization
  −
end;
  −
return true;
   
end
 
end
    +
--[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------
   −
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
+
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
   −
Attempts to convert names to initials in support of |name-list-style=vanc. 
+
--[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >--------------------------------
   −
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period.
+
Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata.
−
See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
+
This function strips common patterns of apostrophe markup. We presume that editors who have taken the time to
 +
markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.
   −
Vancouver style requires family rank designations (Jr, II, III, etc.) to be rendered
+
]]
−
as Jr, 2nd, 3rd, etc.  See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
  −
This code only accepts and understands generational suffix in the Vancouver format
  −
because Roman numerals look like, and can be mistaken for, initials.
     −
This function uses ustring functions because firstname initials may be any of the
+
local function strip_apostrophe_markup (argument)
−
Unicode Latin characters accepted by is_good_vanc_name ().
+
if not is_set (argument) then return argument; end
   −
]]
+
while true do
 +
if argument:match ("%'%'%'%'%'") then -- bold italic (5)
 +
argument=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it
 +
elseif argument:match ("%'%'%'%'") then -- italic start and end without content (4)
 +
argument=argument:gsub("%'%'%'%'", "");
 +
elseif argument:match ("%'%'%'") then -- bold (3)
 +
argument=argument:gsub("%'%'%'", "");
 +
elseif argument:match ("%'%'") then -- italic (2)
 +
argument=argument:gsub("%'%'", "");
 +
else
 +
break;
 +
end
 +
end
 +
return argument; -- done
 +
end
   −
local function reduce_to_initials(first, position)
+
--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------
−
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
     −
if not name then -- if not initials and a suffix
+
Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)
−
name = mw.ustring.match(first, "^(%u+)$"); -- is it just initials?
  −
end
     −
if name then -- if first is initials with or without suffix
+
Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings
−
if 3 > mw.ustring.len (name) then -- if one or two initials
+
of %27%27...
−
if suffix then -- if there is a suffix
+
]]
−
if is_suffix (suffix) then -- is it legitimate?
+
 
−
return first; -- one or two initials and a valid suffix so nothing to do
+
local function make_coins_title (title, script)
−
else
+
if is_set (title) then
−
add_vanc_error (cfg.err_msg_supl.suffix, position); -- one or two initials with invalid suffix so error message
+
title = strip_apostrophe_markup (title); -- strip any apostrophe markup
−
return first; -- and return first unmolested
+
else
−
end
+
title=''; -- if not set, make sure title is an empty string
−
else
+
end
−
return first; -- one or two initials without suffix; nothing to do
+
if is_set (script) then
−
end
+
script = script:gsub ('^%l%l%s*:%s*', ''); -- remove language prefix if present (script value may now be empty string)
−
end
+
script = strip_apostrophe_markup (script); -- strip any apostrophe markup
−
end -- if here then name has 3 or more uppercase letters so treat them as a word
+
else
 +
script=''; -- if not set, make sure script is an empty string
 +
end
 +
if is_set (title) and is_set (script) then
 +
script = ' ' .. script; -- add a space before we concatenate
 +
end
 +
return title .. script; -- return the concatenation
 +
end
 +
 
 +
--[[--------------------------< G E T _ C O I N S _ P A G E S >------------------------------------------------
   −
local initials, names = {}, {}; -- tables to hold name parts and initials
+
Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
−
local i = 1; -- counter for number of initials
     −
names = mw.text.split (first, '[%s,]+'); -- split into a table of names and possible suffix
+
]]
   −
while names[i] do -- loop through the table
+
local function get_coins_pages (pages)
−
if 1 < i and names[i]:match ('[%dJS][%drndth]+%.?$') then -- if not the first name, and looks like a suffix (may have trailing dot)
+
local pattern;
−
names[i] = names[i]:gsub ('%.', ''); -- remove terminal dot if present
+
if not is_set (pages) then return pages; end -- if no page numbers then we're done
−
if is_suffix (names[i]) then -- if a legitimate suffix
+
−
table.insert (initials, ' ' .. names[i]); -- add a separator space, insert at end of initials table
+
while true do
−
break; -- and done because suffix must fall at the end of a name
+
pattern = pages:match("%[(%w*:?//[^ ]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
−
end -- no error message if not a suffix; possibly because of Romanization
+
if nil == pattern then break; end -- no more urls
−
end
+
pattern = escape_lua_magic_chars (pattern); -- pattern is not a literal string; escape lua's magic pattern characters
−
if 3 > i then
+
pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
−
table.insert (initials, mw.ustring.sub(names[i], 1, 1)); -- insert the initial at end of initials table
  −
end
  −
i = i + 1; -- bump the counter
   
end
 
end
−
+
pages = pages:gsub("[%[%]]", ""); -- remove the brackets
−
return table.concat(initials) -- Vancouver format does not include spaces.
+
pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
 +
pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc.) with hyphens; do we need to replace numerical entities like &#32; and the like?
 +
return pages;
 
end
 
end
    +
-- 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
   −
--[[--------------------------< I N T E R W I K I _ P R E F I X E N _ G E T >----------------------------------
+
-- Converts a hyphen to a dash
 +
local function hyphen_to_dash( str )
 +
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
 +
return str;
 +
end
 +
return str:gsub( '-', '–' );
 +
end
   −
extract interwiki prefixen from <value>.  Returns two one or two values:
+
--[[--------------------------< S A F E _ J O I N >------------------------------------------------------------
−
false – no prefixen
  −
nil – prefix exists but not recognized
  −
project prefix, language prefix – when value has either of:
  −
:<project>:<language>:<article>
  −
:<language>:<project>:<article>
  −
project prefix, nil – when <value> has only a known single-letter prefix
  −
nil, language prefix – when <value> has only a known language prefix
     −
accepts single-letter project prefixen: 'd' (wikidata), 's' (wikisource), and 'w' (wikipedia) prefixes; at this
+
Joins a sequence of strings together while checking for duplicate separation characters.
−
writing, the other single-letter prefixen (b (wikibook), c (commons), m (meta), n (wikinews), q (wikiquote), and
  −
v (wikiversity)) are not supported.
      
]]
 
]]
   −
local function interwiki_prefixen_get (value, is_link)
+
local function safe_join( tbl, duplicate_char )
−
if not value:find (':%l+:') then -- if no prefix
+
--[[
−
return false; -- abandon; boolean here to distinguish from nil fail returns later
+
Note: we use string functions here, rather than ustring functions.
−
end
  −
 
  −
local prefix_patterns_linked_t = { -- sequence of valid interwiki and inter project prefixen
  −
'^%[%[:([dsw]):(%l%l+):', -- wikilinked; project and language prefixes
  −
'^%[%[:(%l%l+):([dsw]):', -- wikilinked; language and project prefixes
  −
'^%[%[:([dsw]):', -- wikilinked; project prefix
  −
'^%[%[:(%l%l+):', -- wikilinked; language prefix
  −
}
  −
  −
local prefix_patterns_unlinked_t = { -- sequence of valid interwiki and inter project prefixen
  −
'^:([dsw]):(%l%l+):', -- project and language prefixes
  −
'^:(%l%l+):([dsw]):', -- language and project prefixes
  −
'^:([dsw]):', -- project prefix
  −
'^:(%l%l+):', -- language prefix
  −
}
   
 
−
local cap1, cap2;
+
This has considerably faster performance and should work correctly as
−
for _, pattern in ipairs ((is_link and prefix_patterns_linked_t) or prefix_patterns_unlinked_t) do
+
long as the duplicate_char is strict ASCII.  The strings
−
cap1, cap2 = value:match (pattern);
+
in tbl may be ASCII or UTF8.
−
if cap1 then
+
]]
−
break; -- found a match so stop looking
  −
end
  −
end
   
 
−
if cap1 and cap2 then -- when both then :project:language: or :language:project: (both forms allowed)
+
local str = ''; -- the output string
−
if 1 == #cap1 then -- length == 1 then :project:language:
+
local comp = ''; -- what does 'comp' mean?
−
if cfg.inter_wiki_map[cap2] then -- is language prefix in the interwiki map?
+
local end_chr = '';
−
return cap1, cap2; -- return interwiki project and interwiki language
+
local trim;
 +
for _, value in ipairs( tbl ) do
 +
if value == nil then value = ''; end
 +
 +
if str == '' then -- if output string is empty
 +
str = value; -- assign value to it (first time through the loop)
 +
elseif value ~= '' then
 +
if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup.
 +
comp = value:gsub( "%b<>", "" ); -- remove html markup (<span>string</span> -> string)
 +
else
 +
comp = value;
 
end
 
end
−
else -- here when :language:project:
+
-- typically duplicate_char is sepc
−
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
+
if comp:sub(1,1) == duplicate_char then -- is first charactier same as duplicate_char? why test first character?
−
return cap2, cap1; -- return interwiki project and interwiki language
+
--  Because individual string segments often (always?) begin with terminal punct for th
−
end
+
--  preceding segment: 'First element' .. 'sepc next element' .. etc?
−
end
+
trim = false;
−
return nil; -- unknown interwiki language
+
end_chr = str:sub(-1,-1); -- get the last character of the output string
−
elseif not (cap1 or cap2) then -- both are nil?
+
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff?
−
return nil; -- we got something that looks like a project prefix but isn't; return fail
+
if end_chr == duplicate_char then -- if same as separator
−
elseif 1 == #cap1 then -- here when one capture
+
str = str:sub(1,-2); -- remove it
−
return cap1, nil; -- length is 1 so return project, nil language
+
elseif end_chr == "'" then -- if it might be wikimarkup
−
else -- here when one capture and its length it more than 1
+
if str:sub(-3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
−
if cfg.inter_wiki_map[cap1] then -- is language prefix in the interwiki map?
+
str = str:sub(1, -4) .. "''"; -- remove them and add back ''
−
return nil, cap1; -- return nil project, language
+
elseif str:sub(-5,-1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
−
end
+
trim = true; -- why? why do this and next differently from previous?
−
end
+
elseif str:sub(-4,-1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
−
end
+
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
 +
end
 +
 
 +
if trim then
 +
if value ~= comp then -- value 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 it
 +
 +
value = value:gsub( "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup
 +
else
 +
value = value:sub( 2, -1 ); -- remove duplicate_char when it is first character
 +
end
 +
end
 +
end
 +
str = str .. value; --add it to the output string
 +
end
 +
end
 +
return str;
 +
end
   −
--[[--------------------------< L I S T _ P E O P L E >--------------------------
+
--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------
   −
Formats a list of people (authors, contributors, editors, interviewers, translators)
+
For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters.  When a name
 +
uses characters that contain diacritical marks, those characters are to 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.
 +
 
 +
This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets
 +
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
 +
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
 +
[http://www.unicode.org/charts/PDF/U0100.pdf Latin Extended-A] 0100–017F
 +
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
   −
names in the list will be linked when
+
|lastn= also allowed to contain hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
−
|<name>-link= has a value
+
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
−
|<name>-mask- does NOT have a value; masked names are presumed to have been
  −
rendered previously so should have been linked there
     −
when |<name>-mask=0, the associated name is not rendered
+
At the time of this writing, I had to write the 'if nil == mw.ustring.find ...' test ouside of the code editor and past it here
 +
because the code editor gets confused between character insertion point and cursor position.
    
]]
 
]]
   −
local function list_people (control, people, etal)
+
local function is_good_vanc_name (last, first)
−
local sep;
+
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]*$") then
−
local namesep;
+
if true ~= Page_in_vanc_error_cat then -- if we haven't been here before then set a sticky flag
−
local format = control.format;
+
Page_in_vanc_error_cat=true; -- so that if there are more than one error the category is added only once
−
local maximum = control.maximum;
+
table.insert( z.message_tail, { set_error( 'vancouver', {}, true ) } );
−
local name_list = {};
+
end
−
 
+
return false; -- not a string of latin characters; Vancouver required Romanization
−
if 'vanc' == format then -- Vancouver-like name styling?
+
end;
−
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between names is a comma
+
return true;
−
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
+
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. 
 +
 
 +
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
 +
 
 +
Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc.  This form is not
 +
currently 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_initials(first)
 +
if mw.ustring.match(first, "^%u%u$") 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.gmatch(first, "[^%s%.%-]+") do -- names separated by spaces, hyphens, or periods
 +
table.insert(initials, mw.ustring.sub(word,1,1)) -- Vancouver format does not include full stops.
 +
i = i + 1; -- bump the counter
 +
if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit
 +
end
 +
return table.concat(initials) -- Vancouver format does not include spaces.
 +
end
 +
 
 +
--[[--------------------------< L I S T  _ P E O P L E >-------------------------------------------------------
 +
 
 +
Formats a list of people (e.g. authors / editors)
 +
 
 +
]]
 +
 
 +
local function list_people(control, people, etal)
 +
local sep;
 +
local namesep;
 +
local format = control.format
 +
local maximum = control.maximum
 +
local lastauthoramp = control.lastauthoramp;
 +
local text = {}
 +
 
 +
if 'vanc' == format then -- Vancouver-like author/editor name styling?
 +
sep = ','; -- name-list separator between authors is a comma
 +
namesep = ' '; -- last/first separator is a space
 
else
 
else
−
sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon
+
sep = ';' -- name-list separator between authors is a semicolon
−
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
+
namesep = ', ' -- last/first separator is <comma><space>
 
end
 
end
 
 
−
if sep:sub (-1, -1) ~= " " then sep = sep .. " " end
+
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
−
if utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names
+
if is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for authors
 
 
−
for i, person in ipairs (people) do
+
for i,person in ipairs(people) do
−
if utilities.is_set (person.last) then
+
if is_set(person.last) then
−
local mask = person.mask;
+
local mask = person.mask
−
local one;
+
local one
 
local sep_one = sep;
 
local sep_one = sep;
−
 
+
if is_set (maximum) and i > maximum then
−
if utilities.is_set (maximum) and i > maximum then
   
etal = true;
 
etal = true;
 
break;
 
break;
−
end
+
elseif (mask ~= nil) then
−
+
local n = tonumber(mask)
−
if mask then
+
if (n ~= nil) then
−
local n = tonumber (mask); -- convert to a number if it can be converted; nil else
+
one = string.rep("&mdash;",n)
−
if n then
  −
one = 0 ~= n and string.rep("&mdash;", n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name
  −
person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil
   
else
 
else
−
one = mask; -- replace name with mask text (must include name-list separator)
+
one = mask;
−
sep_one = " "; -- modify name-list separator
+
sep_one = " ";
 
end
 
end
 
else
 
else
−
one = person.last; -- get surname
+
one = person.last
−
local first = person.first -- get given name
+
local first = person.first
−
if utilities.is_set (first) then
+
if is_set(first) then  
−
if ("vanc" == format) then -- if Vancouver format
+
if ( "vanc" == format ) then -- if vancouver format
 
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
 
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
−
if not person.corporate and is_good_vanc_name (one, first, nil, i) then -- and name is all Latin characters; corporate authors not tested
+
if is_good_vanc_name (one, first) then -- and name is all Latin characters
−
first = reduce_to_initials (first, i); -- attempt to convert first name(s) to initials
+
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials
 
end
 
end
 
end
 
end
−
one = one .. namesep .. first;
+
one = one .. namesep .. first  
 
end
 
end
 +
if is_set(person.link) and person.link ~= control.page_name then
 +
one = "[[" .. person.link .. "|" .. one .. "]]" -- link author/editor if this page is not the author's/editor's page
 +
end
 +
 +
if is_set(person.link) and ((nil ~= person.link:find("//")) or (nil ~= person.link:find("[%[%]]"))) then
 +
one = one .. " " .. set_error( 'bad_authorlink' ) end -- url or wikilink in author link;
 
end
 
end
−
if utilities.is_set (person.link) then
+
table.insert( text, one )
−
one = utilities.make_wikilink (person.link, one); -- link author/editor
+
table.insert( text, sep_one )
−
end
  −
 
  −
if one then -- if <one> has a value (name, mdash replacement, or mask text replacement)
  −
local proj, tag = interwiki_prefixen_get (one, true); -- get the interwiki prefixen if present
  −
 
  −
if 'w' == proj and ('Wikipedia' == mw.site.namespaces.Project['name']) then
  −
proj = nil; -- for stuff like :w:de:<article>, :w is unnecessary TODO: maint cat?
  −
end
  −
if proj then
  −
proj = ({['d'] = 'Wikidata', ['s'] = 'Wikisource', ['w'] = 'Wikipedia'})[proj]; -- :w (wikipedia) for linking from a non-wikipedia project
  −
if proj then
  −
one = one .. utilities.wrap_style ('interproj', proj); -- add resized leading space, brackets, static text, language name
  −
tag = nil; -- unset; don't do both project and language
  −
end
  −
end
  −
if tag == cfg.this_wiki_code then
  −
tag = nil; -- stuff like :en:<article> at en.wiki is pointless TODO: maint cat?
  −
end
  −
if tag then
  −
local lang = cfg.lang_tag_remap[tag] or cfg.mw_languages_by_tag_t[tag];
  −
if lang then -- error messaging done in extract_names() where we know parameter names
  −
one = one .. utilities.wrap_style ('interwiki', lang); -- add resized leading space, brackets, static text, language name
  −
end
  −
end
  −
 
  −
table.insert (name_list, one); -- add it to the list of names
  −
table.insert (name_list, sep_one); -- add the proper name-list separator
  −
end
   
end
 
end
 
end
 
end
   −
local count = #name_list / 2; -- (number of names + number of separators) divided by 2
+
local count = #text / 2;
−
if 0 < count then  
+
if count > 0 then  
−
if 1 < count and not etal then
+
if count > 1 and is_set(lastauthoramp) and not etal then
−
if 'amp' == format then
+
text[#text-2] = " & ";
−
name_list[#name_list-2] = " & "; -- replace last separator with ampersand text
  −
elseif 'and' == format then
  −
if 2 == count then
  −
name_list[#name_list-2] = cfg.presentation.sep_nl_and; -- replace last separator with 'and' text
  −
else
  −
name_list[#name_list-2] = cfg.presentation.sep_nl_end; -- replace last separator with '(sep) and' text
  −
end
  −
end
   
end
 
end
−
name_list[#name_list] = nil; -- erase the last separator
+
text[#text] = nil;  
 
end
 
end
−
 
+
−
local result = table.concat (name_list); -- construct list
+
local result = table.concat(text) -- construct list
−
if etal and utilities.is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
+
if etal then  
−
result = result .. sep .. cfg.messages['et al']; -- we've got a last-first list and etal so add et al.
+
local etal_text = cfg.messages['et al'];
 +
result = result .. " " .. etal_text;
 
end
 
end
 
 
−
return result, count; -- return name-list string and count of number of names (count used for editor names only)
+
return result, count
 
end
 
end
    +
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
   −
--[[--------------------< M A K E _ C I T E R E F _ I D >-----------------------
+
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
−
 
  −
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise
  −
returns an empty string.
  −
 
  −
namelist is one of the contributor-, author-, or editor-name lists chosen in that
  −
order.  year is Year or anchor_year.
      
]]
 
]]
   −
local function make_citeref_id (namelist, year)
+
local function anchor_id( options )
−
local names={}; -- a table for the one to four names and year
+
local id = table.concat( options ); -- concatenate names and year for CITEREF id
−
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
+
if is_set (id) then -- if concatenation is not an empty string
−
names[i] = v.last
+
return "CITEREF" .. id; -- add the CITEREF portion
−
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 utilities.is_set (id) then -- if concatenation is not an empty string
  −
return "CITEREF" .. id; -- add the CITEREF portion
   
else
 
else
−
return ''; -- return an empty string; no reason to include CITEREF id in this citation
+
return ''; -- return an empty string; no reason to include CITEREF id in this citation
 
end
 
end
 
end
 
end
    +
--[[--------------------------< E X T R A C T _ N A M E S >----------------------------------------------------
 +
Gets name list from the input arguments
   −
--[[--------------------------< C I T E _ C L A S S _A T T R I B U T E _M A K E >------------------------------
+
Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
 +
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
 +
find |last4= and |last5= then the search is done.
   −
construct <cite> tag class attribute for this citation.
+
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=.
   −
<cite_class> – config.CitationClass from calling template
+
When an author or editor parameter contains some form of 'et al.', the 'et al.' is stripped from the parameter and a flag (etal) returned
−
<mode> – value from |mode= parameter
+
that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps 'et al.' out of the
 +
template's metadata.  When this occurs, the page is added to a maintenance category.
    
]]
 
]]
   −
local function cite_class_attribute_make (cite_class, mode)
+
local function extract_names(args, list_name)
−
local class_t = {};
+
local names = {}; -- table of names
−
table.insert (class_t, 'citation'); -- required for blue highlight
+
local last; -- individual name components
−
if 'citation' ~= cite_class then
+
local first;
−
table.insert (class_t, cite_class); -- identify this template for user css
+
local link;
−
table.insert (class_t, utilities.is_set (mode) and mode or 'cs1'); -- identify the citation style for user css or javascript
+
local mask;
−
else
+
local i = 1; -- loop counter/indexer
−
table.insert (class_t, utilities.is_set (mode) and mode or 'cs2'); -- identify the citation style for user css or javascript
+
local n = 1; -- output table indexer
−
end
+
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)
−
for _, prop_key in ipairs (z.prop_keys_t) do
+
local etal=false; -- return value set to true when we find some form of et al. in an author parameter
−
table.insert (class_t, prop_key); -- identify various properties for user css or javascript
+
local pattern = ",? *'*[Ee][Tt] *[Aa][Ll][%.']*$" -- variations on the 'et al' theme
−
end
+
 +
local err_msg_list_name = list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary
   −
return table.concat (class_t, ' '); -- make a big string and done
+
while true do
 +
last = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1
 +
first = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
 +
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
 +
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
 +
 
 +
local name = tostring(last);
 +
if name:match (pattern) then -- varients on et al.
 +
last = name:gsub (pattern, ''); -- if found, remove
 +
etal = true;
 +
end
 +
name = tostring(first);
 +
if name:match (pattern) then -- varients on et al.
 +
first = name:gsub (pattern, ''); -- if found, remove
 +
etal = true;
 +
end
 +
 
 +
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
 +
names[n] = {last = last, first = first, link = link, mask = mask}; -- add this name to our names list
 +
n = n + 1; -- point to next location in the names table
 +
if 1 == count then -- if the previous name was missing
 +
table.insert( z.message_tail, { set_error( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message
 +
end
 +
count = 0; -- reset the counter, we're looking for two consecutive missing names
 +
end
 +
i = i + 1; -- point to next args location
 +
end
 +
 +
if true == etal then
 +
add_maint_cat ('etal');
 +
end
 +
return names, etal; -- all done, return our list of names
 
end
 
end
    +
-- Populates ID table from arguments using configuration settings
 +
local function extract_ids( args )
 +
local id_list = {};
 +
for k, v in pairs( cfg.id_handlers ) do
 +
v = select_one( args, v.parameters, 'redundant_parameters' );
 +
if is_set(v) then id_list[k] = v; end
 +
end
 +
return id_list;
 +
end
   −
--[[---------------------< N A M E _ H A S _ E T A L >--------------------------
+
--[[--------------------------< B U I L D _ I D _ L I S T >--------------------------------------------------------
−
 
  −
Evaluates the content of name parameters (author, editor, etc.) for variations on
  −
the theme of et al.  If found, the et al. is removed, a flag is set to true and
  −
the function returns the modified name and the flag.
     −
This function never sets the flag to false but returns its previous state because
+
Takes a table of IDs and turns it into a table of formatted ID outputs.
−
it may have been set by previous passes through this function or by the associated
  −
|display-<names>=etal parameter
      
]]
 
]]
   −
local function name_has_etal (name, etal, nocat, param)
+
local function build_id_list( id_list, options )
 +
local new_list, handler = {};
   −
if utilities.is_set (name) then -- name can be nil in which case just return
+
function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
−
local patterns = cfg.et_al_patterns; -- get patterns from configuration
+
 +
for k, v in pairs( id_list ) do
 +
-- fallback to read-only cfg
 +
handler = setmetatable( { ['id'] = v }, fallback(k) );
 
 
−
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
+
if handler.mode == 'external' then
−
if name:match (pattern) then -- if this 'et al' pattern is found in name
+
table.insert( new_list, {handler.label, external_link_id( handler ) } );
−
name = name:gsub (pattern, ''); -- remove the offending text
+
elseif handler.mode == 'internal' then
−
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
+
table.insert( new_list, {handler.label, internal_link_id( handler ) } );
−
if not nocat then -- no categorization for |vauthors=
+
elseif handler.mode ~= 'manual' then
−
utilities.set_message ('err_etal', {param}); -- and set an error if not added
+
error( cfg.messages['unknown_ID_mode'] );
−
end
+
elseif k == 'DOI' then
 +
table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
 +
elseif k == 'ARXIV' then
 +
table.insert( new_list, {handler.label, arxiv( v, options.Class ) } );  
 +
elseif k == 'ASIN' then
 +
table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
 +
elseif k == 'LCCN' then
 +
table.insert( new_list, {handler.label, lccn( v ) } );
 +
elseif k == 'OL' then
 +
table.insert( new_list, {handler.label, openlibrary( v ) } );
 +
elseif k == 'PMC' then
 +
table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
 +
elseif k == 'PMID' then
 +
table.insert( new_list, {handler.label, pmid( v ) } );
 +
elseif k == 'ISSN' then
 +
table.insert( new_list, {handler.label, issn( v ) } );
 +
elseif k == 'ISBN' then
 +
local ISBN = internal_link_id( handler );
 +
if not check_isbn( v ) and not is_set(options.IgnoreISBN) then
 +
ISBN = ISBN .. set_error( 'bad_isbn', {}, false, " ", "" );
 
end
 
end
 +
table.insert( new_list, {handler.label, ISBN } );
 +
elseif k == 'USENETID' then
 +
table.insert( new_list, {handler.label, message_id( v ) } );
 +
else
 +
error( cfg.messages['unknown_manual_ID'] );
 
end
 
end
 
end
 
end
−
 
+
−
return name, etal;
+
function comp( a, b ) -- used in following table.sort()
−
end
+
return a[1] < b[1];
−
 
+
end
−
 
+
−
--[[---------------------< N A M E _ I S _ N U M E R I C >----------------------
+
table.sort( new_list, comp );
−
 
+
for k, v in ipairs( new_list ) do
−
Add maint cat when name parameter value does not contain letters.  Does not catch
+
new_list[k] = v[2];
−
mixed alphanumeric names so |last=A. Green (1922-1987) does not get caught in the
  −
current version of this test but |first=(1888) is caught.
  −
 
  −
returns nothing
  −
 
  −
]]
  −
 
  −
local function name_is_numeric (name, list_name)
  −
if utilities.is_set (name) then
  −
if mw.ustring.match (name, '^[%A]+$') then -- when name does not contain any letters
  −
utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
  −
end
   
end
 
end
 +
 +
return new_list;
 
end
 
end
 +
 
   −
 
+
-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
−
--[[-----------------< N A M E _ H A S _ M U L T _ N A M E S >------------------
+
-- the citation information.
−
 
+
local function COinS(data, class)
−
Evaluates the content of last/surname (authors etc.) parameters for multiple names.
+
if 'table' ~= type(data) or nil == next(data) then
−
Multiple names are indicated if there is more than one comma or any "unescaped"
+
return '';
−
semicolons. Escaped semicolons are ones used as part of selected HTML entities.
  −
If the condition is met, the function adds the multiple name maintenance category.
  −
 
  −
Same test for first except that commas should not appear in given names (MOS:JR says
  −
that the generational suffix does not take a separator character).  Titles, degrees,
  −
postnominals, affiliations, all normally comma separated don't belong in a citation.
  −
 
  −
<name> – name parameter value
  −
<list_name> – AuthorList, EditorList, etc
  −
<limit> – number of allowed commas; 1 (default) for surnames; 0 for given names
  −
 
  −
returns nothing
  −
 
  −
]]
  −
 
  −
local function name_has_mult_names (name, list_name, limit)
  −
local _, commas, semicolons, nbsps;
  −
limit = limit and limit or 1;
  −
if utilities.is_set (name) then
  −
_, commas = name:gsub (',', ''); -- count the number of commas
  −
_, semicolons = name:gsub (';', ''); -- count the number of semicolons
  −
-- nbsps probably should be its own separate count rather than merged in
  −
-- some way with semicolons because Lua patterns do not support the
  −
-- grouping operator that regex does, which means there is no way to add
  −
-- more entities to escape except by adding more counts with the new
  −
-- entities
  −
_, nbsps = name:gsub ('&nbsp;',''); -- count nbsps
  −
  −
-- There is exactly 1 semicolon per &nbsp; entity, so subtract nbsps
  −
-- from semicolons to 'escape' them. If additional entities are added,
  −
-- they also can be subtracted.
  −
if limit < commas or 0 < (semicolons - nbsps) then
  −
utilities.set_message ('maint_mult_names', cfg.special_case_translation [list_name]); -- add a maint message
  −
end
   
end
 
end
−
end
+
−
 
+
local ctx_ver = "Z39.88-2004";
−
 
+
−
--[=[-------------------------< I S _ G E N E R I C >----------------------------------------------------------
+
-- 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 is_set(data.Chapter) then
 +
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
 +
OCinSoutput["rft.genre"] = "bookitem";
 +
OCinSoutput["rft.atitle"] = data.Chapter;
 +
OCinSoutput["rft.btitle"] = data.Title;
 +
elseif is_set(data.Periodical) then
 +
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
 +
if 'arxiv' == class then
 +
OCinSoutput["rft.genre"] = "preprint"; -- cite arxiv
 +
else
 +
OCinSoutput["rft.genre"] = "article";
 +
end
 +
OCinSoutput["rft.jtitle"] = data.Periodical;
 +
OCinSoutput["rft.atitle"] = data.Title;
 +
else
 +
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
 +
OCinSoutput["rft.genre"] = "book"
 +
OCinSoutput["rft.btitle"] = data.Title;
 +
end
 +
 +
OCinSoutput["rft.place"] = data.PublicationPlace;
 +
OCinSoutput["rft.date"] = data.Date;
 +
OCinSoutput["rft.series"] = data.Series;
 +
OCinSoutput["rft.volume"] = data.Volume;
 +
OCinSoutput["rft.issue"] = data.Issue;
 +
OCinSoutput["rft.pages"] = data.Pages;
 +
OCinSoutput["rft.edition"] = data.Edition;
 +
OCinSoutput["rft.pub"] = data.PublisherName;
 +
 +
for k, v in pairs( data.ID_list ) do
 +
local id, value = cfg.id_handlers[k].COinS;
 +
if k == 'ISBN' then value = clean_isbn( v ); else value = v; end
 +
if string.sub( id or "", 1, 4 ) == 'info' then
 +
OCinSoutput["rft_id"] = table.concat{ id, "/", v };
 +
else
 +
OCinSoutput[ id ] = value;
 +
end
 +
end
 +
 +
local last, first;
 +
for k, v in ipairs( data.Authors ) do
 +
last, first = v.last, v.first;
 +
if k == 1 then
 +
if is_set(last) then
 +
OCinSoutput["rft.aulast"] = last;
 +
end
 +
if is_set(first) then
 +
OCinSoutput["rft.aufirst"] = first;
 +
end
 +
end
 +
if is_set(last) and is_set(first) then
 +
OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
 +
elseif is_set(last) then
 +
OCinSoutput["rft.au"] = last;
 +
end
 +
end
 +
 +
OCinSoutput.rft_id = data.URL;
 +
OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
 +
OCinSoutput = setmetatable( OCinSoutput, nil );
 +
 +
-- sort with version string always first, and combine.
 +
table.sort( OCinSoutput );
 +
table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
 +
return table.concat(OCinSoutput, "&");
 +
end
 +
 
   −
Compares values assigned to various parameters according to the string provided as <item> in the function call.
+
--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
−
<item> can have on of two values:
  −
'generic_names' – for name-holding parameters: |last=, |first=, |editor-last=, etc
  −
'generic_titles' – for |title=
     −
There are two types of generic tests.  The 'accept' tests look for a pattern that should not be rejected by the
+
Validates language names provided in |language= parameter if not an ISO639-1 code.  Handles the special case that is Norwegian where
−
'reject' test.  For example,
+
ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.
−
|author=[[John Smith (author)|Smith, John]]
  −
would be rejected by the 'author' reject test.  But piped wikilinks with 'author' disambiguation should not be
  −
rejected so the 'accept' test prevents that from happening.  Accept tests are always performed before reject
  −
tests.
     −
Each of the 'accept' and 'reject' sequence tables hold tables for en.wiki (['en']) and local.wiki (['local'])
+
Returns the language name and associated ISO639-1 code. Because case of the source may be incorrect or different from the case that Wikimedia
−
that each can hold a test sequence table  The sequence table holds, at index [1], a test pattern, and, at index
+
uses, the name comparisons are done in lower case and when a match is found, the Wikimedia version (assumed to be correct) is returned along
−
[2], a boolean control value.  The control value tells string.find() or mw.ustring.find() to do plain-text search (true)
+
with the code.  When there is no match, we return the original language name string.
−
or a pattern search (false).  The intent of all this complexity is to make these searches as fast as possible so
  −
that we don't run out of processing time on very large articles.
     −
Returns
+
mw.language.fetchLanguageNames() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included
−
true when a reject test finds the pattern or string
+
in the list will be found if that name is provided in the |language= parameter.  For example, if |language=Samaritan Aramaic, that name will be
−
false when an accept test finds the pattern or string
+
found with the associated code 'sam', not an ISO639-1 code.  When names are found and the associated code is not two characters, this function
−
nil else
+
returns only the Wikimedia language name.
   −
]=]
+
Adapted from code taken from Module:Check ISO 639-1.
   −
local function is_generic (item, value, wiki)
+
]]
−
local test_val;
  −
local str_lower = { -- use string.lower() for en.wiki (['en']) and use mw.ustring.lower() or local.wiki (['local'])
  −
['en'] = string.lower,
  −
['local'] = mw.ustring.lower,
  −
}
  −
local str_find = { -- use string.find() for en.wiki (['en']) and use mw.ustring.find() or local.wiki (['local'])
  −
['en'] = string.find,
  −
['local'] = mw.ustring.find,
  −
}
     −
local function test (val, test_t, wiki) -- local function to do the testing; <wiki> selects lower() and find() functions
+
local function get_iso639_code (lang)
−
val = test_t[2] and str_lower[wiki](value) or val; -- when <test_t[2]> set to 'true', plaintext search using lowercase value
+
if 'norwegian' == lang:lower() then -- special case related to Wikimedia remap of code 'no' at Extension:CLDR
−
return str_find[wiki] (val, test_t[1], 1, test_t[2]); -- return nil when not found or matched
+
return 'Norwegian', 'no'; -- Make sure rendered version is properly capitalized
 
end
 
end
−
+
−
local test_types_t = {'accept', 'reject'}; -- test accept patterns first, then reject patterns
+
local languages = mw.language.fetchLanguageNames('en', 'all') -- get a list of language names known to Wikimedia
−
local wikis_t = {'en', 'local'}; -- do tests for each of these keys; en.wiki first, local.wiki second
+
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
−
 
+
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
−
for _, test_type in ipairs (test_types_t) do -- for each test type
+
−
for _, generic_value in pairs (cfg.special_case_translation[item][test_type]) do -- spin through the list of generic value fragments to accept or reject
+
for code, name in pairs(languages) do -- scan the list to see if we can find our language
−
for _, wiki in ipairs (wikis_t) do
+
if langlc == mw.ustring.lower(name) then
−
if generic_value[wiki] then
+
if 2 ~= code:len() then -- ISO639-1 codes only
−
if test (value, generic_value[wiki], wiki) then -- go do the test
+
return name; -- so return the name but not the code
−
return ('reject' == test_type); -- param value rejected, return true; false else
  −
end
  −
end
   
end
 
end
 +
return name, code; -- found it, return name to ensure proper capitalization and the ISO639-1 code
 
end
 
end
 
end
 
end
 +
return lang; -- not valid language; return language in original case and nil for ISO639-1 code
 
end
 
end
    +
--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
   −
--[[--------------------------< N A M E _ I S _ G E N E R I C >------------------------------------------------
+
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.
   −
calls is_generic() to determine if <name> is a 'generic name' listed in cfg.generic_names; <name_alias> is the
+
There is an exception.  There are three ISO639-1 codes for Norewegian language variants.  There are two official variants: Norwegian Bokmål (code 'nb') and
−
parameter name used in error messaging
+
Norwegian Nynorsk (code 'nn').  The third, code 'no',  is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless. However, it appears
 +
that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-English-language external links.
   −
]]
+
Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and
−
 
+
return 'Norwegian' when editors use |language=no. We presume that editors don't know about the variants or can't descriminate between them.
−
local function name_is_generic (name, name_alias)
  −
if not added_generic_name_errs  and is_generic ('generic_names', name) then
  −
utilities.set_message ('err_generic_name', name_alias); -- set an error message
  −
added_generic_name_errs = true;
  −
end
  −
end
      +
See Help talk:Citation Style_1#An ISO 639-1 language name test
   −
--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------
+
When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if
 +
the 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 calls various name checking functions used to validate the content of the various name-holding parameters.
+
This function supports multiple languages in the form |language=nb, French, th where the language names or codes are separated from each other by commas.
    
]]
 
]]
   −
local function name_checks (last, first, list_name, last_alias, first_alias)
+
local function language_parameter (lang, namespace)
−
local accept_name;
+
local code; -- the ISO639-1 two character code
−
 
+
local name; -- the language name
−
if utilities.is_set (last) then
+
local language_list = {}; -- table of language names to be rendered
−
last, accept_name = utilities.has_accept_as_written (last); -- remove accept-this-as-written markup when it wraps all of <last>
+
local names_table = {}; -- table made from the value assigned to |language=
−
 
+
local unrec_cat = false -- flag so that we only add unrecognized category once
−
if not accept_name then -- <last> not wrapped in accept-as-written markup
+
−
name_has_mult_names (last, list_name); -- check for multiple names in the parameter
+
names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
−
name_is_numeric (last, list_name); -- check for names that are composed of digits and punctuation
+
−
name_is_generic (last, last_alias); -- check for names found in the generic names list
+
for _, lang in ipairs (names_table) do -- reuse lang
 +
if 0 == namespace and (('en' == lang:lower()) or ('english' == lang:lower())) then
 +
add_maint_cat ('english');
 +
end
 +
 +
if 2 == lang:len() then -- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
 +
name = mw.language.fetchLanguageName( lang:lower(), "en" ); -- get ISO 639-1 language name if Language is a proper code
 
end
 
end
−
end
+
−
 
+
if is_set (name) then -- if Language specified a valid ISO639-1 code
−
if utilities.is_set (first) then
+
code = lang:lower(); -- save it
−
first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first>
+
else
−
 
+
name, code = get_iso639_code (lang); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
−
if not accept_name then -- <first> not wrapped in accept-as-written markup
  −
name_has_mult_names (first, list_name, 0); -- check for multiple names in the parameter; 0 is number of allowed commas in a given name
  −
name_is_numeric (first, list_name); -- check for names that are composed of digits and punctuation
  −
name_is_generic (first, first_alias); -- check for names found in the generic names list
   
end
 
end
−
local wl_type, D = utilities.is_wikilink (first);
+
−
if 0 ~= wl_type then
+
if is_set (code) then
−
first = D;
+
if 'no' == code then name = 'Norwegian' end; -- override wikimedia when code is 'no'
−
utilities.set_message ('err_bad_paramlink', first_alias);
+
if 0 == namespace and 'en' ~= code then -- is this page main / article space and English not the language?
 +
add_prop_cat ('foreign_lang_source', {name, code})
 +
end
 +
elseif false == unrec_cat then
 +
unrec_cat = true; -- only add this category once
 +
add_maint_cat (unknown_lang);
 
end
 
end
 +
 +
table.insert (language_list, name);
 +
name = ''; -- so we can reuse it
 
end
 
end
−
 
+
−
return last, first; -- done
+
code = #language_list -- reuse code as number of languages in the list
 +
if 2 >= code then
 +
name = table.concat (language_list, ' and ') -- insert '<space>and<space>' between two language names
 +
elseif 2 < code then
 +
language_list[code] = 'and ' .. language_list[code]; -- prepend last name with 'and<space>'
 +
name = table.concat (language_list, ', ') -- and concatenate with '<comma><space>' separators
 +
end
 +
return (" " .. wrap_msg ('language', name)); -- wrap with '(in ...)'
 
end
 
end
    +
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
   −
--[[----------------------< E X T R A C T _ N A M E S >-------------------------
+
Set style settings for CS1 citation templates. Returns separator and postscript settings
   −
Gets name list from the input arguments
+
]]
   −
Searches through args in sequential order to find |lastn= and |firstn= parameters
+
local function set_cs1_style (ps)
−
(or their aliases), and their matching link and mask parameters. Stops searching
+
if not is_set (ps) then -- unless explicitely set to something
−
when both |lastn= and |firstn= are not found in args after two sequential attempts:
+
ps = '.'; -- terminate the rendered citation with a period
−
found |last1=, |last2=, and |last3= but doesn't find |last4= and |last5= then the
+
end
−
search is done.
+
return '.', ps; -- separator is a full stop
 +
end
   −
This function emits an error message when there is a |firstn= without a matching
+
--[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------
−
|lastn=.  When there are 'holes' in the list of last names, |last1= and |last3=
  −
are present but |last2= is missing, an error message is emitted. |lastn= is not
  −
required to have a matching |firstn=.
     −
When an author or editor parameter contains some form of 'et al.', the 'et al.'
+
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
−
is stripped from the parameter and a flag (etal) returned that will cause list_people()
  −
to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps
  −
'et al.' out of the template's metadata.  When this occurs, an error is emitted.
      
]]
 
]]
   −
local function extract_names(args, list_name)
+
local function set_cs2_style (ps, ref)
−
local names = {}; -- table of names
+
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
−
local last; -- individual name components
+
ps = ''; -- make sure it isn't nil
−
local first;
+
end
−
local link;
+
if not is_set (ref) then -- if |ref= is not set
−
local mask;
+
ref = "harv"; -- set default |ref=harv
−
local i = 1; -- loop counter/indexer
+
end
−
local n = 1; -- output table indexer
+
return ',', ps, ref; -- separator is a comma
−
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)
+
end
−
local etal = false; -- return value set to true when we find some form of et al. in an author parameter
     −
local last_alias, first_alias, link_alias; -- selected parameter aliases used in error messaging
+
--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
−
while true do
  −
last, last_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'err_redundant_parameters', i ); -- search through args for name components beginning at 1
  −
first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i );
  −
link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i );
  −
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
  −
  −
if last then -- error check |lastn= alias for unknown interwiki link prefix; done here because this is where we have the parameter name
  −
local project, language = interwiki_prefixen_get (last, true); -- true because we expect interwiki links in |lastn= to be wikilinked
  −
if nil == project and nil == language then -- when both are nil
  −
utilities.set_message ('err_bad_paramlink', last_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
  −
last = utilities.remove_wiki_link (last); -- remove wikilink markup; show display value only
  −
end
  −
end
  −
  −
if link then -- error check |linkn= alias for unknown interwiki link prefix
  −
local project, language = interwiki_prefixen_get (link, false); -- false because wiki links in |author-linkn= is an error
  −
if nil == project and nil == language then -- when both are nil
  −
utilities.set_message ('err_bad_paramlink', link_alias); -- not known, emit an error message -- TODO: err_bad_interwiki?
  −
link = nil; -- unset so we don't link
  −
link_alias = nil;
  −
end
  −
end
  −
  −
last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al.
  −
first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.
  −
last, first = name_checks (last, first, list_name, last_alias, first_alias); -- multiple names, extraneous annotation, etc. checks
     −
if first and not last then -- if there is a firstn without a matching lastn
+
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
−
local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias
+
rendered style.
−
utilities.set_message ('err_first_missing_last', {
  −
first_alias, -- param name of alias missing its mate
  −
first_alias:gsub (alias, {['first'] = 'last', ['given'] = 'surname'}), -- make param name appropriate to the alias form
  −
}); -- add this error message
  −
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
  −
count = count + 1; -- number of times we haven't found last and first
  −
if 2 <= count then -- two missing names and we give up
  −
break; -- normal exit or there is a two-name hole in the list; can't tell which
  −
end
  −
else -- we have last with or without a first
  −
local result;
  −
link = link_title_ok (link, link_alias, last, last_alias); -- check for improper wiki-markup
     −
if first then
+
]]
−
link = link_title_ok (link, link_alias, first, first_alias); -- check for improper wiki-markup
  −
end
     −
names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only)
+
local function get_settings_from_cite_class (ps, ref, cite_class)
−
n = n + 1; -- point to next location in the names table
+
local sep;
−
if 1 == count then -- if the previous name was missing
+
if (cite_class == "citation") then -- for citation templates (CS2)
−
utilities.set_message ('err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}); -- add this error message
+
sep, ps, ref = set_cs2_style (ps, ref);
−
end
+
else -- not a citation template so CS1
−
count = 0; -- reset the counter, we're looking for two consecutive missing names
+
sep, ps = set_cs1_style (ps);
−
end
  −
i = i + 1; -- point to next args location
   
end
 
end
−
+
 
−
return names, etal; -- all done, return our list of names and the etal flag
+
return sep, ps, ref -- return them all
 
end
 
end
    +
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
   −
--[[--------------------------< N A M E _ T A G _ G E T >------------------------------------------------------
+
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
 +
config.CitationClass from the template's #invoke: to establish style.
   −
attempt to decode |language=<lang_param> and return language name and matching tag; nil else.
+
]]
   −
This function looks for:
+
local function set_style (mode, ps, ref, cite_class)
−
<lang_param> as a tag in cfg.lang_tag_remap{}
+
local sep;
−
<lang_param> as a name in cfg.lang_name_remap{}
+
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
 +
sep, ps, ref = set_cs2_style (ps, ref);
 +
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
 +
sep, ps = set_cs1_style (ps);
 +
else -- anything but cs1 or cs2
 +
if is_set (mode) then
 +
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'mode', mode}, true ) } ); -- add error message
 +
end
 +
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass
 +
end
 +
if 'none' == ps:lower() then -- if assigned value is 'none' then
 +
ps = ''; -- set to empty string
 +
end
 
 
−
<lang_param> as a name in cfg.mw_languages_by_name_t
+
return sep, ps, ref
−
<lang_param> as a tag in cfg.mw_languages_by_tag_t
+
end
−
when those fail, presume that <lang_param> is an IETF-like tag that MediaWiki does not recognize.  Strip all
  −
script, region, variant, whatever subtags from <lang_param> to leave just a two or three character language tag
  −
and look for the new <lang_param> in cfg.mw_languages_by_tag_t{}
     −
on success, returns name (in properly capitalized form) and matching tag (in lowercase); on failure returns nil
+
--[=[-------------------------< I S _ P D F >------------------------------------------------------------------
   −
]]
+
Determines if a url has the file extension is one of the pdf file extensions used by [[MediaWiki:Common.css]] when
 +
applying the pdf icon to external links.
   −
local function name_tag_get (lang_param)
+
returns true if file extension is one of the recognized extension, else false
−
local lang_param_lc = mw.ustring.lower (lang_param); -- use lowercase as an index into the various tables
  −
local name;
  −
local tag;
     −
name = cfg.lang_tag_remap[lang_param_lc]; -- assume <lang_param_lc> is a tag; attempt to get remapped language name
+
]=]
−
if name then -- when <name>, <lang_param> is a tag for a remapped language name
  −
return name, lang_param_lc; -- so return <name> from remap and <lang_param_lc>
  −
end
     −
tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- still assuming that <lang_param_lc> is a tag; strip script, region, variant subtags
+
local function is_pdf (url)
−
name = cfg.lang_tag_remap[tag]; -- attempt to get remapped language name with language subtag only
+
return url:match ('%.pdf[%?#]?') or url:match ('%.PDF[%?#]?');
−
if name then -- when <name>, <tag> is a tag for a remapped language name
+
end
−
return name, tag; -- so return <name> from remap and <tag>
  −
end
     −
if cfg.lang_name_remap[lang_param_lc] then -- not a tag, assume <lang_param_lc> is a name; attempt to get remapped language tag
+
--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------
−
return cfg.lang_name_remap[lang_param_lc][1], cfg.lang_name_remap[lang_param_lc][2]; -- for this <lang_param_lc>, return a (possibly) new name and appropriate tag
  −
end
     −
tag = cfg.mw_languages_by_name_t[lang_param_lc]; -- assume that <lang_param_lc> is a language name; attempt to get its matching tag
+
Applies css style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does
−
+
not have a matching url parameter.  If the format parameter is not set and the url contains a file extension that
−
if tag then
+
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
−
return cfg.mw_languages_by_tag_t[tag], tag; -- <lang_param_lc> is a name so return the name from the table and <tag>
+
the appropriate styling.
−
end
     −
name = cfg.mw_languages_by_tag_t[lang_param_lc]; -- assume that <lang_param_lc> is a tag; attempt to get its matching language name
+
]]
−
  −
if name then
  −
return name, lang_param_lc; -- <lang_param_lc> is a tag so return it and <name>
  −
end
  −
  −
tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- is <lang_param_lc> an IETF-like tag that MediaWiki doesn't recognize? <tag> gets the language subtag; nil else
     −
if tag then
+
local function style_format (format, url, fmt_param, url_param)
−
name = cfg.mw_languages_by_tag_t[tag]; -- attempt to get a language name using the shortened <tag>
+
if is_set (format) then
−
if name then
+
format = wrap_style ('format', format:upper()); -- force upper case, add leading space, parenthases, resize
−
return name, tag; -- <lang_param_lc> is an unrecognized IETF-like tag so return <name> and language subtag
+
if not is_set (url) then
 +
format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message
 
end
 
end
 +
elseif is_pdf (url) then -- format is not set so if url is a pdf file then
 +
format = wrap_style ('format', 'PDF'); -- set format to pdf
 +
else
 +
format = ''; -- empty string for concatenation
 
end
 
end
 +
return format;
 
end
 
end
    +
--[[--------------------------< G E T _ D I S P L A Y _ A U T H O R S _ E D I T O R S >------------------------
   −
--[[-------------------< L A N G U A G E _ P A R A M E T E R >------------------
+
Returns a number that may or may not limit the length of the author or editor name lists.
   −
Gets language name from a provided two- or three-character ISO 639 code.  If a code
+
When the value assigned to |display-authors= is a number greater than or equal to zero, return the number and
−
is recognized by MediaWiki, use the returned name; if not, then use the value that
+
the previous state of the 'etal' flag (false by default but may have been set to true if the name list contains
−
was provided with the language parameter.
+
some variant of the text 'et al.').
   −
When |language= contains a recognized language (either code or name), the page is
+
When the value assigned to |display-authors= is the keyword 'etal', return a number that is one greater than the
−
assigned to the category for that code: Category:Norwegian-language sources (no).
+
number of authors in the list and set the 'etal' flag true.  This will cause the list_people() to display all of
−
For valid three-character code languages, the page is assigned to the single category
+
the names in the name list followed by 'et al.'
−
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
+
In all other cases, returns nil and the previous state of the 'etal' flag.
−
not recognize three-character equivalents of two-character codes: code 'ar' is
  −
recognized but code 'ara' is not.
  −
 
  −
This function supports multiple languages in the form |language=nb, French, th
  −
where the language names or codes are separated from each other by commas with
  −
optional space characters.
      
]]
 
]]
   −
local function language_parameter (lang)
+
local function get_display_authors_editors (max, count, list_name, etal)
−
local tag; -- some form of IETF-like language tag; language subtag with optional region, sript, vatiant, etc subtags
+
if is_set (max) then
−
local lang_subtag; -- ve populates |language= with mostly unecessary region subtags the MediaWiki does not recognize; this is the base language subtag
+
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
−
local name; -- the language name
+
max = count + 1; -- number of authors + 1 so display all author name plus et al.
−
local language_list = {}; -- table of language names to be rendered
+
etal = true; -- overrides value set by extract_names()
−
local names_t = {}; -- table made from the value assigned to |language=
+
elseif max:match ('^%d+$') then -- if is a string of numbers
 +
max = tonumber (max); -- make it a number
 +
if max >= count and 'authors' == list_name then -- AUTHORS ONLY -- if |display-xxxxors= value greater than or equal to number of authors/editors
 +
add_maint_cat ('disp_auth_ed', list_name);
 +
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 'authors' == list_name then -- AUTHORS ONLY need to clear implicit et al category
 +
max = count + 1; -- number of authors + 1
 +
end
 +
 +
return max, etal;
 +
end
   −
local this_wiki_name = mw.language.fetchLanguageName (cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name
+
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
   −
names_t = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
+
This is the main function doing the majority of the citation
 +
formatting.
   −
for _, lang in ipairs (names_t) do -- reuse lang here because we don't yet know if lang is a language name or a language tag
+
]]
−
name, tag = name_tag_get (lang); -- attempt to get name/tag pair for <lang>; <name> has proper capitalization; <tag> is lowercase
     −
if utilities.is_set (tag) then
+
local function citation0( config, args)
−
lang_subtag = tag:gsub ('^(%a%a%a?)%-.*', '%1'); -- for categorization, strip any IETF-like tags from language tag
+
--[[
 +
Load Input Parameters
 +
The argument_wrapper facilitates the mapping of multiple
 +
aliases to single internal variable.
 +
]]
 +
local A = argument_wrapper( args );
   −
if cfg.this_wiki_code ~= lang_subtag then -- when the language is not the same as this wiki's language
+
local i
−
if 2 == lang_subtag:len() then -- and is a two-character tag
+
local PPrefix = A['PPrefix']
−
utilities.add_prop_cat ('foreign-lang-source', {name, tag}, lang_subtag); -- categorize it; tag appended to allow for multiple language categorization
+
local PPPrefix = A['PPPrefix']
−
else -- or is a recognized language (but has a three-character tag)
+
if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
−
utilities.add_prop_cat ('foreign-lang-source-2', {lang_subtag}, lang_subtag); -- categorize it differently TODO: support multiple three-character tag categories per cs1|2 template?
+
−
end
+
-- Pick out the relevant fields from the arguments.  Different citation templates
−
elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
+
-- define different field names for the same underlying things.
−
utilities.add_prop_cat ('local-lang-source', {name, lang_subtag}); -- categorize it
+
local Authors = A['Authors'];
−
end
+
local author_etal;
−
else
+
local a, author_etal = extract_names( args, 'AuthorList' );
−
name = lang; -- return whatever <lang> has so that we show something
  −
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
  −
end
  −
  −
table.insert (language_list, name);
  −
name = ''; -- so we can reuse it
  −
end
  −
  −
name = utilities.make_sep_list (#language_list, language_list);
  −
if (1 == #language_list) and (lang_subtag == cfg.this_wiki_code) then -- when only one language, find lang name in this wiki lang name; for |language=en-us, 'English' in 'American English'
  −
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
  −
end
  −
return (" " .. wrap_msg ('language', name)); -- otherwise wrap with '(in ...)'
  −
--[[ TODO: should only return blank or name rather than full list
  −
so we can clean up the bunched parenthetical elements Language, Type, Format
  −
]]
  −
end
      +
local Coauthors = A['Coauthors'];
 +
local Others = A['Others'];
 +
local Editors = A['Editors'];
 +
local editor_etal;
 +
local e, editor_etal = extract_names( args, 'EditorList' );
   −
--[[-----------------------< S E T _ C S _ S T Y L E >--------------------------
+
local NameListFormat = A['NameListFormat']; -- replaces |author-format= and |editor-format=
−
 
+
if is_set (NameListFormat) and ('vanc' ~= NameListFormat) then -- only accepted value for this parameter is 'vanc'
−
Gets the default CS style configuration for the given mode.
+
table.insert( z.message_tail, { set_error( 'invalid_param_val', {'name-list-format', NameListFormat}, true ) } ); -- not vanc so add error message
−
Returns default separator and either postscript as passed in or the default.
+
NameListFormat = ''; -- set to empty string
−
In CS1, the default postscript and separator are '.'.
  −
In CS2, the default postscript is the empty string and the default separator is ','.
  −
 
  −
]]
  −
 
  −
local function set_cs_style (postscript, mode)
  −
if utilities.is_set(postscript) then
  −
-- emit a maintenance message if user postscript is the default cs1 postscript
  −
-- we catch the opposite case for cs2 in set_style
  −
if mode == 'cs1' and postscript == cfg.presentation['ps_' .. mode] then
  −
utilities.set_message ('maint_postscript');
  −
end
  −
else
  −
postscript = cfg.presentation['ps_' .. mode];
   
end
 
end
−
return cfg.presentation['sep_' .. mode], postscript;
  −
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'];
 +
local Chapter = A['Chapter'];
 +
local ChapterLink = A['ChapterLink']; -- deprecated
 +
local TransChapter = A['TransChapter'];
 +
local TitleType = A['TitleType'];
 +
local Degree = A['Degree'];
 +
local Docket = A['Docket'];
 +
local ArchiveFormat = A['ArchiveFormat'];
 +
local ArchiveURL = A['ArchiveURL'];
 +
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'];
   −
--[[--------------------------< S E T _ S T Y L E >-----------------------------
+
local Series = A['Series'];
−
 
+
local Volume = A['Volume'];
−
Sets the separator and postscript styles. Checks the |mode= first and the
+
local Issue = A['Issue'];
−
#invoke CitationClass second. Removes the postscript if postscript == none.
+
local Position = '';
−
 
+
local Page = A['Page'];
−
]]
+
local Pages = hyphen_to_dash( A['Pages'] );
 +
local At = A['At'];
   −
local function set_style (mode, postscript, cite_class)
+
local Edition = A['Edition'];
−
local sep;
+
local PublicationPlace = A['PublicationPlace']
−
if 'cs2' == mode then
+
local Place = A['Place'];
−
sep, postscript = set_cs_style (postscript, 'cs2');
  −
elseif 'cs1' == mode then
  −
sep, postscript = set_cs_style (postscript, 'cs1');
  −
elseif 'citation' == cite_class then
  −
sep, postscript = set_cs_style (postscript, 'cs2');
  −
else
  −
sep, postscript = set_cs_style (postscript, 'cs1');
  −
end
  −
 
  −
if cfg.keywords_xlate[postscript:lower()] == 'none' then
  −
-- emit a maintenance message if user postscript is the default cs2 postscript
  −
-- we catch the opposite case for cs1 in set_cs_style
  −
if 'cs2' == mode or 'citation' == cite_class then
  −
utilities.set_message ('maint_postscript');
  −
end
  −
postscript = '';
  −
end
   
 
−
return sep, postscript
+
local PublisherName = A['PublisherName'];
−
end
+
local RegistrationRequired = A['RegistrationRequired'];
 +
local SubscriptionRequired = A['SubscriptionRequired'];
 +
local Via = A['Via'];
 +
local AccessDate = A['AccessDate'];
 +
local ArchiveDate = A['ArchiveDate'];
 +
local Agency = A['Agency'];
 +
local DeadURL = A['DeadURL']
 +
local Language = A['Language'];
 +
local Format = A['Format'];
 +
local ChapterFormat = A['ChapterFormat'];
 +
local DoiBroken = A['DoiBroken'];
 +
local ID = A['ID'];
 +
local ASINTLD = A['ASINTLD'];
 +
local IgnoreISBN = A['IgnoreISBN'];
 +
local Embargo = A['Embargo'];
 +
local Class = A['Class']; -- arxiv class identifier
    +
local ID_list = extract_ids( args );
   −
--[=[-------------------------< I S _ P D F >-----------------------------------
+
local Quote = A['Quote'];
   −
Determines if a URL has the file extension that is one of the PDF file extensions
+
local LayFormat = A['LayFormat'];
−
used by [[MediaWiki:Common.css]] when applying the PDF icon to external links.
+
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
   −
returns true if file extension is one of the recognized extensions, else false
+
local LastAuthorAmp = A['LastAuthorAmp'];
 +
local no_tracking_cats = A['NoTracking'];
   −
]=]
+
--these are used by cite interview
 +
local Callsign = A['Callsign'];
 +
local City = A['City'];
 +
local Program = A['Program'];
   −
local function is_pdf (url)
+
--local variables that are not cs1 parameters
−
return url:match ('%.pdf$') or url:match ('%.PDF$') or
+
local use_lowercase; -- controls capitalization of certain static text
−
url:match ('%.pdf[%?#]') or url:match ('%.PDF[%?#]') or
+
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
−
url:match ('%.PDF&#035') or url:match ('%.pdf&#035');
+
local anchor_year; -- used in the CITEREF identifier
−
end
+
local COinS_date; -- used in the COinS metadata
    +
-- set default parameter values defined by |mode= parameter.  If |mode= is empty or omitted, use CitationClass to set these values
 +
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
 +
local PostScript;
 +
local Ref;
 +
sepc, PostScript, Ref = set_style (A['Mode']:lower(), A['PostScript'], A['Ref'], config.CitationClass);
 +
use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text
   −
--[[--------------------------< S T Y L E _ F O R M A T >-----------------------
+
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
−
 
+
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
−
Applies CSS style to |format=, |chapter-format=, etc.  Also emits an error message
+
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
−
if the format parameter does not have a matching URL parameter.  If the format parameter
+
no_tracking_cats = "true"; -- set no_tracking_cats
−
is not set and the URL contains a file extension that is recognized as a PDF document
+
end
−
by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
+
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
−
the appropriate styling.
+
if this_page.text:match (v) then -- test page name against each pattern
−
 
+
no_tracking_cats = "true"; -- set no_tracking_cats
−
]]
+
break; -- bail out if one is found
−
 
+
end
−
local function style_format (format, url, fmt_param, url_param)
  −
if utilities.is_set (format) then
  −
format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize
  −
if not utilities.is_set (url) then
  −
utilities.set_message ('err_format_missing_url', {fmt_param, url_param}); -- add an error message
   
end
 
end
−
elseif is_pdf (url) then -- format is not set so if URL is a PDF file then
  −
format = utilities.wrap_style ('format', 'PDF'); -- set format to PDF
  −
else
  −
format = ''; -- empty string for concatenation
   
end
 
end
−
return format;
  −
end
      +
-- check for extra |page=, |pages= or |at= parameters.
 +
if is_set(Page) then
 +
if is_set(Pages) or is_set(At) then
 +
Page = Page .. " " .. set_error('extra_pages'); -- add error message
 +
Pages = ''; -- unset the others
 +
At = '';
 +
end
 +
elseif is_set(Pages) then
 +
if is_set(At) then
 +
Pages = Pages .. " " .. set_error('extra_pages'); -- add error messages
 +
At = ''; -- unset
 +
end
 +
end
   −
--[[---------------------< G E T _ D I S P L A Y _ N A M E S >------------------
+
-- both |publication-place= and |place= (|location=) allowed if different
 +
if not is_set(PublicationPlace) and is_set(Place) then
 +
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
 +
end
 +
 +
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
 +
 +
--[[
 +
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
   −
Returns a number that defines the number of names displayed for author and editor
+
|trans_title maps to |trans_chapter when |title is re-mapped
−
name lists and a Boolean flag to indicate when et al. should be appended to the name list.
+
|url maps to |chapterurl when |title is remapped
   −
When the value assigned to |display-xxxxors= is a number greater than or equal to zero,
+
All other combinations of |encyclopedia, |title, and |article are not modified
−
return the number and the previous state of the 'etal' flag (false by default
+
TODO: script-title to script-chapter if and when we support script-chapter
−
but may have been set to true if the name list contains some variant of the text 'et al.').
+
]]
   −
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number
+
local Encyclopedia = A['Encyclopedia'];
−
that is one greater than the number of authors in the list and set the 'etal' flag true.
  −
This will cause the list_people() to display all of the names in the name list followed by 'et al.'
     −
In all other cases, returns nil and the previous state of the 'etal' flag.
+
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
 +
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
 +
if is_set(Title) then
 +
if not is_set(Chapter) then
 +
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
 +
TransChapter = TransTitle;
 +
ChapterURL = URL;
 +
Title = Periodical;
 +
ChapterFormat = Format;
 +
Periodical = ''; -- redundant so unset
 +
TransTitle = ''; -- redundant so unset
 +
URL = ''; -- redundant so unset
 +
Format = ''; -- redundant so unset
 +
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
 +
end
   −
inputs:
+
-- Special case for cite techreport.
−
max: A['DisplayAuthors'] or A['DisplayEditors'], etc; a number or some flavor of etal
+
if (config.CitationClass == "techreport") then -- special case for cite techreport
−
count: #a or #e
+
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
−
list_name: 'authors' or 'editors'
+
if not is_set(ID) then -- can we use ID for the "number"?
−
etal: author_etal or editor_etal
+
ID = Issue; -- yes, use it
 +
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
 +
else -- can't use ID so emit error message
 +
ID = ID .. " " .. set_error('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
 +
end
 +
end
 +
end
   −
This function sets an error message when |display-xxxxors= value greater than or equal to number of names but
+
-- special case for cite interview
−
not when <max> comes from {{cs1 config}} global settings. When using global settings, <param> is set to the
+
if (config.CitationClass == "interview") then
−
keyword 'cs1 config' which is used to supress the normal error. Error is suppressed because it is to be expected
+
if is_set(Program) then
−
that some citations in an article will have the same or fewer names that the limit specified in {{cs1 config}}.
+
ID = ' ' .. Program;
−
 
+
end
−
]]
+
if is_set(Callsign) then
−
 
+
if is_set(ID) then
−
local function get_display_names (max, count, list_name, etal, param)
+
ID = ID .. sepc .. ' ' .. Callsign;
−
if utilities.is_set (max) then
+
else
−
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
+
ID = ' ' .. Callsign;
−
max = count + 1; -- number of authors + 1 so display all author name plus et al.
+
end
−
etal = true; -- overrides value set by extract_names()
+
end
−
elseif max:match ('^%d+$') then -- if is a string of numbers
+
if is_set(City) then
−
max = tonumber (max); -- make it a number
+
if is_set(ID) then
−
if (max >= count) and ('cs1 config' ~= param) then -- error when local |display-xxxxors= value greater than or equal to number of names; not an error when using global setting
+
ID = ID .. sepc .. ' ' .. City;
−
utilities.set_message ('err_disp_name', {param, max}); -- add error message
+
else
−
max = nil;
+
ID = ' ' .. City;
 
end
 
end
−
else -- not a valid keyword or number
  −
utilities.set_message ('err_disp_name', {param, max}); -- add error message
  −
max = nil; -- unset; as if |display-xxxxors= had not been set
   
end
 
end
−
end
  −
  −
return max, etal;
  −
end
     −
 
+
if is_set(Others) then
−
--[[----------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >---------------
+
if is_set(TitleType) then
−
 
+
Others = ' ' .. TitleType .. ' with ' .. Others;
−
Adds error if |page=, |pages=, |quote-page=, |quote-pages= has what appears to be
+
TitleType = '';
−
some form of p. or pp. abbreviation in the first characters of the parameter content.
+
else
−
 
+
Others = ' ' .. 'Interview with ' .. Others;
−
check page for extraneous p, p., pp, pp., pg, pg. at start of parameter value:
  −
good pattern: '^P[^%.P%l]' matches when page begins PX or P# but not Px
  −
      where x and X are letters and # is a digit
  −
bad pattern:  '^[Pp][PpGg]' matches when page begins pp, pP, Pp, PP, pg, pG, Pg, PG
  −
 
  −
]]
  −
 
  −
local function extra_text_in_page_check (val, name)
  −
if not val:match (cfg.vol_iss_pg_patterns.good_ppattern) then
  −
for _, pattern in ipairs (cfg.vol_iss_pg_patterns.bad_ppatterns) do -- spin through the selected sequence table of patterns
  −
if val:match (pattern) then -- when a match, error so
  −
utilities.set_message ('err_extra_text_pages', name); -- add error message
  −
return; -- and done
   
end
 
end
 +
else
 +
Others = '(Interview)';
 
end
 
end
−
end
+
end
−
end
      +
-- special case for cite mailing list
 +
if (config.CitationClass == "mailinglist") then
 +
Periodical = A ['MailingList'];
 +
end
   −
--[[--------------------------< E X T R A _ T E X T _ I N _ V O L _ I S S _ C H E C K >------------------------
+
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
−
 
+
if 'conference' == config.CitationClass then
−
Adds error if |volume= or |issue= has what appears to be some form of redundant 'type' indicator.
+
if is_set(BookTitle) then
−
 
+
Chapter = Title;
−
For |volume=:
+
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
−
'V.', or 'Vol.' (with or without the dot) abbreviations or 'Volume' in the first characters of the parameter
+
ChapterURL = URL;
−
content (all case insensitive). 'V' and 'v' (without the dot) are presumed to be roman numerals so
+
ChapterURLorigin = URLorigin;
−
are allowed.
+
URLorigin = '';
−
 
+
ChapterFormat = Format;
−
For |issue=:
+
TransChapter = TransTitle;
−
'No.', 'I.', 'Iss.' (with or without the dot) abbreviations, or 'Issue' in the first characters of the
+
Title = BookTitle;
−
parameter content (all case insensitive).
+
Format = '';
−
+
-- TitleLink = '';
−
Single character values ('v', 'i', 'n') allowed when not followed by separator character ('.', ':', '=', or
+
TransTitle = '';
−
whitespace character) – param values are trimmed of whitespace by MediaWiki before delivered to the module.
+
URL = '';
−
  −
<val> is |volume= or |issue= parameter value
  −
<name> is |volume= or |issue= parameter name for error message
  −
<selector> is 'v' for |volume=, 'i' for |issue=
  −
 
  −
sets error message on failure; returns nothing
  −
 
  −
]]
  −
 
  −
local function extra_text_in_vol_iss_check (val, name, selector)
  −
if not utilities.is_set (val) then
  −
return;
  −
end
  −
  −
local patterns = 'v' == selector and cfg.vol_iss_pg_patterns.vpatterns or cfg.vol_iss_pg_patterns.ipatterns;
  −
 
  −
local handler = 'v' == selector and 'err_extra_text_volume' or 'err_extra_text_issue';
  −
val = val:lower(); -- force parameter value to lower case
  −
for _, pattern in ipairs (patterns) do -- spin through the selected sequence table of patterns
  −
if val:match (pattern) then -- when a match, error so
  −
utilities.set_message (handler, name); -- add error message
  −
return; -- and done
   
end
 
end
 +
elseif 'speech' ~= config.CitationClass then
 +
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
 
end
 
end
−
end
      +
-- cite map oddities
 +
local Cartography = "";
 +
local Scale = "";
 +
local Sheet = A['Sheet'] or '';
 +
local Sheets = A['Sheets'] or '';
 +
if config.CitationClass == "map" then
 +
Chapter = A['Map'];
 +
ChapterURL = A['MapURL'];
 +
TransChapter = A['TransMap'];
 +
ChapterURLorigin = A:ORIGIN('MapURL');
 +
ChapterFormat = A['MapFormat'];
 +
 +
Cartography = A['Cartography'];
 +
if is_set( Cartography ) then
 +
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
 +
end
 +
Scale = A['Scale'];
 +
if is_set( Scale ) then
 +
Scale = sepc .. " " .. Scale;
 +
end
 +
end
   −
--[=[-------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
+
-- 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
−
split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled
+
local AirDate = A['AirDate'];
−
parentheses to also have commas; in the old version of the code, the doubled parentheses were included in the
+
local Began = A['Began']; -- these two are deprecated because the module understands date ranges
−
rendered citation and in the metadata.  Individual author names may be wikilinked
+
local Ended = A['Ended'];
−
 
+
local SeriesLink = A['SeriesLink'];
−
|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.))
+
local Network = A['Network'];
−
 
+
local Station = A['Station'];
−
]=]
+
local s, n = {}, {};
   −
local function get_v_name_table (vparam, output_table, output_link_table)
+
-- do common parameters first
−
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas
+
if is_set(Network) then table.insert(n, Network); end
−
local wl_type, label, link; -- wl_type not used here; just a placeholder
+
if is_set(Station) then table.insert(n, Station); end
−
+
ID = table.concat(n, sepc .. ' ');
−
local i = 1;
+
−
+
if not is_set (Date) then -- promote airdate or Began/Ended to date
−
while name_table[i] do
+
if is_set (AirDate) then
−
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parentheses
+
Date = AirDate;
−
local name = name_table[i];
+
elseif is_set (Began) then -- deprecated
−
i = i + 1; -- bump indexer to next segment
+
if Began:match('%s') or Ended:match('%s') then -- so we don't create errors: if either has spaces then
−
while name_table[i] do
+
Date = Began .. ' – ' .. Ended; -- use spaced ndash as separator
−
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
+
else
−
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parentheses
+
Date = Began .. '–' .. Ended; -- elsewise no spaces
−
break; -- and done reassembling so
   
end
 
end
−
i = i + 1; -- bump indexer
   
end
 
end
−
table.insert (output_table, name); -- and add corporate name to the output table
+
end
−
table.insert (output_link_table, ''); -- no wikilink
  −
else
  −
wl_type, label, link = utilities.is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
  −
table.insert (output_table, label); -- add this name
  −
if 1 == wl_type then
  −
table.insert (output_link_table, label); -- simple wikilink [[D]]
  −
else
  −
table.insert (output_link_table, link); -- no wikilink or [[L|D]]; add this link if there is one, else empty string
  −
end
  −
end
  −
i = i + 1;
  −
end
  −
return output_table;
  −
end
      +
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
 +
local Season = A['Season'];
 +
local SeriesNumber = A['SeriesNumber'];
   −
--[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------
+
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)); end
 +
if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end
 +
if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
 +
Issue = ''; -- unset because this is not a unique parameter
 +
 +
Chapter = Title; -- promote title parameters to chapter
 +
ChapterLink = TitleLink; -- alias episodelink
 +
TransChapter = TransTitle;
 +
ChapterURL = URL;
 +
ChapterURLorigin = A:ORIGIN('URL');
 +
 +
Title = Series; -- promote series to title
 +
TitleLink = SeriesLink;
 +
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
   −
This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and
+
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
−
|xxxxor-linkn= in args.  It then returns a table of assembled names just as extract_names() does.
+
Chapter = '[[' .. ChapterLink .. '|' .. Chapter .. ']]'; -- ok to wikilink
 +
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
 +
Series = '[[' .. ChapterLink .. '|' .. Series .. ']]'; -- series links with ChapterLink (episodelink -> TitleLink -> ChapterLink) ugly
 +
end
 +
URL = ''; -- unset
 +
TransTitle = ''; -- unset
 +
 +
else -- now oddities that are cite serial
 +
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
 +
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
 +
if is_set (Series) and is_set (SeriesLink) then
 +
Series = '[[' .. SeriesLink .. '|' .. Series .. ']]';
 +
end
 +
Series = wrap_style ('italic-title', Series); -- series is italicized
 +
end
 +
end
 +
-- end of {{cite episode}} stuff
   −
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
+
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
−
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
+
if 'arxiv' == config.CitationClass then
−
tests, are wrapped in doubled parentheses ((corporate name)) to suppress the format tests.
+
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
 +
table.insert( z.message_tail, { set_error( 'arxiv_missing', {}, true ) } ); -- add error message
 +
end
 +
if first_set (AccessDate, At, Chapter, Format, Page, Pages, Periodical, PublisherName, URL, -- a crude list of parameters that are not supported by cite arxiv
 +
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
 +
ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
 +
ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']) then
 +
table.insert( z.message_tail, { set_error( 'arxiv_params_not_supported', {}, true ) } ); -- 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
   −
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
+
-- handle type parameter for those CS1 citations that have default values
   −
This function sets the Vancouver error when a required comma is missing and when there is a space between an author's initials.
+
if in_array(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
 +
TitleType = set_titletype (config.CitationClass, TitleType);
 +
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
 +
TitleType = Degree .. " thesis";
 +
end
 +
end
   −
]]
+
if is_set(TitleType) then -- if type parameter is specified
 +
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
 +
end
   −
local function parse_vauthors_veditors (args, vparam, list_name)
+
-- 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.
−
local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn=
+
if not is_set (Date) then
−
local v_name_table = {};
+
Date = Year; -- promote Year to Date
−
local v_link_table = {}; -- when name is wikilinked, targets go in this table
+
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
−
local etal = false; -- return value set to true when we find some form of et al. vauthors parameter
+
if is_set(Date) then
−
local last, first, link, mask, suffix;
+
local Month = A['Month'];
−
local corporate = false;
+
if is_set(Month) then
 +
Date = Month .. " " .. Date;
 +
end
 +
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
 +
Date = PublicationDate; -- promote PublicationDate to Date
 +
PublicationDate = ''; -- unset, no longer needed
 +
end
 +
end
   −
vparam, etal = name_has_etal (vparam, etal, true); -- find and remove variations on et al. do not categorize (do it here because et al. might have a period)
+
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
−
v_name_table = get_v_name_table (vparam, v_name_table, v_link_table); -- names are separated by commas
     −
for i, v_name in ipairs(v_name_table) do
+
--[[
−
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
+
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
−
local accept_name;
+
we get the date used in the metadata.
−
v_name, accept_name = utilities.has_accept_as_written (v_name); -- remove accept-this-as-written markup when it wraps all of <v_name>
     −
if accept_name then
+
Date validation supporting code is in Module:Citation/CS1/Date_validation
−
last = v_name;
+
]]
−
corporate = true; -- flag used in list_people()
+
do -- create defined block to contain local variables error_message and mismatch
−
elseif string.find(v_name, "%s") then
+
local error_message = '';
−
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
+
-- AirDate has been promoted to Date so not necessary to check it
−
add_vanc_error (cfg.err_msg_supl.punctuation, i);
+
anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
−
end
+
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
−
local lastfirstTable = {}
  −
lastfirstTable = mw.text.split(v_name, "%s+")
  −
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be initials or generational suffix
     −
if not mw.ustring.match (first, '^%u+$') then -- mw.ustring here so that later we will catch non-Latin characters
+
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed;
−
suffix = first; -- not initials so assume that whatever we got is a generational suffix
+
local mismatch = year_date_check (Year, Date)
−
first = table.remove(lastfirstTable); -- get what should be the initials from the table
+
if 0 == mismatch then -- |year= does not match a year-value in |date=
 +
if is_set (error_message) then -- if there is already an error message
 +
error_message = error_message .. ', '; -- 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 ('date_year');
 
end
 
end
−
last = table.concat(lastfirstTable, ' ') -- returns a string that is the concatenation of all other names that are not initials and generational suffix
  −
if not utilities.is_set (last) then
  −
first = ''; -- unset
  −
last = v_name; -- last empty because something wrong with first
  −
add_vanc_error (cfg.err_msg_supl.name, i);
  −
end
  −
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
  −
add_vanc_error (cfg.err_msg_supl['missing comma'], i); -- matches last II last; the case when a comma is missing
  −
end
  −
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test
  −
add_vanc_error (cfg.err_msg_supl.initials, i); -- matches a space between two initials
  −
end
  −
else
  −
last = v_name; -- last name or single corporate name?  Doesn't support multiword corporate names? do we need this?
   
end
 
end
−
+
 
−
if utilities.is_set (first) then
+
if is_set(error_message) then
−
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
+
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
−
add_vanc_error (cfg.err_msg_supl.initials, i); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
  −
end
  −
is_good_vanc_name (last, first, suffix, i); -- check first and last before restoring the suffix which may have a non-Latin digit
  −
if utilities.is_set (suffix) then
  −
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
  −
suffix = ''; -- unset so we don't add this suffix to all subsequent names
  −
end
  −
else
  −
if not corporate then
  −
is_good_vanc_name (last, '', nil, i);
  −
end
   
end
 
end
 +
end -- end of do
   −
link = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ) or v_link_table[i];
+
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS.
−
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
+
-- 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
−
names[i] = {last = last, first = first, link = link, mask = mask, corporate = corporate}; -- add this assembled name to our names list
+
Embargo = is_embargoed (Embargo); --  
−
end
  −
return names, etal; -- all done, return our list of names
  −
end
     −
 
+
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) 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 >------------------------
+
if not is_set (Embargo) then -- if not embargoed or embargo has expired
−
 
+
URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
−
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
+
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
−
select one of |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.
+
end
−
 
  −
Only one of these appropriate three will be used.  The hierarchy is: |authorn= (and aliases) highest and |authors= lowest;
  −
|editorn= (and aliases) highest and |veditors= lowest (support for |editors= withdrawn)
  −
 
  −
When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
  −
test which mimicks the test used in extract_names() when looking for a hole in the author name list.  There may be a better
  −
way to do this, I just haven't discovered what that way is.
  −
 
  −
Emits an error message when more than one xxxxor name source is provided.
  −
 
  −
In this function, vxxxxors = vauthors or veditors; xxxxors = authors as appropriate.
  −
 
  −
]]
  −
 
  −
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
  −
local lastfirst = false;
  −
if utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice in case we have a |first1= without a |last1=; this ...
  −
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
  −
utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
  −
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
  −
lastfirst = true;
   
end
 
end
   −
if (utilities.is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
+
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
−
(utilities.is_set (vxxxxors) and utilities.is_set (xxxxors)) or
+
-- Test if citation has no title
−
(true == lastfirst and utilities.is_set (xxxxors)) then
+
if not is_set(Title) and
−
local err_name;
+
not is_set(TransTitle) and
−
if 'AuthorList' == list_name then -- figure out which name should be used in error message
+
not is_set(ScriptTitle) then
−
err_name = 'author';
+
table.insert( z.message_tail, { set_error( 'citation_missing_title', {}, true ) } );
−
else
  −
err_name = 'editor';
  −
end
  −
utilities.set_message ('err_redundant_parameters', err_name .. '-name-list parameters'); -- add error message
   
end
 
end
−
 
+
−
if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
+
if 'none' == Title and is_set(Periodical) and not (( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia))) then -- special case
−
if utilities.is_set (vxxxxors) then return 2 end;
+
Title = ''; -- set title to empty string
−
if utilities.is_set (xxxxors) then return 3 end;
+
add_maint_cat ('untitled');
−
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
  −
end
  −
 
  −
 
  −
--[[--------------------------< I S _ V A L I D _ P A R A M E T E R _ V A L U E >------------------------------
  −
 
  −
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
  −
of allowable values (yes, y, true, live, dead, etc.).  When the parameter value has not been assigned a value (missing
  −
or empty in the source template) the function returns the value specified by ret_val.  If the parameter value is one
  −
of the list of allowed values returns the translated value; else, emits an error message and returns the value
  −
specified by ret_val.
  −
 
  −
TODO: explain <invert>
  −
 
  −
]]
  −
 
  −
local function is_valid_parameter_value (value, name, possible, ret_val, invert)
  −
if not utilities.is_set (value) then
  −
return ret_val; -- an empty parameter is ok
   
end
 
end
   −
if (not invert and utilities.in_array (value, possible)) then -- normal; <value> is in <possible> table
+
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
−
return cfg.keywords_xlate[value]; -- return translation of parameter keyword
+
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
−
elseif invert and not utilities.in_array (value, possible) then -- invert; <value> is not in <possible> table
+
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
−
return value; -- return <value> as it is
+
-- is the article title, and Chapter is a section within the article. So, we remap
−
else
+
−
utilities.set_message ('err_invalid_param_val', {name, value}); -- not an allowed value so add error message
+
local coins_chapter = Chapter; -- default assuming that remapping not required
−
return ret_val;
+
local coins_title = Title; -- et tu
 +
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
 +
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then
 +
coins_chapter = Title; -- remap
 +
coins_title = Periodical;
 +
end
 
end
 
end
−
end
+
 +
-- this is the function call to COinS()
 +
local OCinSoutput = COinS({
 +
['Periodical'] = Periodical,
 +
['Chapter'] = strip_apostrophe_markup (coins_chapter), -- Chapter stripped of bold / italic wikimarkup
 +
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
 +
['PublicationPlace'] = PublicationPlace,
 +
['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
 +
['Series'] = Series,
 +
['Volume'] = Volume,
 +
['Issue'] = Issue,
 +
['Pages'] = get_coins_pages (first_set(Sheet, Sheets, Page, Pages, At)), -- pages stripped of external links
 +
['Edition'] = Edition,
 +
['PublisherName'] = PublisherName,
 +
['URL'] = first_set( URL, ChapterURL ),
 +
['Authors'] = a,
 +
['ID_list'] = ID_list,
 +
['RawPage'] = this_page.prefixedText,
 +
}, config.CitationClass);
    +
-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
 +
if 'arxiv' == config.CitationClass then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
 +
Periodical = ''; -- periodical not allowed in cite arxiv; if article has been published, use cite journal
 +
end
   −
--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------
+
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
−
 
+
if 'newsgroup' == config.CitationClass then
−
This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
+
if is_set (PublisherName) then
−
when the last character is not a sepc character or when the last three characters are not sepc followed by two
+
PublisherName = '[[Newsgroup]]:&nbsp;' .. external_link( 'news:' .. PublisherName, PublisherName );
−
closing square brackets (close of a wikilink).  When either of these is true, the name_list is terminated with a
+
end
−
single space character.
  −
 
  −
]]
  −
 
  −
local function terminate_name_list (name_list, sepc)
  −
if (string.sub (name_list, -3, -1) == sepc .. '. ') then -- if already properly terminated
  −
return name_list; -- just return the name list
  −
elseif (string.sub (name_list, -1, -1) == sepc) or (string.sub (name_list, -3, -1) == sepc .. ']]') then -- if last name in list ends with sepc char
  −
return name_list .. " "; -- don't add another
  −
else
  −
return name_list .. sepc .. ' '; -- otherwise terminate the name list
   
end
 
end
−
end
        −
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >-----------------------------------------
     −
returns the concatenation of the formatted volume and issue (or journal article number) parameters as a single
+
-- Now perform various field substitutions.
−
string; or formatted volume or formatted issue, or an empty string if neither are set.
+
-- We also add leading spaces and surrounding markup and punctuation to the
−
 
+
-- various parts of the citation, but only when they are non-nil.
−
]]
+
do -- do-block to limit scope of LastFirstAuthors
−
+
local LastFirstAuthors;
−
local function format_volume_issue (volume, issue, article, cite_class, origin, sepc, lower)
+
local Maximum = A['DisplayAuthors'];
−
if not utilities.is_set (volume) and not utilities.is_set (issue) and not utilities.is_set (article) then
  −
return '';
  −
end
     −
-- same condition as in format_pages_sheets()
+
Maximum , author_etal = get_display_authors_editors (Maximum, #a, 'authors', author_etal);
−
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
     −
local is_numeric_vol = volume and (volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')); -- is only uppercase roman numerals or only digits?
+
local control = {
−
local is_long_vol = volume and (4 < mw.ustring.len(volume)); -- is |volume= value longer than 4 characters?
+
format = NameListFormat, -- empty string or 'vanc'
−
+
maximum = Maximum,
−
if volume and (not is_numeric_vol and is_long_vol) then -- when not all digits or Roman numerals, is |volume= longer than 4 characters?
+
lastauthoramp = LastAuthorAmp,
−
utilities.add_prop_cat ('long-vol'); -- yes, add properties cat
+
page_name = this_page.text -- get current page name so that we don't wikilink to it via authorlinkn
−
end
+
};
−
 
+
−
if is_journal then -- journal-style formatting
+
-- If the coauthor field is also used, prevent ampersand and et al. formatting.
−
local vol = '';
+
if is_set(Coauthors) then
 +
control.lastauthoramp = nil;
 +
control.maximum = #a + 1;
 +
end
 +
 +
LastFirstAuthors = list_people(control, a, author_etal);
   −
if utilities.is_set (volume) then
+
if is_set (Authors) then
−
if is_numeric_vol then -- |volume= value all digits or all uppercase Roman numerals?
+
if is_set (LastFirstAuthors) then -- if both author name styles
−
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, volume}); -- render in bold face
+
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'authors') .. ' and ' .. wrap_style ('parameter', 'last')}, true ) } ); -- add error message
−
elseif is_long_vol then -- not all digits or Roman numerals; longer than 4 characters?
+
Authors = LastFirstAuthors; -- TODO: is this correct or should we use |authors= instead?
−
vol = utilities.substitute (cfg.messages['j-vol'], {sepc, utilities.hyphen_to_dash (volume)}); -- not bold
  −
else -- four or fewer characters
  −
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, utilities.hyphen_to_dash (volume)}); -- bold
   
end
 
end
 +
else
 +
Authors = LastFirstAuthors; -- either an author name list or an empty string
 
end
 
end
−
vol = vol .. (utilities.is_set (issue) and utilities.substitute (cfg.messages['j-issue'], issue) or '')
+
end -- end of do
−
vol = vol .. (utilities.is_set (article) and utilities.substitute (cfg.messages['j-article-num'], article) or '')
  −
return vol;
  −
end
  −
  −
if 'podcast' == cite_class and utilities.is_set (issue) then
  −
return wrap_msg ('issue', {sepc, issue}, lower);
  −
end
  −
  −
if 'conference' == cite_class and utilities.is_set (article) then -- |article-number= supported only in journal and conference cites
  −
if utilities.is_set (volume) and utilities.is_set (article) then -- both volume and article number
  −
return wrap_msg ('vol-art', {sepc, utilities.hyphen_to_dash (volume), article}, lower);
  −
elseif utilities.is_set (article) then -- article number alone; when volume alone, handled below
  −
return wrap_msg ('art', {sepc, article}, lower);
  −
end
  −
end
     −
-- all other types of citation
+
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
−
if utilities.is_set (volume) and utilities.is_set (issue) then
+
table.insert( z.message_tail, { set_error('coauthors_missing_author', {}, true) } ); -- emit error message
−
return wrap_msg ('vol-no', {sepc, utilities.hyphen_to_dash (volume), issue}, lower);
  −
elseif utilities.is_set (volume) then
  −
return wrap_msg ('vol', {sepc, utilities.hyphen_to_dash (volume)}, lower);
  −
else
  −
return wrap_msg ('issue', {sepc, issue}, lower);
   
end
 
end
−
end
      +
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
 +
if not is_set(Editors) then
 +
local Maximum = A['DisplayEditors'];
   −
--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------
+
Maximum , editor_etal = get_display_authors_editors (Maximum, #e, 'editors', editor_etal);
 +
-- Preserve old-style implicit et al.
 +
if not is_set(Maximum) and #e == 4 then
 +
Maximum = 3;
 +
table.insert( z.message_tail, { set_error('implict_etal_editor', {}, true) } );
 +
end
   −
adds static text to one of |page(s)= or |sheet(s)= values and returns it with all of the others set to empty strings.
+
local control = {
−
The return order is:
+
format = NameListFormat, -- empty string or 'vanc'
−
page, pages, sheet, sheets
+
maximum = Maximum,
 +
lastauthoramp = LastAuthorAmp,
 +
page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn
 +
};
   −
Singular has priority over plural when both are provided.
+
Editors, EditorCount = list_people(control, e, editor_etal);
 +
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
 +
EditorCount = 2; -- spoof to display (eds.) annotation
 +
end
 +
else
 +
EditorCount = 1;
 +
end
   −
]]
+
-- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation,
 +
-- an error message if the associated url is not set, or an empty string for concatenation
 +
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
 +
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-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');
   −
local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
+
if  not is_set(URL) then --and
−
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
+
-- not is_set(ArchiveURL) then --and -- prevents format_missing_url error from registering
−
if utilities.is_set (sheet) then
+
-- not is_set(ConferenceURL) and -- TODO: keep this here? conference as part of cite web or cite podcast?
−
if 'journal' == origin then
+
-- not is_set(TranscriptURL) then -- TODO: remove? |transcript-url= and |transcript= has separate test
−
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
+
−
else
+
-- Test if cite web or cite podcast |url= is missing or empty
−
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
+
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then
−
end
+
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
−
elseif utilities.is_set (sheets) then
+
end
−
if 'journal' == origin then
+
−
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
+
-- Test if accessdate is given without giving a URL
−
else
+
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
−
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
+
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
−
end
+
AccessDate = '';
 
end
 
end
 
end
 
end
   −
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
+
local OriginalURL, OriginalFormat; -- TODO: swap chapter and title here so that archive applies to most specific if both are set?
−
+
DeadURL = DeadURL:lower(); -- used later when assembling archived text
−
if utilities.is_set (page) then
+
if is_set( ArchiveURL ) then
−
if is_journal then
+
if is_set (URL) then
−
return utilities.substitute (cfg.messages['j-page(s)'], page), '', '', '';
+
OriginalURL = URL; -- save copy of original source URL
−
elseif not nopp then
+
OriginalFormat = Format; -- and original |format=
−
return utilities.substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
+
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
−
else
+
URL = ArchiveURL -- swap-in the archive's url
−
return utilities.substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
+
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
−
end
+
Format = ArchiveFormat or ''; -- swap in archive's format
−
elseif utilities.is_set (pages) then
+
end
−
if is_journal then
+
elseif is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it
−
return utilities.substitute (cfg.messages['j-page(s)'], pages), '', '', '';
+
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
−
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
+
OriginalFormat = ChapterFormat; -- and original |format=
−
return '', utilities.substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
+
if 'no' ~= DeadURL then
−
elseif not nopp then
+
ChapterURL = ArchiveURL -- swap-in the archive's url
−
return '', utilities.substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
+
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
−
else
+
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
−
return '', utilities.substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
+
end
 
end
 
end
 
end
 
end
−
  −
return '', '', '', ''; -- return empty strings
  −
end
      +
if in_array(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup", 'arxiv'}) or
 +
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
 +
if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then -- chapter parameters not supported for these citation types
 +
table.insert( z.message_tail, { set_error( 'chapter_ignored', {}, true ) } ); -- add error message
 +
Chapter = ''; -- set to empty string to be safe with concatenation
 +
TransChapter = '';
 +
ChapterURL = '';
 +
end
 +
else -- otherwise, format chapter / article title
 +
Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);
 +
if is_set (Chapter) then
 +
if 'map' == config.CitationClass and is_set (TitleType) then
 +
Chapter = Chapter .. ' ' .. TitleType;
 +
end
 +
Chapter = Chapter .. ChapterFormat .. sepc .. ' ';
 +
end
 +
end
   −
--[[--------------------------< I N S O U R C E _ L O C _ G E T >----------------------------------------------
+
-- Format main title.
 +
if is_set(TitleLink) and is_set(Title) then
 +
Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
 +
end
   −
returns one of the in-source locators: page, pages, or at.  
+
if in_array(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup", "mailinglist", 'arxiv'}) 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
   −
If any of these are interwiki links to Wikisource, returns the label portion of the interwiki-link as plain text
+
TransError = "";
−
for use in COinS.  This COinS thing is done because here we convert an interwiki-link to an external link and
+
if is_set(TransTitle) then
−
add an icon span around that; get_coins_pages() doesn't know about the span.  TODO: should it? 
+
if is_set(Title) then
−
 
+
TransTitle = " " .. TransTitle;
−
TODO: add support for sheet and sheets?; streamline;
+
else
−
 
+
TransError = " " .. set_error( 'trans_missing_title' );
−
TODO: make it so that this function returns only one of the three as the single in-source (the return value assigned
  −
to a new name)?
  −
 
  −
]]
  −
 
  −
local function insource_loc_get (page, page_orig, pages, pages_orig, at)
  −
local ws_url, ws_label, coins_pages, L; -- for Wikisource interwiki-links; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
  −
 
  −
if utilities.is_set (page) then
  −
if utilities.is_set (pages) or utilities.is_set (at) then
  −
pages = ''; -- unset the others
  −
at = '';
   
end
 
end
−
extra_text_in_page_check (page, page_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
+
end
−
 
+
−
ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label
+
Title = Title .. TransTitle;
−
if ws_url then
+
−
page = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
+
if is_set(Title) then
−
page = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
+
if not is_set(TitleLink) and is_set(URL) then  
−
coins_pages = ws_label;
+
Title = external_link( URL, Title ) .. TransError .. Format;
 +
URL = "";
 +
Format = "";
 +
else
 +
Title = Title .. TransError;
 
end
 
end
−
elseif utilities.is_set (pages) then
+
end
−
if utilities.is_set (at) then
  −
at = ''; -- unset
  −
end
  −
extra_text_in_page_check (pages, pages_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
     −
ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label
+
if is_set(Place) then
−
if ws_url then
+
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
−
pages = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
  −
pages = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
  −
coins_pages = ws_label;
  −
end
  −
elseif utilities.is_set (at) then
  −
ws_url, ws_label, L = wikisource_url_make (at); -- make ws URL from |at= interwiki link; link portion L becomes tooltip label
  −
if ws_url then
  −
at = external_link (ws_url, ws_label .. '&nbsp;', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
  −
at = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
  −
coins_pages = ws_label;
  −
end
   
end
 
end
−
  −
return page, pages, at, coins_pages;
  −
end
  −
  −
--[[--------------------------< I S _ U N I Q U E _ A R C H I V E _ U R L >------------------------------------
  −
  −
add error message when |archive-url= value is same as |url= or chapter-url= (or alias...) value
  −
  −
]]
     −
local function is_unique_archive_url (archive, url, c_url, source, date)
+
if is_set (Conference) then
−
if utilities.is_set (archive) then
+
if is_set (ConferenceURL) then
−
if archive == url or archive == c_url then
+
Conference = external_link( ConferenceURL, Conference );
−
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)}); -- add error message
  −
return '', ''; -- unset |archive-url= and |archive-date= because same as |url= or |chapter-url=
   
end
 
end
 +
Conference = sepc .. " " .. Conference .. ConferenceFormat;
 +
elseif is_set(ConferenceURL) then
 +
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin );
 
end
 
end
   −
return archive, date;
+
if not is_set(Position) then
−
end
+
local Minutes = A['Minutes'];
−
 
+
if is_set(Minutes) then
−
 
+
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
−
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
+
else
−
 
+
local Time = A['Time'];
−
Check archive.org URLs to make sure they at least look like they are pointing at valid archives and not to the
+
if is_set(Time) then
−
save snapshot URL or to calendar pages.  When the archive URL is 'https://web.archive.org/save/' (or http://...)
+
local TimeCaption = A['TimeCaption']
−
archive.org saves a snapshot of the target page in the URL.  That is something that Wikipedia should not allow
+
if not is_set(TimeCaption) then
−
unwitting readers to do.
+
TimeCaption = cfg.messages['event'];
−
 
+
if sepc ~= '.' then
−
When the archive.org URL does not have a complete timestamp, archive.org chooses a snapshot according to its own
+
TimeCaption = TimeCaption:lower();
−
algorithm or provides a calendar 'search' result.  [[WP:ELNO]] discourages links to search results.
+
end
−
 
+
end
−
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
+
Position = " " .. TimeCaption .. " " .. Time;
−
|archive-date= and an error message when:
+
end
−
|archive-url= holds an archive.org save command URL
+
end
−
|archive-url= is an archive.org URL that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
+
else
−
correct place
+
Position = " " .. Position;
−
otherwise returns |archive-url= and |archive-date=
+
At = '';
−
 
+
end
−
There are two mostly compatible archive.org URLs:
  −
//web.archive.org/<timestamp>... -- the old form
  −
//web.archive.org/web/<timestamp>... -- the new form
  −
 
  −
The old form does not support or map to the new form when it contains a display flag.  There are four identified flags
  −
('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
  −
we don't check for these specific flags but we do check the form.
  −
 
  −
This function supports a preview mode.  When the article is rendered in preview mode, this function may return a modified
  −
archive URL:
  −
for save command errors, return undated wildcard (/*/)
  −
for timestamp errors when the timestamp has a wildcard, return the URL unmodified
  −
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)
  −
 
  −
A secondary function is to return an archive-url timestamp from those urls that have them (archive.org and
  −
archive.today). The timestamp is used by validation.archive_date_check() to see if the value in |archive-date=
  −
matches the timestamp in the archive url.
  −
 
  −
]=]
  −
 
  −
local function archive_url_check (url, date)
  −
local err_msg = ''; -- start with the error message empty
  −
local path, timestamp, flag; -- portions of the archive.org URL
   
 
−
timestamp = url:match ('//archive.today/(%d%d%d%d%d%d%d%d%d%d%d%d%d%d)/'); -- get timestamp from archive.today urls
+
if not is_set(Page) then
−
if timestamp then -- if this was an archive.today url ...
+
if is_set(Pages) then
−
return url, date, timestamp; -- return ArchiveURL, ArchiveDate, and timestamp from |archive-url=, and done
+
if is_set(Periodical) and
−
end
+
not in_array(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
−
-- here for archive.org urls
+
Pages = ": " .. Pages;
−
if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine URL
+
elseif tonumber(Pages) ~= nil then
−
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
+
Pages = sepc .." " .. PPrefix .. Pages;
 +
else
 +
Pages = sepc .." " .. PPPrefix .. Pages;
 +
end
 +
end
 +
else
 +
if is_set(Periodical) and
 +
not in_array(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
 +
Page = ": " .. Page;
 +
else
 +
Page = sepc .." " .. PPrefix .. Page;
 +
end
 
end
 
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  
+
if 'map' == config.CitationClass then -- cite map oddity done after COinS call (and with other in-source locators)
−
err_msg = cfg.err_msg_supl.save;
+
if is_set (Sheet) or is_set (Sheets) then
−
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
+
local err_msg1 = 'sheet=, &#124;sheets'; -- default error message in case any of page pages or at are set
−
elseif url:match('//liveweb%.archive%.org/') then
+
local err_msg2;
−
err_msg = cfg.err_msg_supl.liveweb;
+
if is_set (Page) or is_set (Pages) or is_set (At) then -- are any set?
−
else
+
err_msg2 = 'page=, &#124;pages=, &#124;at'; -- a generic error message
−
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation
+
Page = ''; Pages = ''; At = '';
−
if not path then -- malformed in some way; pattern did not match
+
elseif is_set (Sheet) and is_set (Sheets) then -- if both are set make error message
−
err_msg = cfg.err_msg_supl.timestamp;
+
err_msg1 = 'sheet';
−
elseif 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
+
err_msg2 = 'sheets';
−
err_msg = cfg.err_msg_supl.timestamp;
+
end
−
if '*' ~= flag then
+
if is_set (err_msg2) then
−
local replacement = timestamp:match ('^%d%d%d%d%d%d') or timestamp:match ('^%d%d%d%d'); -- get the first 6 (YYYYMM) or first 4 digits (YYYY)
+
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', err_msg1) .. ' and ' .. wrap_style ('parameter', err_msg2)}, true ) } ); -- add error message
−
if replacement then -- nil if there aren't at least 4 digits (year)
+
end
−
replacement = replacement .. string.rep ('0', 14 - replacement:len()); -- year or yearmo (4 or 6 digits) zero-fill to make 14-digit timestamp
+
if not is_set (Sheet) then -- do sheet static text and formatting; Sheet has priority over Sheets if both provided
−
url=url:gsub ('(//web%.archive%.org/[^%d]*)%d[^/]*', '%1' .. replacement .. '*', 1) -- for preview, modify ts to 14 digits plus splat for calendar display
+
if is_set (Sheets) then
 +
if is_set (Periodical) then
 +
Sheet = ": Sheets " .. Sheets; -- because Sheet has priority, no need to support both later on
 +
else
 +
Sheet = sepc .. " Sheets " .. Sheets;
 +
end
 +
end
 +
else
 +
if is_set (Periodical) then
 +
Sheet = ": Sheet " .. Sheet;
 +
else
 +
Sheet = sepc .. " Sheet " .. Sheet;
 
end
 
end
 
end
 
end
−
elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element
  −
err_msg = cfg.err_msg_supl.path;
  −
elseif utilities.is_set (flag) and not utilities.is_set (path) then -- flag not allowed with the old form URL (without the 'web/' path element)
  −
err_msg = cfg.err_msg_supl.flag;
  −
elseif utilities.is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
  −
err_msg = cfg.err_msg_supl.flag;
  −
else
  −
return url, date, timestamp; -- return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
   
end
 
end
 
end
 
end
−
-- if here, something not right so
  −
utilities.set_message ('err_archive_url', {err_msg}); -- add error message and
     −
if is_preview_mode then
+
At = is_set(At) and (sepc .. " " .. At) or "";
−
return url, date, timestamp; -- preview mode so return ArchiveURL, ArchiveDate, and timestamp from |archive-url=
+
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_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, this_page.namespace); -- format, categories (article namespace only), name from ISO639-1, etc
 
else
 
else
−
return '', ''; -- return empty strings for ArchiveURL and ArchiveDate
+
Language=""; -- language not specified so make sure this is an empty string;
 
end
 
end
−
end
      +
Others = is_set(Others) and (sepc .. " " .. Others) or "";
 +
 +
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
 +
Edition = is_set(Edition) and (" " .. wrap_msg ('edition', Edition)) or "";
 +
Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
 +
Series = is_set(Series) and (sepc .. " " .. Series) or "";
 +
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
 +
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
   −
--[[--------------------------< P L A C E _ C H E C K >--------------------------------------------------------
+
if is_set(Volume) then
 +
if ( mw.ustring.len(Volume) > 4 )
 +
  then Volume = sepc .." " .. Volume;
 +
  else Volume = " <b>" .. hyphen_to_dash(Volume) .. "</b>";
 +
end
 +
end
   −
check |place=, |publication-place=, |location= to see if these params include digits.  This function added because
+
------------------------------------ totally unrelated data
−
many editors misuse location to specify the in-source location (|page(s)= and |at= are supposed to do that)
+
if is_set(Via) then
 +
Via = " " .. wrap_msg ('via', Via);
 +
end
   −
returns the original parameter value without modification; added maint cat when parameter value contains digits
+
--[[
 +
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.
    
]]
 
]]
 +
if in_array(SubscriptionRequired:lower(), {'yes', 'true', 'y'}) then
 +
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
 +
elseif in_array(RegistrationRequired:lower(), {'yes', 'true', 'y'}) 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
   −
local function place_check (param_val)
+
if is_set(AccessDate) then
−
if not utilities.is_set (param_val) then -- parameter empty or omitted
+
local retrv_text = " " .. cfg.messages['retrieved']
−
return param_val; -- return that empty state
+
 
 +
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
 
end
 
 
−
if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
+
if is_set(ID) then ID = sepc .." ".. ID; end
−
utilities.set_message ('maint_location'); -- yep, add maint cat
+
  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
 
end
−
  −
return param_val; -- and done
  −
end
      +
ID_list = build_id_list( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} );
   −
--[[--------------------------< I S _ A R C H I V E D _ C O P Y >----------------------------------------------
+
if is_set(URL) then
 +
URL = " " .. external_link( URL, nil, URLorigin );
 +
end
   −
compares |title= to 'Archived copy' (placeholder added by bots that can't find proper title); if matches, return true; nil else
+
if is_set(Quote) then
−
 
+
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
−
]]
+
Quote = Quote:sub(2,-2);
 +
end
 +
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
 +
PostScript = ""; -- CS1 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 ) .. ArchiveFormat, ArchiveDate } );
 +
if not is_set(OriginalURL) then
 +
Archived = Archived .. " " .. set_error('archive_missing_url');  
 +
end
 +
elseif is_set(OriginalURL) then
 +
local arch_text = cfg.messages['archived-dead'];
 +
if sepc ~= "." then arch_text = arch_text:lower() end
 +
Archived = sepc .. " " .. substitute( arch_text,
 +
{ external_link( OriginalURL, cfg.messages['original'] ) .. OriginalFormat, ArchiveDate } ); -- format already styled
 +
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'] ) .. LayFormat .. LaySource .. LayDate
 +
else
 +
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower() ) .. 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
   −
local function is_archived_copy (title)
+
if is_set(Transcript) then
−
title = mw.ustring.lower(title); -- switch title to lower case
+
if is_set(TranscriptURL) then
−
if title:find (cfg.special_case_translation.archived_copy.en) then -- if title is 'Archived copy'
+
Transcript = external_link( TranscriptURL, Transcript );
−
return true;
  −
elseif cfg.special_case_translation.archived_copy['local'] then
  −
if mw.ustring.find (title, cfg.special_case_translation.archived_copy['local']) then -- mw.ustring() because might not be Latin script
  −
return true;
   
end
 
end
 +
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
 +
elseif is_set(TranscriptURL) then
 +
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin );
 
end
 
end
−
end
     −
 
+
local Publisher;
−
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
+
if is_set(Periodical) and
−
 
+
not in_array(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
−
This is the main function doing the majority of the citation formatting.
+
if is_set(PublisherName) then
−
 
+
if is_set(PublicationPlace) then
−
]]
+
Publisher = PublicationPlace .. ": " .. PublisherName;
−
 
+
else
−
local function citation0( config, args )
+
Publisher = PublisherName;
−
--[[
+
end
−
Load Input Parameters
+
elseif is_set(PublicationPlace) then
−
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
+
Publisher= PublicationPlace;
−
]]
+
else  
−
local A = argument_wrapper ( args );
+
Publisher = "";
−
local i
  −
 
  −
-- Pick out the relevant fields from the arguments. Different citation templates
  −
-- define different field names for the same underlying things.
  −
 
  −
local author_etal;
  −
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
  −
local Authors;
  −
local NameListStyle;
  −
if cfg.global_cs1_config_t['NameListStyle'] then -- global setting in {{cs1 config}} overrides local |name-list-style= parameter value; nil when empty or assigned value invalid
  −
NameListStyle = is_valid_parameter_value (cfg.global_cs1_config_t['NameListStyle'], 'cs1 config: name-list-style', cfg.keywords_lists['name-list-style'], ''); -- error messaging 'param' here is a hoax
  −
else
  −
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
   
end
 
end
−
 
+
if is_set(PublicationDate) then
−
if cfg.global_cs1_config_t['NameListStyle'] and utilities.is_set (A['NameListStyle']) then -- when template has |name-list-style=<something> which global setting has overridden
+
if is_set(Publisher) then
−
utilities.set_message ('maint_overridden_setting'); -- set a maint message
+
Publisher = Publisher .. ", " .. wrap_msg ('published', PublicationDate);
 +
else
 +
Publisher = PublicationDate;
 +
end
 
end
 
end
−
 
+
if is_set(Publisher) then
−
local Collaboration = A['Collaboration'];
+
Publisher = " (" .. Publisher .. ")";
−
 
  −
do -- to limit scope of selected
  −
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
  −
if 1 == selected then
  −
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
  −
elseif 2 == selected then
  −
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
  −
a, author_etal = parse_vauthors_veditors (args, A['Vauthors'], 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
  −
elseif 3 == selected then
  −
Authors = A['Authors']; -- use content of |authors=
  −
if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
  −
utilities.set_message ('maint_authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO:
  −
end
   
end
 
end
−
if utilities.is_set (Collaboration) then
+
else
−
author_etal = true; -- so that |display-authors=etal not required
+
if is_set(PublicationDate) then
 +
PublicationDate = " (" .. wrap_msg ('published', PublicationDate) .. ")";
 
end
 
end
−
end
+
if is_set(PublisherName) then
−
 
+
if is_set(PublicationPlace) then
−
local editor_etal;
+
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
−
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
+
else
−
 
+
Publisher = sepc .. " " .. PublisherName .. PublicationDate;
−
do -- to limit scope of selected
+
end
−
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
+
elseif is_set(PublicationPlace) then  
−
if 1 == selected then
+
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
−
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
+
else
−
elseif 2 == selected then
+
Publisher = PublicationDate;
−
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
  −
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
   
end
 
end
 
end
 
end
−
  −
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases
  −
local Chapter_origin = A:ORIGIN ('Chapter');
  −
local Contribution; -- because contribution is required for contributor(s)
  −
if 'contribution' == Chapter_origin then
  −
Contribution = Chapter; -- get the name of the contribution
  −
end
  −
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
   
 
−
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
+
-- Several of the above rely upon detecting this as nil, so do it last.
−
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
+
if is_set(Periodical) then
−
+
if is_set(Title) or is_set(TitleNote) then  
−
if 0 < #c then
+
Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)  
−
if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=
+
else
−
utilities.set_message ('err_contributor_missing_required_param', 'contribution'); -- add missing contribution error message
+
Periodical = wrap_style ('italic-title', Periodical)
−
c = {}; -- blank the contributors' table; it is used as a flag later
  −
end
  −
if 0 == #a then -- |contributor= requires |author=
  −
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
  −
c = {}; -- blank the contributors' table; it is used as a flag later
  −
end
   
end
 
end
−
else -- if not a book cite
  −
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
  −
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
  −
end
  −
Contribution = nil; -- unset
   
end
 
end
   −
local Title = A['Title'];
+
--[[
−
local TitleLink = A['TitleLink'];
+
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
−
 
+
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
−
local auto_select = ''; -- default is auto
+
]]
−
local accept_link;
+
if "speech" == config.CitationClass then -- cite speech only
−
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
+
TitleNote = " (Speech)"; -- annotate the citation
−
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
+
if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
−
auto_select = TitleLink; -- remember selection for later
+
if is_set (Conference) then -- and if |event= is set
−
TitleLink = ''; -- treat as if |title-link= would have been empty
+
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
 +
end
 +
end
 
end
 
end
   −
TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set
+
-- 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 Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
+
local tcommon
−
if 'map' == config.CitationClass and 'section' == Chapter_origin then
+
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
−
Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}}
+
if is_set(Others) then Others = Others .. sepc .. " " end
−
Chapter = ''; -- unset for now; will be reset later from |map= if present
+
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,
 +
Language, Edition, Publisher, Agency, Volume, Issue}, sepc );
 +
 +
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, Issue}, 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 -- all other CS1 templates
 +
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
 +
Volume, Issue, Others, Edition, Publisher, Agency}, sepc );
 
end
 
end
−
  −
local Periodical = A['Periodical'];
  −
local Periodical_origin = A:ORIGIN('Periodical');
  −
local ScriptPeriodical = A['ScriptPeriodical'];
  −
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
  −
local TransPeriodical =  A['TransPeriodical'];
  −
local TransPeriodical_origin =  A:ORIGIN ('TransPeriodical');
   
 
−
if (utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (ScriptPeriodical))) then
+
if #ID_list > 0 then
−
local param;
+
ID_list = safe_join( { sepc .. " ", table.concat( ID_list, sepc .. " " ), ID }, sepc );
−
if utilities.is_set (Periodical) then -- get a parameter name from one of these periodical related meta-parameters
+
else
−
Periodical = nil; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
+
ID_list = ID;
−
param = Periodical_origin -- get parameter name for error messaging
  −
elseif utilities.is_set (TransPeriodical) then
  −
TransPeriodical = nil; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
  −
param = TransPeriodical_origin; -- get parameter name for error messaging
  −
elseif utilities.is_set (ScriptPeriodical) then
  −
ScriptPeriodical = nil; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
  −
param = ScriptPeriodical_origin; -- get parameter name for error messaging
  −
end
  −
 
  −
if utilities.is_set (param) then -- if we found one
  −
utilities.set_message ('err_periodical_ignored', {param}); -- emit an error message
  −
end
   
end
 
end
−
 
+
−
if utilities.is_set (Periodical) then
+
local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
−
local i;
+
local text;
−
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
+
local pgtext = Position .. Sheet .. Page .. Pages .. At;
−
if i then -- non-zero when markup was stripped so emit an error message
+
−
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
+
if is_set(Authors) then
 +
if is_set(Coauthors) then
 +
local sep = '; ';
 +
if 'vanc' == NameListFormat then
 +
sep = ', ';
 +
end
 +
Authors = Authors .. sep .. Coauthors;
 
end
 
end
−
end
+
if is_set(Date) then
−
 
+
Date = " ("..Date..")" .. OrigYear .. sepc .. " "
−
if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
+
elseif string.sub(Authors,-1,-1) == sepc then
−
if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error TODO: make a function for this and similar?
+
Authors = Authors .. " "
−
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')});
+
else
 +
Authors = Authors .. sepc .. " "
 
end
 
end
−
 
+
if is_set(Editors) then
−
Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
+
local in_text = " ";
−
Periodical_origin = A:ORIGIN('MailingList');
+
local post_text = "";
−
end
+
if is_set(Chapter) then
−
 
+
in_text = in_text .. cfg.messages['in'] .. " "
−
-- web and news not tested for now because of
+
else
−
-- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
+
if EditorCount <= 1 then
−
if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
+
post_text = ", " .. cfg.messages['editor'];
−
-- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
+
else
−
local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
+
post_text = ", " .. cfg.messages['editors'];
−
if p[config.CitationClass]  then
+
end
−
utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]});
+
end
 +
if (sepc ~= '.') then in_text = in_text:lower() end
 +
Editors = in_text .. Editors .. post_text;
 +
if (string.sub(Editors,-1,-1) == sepc) or (string.sub(Editors,-3,-1) == sepc .. ']]') then -- if last editor name ends with sepc char
 +
Editors = Editors .. " "; -- don't add another
 +
else
 +
Editors = Editors .. sepc .. " " -- otherwise terninate the editor list
 +
end
 
end
 
end
−
end
+
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
−
+
text = safe_join( {text, pgtext, idcommon}, sepc );
−
local Volume;
+
elseif is_set(Editors) then
−
-- local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
+
if is_set(Date) then
−
if 'citation' == config.CitationClass then
+
if EditorCount <= 1 then
−
if utilities.is_set (Periodical) then
+
Editors = Editors .. ", " .. cfg.messages['editor'];
−
if not utilities.in_array (Periodical_origin, cfg.citation_no_volume_t) then -- {{citation}} does not render |volume= when these parameters are used
+
else
−
Volume = A['Volume']; -- but does for all other 'periodicals'
+
Editors = Editors .. ", " .. cfg.messages['editors'];
−
end
  −
elseif utilities.is_set (ScriptPeriodical) then
  −
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
  −
Volume = A['Volume']; -- but does for all other 'periodicals'
   
end
 
end
 +
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
 
else
 
else
−
Volume = A['Volume']; -- and does for non-'periodical' cites
+
if EditorCount <= 1 then
−
end
+
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
−
elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
+
else
−
Volume = A['Volume'];
+
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
−
end
+
end
−
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');
+
end
−
 
+
text = safe_join( {Editors, Date, Chapter, Place, tcommon}, sepc );
−
local Issue;
+
text = safe_join( {text, pgtext, idcommon}, sepc );
−
if 'citation' == config.CitationClass then
+
else
−
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, cfg.citation_issue_t) then -- {{citation}} may render |issue= when these parameters are used
+
if is_set(Date) then
−
Issue = utilities.hyphen_to_dash (A['Issue']);
+
if ( string.sub(tcommon,-1,-1) ~= sepc )
 +
  then Date = sepc .." " .. Date .. OrigYear
 +
  else Date = " " .. Date .. OrigYear
 +
end
 
end
 
end
−
elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
+
if config.CitationClass=="journal" and is_set(Periodical) then
−
if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
+
text = safe_join( {Chapter, Place, tcommon}, sepc );
−
Issue = utilities.hyphen_to_dash (A['Issue']);
+
text = safe_join( {text, pgtext, Date, idcommon}, sepc );
 +
else
 +
text = safe_join( {Chapter, Place, tcommon, Date}, sepc );
 +
text = safe_join( {text, pgtext, idcommon}, sepc );
 
end
 
end
 
end
 
end
 
 
−
local ArticleNumber;
+
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 );
   −
if utilities.in_array (config.CitationClass, {'journal', 'conference'}) or ('citation' == config.CitationClass and utilities.is_set (Periodical) and 'journal' == Periodical_origin) then
+
-- Now enclose the whole thing in a <span/> element
−
ArticleNumber = A['ArticleNumber'];
+
local options = {};
 +
 +
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
 +
options.class = "citation " .. config.CitationClass;
 +
else
 +
options.class = "citation";
 
end
 
end
−
  −
extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');
  −
  −
local Page;
  −
local Pages;
  −
local At;
  −
local QuotePage;
  −
local QuotePages;
  −
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then -- TODO: rewrite to emit ignored parameter error message?
  −
Page = A['Page'];
  −
Pages = utilities.hyphen_to_dash (A['Pages']);
  −
At = A['At'];
  −
QuotePage = A['QuotePage'];
  −
QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
  −
end
  −
  −
local Edition = A['Edition'];
  −
local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
  −
local Place = place_check (A['Place'], A:ORIGIN('Place'));
   
 
−
local PublisherName = A['PublisherName'];
+
if is_set(Ref) and Ref:lower() ~= "none" then
−
local PublisherName_origin = A:ORIGIN('PublisherName');
+
local id = Ref
−
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then
+
if ( "harv" == Ref ) then
−
local i = 0;
+
local names = {} --table of last names & year
−
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized
+
if #a > 0 then
−
if i and (0 < i) then -- non-zero when markup was stripped so emit an error message
+
for i,v in ipairs(a) do
−
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
+
names[i] = v.last
 +
if i == 4 then break end
 +
end
 +
elseif #e > 0 then
 +
for i,v in ipairs(e) do
 +
names[i] = v.last
 +
if i == 4 then break end
 +
end
 +
end
 +
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations and for YMD dates that require disambiguation
 +
id = anchor_id(names)
 
end
 
end
 +
options.id = id;
 
end
 
end
 
 
−
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then
+
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
−
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'});
+
z.error_categories = {};
 +
text = set_error('empty_citation');
 +
z.message_tail = {};
 
end
 
end
 +
 +
if is_set(options.id) then
 +
text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
 +
else
 +
text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
 +
end
   −
local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
+
local empty_span = '<span style="display:none;">&nbsp;</span>';
−
local Newsgroup_origin = A:ORIGIN('Newsgroup');
+
−
 
+
-- Note: Using display: none on then COinS span breaks some clients.
−
if 'newsgroup' == config.CitationClass then
+
local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
−
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
+
text = text .. OCinS;
−
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
+
 +
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
−
  −
PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
   
end
 
end
   −
local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL?
+
if #z.maintenance_cats ~= 0 then
−
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
+
text = text .. ' <span class="citation-comment" style="display:none; color:#33aa33">';
−
+
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
−
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then
+
text = text .. v .. ' ([[:Category:' .. v ..'|link]])';
−
UrlAccess = nil;
+
end
−
utilities.set_message ('err_param_access_requires_param', 'url');
+
text = text .. '</span>'; -- maintenance mesages (realy just the names of the categories for now)
 
end
 
end
 
 
−
local ChapterURL = A['ChapterURL'];
+
no_tracking_cats = no_tracking_cats:lower();
−
local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
+
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
−
if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then
+
for _, v in ipairs( z.error_categories ) do
−
ChapterUrlAccess = nil;
+
text = text .. '[[Category:' .. v ..']]';
−
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')});
+
end
−
end
+
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
−
 
+
text = text .. '[[Category:' .. v ..']]';
−
local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
  −
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then
  −
MapUrlAccess = nil;
  −
utilities.set_message ('err_param_access_requires_param', {'map-url'});
  −
end
  −
 
  −
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
  −
local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
  −
 
  −
-- check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
  −
if not utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
  −
if cfg.uncategorized_namespaces[this_page.namespace] then -- is this page's namespace id one of the uncategorized namespace ids?
  −
no_tracking_cats = "true"; -- set no_tracking_cats
   
end
 
end
−
for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
+
for _, v in ipairs( z.properties_cats ) do -- append maintenance categories
−
if this_page.text:match (v) then -- test page name against each pattern
+
text = text .. '[[Category:' .. v ..']]';
−
no_tracking_cats = "true"; -- set no_tracking_cats
  −
break; -- bail out if one is found
  −
end
   
end
 
end
 
end
 
end
−
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
+
−
utilities.select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'err_redundant_parameters'); -- this is a dummy call simply to get the error message and category
+
return text
 +
end
   −
local coins_pages;
+
-- 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;
 
 
−
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);
+
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
   −
local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);
+
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
   −
if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
+
dates = validation.dates; -- imported functions
−
utilities.add_prop_cat ('location-test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
+
year_date_check = validation.year_date_check;
−
if PublicationPlace == Place then
  −
Place = ''; -- unset; don't need both if they are the same
  −
end
  −
elseif not utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- when only |place= (|location=) is set ...
  −
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
  −
end
     −
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
+
local args = {};
 +
local suggestions = {};
 +
local error_text, error_state;
   −
local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
+
local config = {};
−
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
+
for k, v in pairs( frame.args ) do
−
local ScriptChapter = A['ScriptChapter'];
  −
local ScriptChapter_origin = A:ORIGIN ('ScriptChapter');
  −
local Format = A['Format'];
  −
local ChapterFormat = A['ChapterFormat'];
  −
local TransChapter = A['TransChapter'];
  −
local TransChapter_origin = A:ORIGIN ('TransChapter');
  −
local TransTitle = A['TransTitle'];
  −
local ScriptTitle = A['ScriptTitle'];
  −
  −
--[[
  −
Parameter remapping for cite encyclopedia:
  −
When the citation has these parameters:
  −
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= for rendering
  −
|encyclopedia= and |article= then map |encyclopedia= to |title= for rendering
  −
 
  −
|trans-title= maps to |trans-chapter= when |title= is re-mapped
  −
|url= maps to |chapter-url= when |title= is remapped
  −
  −
All other combinations of |encyclopedia=, |title=, and |article= are not modified
  −
  −
]]
  −
 
  −
local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
  −
 
  −
if utilities.is_set (Encyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
  −
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
  −
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
  −
Encyclopedia = nil; -- unset because not supported by this template
  −
end
  −
end
  −
 
  −
if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
  −
if utilities.is_set (Periodical) and utilities.is_set (Encyclopedia) then -- when both parameters set emit an error message; {{citation}} only; Periodical not allowed in {{cite encyclopedia}}
  −
utilities.set_message ('err_periodical_ignored', {Periodical_origin});
  −
end
  −
 
  −
if utilities.is_set (Encyclopedia) then
  −
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia
  −
Periodical_origin = A:ORIGIN ('Encyclopedia');
  −
 
  −
if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then
  −
if not utilities.is_set (Chapter) then
  −
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= to |article= and |encyclopedia= to |title= for rendering
  −
ScriptChapter = ScriptTitle;
  −
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
  −
TransChapter = TransTitle;
  −
ChapterURL = URL;
  −
ChapterURL_origin = URL_origin;
  −
 
  −
ChapterUrlAccess = UrlAccess;
  −
 
  −
if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then
  −
Chapter = utilities.make_wikilink (TitleLink, Chapter);
  −
end
  −
Title = Periodical;
  −
ChapterFormat = Format;
  −
Periodical = ''; -- redundant so unset
  −
TransTitle = '';
  −
URL = '';
  −
Format = '';
  −
TitleLink = '';
  −
ScriptTitle = '';
  −
end
  −
elseif utilities.is_set (Chapter) or utilities.is_set (ScriptChapter) then -- |title= not set
  −
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= for rendering
  −
Periodical = ''; -- redundant so unset
  −
end
  −
end
  −
end
  −
 
  −
-- special case for cite techreport.
  −
local ID = A['ID'];
  −
if (config.CitationClass == "techreport") then -- special case for cite techreport
  −
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
  −
if not utilities.is_set (ID) then -- can we use ID for the "number"?
  −
ID = A['Number']; -- yes, use it
  −
else -- ID has a value so emit error message
  −
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'number')});
  −
end
  −
end
  −
end
  −
 
  −
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
  −
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
  −
local Conference = A['Conference'];
  −
local BookTitle = A['BookTitle'];
  −
local TransTitle_origin = A:ORIGIN ('TransTitle');
  −
if 'conference' == config.CitationClass then
  −
if utilities.is_set (BookTitle) then
  −
Chapter = Title;
  −
Chapter_origin = 'title';
  −
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
  −
ChapterURL = URL;
  −
ChapterUrlAccess = UrlAccess;
  −
ChapterURL_origin = URL_origin;
  −
URL_origin = '';
  −
ChapterFormat = Format;
  −
TransChapter = TransTitle;
  −
TransChapter_origin = TransTitle_origin;
  −
Title = BookTitle;
  −
Format = '';
  −
-- TitleLink = '';
  −
TransTitle = '';
  −
URL = '';
  −
end
  −
elseif 'speech' ~= config.CitationClass then
  −
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
  −
end
  −
  −
-- CS1/2 mode
  −
local Mode;
  −
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}} overrides local |mode= parameter value; nil when empty or assigned value invalid
  −
Mode = is_valid_parameter_value (cfg.global_cs1_config_t['Mode'], 'cs1 config: mode', cfg.keywords_lists['mode'], ''); -- error messaging 'param' here is a hoax
  −
else
  −
Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], '');
  −
end
  −
 
  −
if cfg.global_cs1_config_t['Mode'] and utilities.is_set (A['Mode']) then -- when template has |mode=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
-- separator character and postscript
  −
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
  −
-- controls capitalization of certain static text
  −
local use_lowercase = ( sepc == ',' );
  −
  −
-- cite map oddities
  −
local Cartography = "";
  −
local Scale = "";
  −
local Sheet = A['Sheet'] or '';
  −
local Sheets = A['Sheets'] or '';
  −
if config.CitationClass == "map" then
  −
if utilities.is_set (Chapter) then --TODO: make a function for this and similar?
  −
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'map') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', Chapter_origin)}); -- add error message
  −
end
  −
Chapter = A['Map'];
  −
Chapter_origin = A:ORIGIN('Map');
  −
ChapterURL = A['MapURL'];
  −
ChapterURL_origin = A:ORIGIN('MapURL');
  −
TransChapter = A['TransMap'];
  −
ScriptChapter = A['ScriptMap']
  −
ScriptChapter_origin = A:ORIGIN('ScriptMap')
  −
 
  −
ChapterUrlAccess = MapUrlAccess;
  −
ChapterFormat = A['MapFormat'];
  −
 
  −
Cartography = A['Cartography'];
  −
if utilities.is_set ( Cartography ) then
  −
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
  −
end
  −
Scale = A['Scale'];
  −
if utilities.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.
  −
local Series = A['Series'];
  −
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
  −
local SeriesLink = A['SeriesLink'];
  −
 
  −
SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set
  −
 
  −
local Network = A['Network'];
  −
local Station = A['Station'];
  −
local s, n = {}, {};
  −
-- do common parameters first
  −
if utilities.is_set (Network) then table.insert(n, Network); end
  −
if utilities.is_set (Station) then table.insert(n, Station); end
  −
ID = table.concat(n, sepc .. ' ');
  −
  −
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
  −
local Season = A['Season'];
  −
local SeriesNumber = A['SeriesNumber'];
  −
 
  −
if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set TODO: make a function for this and similar?
  −
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
  −
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
  −
end
  −
-- assemble a table of parts concatenated later into Series
  −
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
  −
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
  −
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
  −
Issue = ''; -- unset because this is not a unique parameter
  −
  −
Chapter = Title; -- promote title parameters to chapter
  −
ScriptChapter = ScriptTitle;
  −
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
  −
ChapterLink = TitleLink; -- alias |episode-link=
  −
TransChapter = TransTitle;
  −
ChapterURL = URL;
  −
ChapterUrlAccess = UrlAccess;
  −
ChapterURL_origin = URL_origin;
  −
ChapterFormat = Format;
  −
 
  −
Title = Series; -- promote series to title
  −
TitleLink = SeriesLink;
  −
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
  −
 
  −
if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL
  −
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
  −
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode;
  −
Series = utilities.make_wikilink (ChapterLink, Series);
  −
end
  −
URL = ''; -- unset
  −
TransTitle = '';
  −
ScriptTitle = '';
  −
Format = '';
  −
  −
else -- now oddities that are cite serial
  −
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
  −
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
  −
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
  −
Series = utilities.make_wikilink (SeriesLink, Series);
  −
end
  −
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
  −
end
  −
end
  −
-- end of {{cite episode}} stuff
  −
 
  −
-- handle type parameter for those CS1 citations that have default values
  −
local TitleType = A['TitleType'];
  −
local Degree = A['Degree'];
  −
if utilities.in_array (config.CitationClass, {'AV-media-notes', 'document', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
  −
TitleType = set_titletype (config.CitationClass, TitleType);
  −
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
  −
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
  −
end
  −
end
  −
 
  −
if utilities.is_set (TitleType) then -- if type parameter is specified
  −
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
  −
-- TODO: Hack on TitleType to fix bunched parentheses problem
  −
end
  −
 
  −
-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
  −
local Date = A['Date'];
  −
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
  −
local PublicationDate = A['PublicationDate'];
  −
local Year = A['Year'];
  −
 
  −
if not utilities.is_set (Date) then
  −
Date = Year; -- promote Year to Date
  −
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
  −
if not utilities.is_set (Date) and utilities.is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
  −
Date = PublicationDate; -- promote PublicationDate to Date
  −
PublicationDate = ''; -- unset, no longer needed
  −
Date_origin = A:ORIGIN('PublicationDate'); -- save the name of the promoted parameter
  −
else
  −
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter
  −
end
  −
else
  −
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging
  −
end
  −
 
  −
if PublicationDate == Date then PublicationDate = ''; 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 dates. This must be done before we do COinS because here is where
  −
we get the date used in the metadata.
  −
  −
Date validation supporting code is in Module:Citation/CS1/Date_validation
  −
]]
  −
 
  −
local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
  −
if not utilities.is_set (DF) then
  −
DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template
  −
end
  −
 
  −
local ArchiveURL;
  −
local ArchiveDate;
  −
local ArchiveFormat = A['ArchiveFormat'];
  −
local archive_url_timestamp; -- timestamp from wayback machine url
  −
  −
ArchiveURL, ArchiveDate, archive_url_timestamp = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
  −
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
  −
  −
ArchiveURL, ArchiveDate = is_unique_archive_url (ArchiveURL, URL, ChapterURL, A:ORIGIN('ArchiveURL'), ArchiveDate); -- add error message when URL or ChapterURL == ArchiveURL
  −
 
  −
local AccessDate = A['AccessDate'];
  −
-- local LayDate = A['LayDate'];
  −
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
  −
local DoiBroken = A['DoiBroken'];
  −
local Embargo = A['Embargo'];
  −
local anchor_year; -- used in the CITEREF identifier
  −
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
  −
local error_message = '';
  −
-- AirDate has been promoted to Date so not necessary to check it
  −
local date_parameters_list = {
  −
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
  −
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
  −
['date'] = {val = Date, name = Date_origin},
  −
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
  −
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
  −
-- ['lay-date'] = {val = LayDate, name = A:ORIGIN ('LayDate')},
  −
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')},
  −
['year'] = {val = Year, name = A:ORIGIN ('Year')},
  −
};
  −
 
  −
local error_list = {};
  −
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);
  −
 
  −
-- start temporary Julian / Gregorian calendar uncertainty categorization
  −
if COinS_date.inter_cal_cat then
  −
utilities.add_prop_cat ('jul-greg-uncertainty');
  −
end
  −
-- end temporary Julian / Gregorian calendar uncertainty categorization
  −
 
  −
if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;
  −
validation.year_date_check (Year, A:ORIGIN ('Year'), Date, A:ORIGIN ('Date'), error_list);
  −
end
  −
  −
if 0 == #error_list then -- error free dates only; 0 when error_list is empty
  −
local modified = false; -- flag
  −
  −
if utilities.is_set (DF) then -- if we need to reformat dates
  −
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
  −
end
  −
 
  −
if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
  −
modified = true;
  −
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category
  −
end
  −
  −
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki
  −
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
  −
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
  −
modified = true;
  −
end
  −
 
  −
if modified then -- if the date_parameters_list values were modified
  −
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values
  −
ArchiveDate = date_parameters_list['archive-date'].val;
  −
Date = date_parameters_list['date'].val;
  −
DoiBroken = date_parameters_list['doi-broken-date'].val;
  −
-- LayDate = date_parameters_list['lay-date'].val;
  −
PublicationDate = date_parameters_list['publication-date'].val;
  −
end
  −
 
  −
if archive_url_timestamp and utilities.is_set (ArchiveDate) then
  −
validation.archive_date_check (ArchiveDate, archive_url_timestamp); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate
  −
end
  −
else
  −
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message
  −
end
  −
end -- end of do
  −
 
  −
if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others?
  −
('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) or -- {{citation}} as an encylopedia citation
  −
('citation' == config.CitationClass and not utilities.is_set (Periodical)) then -- {{citation}} as a book citation
  −
if utilities.is_set (PublicationPlace) then
  −
if not utilities.is_set (PublisherName) then
  −
local date = COinS_date.rftdate and tonumber (COinS_date.rftdate:match ('%d%d%d%d')); -- get year portion of COinS date (because in Arabic numerals); convert string to number
  −
if date and (1850 <= date) then -- location has no publisher; if date is 1850 or later
  −
utilities.set_message ('maint_location_no_publisher'); -- add maint cat
  −
end
  −
else -- PublisherName has a value
  −
if cfg.keywords_xlate['none'] == PublisherName then -- if that value is 'none' (only for book and encyclopedia citations)
  −
PublisherName = ''; -- unset
  −
end
  −
end
  −
end
  −
end
  −
 
  −
local ID_list = {}; -- sequence table of rendered identifiers
  −
local ID_list_coins = {}; -- table of identifiers and their values from args; key is same as cfg.id_handlers's key
  −
local Class = A['Class']; -- arxiv class identifier
  −
  −
local ID_support = {
  −
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
  −
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
  −
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
  −
}
  −
 
  −
ID_list, ID_list_coins = identifiers.identifier_lists_get (args, {DoiBroken = DoiBroken, ASINTLD = A['ASINTLD'], Embargo = Embargo, Class = Class}, ID_support);
  −
 
  −
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, {{cite ssrn}}, before generation of COinS data.
  −
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv=, |citeseerx=, |medrxiv=, |ssrn= required for their templates
  −
if not (args[cfg.id_handlers[config.CitationClass:upper()].parameters[1]] or -- can't use ID_list_coins k/v table here because invalid parameters omitted
  −
args[cfg.id_handlers[config.CitationClass:upper()].parameters[2]]) then -- which causes unexpected parameter missing error message
  −
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
  −
end
  −
 
  −
Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['medrxiv'] = 'medRxiv', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
  −
end
  −
 
  −
-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free
  −
 
  −
if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead
  −
if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled
  −
if identifiers.auto_link_urls[auto_select] then -- manual selection
  −
URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link
  −
URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
  −
elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC
  −
URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed
  −
URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
  −
elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI
  −
URL = identifiers.auto_link_urls['doi'];
  −
URL_origin = cfg.id_handlers['DOI'].parameters[1];
  −
end
  −
end
  −
 
  −
if utilities.is_set (URL) then -- set when using an identifier-created URL
  −
if utilities.is_set (AccessDate) then -- |access-date= requires |url=; identifier-created URL is not |url=
  −
utilities.set_message ('err_accessdate_missing_url'); -- add an error message
  −
AccessDate = ''; -- unset
  −
end
  −
 
  −
if utilities.is_set (ArchiveURL) then -- |archive-url= requires |url=; identifier-created URL is not |url=
  −
utilities.set_message ('err_archive_missing_url'); -- add an error message
  −
ArchiveURL = ''; -- unset
  −
end
  −
end
  −
end
  −
 
  −
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
  −
-- Test if citation has no title
  −
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
  −
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
  −
end
  −
 
  −
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
  −
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
  −
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and
  −
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
  −
Title = ''; -- set title to empty string
  −
utilities.set_message ('maint_untitled'); -- add maint cat
  −
end
  −
 
  −
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
  −
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
  −
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
  −
-- is the article title, and Chapter is a section within the article.  So, we remap
  −
  −
local coins_chapter = Chapter; -- default assuming that remapping not required
  −
local coins_title = Title; -- et tu
  −
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
  −
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then
  −
coins_chapter = Title; -- remap
  −
coins_title = Periodical;
  −
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 OCinSoutput = metadata.COinS({
  −
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
  −
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
  −
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
  −
['Degree'] = Degree; -- cite thesis only
  −
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
  −
['PublicationPlace'] = PublicationPlace,
  −
['Date'] = COinS_date.rftdate, -- COinS_date.* has correctly formatted date values if Date is valid;
  −
['Season'] = COinS_date.rftssn,
  −
['Quarter'] = COinS_date.rftquarter,
  −
['Chron'] =  COinS_date.rftchron,
  −
['Series'] = Series,
  −
['Volume'] = Volume,
  −
['Issue'] = Issue,
  −
['ArticleNumber'] = ArticleNumber,
  −
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
  −
['Edition'] = Edition,
  −
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
  −
['URL'] = first_set ({ChapterURL, URL}, 2),
  −
['Authors'] = coins_author,
  −
['ID_list'] = ID_list_coins,
  −
['RawPage'] = this_page.prefixedText,
  −
}, config.CitationClass);
  −
 
  −
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, and {{cite ssrn}} AFTER generation of COinS data.
  −
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, medRxiv, or ssrn now unset so it isn't displayed
  −
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
  −
end
  −
 
  −
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
  −
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
  −
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
  −
end
  −
 
  −
local Editors;
  −
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
  −
local Contributors; -- assembled contributors name list
  −
local contributor_etal;
  −
local Translators; -- assembled translators name list
  −
local translator_etal;
  −
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
  −
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
  −
local Interviewers;
  −
local interviewers_list = {};
  −
interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters
  −
local interviewer_etal;
  −
  −
-- Now perform various field substitutions.
  −
-- We also add leading spaces and surrounding markup and punctuation to the
  −
-- various parts of the citation, but only when they are non-nil.
  −
do
  −
local last_first_list;
  −
local control = {
  −
format = NameListStyle, -- empty string, '&', 'amp', 'and', or 'vanc'
  −
maximum = nil, -- as if display-authors or display-editors not set
  −
mode = Mode
  −
};
  −
 
  −
do -- do editor name list first because the now unsupported coauthors used to modify control table
  −
if cfg.global_cs1_config_t['DisplayEditors'] then -- global setting from {{cs1 config}} overrides local setting
  −
control.maximum , editor_etal = get_display_names (cfg.global_cs1_config_t['DisplayEditors'], #e, 'editors', editor_etal, 'cs1 config');
  −
else
  −
control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal, A:ORIGIN ('DisplayEditors'));
  −
end
  −
 
  −
if cfg.global_cs1_config_t['DisplayEditors'] and utilities.is_set (A['DisplayEditors']) then -- when template has |display-editors=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
Editors, EditorCount = list_people (control, e, editor_etal);
  −
 
  −
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
  −
EditorCount = 2; -- spoof to display (eds.) annotation
  −
end
  −
end
  −
do -- now do interviewers
  −
if cfg.global_cs1_config_t['DisplayInterviewers'] then -- global setting from {{cs1 config}} overrides local setting
  −
control.maximum, interviewer_etal = get_display_names (cfg.global_cs1_config_t['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal, 'cs1 config');
  −
else
  −
control.maximum, interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal, A:ORIGIN ('DisplayInterviewers'));
  −
end
  −
 
  −
if cfg.global_cs1_config_t['DisplayInterviewers'] and utilities.is_set (A['DisplayInterviewers']) then -- when template has |display-interviewers=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
Interviewers = list_people (control, interviewers_list, interviewer_etal);
  −
end
  −
do -- now do translators
  −
if cfg.global_cs1_config_t['DisplayTranslators'] then -- global setting from {{cs1 config}} overrides local setting
  −
control.maximum, translator_etal = get_display_names (cfg.global_cs1_config_t['DisplayTranslators'], #t, 'translators', translator_etal, 'cs1 config');
  −
else
  −
control.maximum, translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal, A:ORIGIN ('DisplayTranslators'));
  −
end
  −
 
  −
if cfg.global_cs1_config_t['DisplayTranslators'] and utilities.is_set (A['DisplayTranslators']) then -- when template has |display-translators=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
Translators = list_people (control, t, translator_etal);
  −
end
  −
do -- now do contributors
  −
if cfg.global_cs1_config_t['DisplayContributors'] then -- global setting from {{cs1 config}} overrides local setting
  −
control.maximum, contributor_etal = get_display_names (cfg.global_cs1_config_t['DisplayContributors'], #c, 'contributors', contributor_etal, 'cs1 config');
  −
else
  −
control.maximum, contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal, A:ORIGIN ('DisplayContributors'));
  −
end
  −
 
  −
if cfg.global_cs1_config_t['DisplayContributors'] and utilities.is_set (A['DisplayContributors']) then -- when template has |display-contributors=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
Contributors = list_people (control, c, contributor_etal);
  −
end
  −
do -- now do authors
  −
if cfg.global_cs1_config_t['DisplayAuthors'] then -- global setting from {{cs1 config}} overrides local setting
  −
control.maximum, author_etal = get_display_names (cfg.global_cs1_config_t['DisplayAuthors'], #a, 'authors', author_etal, 'cs1 config');
  −
else
  −
control.maximum, author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal, A:ORIGIN ('DisplayAuthors'));
  −
end
  −
 
  −
if cfg.global_cs1_config_t['DisplayAuthors'] and utilities.is_set (A['DisplayAuthors']) then -- when template has |display-authors=<something> which global setting has overridden
  −
utilities.set_message ('maint_overridden_setting'); -- set a maint message
  −
end
  −
 
  −
last_first_list = list_people (control, a, author_etal);
  −
 
  −
if utilities.is_set (Authors) then
  −
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
  −
if author_etal then
  −
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter
  −
end
  −
else
  −
Authors = last_first_list; -- either an author name list or an empty string
  −
end
  −
end -- end of do
  −
  −
if utilities.is_set (Authors) and utilities.is_set (Collaboration) then
  −
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
  −
end
  −
 
  −
end
  −
 
  −
local ConferenceFormat = A['ConferenceFormat'];
  −
local ConferenceURL = A['ConferenceURL'];
  −
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
  −
Format = style_format (Format, URL, 'format', 'url');
  −
 
  −
-- special case for chapter format so no error message or cat when chapter not supported
  −
if not (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or
  −
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia))) then
  −
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
  −
end
  −
 
  −
if not utilities.is_set (URL) then
  −
if utilities.in_array (config.CitationClass, {"web", "podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist
  −
('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website=
  −
utilities.set_message ('err_cite_web_url');
  −
end
  −
  −
-- do we have |accessdate= without either |url= or |chapter-url=?
  −
if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set;
  −
utilities.set_message ('err_accessdate_missing_url');
  −
AccessDate = '';
  −
end
  −
end
  −
 
  −
local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');
  −
local OriginalURL
  −
local OriginalURL_origin
  −
local OriginalFormat
  −
local OriginalAccess;
  −
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
  −
if utilities.is_set ( ArchiveURL ) then
  −
if utilities.is_set (ChapterURL) then -- if chapter-url= is set apply archive url to it
  −
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
  −
OriginalURL_origin = ChapterURL_origin; -- name of |chapter-url= parameter for error messages
  −
OriginalFormat = ChapterFormat; -- and original |chapter-format=
  −
 
  −
if 'live' ~= UrlStatus then
  −
ChapterURL = ArchiveURL -- swap-in the archive's URL
  −
ChapterURL_origin = A:ORIGIN('ArchiveURL') -- name of |archive-url= parameter for error messages
  −
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
  −
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs
  −
end
  −
elseif utilities.is_set (URL) then
  −
OriginalURL = URL; -- save copy of original source URL
  −
OriginalURL_origin = URL_origin; -- name of URL parameter for error messages
  −
OriginalFormat = Format; -- and original |format=
  −
OriginalAccess = UrlAccess;
  −
 
  −
if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it
  −
URL = ArchiveURL -- swap-in the archive's URL
  −
URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages
  −
Format = ArchiveFormat or ''; -- swap in archive's format
  −
UrlAccess = nil; -- restricted access levels do not make sense for archived URLs
  −
end
  −
end
  −
elseif utilities.is_set (UrlStatus) then -- if |url-status= is set when |archive-url= is not set
  −
utilities.set_message ('maint_url_status'); -- add maint cat
  −
end
  −
 
  −
if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
  −
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) then
  −
local chap_param;
  −
if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
  −
chap_param = A:ORIGIN ('Chapter')
  −
elseif utilities.is_set (TransChapter) then
  −
chap_param = A:ORIGIN ('TransChapter')
  −
elseif utilities.is_set (ChapterURL) then
  −
chap_param = A:ORIGIN ('ChapterURL')
  −
elseif utilities.is_set (ScriptChapter) then
  −
chap_param = ScriptChapter_origin;
  −
else utilities.is_set (ChapterFormat)
  −
chap_param = A:ORIGIN ('ChapterFormat')
  −
end
  −
 
  −
if utilities.is_set (chap_param) then -- if we found one
  −
utilities.set_message ('err_chapter_ignored', {chap_param}); -- add error message
  −
Chapter = ''; -- and set them to empty string to be safe with concatenation
  −
TransChapter = '';
  −
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
  −
if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
  −
if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
  −
no_quotes = true; -- then render it unquoted
  −
end
  −
end
  −
 
  −
Chapter = format_chapter_title (ScriptChapter, ScriptChapter_origin, Chapter, Chapter_origin, TransChapter, TransChapter_origin, ChapterURL, ChapterURL_origin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
  −
if utilities.is_set (Chapter) then
  −
Chapter = Chapter .. ChapterFormat ;
  −
if 'map' == config.CitationClass and utilities.is_set (TitleType) then
  −
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
  −
end
  −
Chapter = Chapter .. sepc .. ' ';
  −
elseif utilities.is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ...
  −
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it
  −
end
  −
end
  −
 
  −
-- Format main title
  −
local plain_title = false;
  −
local accept_title;
  −
Title, accept_title = utilities.has_accept_as_written (Title, true); -- remove accept-this-as-written markup when it wraps all of <Title>
  −
if accept_title and ('' == Title) then -- only support forced empty for now "(())"
  −
Title = cfg.messages['notitle']; -- replace by predefined "No title" message
  −
-- TODO: utilities.set_message ( 'err_redundant_parameters', ...); -- issue proper error message instead of muting
  −
ScriptTitle = ''; -- just mute for now
  −
TransTitle = ''; -- just mute for now
  −
plain_title = true; -- suppress text decoration for descriptive title
  −
utilities.set_message ('maint_untitled'); -- add maint cat
  −
end
  −
 
  −
if not accept_title then -- <Title> not wrapped in accept-as-written markup
  −
if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title=
  −
Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three
  −
elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ...
  −
not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.)
  −
Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters
  −
end
  −
 
  −
if utilities.is_set (ArchiveURL) and is_archived_copy (Title) then
  −
utilities.set_message ('maint_archived_copy'); -- add maintenance category before we modify the content of Title
  −
end
  −
 
  −
if is_generic ('generic_titles', Title) then
  −
utilities.set_message ('err_generic_title'); -- set an error message
  −
end
  −
end
  −
 
  −
if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'document', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or
  −
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) or
  −
('map' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)))) then -- special case for cite map when the map is in a periodical treat as an article
  −
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from module provided quote marks
  −
Title = utilities.wrap_style ('quoted-title', Title);
  −
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
  −
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle );
  −
elseif plain_title or ('report' == config.CitationClass) then -- no styling for cite report and descriptive titles (otherwise same as above)
  −
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
  −
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
  −
else
  −
Title = utilities.wrap_style ('italic-title', Title);
  −
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
  −
TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle);
  −
end
  −
 
  −
if utilities.is_set (TransTitle) then
  −
if utilities.is_set (Title) then
  −
TransTitle = " " .. TransTitle;
  −
else
  −
utilities.set_message ('err_trans_missing_title', {'title'});
  −
end
  −
end
  −
 
  −
if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs?
  −
if utilities.is_set (TitleLink) and utilities.is_set (URL) then
  −
utilities.set_message ('err_wikilink_in_url'); -- set an error message because we can't have both
  −
TitleLink = ''; -- unset
  −
end
  −
  −
if not utilities.is_set (TitleLink) and utilities.is_set (URL) then
  −
Title = external_link (URL, Title, URL_origin, UrlAccess) .. TransTitle .. Format;
  −
URL = ''; -- unset these because no longer needed
  −
Format = "";
  −
elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then
  −
local ws_url;
  −
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
  −
if ws_url then
  −
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
  −
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
  −
Title = Title .. TransTitle;
  −
else
  −
Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle;
  −
end
  −
else
  −
local ws_url, ws_label, L; -- Title has italic or quote markup by the time we get here which causes is_wikilink() to return 0 (not a wikilink)
  −
ws_url, ws_label, L = wikisource_url_make (Title:gsub('^[\'"]*(.-)[\'"]*$', '%1')); -- make ws URL from |title= interwiki link (strip italic or quote markup); link portion L becomes tooltip label
  −
if ws_url then
  −
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup
  −
Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?
  −
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
  −
Title = Title .. TransTitle;
  −
else
  −
Title = Title .. TransTitle;
  −
end
  −
end
  −
else
  −
Title = TransTitle;
  −
end
  −
 
  −
if utilities.is_set (Place) then
  −
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
  −
end
  −
 
  −
local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
  −
if utilities.is_set (Conference) then
  −
if utilities.is_set (ConferenceURL) then
  −
Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil );
  −
end
  −
Conference = sepc .. " " .. Conference .. ConferenceFormat;
  −
elseif utilities.is_set (ConferenceURL) then
  −
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil );
  −
end
  −
 
  −
local Position = '';
  −
if not utilities.is_set (Position) then
  −
local Minutes = A['Minutes'];
  −
local Time = A['Time'];
  −
 
  −
if utilities.is_set (Minutes) then
  −
if utilities.is_set (Time) then --TODO: make a function for this and similar?
  −
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'minutes') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'time')});
  −
end
  −
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
  −
else
  −
if utilities.is_set (Time) then
  −
local TimeCaption = A['TimeCaption']
  −
if not utilities.is_set (TimeCaption) then
  −
TimeCaption = cfg.messages['event'];
  −
if sepc ~= '.' then
  −
TimeCaption = TimeCaption:lower();
  −
end
  −
end
  −
Position = " " .. TimeCaption .. " " .. Time;
  −
end
  −
end
  −
else
  −
Position = " " .. Position;
  −
At = '';
  −
end
  −
 
  −
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);
  −
 
  −
At = utilities.is_set (At) and (sepc .. " " .. At) or "";
  −
Position = utilities.is_set (Position) and (sepc .. " " .. Position) or "";
  −
if config.CitationClass == 'map' then
  −
local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier
  −
local Inset = A['Inset'];
  −
  −
if utilities.is_set ( Inset ) then
  −
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
  −
end
  −
 
  −
if utilities.is_set ( Sections ) then
  −
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
  −
elseif utilities.is_set ( Section ) then
  −
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
  −
end
  −
At = At .. Inset .. Section;
  −
end
  −
 
  −
local Others = A['Others'];
  −
if utilities.is_set (Others) and 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
  −
if config.CitationClass == "AV-media-notes"
  −
or config.CitationClass == "audio-visual" then -- special maint for AV/M which has a lot of 'false' positives right now
  −
utilities.set_message ('maint_others_avm')
  −
else
  −
utilities.set_message ('maint_others');
  −
end
  −
end
  −
Others = utilities.is_set (Others) and (sepc .. " " .. Others) or "";
  −
  −
if utilities.is_set (Translators) then
  −
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc);
  −
end
  −
if utilities.is_set (Interviewers) then
  −
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc);
  −
end
  −
  −
local TitleNote = A['TitleNote'];
  −
TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or "";
  −
if utilities.is_set (Edition) then
  −
if Edition:match ('%f[%a][Ee]d%n?%.?$') or Edition:match ('%f[%a][Ee]dition$') then -- Ed, ed, Ed., ed., Edn, edn, Edn., edn.
  −
utilities.set_message ('err_extra_text_edition'); -- add error message
  −
end
  −
Edition = " " .. wrap_msg ('edition', Edition);
  −
else
  −
Edition = '';
  −
end
  −
 
  −
Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
  −
local Agency = A['Agency'];
  −
Agency = utilities.is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";
  −
Volume = format_volume_issue (Volume, Issue, ArticleNumber, config.CitationClass, Periodical_origin, sepc, use_lowercase);
  −
 
  −
if utilities.is_set (AccessDate) then
  −
local retrv_text = " " .. cfg.messages['retrieved']
  −
 
  −
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
  −
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case
  −
AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text
  −
 
  −
AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
  −
end
  −
  −
if utilities.is_set (ID) then ID = sepc .. " " .. ID; end
  −
  −
local Docket = A['Docket'];
  −
  if "thesis" == config.CitationClass and utilities.is_set (Docket) then
  −
ID = sepc .. " Docket " .. Docket .. ID;
  −
end
  −
  if "report" == config.CitationClass and utilities.is_set (Docket) then -- for cite report when |docket= is set
  −
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set
  −
end
  −
 
  −
if utilities.is_set (URL) then
  −
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
  −
end
  −
 
  −
local Quote = A['Quote'];
  −
local TransQuote = A['TransQuote'];
  −
local ScriptQuote = A['ScriptQuote'];
  −
if utilities.is_set (Quote) or utilities.is_set (TransQuote) or utilities.is_set (ScriptQuote) then
  −
 
  −
if utilities.is_set (Quote) then
  −
if Quote:sub(1, 1) == '"' and Quote:sub(-1, -1) == '"' then -- if first and last characters of quote are quote marks
  −
Quote = Quote:sub(2, -2); -- strip them off
  −
end
  −
end
  −
  −
Quote = kern_quotes (Quote); -- kern if needed
  −
Quote = utilities.wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
  −
  −
if utilities.is_set (ScriptQuote) then
  −
Quote = script_concatenate (Quote, ScriptQuote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
  −
end
  −
 
  −
if utilities.is_set (TransQuote) then
  −
if TransQuote:sub(1, 1) == '"' and TransQuote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
  −
TransQuote = TransQuote:sub(2, -2); -- strip them off
  −
end
  −
Quote = Quote .. " " .. utilities.wrap_style ('trans-quoted-title', TransQuote );
  −
end
  −
 
  −
if utilities.is_set (QuotePage) or utilities.is_set (QuotePages) then -- add page prefix
  −
local quote_prefix = '';
  −
if utilities.is_set (QuotePage) then
  −
extra_text_in_page_check (QuotePage, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
  −
if not NoPP then
  −
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePage}), '', '', '';
  −
else
  −
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePage}), '', '', '';
  −
end
  −
elseif utilities.is_set (QuotePages) then
  −
extra_text_in_page_check (QuotePages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
  −
if tonumber(QuotePages) ~= nil and not NoPP then -- if only digits, assume single page
  −
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePages}), '', '';
  −
elseif not NoPP then
  −
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, QuotePages}), '', '';
  −
else
  −
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePages}), '', '';
  −
end
  −
end
  −
                       
  −
Quote = quote_prefix .. ": " .. Quote;
  −
else
  −
Quote = sepc .. " " .. Quote;
  −
end
  −
 
  −
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
  −
end
  −
  −
-- We check length of PostScript here because it will have been nuked by
  −
-- the quote parameters. We'd otherwise emit a message even if there wasn't
  −
-- a displayed postscript.
  −
-- TODO: Should the max size (1) be configurable?
  −
-- TODO: Should we check a specific pattern?
  −
if utilities.is_set(PostScript) and mw.ustring.len(PostScript) > 1 then
  −
utilities.set_message ('maint_postscript')
  −
end
  −
  −
local Archived;
  −
if utilities.is_set (ArchiveURL) then
  −
if not utilities.is_set (ArchiveDate) then -- ArchiveURL set but ArchiveDate not set
  −
utilities.set_message ('err_archive_missing_date'); -- emit an error message
  −
ArchiveURL = ''; -- empty string for concatenation
  −
ArchiveDate = ''; -- empty string for concatenation
  −
end
  −
else
  −
if utilities.is_set (ArchiveDate) then -- ArchiveURL not set but ArchiveDate is set
  −
utilities.set_message ('err_archive_date_missing_url'); -- emit an error message
  −
ArchiveURL = ''; -- empty string for concatenation
  −
ArchiveDate = ''; -- empty string for concatenation
  −
end
  −
end
  −
 
  −
if utilities.is_set (ArchiveURL) then
  −
local arch_text;
  −
-- if not utilities.is_set (ArchiveDate) then
  −
-- utilities.set_message ('err_archive_missing_date');
  −
-- ArchiveDate = ''; -- empty string for concatenation
  −
-- end
  −
if "live" == UrlStatus then
  −
arch_text = cfg.messages['archived'];
  −
if sepc ~= "." then arch_text = arch_text:lower() end
  −
if utilities.is_set (ArchiveDate) then
  −
Archived = sepc .. ' ' .. utilities.substitute ( cfg.messages['archived-live'],
  −
{external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil) .. ArchiveFormat, ArchiveDate } );
  −
else
  −
Archived = '';
  −
end
  −
if not utilities.is_set (OriginalURL) then
  −
utilities.set_message ('err_archive_missing_url');
  −
Archived = ''; -- empty string for concatenation
  −
end
  −
elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
  −
if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
  −
arch_text = cfg.messages['archived-unfit'];
  −
if sepc ~= "." then arch_text = arch_text:lower() end
  −
Archived = sepc .. ' ' .. arch_text .. ArchiveDate; -- format already styled
  −
if 'bot: unknown' == UrlStatus then
  −
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
  −
else
  −
utilities.set_message ('maint_unfit'); -- and add a category if not already added
  −
end
  −
else -- UrlStatus is empty, 'dead'
  −
arch_text = cfg.messages['archived-dead'];
  −
if sepc ~= "." then arch_text = arch_text:lower() end
  −
if utilities.is_set (ArchiveDate) then
  −
Archived = sepc .. " " .. utilities.substitute ( arch_text,
  −
{ external_link( OriginalURL, cfg.messages['original'], OriginalURL_origin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled
  −
else
  −
Archived = ''; -- unset for concatenation
  −
end
  −
end
  −
else -- OriginalUrl not set
  −
utilities.set_message ('err_archive_missing_url');
  −
Archived = ''; -- empty string for concatenation
  −
end
  −
elseif utilities.is_set (ArchiveFormat) then
  −
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
  −
else
  −
Archived = '';
  −
end
  −
  −
-- local Lay = '';
  −
-- local LaySource = A['LaySource'];
  −
-- local LayURL = A['LayURL'];
  −
-- local LayFormat = A['LayFormat'];
  −
-- LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url');
  −
-- if utilities.is_set (LayURL) then
  −
-- if utilities.is_set (LayDate) then LayDate = " (" .. LayDate .. ")" end
  −
-- if utilities.is_set (LaySource) then
  −
-- LaySource = " &ndash; ''" .. utilities.safe_for_italics (LaySource) .. "''";
  −
-- else
  −
-- LaySource = "";
  −
-- 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
  −
-- elseif utilities.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
  −
 
  −
local TranscriptURL = A['TranscriptURL']
  −
local TranscriptFormat = A['TranscriptFormat'];
  −
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');
  −
local Transcript = A['Transcript'];
  −
local TranscriptURL_origin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
  −
if utilities.is_set (Transcript) then
  −
if utilities.is_set (TranscriptURL) then
  −
Transcript = external_link( TranscriptURL, Transcript, TranscriptURL_origin, nil );
  −
end
  −
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
  −
elseif utilities.is_set (TranscriptURL) then
  −
Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil );
  −
end
  −
 
  −
local Publisher;
  −
if utilities.is_set (PublicationDate) then
  −
PublicationDate = wrap_msg ('published', PublicationDate);
  −
end
  −
if utilities.is_set (PublisherName) then
  −
if utilities.is_set (PublicationPlace) then
  −
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
  −
else
  −
Publisher = sepc .. " " .. PublisherName .. PublicationDate; 
  −
end
  −
elseif utilities.is_set (PublicationPlace) then
  −
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
  −
else
  −
Publisher = PublicationDate;
  −
end
  −
  −
-- Several of the above rely upon detecting this as nil, so do it last.
  −
if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then
  −
if utilities.is_set (Title) or utilities.is_set (TitleNote) then
  −
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
  −
else
  −
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
  −
end
  −
end
  −
  −
local Language = A['Language'];
  −
if utilities.is_set (Language) then
  −
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc.
  −
else
  −
Language=''; -- language not specified so make sure this is an empty string;
  −
--[[ TODO: need to extract the wrap_msg from language_parameter
  −
so that we can solve parentheses bunching problem with Format/Language/TitleType
  −
]]
  −
end
  −
 
  −
--[[
  −
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
  −
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
  −
]]
  −
if "speech" == config.CitationClass then -- cite speech only
  −
TitleNote = TitleType; -- move TitleType to TitleNote so that it renders ahead of |event=
  −
TitleType = ''; -- and unset
  −
 
  −
if utilities.is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
  −
if utilities.is_set (Conference) then -- and if |event= is set
  −
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
  −
end
  −
end
  −
end
  −
 
  −
-- Piece all bits together at last.  Here, all should be non-nil.
  −
-- 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 utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
  −
if not (utilities.is_set (Authors) or utilities.is_set (Editors)) then
  −
Others = Others:gsub ('^' .. sepc .. ' ', ''); -- when no authors and no editors, strip leading sepc and space
  −
end
  −
if utilities.is_set (Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here?
  −
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc );
  −
elseif utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites
  −
if utilities.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, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
  −
else
  −
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
  −
end
  −
 
  −
elseif 'map' == config.CitationClass then -- special cases for cite map
  −
if utilities.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 utilities.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, Language, Edition, Publisher}, sepc );
  −
 
  −
else -- all other CS1 templates
  −
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
  −
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 Via = A['Via'];
  −
Via = utilities.is_set (Via) and  wrap_msg ('via', Via) or '';
  −
local idcommon;
  −
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript
  −
-- idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Lay, Quote }, sepc );
  −
idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Quote }, sepc );
  −
else
  −
-- idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Lay, Quote }, sepc );
  −
idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Quote }, sepc );
  −
end
  −
  −
local text;
  −
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
  −
 
  −
local OrigDate = A['OrigDate'];
  −
OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or '';
  −
if utilities.is_set (Date) then
  −
if utilities.is_set (Authors) or utilities.is_set (Editors) then -- date follows authors or editors when authors not set
  −
Date = " (" .. Date .. ")" .. OrigDate .. sepc .. " "; -- in parentheses
  −
else -- neither of authors and editors set
  −
if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc
  −
Date = " " .. Date .. OrigDate; -- Date does not begin with sepc
  −
else
  −
Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc
  −
end
  −
end
  −
end
  −
if utilities.is_set (Authors) then
  −
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Authors termination
  −
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
  −
end
  −
if utilities.is_set (Editors) then
  −
local in_text = '';
  −
local post_text = '';
  −
if utilities.is_set (Chapter) and 0 == #c then
  −
in_text = cfg.messages['in'] .. ' ';
  −
if (sepc ~= '.') then
  −
in_text = in_text:lower(); -- lowercase for cs2
  −
end
  −
end
  −
if EditorCount <= 1 then
  −
post_text = ' (' .. cfg.messages['editor'] .. ')'; -- be consistent with no-author, no-date case
  −
else
  −
post_text = ' (' .. cfg.messages['editors'] .. ')';
  −
end
  −
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
  −
end
  −
if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc.
  −
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
  −
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
  −
Authors = by_text .. Authors; -- author follows title so tweak it here
  −
if utilities.is_set (Editors) and utilities.is_set (Date) then -- when Editors make sure that Authors gets terminated
  −
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
  −
end
  −
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination
  −
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
  −
end
  −
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
  −
else
  −
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
  −
end
  −
elseif utilities.is_set (Editors) then
  −
if utilities.is_set (Date) then
  −
if EditorCount <= 1 then
  −
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editor'];
  −
else
  −
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editors'];
  −
end
  −
else
  −
if EditorCount <= 1 then
  −
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
  −
else
  −
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
  −
end
  −
end
  −
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc );
  −
else
  −
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
  −
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
  −
else
  −
text = safe_join( {Chapter, Place, tcommon, Date, pgtext, idcommon}, sepc );
  −
end
  −
end
  −
  −
if utilities.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_t = {};
  −
options_t.class = cite_class_attribute_make (config.CitationClass, Mode);
  −
 
  −
local Ref = is_valid_parameter_value (A['Ref'], A:ORIGIN('Ref'), cfg.keywords_lists['ref'], nil, true); -- nil when |ref=harv; A['Ref'] else
  −
 
  −
if 'none' ~= cfg.keywords_xlate[(Ref and Ref:lower()) or ''] then
  −
local namelist_t = {}; -- holds selected contributor, author, editor name list
  −
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation
  −
 
  −
if #c > 0 then -- if there is a contributor list
  −
namelist_t = c; -- select it
  −
elseif #a > 0 then -- or an author list
  −
namelist_t = a;
  −
elseif #e > 0 then -- or an editor list
  −
namelist_t = e;
  −
end
  −
local citeref_id;
  −
if #namelist_t > 0 then -- if there are names in namelist_t
  −
citeref_id = make_citeref_id (namelist_t, year); -- go make the CITEREF anchor
  −
if mw.uri.anchorEncode (citeref_id) == ((Ref and mw.uri.anchorEncode (Ref)) or '') then -- Ref may already be encoded (by {{sfnref}}) so citeref_id must be encoded before comparison
  −
utilities.set_message ('maint_ref_duplicates_default');
  −
end
  −
else
  −
citeref_id = ''; -- unset
  −
end
  −
options_t.id = Ref or citeref_id;
  −
end
  −
 
  −
if string.len (text:gsub('%b<>', '')) <= 2 then -- remove html and html-like tags; then get length of what remains;
  −
z.error_cats_t = {}; -- blank the categories list
  −
z.error_msgs_t = {}; -- blank the error messages list
  −
OCinSoutput = nil; -- blank the metadata string
  −
text = ''; -- blank the the citation
  −
utilities.set_message ('err_empty_citation'); -- set empty citation message and category
  −
end
  −
  −
local render_t = {}; -- here we collect the final bits for concatenation into the rendered citation
  −
 
  −
if utilities.is_set (options_t.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
  −
table.insert (render_t, utilities.substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options_t.id), mw.text.nowiki(options_t.class), text})); -- when |ref= is set or when there is a namelist
  −
else
  −
table.insert (render_t, utilities.substitute (cfg.presentation['cite'], {mw.text.nowiki(options_t.class), text})); -- when |ref=none or when namelist_t empty and |ref= is missing or is empty
  −
end
  −
 
  −
if OCinSoutput then -- blanked when citation is 'empty' so don't bother to add boilerplate metadata span
  −
table.insert (render_t, utilities.substitute (cfg.presentation['ocins'], OCinSoutput)); -- format and append metadata to the citation
  −
end
  −
 
  −
local template_name = ('citation' == config.CitationClass) and 'citation' or 'cite ' .. (cfg.citation_class_map_t[config.CitationClass] or config.CitationClass);
  −
local template_link = '[[Template:' .. template_name .. '|' .. template_name .. ']]';
  −
local msg_prefix = '<code class="cs1-code">{{' .. template_link .. '}}</code>: ';
  −
 
  −
if 0 ~= #z.error_msgs_t then
  −
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_e, template_link));
  −
 
  −
table.insert (render_t, ' '); -- insert a space between citation and its error messages
  −
table.sort (z.error_msgs_t); -- sort the error messages list; sorting includes wrapping <span> and <code> tags; hidden-error sorts ahead of visible-error
  −
 
  −
local hidden = true; -- presume that the only error messages emited by this template are hidden
  −
for _, v in ipairs (z.error_msgs_t) do -- spin through the list of error messages
  −
if v:find ('cs1-visible-error', 1, true) then -- look for the visible error class name
  −
hidden = false; -- found one; so don't hide the error message prefix
  −
break; -- and done because no need to look further
  −
end
  −
end
  −
 
  −
z.error_msgs_t[1] = table.concat ({utilities.error_comment (msg_prefix, hidden), z.error_msgs_t[1]}); -- add error message prefix to first error message to prevent extraneous punctuation
  −
table.insert (render_t, table.concat (z.error_msgs_t, '; ')); -- make a big string of error messages and add it to the rendering
  −
end
  −
 
  −
if 0 ~= #z.maint_cats_t then
  −
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_m, template_link));
  −
 
  −
table.sort (z.maint_cats_t); -- sort the maintenance messages list
  −
 
  −
local maint_msgs_t = {}; -- here we collect all of the maint messages
  −
 
  −
if 0 == #z.error_msgs_t then -- if no error messages
  −
table.insert (maint_msgs_t, msg_prefix); -- insert message prefix in maint message livery
  −
end
  −
  −
for _, v in ipairs( z.maint_cats_t ) do -- append maintenance categories
  −
table.insert (maint_msgs_t, -- assemble new maint message and add it to the maint_msgs_t table
  −
table.concat ({v, ' (', utilities.substitute (cfg.messages[':cat wikilink'], v), ')'})
  −
);
  −
end
  −
table.insert (render_t, utilities.substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs_t, ' '))); -- wrap the group of maint messages with proper presentation and save
  −
end
  −
 
  −
if not no_tracking_cats then
  −
for _, v in ipairs (z.error_cats_t) do -- append error categories
  −
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
  −
end
  −
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
  −
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
  −
end
  −
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
  −
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
  −
end
  −
end
  −
 
  −
return table.concat (render_t); -- make a big string and done
  −
end
  −
 
  −
 
  −
--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
  −
 
  −
Looks for a parameter's name in one of several whitelists.
  −
 
  −
Parameters in the whitelist can have three values:
  −
true - active, supported parameters
  −
false - deprecated, supported parameters
  −
nil - unsupported parameters
  −
  −
]]
  −
 
  −
local function validate (name, cite_class, empty)
  −
local name = tostring (name);
  −
local enum_name; -- parameter name with enumerator (if any) replaced with '#'
  −
local state;
  −
local function state_test (state, name) -- local function to do testing of state values
  −
if true == state then return true; end -- valid actively supported parameter
  −
if false == state then
  −
if empty then return nil; end -- empty deprecated parameters are treated as unknowns
  −
deprecated_parameter (name); -- parameter is deprecated but still supported
  −
return true;
  −
end
  −
if 'tracked' == state then
  −
local base_name = name:gsub ('%d', ''); -- strip enumerators from parameter names that have them to get the base name
  −
utilities.add_prop_cat ('tracked-param', {base_name}, base_name); -- add a properties category; <base_name> modifies <key>
  −
return true;
  −
end
  −
return nil;
  −
end
  −
 
  −
if name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted
  −
return nil;
  −
end
  −
-- replace wnumerator digit(s) with # (|last25= becomes |last#=) (mw.ustring because non-Western 'local' digits)
  −
enum_name = mw.ustring.gsub (name, '%d+$', '#'); -- where enumerator is last charaters in parameter name (these to protect |s2cid=)
  −
enum_name = mw.ustring.gsub (enum_name, '%d+([%-l])', '#%1'); -- where enumerator is in the middle of the parameter name; |author#link= is the oddity
  −
 
  −
if 'document' == cite_class then -- special case for {{cite document}}
  −
state = whitelist.document_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
  −
if true == state_test (state, name) then return true; end
  −
  −
return false;
  −
end
  −
 
  −
if utilities.in_array (cite_class, whitelist.preprint_template_list_t) then -- limited parameter sets allowed for these templates
  −
state = whitelist.limited_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters
  −
if true == state_test (state, name) then return true; end
  −
 
  −
state = whitelist.preprint_arguments_t[cite_class][name]; -- look in the parameter-list for the template identified by cite_class
  −
if true == state_test (state, name) then return true; end
  −
 
  −
return false; -- not supported because not found or name is set to nil
  −
end -- end limited parameter-set templates
  −
 
  −
if utilities.in_array (cite_class, whitelist.unique_param_template_list_t) then -- template-specific parameters for templates that accept parameters from the basic argument list
  −
state = whitelist.unique_arguments_t[cite_class][name]; -- look in the template-specific parameter-lists for the template identified by cite_class
  −
if true == state_test (state, name) then return true; end
  −
end -- if here, fall into general validation
  −
 
  −
state = whitelist.common_parameters_t[enum_name]; -- all other templates; all normal parameters allowed; this list holds enumerated and nonenumerated parameters
  −
if true == state_test (state, name) then return true; end
  −
 
  −
return false; -- not supported because not found or name is set to nil
  −
end
  −
 
  −
 
  −
--[=[-------------------------< I N T E R _ W I K I _ C H E C K >----------------------------------------------
  −
 
  −
check <value> for inter-language interwiki-link markup.  <prefix> must be a MediaWiki-recognized language
  −
code.  when these values have the form (without leading colon):
  −
[[<prefix>:link|label]] return label as plain-text
  −
[[<prefix>:link]] return <prefix>:link as plain-text
  −
 
  −
return value as is else
  −
 
  −
]=]
  −
 
  −
local function inter_wiki_check (parameter, value)
  −
local prefix = value:match ('%[%[(%a+):'); -- get an interwiki prefix if one exists
  −
local _;
  −
  −
if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so
  −
utilities.set_message ('err_bad_paramlink', parameter); -- emit an error message
  −
_, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink
  −
end
  −
return value;
  −
end
  −
 
  −
 
  −
--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------
  −
 
  −
Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal
  −
sign, compare the alphanumeric string to the list of cs1|2 parameters.  If found, then the string is possibly a
  −
parameter that is missing its pipe.  There are two tests made:
  −
{{cite ... |title=Title access-date=2016-03-17}} -- the first parameter has a value and whitespace separates that value from the missing pipe parameter name
  −
{{cite ... |title=access-date=2016-03-17}} -- the first parameter has no value (whitespace after the first = is trimmed by MediaWiki)
  −
cs1|2 shares some parameter names with XML/HTML attributes: class=, title=, etc.  To prevent false positives XML/HTML
  −
tags are removed before the search.
  −
 
  −
If a missing pipe is detected, this function adds the missing pipe maintenance category.
  −
 
  −
]]
  −
 
  −
local function missing_pipe_check (parameter, value)
  −
local capture;
  −
value = value:gsub ('%b<>', ''); -- remove XML/HTML tags because attributes: class=, title=, etc.
  −
 
  −
capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
  −
if capture and validate (capture) then -- if the capture is a valid parameter name
  −
utilities.set_message ('err_missing_pipe', parameter);
  −
end
  −
end
  −
 
  −
 
  −
--[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >--------------------------------------
  −
 
  −
look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked
  −
 
  −
]]
  −
 
  −
local function has_extraneous_punc (param, value)
  −
if 'number' == type (param) then
  −
return;
  −
end
  −
  −
param = param:gsub ('%d+', '#'); -- enumerated name-list mask params allow terminal punct; normalize
  −
if cfg.punct_skip[param] then
  −
return; -- parameter name found in the skip table so done
  −
end
  −
  −
if value:match ('[,;:]$') then
  −
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
  −
end
  −
if value:match ('^=') then -- sometimes an extraneous '=' character appears ...
  −
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
  −
end
  −
end
  −
 
  −
 
  −
--[[--------------------------< H A S _ E X T R A N E O U S _ U R L >------------------------------------------
  −
 
  −
look for extraneous url parameter values; parameters listed in skip table are not checked
  −
 
  −
]]
  −
 
  −
local function has_extraneous_url (url_param_t)
  −
local url_error_t = {};
  −
  −
check_for_url (url_param_t, url_error_t); -- extraneous url check
  −
if 0 ~= #url_error_t then -- non-zero when there are errors
  −
table.sort (url_error_t);
  −
utilities.set_message ('err_param_has_ext_link', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
  −
end
  −
end
  −
 
  −
 
  −
--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
  −
 
  −
This is used by templates such as {{cite book}} to create the actual citation text.
  −
 
  −
]]
  −
 
  −
local function citation(frame)
  −
Frame = frame; -- save a copy in case we need to display an error message in preview mode
  −
 
  −
local config = {}; -- table to store parameters from the module {{#invoke:}}
  −
for k, v in pairs( frame.args ) do -- get parameters from the {{#invoke}} frame
   
config[k] = v;
 
config[k] = v;
−
-- args[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
+
args[k] = v;  
−
end
+
end
−
-- i18n: set the name that your wiki uses to identify sandbox subpages from sandbox template invoke (or can be set here)
  −
local sandbox = ((config.SandboxPath and '' ~= config.SandboxPath) and config.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}}
  −
is_sandbox = nil ~= string.find (frame:getTitle(), sandbox, 1, true); -- is this invoke the sandbox module?
  −
sandbox = is_sandbox and sandbox or ''; -- use i18n sandbox to load sandbox modules when this module is the sandox; live modules else
  −
 
  −
local pframe = frame:getParent()
  −
local styles;
  −
  −
cfg = mw.loadData ('Module:Citation/CS1/Configuration' .. sandbox); -- load sandbox versions of support modules when {{#invoke:Citation/CS1/sandbox|...}}; live modules else
  −
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist' .. sandbox);
  −
utilities = require ('Module:Citation/CS1/Utilities' .. sandbox);
  −
validation = require ('Module:Citation/CS1/Date_validation' .. sandbox);
  −
identifiers = require ('Module:Citation/CS1/Identifiers' .. sandbox);
  −
metadata = require ('Module:Citation/CS1/COinS' .. sandbox);
  −
styles = 'Module:Citation/CS1' .. sandbox .. '/styles.css';
  −
 
  −
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
  −
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
  −
validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module
  −
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module
  −
 
  −
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
  −
 
  −
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));
     −
local args = {}; -- table where we store all of the template's arguments
+
for k, v in pairs( pframe.args ) do
−
local suggestions = {}; -- table where we store suggestions if we need to loadData them
  −
local error_text; -- used as a flag
  −
 
  −
local capture; -- the single supported capture when matching unknown parameters using patterns
  −
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
  −
for k, v in pairs( pframe.args ) do -- get parameters from the parent (template) frame
  −
v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string
   
if v ~= '' then
 
if v ~= '' then
−
if ('string' == type (k)) then
+
if not validate( k ) then
−
k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- for enumerated parameters, translate 'local' digits to Western 0-9
+
error_text = "";
−
end
+
if type( k ) ~= 'string' then
−
if not validate( k, config.CitationClass ) then
+
-- Exclude empty numbered parameters
−
if type (k) ~= 'string' then -- exclude empty numbered parameters
   
if v:match("%S+") ~= nil then
 
if v:match("%S+") ~= nil then
−
error_text = utilities.set_message ('err_text_ignored', {v});
+
error_text, error_state = set_error( 'text_ignored', {v}, true );
 
end
 
end
−
elseif validate (k:lower(), config.CitationClass) then  
+
elseif validate( k:lower() ) then  
−
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, k:lower()}); -- suggest the lowercase version of the parameter
+
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true );
 
else
 
else
−
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
+
if #suggestions == 0 then
−
suggestions = mw.loadData ('Module:Citation/CS1/Suggestions' .. sandbox); --load sandbox version of suggestion module when {{#invoke:Citation/CS1/sandbox|...}}; live module else
+
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
 
end
 
end
−
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
+
if suggestions[ k:lower() ] ~= nil then
−
capture = k:match (pattern); -- the whole match if no capture in pattern else the capture if a match
+
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
−
if capture then -- if the pattern matches
+
else
−
param = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator)
+
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
−
if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists)
  −
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message
  −
else
  −
error_text = utilities.set_message ('err_parameter_ignored', {k}); -- suggested param not supported by this template
  −
v = ''; -- unset
  −
end
  −
end
  −
end
  −
if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an explicit suggestion?
  −
if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], config.CitationClass) then
  −
utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]});
  −
else
  −
utilities.set_message ('err_parameter_ignored', {k});
  −
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
  −
end
   
end
 
end
 
end    
 
end    
 +
if error_text ~= '' then
 +
table.insert( z.message_tail, {error_text, error_state} );
 +
end
 
end
 
end
−
 
+
args[k] = v;
−
args[k] = v; -- save this parameter and its value
+
elseif args[k] ~= nil or (k == 'postscript') then
−
 
+
args[k] = v;
−
elseif not utilities.is_set (v) then -- for empty parameters
+
end
−
if not validate (k, config.CitationClass, true) then -- is this empty parameter a valid parameter
  −
k = ('' == k) and '(empty string)' or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text
  −
table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list
  −
end
  −
-- crude debug support that allows us to render a citation from module {{#invoke:}} TODO: keep?
  −
-- elseif args[k] ~= nil or (k == 'postscript') then -- when args[k] has a value from {{#invoke}} frame (we don't normally do that)
  −
-- args[k] = v; -- overwrite args[k] with empty string from pframe.args[k] (template frame); v is empty string here
  −
end -- not sure about the postscript bit; that gets handled in parameter validation; historical artifact?
   
end
 
end
−
 
+
−
if 0 ~= #empty_unknowns then -- create empty unknown error message
+
return citation0( config, args)
−
utilities.set_message ('err_param_unknown_empty', {
  −
1 == #empty_unknowns and '' or 's',
  −
utilities.make_sep_list (#empty_unknowns, empty_unknowns)
  −
});
  −
end
  −
 
  −
local url_param_t = {};
  −
 
  −
for k, v in pairs( args ) do
  −
if 'string' == type (k) then -- don't evaluate positional parameters
  −
has_invisible_chars (k, v); -- look for invisible characters
  −
end
  −
has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
  −
missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe?
  −
args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label
  −
 
  −
if 'string' == type (k) and not cfg.url_skip[k] then -- when parameter k is not positional and not in url skip table
  −
url_param_t[k] = v; -- make a parameter/value list for extraneous url check
  −
end
  −
end
  −
 
  −
has_extraneous_url (url_param_t); -- look for url in parameter values where a url does not belong
  −
 
  −
return table.concat ({
  −
frame:extensionTag ('templatestyles', '', {src=styles}),
  −
citation0( config, args)
  −
});
   
end
 
end
   −
 
+
return z
−
--[[--------------------------< E X P O R T E D  F U N C T I O N S >------------------------------------------
  −
]]
  −
 
  −
return {citation = citation};
 
Источник — https://in.wiki/Служебная:Сравнение_версий/10267