Modul:Citation/CS1: Forskjell mellom sideversjoner

Fra wikisida.no
Hopp til navigering Hopp til søk
m 242 revisjoner er importert fra en:Module:Citation/CS1: test
Sorry! Ble veldig feil!
Linje 1: Linje 1:
local z = {
    error_categories = {};
    error_ids = {};
    message_tail = {};
}


local cs1 ={};
-- Include translation message hooks, ID and error handling configuration settings.
--local cfg = mw.loadData( 'Modul:Citation/CS1/Configuration/sandkasse' );


--[[--------------------------< F O R W A R D  D E C L A R A T I O N S >--------------------------------------
-- Contains a list of all recognized parameters
]]
--local whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist/sandkasse' );
 
local dates, year_date_check, reformat_dates, date_hyphen_to_dash -- functions in Module:Citation/CS1/Date_validation
 
local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities
add_maint_cat, wrap_style, safe_for_italics, remove_wiki_link;
 
local z ={}; -- tables in Module:Citation/CS1/Utilities
 
local extract_ids, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers
 
local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS
 
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/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 >--------------------------------------
 
delare variables here that have page-wide scope
 
]]
 
local Preview_mode = false; -- flag indicating that we are rendering a preview page (Show preview button)
 
--[[--------------------------< F I R S T _ S E T >------------------------------------------------------------
 
Locates and returns the first set value in a table of values where the order established in the table,
left-to-right (or top-to-bottom), is the order in which the values are evaluated.  Returns nil if none are set.


This version replaces the original 'for _, val in pairs do' and a similar version that used ipairs. With the pairs
--local dates = require('Modul:Citation/CS1/Date_validation/sandkasse').dates -- location of date validation code
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.


]]
-- Whether variable is set or not
 
function is_set( var )
local function first_set (list, count)
    return not (var == nil or var == '');
local i = 1;
while i <= count do -- loop through all items in list
if is_set( list[i] ) then
return list[i]; -- return the first set list member
end
i = i + 1; -- point to next
end
end
end


--[[--------------------------< A D D _ P R O P _ C A T >--------------------------------------------------------
-- First set variable or nil if none
 
function first_set(...)
Adds a category to z.properties_cats using names from the configuration file with additional text if any.
    local list = {...};
 
    for _, var in pairs(list) do
]]
        if is_set( var ) then
 
            return var;
local added_prop_cats = {} -- list of property categories that have been added to z.properties_cats
        end
local function add_prop_cat (key, arguments)
    end
if not added_prop_cats [key] then
added_prop_cats [key] = true; -- note that we've added this category
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table
end
end
end


--[[--------------------------< A D D _ V A N C _ E R R O R >----------------------------------------------------
-- Whether needle is in haystack
 
function inArray( needle, haystack )
Adds a single Vancouver system error message to the template's output regardless of how many error actually exist.
    if needle == nil then
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
        return false;
 
    end
]]
    for n,v in ipairs( haystack ) do
 
        if v == needle then
local added_vanc_errs; -- flag so we only emit one Vancouver error / category
            return n;
local function add_vanc_error (source)
        end
if not added_vanc_errs then
    end
added_vanc_errs = true; -- note that we've added this category
    return false;
table.insert( z.message_tail, { set_error( 'vancouver', {source}, true ) } );
end
end
end


 
--[[
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
 
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
does this thing that purports to be a uri scheme seem to be a valid scheme?  The scheme is checked to see if it
details of which parameter caused the error message are not provided.  Only one error message is emitted regarless of the number of deprecated parameters in the citation.
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
 
]]
]]
 
function deprecated_parameter()
local function is_scheme (scheme)
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
return scheme and scheme:match ('^%a[%a%d%+%.%-]*:'); -- true if scheme is set and matches the pattern
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
end
-- table.insert( z.message_tail, { seterror( 'deprecated_params', {error_message}, true ) } ); -- add error message
 
table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } ); -- add error message
 
--[=[-------------------------< I S _ D O M A I N _ N A M E >--------------------------------------------------
 
Does this thing that purports to be a domain name seem to be a valid domain name?
 
Syntax defined here: http://tools.ietf.org/html/rfc1034#section-3.5
BNF defined here: https://tools.ietf.org/html/rfc4234
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
see also [[Single-letter second-level domain]]
list of tlds: https://www.iana.org/domains/root/db
 
rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit.  Between
the first and last characters the name may use letters, digits, and the hyphen.
 
Also allowed are IPv4 addresses. IPv6 not supported
 
domain is expected to be stripped of any path so that the last character in the last character of the tld.  tld
is two or more alpha characters.  Any preceding '//' (from splitting a url with a scheme) will be stripped
here.  Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal.
 
There are several tests:
the first character of the whole domain name including subdomains must be a letter or a digit
internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
single-letter/digit second-level domains in the .org TLD
q, x, and z SL domains in the .com TLD
i and q SL domains in the .net TLD
single-letter SL domains in the ccTLDs (where the ccTLD is two letters)
two-character SL domains in gTLDs (where the gTLD is two or more letters)
three-plus-character SL domains in gTLDs (where the gTLD is two or more letters)
IPv4 dot-decimal address format; TLD not allowed
 
returns true if domain appears to be a proper name and tld or IPv4 address, else false
 
]=]
 
local function is_domain_name (domain)
if not domain then
return false; -- if not set, abandon
end
domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once
if not domain:match ('^[%a%d]') then -- first character must be letter or digit
return false;
end
-- Do most common case first
if domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$') then -- three or more character hostname.hostname or hostname.tld
return true;
elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix
return true;
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character .org hostname
return true;
elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10)
return true;
elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
return true;
elseif domain:match ('%f[%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars)
return true;
elseif domain:match ('%f[%a%d][%a%d][%a%d]%.%a%a+$') then -- two character hostname and tld
return true;
elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address
return true;
else
return false;
end
end
end
end


 
-- Populates numbered arguments in a message string using an argument table.
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
function substitute( msg, args )
 
-- return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
returns true if the scheme and domain parts of a url appear to be a valid url; else false.
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
 
This function is the last step in the validation process.  This function is separate because there are cases that
are not covered by split_url(), for example is_parameter_ext_wikilink() which is looking for bracketted external
wikilinks.
 
]]
 
local function is_url (scheme, domain)
if is_set (scheme) then -- if scheme is set check it and domain
return is_scheme (scheme) and is_domain_name (domain);
else
return is_domain_name (domain); -- scheme not set when url is protocol relative
end
end
end


 
--[[
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
 
Split a url into a scheme, authority indicator, and domain.
 
First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#).
 
If protocol relative url, return nil scheme and domain else return nil for both scheme and domain.
 
When not protocol relative, get scheme, authority indicator, and domain.  If there is an authority indicator (one
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.
 
Strip off any port and path;
 
]]
 
local function split_url (url_str)
local scheme, authority, domain;
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
 
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol relative url
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
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
return scheme; -- return scheme only making domain nil which will cause an error message
end
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
end
return scheme, domain;
end
 
 
--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------
 
checks the content of |title-link=, |series-link=, |author-link= etc for properly formatted content: no wikilinks, no urls
 
Link parameters are to hold the title of a wikipedia article so none of the WP:TITLESPECIALCHARACTERS are allowed:
# < > [ ] | { } _
except the underscore which is used as a space in wiki urls and # which is used for section links
 
returns false when the value contains any of these characters.
 
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid url (the
|<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok).
 
]]
 
local function link_param_ok (value)
local scheme, domain;
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
return false;
end
 
scheme, domain = split_url (value); -- get scheme or nil and domain or nil from url;
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url
end
 
--[[--------------------------< L I N K _ T I T L E _ O K >---------------------------------------------------
 
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.
 
|<title>= may be wikilinked but not when |<param>-link= has a value.  This function emits an error message when
that condition exists
 
]]
 
local function link_title_ok (link, lorig, title, torig)
local orig;
 
if is_set (link) then -- don't bother if <param>-link doesn't have a value
if not link_param_ok (link) then -- check |<param>-link= markup
orig = lorig; -- identify the failing link parameter
elseif title:find ('%[%[') then -- check |title= for wikilink markup
orig = torig; -- identify the failing |title= parameter
end
end
 
if is_set (orig) then
table.insert( z.message_tail, { set_error( 'bad_paramlink', orig)}); -- url or wikilink in |title= with |title-link=;
end
end
 
 
--[[--------------------------< C H E C K _ U R L >------------------------------------------------------------
 
Determines whether a URL string appears to be valid.
 
First we test for space characters.  If any are found, return false.  Then split the url into scheme and domain
portions, or for protocol relative (//example.com) urls, just the domain.  Use is_url() to validate the two
portions of the url.  If both are valid, or for protocol relative if domain is valid, return true, else false.
 
Because it is different from a standard url, and because this module used external_link() to make external links
that work for standard and news: links, we validate newsgroup names here.  The specification for a newsgroup name
is at https://tools.ietf.org/html/rfc5536#section-3.1.4
 
]]
 
local function check_url( url_str )
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper url
return false;
end
local scheme, domain;
 
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from url;
if 'news:' == scheme then -- special case for newsgroups
return domain:match('^[%a%d%+%-_]+%.[%a%d%+%-_%.]*[%a%d%+%-_]$');
end
return is_url (scheme, domain); -- return true if value appears to be a valid url
end
 
 
--[=[-------------------------< I S _ P A R A M E T E R _ E X T _ W I K I L I N K >----------------------------
 
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
non-space characters following the opening bracket appear to be a url.  The test will also find external wikilinks
that use protocol relative urls. Also finds bare urls.
 
The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls.  The tests that
find bracketed urls are required because the parameters that call this test (currently |title=, |chapter=, |work=,
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
is possible as might be [[en://Hus]].
 
]=]
 
local function is_parameter_ext_wikilink (value)
local scheme, domain;
 
if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext wikilink with scheme and domain: [xxxx://yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
elseif value:match ('%a%S*:%S+') then -- if bare url with scheme; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
elseif value:match ('//%S+') 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
 
return is_url (scheme, domain); -- return true if value appears to be a valid url
end
 
 
--[[-------------------------< C H E C K _ F O R _ U R L >-----------------------------------------------------
 
loop through a list of parameters and their values.  Look at the value and if it has an external link, emit an error message.
 
]]
 
local function check_for_url (parameter_list)
local error_message = '';
for k, v in pairs (parameter_list) do -- for each parameter in the list
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message
if is_set(error_message) then -- once we've added the first portion of the error message ...
error_message=error_message .. ", "; -- ... add a comma space separator
end
error_message=error_message .. "&#124;" .. k .. "="; -- add the failed parameter
end
end
if is_set (error_message) then -- done looping, if there is an error message, display it
table.insert( z.message_tail, { set_error( 'param_has_ext_link', {error_message}, true ) } );
end
end
 
 
--[[--------------------------< S A F E _ F O R _ U R L >------------------------------------------------------
 
Escape sequences for content that will be used for URL descriptions
 
]]
 
local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then
table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } );
end
return str:gsub( '[%[%]\n]', {
['['] = '&#91;',
[']'] = '&#93;',
['\n'] = ' ' } );
end
 
--[[--------------------------< E X T E R N A L _ L I N K >----------------------------------------------------
 
Format an external link with error checking
 
]]
 
local function external_link( URL, label, source )
local error_str = "";
local domain;
local path;
if not is_set( label ) then
label = URL;
if is_set( source ) then
error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
else
error( cfg.messages["bare_url_no_origin"] );
end
end
if not check_url( URL ) then
error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str;
end
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the url into scheme plus domain and path
if path then -- if there is a path portion
path = path:gsub ('[%[%]]', {['[']='%5b',[']']='%5d'}); -- replace '[' and ']' with their percent encoded values
URL=domain..path; -- and reassemble
end
return table.concat({ "[", URL, " ", safe_for_url( label ), "]", error_str });
end
 
 
--[[--------------------------< D E P R E C A T E D _ P A R A M E T E R >--------------------------------------
 
Categorize and emit an error message when the citation contains one or more deprecated parameters.  The function includes the
offending parameter name to the error message.  Only one error message is emitted regardless of the number of deprecated
parameters in the citation.
 
]]
 
local page_in_deprecated_cat; -- sticky flag so that the category is added only once
local function deprecated_parameter(name)
if not page_in_deprecated_cat then
page_in_deprecated_cat = true; -- note that we've added this category
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message
end
end
 
--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
 
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.
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:
This function will positive kern either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
"'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)
" '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.
Call this function for chapter titles, for website titles, etc; not for book titles.
]]
]]
 
function kern_quotes (str)
local function kern_quotes (str)
local left='<span style="padding-left:0.2em;">%1</span>'; -- spacing to use when title contains leading single or double quote mark
local cap='';
local right='<span style="padding-right:0.2em;">%1</span>'; -- spacing to use when title contains trailing single or double quote mark
local cap2='';
cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes
if  str:match ("^[\"\'][^\']") then
if is_set (cap) then
str = string.gsub( str, "^[\"\']", left, 1 ); -- replace (captured) leading single or double quote with left-side <span>
str = substitute (cfg.presentation['kern-left'], {cap, cap2});
end
end
 
if str:match ("[^\'][\"\']$") then
cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
str = string.gsub( str, "[\"\']$", right, 1 ); -- replace (captured) trailing single or double quote with right-side <span>
if is_set (cap) then
str = substitute (cfg.presentation['kern-right'], {cap, cap2});
end
end
return str;
return str;
end
end


--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
-- Wraps a string using a message_list configuration taking one argument
 
function wrap( key, str, lower )
|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
    if not is_set( str ) then
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 "";
in italic markup.
    elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
 
        str = safeforitalics( str );
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.
    end
 
    if lower == true then
|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:
        return substitute( cfg.messages[key]:lower(), {str} );
|script-title=ja:*** *** (where * represents a Japanese character)
    else
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
        return substitute( cfg.messages[key], {str} );
|script-title=ja : *** ***
    end       
|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 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.
 
Supports |script-title= and |script-chapter=
 
TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
]]
 
local function format_script_value (script_value)
local lang=''; -- initialize to empty string
local name;
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, cfg.script_lang_codes) 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
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 >------------------------------------------
--[[
 
Argument wrapper.  This function provides support for argument
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
mapping defined in the configuration file so that multiple names
wrapped in <bdi> tags.
can be transparently aliased to single internal variable.
]]
]]
 
function argument_wrapper( args )
local function script_concatenate (title, script)
    local origin = {};
if is_set (script) then
   
script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
    return setmetatable({
if is_set (script) then
        ORIGIN = function( self, k )
title = title .. ' ' .. script; -- concatenate title and script title
            local dummy = self[k]; --force the variable to be loaded.
end
            return origin[k];
end
        end
return title;
    },
    {
        __index = function ( tbl, k )
            if origin[k] ~= nil then
                return nil;
            end
           
            local args, list, v = args, cfg.aliases[k];
           
            if type( list ) == 'table' then
                v, origin[k] = selectone( args, list, 'redundant_parameters' );
                if origin[k] == nil then
                    origin[k] = ''; -- Empty string, not nil
                end
            elseif list ~= nil then
                v, origin[k] = args[list], list;
            else
                -- maybe let through instead of raising an error?
                -- v, origin[k] = args[k], k;
                error( cfg.messages['unknown_argument_map'] );
            end
           
            -- Empty strings, not nil;
            if v == nil then
                v = cfg.defaults[k] or '';
                origin[k] = '';
            end
           
            tbl = rawset( tbl, k, v );
            return v;
        end,
    });
end
end


 
--[[
--[[--------------------------< W R A P _ M S G >--------------------------------------------------------------
 
Applies additional message text to various parameter values. Supplied string is wrapped using a message_list
configuration taking one argument.  Supports lower case text for {{citation}} templates.  Additional text taken
from citation_config.messages - the reason this function is similar to but separate from wrap_style().
 
]]
 
local function wrap_msg (key, str, lower)
if not is_set( str ) then
return "";
end
if true == lower then
local msg;
msg = cfg.messages[key]:lower(); -- set the message to lower case before
return substitute( msg, str ); -- including template text
else
return substitute( cfg.messages[key], str );
end
end
 
 
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
 
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
parameter (chapter_url_source used for error messages).
 
]]
 
local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes)
local chapter_error = '';
if not is_set (chapter) then
chapter = ''; -- to be safe for concatenation
else
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
chapter = wrap_style ('quoted-title', chapter);
end
end
 
chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
 
if is_set (transchapter) then
transchapter = wrap_style ('trans-quoted-title', transchapter);
if is_set (chapter) then
chapter = chapter ..  ' ' .. transchapter;
else -- here when transchapter without chapter or script-chapter
chapter = transchapter; --
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'});
end
end
 
if is_set (chapterurl) then
chapter = external_link (chapterurl, chapter, chapter_url_source); -- adds bare_url_missing_title error if appropriate
end
 
return chapter .. chapter_error;
end
 
--[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >----------------------------------------
 
This function searches a parameter's value for nonprintable or invisible characters.  The search stops at the
first match.
 
This function will detect the visible replacement character when it is part of the wikisource.
 
Detects but ignores nowiki and math stripmarkers.  Also detects other named stripmarkers (gallery, math, pre, ref)
and identifies them with a slightly different error message.  See also coins_cleanup().
 
Detects but ignores the character pattern that results from the transclusion of {{'}} templates.
 
Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the
parameter value.
 
]]
 
local function has_invisible_chars (param, v)
local position = ''; -- position of invisible char or starting position of stripmarker
local dummy; -- end of matching string; not used but required to hold end position when a capture is returned
local capture; -- used by stripmarker detection to hold name of the stripmarker
local i=1;
local stripmarker, apostrophe;
capture = string.match (v, '[%w%p ]*'); -- Test for values that are simple ASCII text and bypass other tests if true
if capture == v then -- if same there are no unicode characters
return;
end
 
while cfg.invisible_chars[i] do
local char=cfg.invisible_chars[i][1] -- the character or group name
local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it
position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern
if position then
if 'nowiki' == capture or 'math' == capture then -- nowiki, math stripmarker (not an error condition)
stripmarker = true; -- set a flag
elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
position = nil; -- unset
else
local err_msg;
if capture then
err_msg = capture .. ' ' .. char;
else
err_msg = char .. ' ' .. 'character';
end
 
table.insert( z.message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } ); -- add error message
return; -- and done with this parameter
end
end
i=i+1; -- bump our index
end
end
 
 
--[[--------------------------< A R G U M E N T _ W R A P P E R >----------------------------------------------
 
Argument wrapper.  This function provides support for argument mapping defined in the configuration file so that
multiple names can be transparently aliased to single internal variable.
 
]]
 
local function argument_wrapper( args )
local origin = {};
return setmetatable({
ORIGIN = function( self, k )
local dummy = self[k]; --force the variable to be loaded.
return origin[k];
end
},
{
__index = function ( tbl, k )
if origin[k] ~= nil then
return nil;
end
local args, list, v = args, cfg.aliases[k];
if type( list ) == 'table' then
v, origin[k] = select_one( args, list, 'redundant_parameters' );
if origin[k] == nil then
origin[k] = ''; -- Empty string, not nil
end
elseif list ~= nil then
v, origin[k] = args[list], list;
else
-- maybe let through instead of raising an error?
-- v, origin[k] = args[k], k;
error( cfg.messages['unknown_argument_map'] );
end
-- Empty strings, not nil;
if v == nil then
v = cfg.defaults[k] or '';
origin[k] = '';
end
tbl = rawset( tbl, k, v );
return v;
end,
});
end
 
--[[--------------------------< V A L I D A T E >--------------------------------------------------------------
Looks for a parameter's name in the whitelist.
Looks for a parameter's name in the whitelist.


Linje 689: Linje 147:
false - deprecated, supported parameters
false - deprecated, supported parameters
nil - unsupported parameters
nil - unsupported parameters
]]
]]
 
function validate( name )
local function validate( name )
local name = tostring( name );
local name = tostring( name );
local state = whitelist.basic_arguments[ name ];
local state = whitelist.basic_arguments[ name ];
Linje 699: Linje 155:
if true == state then return true; end -- valid actively supported parameter
if true == state then return true; end -- valid actively supported parameter
if false == state then
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
return true;
end
end
Linje 708: Linje 164:
if true == state then return true; end -- valid actively supported parameter
if true == state then return true; end -- valid actively supported parameter
if false == state then
if false == state then
deprecated_parameter (name); -- parameter is deprecated but still supported
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
return true;
end
end
Linje 715: Linje 171:
end
end


-- Formats a comment for error trapping
function errorcomment( content, hidden )
    return wrap( hidden and 'hidden-error' or 'visible-error', content );
end


--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------
--[[
 
Sets an error condition and returns the appropriate error messageThe actual placement
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>When date is DD MMMM YYYY or is
of the error message in the output is the responsibility of the calling function.
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.
 
]]
]]
function seterror( error_id, arguments, raw, prefix, suffix )
    local error_state = cfg.error_conditions[ error_id ];
   
    prefix = prefix or "";
    suffix = suffix or "";
   
    if error_state == nil then
        error( cfg.messages['undefined_error'] );
    elseif is_set( error_state.category ) then
        table.insert( z.error_categories, error_state.category );
    end
   
    local message = substitute( error_state.message, arguments );
   
    message = message .. " ([[" .. cfg.messages['help page link'] ..
        "#" .. error_state.anchor .. "|" ..
        cfg.messages['help page label'] .. "]])";
   
    z.error_ids[ error_id ] = true;
    if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
            and z.error_ids['citation_missing_title'] then
        return '', false;
    end
   
    message = table.concat({ prefix, message, suffix });
   
    if raw == true then
        return message, error_state.hidden;
    end       
       
    return errorcomment( message, error_state.hidden );
end


local function nowrap_date (date)
-- Formats a wiki style external link
local cap='';
function externallinkid(options)
local cap2='';
    local url_string = options.id;
    if options.encode == true or options.encode == nil then
        url_string = mw.uri.encode( url_string );
    end
    return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
        options.link, options.label, options.separator or "&nbsp;",
        options.prefix, url_string, options.suffix or "",
        mw.text.nowiki(options.id)
    );
end


if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
-- Formats a wiki style internal link
date = substitute (cfg.presentation['nowrap1'], date);
function internallinkid(options)
    return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
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
        options.link, options.label, options.separator or "&nbsp;",
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
        options.prefix, options.id, options.suffix or "",
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
        mw.text.nowiki(options.id)
end
    );
return date;
end
end


--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
-- Format an external link with error checking
 
function externallink( URL, label, source )
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
    local error_str = "";
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
    if not is_set( label ) then
 
        label = URL;
]]
        if is_set( source ) then
 
            error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
local function set_titletype (cite_class, title_type)
        else
if is_set(title_type) then
            error( cfg.messages["bare_url_no_origin"] );
if "none" == title_type then
        end           
title_type = ""; -- if |type=none then type parameter not displayed
    end
end
    if not checkurl( URL ) then
return title_type; -- if |type= has been set to any other value use that value
        error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
end
    end
 
    return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
return cfg.title_types [cite_class] or ''; -- set template's default title type; else empty string for concatenation
end
end


 
-- Formats a link to Amazon
--[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------
function amazon(id, domain)
 
    if not is_set(domain) then
Converts a hyphen to a dash
        domain = "com"
 
    elseif ( "jp" == domain or "uk" == domain ) then
]]
        domain = "co." .. domain
 
    end
local function hyphen_to_dash( str )
    local handler = cfg.id_handlers['ASIN'];
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
    return externallinkid({link = handler.link,
return str;
        label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
end
        encode=handler.encode, separator = handler.separator})
return str:gsub( '-', '–' );
end
end


--[[
Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/


--[[--------------------------< S A F E _ J O I N >------------------------------------------------------------
length = 8 then all digits
 
length = 9 then lccn[1] is alpha
Joins a sequence of strings together while checking for duplicate separation characters.
length = 10 then lccn[1] and lccn[2] are both alpha or both digits
length = 11 then lccn[1] is alpha, lccn[2] and lccn[3] are both alpha or both digits
length = 12 then lccn[1] and lccn[2] are both alpha


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


local function safe_join( tbl, duplicate_char )
local len = id:len(); -- get the length of the lccn
--[[
Note: we use string functions here, rather than ustring functions.
This has considerably faster performance and should work correctly as
long as the duplicate_char is strict ASCII.  The strings
in tbl may be ASCII or UTF8.
]]
local str = ''; -- the output string
local comp = ''; -- what does 'comp' mean?
local end_chr = '';
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
-- typically duplicate_char is sepc
if comp:sub(1,1) == duplicate_char then -- is first charactier same as duplicate_char? why test first character?
--  Because individual string segments often (always?) begin with terminal punct for th
--  preceding segment: 'First element' .. 'sepc next element' .. etc?
trim = false;
end_chr = str:sub(-1,-1); -- get the last character of the output string
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff?
if end_chr == duplicate_char then -- if same as separator
str = str:sub(1,-2); -- remove it
elseif end_chr == "'" then -- if it might be wikimarkup
if str:sub(-3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
str = str:sub(1, -4) .. "''"; -- remove them and add back ''
elseif str:sub(-5,-1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
trim = true; -- why? why do this and next differently from previous?
elseif str:sub(-4,-1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
trim = true; -- same question
end
elseif end_chr == "]" then -- if it might be wikimarkup
if str:sub(-3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
trim = true;
elseif str:sub(-2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
trim = true;
elseif str:sub(-4,-1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
trim = true;
end
elseif end_chr == " " then -- if last char of output string is a space
if str:sub(-2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
str = str:sub(1,-3); -- remove them both
end
end


if trim then
if 8 == len then
if value ~= comp then -- value does not equal comp when value contains html markup
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits)
local dup2 = duplicate_char;
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
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
end
elseif 9 == len then -- LCCN should be adddddddd
return str;
if nil == id:match("%a%d%d%d%d%d%d%d%d") then -- does it match our pattern?
end 
err_cat = ' ' .. seterror( 'bad_lccn' ); -- set an error message
 
 
--[[--------------------------< I S _ S U F F I X >------------------------------------------------------------
 
returns true is suffix is properly formed Jr, Sr, or ordinal in the range 2–9.  Puncutation not allowed.
 
]]
 
local function is_suffix (suffix)
if in_array (suffix, {'Jr', 'Sr', '2nd', '3rd'}) or suffix:match ('^%dth$') then
return true;
end
return false;
end
 
--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------
 
For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters.  When a name
uses characters that contain diacritical marks, those characters are to 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
 
|lastn= also allowed to contain hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
 
This original test:
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
was written ouside 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 – À-Ö
\195\152-\195\182 – Ø-ö
\195\184-\198\191 – ø-ƿ
\199\132-\201\143 – DŽ-ɏ%
 
]]
 
local function is_good_vanc_name (last, first)
local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it
 
if is_set (suffix) then
if not is_suffix (suffix) then
add_vanc_error ('suffix');
return false; -- not a name with an appropriate suffix
end
end
end
elseif 10 == len then -- LCCN should be aadddddddd or dddddddddd
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
if id:match("[^%d]") then -- if LCCN has anything but digits (nil if only digits) ...
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
if nil == id:match("^%a%a%d%d%d%d%d%d%d%d") then -- ... see if it matches our pattern
add_vanc_error ('non-Latin character');
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
return false; -- not a string of latin characters; Vancouver requires Romanization
end;
return true;
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.  See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials.
 
This function uses ustring functions because firstname initials may be any of the unicode Latin characters accepted by is_good_vanc_name ().
 
]]
 
local function reduce_to_initials(first)
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
 
if not name then -- if not initials and a suffix
name = mw.ustring.match(first, "^(%u+)$"); -- is it just intials?
end
 
if name then -- if first is initials with or without suffix
if 3 > name:len() then -- if one or two initials
if suffix then -- if there is a suffix
if is_suffix (suffix) then -- is it legitimate?
return first; -- one or two initials and a valid suffix so nothing to do
else
add_vanc_error ('suffix'); -- one or two initials with invalid suffix so error message
return first; -- and return first unmolested
end
else
return first; -- one or two initials without suffix; nothing to do
end
end
end
end
end -- if here then name has 3 or more uppercase letters so treat them as a word
elseif 11 == len then -- LCCN should be aaadddddddd or adddddddddd
 
if not (id:match("^%a%a%a%d%d%d%d%d%d%d%d") or id:match("^%a%d%d%d%d%d%d%d%d%d%d")) then -- see if it matches one of our patterns
 
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
local initials, names = {}, {}; -- tables to hold name parts and initials
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
if 1 < i and names[i]:match ('[%dJS][%drndth]+%.?$') then -- if not the first name, and looks like a suffix (may have trailing dot)
names[i] = names[i]:gsub ('%.', ''); -- remove terminal dot if present
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
break; -- and done because suffix must fall at the end of a name
end -- no error message if not a suffix; possibly because of Romanization
end
end
if 3 > i then
elseif 12 == len then -- LCCN should be aadddddddddd
table.insert (initials, mw.ustring.sub(names[i],1,1)); -- insert the intial at end of initials table
if not id:match("^%a%a%d%d%d%d%d%d%d%d%d%d") then -- see if it matches our pattern
err_cat = ' ' .. seterror( 'bad_lccn' ); -- no match, set an error message
end
end
i = i+1; -- bump the counter
else
err_cat = ' ' .. seterror( 'bad_lccn' ); -- wrong length, set an error message
end
end
 
-- for word in mw.ustring.gmatch(first, "[^%s%.%-]+") do -- names separated by spaces, hyphens, or periods
return externallinkid({link = handler.link, label = handler.label,
-- table.insert(initials, mw.ustring.sub(word,1,1)) -- Vancouver format does not include full stops.
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
-- 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
end


--[[--------------------------< L I S T  _ P E O P L E >-------------------------------------------------------
--[[
 
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
Formats a list of people (e.g. authors / editors)
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
 
]]
]]
 
function pmid(id)
local function list_people(control, people, etal)
local test_limit = 30000000; -- update this value as PMIDs approach
local sep;
local handler = cfg.id_handlers['PMID'];
local namesep;
local err_cat = ''; -- presume that PMID is valid
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
sep = ';' -- name-list separator between authors is a semicolon
namesep = ', ' -- last/first separator is <comma><space>
end
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
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
if id:match("[^%d]") then -- if PMID has anything but digits
if is_set(person.last) then
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
local mask = person.mask
else -- PMID is only digits
local one
local id_num = tonumber(id); -- convert id to a number for range testing
local sep_one = sep;
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
if is_set (maximum) and i > maximum then
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
etal = true;
break;
elseif (mask ~= nil) then
local n = tonumber(mask)
if (n ~= nil) then
one = string.rep("&mdash;",n)
else
one = mask;
sep_one = " ";
end
else
one = person.last
local first = person.first
if is_set(first) then  
if ( "vanc" == format ) then -- if vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials
end
end
one = one .. namesep .. first
end
if is_set(person.link) and person.link ~= control.page_name then
one = "[[" .. person.link .. "|" .. one .. "]]" -- link author/editor if this page is not the author's/editor's page
end
end
table.insert( text, one )
table.insert( text, sep_one )
end
end
end
local count = #text / 2; -- (number of names + number of separators) divided by 2
if count > 0 then
if count > 1 and is_set(lastauthoramp) and not etal then
text[#text-2] = " & "; -- replace last separator with ampersand text
end
text[#text] = nil; -- erase the last separator
end
end
local result = table.concat(text) -- construct list
return externallinkid({link = handler.link, label = handler.label,
if etal and is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've go a last-first list and etal so add et al.
end
return result, count
end
end


--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
--[[
 
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
in the future, returns true; otherwse, returns false because the embargo has expired or |embargo= not set in this cite.
 
namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year.
 
]]
]]
local function anchor_id (namelist, year)
function is_embargoed(embargo)
local names={}; -- a table for the one to four names and year
if is_set(embargo) then
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
local lang = mw.getContentLanguage();
names[i] = v.last
local good1, embargo_date, good2, todays_date;
if i == 4 then break end -- if four then done
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
end
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
table.insert (names, year); -- add the year at the end
local id = table.concat(names); -- concatenate names and year for CITEREF id
if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then --is embargo date is in the future?
if is_set (id) then -- if concatenation is not an empty string
return true; -- still embargoed
return "CITEREF" .. id; -- add the CITEREF portion
else
return ''; -- return an empty string; no reason to include CITEREF id in this citation
end
end
 
 
--[[--------------------------< N A M E _ H A S _ E T A L >----------------------------------------------------
 
Evaluates the content of author and editor name parameters 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 it's previous state because it may have been set by
previous passes through this function or by the parameters |display-authors=etal or |display-editors=etal
 
]]
 
local function name_has_etal (name, etal, nocat)
 
if is_set (name) then -- name can be nil in which case just return
local etal_pattern = "[;,]? *[\"']*%f[%a][Ee][Tt] *[Aa][Ll][%.\"']*$" -- variations on the 'et al' theme
local others_pattern = "[;,]? *%f[%a]and [Oo]thers"; -- and alternate to et al.
if name:match (etal_pattern) then -- variants on et al.
name = name:gsub (etal_pattern, ''); -- if found, remove
etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
if not nocat then -- no categorization for |vauthors=
add_maint_cat ('etal'); -- and add a category if not already added
end
elseif name:match (others_pattern) then -- if not 'et al.', then 'and others'?
name = name:gsub (others_pattern, ''); -- if found, remove
etal = true; -- set flag (may have been set previously here or by |display-authors=etal)
if not nocat then -- no categorization for |vauthors=
add_maint_cat ('etal'); -- and add a category if not already added
end
end
end
end
end
return name, etal; --  
return false; -- embargo expired or |embargo= not set
end
end


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


Evaluates the content of author and editor (surnames only) parameters for multiple namesMultiple names are
The embargo parameter takes a date for a value. If the embargo date is in the future
indicated if there is more than one comma and or semicolon.  If found, the function adds the multiple name
the PMC identifier will not be linked to the articleIf the embargo specifies a date in the past, or if it is empty or omitted, then
(author or editor) maintenance category.
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.


PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
]]
function pmc(id, embargo)
local test_limit = 5000000; -- update this value as PMCs approach
local handler = cfg.id_handlers['PMC'];
local err_cat =  ''; -- presume that PMC is valid
   
local text;


local function name_has_mult_names (name, list_name)
if id:match("[^%d]") then -- if PMC has anything but digits
local count, _;
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
if is_set (name) then
else -- PMC is only digits
if name:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, ignore
local id_num = tonumber(id); -- convert id to a number for range testing
name = name:match ('^%(%((.*)%)%)$'); -- strip parens
if 1 > id_num or test_limit < id_num then -- if PMC is outside test limit boundaries
else
err_cat = ' ' .. seterror( 'bad_pmc' ); -- set an error message
_, count = name:gsub ('[;,]', ''); -- count the number of separator-like characters
if 1 < count then -- param could be |author= or |editor= so one separactor character is acceptable
add_maint_cat ('mult_names', list_name:lower()); -- more than one separator indicates multiple names so add a maint cat for this template
end
end
end
return name; -- and done
end
 
--[[--------------------------< E X T R A C T _ N A M E S >----------------------------------------------------
Gets name list from the input arguments
 
Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
find |last4= and |last5= then the search is done.
 
This function emits an error message when there is a |firstn= without a matching |lastn=. When there are 'holes' in the list of last names, |last1= and |last3=
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
 
When an author or editor parameter contains some form of 'et al.', the 'et al.' is stripped from the parameter and a flag (etal) returned
that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration.  This keeps 'et al.' out of the
template's metadata.  When this occurs, the page is added to a maintenance category.
 
]]
 
local function extract_names(args, list_name)
local names = {}; -- table of names
local last; -- individual name components
local first;
local link;
local mask;
local i = 1; -- loop counter/indexer
local n = 1; -- output table indexer
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
local etal=false; -- return value set to true when we find some form of et al. in an author parameter
 
local err_msg_list_name = list_name:match ("(%w+)List") .. 's list'; -- modify AuthorList or EditorList for use in error messages if necessary
while true do
last = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 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 );
 
last, etal = name_has_etal (last, etal, false); -- find and remove variations on et al.
first, etal = name_has_etal (first, etal, false); -- find and remove variations on et al.
last = name_has_mult_names (last, err_msg_list_name); -- check for multiple names in last and its aliases
if first and not last then -- if there is a firstn without a matching lastn
table.insert( z.message_tail, { set_error( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
count = count + 1; -- number of times we haven't found last and first
if 2 <= count then -- two missing names and we give up
break; -- normal exit or there is a two-name hole in the list; can't tell which
end
else -- we have last with or without a first
link_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup
 
names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only)
n = n + 1; -- point to next location in the names table
if 1 == count then -- if the previous name was missing
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
end
i = i + 1; -- point to next args location
end
end
return names, etal; -- all done, return our list of names
if is_embargoed(embargo) then
end
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat; --still embargoed so no external link
 
else
--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
text = externallinkid({link = handler.link, label = handler.label, --no embargo date, ok to link to article
 
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code.
 
Returns the language name and associated two- or three-character code.  Because case of the source may be incorrect
or different from the case that WikiMedia 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 with the code.  When there is no match, we
return the original language name string.
 
mw.language.fetchLanguageNames(<local wiki language>, 'all') return a list of languages that in some cases may include
extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support
code 'cbk' or name 'Chavacano'.
 
Names but that are included in the list will be found if that name is provided in the |language= parameter. For example,
if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'. When names are found
and the associated code is not two or three characters, this function returns only the Wikimedia language name.
 
Adapted from code taken from Module:Check ISO 639-1.
 
]]
 
local function get_iso639_code (lang, this_wiki_code)
local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia
-- ('all' is required for North Ndebele, South Ndebele, and Ojibwa)
local langlc = mw.ustring.lower(lang); -- lower case version for comparisons
for code, name in pairs(languages) do -- scan the list to see if we can find our language
if langlc == mw.ustring.lower(name) then
if 2 ~= code:len() and 3 ~= code:len() then -- two- or three-character codes only; extensions not supported
return name; -- so return the name but not the code
end
return name, code; -- found it, return name to ensure proper capitalization and the the code
end
end
end
return lang; -- not valid language; return language in original case and nil for the code
return text;
end
end


--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
-- Formats a DOI and checks for DOI errors.
 
Gets language name from a provided two- or three-character ISO 639 code.  If a code is recognized by MediaWiki,
use the returned name; if not, then use the value that was provided with the language parameter.
 
When |language= contains a recognized language (either code or name), the page is assigned to the category for
that code: Category:Norwegian-language sources (no).  For valid three-character code languages, the page is assigned
to the single category for '639-2' codes: Category:CS1 ISO 639-2 language sources.
 
Languages that are the same as the local wiki are not categorized.  MediaWiki does not recognize three-character
equivalents of two-character codes: code 'ar' is recognized bit 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.
 
]]
 
local function language_parameter (lang)
local code; -- the two- or three-character language code
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
local names_table = {}; -- table made from the value assigned to |language=


local this_wiki = mw.getContentLanguage(); -- get a language object for this wiki
-- DOI names contain two parts: prefix and suffix separated by a forward slash.
local this_wiki_code = this_wiki:getCode() -- get this wiki's language code
-- Prefix: directory indicator '10.' followed by a registrant code
local this_wiki_name = mw.language.fetchLanguageName(this_wiki_code, this_wiki_code); -- get this wiki's language name
-- Suffix: character string of any length chosen by the registrant


names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
-- This function checks a DOI name for: prefix/suffix. If the doi name contains spaces or endashes,
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.


for _, lang in ipairs (names_table) do -- reuse lang
-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.


if lang:match ('^%a%a%-') then -- strip ietf language tags from code; TODO: is there a need to support 3-char with tag?
function doi(id, inactive)
lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code?
    local cat = ""
end
    local handler = cfg.id_handlers['DOI'];
if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code
   
name = mw.language.fetchLanguageName( lang:lower(), this_wiki_code); -- get language name if |language= is a proper code
    local text;
end
if is_set(inactive) then
local inactive_year = inactive:match("%d%d%d%d") or ''; -- try to get the year portion from the inactive date
if is_set (name) then -- if |language= specified a valid code
text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
code = lang:lower(); -- save it
if is_set(inactive_year) then
table.insert( z.error_categories, "Sider med inaktiv DOI" );
else
else
name, code = get_iso639_code (lang, this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization)
table.insert( z.error_categories, "Sider med inaktiv DOI" ); -- when inactive doesn't contain a recognizable year
end
end
inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
if is_set (code) then -- only 2- or 3-character codes
else  
if this_wiki_code ~= code then -- when the language is not the same as this wiki's language
text = externallinkid({link = handler.link, label = handler.label,
if 2 == code:len() then -- and is a two-character code
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
add_prop_cat ('foreign_lang_source', {name, code}) -- categorize it
inactive = ""
else -- or is a recognized language (but has a three-character code)
add_prop_cat ('foreign_lang_source_2', {code}) -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
end
end
else
add_maint_cat ('unknown_lang'); -- add maint category if not already added
end
table.insert (language_list, name);
name = ''; -- so we can reuse it
end
end
 
code = #language_list -- reuse code as number of languages in the list
if nil == id:match("^10%.[^%s–]-/[^%s–]-[^%.,]$") then -- doi must begin with '10.', must contain a fwd slash, must not contain spaces or endashes, and must not end with period or comma
if 2 >= code then
cat = ' ' .. seterror( 'bad_doi' );
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
end
if this_wiki_name == name then
return text .. inactive .. cat
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 ...)'
end
end


--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
-- Formats an OpenLibrary link, and checks for associated errors.
 
function openlibrary(id)
Set style settings for CS1 citation templates. Returns separator and postscript settings
    local code = id:sub(-1,-1)
 
    local handler = cfg.id_handlers['OL'];
]]
    if ( code == "A" ) then
 
        return externallinkid({link=handler.link, label=handler.label,
local function set_cs1_style (ps)
            prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
if not is_set (ps) then -- unless explicitely set to something
            encode = handler.encode})
ps = '.'; -- terminate the rendered citation with a period
    elseif ( code == "M" ) then
end
        return externallinkid({link=handler.link, label=handler.label,
return '.', ps; -- separator is a full stop
            prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
            encode = handler.encode})
    elseif ( code == "W" ) then
        return externallinkid({link=handler.link, label=handler.label,
            prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
            encode = handler.encode})
    else
        return externallinkid({link=handler.link, label=handler.label,
            prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
            encode = handler.encode}) ..
            ' ' .. seterror( 'bad_ol' );
    end
end
end


--[[--------------------------< S E T _ C S 2 _ S T Y 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
Set style settings for CS2 citation templates. Returns separator, postscript, ref settings
digits with a space. When that condition occurred, the resulting link looked like this:


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


local function set_cs2_style (ps, ref)
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and ndashes from the issn
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
ps = ''; -- make sure it isn't nil
end
if not is_set (ref) then -- if |ref= is not set
ref = "harv"; -- set default |ref=harv
end
return ',', ps, ref; -- separator is a comma
end


--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 didgits long, containing only 0-9 or X in the last position
 
valid_issn=false; -- wrong length or improper character
When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
else
rendered style.
valid_issn=is_valid_isxn(id, 8); -- validate issn
 
]]
 
local function get_settings_from_cite_class (ps, ref, cite_class)
local sep;
if (cite_class == "citation") then -- for citation templates (CS2)
sep, ps, ref = set_cs2_style (ps, ref);
else -- not a citation template so CS1
sep, ps = set_cs1_style (ps);
end
end


return sep, ps, ref -- return them all
if true == valid_issn then
end
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
 
else
--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
id = issn_copy; -- if not valid, use the show the invalid issn with error message
 
Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
config.CitationClass from the template's #invoke: to establish style.
 
]]
 
local function set_style (mode, ps, ref, cite_class)
local sep;
if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style
sep, ps, ref = set_cs2_style (ps, ref);
elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style
sep, ps = set_cs1_style (ps);
else -- anything but cs1 or cs2
sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass
end
if 'none' == ps:lower() then -- if assigned value is 'none' then
ps = ''; -- set to empty string
end
end
return sep, ps, ref
text = externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
if false == valid_issn then
text = text .. ' ' .. seterror( 'bad_issn' ) -- add an error message if the issn is invalid
end
return text
end
end


--[=[-------------------------< I S _ P D F >------------------------------------------------------------------
--[[
 
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
Determines if a url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.css]] when
Also handles the special case where it is desireable to omit the title type from the rendered citation (|type=none).
applying the pdf icon to external links.
 
returns true if file extension is one of the recognized extension, else false
 
]=]
 
local function is_pdf (url)
return url:match ('%.pdf[%?#]?') or url:match ('%.PDF[%?#]?');
end
 
--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------
 
Applies css style to |format=, |chapter-format=, etc.  Also emits an error message if the format parameter does
not have a matching url parameter.  If the format parameter is not set and the url contains a file extension that
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
the appropriate styling.
 
]]
]]
 
function set_titletype(cite_class, title_type)
local function style_format (format, url, fmt_param, url_param)
if is_set(title_type) then
if is_set (format) then
if "none" == title_type then
format = wrap_style ('format', format); -- add leading space, parenthases, resize
title_type = ""; -- if |type=none then type parameter not displayed
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
return title_type; -- if |type= has been set to any other value use that value
format = wrap_style ('format', 'PDF'); -- set format to pdf
else
format = ''; -- empty string for concatenation
end
end
return format;
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 >------------------------
if "AV media notes" == cite_class or "DVD notes" == cite_class then -- if this citation is cite AV media notes or cite DVD notes
return "mediemerknader"; -- display AV media notes / DVD media notes annotation


Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag
elseif "podcast" == cite_class then -- if this citation is cite podcast
to indicate when et al. should be appended to the name list.
return "podcast"; -- display podcast annotation


When the value assigned to |display-xxxxors= is a number greater than or equal to zero, return the number and
elseif "pressrelease" == cite_class then -- if this citation is cite press release
the previous state of the 'etal' flag (false by default but may have been set to true if the name list contains
return "pressemelding"; -- display press release annotation
some variant of the text 'et al.').


When the value assigned to |display-xxxxors= is the keyword 'etal', return a number that is one greater than the
elseif "techreport" == cite_class then -- if this citation is cite techreport
number of authors in the list and set the 'etal' flag true.  This will cause the list_people() to display all of
return "teknisk rapport"; -- display techreport annotation
the names in the name list followed by 'et al.'
 
elseif "thesis" == cite_class then -- if this citation is cite thesis (degree option handled after this function returns)
In all other cases, returns nil and the previous state of the 'etal' flag.
return "avhandling"; -- display simple thesis annotation (without |degree= modification)
 
inputs:
max: A['DisplayAuthors'] or A['DisplayEditors']; a number or some flavor of etal
count: #a or #e
list_name: 'authors' or 'editors'
etal: author_etal or editor_etal
 
]]
 
local function get_display_authors_editors (max, count, list_name, etal)
if is_set (max) then
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
max = count + 1; -- number of authors + 1 so display all author name plus et al.
etal = true; -- overrides value set by extract_names()
elseif max:match ('^%d+$') then -- if is a string of numbers
max = tonumber (max); -- make it a number
if max >= count then -- 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; as if |display-xxxxors= had not been set
end
end
end
return max, etal;
end
end


--[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------
--[[
 
Determines whether a URL string is valid
Adds page to Category:CS1 maint: extra text if |page= or |pages= has what appears to be some form of p. or pp.
abbreviation in the first characters of the parameter content.
 
check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value:
good pattern: '^P[^%.P%l]' matches when |page(s)= begins PX or P# but not Px where x and X are letters and # is a dgiit
bad pattern: '^[Pp][Pp]' matches matches when |page(s)= begins pp or pP or Pp or PP


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


local function extra_text_in_page_check (page)
-- Removes irrelevant text and dashes from ISBN number
-- local good_pattern = '^P[^%.P%l]';
-- Similar to that used for Special:BookSources
local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg?
function cleanisbn( isbn_str )
-- local bad_pattern = '^[Pp][Pp]';
    return isbn_str:gsub( "[^-0-9X]", "" );
local bad_pattern = '^[Pp]?[Pp]%.?[ %d]';
end


if not page:match (good_pattern) and (page:match (bad_pattern) or  page:match ('^[Pp]ages?')) then
-- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
add_maint_cat ('extra_text');
function get_coins_pages (pages)
if not is_set (pages) then return pages; end -- if no page numbers then we're done
    while true do
pattern = pages:match("%[([%w/:\.]+%s+)[%w%d].*%]"); -- pattern is the opening bracket, the url and following space(s): "[url "
if nil == pattern then break; end -- no more urls
pages = pages:gsub(pattern, ""); -- remove as many instances of pattern as possible
end
end
-- if Page:match ('^[Pp]?[Pp]%.?[ %d]') or  Page:match ('^[Pp]ages?[ %d]') or
pages = pages:gsub("[%[%]]", ""); -- remove the brackets
-- Pages:match ('^[Pp]?[Pp]%.?[ %d]') or  Pages:match ('^[Pp]ages?[ %d]') then
pages = pages:gsub("–", "-" ); -- replace endashes with hyphens
-- add_maint_cat ('extra_text');
pages = pages:gsub("&%w+;", "-" ); -- and replace html entities (&ndash; etc) with hyphens; do we need to replace numerical entities like &#32; and the like?
-- end
return pages;
end
end


 
--[[
--[[--------------------------< P A R S E _ V A U T H O R S _ V E D I T O R S >--------------------------------
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
 
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
This function extracts author / editor names from |vauthors= or |veditors= and finds matching |xxxxor-maskn= and
spaces and other non-isxn characters.
|xxxxor-linkn= in args.  It then returns a table of assembled names just as extract_names() does.
 
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests.
 
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
 
This function sets the vancouver error when a reqired comma is missing and when there is a space between an author's initials.
 
]]
]]
 
function is_valid_isxn (isxn_str, len)
local function parse_vauthors_veditors (args, vparam, list_name)
local temp = 0;
local names = {}; -- table of names assembled from |vauthors=, |author-maskn=, |author-linkn=
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes
local v_name_table = {};
len = len+1; -- adjust to be a loop counter
local etal = false; -- return value set to true when we find some form of et al. vauthors parameter
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
local last, first, link, mask, suffix;
if v == string.byte( "X" ) then -- if checkdigit is X
local corporate = false;
temp = temp + 10*( len - i ); -- it represents 10 decimal
 
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 vparam:find ('%[%[') or vparam:find ('%]%]') then -- no wikilinking vauthors names
add_vanc_error ('wikilink');
end
v_name_table = mw.text.split(vparam, "%s*,%s*") -- names are separated by commas
 
for i, v_name in ipairs(v_name_table) do
if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to supress vanc formatting and error detection
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses
corporate = true; -- flag used in list_people()
elseif string.find(v_name, "%s") then
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
add_vanc_error ('punctuation');
end
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 author intials
if is_suffix (first) then -- if a valid suffix
suffix = first -- save it as a suffix and
first = table.remove(lastfirstTable); -- get what should be the initials from the table
end -- no suffix error message here because letter combination may be result of Romanization; check for digits?
last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
add_vanc_error ('missing comma'); -- 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 ('name'); -- matches a space between two intiials
end
else
else
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
temp = temp + tonumber( string.char(v) )*(len-i);
last = v_name; -- last name or single corporate name?  Doesn't support multiword corporate names? do we need this?
end
end
if is_set (first) then
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
end
is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit
if 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
is_good_vanc_name (last, '');
end
-- this from extract_names ()
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list
end
end
return names, etal; -- all done, return our list of names
return temp % 11 == 0; -- returns true if calculation result is zero
end
end


--[[--------------------------< S E L E C T _ A U T H O R _ E D I T O R _ S O U R C E >------------------------
-- Determines whether an ISBN string is valid
 
function checkisbn( isbn_str )
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
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
select one of |editors=, |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
 
local len = isbn_str:len();
Only one of these appropriate three will be used.  The hierarchy is: |authorn= (and aliases) highest and |authors= lowest and
   
similarly, |editorn= (and aliases) highest and |editors= lowest
if len ~= 10 and len ~= 13 then
 
return false;
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 or editors as appropriate.
 
]]
 
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local lastfirst = false;
if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a first 1 without a last1
select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) then
lastfirst=true;
end
end


if (is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
if len == 10 then
(is_set (vxxxxors) and is_set (xxxxors)) or
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
(true == lastfirst and is_set (xxxxors)) then
return is_valid_isxn(isbn_str, 10);
local err_name;
else
if 'AuthorList' == list_name then -- figure out which name should be used in error message
local temp = 0;
err_name = 'author';
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
else
isbn_str = { isbn_str:byte(1, len) };
err_name = 'editor';
for i, v in ipairs( isbn_str ) do
end
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
table.insert( z.message_tail, { set_error( 'redundant_parameters',
end
{err_name .. '-name-list parameters'}, true ) } ); -- add error message
return temp % 10 == 0;
end
end
end


if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
if is_set (vxxxxors) then return 2 end;
function removewikilink( str )
if is_set (xxxxors) then return 3 end;
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
        return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
    end));
end
end


 
-- Escape sequences for content that will be used for URL descriptions
--[[--------------------------< I S _ V A L I D _ P A R A M E T E R _ V A L U E >------------------------------
function safeforurl( str )
 
    if str:match( "%[%[.-%]%]" ) ~= nil then  
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
of allowable values (yes, y, true, no, etc).  When the parameter value has not been assigned a value (missing or empty
    end
in the source template) the function refurns true.  If the parameter value is one of the list of allowed values returns
   
true; else, emits an error message and returns false.
    return str:gsub( '[%[%]\n]', {   
 
        ['['] = '&#91;',
]]
        [']'] = '&#93;',
 
        ['\n'] = ' ' } );
local function is_valid_parameter_value (value, name, possible)
if not is_set (value) then
return true; -- an empty parameter is ok
elseif in_array(value:lower(), possible) then
return true;
else
table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message
return false
end
end
end


 
-- Converts a hyphen to a dash
--[[--------------------------< T E R M I N A T E _ N A M E _ L I S T >----------------------------------------
function hyphentodash( str )
 
    if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
This function terminates a name list (author, contributor, editor) with a separator character (sepc) and a space
        return str;
when the last character is not a sepc character or when the last three characters are not sepc followed by two
    end   
closing square brackets (close of a wikilink).  When either of these is true, the name_list is terminated with a
    return str:gsub( '-', '–' );
single space character.
 
]]
 
local function terminate_name_list (name_list, sepc)
if (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 terninate the name list
end
end
end


 
-- Protects a string that will be wrapped in wiki italic markup '' ... ''
--[[-------------------------< F O R M A T _ V O L U M E _ I S S U E >----------------------------------------
function safeforitalics( str )
 
    --[[ Note: We can not use <i> for italics, as the expected behavior for
returns the concatenation of the formatted volume and issue parameters as a single string; or formatted volume
    italics specified by ''...'' in the title is that they will be inverted
or formatted issue, or an empty string if neither are set.
    (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
 
    tend to interact poorly under Mediawiki's HTML tidy. ]]
]]
   
    if not is_set(str) then
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
        return str;
if not is_set (volume) and not is_set (issue) then
    else
return '';
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
end
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
       
if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then
        -- Remove newlines as they break italics.
if is_set (volume) and is_set (issue) then
        return str:gsub( '\n', ' ' );
return wrap_msg ('vol-no', {sepc, volume, issue}, lower);
    end
elseif is_set (volume) then
return wrap_msg ('vol', {sepc, volume}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
end
end
local vol = '';
if is_set (volume) then
if (4 < mw.ustring.len(volume)) then
vol = substitute (cfg.messages['j-vol'], {sepc, volume});
else
vol = wrap_style ('vol-bold', hyphen_to_dash(volume));
end
end
if is_set (issue) then
return vol .. substitute (cfg.messages['j-issue'], issue);
end
return vol;
end
end


--[[-------------------------< N O R M A L I Z E _ P A G E _ L I S T >-----------------------------------------
not currently used
normalizes a comma, ampersand, and/or space separated list to be '<value>, <value>, ..., <value>'
returns list unchanged if there are no commas else strips whitespace and then reformats the list
]]
--[[
--[[
local function normalize_page_list (list)
Joins a sequence of strings together while checking for duplicate separation
if not list:find ('[,& ]') then return list end -- if list is not delimited with commas, ampersands, or spaces; done
characters.
list = mw.text.split (list, '[,&%s]+'); -- make a table of values
list = table.concat (list, ', '); -- and now make a normalized list
return list;
end
]]
]]
function safejoin( tbl, duplicate_char )
    --[[
    Note: we use string functions here, rather than ustring functions.
   
    This has considerably faster performance and should work correctly as
    long as the duplicate_char is strict ASCII.  The strings
    in tbl may be ASCII or UTF8.
    ]]
   
    local str = '';
    local comp = '';
    local end_chr = '';
    local trim;
    for _, value in ipairs( tbl ) do
        if value == nil then value = ''; end
       
        if str == '' then
            str = value;
        elseif value ~= '' then
            if value:sub(1,1) == '<' then
                -- Special case of values enclosed in spans and other markup.
                comp = value:gsub( "%b<>", "" );
            else
                comp = value;
            end
           
            if comp:sub(1,1) == duplicate_char then
                trim = false;
                end_chr = str:sub(-1,-1);
                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
                if end_chr == duplicate_char then
                    str = str:sub(1,-2);
                elseif end_chr == "'" then
                    if str:sub(-3,-1) == duplicate_char .. "''" then
                        str = str:sub(1, -4) .. "''";
                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
                        trim = true;
                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
                        trim = true;
                    end
                elseif end_chr == "]" then
                    if str:sub(-3,-1) == duplicate_char .. "]]" then
                        trim = true;
                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
                        trim = true;
                    end
                elseif end_chr == " " then
                    if str:sub(-2,-1) == duplicate_char .. " " then
                        str = str:sub(1,-3);
                    end
                end


--[[-------------------------< F O R M A T _ P A G E S _ S H E E T S >-----------------------------------------
                if trim then
                    if value ~= comp then
                        local dup2 = duplicate_char;
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
                       
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
                    else
                        value = value:sub( 2, -1 );
                    end
                end
            end
            str = str .. value;
        end
    end
    return str;
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.
-- Attempts to convert names to initials.
The return order is:
function reducetoinitials(first)
page, pages, sheet, sheets
    local initials = {}
    for word in string.gmatch(first, "%S+") do
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
    end
    return table.concat(initials) -- Vancouver format does not include spaces.
end


Singular has priority over plural when both are provided.
-- Formats a list of people (e.g. authors / editors)
function listpeople(control, people)
    local sep = control.sep;
    local namesep = control.namesep
    local format = control.format
    local maximum = control.maximum
    local lastauthoramp = control.lastauthoramp;
    local text = {}
    local etal = false;
   
    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
    if maximum ~= nil and maximum < 1 then return "", 0; end
   
    for i,person in ipairs(people) do
        if is_set(person.last) then
            local mask = person.mask
            local one
            local sep_one = sep;
            if maximum ~= nil and i > maximum then
                etal = true;
                break;
            elseif (mask ~= nil) then
                local n = tonumber(mask)
                if (n ~= nil) then
                    one = string.rep("&mdash;",n)
                else
                    one = mask;
                    sep_one = " ";
                end
            else
                one = person.last
                local first = person.first
                if is_set(first) then
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
                    one = one .. namesep .. first
                end
                if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
                if is_set(person.link) and nil ~= person.link:find("//") then one = one .. " " .. seterror( 'bad_authorlink' ) end -- check for url in author link;
            end
            table.insert( text, one )
            table.insert( text, sep_one )
        end
    end


]]
    local count = #text / 2;
    if count > 0 then
        if count > 1 and is_set(lastauthoramp) and not etal then
            text[#text-2] = " & ";
        end
        text[#text] = nil;
    end
   
    local result = table.concat(text) -- construct list
    if etal then
        local etal_text = cfg.messages['et al'];
        result = result .. " " .. etal_text;
    end
   
    -- if necessary wrap result in <span> tag to format in Small Caps
    if ( "scap" == format ) then result =
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    end
    return result, count
end


local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
-- Generates a CITEREF anchor ID.
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
function anchorid( options )
if is_set (sheet) then
    return "CITEREF" .. table.concat( options );
if 'journal' == origin then
end
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
else
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
end
elseif is_set (sheets) then
if 'journal' == origin then
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
else
return '', '', '', wrap_msg ('sheets', {sepc, sheets}, lower);
end
end
end


local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'journal' == origin);
-- Gets name list from the input arguments
function extractnames(args, list_name)
    local names = {};
    local i = 1;
    local last;
   
    while true do
        last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
        if not is_set(last) then
            -- just in case someone passed in an empty parameter
            break;
        end
        names[i] = {
            last = last,
            first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
        };
        i = i + 1;
    end
    return names;
end


if is_set (page) then
-- Populates ID table from arguments using configuration settings
if is_journal then
function extractids( args )
return substitute (cfg.messages['j-page(s)'], page), '', '', '';
    local id_list = {};
elseif not nopp then
    for k, v in pairs( cfg.id_handlers ) do   
return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
        v = selectone( args, v.parameters, 'redundant_parameters' );
else
        if is_set(v) then id_list[k] = v; end
return substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
    end
end
    return id_list;
elseif is_set(pages) then
if is_journal then
return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif not nopp then
return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
else
return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
end
end
return '', '', '', ''; -- return empty strings
end
end


 
-- Takes a table of IDs and turns it into a table of formatted ID outputs.
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
function buildidlist( id_list, options )
 
    local new_list, handler = {};
Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the
   
save snapshot url or to calendar pages.  When the archive url is 'https://web.archive.org/save/' (or http://...)
    function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
archive.org saves a snapshot of the target page in the url.  That is something that Wikipedia should not allow
   
unwitting readers to do.
    for k, v in pairs( id_list ) do
 
        -- fallback to read-only cfg
When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own
        handler = setmetatable( { ['id'] = v }, fallback(k) );
algorithm or provides a calendar 'search' result.  [[WP:ELNO]] discourages links to search results.
       
 
        if handler.mode == 'external' then
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
            table.insert( new_list, {handler.label, externallinkid( handler ) } );
|archive-date= and an error message when:
        elseif handler.mode == 'internal' then
|archive-url= holds an archive.org save command url
            table.insert( new_list, {handler.label, internallinkid( handler ) } );
|archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
        elseif handler.mode ~= 'manual' then
correct place
            error( cfg.messages['unknown_ID_mode'] );
otherwise returns |archive-url= and |archive-date=
        elseif k == 'DOI' then
 
            table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
There are two mostly compatible archive.org urls:
        elseif k == 'ASIN' then
//web.archive.org/<timestamp>... -- the old form
            table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
//web.archive.org/web/<timestamp>... -- the new form
        elseif k == 'LCCN' then
 
            table.insert( new_list, {handler.label, lccn( v ) } );
The old form does not support or map to the new form when it contains a display flag. There are four identified flags
        elseif k == 'OL' then
('id_', 'js_', 'cs_', 'im_') but since archive.org ignores others following the same form (two letters and an underscore)
            table.insert( new_list, {handler.label, openlibrary( v ) } );
we don't check for these specific flags but we do check the form.
        elseif k == 'PMC' then
 
            table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
This function supports a preview mode. When the article is rendered in preview mode, this funct may return a modified
        elseif k == 'PMID' then
archive url:
            table.insert( new_list, {handler.label, pmid( v ) } );
for save command errors, return undated wildcard (/*/)
        elseif k == 'ISSN' then
for timestamp errors when the timestamp has a wildcard, return the url unmodified
        table.insert( new_list, {handler.label, issn( v ) } );
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)
        elseif k == 'ISBN' then
 
            local ISBN = internallinkid( handler );
]=]
            if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
 
                ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
local function archive_url_check (url, date)
            end
local err_msg = ''; -- start with the error message empty
            table.insert( new_list, {handler.label, ISBN } );              
local path, timestamp, flag; -- portions of the archive.or url
        else
            error( cfg.messages['unknown_manual_ID'] );
if not url:match('//web%.archive%.org/') then
        end
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
    end
end
   
 
    function comp( a, b ) -- used in following table.sort()
if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
        return a[1] < b[1];
table.insert( z.message_tail, { set_error( 'archive_url', {'save command'}, true ) } ); -- add error message
    end
if Preview_mode then
   
return url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1), date; -- preview mode: modify and return ArchiveURL and ArchiveDate
    table.sort( new_list, comp );
else
    for k, v in ipairs( new_list ) do
return '', ''; -- return empty strings for archiveURL and ArchiveDate
        new_list[k] = v[2];
end
    end
end
   
 
    return new_list;
-- if url:match('//web%.archive%.org/web/%*/') or url:match('//web%.archive%.org/%*/') then -- wildcard with or without 'web/' path element
end
-- table.insert( z.message_tail, { set_error( 'archive_url', {'wildcard'}, true ) } ); -- add error message and
 
-- return '', ''; -- return empty strings for archiveURL and ArchiveDate
-- Chooses one matching parameter from a list of parameters to consider
-- end
-- Generates an error if more than one match is present.
function selectone( args, possible, error_condition, index )
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation
    local value = nil;
    local selected = '';
if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
    local error_list = {};
err_msg = 'timestamp';
   
if '*' ~= flag then
    if index ~= nil then index = tostring(index); end
url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
   
end
    -- Handle special case of "#" replaced by empty string
elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
    if index == '1' then
err_msg = 'path';
        for _, v in ipairs( possible ) do
elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
            v = v:gsub( "#", "" );
err_msg = 'flag';
            if is_set(args[v]) then
elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
                if value ~= nil and selected ~= v then
err_msg = 'flag';
                    table.insert( error_list, v );
else
                else
return url, date; -- return archiveURL and ArchiveDate
                    value = args[v];
end
                    selected = v;
-- if here something not right so
                end
table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and
            end
if Preview_mode then
        end       
return url, date; -- preview mode so return archiveURL and ArchiveDate
    end
else
   
return '', ''; -- return empty strings for archiveURL and ArchiveDate
    for _, v in ipairs( possible ) do
end
        if index ~= nil then
            v = v:gsub( "#", index );
        end
        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
   
    if #error_list > 0 then
        local error_str = "";
        for _, k in ipairs( error_list ) do
            if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
            error_str = error_str .. wrap( 'parameter', k );
        end
        if #error_list > 1 then
            error_str = error_str .. cfg.messages['parameter-final-separator'];
        else
            error_str = error_str .. cfg.messages['parameter-pair-separator'];
        end
        error_str = error_str .. wrap( 'parameter', selected );
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    end
   
    return value, selected;
end
end


 
-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
--[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------
-- the citation information.
 
function COinS(data)
Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal
    if 'table' ~= type(data) or nil == next(data) then
sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a
        return '';
parameter that is missing its pipe:
    end
{{cite ... |title=Title access-date=2016-03-17}}
   
 
    local ctx_ver = "Z39.88-2004";
cs1|2 shares some parameter names with xml/html atributes: class=, title=, etc. To prevent false positives xml/html
   
tags are removed before the search.
    -- treat table strictly as an array with only set values.
 
    local OCinSoutput = setmetatable( {}, {
If a missing pipe is detected, this function adds the missing pipe maintenance category.
        __newindex = function(self, key, value)
 
            if is_set(value) then
]]
                rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
 
            end
local function missing_pipe_check (value)
        end
local capture;
    });
value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc
   
 
    if is_set(data.Chapter) then
capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
if capture and validate (capture) then -- if the capture is a valid parameter name
        OCinSoutput["rft.genre"] = "bookitem";
add_maint_cat ('missing_pipe');
        OCinSoutput["rft.btitle"] = data.Chapter;
end
        OCinSoutput["rft.atitle"] = data.Title;
    elseif is_set(data.Periodical) then
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
        OCinSoutput["rft.genre"] = "article";
        OCinSoutput["rft.jtitle"] = data.Periodical;
        OCinSoutput["rft.atitle"] = data.Title;
    else
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
        OCinSoutput["rft.genre"] = "book"
        OCinSoutput["rft.btitle"] = data.Title;
    end
   
    OCinSoutput["rft.place"] = data.PublicationPlace;
    OCinSoutput["rft.date"] = data.Date;
    OCinSoutput["rft.series"] = data.Series;
    OCinSoutput["rft.volume"] = data.Volume;
    OCinSoutput["rft.issue"] = data.Issue;
    OCinSoutput["rft.pages"] = data.Pages;
    OCinSoutput["rft.edition"] = data.Edition;
    OCinSoutput["rft.pub"] = data.PublisherName;
   
    for k, v in pairs( data.ID_list ) do
        local id, value = cfg.id_handlers[k].COinS;
        if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
        if string.sub( id or "", 1, 4 ) == 'info' then
            OCinSoutput["rft_id"] = table.concat{ id, "/", v };
        else
            OCinSoutput[ id ] = value;
        end
    end
   
    local last, first;
    for k, v in ipairs( data.Authors ) do
        last, first = v.last, v.first;
        if k == 1 then
            if is_set(last) then
                OCinSoutput["rft.aulast"] = last;
            end
            if is_set(first) then
                OCinSoutput["rft.aufirst"] = first;
            end
        end
        if is_set(last) and is_set(first) then
            OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
        elseif is_set(last) then
            OCinSoutput["rft.au"] = last;
        end
    end
   
    OCinSoutput.rft_id = data.URL;
    OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
    OCinSoutput = setmetatable( OCinSoutput, nil );
   
    -- sort with version string always first, and combine.
    table.sort( OCinSoutput );
    table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
    return table.concat(OCinSoutput, "&");
end
end


 
--[[
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
This is the main function doing the majority of the citation
 
formatting.
This is the main function doing the majority of the citation formatting.
 
]]
]]
function citation0( config, args)
    --[[
    Load Input Parameters
    The argment_wrapper facillitates the mapping of multiple
    aliases to single internal variable.
    ]]
    local A = argument_wrapper( args );


local function citation0( config, args)
    local i
--[[
    local PPrefix = A['PPrefix']
Load Input Parameters
    local PPPrefix = A['PPPrefix']
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
    if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
]]
   
local A = argument_wrapper( args );
    -- Pick out the relevant fields from the arguments.  Different citation templates
local i
    -- define different field names for the same underlying things.  
 
    local Authors = A['Authors'];
-- Pick out the relevant fields from the arguments.  Different citation templates
    local a = extractnames( args, 'AuthorList' );
-- 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 NameListFormat = A['NameListFormat'];
local Collaboration = A['Collaboration'];
 
do -- to limit scope of selected
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
if 1 == selected then
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
elseif 2 == selected then
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
elseif 3 == selected then
Authors = A['Authors']; -- use content of |authors=
end
if is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end
 
local Coauthors = A['Coauthors'];
local Others = A['Others'];
 
local editor_etal;
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
local Editors;
 
do -- to limit scope of selected
local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
if 1 == selected then
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
elseif 2 == selected then
NameListFormat = 'vanc'; -- override whatever |name-list-format= might be
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
elseif 3 == selected then
Editors = A['Editors']; -- use content of |editors=
end
end
 
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
local Translators; -- assembled translators name list
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
local Contributors; -- assembled contributors name list
local Contribution = A['Contribution'];
if in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
if 0 < #c then
if not is_set (Contribution) then -- |contributor= requires |contribution=
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
if 0 == #a then -- |contributor= requires |author=
table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
else -- if not a book cite
if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message
end
Contribution = nil; -- unset
end


if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc'
    local Coauthors = A['Coauthors'];
NameListFormat = ''; -- anything else, set to empty string
    local Others = A['Others'];
end
    local Editors = A['Editors'];
 
    local e = extractnames( args, 'EditorList' );
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'];
link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set
 
local Chapter = A['Chapter'];
local ScriptChapter = A['ScriptChapter'];
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
local TransChapter = A['TransChapter'];
local TitleType = A['TitleType'];
local Degree = A['Degree'];
local Docket = A['Docket'];
local ArchiveFormat = A['ArchiveFormat'];
 
local ArchiveDate;
local ArchiveURL;
 
ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
local DeadURL = A['DeadURL']
if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes'
DeadURL = ''; -- anything else, set to empty string
end


local URL = A['URL']
    local Year = A['Year'];
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL
    local PublicationDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['PublicationDate'], 'n' } };
local ChapterURL = A['ChapterURL'];
    local OrigYear = A['OrigYear'];
local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
    local Date = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['Date'], 'n' } };
local ConferenceFormat = A['ConferenceFormat'];
    local LayDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['LayDate'], 'n' } };
local ConferenceURL = A['ConferenceURL'];
    ------------------------------------------------- Get title data
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
    local Title = A['Title'];
local Periodical = A['Periodical'];
    local BookTitle = A['BookTitle'];
local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
    local Conference = A['Conference'];
    local TransTitle = A['TransTitle'];
    local TitleNote = A['TitleNote'];
    local TitleLink = A['TitleLink'];
    local Chapter = A['Chapter'];
    local ChapterLink = A['ChapterLink'];
    local TransChapter = A['TransChapter'];
    local TitleType = A['TitleType'];
    local Degree = A['Degree'];
    local Docket = A['Docket'];
    local ArchiveURL = A['ArchiveURL'];
    local URL = A['URL']
    local URLorigin = A:ORIGIN('URL');
    local ChapterURL = A['ChapterURL'];
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
    local Periodical = A['Periodical'];


local Series = A['Series'];
local Series = A['Series'];
    local Volume = A['Volume'];
local Volume;
    local Issue = A['Issue'];
local Issue;
    local Position = '';
local Page;
    local Page = A['Page'];
local Pages;
    local Pages = hyphentodash( A['Pages'] );
local At;
    local At = A['At'];
 
if in_array (config.CitationClass, cfg.templates_using_volume) and not ('conference' == config.CitationClass and not is_set (Periodical)) then
Volume = A['Volume'];
end
if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then
Issue = A['Issue'];
end
local Position = '';
if not in_array (config.CitationClass, cfg.templates_not_using_page) then
Page = A['Page'];
Pages = hyphen_to_dash( A['Pages'] );
At = A['At'];
end


local Edition = A['Edition'];
    local Edition = A['Edition'];
local PublicationPlace = A['PublicationPlace']
    local PublicationPlace = A['PublicationPlace']
local Place = A['Place'];
    local Place = A['Place'];
   
local PublisherName = A['PublisherName'];
    local PublisherName = A['PublisherName'];
local RegistrationRequired = A['RegistrationRequired'];
    local RegistrationRequired = A['RegistrationRequired'];
if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then
    local SubscriptionRequired = A['SubscriptionRequired'];
RegistrationRequired=nil;
    local Via = A['Via'];
end
    local AccessDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['AccessDate'], 'n' } };
local SubscriptionRequired = A['SubscriptionRequired'];
    local ArchiveDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['ArchiveDate'], 'n' } };
if not is_valid_parameter_value (SubscriptionRequired, 'subscription', cfg.keywords ['yes_true_y']) then
    local Agency = A['Agency'];
SubscriptionRequired=nil;
    local DeadURL = A['DeadURL']
end
    local Language = A['Language'];
 
    local Format = A['Format'];
local Via = A['Via'];
    local Ref = A['Ref'];
local AccessDate = A['AccessDate'];
local Agency = A['Agency'];
 
local Language = A['Language'];
local Format = A['Format'];
local ChapterFormat = A['ChapterFormat'];
local DoiBroken = A['DoiBroken'];
local DoiBroken = A['DoiBroken'];
local ID = A['ID'];
local ID = A['ID'];
local ASINTLD = A['ASINTLD'];
    local ASINTLD = A['ASINTLD'];
local IgnoreISBN = A['IgnoreISBN'];
    local IgnoreISBN = A['IgnoreISBN'];
if not is_valid_parameter_value (IgnoreISBN, 'ignore-isbn-error', cfg.keywords ['yes_true_y']) then
    local Embargo = A['Embargo'];
IgnoreISBN = nil; -- anything else, set to empty string
end
local Embargo = A['Embargo'];
local Class = A['Class']; -- arxiv class identifier


local ID_list = extract_ids( args );
    local ID_list = extractids( args );
   
    local Quote = A['Quote'];
    local PostScript = A['PostScript'];


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


local LayFormat = A['LayFormat'];
    local LastAuthorAmp = A['LastAuthorAmp'];
local LayURL = A['LayURL'];
    local no_tracking_cats = A['NoTracking'];
local LaySource = A['LaySource'];
local Transcript = A['Transcript'];
local TranscriptFormat = A['TranscriptFormat'];
local TranscriptURL = A['TranscriptURL']
local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL
 
local LastAuthorAmp = A['LastAuthorAmp'];
if not is_valid_parameter_value (LastAuthorAmp, 'last-author-amp', cfg.keywords ['yes_true_y']) then
LastAuthorAmp = nil; -- set to empty string
end
local no_tracking_cats = A['NoTracking'];
if not is_valid_parameter_value (no_tracking_cats, 'no-tracking', cfg.keywords ['yes_true_y']) then
no_tracking_cats = nil; -- set to empty string
end


--these are used by cite interview
--these are used by cite interview
local Callsign = A['Callsign'];
local Callsign = A['Callsign'];
local City = A['City'];
local City = A['City'];
local Cointerviewers = A['Cointerviewers']; -- deprecated
local Interviewer = A['Interviewer']; -- deprecated
local Program = A['Program'];
local Program = A['Program'];


--local variables that are not cs1 parameters
--local variables that are not cs1 parameters
local use_lowercase; -- controls capitalization of certain static text
    local page_type; -- is this needed?  Doesn't appear to be used anywhere;
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
    local use_lowercase = ( sepc ~= '.' );
local anchor_year; -- used in the CITEREF identifier
    local this_page = mw.title.getCurrentTitle(); --Also used for COinS and for language
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
local anchor_year; -- used in the CITEREF identifier
 
local COinS_date; -- used in the COinS metadata
local DF = A['DF']; -- date format set in cs1|2 template
if not is_valid_parameter_value (DF, 'df', cfg.keywords['date-format']) then -- validate reformatting keyword
DF = ''; -- not valid, set to empty string
end
 
-- set default parameter values defined by |mode= parameter.  If |mode= is empty or omitted, use CitationClass to set these values
local Mode = A['Mode'];
if not is_valid_parameter_value (Mode, 'mode', cfg.keywords['mode']) then
Mode = '';
end
local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
local PostScript;
local Ref;
sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass);
use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text


--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
-- Set postscript default.
if not is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if not is_set (PostScript) then -- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
if (config.CitationClass ~= "citation") then -- this template is not a citation template
no_tracking_cats = "true"; -- set no_tracking_cats
PostScript = '.'; -- must be a cite xxx template so set postscript to default (period)
end
end
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
else
if this_page.text:match (v) then -- test page name against each pattern
if PostScript:lower() == 'none' then -- if |postscript=none then
no_tracking_cats = "true"; -- set no_tracking_cats
PostScript = ''; -- no postscript
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)
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories.
select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category
if not is_set(no_tracking_cats) then -- ignore if we are already not going to categorize this page
for k, v in pairs( cfg.uncategorized_namespaces ) do -- otherwise, spin through the list of namespaces we don't include in error categories
if this_page.nsText == v then -- if we find one
no_tracking_cats = "true"; -- set no_trackin_cats
break; -- and we're done
            end
        end
    end


local NoPP = A['NoPP']
-- check for extra |page=, |pages= or |at= parameters.
if is_set (NoPP) and is_valid_parameter_value (NoPP, 'nopp', cfg.keywords ['yes_true_y']) then
    if is_set(Page) then
NoPP = true;
        if is_set(Pages) or is_set(At) then
else
            Page = Page .. " " .. seterror('extra_pages'); -- add error message
NoPP = nil; -- unset, used as a flag later
            Pages = ''; -- unset the others
end
            At = '';
 
        end
if is_set(Page) then
    elseif is_set(Pages) then
if is_set(Pages) or is_set(At) then
        if is_set(At) then
Pages = ''; -- unset the others
            Pages = Pages .. " " .. seterror('extra_pages'); -- add error messages
At = '';
            At = ''; -- unset
end
        end
extra_text_in_page_check (Page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
    end  
elseif is_set(Pages) then
if is_set(At) then
At = ''; -- unset
end
extra_text_in_page_check (Pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
end


-- both |publication-place= and |place= (|location=) allowed if different
-- both |publication-place= and |place= (|location=) allowed if different
if not is_set(PublicationPlace) and is_set(Place) then
    if not is_set(PublicationPlace) and is_set(Place) then
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
        PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
    end
   
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
    if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
   
--[[
--[[
Parameter remapping for cite encyclopedia:
Parameter remapping for cite encyclopedia:
Linje 2 141: Linje 1 177:


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


All other combinations of |encyclopedia, |title, and |article are not modified
All other combinations of |encyclopedia, |title, and |article are not modified
]]
]]
 
if ( config.CitationClass == "encyclopaedia" ) then
local Encyclopedia = A['Encyclopedia'];
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
 
if is_set(Title) then
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) or is_set (ScriptTitle) then
if not is_set(Chapter) then
if not is_set(Chapter) then
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
ScriptChapter = ScriptTitle;
TransChapter = TransTitle;
TransChapter = TransTitle;
ChapterURL = URL;
if not is_set (ChapterURL) and is_set (TitleLink) then
Chapter= '[[' .. TitleLink .. '|' .. Chapter .. ']]';
end
Title = Periodical;
Title = Periodical;
ChapterFormat = Format;
Periodical = ''; -- redundant so unset
Periodical = ''; -- redundant so unset
TransTitle = ''; -- redundant so unset
TransTitle = '';
URL = '';
Format = '';
TitleLink = '';
ScriptTitle = '';
end
end
else -- |title not set
else -- |title not set
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Periodical = ''; -- redundant so unset
Periodical = ''; -- redundant so unset
end
end
end
end
end
--special cases for citation.
if (config.CitationClass == "citation") then -- for citation templates
if not is_set (Ref) then -- if |ref= is not set
Ref = "harv"; -- set default |ref=harv
end
if not is_set (sepc) then -- if |separator= is not set
sepc = ','; -- set citation separator to its default (comma)
end
else -- not a citation template
if not is_set (sepc) then -- if |separator= has not been set
sepc = '.'; -- set cite xxx separator to its default (period)
end
end
-- check for specital case where |separator=none
if 'none' == sepc:lower() then -- if |separator=none
sepc = ''; -- then set it to a empty string
end
end


-- Special case for cite techreport.
-- Special case for cite techreport.
if (config.CitationClass == "techreport") then -- special case for cite techreport
if (config.CitationClass == "techreport") then -- special case for cite techreport
if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
if not is_set(ID) then -- can we use ID for the "number"?
if not is_set(ID) then -- can we use ID for the "number"?
ID = A['Number']; -- yes, use it
ID = Issue; -- yes, use it
else -- ID has a value so emit error message
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )});
else -- can't use ID so emit error message
ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
end
end
end
end
Linje 2 207: Linje 1 248:
end
end


if is_set(Others) then
if is_set(Interviewer) then
if is_set(TitleType) then
if is_set(TitleType) then
Others = ' ' .. TitleType .. ' with ' .. Others;
Others = ' ' .. TitleType .. ' with ' .. Interviewer;
TitleType = '';
TitleType = '';
else
else
Others = ' ' .. 'Interview with ' .. Others;
Others = ' ' .. 'Interview with ' .. Interviewer;
end
if is_set(Cointerviewers) then
Others = Others .. sepc .. ' ' .. Cointerviewers;
end
end
else
else
Linje 2 219: Linje 1 263:
end
end


-- special case for cite mailing list
--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
if (config.CitationClass == "mailinglist") then
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
Periodical = A ['MailingList'];
if not is_embargoed(Embargo) then
elseif 'mailinglist' == A:ORIGIN('Periodical') then
URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
Periodical = ''; -- unset because mailing list is only used for cite mailing list
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
end
end
end


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
if 'conference' == config.CitationClass then
--TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
if is_set(BookTitle) then
if is_set(BookTitle) then
Chapter = Title;
Chapter = Title;
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
ChapterLink = TitleLink;
ChapterURL = URL;
TransChapter = TransTitle;
ChapterURLorigin = URLorigin;
Title = BookTitle;
URLorigin = '';
TitleLink = '';
ChapterFormat = Format;
TransTitle = '';
TransChapter = TransTitle;
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
 
-- 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
end


-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
--[[ -- {{cite episode}} is not currently supported by this module
if config.CitationClass == "episode" then
local AirDate = A['AirDate'];
local AirDate = A['AirDate'];
local SeriesLink = A['SeriesLink'];
local SeriesLink = A['SeriesLink'];
 
local Season = A['Season'];
link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set
local SeriesNumber = A['SeriesNumber'];
 
local Network = A['Network'];
local Network = A['Network'];
local Station = A['Station'];
local Station = A['Station'];
local s, n = {}, {};
local s, n = {}, {};
-- do common parameters first
local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
if is_set(Network) then table.insert(n, Network); end
if is_set(Network) then table.insert(n, Network); end
if is_set(Station) then table.insert(n, Station); end
if is_set(Station) then table.insert(n, Station); end
ID = table.concat(n, sepc .. ' ');
if not is_set (Date) and is_set (AirDate) then -- promote airdate to date
Date = Date or AirDate;
Date = AirDate;
Chapter = Title;
end
ChapterLink = TitleLink;
 
TransChapter = TransTitle;
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
Title = Series;
local Season = A['Season'];
TitleLink = SeriesLink;
local SeriesNumber = A['SeriesNumber'];
TransTitle = '';
 
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
ScriptChapter = ScriptTitle;
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
 
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
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 = '';
ScriptTitle = '';
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
 
-- Account for the oddities that are {{cite arxiv}}, before generation of COinS data.
if 'arxiv' == config.CitationClass then
if not is_set (ID_list['ARXIV']) then -- |arxiv= or |eprint= required for cite arxiv
table.insert( z.message_tail, { set_error( 'arxiv_missing', {}, true ) } ); -- add error message
elseif is_set (Series) then -- series is an alias of version
ID_list['ARXIV'] = ID_list['ARXIV'] .. Series; -- concatenate version onto the end of the arxiv identifier
Series = ''; -- unset
deprecated_parameter ('version'); -- deprecated parameter but only for cite arxiv
end
if first_set ({AccessDate, At, Chapter, Format, Page, Pages, Periodical, PublisherName, URL, -- a crude list of parameters that are not supported by cite arxiv
Series = table.concat(s, Sep);
ID_list['ASIN'], ID_list['BIBCODE'], ID_list['DOI'], ID_list['ISBN'], ID_list['ISSN'],
ID = table.concat(n, Sep);
ID_list['JFM'], ID_list['JSTOR'], ID_list['LCCN'], ID_list['MR'], ID_list['OCLC'], ID_list['OL'],
ID_list['OSTI'], ID_list['PMC'], ID_list['PMID'], ID_list['RFC'], ID_list['SSRN'], ID_list['USENETID'], ID_list['ZBL']},27) then
table.insert( z.message_tail, { set_error( 'arxiv_params_not_supported', {}, true ) } ); -- 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
end
-- end of {{cite episode}} stuff]]


-- handle type parameter for those CS1 citations that have default values
-- legacy: promote concatenation of |day=, |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
if in_array(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
if not is_set(Date) then
TitleType = set_titletype (config.CitationClass, TitleType);
Date = Year; -- promote Year to Date
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
TitleType = Degree .. " thesis";
if is_set(Date) then
local Month = A['Month'];
if is_set(Month) then
Date = Month .. " " .. Date;
local Day = A['Day']
if is_set(Day) then Date = Day .. ". " .. Date end
end
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promonte PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
end
end
end
end


if is_set(TitleType) then -- if type parameter is specified
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses
end
 
-- legacy: promote concatenation of |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
if not is_set (Date) then
Date = Year; -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if not is_set (Date) and is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
end
end


if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation


--[[
--[[
Linje 2 386: Linje 1 337:
we get the date used in the metadata.
we get the date used in the metadata.


Date validation supporting code is in Module:Citation/CS1/Date_validation
Date validation supporting code is in Modul:Citation/CS1/Date_validation
]]
]]
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
local error_message = '';
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
-- AirDate has been promoted to Date so not necessary to check it
if is_set(error_message) then
local date_parameters_list = {['access-date']=AccessDate, ['archive-date']=ArchiveDate, ['date']=Date, ['doi-broken-date']=DoiBroken,
table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } ); -- add this error message
['embargo']=Embargo, ['lay-date']=LayDate, ['publication-date']=PublicationDate, ['year']=Year};
 
anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);
 
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed;
local mismatch = year_date_check (Year, Date)
if 0 == mismatch then -- |year= does not match a year-value in |date=
if is_set (error_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
if not is_set(error_message) then -- error free dates only
local modified = false; -- flag
if is_set (DF) then -- if we need to reformat dates
modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate
end
 
if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
modified = true;
add_maint_cat ('date_format'); -- hyphens were converted so add maint category
end
if modified then -- if the date_parameters_list values were modified
AccessDate = date_parameters_list['access-date']; -- overwrite date holding parameters with modified values
ArchiveDate = date_parameters_list['archive-date'];
Date = date_parameters_list['date'];
DoiBroken = date_parameters_list['doi-broken-date'];
LayDate = date_parameters_list['lay-date'];
PublicationDate = date_parameters_list['publication-date'];
end
else
table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
end
 
-- if is_set(error_message) then
-- table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message
-- elseif is_set (DF) then
-- if reformat_dates (date_parameters_list, DF, false) then -- reformat to DF format, use long month names if appropriate
-- AccessDate = date_parameters_list['access-date']; -- overwrite date holding parameters with reformatted values
-- ArchiveDate = date_parameters_list['archive-date'];
-- Date = date_parameters_list['date'];
-- DoiBroken = date_parameters_list['doi-broken-date'];
-- LayDate = date_parameters_list['lay-date'];
-- PublicationDate = date_parameters_list['publication-date'];
-- end
-- end
end -- end of do
 
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set.  Do this after date check but before COInS.
-- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date
Embargo = is_embargoed (Embargo); --
 
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
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
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
end
end
end


-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-- Test if citation has no title
if not is_set(Title) and
not is_set(TransTitle) and
not is_set(ScriptTitle) then
if 'episode' == config.CitationClass then -- special case for cite episode; TODO: is there a better way to do this?
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'series'}, true ) } );
else
table.insert( z.message_tail, { set_error( 'citation_missing_title', {'title'}, true ) } );
end
end
if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites
Title = ''; -- set title to empty string
add_maint_cat ('untitled');
end


check_for_url ({ -- add error message when any of these parameters contains a URL
    -- COinS metadata (see <http://ocoins.info/>) for
['title']=Title,
    -- automated parsing of citation information.
[A:ORIGIN('Chapter')]=Chapter,
    local OCinSoutput = COinS{
[A:ORIGIN('Periodical')]=Periodical,
        ['Periodical'] = Periodical,
[A:ORIGIN('PublisherName')] = PublisherName
        ['Chapter'] = Chapter,
});
        ['Title'] = Title,
        ['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(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,
    };


-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
    if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
        Chapter = Title;
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
        ChapterLink = TitleLink;
-- is the article title, and Chapter is a section within the article.  So, we remap
        TransChapter = TransTitle;
        Title = '';
local coins_chapter = Chapter; -- default assuming that remapping not required
        TitleLink = '';
local coins_title = Title; -- et tu
        TransTitle = '';
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
    end
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
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()
    -- Now perform various field substitutions.
local OCinSoutput = COinS({
    -- We also add leading spaces and surrounding markup and punctuation to the
['Periodical'] = Periodical,
    -- various parts of the citation, but only when they are non-nil.
['Encyclopedia'] = Encyclopedia,
    if not is_set(Authors) then
['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
        local Maximum = tonumber( A['DisplayAuthors'] );
['Degree'] = Degree; -- cite thesis only
       
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
        -- Preserve old-style implicit et al.
['PublicationPlace'] = PublicationPlace,
        if not is_set(Maximum) and #a == 9 then
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
            Maximum = 8;
['Season'] = COinS_date.rftssn,
            table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
['Chron'] =  COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
        elseif not is_set(Maximum) then
['Series'] = Series,
            Maximum = #a + 1;
['Volume'] = Volume,
        end
['Issue'] = Issue,
           
['Pages'] = get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
        local control = {
['Edition'] = Edition,
            sep = A["AuthorSeparator"] .. " ",
['PublisherName'] = PublisherName,
            namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
['URL'] = first_set ({ChapterURL, URL}, 2),
            format = A["AuthorFormat"],
['Authors'] = coins_author,
            maximum = Maximum,
['ID_list'] = ID_list,
            lastauthoramp = LastAuthorAmp
['RawPage'] = this_page.prefixedText,
        };
}, config.CitationClass);
       
        -- If the coauthor field is also used, prevent ampersand and et al. formatting.
        if is_set(Coauthors) then
            control.lastauthoramp = nil;
            control.maximum = #a + 1;
        end
       
        Authors = listpeople(control, a)
    end


-- Account for the oddities that are {{cite arxiv}}, AFTER generation of COinS data.
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 'arxiv' == config.CitationClass then -- we have set rft.jtitle in COinS to arXiv, now unset so it isn't displayed
table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } ); -- emit error message
Periodical = ''; -- periodical not allowed in cite arxiv; if article has been published, use cite journal
end
end


-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
    local EditorCount
if 'newsgroup' == config.CitationClass then
    if not is_set(Editors) then
if is_set (PublisherName) then
        local Maximum = tonumber( A['DisplayEditors'] );
PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName') ));
        -- Preserve old-style implicit et al.
end
        if not is_set(Maximum) and #e == 4 then  
end
            Maximum = 3;
 
            table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
 
        elseif not is_set(Maximum) then
            Maximum = #e + 1;
        end


-- Now perform various field substitutions.
        local control = {
-- We also add leading spaces and surrounding markup and punctuation to the
            sep = A["EditorSeparator"] .. " ",
-- various parts of the citation, but only when they are non-nil.
            namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
            format = A['EditorFormat'],
do
            maximum = Maximum,
local last_first_list;
            lastauthoramp = LastAuthorAmp
-- local maximum;
        };
local control = {
format = NameListFormat, -- empty string or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
lastauthoramp = LastAuthorAmp,
page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn
};


do -- do editor name list first because coauthors can modify control table
        Editors, EditorCount = listpeople(control, e);
control.maximum , editor_etal = get_display_authors_editors (A['DisplayEditors'], #e, 'editors', editor_etal);
    else
last_first_list, EditorCount = list_people(control, e, editor_etal);
        EditorCount = 1;
    end


if is_set (Editors) then
    local Cartography = "";
if editor_etal then
    local Scale = "";
Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal
    if config.CitationClass == "map" then
EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation
        if not is_set( Authors ) and is_set( PublisherName ) then
else
            Authors = PublisherName;
EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation
            PublisherName = "";
end
        end
else
        Cartography = A['Cartography'];
Editors = last_first_list; -- either an author name list or an empty string
        if is_set( Cartography ) then
end
            Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
 
        end       
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
        Scale = A['Scale'];
EditorCount = 2; -- spoof to display (eds.) annotation
        if is_set( Scale ) then
end
            Scale = sepc .. " " .. Scale;
end
        end       
do -- now do translators
    end
control.maximum = #t; -- number of translators
   
Translators = list_people(control, t, false); -- et al not currently supported
    if not is_set(URL) and
end
        not is_set(ChapterURL) and
do -- now do contributors
        not is_set(ArchiveURL) and
control.maximum = #c; -- number of contributors
        not is_set(ConferenceURL) and
Contributors = list_people(control, c, false); -- et al not currently supported
        not is_set(TranscriptURL) then
       
        -- Test if cite web or cite podcast |url= is missing or empty
if inArray(config.CitationClass, {"web","podcast"}) then
table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
end
end
do -- now do authors
       
control.maximum , author_etal = get_display_authors_editors (A['DisplayAuthors'], #a, 'authors', author_etal);
        -- Test if accessdate is given without giving a URL
 
        if is_set(AccessDate) then
if is_set(Coauthors) then -- if the coauthor field is also used, prevent ampersand and et al. formatting.
            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
control.lastauthoramp = nil;
            AccessDate = '';
control.maximum = #a + 1;
        end
end
       
        -- Test if format is given without giving a URL
last_first_list = list_people(control, a, author_etal);
        if is_set(Format) then
            Format = Format .. seterror( 'format_missing_url' );
        end
    end
   
    -- Test if citation has no title
    if  not is_set(Chapter) and
        not is_set(Title) and
        not is_set(Periodical) and
        not is_set(Conference) and
        not is_set(TransTitle) and
        not is_set(TransChapter) then
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    end
   
    Format = is_set(Format) and " (" .. Format .. ")" or "";
   
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
    if is_set( ArchiveURL ) then
        if ( DeadURL ~= "no" and DeadURL ~= "nei" ) then
            URL = ArchiveURL
            URLorigin = A:ORIGIN('ArchiveURL')
        end
    end
   
    -- Format chapter / article title
    if is_set(Chapter) and is_set(ChapterLink) then
        Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
    end
    if is_set(Periodical) and is_set(Title) then
        Chapter = wrap( 'italic-title', Chapter );
        TransChapter = wrap( 'trans-italic-title', TransChapter );
    else
Chapter = kern_quotes (Chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
        Chapter = wrap( 'quoted-title', Chapter );
        TransChapter = wrap( 'trans-quoted-title', TransChapter );
    end
   
    local TransError = ""
    if is_set(TransChapter) then
        if not is_set(Chapter) then
            TransError = " " .. seterror( 'trans_missing_chapter' );
        else
            TransChapter = " " .. TransChapter;
        end
    end
   
    Chapter = Chapter .. TransChapter;
   
    if is_set(Chapter) then
        if not is_set(ChapterLink) then
            if is_set(ChapterURL) then
                Chapter = externallink( ChapterURL, Chapter ) .. TransError;
                if not is_set(URL) then
                    Chapter = Chapter .. Format;
                    Format = "";
                end
            elseif is_set(URL) then
                Chapter = externallink( URL, Chapter ) .. TransError .. Format;
                URL = "";
                Format = "";
            else
                Chapter = Chapter .. TransError;
            end           
        elseif is_set(ChapterURL) then
            Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) ..
                TransError;
        else
            Chapter = Chapter .. TransError;
        end
        Chapter = Chapter .. sepc .. " " -- with end-space
    elseif is_set(ChapterURL) then
        Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
    end       
   
    -- Format main title.
    if is_set(TitleLink) and is_set(Title) then
        Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
    end
   
    if is_set(Periodical) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
            not is_set(Chapter) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    else
        Title = wrap( 'italic-title', Title );
        TransTitle = wrap( 'trans-italic-title', TransTitle );
    end
   
    TransError = "";
    if is_set(TransTitle) then
        if not is_set(Title) then
            TransError = " " .. seterror( 'trans_missing_title' );
        else
            TransTitle = " " .. TransTitle;
        end
    end
   
    Title = Title .. TransTitle;
   
    if is_set(Title) then
        if not is_set(TitleLink) and is_set(URL) then
            Title = externallink( URL, Title ) .. TransError .. Format     
            URL = "";
            Format = "";
        else
            Title = Title .. TransError;
        end
    end
   
    if is_set(Place) then
        Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
    end
   
    if is_set(Conference) then
        if is_set(ConferenceURL) then
            Conference = externallink( ConferenceURL, Conference );
        end
        Conference = sepc .. " " .. Conference
    elseif is_set(ConferenceURL) then
        Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
    end
   
    if not is_set(Position) then
        local Minutes = A['Minutes'];
        if is_set(Minutes) then
            Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
        else
            local Time = A['Time'];
            if is_set(Time) then
                local TimeCaption = A['TimeCaption']
                if not is_set(TimeCaption) then
                    TimeCaption = cfg.messages['event'];
                    if sepc ~= '.' then
                        TimeCaption = TimeCaption:lower();
                    end
                end
                Position = " " .. TimeCaption .. " " .. Time;
            end
        end
    else
        Position = " " .. Position;
        At = '';
    end
   
    if not is_set(Page) then
        if is_set(Pages) then
            if is_set(Periodical) and
                not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
                Pages = ", s. " .. Pages;
            elseif tonumber(Pages) ~= nil then
                Pages = sepc .." " .. PPrefix .. Pages;
            else
                Pages = sepc .." " .. PPPrefix .. Pages;
            end
        end
    else
        if is_set(Periodical) and
            not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
            Page = ", s. " .. Page;
        else
            Page = sepc .." " .. PPrefix .. Page;
        end
    end
   
    At = is_set(At) and (sepc .. " " .. At) or "";
    Position = is_set(Position) and (sepc .. " " .. Position) or "";
    if config.CitationClass == 'map' then
        local Section = A['Section'];
        local Inset = A['Inset'];
        if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
            if is_set( Section ) then
                Section = ", " .. wrap( 'section', Section, true );
            end
            if is_set( Inset ) then
                Inset = ", " .. wrap( 'inset', Inset, true );
            end
        else
            if is_set( Section ) then
                Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
                if is_set( Inset ) then
                    Inset = ", " .. wrap( 'inset', Inset, true );
                end
            elseif is_set( Inset ) then
                Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
            end           
        end           
        At = At .. Section .. Inset;       
    end   


if is_set (Authors) then
--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found,
Authors, author_etal = name_has_etal (Authors, author_etal, false); -- find and remove variations on et al.
use that value; if not, then use the value that was provided with the language parameter.
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 is_set (Authors) and is_set (Collaboration) then
Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English).
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
]]
end
if is_set (Language) then
 
-- local name = mw.language.fetchLanguageName( Language:lower(), "en" ); -- experiment: this seems to return correct ISO 639-1 language names
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
local name = cfg.iso639_1[Language:lower()]; -- get the language name if Language parameter has a valid iso 639-1 code
table.insert( z.message_tail, { set_error('coauthors_missing_author', {}, true) } ); -- emit error message
if nil == name then
end
Language=" " .. wrap( 'language', Language ); -- no match, use parameter's value
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');
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
Format = style_format (Format, URL, 'format', 'url');
LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url');
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl');
 
-- special case for chapter format so no error message or cat when chapter not supported
if not (in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) or
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
end
 
if not is_set(URL) then
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
end
-- do we have |accessdate= without either |url= or |chapter-url=?
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set;
table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } );
AccessDate = '';
end
end
 
local OriginalURL, OriginalURLorigin, 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 is_set( ArchiveURL ) then
if is_set (ChapterURL) then -- swapped -- URL not set so if chapter-url is set apply archive url to it
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text
OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages
OriginalFormat = ChapterFormat; -- and original |format=
if 'no' ~= DeadURL then
ChapterURL = ArchiveURL -- swap-in the archive's url
ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
end
elseif is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
OriginalURLorigin = URLorigin; -- name of url parameter for error messages
OriginalFormat = Format; -- and original |format=
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
URL = ArchiveURL -- swap-in the archive's url
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages
Format = ArchiveFormat or ''; -- swap in archive's format
end
end
end
 
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease','podcast', 'newsgroup', 'arxiv'}) or -- if any of the 'periodical' cites except encyclopedia
('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
local chap_param;
if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = A:ORIGIN ('Chapter')
elseif is_set (TransChapter) then
chap_param = A:ORIGIN ('TransChapter')
elseif is_set (ChapterURL) then
chap_param = A:ORIGIN ('ChapterURL')
elseif is_set (ScriptChapter) then
chap_param = A:ORIGIN ('ScriptChapter')
else is_set (ChapterFormat)
chap_param = A:ORIGIN ('ChapterFormat')
end
 
if is_set (chap_param) then -- if we found one
table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- 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 is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if in_array (Contribution:lower(), cfg.keywords.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
end
end
 
Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes); -- Contribution is also in Chapter
if is_set (Chapter) then
Chapter = Chapter .. ChapterFormat ;
if 'map' == config.CitationClass and is_set (TitleType) then
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
Chapter = Chapter.. sepc .. ' ';
elseif 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.
if is_set(TitleLink) and is_set(Title) then
Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
end
 
if in_array(config.CitationClass, {'web','news','journal', 'magazine', '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
 
local TransError = "";
if is_set(TransTitle) then
if is_set(Title) then
TransTitle = " " .. TransTitle;
else
else
TransError = " " .. set_error( 'trans_missing_title', {'title'} );
if 0 == this_page.namespace and 'no' ~= Language:lower() then --found a match; is this page main / article space and Norwegian not the language?
end
Language=" " .. wrap( 'language', name .. '[[Kategori:Artikler med eksterne lenker på ' .. name .. ']]' ); -- in main space and not English: categorize
end
else
Language=" " .. wrap( 'language', name ); --not in mainspace or language is Norwegian so don't categorize
Title = Title .. TransTitle;
if is_set(Title) then
if not is_set(TitleLink) and is_set(URL) then
Title = external_link( URL, Title, URLorigin ) .. TransError .. Format;
-- this experiment hidden 2016-04-10; see Help_talk:Citation_Style_1#Recycled_urls
-- local temp_title = external_link( URL, Title, URLorigin ) .. TransError .. Format; -- do this so we get error message even if url is usurped no archive
-- if in_array (DeadURL, {'unfit no archive', 'usurped no archive'}) then -- when url links to inappropriate location and there is no archive of original source available
-- local err_msg
-- if temp_title:match ('%[%S+%s+(.+)%](<.+)') then -- if there is an error message
-- Title, err_msg = temp_title:match ('%[%S+%s+(.+)%](<.+)'); -- strip off external link; TODO: find a better to do this
-- Title = Title .. (err_msg or '');
-- end
-- else
-- Title = temp_title;
-- end
 
URL = ''; -- unset these because no longer needed
Format = "";
else
Title = Title .. TransError;
end
end
 
if is_set(Place) then
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
end
 
if is_set (Conference) then
if is_set (ConferenceURL) then
Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin );
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif is_set(ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin );
end
 
if not is_set(Position) then
local Minutes = A['Minutes'];
local Time = A['Time'];
 
if is_set(Minutes) then
if is_set (Time) then
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } );
end
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
else
if is_set(Time) then
local TimeCaption = A['TimeCaption']
if not is_set(TimeCaption) then
TimeCaption = cfg.messages['event'];
if sepc ~= '.' then
TimeCaption = TimeCaption:lower();
end
end
Position = " " .. TimeCaption .. " " .. Time;
end
end
end
end
else
else
Position = " " .. Position;
Language=""; -- language not specified so make sure this is an empty string;
At = '';
end
end


Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);
Others = is_set(Others) and (sepc .. " " .. Others) or "";


At = is_set(At) and (sepc .. " " .. At) or "";
-- handle type parameter for those CS1 citations that have default values
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
if inArray(config.CitationClass, {"AV media notes", "DVD notes", "podcast", "pressrelease", "techreport", "thesis"}) then
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
TitleType = set_titletype (config.CitationClass, TitleType);
elseif is_set( Section ) then
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
TitleType = Degree .. " thesis";
end
end
At = At .. Inset .. Section;
end
if is_set (Language) then
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc
else
Language=""; -- language not specified so make sure this is an empty string;
end
end


Others = is_set(Others) and (sepc .. " " .. Others) or "";
if is_set(TitleType) then -- if type parameter is specified
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
if is_set (Translators) then
-- Others = sepc .. ' Translated by ' .. Translators .. Others;
Others = sepc .. ' ' .. wrap_msg ('translated', Translators, use_lowercase) .. Others;  
end
end


TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
if is_set (Edition) then
    Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then
    Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
add_maint_cat ('extra_text', 'edition');
    Series = is_set(Series) and (sepc .. " " .. Series) or "";
end
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
Edition = " " .. wrap_msg ('edition', Edition);
    Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
else
Edition = '';
end
 
Series = is_set(Series) and (sepc .. " " .. Series) or "";
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
 
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);
 
------------------------------------ totally unrelated data
if is_set(Via) then
Via = " " .. wrap_msg ('via', Via);
end


--[[
    if is_set(Volume) then
Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link
        if ( mw.ustring.len(Volume) > 4 )
note is displayed. There are no error messages for this condition.
          then Volume = sepc .." " .. Volume;
          else Volume = ", " .. hyphentodash(Volume);
        end
    end


]]
--[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
if is_set (SubscriptionRequired) then
    if is_set(Volume) then
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message
        if ( mw.ustring.len(Volume) > 4 )
elseif is_set (RegistrationRequired) then
          then Volume = sepc .. " " .. Volume;
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message
          else
else
              Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
SubscriptionRequired = ''; -- either or both might be set to something other than yes true y
              if is_set(Series) then Volume = sepc .. Volume;
end
              end
        end
    end
]]   
    ------------------------------------ totally unrelated data
    --[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
    behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
   
    Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition.
    ]]
    if is_set(Via) then
        Via = " " .. wrap( 'via', Via );
    end


if is_set(AccessDate) then
if is_set(SubscriptionRequired) then
local retrv_text = " " .. cfg.messages['retrieved']
        SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
    elseif is_set(RegistrationRequired) then
        SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
    end


AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
    if is_set(AccessDate) then
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if 'citation', lower case
        local retrv_text = " " .. cfg.messages['retrieved']
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text
        if (sepc ~= ".") then retrv_text = retrv_text:lower() end
-- neither of these work; don't know why; it seems that substitute() isn't being called
        AccessDate = '<span class="reference-accessdate">' .. sepc
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
            .. substitute( retrv_text, {AccessDate} ) .. '</span>'
end
    end
   
if is_set(ID) then ID = sepc .." ".. ID; end
    if is_set(ID) then ID = sepc .." ".. ID; end
   if "thesis" == config.CitationClass and is_set(Docket) then
   if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
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


ID_list = build_id_list( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} );
   
    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );


if is_set(URL) then
    if is_set(URL) then
URL = " " .. external_link( URL, nil, URLorigin );
        URL = " " .. externallink( URL, nil, URLorigin );
end
    end


if is_set(Quote) then
    if is_set(Quote) then
if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then -- if first and last characters of quote are quote marks
        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
Quote = Quote:sub(2,-2); -- strip them off
            Quote = Quote:sub(2,-2);
end
        end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
        Quote = sepc .." " .. wrap( 'quoted-text', Quote );  
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
        PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set
end
    end
   
local Archived
    local Archived
if is_set(ArchiveURL) then
    if is_set(ArchiveURL) then
if not is_set(ArchiveDate) then
        if not is_set(ArchiveDate) then
ArchiveDate = set_error('archive_missing_date');
            ArchiveDate = seterror('archive_missing_date');
end
        end
if "no" == DeadURL then
        if "no" == DeadURL or "nei" == DeadURL then
local arch_text = cfg.messages['archived'];
            local arch_text = cfg.messages['archived'];
if sepc ~= "." then arch_text = arch_text:lower() end
            if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
            Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL') ) .. ArchiveFormat, ArchiveDate } );
                { externallink( ArchiveURL, arch_text ), ArchiveDate } );
if not is_set(OriginalURL) then
            if not is_set(OriginalURL) then
Archived = Archived .. " " .. set_error('archive_missing_url');  
                Archived = Archived .. " " .. seterror('archive_missing_url');                              
end
            end
elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped'
        elseif is_set(OriginalURL) then
local arch_text = cfg.messages['archived-dead'];
            local arch_text = cfg.messages['archived-dead'];
if sepc ~= "." then arch_text = arch_text:lower() end
            if sepc ~= "." then arch_text = arch_text:lower() end
if in_array (DeadURL, {'unfit', 'usurped'}) then
            Archived = sepc .. " " .. substitute( arch_text,
Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled
                { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
else -- DeadURL is empty, 'yes', 'true', or 'y'
        else
Archived = sepc .. " " .. substitute( arch_text,
            local arch_text = cfg.messages['archived-missing'];
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin ) .. OriginalFormat, ArchiveDate } ); -- format already styled
            if sepc ~= "." then arch_text = arch_text:lower() end
end
            Archived = sepc .. " " .. substitute( arch_text,  
else
                { seterror('archive_missing_url'), ArchiveDate } );
local arch_text = cfg.messages['archived-missing'];
        end
if sepc ~= "." then arch_text = arch_text:lower() end
    else
Archived = sepc .. " " .. substitute( arch_text,  
        Archived = ""
{ set_error('archive_missing_url'), ArchiveDate } );
    end
end
   
elseif is_set (ArchiveFormat) then
    local Lay
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
    if is_set(LayURL) then
else
        if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
Archived = ""
        if is_set(LaySource) then  
end
            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
        else
local Lay = '';
            LaySource = "";
if is_set(LayURL) then
        end
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
        if sepc == '.' then
if is_set(LaySource) then  
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
LaySource = " &ndash; ''" .. safe_for_italics(LaySource) .. "''";
        else
else
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
LaySource = "";
        end          
end
    else
if sepc == '.' then
        Lay = "";
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary'], A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate
    end
else
   
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL') ) .. LayFormat .. LaySource .. LayDate
    if is_set(Transcript) then
end
        if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url=
    elseif is_set(TranscriptURL) then
Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message
        Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
end
    end
 
   
if is_set(Transcript) then
    local Publisher;
if is_set(TranscriptURL) then
    if is_set(Periodical) and
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin );
        not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
end
        if is_set(PublisherName) then
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
            if is_set(PublicationPlace) then
elseif is_set(TranscriptURL) then
                Publisher = PublicationPlace .. ": " .. PublisherName;
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin );
            else
end
                Publisher = PublisherName;   
 
            end
local Publisher;
        elseif is_set(PublicationPlace) then
if is_set(Periodical) and
            Publisher= PublicationPlace;
not in_array(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
        else  
if is_set(PublisherName) then
            Publisher = "";
if is_set(PublicationPlace) then
        end
Publisher = PublicationPlace .. ": " .. PublisherName;
        if is_set(PublicationDate) then
else
            if is_set(Publisher) then
Publisher = PublisherName;   
                Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
end
            else
elseif is_set(PublicationPlace) then
                Publisher = PublicationDate;
Publisher= PublicationPlace;
            end
else  
        end
Publisher = "";
        if is_set(Publisher) then
end
            Publisher = " (" .. Publisher .. ")";
if is_set(PublicationDate) then
        end
if is_set(Publisher) then
    else
Publisher = Publisher .. ", " .. wrap_msg ('published', PublicationDate);
        if is_set(PublicationDate) then
else
            PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
Publisher = PublicationDate;
        end
end
        if is_set(PublisherName) then
end
            if is_set(PublicationPlace) then
if is_set(Publisher) then
                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
Publisher = " (" .. Publisher .. ")";
            else
end
                Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
else
            end          
if is_set(PublicationDate) then
        elseif is_set(PublicationPlace) then  
PublicationDate = " (" .. wrap_msg ('published', PublicationDate) .. ")";
            Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
end
        else  
if is_set(PublisherName) then
            Publisher = PublicationDate;
if is_set(PublicationPlace) then
        end
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
    end
else
   
Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
    -- Several of the above rely upon detecting this as nil, so do it last.
end
    if is_set(Periodical) then
elseif is_set(PublicationPlace) then  
        if is_set(Title) or is_set(TitleNote) then  
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
            Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
else  
        else  
Publisher = PublicationDate;
            Periodical = wrap( 'italic-title', Periodical )
end
        end
end
    end
-- Several of the above rely upon detecting this as nil, so do it last.
if is_set(Periodical) then
if is_set(Title) or is_set(TitleNote) then  
Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)  
else  
Periodical = wrap_style ('italic-title', Periodical)
end
end


--[[
--[[
Linje 3 015: Linje 1 884:
end
end


-- Piece all bits together at last.  Here, all should be non-nil.
    -- Piece all bits together at last.  Here, all should be non-nil.
-- We build things this way because it is more efficient in LUA
    -- We build things this way because it is more efficient in LUA
-- not to keep reassigning to the same string variable over and over.
    -- not to keep reassigning to the same string variable over and over.
 
local tcommon;
local tcommon2; -- used for book cite when |contributor= is set
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
if is_set(Others) then Others = Others .. sepc .. " " end
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,
Language, Edition, Publisher, Agency, Volume}, sepc );
elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc
tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, 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
    local tcommon
if is_set (Chapter) then -- map in a book; TitleType is part of Chapter
    if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
        if is_set(Others) then Others = Others .. sepc .. " " end
elseif is_set (Periodical) then -- map in a periodical
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series,  
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
            Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
else -- a sheet or stand-alone map
    else  
tcommon = safe_join( {Title, TitleType, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc );
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language,  
end
            Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
    end
elseif 'episode' == config.CitationClass then -- special case for cite episode
   
tcommon = safe_join( {Title, TitleNote, TitleType, Series, Transcript, Language, Edition, Publisher}, sepc );
    if #ID_list > 0 then
else -- all other CS1 templates
        ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
tcommon = safe_join( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,  
    else
Volume, Others, Edition, Publisher, Agency}, sepc );
        ID_list = ID;
end
    end
   
if #ID_list > 0 then
    local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
ID_list = safe_join( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
    local text;
else
    local pgtext = Position .. Page .. Pages .. At;
ID_list = ID;
   
end
    if is_set(Authors) then
        if is_set(Coauthors) then
local idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
            Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
local text;
        end
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
        if is_set(Date) then
 
            Date = " ("..Date..")" .. OrigYear .. sepc .. " "
if is_set(Date) then
        elseif string.sub(Authors,-1,-1) == sepc then
if is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set
            Authors = Authors .. " "
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses
        else
else -- neither of authors and editors set
            Authors = Authors .. sepc .. " "
if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc
        end
Date = " " .. Date .. OrigYear; -- Date does not begin with sepc
        if is_set(Editors) then
else
            local in_text = " ";
Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc
            local post_text = "";
end
            if is_set(Chapter) then
end
                in_text = in_text .. cfg.messages['in'] .. " "
end
            else
if is_set(Authors) then
                if EditorCount <= 1 then
if is_set(Coauthors) then
                    post_text = ", " .. cfg.messages['editor'];
if 'vanc' == NameListFormat then -- separate authors and coauthors with proper name-list-separator
                else
Authors = Authors .. ', ' .. Coauthors;
                    post_text = ", " .. cfg.messages['editors'];
else
                end
Authors = Authors .. '; ' .. Coauthors;
            end  
end
            if (sepc ~= '.') then in_text = in_text:lower() end
end
            Editors = in_text .. Editors .. post_text;
if not is_set (Date) then -- when date is set it's in parentheses; no Authors termination
            if (string.sub(Editors,-1,-1) == sepc)
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
                then Editors = Editors .. " "
end
                else Editors = Editors .. sepc .. " "
if is_set(Editors) then
            end
local in_text = " ";
        end
local post_text = "";
        text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
if is_set(Chapter) and 0 == #c then
        text = safejoin( {text, pgtext, idcommon}, sepc );
in_text = in_text .. cfg.messages['in'] .. " "
    elseif is_set(Editors) then
if (sepc ~= '.') then in_text = in_text:lower() end -- lowercase for cs2
        if is_set(Date) then
else
            if EditorCount <= 1 then
if EditorCount <= 1 then
                Editors = Editors .. ", " .. cfg.messages['editor'];
post_text = ", " .. cfg.messages['editor'];
            else
else
                Editors = Editors .. ", " .. cfg.messages['editors'];
post_text = ", " .. cfg.messages['editors'];
            end
end
            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
end  
        else
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
            if EditorCount <= 1 then
end
                Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc
            else
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
                Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
            end
Authors = by_text .. Authors; -- author follows title so tweak it here
        end
if is_set (Editors) then -- when Editors make sure that Authors gets terminated
        text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
        text = safejoin( {text, pgtext, idcommon}, sepc );
end
    else
if not is_set (Date) then -- when date is set it's in parentheses; no Contributors termination
        if is_set(Date) then
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
            if ( string.sub(tcommon,-1,-1) ~= sepc )
end
              then Date = sepc .." " .. Date .. OrigYear
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc );
              else Date = " " .. Date .. OrigYear
else
            end
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
        end
end
        if config.CitationClass=="journal" and is_set(Periodical) then
elseif is_set(Editors) then
            text = safejoin( {Chapter, Place, tcommon}, sepc );
if is_set(Date) then
            text = safejoin( {text, pgtext, Date, idcommon}, sepc );
if EditorCount <= 1 then
        else
Editors = Editors .. ", " .. cfg.messages['editor'];
            text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
else
            text = safejoin( {text, pgtext, idcommon}, sepc );
Editors = Editors .. ", " .. cfg.messages['editors'];
        end
end
    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 in_array(config.CitationClass, {"journal","citation"}) and 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 is_set(PostScript) and PostScript ~= sepc then
if is_set(PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
text = text:sub(1,-sepc:len()-1);
text = text:sub(1,-sepc:len()-1);
end
-- text = text:sub(1,-2); --Remove final separator (assumes that sepc is only one character)
end  
text = safe_join( {text, PostScript}, sepc );
   
 
    text = safejoin( {text, PostScript}, sepc );
-- Now enclose the whole thing in a <cite/> element
local options = {};
if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
options.class = config.CitationClass;
options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref=
else
options.class = "citation";
end
if is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate
local id = Ref
if ('harv' == Ref ) then
local namelist = {}; -- holds selected contributor, author, editor name list
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation


if #c > 0 then -- if there is a contributor list
    -- Now enclose the whole thing in a <span/> element
namelist = c; -- select it
    local options = {};
elseif #a > 0 then -- or an author list
   
namelist = a;
    if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
elseif #e > 0 then -- or an editor list
        options.class = "citation " .. config.CitationClass;
namelist = e;
    else
end
        options.class = "citation";
if #namelist > 0 then -- if there are names in namelist
    end
id = anchor_id (namelist, year); -- go make the CITEREF anchor
   
else
    if is_set(Ref) and Ref:lower() ~= "none" then
id = ''; -- unset
        local id = Ref
end
        if ( "harv" == Ref ) then
end
            local names = {} --table of last names & year
options.id = id;
            if #a > 0 then
end
                for i,v in ipairs(a) do
                    names[i] = v.last
if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
                    if i == 4 then break end
z.error_categories = {};
                end
text = set_error('empty_citation');
            elseif #e > 0 then
z.message_tail = {};
                for i,v in ipairs(e) do
end
                    names[i] = v.last
                    if i == 4 then break end               
if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
                end
text = substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text}); -- when |ref= is set
            end
else
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
text = substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text}); -- all other cases
            id = anchorid(names)
end
        end
 
        options.id = id;
text = text .. substitute (cfg.presentation['ocins'], {OCinSoutput}); -- append metadata to the citation
    end
   
if #z.message_tail ~= 0 then
    if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
text = text .. " ";
        z.error_categories = {};
for i,v in ipairs( z.message_tail ) do
        text = seterror('empty_citation');
if is_set(v[1]) then
        z.message_tail = {};
if i == #z.message_tail then
    end
text = text .. error_comment( v[1], v[2] );
   
else
    if is_set(options.id) then  
text = text .. error_comment( v[1] .. "; ", v[2] );
        text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
end
    else
end
        text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
end
    end      
end


if #z.maintenance_cats ~= 0 then
    local empty_span = '<span style="display:none;">&nbsp;</span>';
text = text .. '<span class="citation-comment" style="display:none; color:#33aa33">';
   
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
    -- Note: Using display: none on then COinS span breaks some clients.
text = text .. ' ' .. v .. ' ([[:Category:' .. v ..'|link]])';
    local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
end
    text = text .. OCinS;
text = text .. '</span>'; -- maintenance mesages (realy just the names of the categories for now)
   
end
    if #z.message_tail ~= 0 then
        text = text .. " ";
no_tracking_cats = no_tracking_cats:lower();
        for i,v in ipairs( z.message_tail ) do
if in_array(no_tracking_cats, {"", "no", "false", "n"}) then
            if is_set(v[1]) then
for _, v in ipairs( z.error_categories ) do
                if i == #z.message_tail then
text = text .. '[[Category:' .. v ..']]';
                    text = text .. errorcomment( v[1], v[2] );
end
                else
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
                    text = text .. errorcomment( v[1] .. "; ", v[2] );
text = text .. '[[Category:' .. v ..']]';
                end
end
            end
for _, v in ipairs( z.properties_cats ) do -- append maintenance categories
        end
text = text .. '[[Category:' .. v ..']]';
    end
end
   
end
    no_tracking_cats = no_tracking_cats:lower();
    if inArray(no_tracking_cats, {"", "no", "nei", "false", "n"}) then
return text
        for _, v in ipairs( z.error_categories ) do
            text = text .. '[[Category:' .. v ..']]';
        end
    end
   
    return text
end
end


--[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------
-- This is used by templates such as {{cite book}} to create the actual citation text.
 
function z.citation(frame)
This is used by templates such as {{cite book}} to create the actual citation text.
    local pframe = frame:getParent()
 
   
]]
    if nil ~= string.find( frame:getTitle(), 'sandkasse', 1, true ) then -- did the {{#invoke:}} use sandkasse version?
 
    cfg = mw.loadData( 'Modul:Citation/CS1/Configuration/sandkasse' ); -- load sandkasse versions of Configuration and Whitelist and ...
function cs1.citation(frame)
    whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist/sandkasse' );
local pframe = frame:getParent()
    dates = require('Modul:Citation/CS1/Date_validation/sandkasse').dates -- ... sandkasse version of date validation code
local validation, utilities, identifiers, metadata;
    else -- otherwise
    cfg = mw.loadData( 'Modul:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ...
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
    whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist' );
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of support modules
    dates = require('Modul:Citation/CS1/Date_validation').dates -- ... live version of date validation code
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');
else -- otherwise
cfg = mw.loadData ('Module:Citation/CS1/Configuration'); -- load live versions of support modules
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist');
utilities = require ('Module:Citation/CS1/Utilities');
validation = require ('Module:Citation/CS1/Date_validation');
identifiers = require ('Module:Citation/CS1/Identifiers');
metadata = require ('Module:Citation/CS1/COinS');
end
 
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
validation.set_selected_modules (utilities); -- so that functions in Date validataion can see 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
 
dates = validation.dates; -- imported functions from Module:Citation/CS1/Date validation
year_date_check = validation.year_date_check;
reformat_dates = validation.reformat_dates;
date_hyphen_to_dash = validation.date_hyphen_to_dash;
is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities
in_array = utilities.in_array;
substitute = utilities.substitute;
error_comment = utilities.error_comment;
set_error = utilities.set_error;
select_one = utilities.select_one;
add_maint_cat = utilities.add_maint_cat;
wrap_style = utilities.wrap_style;
safe_for_italics = utilities.safe_for_italics;
remove_wiki_link = utilities.remove_wiki_link;
 
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities
 
extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Utilities
build_id_list = identifiers.build_id_list;
is_embargoed = identifiers.is_embargoed;
make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS
get_coins_pages = metadata.get_coins_pages;
COinS = metadata.COinS;
 
Preview_mode = frame:preprocess('{{REVISIONID}}'); -- use magic word to get revision id
if is_set (Preview_mode) then -- if there is a value then this is not a preiview
Preview_mode = false;
else
Preview_mode = true; -- no value (nil or empty string) so this is a preview
end
end
local args = {};
    local args = {};
local suggestions = {};
    local suggestions = {};
local error_text, error_state;
    local error_text, error_state;


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


local capture; -- the single supported capture when matching unknown parameters using patterns
    for k, v in pairs( pframe.args ) do
for k, v in pairs( pframe.args ) do
        if v ~= '' then
if v ~= '' then
            if not validate( k ) then          
if not validate( k ) then
                error_text = "";
error_text = "";
                if type( k ) ~= 'string' then
if type( k ) ~= 'string' then
                    -- Exclude empty numbered parameters
-- Exclude empty numbered parameters
                    if v:match("%S+") ~= nil then
if v:match("%S+") ~= nil then
                        error_text, error_state = seterror( 'text_ignored', {v}, true );
error_text, error_state = set_error( 'text_ignored', {v}, true );
                    end
end
                elseif validate( k:lower() ) then  
elseif validate( k:lower() ) then  
                    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true );
                else
else
                    if #suggestions == 0 then
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
                        suggestions = mw.loadData( 'Modul:Citation/CS1/Suggestions' );
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
                    end
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version
                    if suggestions[ k:lower() ] ~= nil then
else
                        error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' ); -- use the live version
                    else
end
                        error_text, error_state = seterror( 'parameter_ignored', {k}, true );
end
                    end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
                end                
capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match
                if error_text ~= '' then
if capture then -- if the pattern matches
                    table.insert( z.message_tail, {error_text, error_state} );
param = substitute( param, capture ); -- add the capture to the suggested parameter (typically the enumerator)
                end              
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, param}, true ); -- set the error message
            end
end
            args[k] = v;
end
        elseif args[k] ~= nil or (k == 'postscript') then
if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit suggestion?
            args[k] = v;
if suggestions.suggestions[ k:lower() ] ~= nil then
        end      
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true );
    end  
else
   
error_text, error_state = set_error( 'parameter_ignored', {k}, true );
    return citation0( config, args)
end
end
end  
if error_text ~= '' then
table.insert( z.message_tail, {error_text, error_state} );
end
end
missing_pipe_check (v); -- do we think that there is a parameter that is missing a pipe?
args[k] = v;
elseif args[k] ~= nil or (k == 'postscript') then
args[k] = v;
end
end
 
for k, v in pairs( args ) do
if 'string' == type (k) then -- don't evaluate positional parameters
has_invisible_chars (k, v);
end
end
return citation0( config, args)
end
end


return cs1;
return z

Sideversjonen fra 20. jun. 2016 kl. 20:46

Denne modulen og dens undermoduler er «motoren» bak CS1-stilen og de ulike kildemalene som følger denne ({{Kilde bok}}, {{Kilde www}}, osv…). Modulen er importert fra en:Module:Citation/CS1 og tilpasset norske forhold. De viktigste tilpasningene er i Modul:Citation/CS1/Configuration og Modul:Citation/CS1/Date validation, men det er gjort tilpasninger i omtrent alle undermodulene, så ved behov for å re-importere må man passe på dette. Re-importer alltid til sandkassene først.

Skal du gjøre endringer i denne modulen eller en av modulens undermoduler, prøv alltid i den tilhørende sandkassen først. Det finnes sandkasseversjoner av alle kildemalene som benytter Modul:Citation/CS1/sandkasse: {{Kilde bok/sandkasse}}, {{Kilde www/sandkasse}}, osv…, slik at du kan se hvordan disse blir påvirket av endringene dine.

Brukes av

Denne modulen brukes av følgende kildemaler:

Tilleggsmoduler


Vedlikeholdskategorier

Kategorien Sider med feil i referansemaler ikke funnet

local z = {
    error_categories = {};
    error_ids = {};
    message_tail = {};
}

-- Include translation message hooks, ID and error handling configuration settings.
--local cfg = mw.loadData( 'Modul:Citation/CS1/Configuration/sandkasse' );

-- Contains a list of all recognized parameters
--local whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist/sandkasse' );

--local dates = require('Modul:Citation/CS1/Date_validation/sandkasse').dates		-- location of date validation code

-- Whether variable is set or not
function is_set( var )
    return not (var == nil or var == '');
end

-- First set variable or nil if none
function first_set(...)
    local list = {...};
    for _, var in pairs(list) do
        if is_set( var ) then
            return var;
        end
    end
end

-- Whether needle is in haystack
function inArray( needle, haystack )
    if needle == nil then
        return false;
    end
    for n,v in ipairs( haystack ) do
        if v == needle then
            return n;
        end
    end
    return false;
end

--[[
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
details of which parameter caused the error message are not provided.  Only one error message is emitted regarless of the number of deprecated parameters in the citation.
]]
function deprecated_parameter()
	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, { seterror( 'deprecated_params', {error_message}, true ) } );		-- add error message
		table.insert( z.message_tail, { seterror( 'deprecated_params', {}, true ) } );		-- add error message
	end
end

-- Populates numbered arguments in a message string using an argument table.
function substitute( msg, args )
--	return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
	return args and mw.message.newRawMessage( msg, args ):plain() or msg;
end

--[[
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)
]]
function kern_quotes (str)
	local left='<span style="padding-left:0.2em;">%1</span>';		-- spacing to use when title contains leading single or double quote mark
	local right='<span style="padding-right:0.2em;">%1</span>';		-- spacing to use when title contains trailing single or double quote mark
	
	if  str:match ("^[\"\'][^\']") then
		str = string.gsub( str, "^[\"\']", left, 1 );				-- replace (captured) leading single or double quote with left-side <span>
	end
	if str:match ("[^\'][\"\']$") then
		str = string.gsub( str, "[\"\']$", right, 1 );			-- replace (captured) trailing single or double quote with right-side <span>
	end
	return str;
end

-- Wraps a string using a message_list configuration taking one argument
function wrap( key, str, lower )
    if not is_set( str ) then
        return "";
    elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
        str = safeforitalics( str );
    end
    if lower == true then
        return substitute( cfg.messages[key]:lower(), {str} );
    else
        return substitute( cfg.messages[key], {str} );
    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.
]]
function argument_wrapper( args )
    local origin = {};
    
    return setmetatable({
        ORIGIN = function( self, k )
            local dummy = self[k]; --force the variable to be loaded.
            return origin[k];
        end
    },
    {
        __index = function ( tbl, k )
            if origin[k] ~= nil then
                return nil;
            end
            
            local args, list, v = args, cfg.aliases[k];
            
            if type( list ) == 'table' then
                v, origin[k] = selectone( args, list, 'redundant_parameters' );
                if origin[k] == nil then
                    origin[k] = ''; -- Empty string, not nil
                end
            elseif list ~= nil then
                v, origin[k] = args[list], list;
            else
                -- maybe let through instead of raising an error?
                -- v, origin[k] = args[k], k;
                error( cfg.messages['unknown_argument_map'] );
            end
            
            -- Empty strings, not nil;
            if v == nil then
                v = cfg.defaults[k] or '';
                origin[k] = '';
            end
            
            tbl = rawset( tbl, k, v );
            return v;
        end,
    });
end

--[[
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
]]
function validate( name )
	local name = tostring( name );
	local state = whitelist.basic_arguments[ name ];
	
	-- Normal arguments
	if true == state then return true; end		-- valid actively supported parameter
	if false == state then
		deprecated_parameter ();				-- 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 ();				-- parameter is deprecated but still supported
		return true;
	end
	
	return false;								-- Not supported because not found or name is set to nil
end

-- Formats a comment for error trapping
function errorcomment( content, hidden )
    return wrap( hidden and 'hidden-error' or 'visible-error', content );
end

--[[
Sets an error condition and returns the appropriate error message.  The actual placement
of the error message in the output is the responsibility of the calling function.
]]
function seterror( error_id, arguments, raw, prefix, suffix )
    local error_state = cfg.error_conditions[ error_id ];
    
    prefix = prefix or "";
    suffix = suffix or "";
    
    if error_state == nil then
        error( cfg.messages['undefined_error'] );
    elseif is_set( error_state.category ) then
        table.insert( z.error_categories, error_state.category );
    end
    
    local message = substitute( error_state.message, arguments );
    
    message = message .. " ([[" .. cfg.messages['help page link'] .. 
        "#" .. error_state.anchor .. "|" ..
        cfg.messages['help page label'] .. "]])";
    
    z.error_ids[ error_id ] = true;
    if inArray( error_id, { 'bare_url_missing_title', 'trans_missing_title' } )
            and z.error_ids['citation_missing_title'] then
        return '', false;
    end
    
    message = table.concat({ prefix, message, suffix });
    
    if raw == true then
        return message, error_state.hidden;
    end        
        
    return errorcomment( message, error_state.hidden );
end

-- Formats a wiki style external link
function externallinkid(options)
    local url_string = options.id;
    if options.encode == true or options.encode == nil then
        url_string = mw.uri.encode( url_string );
    end
    return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
        options.link, options.label, options.separator or "&nbsp;",
        options.prefix, url_string, options.suffix or "",
        mw.text.nowiki(options.id)
    );
end

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

-- Format an external link with error checking
function externallink( URL, label, source )
    local error_str = "";
    if not is_set( label ) then
        label = URL;
        if is_set( source ) then
            error_str = seterror( 'bare_url_missing_title', { wrap( 'parameter', source ) }, false, " " );
        else
            error( cfg.messages["bare_url_no_origin"] );
        end            
    end
    if not checkurl( URL ) then
        error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
    end
    return table.concat({ "[", URL, " ", safeforurl( label ), "]", error_str });
end

-- Formats a link to Amazon
function amazon(id, domain)
    if not is_set(domain) then 
        domain = "com"
    elseif ( "jp" == domain or "uk" == domain ) then
        domain = "co." .. domain
    end
    local handler = cfg.id_handlers['ASIN'];
    return externallinkid({link = handler.link,
        label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
        encode=handler.encode, separator = handler.separator})
end

--[[
Format 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 alpha
length = 10 then lccn[1] and lccn[2] are both alpha or both digits
length = 11 then lccn[1] is alpha, lccn[2] and lccn[3] are both alpha or both digits
length = 12 then lccn[1] and lccn[2] are both alpha

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

	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 = ' ' .. seterror( 'bad_lccn' );	-- set an error message
		end
	elseif 9 == len then								-- LCCN should be adddddddd
		if nil == id:match("%a%d%d%d%d%d%d%d%d") then			-- does it match our pattern?
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
		end
	elseif 10 == len then								-- LCCN should be aadddddddd or dddddddddd
		if id:match("[^%d]") then							-- if LCCN has anything but digits (nil if only digits) ...
			if nil == id:match("^%a%a%d%d%d%d%d%d%d%d") then	-- ... see if it matches our pattern
				err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
			end
		end
	elseif 11 == len then								-- LCCN should be aaadddddddd or adddddddddd
		if not (id:match("^%a%a%a%d%d%d%d%d%d%d%d") or id:match("^%a%d%d%d%d%d%d%d%d%d%d")) then	-- see if it matches one of our patterns
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
		end
	elseif 12 == len then								-- LCCN should be aadddddddddd
		if not id:match("^%a%a%d%d%d%d%d%d%d%d%d%d") then	-- see if it matches our pattern
			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
		end
	else
		err_cat = ' ' .. seterror( 'bad_lccn' );		-- wrong length, set an error message
	end

	return externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end

--[[
Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
]]
function pmid(id)
	local test_limit = 30000000;						-- update this value as PMIDs approach
	local handler = cfg.id_handlers['PMID'];
	local err_cat =  '';								-- presume that PMID is valid
	
	if id:match("[^%d]") then							-- if PMID has anything but digits
		err_cat = ' ' .. seterror( 'bad_pmid' );		-- set an error message
	else												-- PMID 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 PMID is outside test limit boundaries
			err_cat = ' ' .. seterror( 'bad_pmid' );	-- set an error message
		end
	end
	
	return externallinkid({link = handler.link, label = handler.label,
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end

--[[
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 true; otherwse, returns false because the embargo has expired or |embargo= not set in this cite.
]]
function is_embargoed(embargo)
	if is_set(embargo) then
		local lang = mw.getContentLanguage();
		local good1, embargo_date, good2, todays_date;
		good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
		good2, todays_date = pcall( lang.formatDate, lang, 'U' );
	
		if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then	--is embargo date is in the future?
			return true;	-- still embargoed
		end
	end
	return false;			-- embargo expired or |embargo= not set
end

--[[
Format a PMC, do simple error checking, and check for embargoed articles.

The embargo parameter takes a date for a value. If the embargo date is in the future
the PMC identifier will not be linked to the article.  If the embargo specifies a date in the past, or if it is empty or omitted, then
the PMC identifier is linked to the article through the link at cfg.id_handlers['PMC'].prefix.

PMCs are sequential numbers beginning at 1 and counting up.  This code checks the PMC to see that it contains only digits and is less
than test_limit; the value in local variable test_limit will need to be updated periodically as more PMCs are issued.
]]
function pmc(id, embargo)
	local test_limit = 5000000;							-- update this value as PMCs approach
	local handler = cfg.id_handlers['PMC'];
	local err_cat =  '';								-- presume that PMC is valid
    
	local text;

	if id:match("[^%d]") then							-- if PMC has anything but digits
		err_cat = ' ' .. seterror( 'bad_pmc' );			-- set an error message
	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 = ' ' .. seterror( 'bad_pmc' );		-- set an error message
		end
	end
	
	if is_embargoed(embargo) then
		text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id .. err_cat;	--still embargoed so no external link
	else
		text = externallinkid({link = handler.link, label = handler.label,			--no embargo date, ok to link to article
			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
	end
	return text;
end

-- Formats a DOI and checks for DOI errors.

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

-- This function checks a DOI name for: prefix/suffix.  If the doi name contains spaces or endashes,
-- or, if it ends with a period or a comma, this function will emit a bad_doi error message.

-- DOI names are case-insensitive and can incorporate any printable Unicode characters so the test for spaces, endash,
-- and terminal punctuation may not be technically correct but it appears, that in practice these characters are rarely if ever used in doi names.

function doi(id, inactive)
    local cat = ""
    local handler = cfg.id_handlers['DOI'];
    
    local text;
	if is_set(inactive) then
		local inactive_year = inactive:match("%d%d%d%d") or '';		-- try to get the year portion from the inactive date
		text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
		if is_set(inactive_year) then
			table.insert( z.error_categories, "Sider med inaktiv DOI" );
		else
			table.insert( z.error_categories, "Sider med inaktiv DOI" );	-- when inactive doesn't contain a recognizable year
		end
		inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")" 
	else 
		text = externallinkid({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 = ' ' .. seterror( 'bad_doi' );
	end
	return text .. inactive .. cat 
end

-- Formats an OpenLibrary link, and checks for associated errors.
function openlibrary(id)
    local code = id:sub(-1,-1)
    local handler = cfg.id_handlers['OL'];
    if ( code == "A" ) then
        return externallinkid({link=handler.link, label=handler.label,
            prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
            encode = handler.encode})
    elseif ( code == "M" ) then
        return externallinkid({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 externallinkid({link=handler.link, label=handler.label,
            prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
            encode = handler.encode})
    else
        return externallinkid({link=handler.link, label=handler.label,
            prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
            encode = handler.encode}) .. 
            ' ' .. seterror( 'bad_ol' );
    end
end

--[[
Validate and format an issn.  This code fixes the case where an editor has included an ISSN in the citation but has separated the two groups of four
digits with a space.  When that condition occurred, the resulting link looked like this:

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

	id=id:gsub( "[%s-–]", "" );									-- strip spaces, hyphens, and ndashes from the issn

	if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then		-- validate the issn: 8 didgits long, containing only 0-9 or X in the last position
		valid_issn=false;										-- wrong length or improper character
	else
		valid_issn=is_valid_isxn(id, 8);						-- validate issn
	end

	if true == valid_issn then
		id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 );	-- if valid, display correctly formatted version
	else
		id = issn_copy;											-- if not valid, use the show the invalid issn with error message
	end
	
	text = externallinkid({link = handler.link, label = handler.label,
		prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
 
	if false == valid_issn then
		text = text .. ' ' .. seterror( 'bad_issn' )			-- add an error message if the issn is invalid
	end 
	
	return text
end

--[[
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
Also handles the special case where it is desireable to omit the title type from the rendered citation (|type=none).
]]
function set_titletype(cite_class, title_type)
	if is_set(title_type) then
		if "none" == title_type then
			title_type = "";					-- if |type=none then type parameter not displayed
		end
		return title_type;						-- if |type= has been set to any other value use that value
	end

	if "AV media notes" == cite_class or "DVD notes" == cite_class then		-- if this citation is cite AV media notes or cite DVD notes
		return "mediemerknader";					-- display AV media notes / DVD media notes annotation

	elseif "podcast" == cite_class then			-- if this citation is cite podcast
		return "podcast";						-- display podcast annotation

	elseif "pressrelease" == cite_class then	-- if this citation is cite press release
		return "pressemelding";					-- display press release annotation

	elseif "techreport" == cite_class then		-- if this citation is cite techreport
		return "teknisk rapport";				-- display techreport annotation
	
	elseif "thesis" == cite_class then			-- if this citation is cite thesis (degree option handled after this function returns)
			return "avhandling";					-- display simple thesis annotation (without |degree= modification)
	end
end

--[[
Determines whether a URL string is valid

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

-- Removes irrelevant text and dashes from ISBN number
-- Similar to that used for Special:BookSources
function cleanisbn( isbn_str )
    return isbn_str:gsub( "[^-0-9X]", "" );
end

-- Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
function get_coins_pages (pages)
	if not is_set (pages) then return pages; end			-- if no page numbers then we're done
	
    while true do
		pattern = pages:match("%[([%w/:\.]+%s+)[%w%d].*%]");	-- pattern is the opening bracket, the url and following space(s): "[url "
		if nil == pattern then break; end					-- no more urls
		pages = pages:gsub(pattern, "");					-- remove as many instances of pattern as possible
	end
	pages = pages:gsub("[%[%]]", "");						-- remove the brackets
	pages = pages:gsub("–", "-" );							-- replace endashes with hyphens
	pages = pages:gsub("&%w+;", "-" );						-- and replace html entities (&ndash; etc) with hyphens; do we need to replace numerical entities like &#32; and the like?
	return pages;
end

--[[
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
If the number is valid the result will be 0. Before calling this function, issbn/issn must be checked for length and stripped of dashes,
spaces and other non-isxn characters.
]]
function is_valid_isxn (isxn_str, len)
	local temp = 0;
	isxn_str = { isxn_str:byte(1, len) };	-- make a table of bytes
	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
		if v == string.byte( "X" ) then		-- if checkdigit is X
			temp = temp + 10*( len - i );	-- it represents 10 decimal
		else
			temp = temp + tonumber( string.char(v) )*(len-i);
		end
	end
	return temp % 11 == 0;					-- returns true if calculation result is zero
end

-- Determines whether an ISBN string is valid
function checkisbn( isbn_str )
	if nil ~= isbn_str:match("[^%s-0-9X]") then return false; end		-- fail if isbn_str contains anything but digits, hyphens, or the uppercase X
	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" );	-- remove hyphens and spaces
	local len = isbn_str:len();
 
	if len ~= 10 and len ~= 13 then
		return false;
	end

	if len == 10 then
		if isbn_str:match( "^%d*X?$" ) == nil then return false; end
		return is_valid_isxn(isbn_str, 10);
	else
		local temp = 0;
		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) };
		for i, v in ipairs( isbn_str ) do
			temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
		end
		return temp % 10 == 0;
	end
end

-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
function removewikilink( str )
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
        return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
    end));
end

-- Escape sequences for content that will be used for URL descriptions
function safeforurl( str )
    if str:match( "%[%[.-%]%]" ) ~= nil then 
        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
    end
    
    return str:gsub( '[%[%]\n]', {    
        ['['] = '&#91;',
        [']'] = '&#93;',
        ['\n'] = ' ' } );
end

-- Converts a hyphen to a dash
function hyphentodash( str )
    if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
        return str;
    end    
    return str:gsub( '-', '–' );
end

-- Protects a string that will be wrapped in wiki italic markup '' ... ''
function safeforitalics( str )
    --[[ Note: We can not 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. ]]
    
    if not is_set(str) then
        return str;
    else
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
        
        -- Remove newlines as they break italics.
        return str:gsub( '\n', ' ' );
    end
end

--[[
Joins a sequence of strings together while checking for duplicate separation
characters.
]]
function safejoin( tbl, duplicate_char )
    --[[
    Note: we use string functions here, rather than ustring functions.
    
    This has considerably faster performance and should work correctly as 
    long as the duplicate_char is strict ASCII.  The strings
    in tbl may be ASCII or UTF8.
    ]]
    
    local str = '';
    local comp = '';
    local end_chr = '';
    local trim;
    for _, value in ipairs( tbl ) do
        if value == nil then value = ''; end
        
        if str == '' then
            str = value;
        elseif value ~= '' then
            if value:sub(1,1) == '<' then
                -- Special case of values enclosed in spans and other markup.
                comp = value:gsub( "%b<>", "" );
            else
                comp = value;
            end
            
            if comp:sub(1,1) == duplicate_char then
                trim = false;
                end_chr = str:sub(-1,-1);
                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
                if end_chr == duplicate_char then
                    str = str:sub(1,-2);
                elseif end_chr == "'" then
                    if str:sub(-3,-1) == duplicate_char .. "''" then
                        str = str:sub(1, -4) .. "''";
                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
                        trim = true;
                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
                        trim = true;
                    end
                elseif end_chr == "]" then
                    if str:sub(-3,-1) == duplicate_char .. "]]" then
                        trim = true;
                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
                        trim = true;
                    end
                elseif end_chr == " " then
                    if str:sub(-2,-1) == duplicate_char .. " " then
                        str = str:sub(1,-3);
                    end
                end

                if trim then
                    if value ~= comp then 
                        local dup2 = duplicate_char;
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
                        
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
                    else
                        value = value:sub( 2, -1 );
                    end
                end
            end
            str = str .. value;
        end
    end
    return str;
end  

-- Attempts to convert names to initials.
function reducetoinitials(first)
    local initials = {}
    for word in string.gmatch(first, "%S+") do
        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
    end
    return table.concat(initials) -- Vancouver format does not include spaces.
end

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

    local count = #text / 2;
    if count > 0 then 
        if count > 1 and is_set(lastauthoramp) and not etal then
            text[#text-2] = " & ";
        end
        text[#text] = nil; 
    end
    
    local result = table.concat(text) -- construct list
    if etal then 
        local etal_text = cfg.messages['et al'];
        result = result .. " " .. etal_text;
    end
    
    -- if necessary wrap result in <span> tag to format in Small Caps
    if ( "scap" == format ) then result = 
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    end 
    return result, count
end

-- Generates a CITEREF anchor ID.
function anchorid( options )
    return "CITEREF" .. table.concat( options );
end

-- Gets name list from the input arguments
function extractnames(args, list_name)
    local names = {};
    local i = 1;
    local last;
    
    while true do
        last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
        if not is_set(last) then
            -- just in case someone passed in an empty parameter
            break;
        end
        names[i] = {
            last = last,
            first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
        };
        i = i + 1;
    end
    return names;
end

-- Populates ID table from arguments using configuration settings
function extractids( args )
    local id_list = {};
    for k, v in pairs( cfg.id_handlers ) do    
        v = selectone( args, v.parameters, 'redundant_parameters' );
        if is_set(v) then id_list[k] = v; end
    end
    return id_list;
end

-- Takes a table of IDs and turns it into a table of formatted ID outputs.
function buildidlist( id_list, options )
    local new_list, handler = {};
    
    function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
    
    for k, v in pairs( id_list ) do
        -- fallback to read-only cfg
        handler = setmetatable( { ['id'] = v }, fallback(k) );
        
        if handler.mode == 'external' then
            table.insert( new_list, {handler.label, externallinkid( handler ) } );
        elseif handler.mode == 'internal' then
            table.insert( new_list, {handler.label, internallinkid( handler ) } );
        elseif handler.mode ~= 'manual' then
            error( cfg.messages['unknown_ID_mode'] );
        elseif k == 'DOI' then
            table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
        elseif k == 'ASIN' then
            table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } ); 
        elseif k == 'LCCN' then
            table.insert( new_list, {handler.label, lccn( v ) } );
        elseif k == 'OL' then
            table.insert( new_list, {handler.label, openlibrary( v ) } );
        elseif k == 'PMC' then
            table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
        elseif k == 'PMID' then
            table.insert( new_list, {handler.label, pmid( v ) } );
        elseif k == 'ISSN' then
        	table.insert( new_list, {handler.label, issn( v ) } );
        elseif k == 'ISBN' then
            local ISBN = internallinkid( handler );
            if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
                ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
            end
            table.insert( new_list, {handler.label, ISBN } );                
        else
            error( cfg.messages['unknown_manual_ID'] );
        end
    end
    
    function comp( a, b )	-- used in following table.sort()
        return a[1] < b[1];
    end
    
    table.sort( new_list, comp );
    for k, v in ipairs( new_list ) do
        new_list[k] = v[2];
    end
    
    return new_list;
end
  
-- Chooses one matching parameter from a list of parameters to consider
-- Generates an error if more than one match is present.
function selectone( args, possible, error_condition, index )
    local value = nil;
    local selected = '';
    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
    
    for _, v in ipairs( possible ) do
        if index ~= nil then
            v = v:gsub( "#", index );
        end
        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
    
    if #error_list > 0 then
        local error_str = "";
        for _, k in ipairs( error_list ) do
            if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
            error_str = error_str .. wrap( 'parameter', k );
        end
        if #error_list > 1 then
            error_str = error_str .. cfg.messages['parameter-final-separator'];
        else
            error_str = error_str .. cfg.messages['parameter-pair-separator'];
        end
        error_str = error_str .. wrap( 'parameter', selected );
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    end
    
    return value, selected;
end

-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
-- the citation information.
function COinS(data)
    if 'table' ~= type(data) or nil == next(data) then
        return '';
    end
    
    local ctx_ver = "Z39.88-2004";
    
    -- treat table strictly as an array with only set values.
    local OCinSoutput = setmetatable( {}, {
        __newindex = function(self, key, value)
            if is_set(value) then
                rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( 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.btitle"] = data.Chapter;
        OCinSoutput["rft.atitle"] = data.Title;
    elseif is_set(data.Periodical) then
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
        OCinSoutput["rft.genre"] = "article";
        OCinSoutput["rft.jtitle"] = data.Periodical;
        OCinSoutput["rft.atitle"] = data.Title;
    else
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
        OCinSoutput["rft.genre"] = "book"
        OCinSoutput["rft.btitle"] = data.Title;
    end
    
    OCinSoutput["rft.place"] = data.PublicationPlace;
    OCinSoutput["rft.date"] = data.Date;
    OCinSoutput["rft.series"] = data.Series;
    OCinSoutput["rft.volume"] = data.Volume;
    OCinSoutput["rft.issue"] = data.Issue;
    OCinSoutput["rft.pages"] = data.Pages;
    OCinSoutput["rft.edition"] = data.Edition;
    OCinSoutput["rft.pub"] = data.PublisherName;
    
    for k, v in pairs( data.ID_list ) do
        local id, value = cfg.id_handlers[k].COinS;
        if k == 'ISBN' then value = cleanisbn( v ); else value = v; end
        if string.sub( id or "", 1, 4 ) == 'info' then
            OCinSoutput["rft_id"] = table.concat{ id, "/", v };
        else
            OCinSoutput[ id ] = value;
        end
    end
    
    local last, first;
    for k, v in ipairs( data.Authors ) do
        last, first = v.last, v.first;
        if k == 1 then
            if is_set(last) then
                OCinSoutput["rft.aulast"] = last;
            end
            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

--[[
This is the main function doing the majority of the citation
formatting.
]]
function citation0( config, args)
    --[[ 
    Load Input Parameters
    The argment_wrapper facillitates the mapping of multiple
    aliases to single internal variable.
    ]]
    local A = argument_wrapper( args );

    local i 
    local PPrefix = A['PPrefix']
    local PPPrefix = A['PPPrefix']
    if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
    
    -- Pick out the relevant fields from the arguments.  Different citation templates
    -- define different field names for the same underlying things.    
    local Authors = A['Authors'];
    local a = extractnames( args, 'AuthorList' );

    local Coauthors = A['Coauthors'];
    local Others = A['Others'];
    local Editors = A['Editors'];
    local e = extractnames( args, 'EditorList' );

    local Year = A['Year'];
    local PublicationDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['PublicationDate'], 'n' } };
    local OrigYear = A['OrigYear'];
    local Date = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['Date'], 'n' } };
    local LayDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['LayDate'], 'n' } };
    ------------------------------------------------- Get title data
    local Title = A['Title'];
    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'];
    local TransChapter = A['TransChapter'];
    local TitleType = A['TitleType'];
    local Degree = A['Degree'];
    local Docket = A['Docket'];
    local ArchiveURL = A['ArchiveURL'];
    local URL = A['URL']
    local URLorigin = A:ORIGIN('URL');
    local ChapterURL = A['ChapterURL'];
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
    local Periodical = A['Periodical'];

	local Series = A['Series'];
    local Volume = A['Volume'];
    local Issue = A['Issue'];
    local Position = '';
    local Page = A['Page'];
    local Pages = hyphentodash( A['Pages'] );	
    local At = A['At'];

    local Edition = A['Edition'];
    local PublicationPlace = A['PublicationPlace']
    local Place = A['Place'];
    
    local PublisherName = A['PublisherName'];
    local RegistrationRequired = A['RegistrationRequired'];
    local SubscriptionRequired = A['SubscriptionRequired'];
    local Via = A['Via'];
    local AccessDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['AccessDate'], 'n' } };
    local ArchiveDate = mw.getCurrentFrame():expandTemplate{ title = 'ISOtilNorskdato', args = { A['ArchiveDate'], 'n' } };
    local Agency = A['Agency'];
    local DeadURL = A['DeadURL']
    local Language = A['Language'];
    local Format = A['Format'];
    local Ref = A['Ref'];
	local DoiBroken = A['DoiBroken'];
	local ID = A['ID'];
    local ASINTLD = A['ASINTLD'];
    local IgnoreISBN = A['IgnoreISBN'];
    local Embargo = A['Embargo'];

    local ID_list = extractids( args );
    
    local Quote = A['Quote'];
    local PostScript = A['PostScript'];

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

    local LastAuthorAmp = A['LastAuthorAmp'];
    local no_tracking_cats = A['NoTracking'];

--these are used by cite interview
	local Callsign = A['Callsign'];
	local City = A['City'];
	local Cointerviewers = A['Cointerviewers'];			-- deprecated
	local Interviewer = A['Interviewer'];				-- deprecated
	local Program = A['Program'];

--local variables that are not cs1 parameters
    local page_type;									-- is this needed?  Doesn't appear to be used anywhere;
    local use_lowercase = ( sepc ~= '.' );
    local this_page = mw.title.getCurrentTitle();		--Also used for COinS and for language
	local anchor_year;									-- used in the CITEREF identifier
	local COinS_date;									-- used in the COinS metadata

-- Set postscript default.
	if not is_set (PostScript) then						-- if |postscript= has not been set (Postscript is nil which is the default for {{citation}}) and
		if (config.CitationClass ~= "citation") then	-- this template is not a citation template
			PostScript = '.';							-- must be a cite xxx template so set postscript to default (period)
		end
	else
		if PostScript:lower() == 'none' then			-- if |postscript=none then
			PostScript = '';							-- no postscript
		end
	end

--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories.
	if not is_set(no_tracking_cats) then				-- ignore if we are already not going to categorize this page
		for k, v in pairs( cfg.uncategorized_namespaces ) do	-- otherwise, spin through the list of namespaces we don't include in error categories
			if this_page.nsText == v then				-- if we find one
				no_tracking_cats = "true";				-- set no_trackin_cats
				break;									-- and we're done
            end
        end
    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 .. " " .. seterror('extra_pages');	-- add error message
            Pages = '';										-- unset the others
            At = '';
        end
    elseif is_set(Pages) then
        if is_set(At) then
            Pages = Pages .. " " .. seterror('extra_pages');	-- add error messages
            At = '';											-- unset
        end
    end    

-- both |publication-place= and |place= (|location=) allowed if different
    if not is_set(PublicationPlace) and is_set(Place) then
        PublicationPlace = Place;							-- promote |place= (|location=) to |publication-place
    end
    
    if PublicationPlace == Place then Place = ''; end		-- don't need both if they are the same
    
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
	|encyclopedia and |title then map |title to |article and |encyclopedia to |title
	|encyclopedia and |article then map |encyclopedia to |title
	|encyclopedia then map |encyclopedia to |title

	|trans_title maps to |trans_chapter when |title is re-mapped

All other combinations of |encyclopedia, |title, and |article are not modified
]]
	if ( config.CitationClass == "encyclopaedia" ) then
		if is_set(Periodical) then					-- Periodical is set when |encyclopedia is set
			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;
					Title = Periodical;
					Periodical = '';				-- redundant so unset
					TransTitle = '';				-- 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

--special cases for citation.
	if (config.CitationClass == "citation") then		-- for citation templates
		if not is_set (Ref) then						-- if |ref= is not set
			Ref = "harv";								-- set default |ref=harv
		end
		if not is_set (sepc) then						-- if |separator= is not set
			sepc = ',';									-- set citation separator to its default (comma)
		end
	else												-- not a citation template
		if not is_set (sepc) then						-- if |separator= has not been set
			sepc = '.';									-- set cite xxx separator to its default (period)
		end
	end

-- check for specital case where |separator=none
	if 'none' == sepc:lower() then						-- if |separator=none
		sepc = '';										-- then set it to a empty string
	end

-- Special case for cite techreport.
	if (config.CitationClass == "techreport") then	-- special case for cite techreport
		if is_set(Issue) then						-- cite techreport uses 'number', which other citations aliase to 'issue'
			if not is_set(ID) then					-- can we use ID for the "number"?
				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 .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
			end
		end	
	end

-- special case for cite interview
	if (config.CitationClass == "interview") then
		if is_set(Program) then
			ID = ' ' .. Program;
		end
		if is_set(Callsign) then
			if is_set(ID) then
				ID = ID .. sepc .. ' ' .. Callsign;
			else
				ID = ' ' .. Callsign;
			end
		end
		if is_set(City) then
			if is_set(ID) then
				ID = ID .. sepc .. ' ' .. City;
			else
				ID = ' ' .. City;
			end
		end

		if is_set(Interviewer) then
			if is_set(TitleType) then
				Others = ' ' .. TitleType .. ' with ' .. Interviewer;
				TitleType = '';
			else
				Others = ' ' .. 'Interview with ' .. Interviewer;
			end
			if is_set(Cointerviewers) then
				Others = Others .. sepc .. ' ' .. Cointerviewers;
			end
		else
			Others = '(Interview)';
		end
	end

--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
	if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
		if not is_embargoed(Embargo) then
			URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC'];	-- set url to be the same as the PMC external link if not embargoed
			URLorigin = cfg.id_handlers['PMC'].parameters[1];		-- set URLorigin to parameter name for use in error message if citation is missing a |title=
		end
	end

-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
--TODO: if this is only for {{cite conference}}, shouldn't we be checking? (if config.CitationClass=='conference' then ...)
	if is_set(BookTitle) then
		Chapter = Title;
		ChapterLink = TitleLink;
		TransChapter = TransTitle;
		Title = BookTitle;
		TitleLink = '';
		TransTitle = '';
	end

-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
--[[	-- {{cite episode}} is not currently supported by this module
	if config.CitationClass == "episode" then
		local AirDate = A['AirDate'];
		local SeriesLink = A['SeriesLink'];
		local Season = A['Season'];
		local SeriesNumber = A['SeriesNumber'];
		local Network = A['Network'];
		local Station = A['Station'];
		local s, n = {}, {};
		local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
		
		if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
		if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
		if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
		if is_set(Network) then table.insert(n, Network); end
		if is_set(Station) then table.insert(n, Station); end
		
		Date = Date or AirDate;
		Chapter = Title;
		ChapterLink = TitleLink;
		TransChapter = TransTitle;
		Title = Series;
		TitleLink = SeriesLink;
		TransTitle = '';
		
		Series = table.concat(s, Sep);
		ID = table.concat(n, Sep);
	end
-- end of {{cite episode}} stuff]]

-- legacy: promote concatenation of |day=, |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
	if not is_set(Date) then
		Date = Year;						-- promote Year to Date
		Year = nil;							-- make nil so Year as empty string isn't used for CITEREF
		if is_set(Date) then
			local Month = A['Month'];
			if is_set(Month) then
				Date = Month .. " " .. Date;
				local Day = A['Day']
				if is_set(Day) then Date = Day .. ". " .. Date end
			end
		elseif is_set(PublicationDate) then	-- use PublicationDate when |date= and |year= are not set
			Date = PublicationDate;			-- promonte PublicationDate to Date
			PublicationDate = '';			-- unset, no longer needed
		end
	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 Modul:Citation/CS1/Date_validation
]]
	anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
		['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
	if is_set(error_message) then
		table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } );	-- add this error message
	end

-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.

    -- COinS metadata (see <http://ocoins.info/>) for
    -- automated parsing of citation information.
    local OCinSoutput = COinS{
        ['Periodical'] = Periodical,
        ['Chapter'] = Chapter,
        ['Title'] = Title,
        ['PublicationPlace'] = PublicationPlace,
        ['Date'] = first_set(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(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,
    };

    if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
        Chapter = Title;
        ChapterLink = TitleLink;
        TransChapter = TransTitle;
        Title = '';
        TitleLink = '';
        TransTitle = '';
    end

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

	if not is_set(Authors) and is_set(Coauthors) then	-- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified
		table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } );	-- emit error message
	end

    local EditorCount
    if not is_set(Editors) then
        local Maximum = tonumber( A['DisplayEditors'] );
        -- Preserve old-style implicit et al.
        if not is_set(Maximum) and #e == 4 then 
            Maximum = 3;
            table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
        elseif not is_set(Maximum) then
            Maximum = #e + 1;
        end

        local control = { 
            sep = A["EditorSeparator"] .. " ",
            namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
            format = A['EditorFormat'],
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
        };

        Editors, EditorCount = listpeople(control, e);
    else
        EditorCount = 1;
    end

    local Cartography = "";
    local Scale = "";
    if config.CitationClass == "map" then
        if not is_set( Authors ) and is_set( PublisherName ) then
            Authors = PublisherName;
            PublisherName = "";
        end
        Cartography = A['Cartography'];
        if is_set( Cartography ) then
            Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
        end        
        Scale = A['Scale'];
        if is_set( Scale ) then
            Scale = sepc .. " " .. Scale;
        end        
    end
    
    if  not is_set(URL) and
        not is_set(ChapterURL) and
        not is_set(ArchiveURL) and
        not is_set(ConferenceURL) and
        not is_set(TranscriptURL) then
        
        -- Test if cite web or cite podcast |url= is missing or empty 
		if inArray(config.CitationClass, {"web","podcast"}) then	
			table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
		end
        
        -- Test if accessdate is given without giving a URL
        if is_set(AccessDate) then
            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
            AccessDate = '';
        end
        
        -- Test if format is given without giving a URL
        if is_set(Format) then
            Format = Format .. seterror( 'format_missing_url' );
        end
    end
    
    -- Test if citation has no title
    if  not is_set(Chapter) and
        not is_set(Title) and
        not is_set(Periodical) and
        not is_set(Conference) and
        not is_set(TransTitle) and
        not is_set(TransChapter) then
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    end
    
    Format = is_set(Format) and " (" .. Format .. ")" or "";
    
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
    if is_set( ArchiveURL ) then
        if ( DeadURL ~= "no" and DeadURL ~= "nei" ) then
            URL = ArchiveURL
            URLorigin = A:ORIGIN('ArchiveURL')
        end
    end
    
    -- Format chapter / article title
    if is_set(Chapter) and is_set(ChapterLink) then 
        Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
    end
    if is_set(Periodical) and is_set(Title) then
        Chapter = wrap( 'italic-title', Chapter );
        TransChapter = wrap( 'trans-italic-title', TransChapter );
    else
		Chapter = kern_quotes (Chapter);				-- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
        Chapter = wrap( 'quoted-title', Chapter );
        TransChapter = wrap( 'trans-quoted-title', TransChapter );
    end
    
    local TransError = ""
    if is_set(TransChapter) then
        if not is_set(Chapter) then
            TransError = " " .. seterror( 'trans_missing_chapter' );
        else
            TransChapter = " " .. TransChapter;
        end
    end
    
    Chapter = Chapter .. TransChapter;
    
    if is_set(Chapter) then
        if not is_set(ChapterLink) then
            if is_set(ChapterURL) then
                Chapter = externallink( ChapterURL, Chapter ) .. TransError;
                if not is_set(URL) then
                    Chapter = Chapter .. Format;
                    Format = "";
                end
            elseif is_set(URL) then 
                Chapter = externallink( URL, Chapter ) .. TransError .. Format;
                URL = "";
                Format = "";
            else
                Chapter = Chapter .. TransError;
            end            
        elseif is_set(ChapterURL) then
            Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. 
                TransError;
        else
            Chapter = Chapter .. TransError;
        end
        Chapter = Chapter .. sepc .. " " -- with end-space
    elseif is_set(ChapterURL) then
        Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " ";
    end        
    
    -- Format main title.
    if is_set(TitleLink) and is_set(Title) then
        Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
    end
    
    if is_set(Periodical) then
		Title = kern_quotes (Title);				-- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
            not is_set(Chapter) then
		Title = kern_quotes (Title);				-- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
        Title = wrap( 'quoted-title', Title );
        TransTitle = wrap( 'trans-quoted-title', TransTitle );
    else
        Title = wrap( 'italic-title', Title );
        TransTitle = wrap( 'trans-italic-title', TransTitle );
    end
    
    TransError = "";
    if is_set(TransTitle) then
        if not is_set(Title) then
            TransError = " " .. seterror( 'trans_missing_title' );
        else
            TransTitle = " " .. TransTitle;
        end
    end
    
    Title = Title .. TransTitle;
    
    if is_set(Title) then
        if not is_set(TitleLink) and is_set(URL) then 
            Title = externallink( URL, Title ) .. TransError .. Format       
            URL = "";
            Format = "";
        else
            Title = Title .. TransError;
        end
    end
    
    if is_set(Place) then
        Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " ";
    end
    
    if is_set(Conference) then
        if is_set(ConferenceURL) then
            Conference = externallink( ConferenceURL, Conference );
        end
        Conference = sepc .. " " .. Conference
    elseif is_set(ConferenceURL) then
        Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin );
    end
    
    if not is_set(Position) then
        local Minutes = A['Minutes'];
        if is_set(Minutes) then
            Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
        else
            local Time = A['Time'];
            if is_set(Time) then
                local TimeCaption = A['TimeCaption']
                if not is_set(TimeCaption) then
                    TimeCaption = cfg.messages['event'];
                    if sepc ~= '.' then
                        TimeCaption = TimeCaption:lower();
                    end
                end
                Position = " " .. TimeCaption .. " " .. Time;
            end
        end
    else
        Position = " " .. Position;
        At = '';
    end
    
    if not is_set(Page) then
        if is_set(Pages) then
            if is_set(Periodical) and
                not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
                Pages = ", s. " .. Pages;
            elseif tonumber(Pages) ~= nil then
                Pages = sepc .." " .. PPrefix .. Pages;
            else
                Pages = sepc .." " .. PPPrefix .. Pages;
            end
        end
    else
        if is_set(Periodical) and
            not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
            Page = ", s. " .. Page;
        else
            Page = sepc .." " .. PPrefix .. Page;
        end
    end
    
    At = is_set(At) and (sepc .. " " .. At) or "";
    Position = is_set(Position) and (sepc .. " " .. Position) or "";
    if config.CitationClass == 'map' then
        local Section = A['Section'];
        local Inset = A['Inset'];
        if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then
            if is_set( Section ) then
                Section = ", " .. wrap( 'section', Section, true );
            end
            if is_set( Inset ) then
                Inset = ", " .. wrap( 'inset', Inset, true );
            end
        else
            if is_set( Section ) then
                Section = sepc .. " " .. wrap( 'section', Section, use_lowercase );
                if is_set( Inset ) then
                    Inset = ", " .. wrap( 'inset', Inset, true );
                end
            elseif is_set( Inset ) then
                Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase );
            end            
        end            
        At = At .. Section .. Inset;        
    end    

	--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found, 
	use that value; if not, then use the value that was provided with the language parameter.
	
	Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English).
	]]
	if is_set (Language) then
--		local name = mw.language.fetchLanguageName( Language:lower(), "en" );	-- experiment: this seems to return correct ISO 639-1 language names
		local name = cfg.iso639_1[Language:lower()];		-- get the language name if Language parameter has a valid iso 639-1 code
		if nil == name then
			Language=" " .. wrap( 'language', Language );	-- no match, use parameter's value
		else
			if 0 == this_page.namespace and 'no' ~= Language:lower() then	--found a match; is this page main / article space and Norwegian not the language?
				Language=" " .. wrap( 'language', name .. '[[Kategori:Artikler med eksterne lenker på ' .. name .. ']]' );	-- in main space and not English: categorize
			else
				Language=" " .. wrap( 'language', name );	--not in mainspace or language is Norwegian so don't categorize
			end
		end
	else
		Language="";	-- language not specified so make sure this is an empty string;
	end

	Others = is_set(Others) and (sepc .. " " .. Others) or "";

-- handle type parameter for those CS1 citations that have default values

	if inArray(config.CitationClass, {"AV media notes", "DVD notes", "podcast", "pressrelease", "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

	TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
    Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
    Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
    Series = is_set(Series) and (sepc .. " " .. Series) or "";
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
    Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";

    if is_set(Volume) then
        if ( mw.ustring.len(Volume) > 4 )
          then Volume = sepc .." " .. Volume;
          else Volume = ", " .. hyphentodash(Volume);
        end
    end

--[[ This code commented out while discussion continues until after week of 2014-03-23 live module update;
    if is_set(Volume) then
        if ( mw.ustring.len(Volume) > 4 )
          then Volume = sepc .. " " .. Volume;
          else
              Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
              if is_set(Series) then Volume = sepc .. Volume;
              end
        end
    end
]]    
    ------------------------------------ totally unrelated data
    --[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
    behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
    
    Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition.
    ]]
    if is_set(Via) then
        Via = " " .. wrap( 'via', Via );
    end

	if is_set(SubscriptionRequired) then
        SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
    elseif is_set(RegistrationRequired) then
        SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
    end

    if is_set(AccessDate) then
        local retrv_text = " " .. cfg.messages['retrieved']
        if (sepc ~= ".") then retrv_text = retrv_text:lower() end
        AccessDate = '<span class="reference-accessdate">' .. sepc
            .. substitute( retrv_text, {AccessDate} ) .. '</span>'
    end
    
    if is_set(ID) then ID = sepc .." ".. ID; end
   	if "thesis" == config.CitationClass and is_set(Docket) then
		ID = sepc .." Docket ".. Docket .. ID;
	end

    
    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );

    if is_set(URL) then
        URL = " " .. externallink( URL, nil, URLorigin );
    end

    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( 'quoted-text', Quote ); 
        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 = seterror('archive_missing_date');
        end
        if "no" == DeadURL or "nei" == DeadURL then
            local arch_text = cfg.messages['archived'];
            if sepc ~= "." then arch_text = arch_text:lower() end
            Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
                { externallink( ArchiveURL, arch_text ), ArchiveDate } );
            if not is_set(OriginalURL) then
                Archived = Archived .. " " .. seterror('archive_missing_url');                               
            end
        elseif is_set(OriginalURL) then
            local arch_text = cfg.messages['archived-dead'];
            if sepc ~= "." then arch_text = arch_text:lower() end
            Archived = sepc .. " " .. substitute( arch_text,
                { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
        else
            local arch_text = cfg.messages['archived-missing'];
            if sepc ~= "." then arch_text = arch_text:lower() end
            Archived = sepc .. " " .. substitute( arch_text, 
                { seterror('archive_missing_url'), ArchiveDate } );
        end
    else
        Archived = ""
    end
    
    local Lay
    if is_set(LayURL) then
        if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
        if is_set(LaySource) then 
            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''";
        else
            LaySource = "";
        end
        if sepc == '.' then
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary'] ) .. LaySource .. LayDate
        else
            Lay = sepc .. " " .. externallink( LayURL, cfg.messages['lay summary']:lower() ) .. LaySource .. LayDate
        end            
    else
        Lay = "";
    end
    
    if is_set(Transcript) then
        if is_set(TranscriptURL) then Transcript = externallink( TranscriptURL, Transcript ); end
    elseif is_set(TranscriptURL) then
        Transcript = externallink( TranscriptURL, nil, TranscriptURLorigin );
    end
    
    local Publisher;
    if is_set(Periodical) and
        not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
        if is_set(PublisherName) then
            if is_set(PublicationPlace) then
                Publisher = PublicationPlace .. ": " .. PublisherName;
            else
                Publisher = PublisherName;  
            end
        elseif is_set(PublicationPlace) then
            Publisher= PublicationPlace;
        else 
            Publisher = "";
        end
        if is_set(PublicationDate) then
            if is_set(Publisher) then
                Publisher = Publisher .. ", " .. wrap( 'published', PublicationDate );
            else
                Publisher = PublicationDate;
            end
        end
        if is_set(Publisher) then
            Publisher = " (" .. Publisher .. ")";
        end
    else
        if is_set(PublicationDate) then
            PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
        end
        if is_set(PublisherName) then
            if is_set(PublicationPlace) then
                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
            else
                Publisher = sepc .. " " .. PublisherName .. PublicationDate;  
            end            
        elseif is_set(PublicationPlace) then 
            Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
        else 
            Publisher = PublicationDate;
        end
    end
    
    -- Several of the above rely upon detecting this as nil, so do it last.
    if is_set(Periodical) then
        if is_set(Title) or is_set(TitleNote) then 
            Periodical = sepc .. " " .. wrap( 'italic-title', Periodical ) 
        else 
            Periodical = wrap( 'italic-title', Periodical )
        end
    end

--[[
Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
]]
	if "speech" == config.CitationClass then				-- cite speech only
		TitleNote = " (Speech)";							-- annotate the citation
		if is_set (Periodical) then							-- if Periodical, perhaps because of an included |website= or |journal= parameter 
			if is_set (Conference) then						-- and if |event= is set
				Conference = Conference .. sepc .. " ";		-- then add appropriate punctuation to the end of the Conference variable before rendering
			end
		end
	end

    -- Piece all bits together at last.  Here, all should be non-nil.
    -- 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
    if inArray(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
        if is_set(Others) then Others = Others .. sepc .. " " end
        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, 
            Language, Cartography, Edition, Publisher, Agency, Volume, Issue}, sepc );
    else 
        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Scale, Series, Language, 
            Volume, Issue, Others, Cartography, Edition, Publisher, Agency}, sepc );
    end
    
    if #ID_list > 0 then
        ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
    else
        ID_list = ID;
    end
    
    local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
    local text;
    local pgtext = Position .. Page .. Pages .. At;
    
    if is_set(Authors) then
        if is_set(Coauthors) then
            Authors = Authors .. A['AuthorSeparator'] .. " " .. Coauthors
        end
        if is_set(Date) then
            Date = " ("..Date..")" .. OrigYear .. sepc .. " "
        elseif string.sub(Authors,-1,-1) == sepc then
            Authors = Authors .. " "
        else
            Authors = Authors .. sepc .. " "
        end
        if is_set(Editors) then
            local in_text = " ";
            local post_text = "";
            if is_set(Chapter) then
                in_text = in_text .. cfg.messages['in'] .. " "
            else
                if EditorCount <= 1 then
                    post_text = ", " .. cfg.messages['editor'];
                else
                    post_text = ", " .. cfg.messages['editors'];
                end
            end 
            if (sepc ~= '.') then in_text = in_text:lower() end
            Editors = in_text .. Editors .. post_text;
            if (string.sub(Editors,-1,-1) == sepc)
                then Editors = Editors .. " "
                else Editors = Editors .. sepc .. " "
            end
        end
        text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
        text = safejoin( {text, pgtext, idcommon}, sepc );
    elseif is_set(Editors) then
        if is_set(Date) then
            if EditorCount <= 1 then
                Editors = Editors .. ", " .. cfg.messages['editor'];
            else
                Editors = Editors .. ", " .. cfg.messages['editors'];
            end
            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
        else
            if EditorCount <= 1 then
                Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " "
            else
                Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " "
            end
        end
        text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
        text = safejoin( {text, pgtext, idcommon}, sepc );
    else
        if is_set(Date) then
            if ( string.sub(tcommon,-1,-1) ~= sepc )
              then Date = sepc .." " .. Date .. OrigYear
              else Date = " " .. Date .. OrigYear
            end
        end
        if config.CitationClass=="journal" and is_set(Periodical) then
            text = safejoin( {Chapter, Place, tcommon}, sepc );
            text = safejoin( {text, pgtext, Date, idcommon}, sepc );
        else
            text = safejoin( {Chapter, Place, tcommon, Date}, sepc );
            text = safejoin( {text, pgtext, idcommon}, sepc );
        end
    end
    
	if is_set(PostScript) and PostScript ~= sepc then
		text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
		text = text:sub(1,-sepc:len()-1);
--		text = text:sub(1,-2);	--Remove final separator (assumes that sepc is only one character)
	end    
    
    text = safejoin( {text, PostScript}, sepc );

    -- Now enclose the whole thing in a <span/> element
    local options = {};
    
    if is_set(config.CitationClass) and config.CitationClass ~= "citation" then
        options.class = "citation " .. config.CitationClass;
    else
        options.class = "citation";
    end
    
    if is_set(Ref) and Ref:lower() ~= "none" then
        local id = Ref
        if ( "harv" == Ref ) then
            local names = {} --table of last names & year
            if #a > 0 then
                for i,v in ipairs(a) do 
                    names[i] = v.last 
                    if i == 4 then break end
                end
            elseif #e > 0 then
                for i,v in ipairs(e) do 
                    names[i] = v.last 
                    if i == 4 then break end                
                end
            end
			names[ #names + 1 ] = first_set(Year, anchor_year);	-- Year first for legacy citations
            id = anchorid(names)
        end
        options.id = id;
    end
    
    if string.len(text:gsub("<span[^>/]*>.-</span>", ""):gsub("%b<>","")) <= 2 then
        z.error_categories = {};
        text = seterror('empty_citation');
        z.message_tail = {};
    end
    
    if is_set(options.id) then 
        text = '<span id="' .. mw.uri.anchorEncode(options.id) ..'" class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    else
        text = '<span class="' .. mw.text.nowiki(options.class) .. '">' .. text .. "</span>";
    end        

    local empty_span = '<span style="display:none;">&nbsp;</span>';
    
    -- Note: Using display: none on then COinS span breaks some clients.
    local OCinS = '<span title="' .. OCinSoutput .. '" class="Z3988">' .. empty_span .. '</span>';
    text = text .. OCinS;
    
    if #z.message_tail ~= 0 then
        text = text .. " ";
        for i,v in ipairs( z.message_tail ) do
            if is_set(v[1]) then
                if i == #z.message_tail then
                    text = text .. errorcomment( v[1], v[2] );
                else
                    text = text .. errorcomment( v[1] .. "; ", v[2] );
                end
            end
        end
    end
    
    no_tracking_cats = no_tracking_cats:lower();
    if inArray(no_tracking_cats, {"", "no", "nei", "false", "n"}) then
        for _, v in ipairs( z.error_categories ) do
            text = text .. '[[Category:' .. v ..']]';
        end
    end
    
    return text
end

-- This is used by templates such as {{cite book}} to create the actual citation text.
function z.citation(frame)
    local pframe = frame:getParent()
    
    if nil ~= string.find( frame:getTitle(), 'sandkasse', 1, true ) then				-- did the {{#invoke:}} use sandkasse version?
    	cfg = mw.loadData( 'Modul:Citation/CS1/Configuration/sandkasse' );	-- load sandkasse versions of Configuration and Whitelist and ...
    	whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist/sandkasse' );
    	dates = require('Modul:Citation/CS1/Date_validation/sandkasse').dates	-- ... sandkasse version of date validation code
    else																	-- otherwise
    	cfg = mw.loadData( 'Modul:Citation/CS1/Configuration' );			-- load live versions of Configuration and Whitelist and ...
    	whitelist = mw.loadData( 'Modul:Citation/CS1/Whitelist' );
    	dates = require('Modul:Citation/CS1/Date_validation').dates		-- ... live version of date validation code
	end
	
    local args = {};
    local suggestions = {};
    local error_text, error_state;

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

    for k, v in pairs( pframe.args ) do
        if v ~= '' then
            if not validate( k ) then            
                error_text = "";
                if type( k ) ~= 'string' then
                    -- Exclude empty numbered parameters
                    if v:match("%S+") ~= nil then
                        error_text, error_state = seterror( 'text_ignored', {v}, true );
                    end
                elseif validate( k:lower() ) then 
                    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
                else
                    if #suggestions == 0 then
                        suggestions = mw.loadData( 'Modul:Citation/CS1/Suggestions' );
                    end
                    if suggestions[ k:lower() ] ~= nil then
                        error_text, error_state = seterror( 'parameter_ignored_suggest', {k, suggestions[ k:lower() ]}, true );
                    else
                        error_text, error_state = seterror( 'parameter_ignored', {k}, true );
                    end
                end                  
                if error_text ~= '' then
                    table.insert( z.message_tail, {error_text, error_state} );
                end                
            end
            args[k] = v;
        elseif args[k] ~= nil or (k == 'postscript') then
            args[k] = v;
        end        
    end    
    
    return citation0( config, args)
end

return z