Difference between revisions of "Module:Citation/CS1"

Latest revision as of 01:27, 15 February 2015

local z = { error_categories = {}; -- for categorizing citations that contain errors error_ids = {}; message_tail = {}; maintenance_cats = {}; -- for categorizing citations that aren't erroneous per se, but could use a little work properties_cats = {}; -- for categorizing citations based on certain properties, language of source for instance }

-- 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 |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 regardless of the number of deprecated parameters in the citation. ]] function deprecated_parameter(name) if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once table.insert( z.message_tail, { seterror( 'deprecated_params', {name}, true ) } ); -- add error message end end

-- Populates numbered arguments in a message string using an argument table. function substitute( msg, args ) return args and mw.message.newRawMessage( msg, args ):plain() or msg; 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. This function will positive kern either single or double quotes: "'Unkerned title with leading and trailing single quote marks'" " 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example) Double single quotes (italic or bold wikimarkup) are not kerned.

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

]]

function kern_quotes (str) local cap=; local cap2=;

cap, cap2 = str:match ("^([\"\'])([^\'].+)"); -- match leading double or single quote but not double single quotes if is_set (cap) then str = substitute (cfg.presentation['kern-left'], {cap, cap2}); end

cap, cap2 = str:match ("^(.+[^\'])([\"\'])$") if is_set (cap) then str = substitute (cfg.presentation['kern-right'], {cap, cap2}); end return str; end

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

|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped in italic markup.

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

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

The prefix is checked for validity. If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the 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.

At this writing, only |script-title= is supported. It is anticipated that additional parameters will be created to use this function.

TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script; ]]

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 inArray (lang, {'ar', 'bs', 'dv', 'el', 'fa', 'hy', 'ja', 'ko', 'ku', 'he', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then table.insert( z.properties_cats, 'CS1 uses ' .. name .. '-language script ('..lang..')'); -- categorize in language-specific categories else table.insert( z.properties_cats, 'CS1 uses foreign language script'); -- use this category as a catchall until language-specific category is available 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

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

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

function script_concatenate (title, script) if is_set (script) then script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error if is_set (script) then title = title .. ' ' .. script; -- concatenate title and script title end end return title; end

--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------

Applies styling to various parameters. Supplied string is wrapped using a message_list configuration taking one argument; protects italic styled parameters. Additional text taken from citation_config.presentation - the reason this function is similar to but separate from wrap_msg().

]]

function wrap_style (key, str) if not is_set( str ) then return ""; elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then str = safeforitalics( str ); end

return substitute( cfg.presentation[key], {str} ); 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 Template:Citation templates. Additional text taken from citation_config.messages - the reason this function is similar to but separate from wrap_style().

]]

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 str = substitute( msg, {str} ); -- including template text return str; 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 three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta- parameter (chapter_url_source used for error messages).

]]

function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source) local chapter_error = ;

if not is_set (chapter) then chapter = ; -- just to be safe for concatenation if is_set (transchapter) then chapter = wrap_style ('trans-quoted-title', transchapter); chapter_error = " " .. seterror ('trans_missing_chapter'); end if is_set (chapterurl) then chapter = externallink (chapterurl, chapter, chapter_url_source); -- adds bare_url_missing_title error if appropriate end return chapter .. chapter_error; else -- here when chapter is set 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); if is_set (transchapter) then transchapter = wrap_style ('trans-quoted-title', transchapter); chapter = chapter .. ' ' .. transchapter; end if is_set (chapterurl) then chapter = externallink (chapterurl, chapter); -- adds bare_url_missing_title error if appropriate end end return chapter; 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 (name); -- parameter is deprecated but still supported return true; end

-- Arguments with numbers in them name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last# state = whitelist.numbered_arguments[ name ]; if true == state then return true; end -- valid actively supported parameter if false == state then deprecated_parameter (name); -- parameter is deprecated but still supported return true; end

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

--[[--------------------------< E R R O R C O M M E N T >------------------------------------------------------

Wraps error messages with css markup according to the state of hidden.

]] function errorcomment( content, hidden ) return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['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]', options.link, options.label, options.separator or " ", 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', options.link, options.label, options.separator or " ", 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_style ('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

--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------

When date is YYYY-MM-DD format wrap in nowrap span: YYYY-MM-DD. When date is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span: DD MMMM YYYY or MMMM DD, YYYY

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

]]

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

if date:match("^%d%d%d%d%-%d%d%-%d%d$") then date = substitute (cfg.presentation['nowrap1'], date);

elseif date:match("%a+%s*%d%d?,%s*%d%d%d%d") or date:match ("%d%d?%s*%a+%s*%d%d%d%d") then cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$"); date = substitute (cfg.presentation['nowrap2'], {cap, cap2}); end

return date; end

--[[--------------------------< A M A Z O N >------------------------------------------------------------------

Formats a link to Amazon. Do simple error checking: asin must be mix of 10 numeric or uppercase alpha characters. If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit isbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=. Error message if not 10 characters, if not isbn10, if mixed and first character is a digit.

]]

function amazon(id, domain) local err_cat = ""

if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then err_cat = ' ' .. seterror ('bad_asin'); -- asin is not a mix of 10 uppercase alpha and numeric characters else if id:match("^%d%d%d%d%d%d%d%d%d[%dX]$") then -- if 10-digit numeric (or 9 digits with terminal X) if checkisbn( id ) then -- see if asin value is isbn10 table.insert( z.maintenance_cats, "CS1 maint: ASIN uses ISBN"); -- add to maint category elseif not is_set (err_cat) then err_cat = ' ' .. seterror ('bad_asin'); -- asin is not isbn10 end elseif not id:match("^%u[%d%u]+$") then err_cat = ' ' .. seterror ('bad_asin'); -- asin doesn't begin with uppercase alpha end end if not is_set(domain) then domain = "com"; elseif inArray (domain, {'jp', 'uk'}) then -- Japan, United Kingdom domain = "co." .. domain; elseif inArray (domain, {'au', 'br', 'mx'}) then -- Australia, Brazil, Mexico domain = "com." .. 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}) .. err_cat; end

--[[--------------------------< A R X I V >--------------------------------------------------------------------

See: http://arxiv.org/help/arxiv_identifier

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

the second form, valid from April 2007 through December 2014 is: arXiv:<date code>.<number><version> where: <date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01 <number> is a four-digit number <version> is a 1 or more digit number preceded with a lowercase v; no spaces

the third form, valid from January 2015 is: arXiv:<date code>.<number><version> where: <date code> and <version> are as defined for 0704-1412 <number> is a five-digit number ]]

function arxiv (id) local handler = cfg.id_handlers['ARXIV']; local year, month, version; local err_cat = ""

if id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$") or id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$") then -- test for the 9108-0703 format w/ & w/o version year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$"); year = tonumber(year); month = tonumber(month); if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or -- if invalid year or invalid month ((91 == year and 7 > month) or (7 == year and 3 < month)) then -- if years ok, are starting and ending months ok? err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message end elseif id:match("^%d%d[01]%d%.%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%dv%d+$") then -- test for the 0704-1412 w/ & w/o version year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d[v%d]*$"); year = tonumber(year); month = tonumber(month); if ((7 > year) or (14 < year) or (1 > month or 12 < month)) or -- is year invalid or is month invalid? (doesn't test for future years) ((7 == year) and (4 > month)) then --or -- when year is 07, is month invalid (before April)? err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message end elseif id:match("^%d%d[01]%d%.%d%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$") then -- test for the 1501- format w/ & w/o version year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$"); year = tonumber(year); month = tonumber(month); if ((15 > year) or (1 > month or 12 < month)) then -- is year invalid or is month invalid? (doesn't test for future years) err_cat = ' ' .. seterror( 'bad_arxiv' ); -- set error message end else err_cat = ' ' .. seterror( 'bad_arxiv' ); -- arXiv id doesn't match any format end

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

--[[ lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization) 1. Remove all blanks. 2. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash. 3. If there is a hyphen in the string: a. Remove it. b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out): 1. All these characters should be digits, and there should be six or less. (not done in this function) 2. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.

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

function normalize_lccn (lccn) lccn = lccn:gsub ("%s", ""); -- 1. strip whitespace

if nil ~= string.find (lccn,'/') then lccn = lccn:match ("(.-)/"); -- 2. remove forward slash and all character to the right of it end

local prefix local suffix prefix, suffix = lccn:match ("(.+)%-(.+)"); -- 3.a remove hyphen by splitting the string into prefix and suffix

if nil ~= suffix then -- if there was a hyphen suffix=string.rep("0", 6-string.len (suffix)) .. suffix; -- 3.b.2 left fill the suffix with 0s if suffix length less than 6 lccn=prefix..suffix; -- reassemble the lccn end

return lccn; end

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

length = 8 then all digits length = 9 then lccn[1] is lower case alpha length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits length = 12 then lccn[1] and lccn[2] are both lower case alpha

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

id = normalize_lccn (id); -- get canonical form (no whitespace, hyphens, forward slashes) local len = id:len(); -- get the length of the lccn

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

if not is_set (err_cat) and nil ~= lccn:find ('%s') then err_cat = ' ' .. seterror( 'bad_lccn' ); -- lccn contains a space, set an error message end

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

--[[ Format PMID and do simple error checking. PMIDs are sequential numbers beginning at 1 and counting up. This code checks the PMID to see that it contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued. ]] 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; otherwise, 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.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.label .. ":" .. id; if is_set(inactive_year) then table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year ); else table.insert( z.error_categories, "Pages with inactive DOIs" ); -- when inactive doesn't contain a recognizable year end 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:match("^%d+([AMW])$"); -- only digits followed by 'A', 'M', or 'W' 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: 4327 0819 4327 -- can't have spaces in an external link

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

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

if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 digits long, containing only 0-9 or X in the last position 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

--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------

Validate and format a usenet message id. Simple error checking, looks for 'id-left@id-right' not enclosed in '<' and/or '>' angle brackets.

]]

function message_id (id) local handler = cfg.id_handlers['USENETID'];

text = externallinkid({link = handler.link, label = handler.label, prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})

if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then -- doesn't have '@' or has one or first or last character is '< or '>' text = text .. ' ' .. seterror( 'bad_message_id' ) -- add an error message if the message id is invalid end

return text end

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

This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults. Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).

]] function set_titletype(cite_class, title_type) if is_set(title_type) then 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 "Media notes"; -- display AV media notes / DVD media notes annotation

elseif "mailinglist" == cite_class then -- if this citation is cite mailing list return "Mailing list"; -- display mailing list 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 "Press release"; -- display press release annotation

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

elseif "techreport" == cite_class then -- if this citation is cite techreport return "Technical report"; -- display techreport annotation

elseif "thesis" == cite_class then -- if this citation is cite thesis (degree option handled after this function returns) return "Thesis"; -- 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

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

Returns a string where all of lua's magic characters have been escaped. This is important because functions like string.gsub() treat their pattern and replace strings as patterns, not literal strings. ]] function escape_lua_magic_chars (argument) argument = argument:gsub("%%", "%%%%"); -- replace % with %% argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1"); -- replace all other lua magic pattern characters return argument; end

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

Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata. This function strips common patterns of apostrophe markup. We presume that editors who have taken the time to markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.

]] function strip_apostrophe_markup (argument) if not is_set (argument) then return argument; end

while true do if argument:match ("%'%'%'%'%'") then -- bold italic (5) argument=argument:gsub("%'%'%'%'%'", ""); -- remove all instances of it elseif argument:match ("%'%'%'%'") then -- italic start and end without content (4) argument=argument:gsub("%'%'%'%'", ""); elseif argument:match ("%'%'%'") then -- bold (3) argument=argument:gsub("%'%'%'", ""); elseif argument:match ("%'%'") then -- italic (2) argument=argument:gsub("%'%'", ""); else break; end end return argument; -- done end

--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------

Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)

Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings of %27%27... ]]

function make_coins_title (title, script) if is_set (title) then title = strip_apostrophe_markup (title); -- strip any apostrophe markup else title=; -- if not set, make sure title is an empty string end if is_set (script) then script = script:gsub ('^%l%l%s*:%s*', ); -- remove language prefix if present (script value may now be empty string) script = strip_apostrophe_markup (script); -- strip any apostrophe markup else script=; -- if not set, make sure script is an empty string end if is_set (title) and is_set (script) then script = ' ' .. script; -- add a space before we concatenate end return title .. script; -- return the concatenation end

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

Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.

]] function get_coins_pages (pages) local pattern; 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 pattern = escape_lua_magic_chars (pattern); -- pattern is not a literal string; escape lua's magic pattern characters 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 (– etc.) with hyphens; do we need to replace numerical entities like 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 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]', { ['['] = '[', [']'] = ']', ['\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 cannot use 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, 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 = "" .. str; end if str:sub(-1,-1) == "'" then str = str .. ""; end

-- Remove newlines as they break italics. return str:gsub( '\n', ' ' ); end end

--[[--------------------------< S A F E J O I N >--------------------------------------------------------------

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 = ; -- 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 (string -> 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 value ~= comp then -- value does not equal comp when value contains html markup local dup2 = duplicate_char; if dup2:match( "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it

value = value:gsub( "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup else value = value:sub( 2, -1 ); -- remove duplicate_char when it is first character end end end str = str .. value; --add it to the output string end end return str; end

-- Attempts to convert names to initials. function reducetoinitials(first) local initials = {} local i = 0; -- counter for number of initials for word in string.gmatch(first, "%S+") do table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops. i = i + 1; -- bump the counter if 2 <= i then break; end -- only two initials allowed in Vancouver system; if 2, quit end return table.concat(initials) -- Vancouver format does not include spaces. end

-- Formats a list of people (e.g. authors / editors) function listpeople(control, people) local sep; local namesep; local format = control.format local maximum = control.maximum local lastauthoramp = control.lastauthoramp; local text = {} local etal = false;

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 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("—",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) and person.link ~= control.page_name then one = "" .. one .. "" -- link author/editor if this page is not the author's/editor's page end

if is_set(person.link) and ((nil ~= person.link:find("//")) or (nil ~= person.link:find("[%[%]]"))) then one = one .. " " .. seterror( 'bad_authorlink' ) end -- url or wikilink 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

return result, count end

--[[--------------------------< A N C H O R I D >-------------------------------------------------------------- Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise returns an empty string.

]]

function anchorid( options ) local id = table.concat( options ); -- concatenate names and year for CITEREF id if is_set (id) then -- if concatenation is not an empty string return "CITEREF" .. id; -- add the CITEREF portion else return ; -- return an empty string; no reason to include CITEREF id in this citation end end

--[[ Gets name list from the input arguments

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=. ]] function extractnames(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 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 = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1 first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ); link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ); mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );

if first and not last then -- if there is a firstn without a matching lastn table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } ); -- add this error message elseif not first and not last then -- if both firstn and lastn aren't found, are we done? count = count + 1; -- number of times we haven't found last and first if 2 == count then -- two missing names and we give up break; -- normal exit or there is a two-name hole in the list; can't tell which end else -- we have last with or without a first names[n] = {last = last, first = first, link = link, mask = mask}; -- add this name to our names list n = n + 1; -- point to next location in the names table if 1 == count then -- if the previous name was missing table.insert( z.message_tail, { seterror( 'missing_name', {err_msg_list_name, i-1}, true ) } ); -- add this error message end count = 0; -- reset the counter, we're looking for two consecutive missing names end i = i + 1; -- point to next args location end return names; -- all done, return our list of 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 == 'ARXIV' then table.insert( new_list, {handler.label, arxiv( v ) } ); elseif k == 'ASIN' then table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } ); elseif k == 'LCCN' then table.insert( new_list, {handler.label, lccn( v ) } ); elseif k == 'OL' then table.insert( new_list, {handler.label, openlibrary( v ) } ); elseif k == 'PMC' then table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } ); elseif k == 'PMID' then table.insert( new_list, {handler.label, pmid( v ) } ); elseif k == 'ISSN' then table.insert( new_list, {handler.label, issn( v ) } ); elseif k == 'ISBN' then local ISBN = internallinkid( handler ); if not checkisbn( v ) and not is_set(options.IgnoreISBN) then ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" ); end table.insert( new_list, {handler.label, ISBN } ); elseif k == 'USENETID' then table.insert( new_list, {handler.label, message_id( v ) } ); 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_style ('parameter', k); end if #error_list > 1 then error_str = error_str .. cfg.messages['parameter-final-separator']; else error_str = error_str .. cfg.messages['parameter-pair-separator']; end error_str = error_str .. wrap_style ('parameter', selected); table.insert( z.message_tail, { 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.atitle"] = data.Chapter; OCinSoutput["rft.btitle"] = 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

--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------

Validates language names provided in |language= parameter if not an ISO639-1 code. Handles the special case that is Norwegian where ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.

Returns the language name and associated ISO639-1 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() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included in the list will be found if that name is provided in the |language= parameter. For example, if |language=Samaritan Aramaic, that name will be found with the associated code 'sam', not an ISO639-1 code. When names are found and the associated code is not two characters, this function returns only the Wikimedia language name.

Adapted from code taken from Module:Check ISO 639-1. ]]

function get_iso639_code (lang) if 'norwegian' == lang:lower() then -- special case related to Wikimedia remap of code 'no' at Extension:CLDR return 'Norwegian', 'no'; -- Make sure rendered version is properly capitalized end

local languages = mw.language.fetchLanguageNames('en', '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() then -- ISO639-1 codes only return name; -- so return the name but not the code end return name, code; -- found it, return name to ensure proper capitalization and the ISO639-1 code end end return lang; -- not valid language; return language in original case and nil for ISO639-1 code end

--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------

Get language name from ISO639-1 code value provided. If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.

There is an exception. There are three ISO639-1 codes for Norewegian language variants. There are two official variants: Norwegian Bokmål (code 'nb') and Norwegian Nynorsk (code 'nn'). The third, code 'no', is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless. However, it appears that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-English-language external links.

Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and return 'Norwegian' when editors use |language=no. We presume that editors don't know about the variants or can't descriminate between them.

See Help talk:Citation Style_1#An ISO 639-1 language name test

When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if the page is a mainspace page and the ISO639-1 code is not 'en'. Similarly, if the parameter is |language=Norwegian, it will be categorized in the same way.

]]

function language_parameter (lang, namespace) local code; -- the ISO639-1 two character code local name; -- the language name local test=;

if 0 == namespace and (('en' == lang:lower()) or ('english' == lang:lower())) then table.insert (z.maintenance_cats, 'CS1 maint: English language specified'); -- add maintenance category if |language=English or |language=en in article space end

if 2 == lang:len() then -- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes) name = mw.language.fetchLanguageName( lang:lower(), "en" ); -- get ISO 639-1 language name if Language is a proper code end

if is_set (name) then -- if Language specified a valid ISO639-1 code code = lang:lower(); -- save it else name, code = get_iso639_code (lang); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) end

if is_set (code) then if 'no' == code then name = 'Norwegian' end; -- override wikimedia when code is 'no' if 0 == namespace and 'en' ~= code then -- is this page main / article space and English not the language? table.insert( z.properties_cats, 'CS1 ' .. name .. '-language sources (' .. code .. ')'); -- in main space and not English: categorize end else table.insert (z.maintenance_cats, 'CS1 maint: Unrecognized language'); -- add maintenance category when |language= does not appear to be ISO 639-1 language end return (" " .. wrap_msg ('language', name)); -- wrap with '(in ...)' end

--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >---------------------- When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish rendered style.

]]

function get_settings_from_cite_class (ps, ref, cite_class) local sep; if (cite_class == "citation") then -- for citation templates (CS2) sep = ','; -- set citation separator to its default (comma) 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 else -- not a citation template so CS1 sep = '.'; -- set cite xxx separator to its default (period) if not is_set (ps) then -- if |postscript= has not been set ps = '.'; -- set cs1 default end end

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

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

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

]]

function set_style (mode, ps, ref, cite_class) local sep; if is_set (mode) then if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style sep = ','; -- separate elements with a comma if not is_set (ps) then -- unless explicitely set to something ps = ; -- make sure it isn't nil end if not is_set (ref) then -- unless explicitely set to something ref = 'harv'; -- set so this template renders with CITEREF anchor id end elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style sep = '.'; -- separate elements with a period if not is_set (ps) then -- unless explicitely set to something ps = '.'; -- terminate the rendered citation with a period end else -- anything but cs1 or cs2 table.insert( z.message_tail, { seterror( 'invalid_param_val', {'mode', mode}, true ) } ); -- add error message sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass end else -- when |mode= empty or omitted 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

return sep, ps, ref end

--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------ This is the main function doing the majority of the citation formatting. ]] function citation0( config, args) --[[ Load Input Parameters The argument_wrapper facilitates 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 NameListFormat = A['NameListFormat']; -- replaces |author-format= and |editor-format= if is_set (NameListFormat) and ('vanc' ~= NameListFormat) then -- only accepted value for this parameter is 'vanc' table.insert( z.message_tail, { seterror( 'invalid_param_val', {'name-list-format', NameListFormat}, true ) } ); -- not vanc so add error message NameListFormat = ; -- set to empty string end

local Year = A['Year']; local PublicationDate = A['PublicationDate']; local OrigYear = A['OrigYear']; local Date = A['Date']; local LayDate = A['LayDate']; ------------------------------------------------- Get title data local Title = A['Title']; local ScriptTitle = A['ScriptTitle']; local BookTitle = A['BookTitle']; local Conference = A['Conference']; local TransTitle = A['TransTitle']; local TitleNote = A['TitleNote']; local TitleLink = A['TitleLink']; local Chapter = A['Chapter']; local ChapterLink = A['ChapterLink']; -- deprecated local TransChapter = A['TransChapter']; local TitleType = A['TitleType']; local Degree = A['Degree']; local Docket = A['Docket']; local ArchiveURL = A['ArchiveURL']; local URL = A['URL'] local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL local ChapterURL = A['ChapterURL']; local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL local ConferenceURL = A['ConferenceURL']; local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds 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 = A['AccessDate']; local ArchiveDate = A['ArchiveDate']; local Agency = A['Agency']; local DeadURL = A['DeadURL'] local Language = A['Language']; local Format = A['Format']; local ChapterFormat = A['ChapterFormat']; local DoiBroken = A['DoiBroken']; local ID = A['ID']; local ASINTLD = A['ASINTLD']; local IgnoreISBN = A['IgnoreISBN']; local Embargo = A['Embargo'];

local ID_list = extractids( args );

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'); -- get name of parameter that holds TranscriptURL

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

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

--local variables that are not cs1 parameters local use_lowercase; -- controls capitalization of certain static text 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 default parameter values defined by |mode= parameter. If |mode= is empty or omitted, use CitationClass to set these values local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma local PostScript; local Ref; sepc, PostScript, Ref = set_style (A['Mode']:lower(), A['PostScript'], A['Ref'], config.CitationClass); use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text

--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 if inArray (this_page.nsText, cfg.uncategorized_namespaces) then no_tracking_cats = "true"; -- set no_tracking_cats 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

if PublicationPlace == Place then Place = ; end -- don't need both if they are the same

All other combinations of |encyclopedia, |title, and |article are not modified TODO: script-title to script-chapter if and when we support script-chapter ]]

local Encyclopedia = A['Encyclopedia'];

if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation if is_set(Periodical) then -- Periodical is set when |encyclopedia is set if is_set(Title) then if not is_set(Chapter) then Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title TransChapter = TransTitle; ChapterURL = URL; Title = Periodical; ChapterFormat = Format; Periodical = ; -- redundant so unset TransTitle = ; -- redundant so unset URL = ; -- redundant so unset Format = ; -- redundant so unset end else -- |title not set Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title Periodical = ; -- redundant so unset end end end

-- 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', '|id= and |number='); 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(Others) then if is_set(TitleType) then Others = ' ' .. TitleType .. ' with ' .. Others; TitleType = ; else Others = ' ' .. 'Interview with ' .. Others; end else Others = '(Interview)'; end end

-- special case for cite mailing list if (config.CitationClass == "mailinglist") then Periodical = A ['MailingList']; end

--Account for the oddity that is Script error 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 Template:Cite conference, before generation of COinS data. if 'conference' == config.CitationClass then if is_set(BookTitle) then Chapter = Title; -- ChapterLink = TitleLink; -- |chapterlink= is deprecated ChapterURL = URL; ChapterURLorigin = URLorigin; URLorigin = ; ChapterFormat = Format; TransChapter = TransTitle; Title = BookTitle; Format = ; -- TitleLink = ; TransTitle = ; URL = ; end else Conference = ; -- not cite conference so make sure this is empty string end

-- Account for the oddity that is Template:Cite episode, before generation of COinS data. --[[ -- Template: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 Template:Cite episode stuff]]

-- 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 is_set(Date) then if is_set (Year) then table.insert( z.maintenance_cats, "CS1 maint: Date and year"); -- add to maint category end else 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; end elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set Date = PublicationDate; -- promote PublicationDate to Date PublicationDate = ; -- unset, no longer needed end end

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

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

Date validation supporting code is in Module:Citation/CS1/Date_validation ]] 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. -- Test if citation has no title if not is_set(Title) and -- not is_set(Periodical) and -- not a title -- not is_set(Conference) and -- not a title not is_set(TransTitle) and not is_set(ScriptTitle) then table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } ); end

if 'none' == Title and is_set(Periodical) and not (( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia))) then -- special case Title = ; -- set title to empty string table.insert( z.maintenance_cats, "CS1 maint: Untitled periodical"); -- add to maint category end

-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information. -- handle the oddity that is cite encyclopedia and Template:Citation. Here we presume that -- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title -- is the article title, and Chapter is a section within the article. So, we remap

local coins_chapter = Chapter; -- default assuming that remapping not required local coins_title = Title; -- et tu if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used then coins_chapter = Title; -- remap coins_title = Periodical; end end

-- this is the function call to COinS() local OCinSoutput = COinS{ ['Periodical'] = Periodical, ['Chapter'] = strip_apostrophe_markup (coins_chapter), -- Chapter stripped of bold / italic wikimarkup ['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup ['PublicationPlace'] = PublicationPlace, ['Date'] = first_set(COinS_date, Date), -- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here? Should we be including invalid dates in metadata? ['Series'] = Series, ['Volume'] = Volume, ['Issue'] = Issue, ['Pages'] = get_coins_pages (first_set(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, }; --[[Why is this here? Why are we mapping Title to Chapter when Periodical is set? if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then Chapter = Title; ChapterLink = TitleLink; TransChapter = TransTitle; Title = ; TitleLink = ; TransTitle = ; end ]]

-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text if 'newsgroup' == config.CitationClass then if is_set (PublisherName) then PublisherName = 'Newsgroup: ' .. externallink( 'news:' .. PublisherName, PublisherName ); end end

-- Now perform various field substitutions. -- We also add leading spaces and surrounding markup and punctuation to the -- various parts of the citation, but only when they are non-nil. if not is_set(Authors) then local Maximum = tonumber( A['DisplayAuthors'] );

if is_set (Maximum) then if Maximum >= #a then -- if display-authors value greater than or equal to number of authors table.insert( z.maintenance_cats, "CS1 maint: display-authors"); -- add maintenance category because display-authors parameter may be removed end else Maximum = #a + 1; -- number of authors + 1 end

local control = { format = NameListFormat, -- empty string or 'vanc' maximum = Maximum, lastauthoramp = LastAuthorAmp, page_name = this_page.text -- get current page name so that we don't wikilink to it via authorlinkn };

-- 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 = { format = NameListFormat, -- empty string or 'vanc' maximum = Maximum, lastauthoramp = LastAuthorAmp, page_name = this_page.text -- get current page name so that we don't wikilink to it via editorlinkn };

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_msg ('cartography', Cartography, use_lowercase); end Scale = A['Scale']; if is_set( Scale ) then Scale = sepc .. " " .. Scale; end end

Format = is_set(Format) and " (" .. Format .. ")" or "";

if not is_set(URL) and not is_set(ArchiveURL) and not is_set(ConferenceURL) and -- TODO: keep this here? conference as part of cite web or cite podcast? not is_set(TranscriptURL) then

-- Test if cite web or cite podcast |url= is missing or empty if inArray(config.CitationClass, {"web","podcast", "mailinglist"}) 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) and not is_set(ChapterURL)then -- ChapterURL may be set when the others are not set; TODO: move this to a separate test? table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } ); AccessDate = ; end

-- Test if format is given without giving a URL if is_set(Format) then Format = Format .. seterror( 'format_missing_url', {'format', 'url'} ); end end --[[ -- Test if citation has no title if not is_set(Title) and -- not is_set(Periodical) and -- not a title -- not is_set(Conference) and -- not a title not is_set(TransTitle) and not is_set(ScriptTitle) then table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } ); end

if 'none' == Title and is_set(Periodical) then -- special case Title = ; -- set title to empty string table.insert( z.maintenance_cats, "CS1 maint: Untitled periodical"); -- add to maint category end ]] local OriginalURL; DeadURL = DeadURL:lower(); -- used later when assembling archived text if is_set( ArchiveURL ) then if is_set (URL) then OriginalURL = URL; -- save copy of original source URL 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 end elseif is_set (ChapterURL) then -- URL not set so if chapter-url is set apply archive url to it OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text if 'no' ~= DeadURL then ChapterURL = ArchiveURL -- swap-in the archive's url URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages end end end

if inArray(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup"}) or ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then -- chapter parameters not supported for these citation types table.insert( z.message_tail, { seterror( 'chapter_ignored', {}, true ) } ); -- add error message Chapter = ; -- set to empty string to be safe with concatenation TransChapter = ; ChapterURL = ; end else -- otherwise, format chapter / article title Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin); if is_set (Chapter) then ChapterFormat = is_set(ChapterFormat) and " (" .. ChapterFormat .. ")" or ""; if is_set(ChapterFormat) and not is_set (ChapterURL) then -- Test if |chapter-format= is given without giving a |chapter-url= ChapterFormat = ChapterFormat .. seterror( 'format_missing_url', {'chapter-format', 'chapter-url'} ); end Chapter = Chapter .. ChapterFormat .. sepc .. ' '; end end

-- Format main title. if is_set(TitleLink) and is_set(Title) then Title = "" .. Title .. "" end

if inArray(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup", "mailinglist"}) or ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then 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

TransError = ""; if is_set(TransTitle) then if is_set(Title) then TransTitle = " " .. TransTitle; else TransError = " " .. seterror( 'trans_missing_title' ); 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_msg ('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 = ": " .. Pages; elseif tonumber(Pages) ~= nil then Pages = sepc .." " .. PPrefix .. Pages; else Pages = sepc .." " .. PPPrefix .. Pages; end end else if is_set(Periodical) and not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then Page = ": " .. Page; else Page = sepc .." " .. PPrefix .. Page; end end

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_msg ('section', Section, true); end if is_set( Inset ) then Inset = ", " .. wrap_msg ('inset', Inset, true); end else if is_set( Section ) then Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); if is_set( Inset ) then Inset = ", " .. wrap_msg ('inset', Inset, true); end elseif is_set( Inset ) then Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); end end At = At .. Section .. Inset; end

if is_set (Language) then Language = language_parameter (Language, this_page.namespace); -- format, categories (article namespace only), name from ISO639-1, etc else Language=""; -- language not specified so make sure this is an empty string; end

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

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

if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "podcast", "pressrelease", "report", "techreport", "thesis"}) then TitleType = set_titletype (config.CitationClass, TitleType); if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis TitleType = Degree .. " thesis"; end end

if is_set(TitleType) then -- if type parameter is specified TitleType = " (" .. TitleType .. ")"; -- display it in parentheses end

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

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

------------------------------------ totally unrelated data if is_set(Via) then Via = " " .. wrap_msg ('via', Via); end

--[[ Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition.

]] if inArray(SubscriptionRequired:lower(), {'yes', 'true', 'y'}) then SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; -- subscription required message elseif inArray(RegistrationRequired:lower(), {'yes', 'true', 'y'}) then SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; -- registration required message else SubscriptionRequired = ; -- either or both might be set to something other than yes true y end

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

AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if 'citation', lower case AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text -- neither of these work; don't know why; it seems that substitute() isn't being called AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates end

if is_set(ID) then ID = sepc .." ".. ID; end

if "thesis" == config.CitationClass and is_set(Docket) then

ID = sepc .." Docket ".. Docket .. ID; end

if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set

ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set end
ID_list = 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_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags PostScript = ""; -- CS1 does not supply terminal punctuation when |quote= is set end
local Archived if is_set(ArchiveURL) then if not is_set(ArchiveDate) then ArchiveDate = seterror('archive_missing_date'); end if "no" == DeadURL then local arch_text = cfg.messages['archived']; if sepc ~= "." then arch_text = arch_text:lower() end Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], { externallink( ArchiveURL, arch_text ), ArchiveDate } ); if not is_set(OriginalURL) then Archived = Archived .. " " .. seterror('archive_missing_url'); end elseif is_set(OriginalURL) then local arch_text = cfg.messages['archived-dead']; if sepc ~= "." then arch_text = arch_text:lower() end Archived = sepc .. " " .. substitute( arch_text, { externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } ); else local arch_text = cfg.messages['archived-missing']; if sepc ~= "." then arch_text = arch_text:lower() end Archived = sepc .. " " .. substitute( arch_text, { seterror('archive_missing_url'), ArchiveDate } ); end else Archived = "" end
local Lay if is_set(LayURL) then if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end if is_set(LaySource) then LaySource = " – " .. 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_msg ('published', PublicationDate); else Publisher = PublicationDate; end end if is_set(Publisher) then Publisher = " (" .. Publisher .. ")"; end else if is_set(PublicationDate) then PublicationDate = " (" .. wrap_msg ('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_style ('italic-title', Periodical) else Periodical = wrap_style ('italic-title', Periodical) end end
--[[ Handle the oddity that is cite speech. This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so 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 local sep = '; '; if 'vanc' == NameListFormat then sep = ', '; end Authors = Authors .. sep .. 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 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 and for YMD dates that require disambiguation id = anchorid(names) end options.id = id; end
if string.len(text:gsub("/]*>.-", ""):gsub("%b<>","")) <= 2 then z.error_categories = {}; text = seterror('empty_citation'); z.message_tail = {}; end
if is_set(options.id) then text = '' .. text .. ""; else text = '' .. text .. ""; end
local empty_span = ' ';
-- Note: Using display: none on then COinS span breaks some clients. local OCinS = '' .. empty_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", "false", "n"}) then for _, v in ipairs( z.error_categories ) do text = text .. ; end for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories text = text .. ; end for _, v in ipairs( z.properties_cats ) do -- append maintenance categories text = text .. ; end end
return text end
-- This is used by templates such as . to create the actual citation text. function z.citation(frame) local pframe = frame:getParent()
if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then -- did the Script error use sandbox version? cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); -- load sandbox versions of Configuration and Whitelist and ... whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' ); dates = require('Module:Citation/CS1/Date_validation/sandbox').dates -- ... sandbox version of date validation code else -- otherwise cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); -- load live versions of Configuration and Whitelist and ... whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' ); dates = require('Module:Citation/CS1/Date_validation').dates -- ... live version of date validation code end
local args = {}; local 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( 'Module: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

Difference between revisions of "Module:Citation/CS1"

Latest revision as of 01:27, 15 February 2015

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Toolbox

@@ Line 1: / Line 1: @@
 local z = {
-    error_categories = {};
+	error_categories = {};		-- for categorizing citations that contain errors
-    error_ids = {};
+	error_ids = {};
-    message_tail = {};
+	message_tail = {};
+	maintenance_cats = {};		-- for categorizing citations that aren't erroneous per se, but could use a little work
+	properties_cats = {};		-- for categorizing citations based on certain properties, language of source for instance
 }
--- Include translation message hooks, ID and error handling configuration settings.
+-- Whether variable is set or not
-local cfg = mw.loadData( 'Module:Citation/CS1/Configuration' );
+function is_set( var )
+	return not (var == nil or var == '');
--- Contains a list of all recognized parameters
+end
-local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
--- Checks that parameter name is valid
+-- First set variable or nil if none
-function validate( name )
+function first_set(...)
-    name = tostring( name );
+	local list = {...};
+	for _, var in pairs(list) do
-    -- Normal arguments
+		if is_set( var ) then
-    if whitelist.basic_arguments[ name ] then
+			return var;
-        return true;
+		end
-    end
+	end
-    -- Arguments with numbers in them
-    name = name:gsub( "%d+", "#" );
-    if whitelist.numbered_arguments[ name ] then
-        return true;
-    end
-    -- Not found, argument not supported.
-    return false
 end
--- Formats a comment for error trapping
+-- Whether needle is in haystack
-function errorcomment( content, hidden )
+function inArray( needle, haystack )
-    if hidden then
+	if needle == nil then
-        return '<span style="display:none;font-size:100%" class="error citation-comment">' .. content .. '</span>';
+		return false;
-    else
+	end
-        return '<span style="font-size:100%" class="error">' .. content .. '</span>';
+	for n,v in ipairs( haystack ) do
-    end
+		if v == needle then
+			return n;
+		end
+	end
+	return false;
 end
 --[[
-Sets an error condition and returns the appropriate error message.  The actual placement
+Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |month=,
-of the error message in the output is the responsibility of the calling function.
+|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 regardless of the number of deprecated parameters in the citation.
 ]]
-function seterror( error_id, args, raw, prefix, suffix )
+function deprecated_parameter(name)
-    local error_state = cfg.error_conditions[ error_id ];
+	if true ~= Page_in_deprecated_cat then	-- if we haven't been here before then set a
-    prefix = prefix or "";
+		Page_in_deprecated_cat=true;		-- sticky flag so that if there are more than one deprecated parameter the category is added only once
-    suffix = suffix or "";
+		table.insert( z.message_tail, { seterror( 'deprecated_params', {name}, true ) } );		-- add error message
+	end
+end
-    if error_state == nil then
+-- Populates numbered arguments in a message string using an argument table.
-        error( cfg.message_list['undefined_error'] );
+function substitute( msg, args )
-    end
+	return args and mw.message.newRawMessage( msg, args ):plain() or msg;
+end
-    if error_state.category ~= nil and error_state.category ~= "" then
-        table.insert( z.error_categories, error_state.category );
+--[[--------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
-    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.
-    local message = error_state.message;
+This function will positive kern either single or double quotes:
-    if args ~= nil then
+	"'Unkerned title with leading and trailing single quote marks'"
-        for k, m in ipairs( args ) do
+	" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
-            m = m:gsub( "%%", "%%%%" );
+Double single quotes (italic or bold wikimarkup) are not kerned.
-            message = message:gsub( "$" .. k .. "(%D)", m .. "%1" );
-        end
+Call this function for chapter titles, for website titles, etc; not for book titles.
-    end
+]]
-    message = wikiescape(message) .. " ([[" .. cfg.message_list['help page link'] ..
+function kern_quotes (str)
-        "#" .. error_state.anchor .. "|" ..
+	local cap='';
-        cfg.message_list['help page label'] .. "]])";
+	local cap2='';
+	cap, cap2 = str:match ("^([\"\'])([^\'].+)");								-- match leading double or single quote but not double single quotes
+	if is_set (cap) then
+		str = substitute (cfg.presentation['kern-left'], {cap, cap2});
+	end
-    z.error_ids[ error_id ] = true;
+	cap, cap2 = str:match ("^(.+[^\'])([\"\'])$")
-    if (error_id == 'bare_url_missing_title' or error_id == 'trans_missing_title')
+	if is_set (cap) then
-            and z.error_ids['citation_missing_title'] then
+		str = substitute (cfg.presentation['kern-right'], {cap, cap2});
-        return '', false;
+	end
-    end
+	return str;
-    message = prefix .. message .. suffix;
-    if raw == true then
-        return message, error_state.hidden;
-    end
-    return errorcomment( message, error_state.hidden );
 end
--- This returns a string with HTML character entities for wikitext markup characters.
+--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
-function wikiescape(text)
-    text = text:gsub( '[&\'%[%]{|}]', {
+|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
-            ['&'] = '&#38;',
+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
-            ["'"] = '&#39;',
+in italic markup.
-            ['['] = '&#91;',
-            [']'] = '&#93;',
+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.
-            ['{'] = '&#123;',
-            ['|'] = '&#124;',
+|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:
-            ['}'] = '&#125;' } );
+	|script-title=ja:*** *** (where * represents a Japanese character)
-    return text;
+Spaces between the two-character code and the colon and the colon and the first script character are allowed:
+	|script-title=ja : *** ***
+	|script-title=ja: *** ***
+	|script-title=ja :*** ***
+Spaces preceding the prefix are allowed: |script-title = ja:*** ***
+The prefix is checked for validity.  If it is a valid 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.
+At this writing, only |script-title= is supported.  It is anticipated that additional parameters will be created to use this function.
+TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script;
+]]
+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 inArray (lang, {'ar', 'bs', 'dv', 'el', 'fa', 'hy', 'ja', 'ko', 'ku', 'he', 'ps', 'ru', 'sd', 'sr', 'th', 'uk', 'ug', 'yi', 'zh'}) then
+				table.insert( z.properties_cats, 'CS1 uses ' .. name .. '-language script ('..lang..')');	-- categorize in language-specific categories
+			else
+				table.insert( z.properties_cats, 'CS1 uses foreign language script');	-- use this category as a catchall until language-specific category is available
+			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
+--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
+Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
+wrapped in <bdi> tags.
+]]
+function script_concatenate (title, script)
+	if is_set (script) then
+		script = format_script_value (script);									-- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
+		if is_set (script) then
+			title = title .. ' ' .. script;										-- concatenate title and script title
+		end
+	end
+	return title;
+end
+--[[--------------------------< W R A P _ S T Y L E >----------------------------------------------------------
+Applies styling to various parameters.  Supplied string is wrapped using a message_list configuration taking one
+argument; protects italic styled parameters.  Additional text taken from citation_config.presentation - the reason
+this function is similar to but separate from wrap_msg().
+]]
+function wrap_style (key, str)
+	if not is_set( str ) then
+		return "";
+	elseif inArray( key, { 'italic-title', 'trans-italic-title' } ) then
+		str = safeforitalics( str );
+	end
+	return substitute( cfg.presentation[key], {str} );
+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().
+]]
+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
+		str = substitute( msg, {str} );											-- including template text
+		return str;
+	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 three chapter parameters: |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
+parameter (chapter_url_source used for error messages).
+]]
+function format_chapter_title (chapter, transchapter, chapterurl, chapter_url_source)
+	local chapter_error = '';
+	if not is_set (chapter) then
+		chapter = '';															-- just to be safe for concatenation
+		if is_set (transchapter) then
+			chapter = wrap_style ('trans-quoted-title', transchapter);
+			chapter_error = " " .. seterror ('trans_missing_chapter');
+		end
+		if is_set (chapterurl) then
+			chapter = externallink (chapterurl, chapter, chapter_url_source);	-- adds bare_url_missing_title error if appropriate
+		end
+		return chapter .. chapter_error;
+	else																		-- here when chapter is set
+		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);
+		if is_set (transchapter) then
+			transchapter = wrap_style ('trans-quoted-title', transchapter);
+			chapter = chapter .. ' ' .. transchapter;
+		end
+		if is_set (chapterurl) then
+			chapter = externallink (chapterurl, chapter);						-- adds bare_url_missing_title error if appropriate
+		end
+	end
+	return chapter;
+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 (name);				-- parameter is deprecated but still supported
+		return true;
+	end
+	-- Arguments with numbers in them
+	name = name:gsub( "%d+", "#" );				-- replace digit(s) with # (last25 becomes last#
+	state = whitelist.numbered_arguments[ name ];
+	if true == state then return true; end		-- valid actively supported parameter
+	if false == state then
+		deprecated_parameter (name);				-- parameter is deprecated but still supported
+		return true;
+	end
+	return false;								-- Not supported because not found or name is set to nil
+end
+--[[--------------------------< E R R O R C O M M E N T >------------------------------------------------------
+Wraps error messages with css markup according to the state of hidden.
+]]
+function errorcomment( content, hidden )
+	return substitute( hidden and cfg.presentation['hidden-error'] or cfg.presentation['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 sep = options.separator or "&nbsp;"
+	local url_string = options.id;
-    options.suffix = options.suffix or ""
+	if options.encode == true or options.encode == nil then
-    local url_string = options.id
+		url_string = mw.uri.encode( url_string );
-    if options.encode == true or options.encode == nil then
+	end
-        url_string = mw.uri.encode( url_string );
+	return mw.ustring.format( '[[%s|%s]]%s[%s%s%s %s]',
-    end
+		options.link, options.label, options.separator or "&nbsp;",
+		options.prefix, url_string, options.suffix or "",
-    return "[[" .. options.link .. "|" .. options.label .. "]]" .. sep .. "[" ..
+		mw.text.nowiki(options.id)
-            options.prefix .. url_string .. options.suffix .. " " .. mw.text.nowiki(options.id) .. "]"
+	);
 end
 -- Formats a wiki style internal link
 function internallinkid(options)
-    local sep = options.separator or "&nbsp;"
+	return mw.ustring.format( '[[%s|%s]]%s[[%s%s%s|%s]]',
-    options.suffix = options.suffix or ""
+		options.link, options.label, options.separator or "&nbsp;",
-    return "[[" .. options.link .. "|" .. options.label .. "]]" .. sep .. "[[" ..
+		options.prefix, options.id, options.suffix or "",
-            options.prefix .. options.id .. options.suffix .. "|" .. mw.text.nowiki(options.id) .. "]]"
+		mw.text.nowiki(options.id)
+	);
 end
 -- Format an external link with error checking
-function externallink( URL, label )
+function externallink( URL, label, source )
-    local error_str = "";
+	local error_str = "";
-    if label == nil or label == "" then
+	if not is_set( label ) then
-        label = URL;
+		label = URL;
-        error_str = seterror( 'bare_url_missing_title', {}, false, " " );
+		if is_set( source ) then
-    end
+			error_str = seterror( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " );
-    if not checkurl( URL ) then
+		else
-        error_str = seterror( 'bad_url', {}, false, " " ) .. error_str;
+			error( cfg.messages["bare_url_no_origin"] );
-    end
+		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
-    return "[" .. URL .. ' ' .. safeforurl( label ) .. "]" .. error_str;
+--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------
+When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.  When date is DD MMMM YYYY or is
+MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
+DOES NOT yet support MMMM YYYY or any of the date ranges.
+]]
+function nowrap_date (date)
+	local cap='';
+	local cap2='';
+	if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
+		date = substitute (cfg.presentation['nowrap1'], date);
+	elseif date:match("%a+%s*%d%d?,%s*%d%d%d%d") or date:match ("%d%d?%s*%a+%s*%d%d%d%d") then
+		cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
+		date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
+	end
+	return date;
 end
--- Formats a link to Amazon
+--[[--------------------------< A M A Z O N >------------------------------------------------------------------
+Formats a link to Amazon.  Do simple error checking: asin must be mix of 10 numeric or uppercase alpha
+characters.  If a mix, first character must be uppercase alpha; if all numeric, asins must be 10-digit
+isbn. If 10-digit isbn, add a maintenance category so a bot or awb script can replace |asin= with |isbn=.
+Error message if not 10 characters, if not isbn10, if mixed and first character is a digit.
+]]
 function amazon(id, domain)
-    if ( nil == domain ) then
+	local err_cat = ""
-        domain = "com"
-    elseif ( "jp" == domain or "uk" == domain ) then
+	if not id:match("^[%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u][%d%u]$") then
-        domain = "co." .. domain
+		err_cat =  ' ' .. seterror ('bad_asin');								-- asin is not a mix of 10 uppercase alpha and numeric characters
-    end
+	else
-    local handler = cfg.id_handlers['ASIN'];
+		if id:match("^%d%d%d%d%d%d%d%d%d[%dX]$") then								-- if 10-digit numeric (or 9 digits with terminal X)
-    return externallinkid({link = handler.link,
+			if checkisbn( id ) then												-- see if asin value is isbn10
-        label=handler.label , prefix="//www.amazon."..domain.."/dp/",id=id,
+				table.insert( z.maintenance_cats, "CS1 maint: ASIN uses ISBN");	-- add to maint category
-        encode=handler.encode, separator = handler.separator})
+			elseif not is_set (err_cat) then
+				err_cat =  ' ' .. seterror ('bad_asin');						-- asin is not isbn10
+			end
+		elseif not id:match("^%u[%d%u]+$") then
+			err_cat =  ' ' .. seterror ('bad_asin');							-- asin doesn't begin with uppercase alpha
+		end
+	end
+	if not is_set(domain) then
+		domain = "com";
+	elseif inArray (domain, {'jp', 'uk'}) then			-- Japan, United Kingdom
+		domain = "co." .. domain;
+	elseif inArray (domain, {'au', 'br', 'mx'}) then	-- Australia, Brazil, Mexico
+		domain = "com." .. 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}) .. err_cat;
+end
+--[[--------------------------< A R X I V >--------------------------------------------------------------------
+See: http://arxiv.org/help/arxiv_identifier
+format and error check arXiv identifier.  There are three valid forms of the identifier:
+the first form, valid only between date codes 9108 and 0703 is:
+	arXiv:<archive>.<class>/<date code><number><version>
+where:
+	<archive> is a string of alpha characters - may be hyphenated; no other punctuation
+	<class> is a string of alpha characters - may be hyphenated; no other punctuation
+	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
+		first digit of YY for this form can only 9 and 0
+	<number> is a three-digit number
+	<version> is a 1 or more digit number preceded with a lowercase v; no spaces (undocumented)
+the second form, valid from April 2007 through December 2014 is:
+	arXiv:<date code>.<number><version>
+where:
+	<date code> is four digits in the form YYMM where YY is the last two digits of the four-digit year and MM is the month number January = 01
+	<number> is a four-digit number
+	<version> is a 1 or more digit number preceded with a lowercase v; no spaces
+the third form, valid from January 2015 is:
+	arXiv:<date code>.<number><version>
+where:
+	<date code> and <version> are as defined for 0704-1412
+	<number> is a five-digit number
+]]
+function arxiv (id)
+	local handler = cfg.id_handlers['ARXIV'];
+	local year, month, version;
+	local err_cat = ""
+	if id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%d$") or id:match("^%a[%a%.%-]+/[90]%d[01]%d%d%d%dv%d+$") then	-- test for the 9108-0703 format w/ & w/o version
+		year, month = id:match("^%a[%a%.%-]+/([90]%d)([01]%d)%d%d%d[v%d]*$");
+		year = tonumber(year);
+		month = tonumber(month);
+		if ((not (90 < year or 8 > year)) or (1 > month or 12 < month)) or		-- if invalid year or invalid month
+			((91 == year and 7 > month) or (7 == year and 3 < month)) then		-- if years ok, are starting and ending months ok?
+				err_cat = ' ' .. seterror( 'bad_arxiv' );						-- set error message
+		end
+	elseif id:match("^%d%d[01]%d%.%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%dv%d+$") then	-- test for the 0704-1412 w/ & w/o version
+		year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d[v%d]*$");
+		year = tonumber(year);
+		month = tonumber(month);
+		if ((7 > year) or (14 < year) or (1 > month or 12 < month)) or			-- is year invalid or is month invalid? (doesn't test for future years)
+			((7 == year) and (4 > month)) then --or									-- when year is 07, is month invalid (before April)?
+				err_cat = ' ' .. seterror( 'bad_arxiv' );						-- set error message
+		end
+	elseif id:match("^%d%d[01]%d%.%d%d%d%d%d$") or id:match("^%d%d[01]%d%.%d%d%d%d%dv%d+$") then	-- test for the 1501- format w/ & w/o version
+		year, month = id:match("^(%d%d)([01]%d)%.%d%d%d%d%d[v%d]*$");
+		year = tonumber(year);
+		month = tonumber(month);
+		if ((15 > year) or (1 > month or 12 < month)) then						-- is year invalid or is month invalid? (doesn't test for future years)
+			err_cat = ' ' .. seterror( 'bad_arxiv' );							-- set error message
+		end
+	else
+		err_cat = ' ' .. seterror( 'bad_arxiv' );								-- arXiv id doesn't match any format
+	end
+	return externallinkid({link = handler.link, label = handler.label,
+			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
+end
+--[[
+lccn normalization (http://www.loc.gov/marc/lccn-namespace.html#normalization)
+. Remove all blanks.
+. If there is a forward slash (/) in the string, remove it, and remove all characters to the right of the forward slash.
+. If there is a hyphen in the string:
+	a. Remove it.
+	b. Inspect the substring following (to the right of) the (removed) hyphen. Then (and assuming that steps 1 and 2 have been carried out):
+. All these characters should be digits, and there should be six or less. (not done in this function)
+. If the length of the substring is less than 6, left-fill the substring with zeroes until the length is six.
+Returns a normalized lccn for lccn() to validate.  There is no error checking (step 3.b.1) performed in this function.
+]]
+function normalize_lccn (lccn)
+	lccn = lccn:gsub ("%s", "");									-- 1. strip whitespace
+	if nil ~= string.find (lccn,'/') then
+		lccn = lccn:match ("(.-)/");								-- 2. remove forward slash and all character to the right of it
+	end
+	local prefix
+	local suffix
+	prefix, suffix = lccn:match ("(.+)%-(.+)");						-- 3.a remove hyphen by splitting the string into prefix and suffix
+	if nil ~= suffix then											-- if there was a hyphen
+		suffix=string.rep("0", 6-string.len (suffix)) .. suffix;	-- 3.b.2 left fill the suffix with 0s if suffix length less than 6
+		lccn=prefix..suffix;										-- reassemble the lccn
+	end
+	return lccn;
+	end
+--[[
+Format LCCN link and do simple error checking.  LCCN is a character string 8-12 characters long. The length of the LCCN dictates the character type of the first 1-3 characters; the
+rightmost eight are always digits. http://info-uri.info/registry/OAIHandler?verb=GetRecord&metadataPrefix=reg&identifier=info:lccn/
+length = 8 then all digits
+length = 9 then lccn[1] is lower case alpha
+length = 10 then lccn[1] and lccn[2] are both lower case alpha or both digits
+length = 11 then lccn[1] is lower case alpha, lccn[2] and lccn[3] are both lower case alpha or both digits
+length = 12 then lccn[1] and lccn[2] are both lower case alpha
+]]
+function lccn(lccn)
+	local handler = cfg.id_handlers['LCCN'];
+	local err_cat =  '';								-- presume that LCCN is valid
+	local id = lccn;									-- local copy of the lccn
+	id = normalize_lccn (id);							-- get canonical form (no whitespace, hyphens, forward slashes)
+	local len = id:len();								-- get the length of the lccn
+	if 8 == len then
+		if id:match("[^%d]") then						-- if LCCN has anything but digits (nil if only digits)
+			err_cat = ' ' .. seterror( 'bad_lccn' );	-- set an error message
+		end
+	elseif 9 == len then								-- LCCN should be adddddddd
+		if nil == id:match("%l%d%d%d%d%d%d%d%d") then			-- does it match our pattern?
+			err_cat = ' ' .. 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("^%l%l%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("^%l%l%l%d%d%d%d%d%d%d%d") or id:match("^%l%d%d%d%d%d%d%d%d%d%d")) then	-- see if it matches one of our patterns
+			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
+		end
+	elseif 12 == len then								-- LCCN should be aadddddddddd
+		if not id:match("^%l%l%d%d%d%d%d%d%d%d%d%d") then	-- see if it matches our pattern
+			err_cat = ' ' .. seterror( 'bad_lccn' );	-- no match, set an error message
+		end
+	else
+		err_cat = ' ' .. seterror( 'bad_lccn' );		-- wrong length, set an error message
+	end
+	if not is_set (err_cat) and nil ~= lccn:find ('%s') then
+		err_cat = ' ' .. seterror( 'bad_lccn' );		-- lccn contains a space, set an error message
+	end
+	return externallinkid({link = handler.link, label = handler.label,
+			prefix=handler.prefix,id=lccn,separator=handler.separator, encode=handler.encode}) .. err_cat;
+end
+--[[
+Format PMID and do simple error checking.  PMIDs are sequential numbers beginning at 1 and counting up.  This code checks the PMID to see that it
+contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
+]]
+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; otherwise, 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 cat = ""
-    local handler = cfg.id_handlers['DOI'];
+	local handler = cfg.id_handlers['DOI'];
-    local text;
+	local text;
-    if ( inactive ~= nil ) then
+	if is_set(inactive) then
-        text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
+		local inactive_year = inactive:match("%d%d%d%d") or '';		-- try to get the year portion from the inactive date
-        table.insert( z.error_categories, "Pages with DOIs inactive since " .. selectyear(inactive) );
+		text = "[[" .. handler.link .. "|" .. handler.label .. "]]:" .. id;
-        inactive = " (" .. cfg.message_list['inactive'] .. " " .. inactive .. ")"
+		if is_set(inactive_year) then
-    else
+			table.insert( z.error_categories, "Pages with DOIs inactive since " .. inactive_year );
-        text = externallinkid({link = handler.link, label = handler.label,
+		else
-            prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
+			table.insert( z.error_categories, "Pages with inactive DOIs" );	-- when inactive doesn't contain a recognizable year
-        inactive = ""
+		end
-    end
+		inactive = " (" .. cfg.messages['inactive'] .. " " .. inactive .. ")"
-    if ( string.sub(id,1,3) ~= "10." ) then
+	else
-        cat = seterror( 'bad_doi' );
+		text = externallinkid({link = handler.link, label = handler.label,
-    end
+			prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
-    return text .. inactive .. cat
+		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 code = id:match("^%d+([AMW])$");					-- only digits followed by 'A', 'M', or 'W'
-    local handler = cfg.id_handlers['OL'];
+	local handler = cfg.id_handlers['OL'];
-    if ( code == "A" ) then
-        return externallinkid({link=handler.link, label=handler.label,
+	if ( code == "A" ) then
-            prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
+		return externallinkid({link=handler.link, label=handler.label,
-            encode = handler.encode})
+			prefix="http://openlibrary.org/authors/OL",id=id, separator=handler.separator,
-    elseif ( code == "M" ) then
+			encode = handler.encode})
-        return externallinkid({link=handler.link, label=handler.label,
+	elseif ( code == "M" ) then
-            prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
+		return externallinkid({link=handler.link, label=handler.label,
-            encode = handler.encode})
+			prefix="http://openlibrary.org/books/OL",id=id, separator=handler.separator,
-    elseif ( code == "W" ) then
+			encode = handler.encode})
-        return externallinkid({link=handler.link, label=handler.label,
+	elseif ( code == "W" ) then
-            prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
+		return externallinkid({link=handler.link, label=handler.label,
-            encode = handler.encode})
+			prefix= "http://openlibrary.org/works/OL",id=id, separator=handler.separator,
-    else
+			encode = handler.encode})
-        return externallinkid({link=handler.link, label=handler.label,
+	else
-            prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
+		return externallinkid({link=handler.link, label=handler.label,
-            encode = handler.encode}) ..
+			prefix= "http://openlibrary.org/OL",id=id, separator=handler.separator,
-            ' ' .. seterror( 'bad_ol' );
+			encode = handler.encode}) ..
-    end
+			' ' .. 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 endashes from the issn
+	if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then		-- validate the issn: 8 digits long, containing only 0-9 or X in the last position
+		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
+--[[--------------------------< M E S S A G E _ I D >----------------------------------------------------------
+Validate and format a usenet message id.  Simple error checking, looks for 'id-left@id-right' not enclosed in
+'<' and/or '>' angle brackets.
+]]
+function message_id (id)
+	local handler = cfg.id_handlers['USENETID'];
+	text = externallinkid({link = handler.link, label = handler.label,
+		prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
+	if not id:match('^.+@.+$') or not id:match('^[^<].*[^>]$')then				-- doesn't have '@' or has one or first or last character is '< or '>'
+		text = text .. ' ' .. seterror( 'bad_message_id' )						-- add an error message if the message id is invalid
+	end
+	return text
+end
+--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
+This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
+Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
+]]
+function set_titletype(cite_class, title_type)
+	if is_set(title_type) then
+		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 "Media notes";					-- display AV media notes / DVD media notes annotation
+	elseif "mailinglist" == cite_class then		-- if this citation is cite mailing list
+		return "Mailing list";					-- display mailing list 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 "Press release";					-- display press release annotation
+	elseif "report" == cite_class then			-- if this citation is cite report
+		return "Report";						-- display report annotation
+	elseif "techreport" == cite_class then		-- if this citation is cite techreport
+		return "Technical report";				-- display techreport annotation
+	elseif "thesis" == cite_class then			-- if this citation is cite thesis (degree option handled after this function returns)
+			return "Thesis";					-- display simple thesis annotation (without |degree= modification)
+	end
 end
 --[[
-Determines whether an URL string is valid
+Determines whether a URL string is valid
 At present the only check is whether the string appears to
@@ Line 198: / Line 848: @@
 ]]
 function checkurl( url_str )
-    if url_str:sub(1,2) == "//" then
+	-- Protocol-relative or URL scheme
-        -- Protocol-less URLs
+	return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
-        return true;
-    elseif url_str:match( "^[^/]*:" ) ~= nil then
-        -- Look for ":" prefix and assume it is a URI scheme
-        return true;
-    else
-        -- Anything else is an error
-        return false;
-    end
 end
@@ Line 213: / Line 855: @@
 -- Similar to that used for Special:BookSources
 function cleanisbn( isbn_str )
-    return isbn_str:gsub( "[^-0-9X]", "" );
+	return isbn_str:gsub( "[^-0-9X]", "" );
+end
+--[[--------------------------< E S C A P E _ L U A _ M A G I C _ C H A R S >----------------------------------
+Returns a string where all of lua's magic characters have been escaped.  This is important because functions like
+string.gsub() treat their pattern and replace strings as patterns, not literal strings.
+]]
+function escape_lua_magic_chars (argument)
+	argument = argument:gsub("%%", "%%%%");										-- replace % with %%
+	argument = argument:gsub("([%^%$%(%)%.%[%]%*%+%-%?])", "%%%1");				-- replace all other lua magic pattern characters
+	return argument;
+end
+--[[--------------------------< S T R I P _ A P O S T R O P H E _ M A R K U P >--------------------------------
+Strip wiki italic and bold markup from argument so that it doesn't contaminate COinS metadata.
+This function strips common patterns of apostrophe markup.  We presume that editors who have taken the time to
+markup a title have, as a result, provided valid markup. When they don't, some single apostrophes are left behind.
+]]
+function strip_apostrophe_markup (argument)
+	if not is_set (argument) then return argument; end
+	while true do
+		if argument:match ("%'%'%'%'%'") then									-- bold italic (5)
+			argument=argument:gsub("%'%'%'%'%'", "");							-- remove all instances of it
+		elseif argument:match ("%'%'%'%'") then									-- italic start and end without content (4)
+			argument=argument:gsub("%'%'%'%'", "");
+		elseif argument:match ("%'%'%'") then									-- bold (3)
+			argument=argument:gsub("%'%'%'", "");
+		elseif argument:match ("%'%'") then										-- italic (2)
+			argument=argument:gsub("%'%'", "");
+		else
+			break;
+		end
+	end
+	return argument;															-- done
+end
+--[[--------------------------< M A K E _ C O I N S _ T I T L E >----------------------------------------------
+Makes a title for COinS from Title and / or ScriptTitle (or any other name-script pairs)
+Apostrophe markup (bold, italics) is stripped from each value so that the COinS metadata isn't correupted with strings
+of %27%27...
+]]
+function make_coins_title (title, script)
+	if is_set (title) then
+		title = strip_apostrophe_markup (title);								-- strip any apostrophe markup
+	else
+		title='';																-- if not set, make sure title is an empty string
+	end
+	if is_set (script) then
+		script = script:gsub ('^%l%l%s*:%s*', '');								-- remove language prefix if present (script value may now be empty string)
+		script = strip_apostrophe_markup (script);								-- strip any apostrophe markup
+	else
+		script='';																-- if not set, make sure script is an empty string
+	end
+	if is_set (title) and is_set (script) then
+		script = ' ' .. script;													-- add a space before we concatenate
+	end
+	return title .. script;														-- return the concatenation
+end
+--[[--------------------------< G E T _ C O I N S _ P A G E S >------------------------------------------------
+Extract page numbers from external wikilinks in any of the |page=, |pages=, or |at= parameters for use in COinS.
+]]
+function get_coins_pages (pages)
+	local pattern;
+	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
+		pattern = escape_lua_magic_chars (pattern);								-- pattern is not a literal string; escape lua's magic pattern characters
+		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 )
-    isbn_str = cleanisbn( isbn_str ):gsub( "-", "" );
+	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
-    local len = isbn_str:len();
+	isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" );	-- remove hyphens and spaces
+	local len = isbn_str:len();
-    if len ~= 10 and len ~= 13 then
+	if len ~= 10 and len ~= 13 then
-        return false;
+		return false;
-    end
+	end
-    local temp = 0;
+	if len == 10 then
-    if len == 10 then
+		if isbn_str:match( "^%d*X?$" ) == nil then return false; end
-        if isbn_str:match( "^%d*X?$" ) == nil then return false; end
+		return is_valid_isxn(isbn_str, 10);
-        isbn_str = { isbn_str:byte(1, len) };
+	else
-        for i, v in ipairs( isbn_str ) do
+		local temp = 0;
-            if v == string.byte( "X" ) then
+		if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end	-- isbn13 begins with 978 or 979
-                temp = temp + 10*( 11 - i );
+		isbn_str = { isbn_str:byte(1, len) };
-            else
+		for i, v in ipairs( isbn_str ) do
-                temp = temp + tonumber( string.char(v) )*(11-i);
+			temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
-            end
+		end
-        end
+		return temp % 10 == 0;
-        return temp % 11 == 0;
+	end
-    else
-        if isbn_str:match( "^%d*$" ) == nil then return false; end
-        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 )
-    str = str:gsub( "%[%[[^|%]]*|([^%]]*)%]%]", "%1" );
+	return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
-    str = str:gsub( "%[%[([^%]]*)%]%]", "%1" );
+		return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
-    return str
+	end));
 end
 -- Escape sequences for content that will be used for URL descriptions
 function safeforurl( str )
-    if str:match( "%[%[.-%]%]" ) ~= nil then
+	if str:match( "%[%[.-%]%]" ) ~= nil then
-        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
+		table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
-    end
+	end
-    return str:gsub( '[%[%]\n]', {
+	return str:gsub( '[%[%]\n]', {
-        ['['] = '&#91;',
+		['['] = '&#91;',
-        [']'] = '&#93;',
+		[']'] = '&#93;',
-        ['\n'] = ' ' } );
+		['\n'] = ' ' } );
 end
 -- Converts a hyphen to a dash
 function hyphentodash( str )
-    if str == nil then
+	if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
-        return nil;
+		return str;
-    end
+	end
-    if str:match( "[%[%]{}<>]" ) ~= nil then
+	return str:gsub( '-', '–' );
-        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
+	--[[ Note: We cannot use <i> for italics, as the expected behavior for
-    italics specified by ''...'' in the title is that they will be inverted
+	italics specified by ''...'' in the title is that they will be inverted
-    (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
+	(i.e. unitalicized) in the resulting references.  In addition, <i> and ''
-    tend to interact poorly under Mediawiki's HTML tidy. ]]
+	tend to interact poorly under Mediawiki's HTML tidy. ]]
-    if str == nil or str == '' then
+	if not is_set(str) then
-        return str;
+		return str;
-    else
+	else
-        if str:sub(1,1) == "'" then str = "<span />" .. str; end
+		if str:sub(1,1) == "'" then str = "<span />" .. str; end
-        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
+		if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
-        return str:gsub( '\n', ' ' );
-    end
+		-- Remove newlines as they break italics.
+		return str:gsub( '\n', ' ' );
+	end
 end
---[[
+--[[--------------------------< S A F E J O I N >--------------------------------------------------------------
-Joins a sequence of strings together while checking for duplicate separation
-characters.
+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.
+	Note: we use string functions here, rather than ustring functions.
-    This has considerably faster performance and should work correctly as
+	This has considerably faster performance and should work correctly as
-    long as the duplicate_char is strict ASCII.  The strings
+	long as the duplicate_char is strict ASCII.  The strings
-    in tbl may be ASCII or UTF8.
+	in tbl may be ASCII or UTF8.
-    ]]
+	]]
-    local str = '';
+	local str = '';																-- the output string
-    local comp = '';
+	local comp = '';															-- what does 'comp' mean?
-    local end_chr = '';
+	local end_chr = '';
-    local trim;
+	local trim;
-    for _, value in ipairs( tbl ) do
+	for _, value in ipairs( tbl ) do
-        if value == nil then value = ''; end
+		if value == nil then value = ''; end
-        if str == '' then
+		if str == '' then														-- if output string is empty
-            str = value;
+			str = value;														-- assign value to it (first time through the loop)
-        elseif value ~= '' then
+		elseif value ~= '' then
-            if value:sub(1,1) == '<' then
+			if value:sub(1,1) == '<' then										-- Special case of values enclosed in spans and other markup.
-                -- Special case of values enclosed in spans and other markup.
+				comp = value:gsub( "%b<>", "" );								-- remove html markup (<span>string</span> -> string)
-                comp = value:gsub( "%b<>", "" );
+			else
-            else
+				comp = value;
-                comp = value;
+			end
-            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?
-            if comp:sub(1,1) == duplicate_char then
+																				--   Because individual string segments often (always?) begin with terminal punct for th
-                trim = false;
+																				--   preceding segment: 'First element' .. 'sepc next element' .. etc?
-                end_chr = str:sub(-1,-1);
+				trim = false;
-                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
+				end_chr = str:sub(-1,-1);										-- get the last character of the output string
-                if end_chr == duplicate_char then
+				-- str = str .. "<HERE(enchr=" .. end_chr.. ")"					-- debug stuff?
-                    str = str:sub(1,-2);
+				if end_chr == duplicate_char then								-- if same as separator
-                elseif end_chr == "'" then
+					str = str:sub(1,-2);										-- remove it
-                    if str:sub(-3,-1) == duplicate_char .. "''" then
+				elseif end_chr == "'" then										-- if it might be wikimarkup
-                        str = str:sub(1, -4) .. "''";
+					if str:sub(-3,-1) == duplicate_char .. "''" then			-- if last three chars of str are sepc''
-                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
+						str = str:sub(1, -4) .. "''";							-- remove them and add back ''
-                        trim = true;
+					elseif str:sub(-5,-1) == duplicate_char .. "]]''" then		-- if last five chars of str are sepc]]''
-                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
+						trim = true;											-- why? why do this and next differently from previous?
-                        trim = true;
+					elseif str:sub(-4,-1) == duplicate_char .. "]''" then		-- if last four chars of str are sepc]''
-                    end
+						trim = true;											-- same question
-                elseif end_chr == "]" then
+					end
-                    if str:sub(-3,-1) == duplicate_char .. "]]" then
+				elseif end_chr == "]" then										-- if it might be wikimarkup
-                        trim = true;
+					if str:sub(-3,-1) == duplicate_char .. "]]" then			-- if last three chars of str are sepc]] wikilink
-                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
+						trim = true;
-                        trim = true;
+					elseif str:sub(-2,-1) == duplicate_char .. "]" then			-- if last two chars of str are sepc] external link
-                    end
+						trim = true;
-                elseif end_chr == " " then
+					elseif str:sub(-4,-1) == duplicate_char .. "'']" then		-- normal case when |url=something & |title=Title.
-                    if str:sub(-2,-1) == duplicate_char .. " " then
+						trim = true;
-                        str = str:sub(1,-3);
+					end
-                    end
+				elseif end_chr == " " then										-- if last char of output string is a space
-                end
+					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 trim then
-                    if value ~= comp then
+					if value ~= comp then 										-- value does not equal comp when value contains html markup
-                        local dup2 = duplicate_char;
+						local dup2 = duplicate_char;
-                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
+						if dup2:match( "%A" ) then dup2 = "%" .. dup2; end		-- if duplicate_char not a letter then escape it
-                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
+						value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )			-- remove duplicate_char if it follows html markup
-                    else
+					else
-                        value = value:sub( 2, -1 );
+						value = value:sub( 2, -1 );								-- remove duplicate_char when it is first character
-                    end
+					end
-                end
+				end
-            end
+			end
-            str = str .. value;
+			str = str .. value;													--add it to the output string
-        end
+		end
-    end
+	end
-    return str;
+	return str;
 end
---[[
-Return the year portion of a date string, if possible.
-Returns empty string if the argument can not be interpreted
-as a year.
-]]
-function selectyear( str )
-    -- Is the input a simple number?
-    local num = tonumber( str );
-    if num ~= nil and num > 0 and num < 2100 and num == math.abs(num) then
-        return str;
-    else
-        -- Use formatDate to interpret more complicated formats
-        local lang = mw.getContentLanguage();
-        local good, result;
-        good, result = pcall( lang.formatDate, lang, 'Y', str )
-        if good then
-            return result;
-        else
-            -- Can't make sense of this input, return blank.
-            return "";
-        end
-    end
-end
 -- Attempts to convert names to initials.
 function reducetoinitials(first)
-    local initials = {}
+	local initials = {}
-    for word in string.gmatch(first, "%S+") do
+	local i = 0;										-- counter for number of initials
-        table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
+	for word in string.gmatch(first, "%S+") do
-    end
+		table.insert(initials, string.sub(word,1,1))	-- Vancouver format does not include full stops.
-    return table.concat(initials) -- Vancouver format does not include spaces.
+		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
 -- Formats a list of people (e.g. authors / editors)
 function listpeople(control, people)
-    local sep = control.sep;
+	local sep;
-    if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
+	local namesep;
-    local namesep = control.namesep
+	local format = control.format
-    local format = control.format
+	local maximum = control.maximum
-    local maximum = control.maximum
+	local lastauthoramp = control.lastauthoramp;
-    local lastauthoramp = control.lastauthoramp;
+	local text = {}
-    local text = {}
+	local etal = false;
-    local etal = false;
-    for i,person in ipairs(people) do
+	if 'vanc' == format then													-- Vancouver-like author/editor name styling?
-        if (person.last ~= nil or person.last ~= "") then
+		sep = ',';																-- name-list separator between authors is a comma
-            local mask = person.mask
+		namesep = ' ';															-- last/first separator is a space
-            local one
+	else
-            if ( maximum ~= nil and i == maximum + 1 ) then
+		sep = ';'																-- name-list separator between authors is a semicolon
-                etal = true;
+		namesep = ', '															-- last/first separator is <comma><space>
-                break;
+	end
-            elseif (mask ~= nil) then
-                local n = tonumber(mask)
+	if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
-                if (n ~= nil) then
+	if maximum ~= nil and maximum < 1 then return "", 0; end
-                    one = string.rep("&mdash;",n)
-                else
+	for i,person in ipairs(people) do
-                    one = mask
+		if is_set(person.last) then
-                end
+			local mask = person.mask
-            else
+			local one
-                one = person.last
+			local sep_one = sep;
-                local first = person.first
+			if maximum ~= nil and i > maximum then
-                if (first ~= nil and first ~= '') then
+				etal = true;
-                    if ( "vanc" == format ) then first = reducetoinitials(first) end
+				break;
-                    one = one .. namesep .. first
+			elseif (mask ~= nil) then
-                end
+				local n = tonumber(mask)
-                if (person.link ~= nil and person.link ~= "") then one = "[[" .. person.link .. "|" .. one .. "]]" end
+				if (n ~= nil) then
-            end
+					one = string.rep("&mdash;",n)
-            table.insert(text, one)
+				else
-        end
+					one = mask;
-    end
+					sep_one = " ";
-    local count = #text;
+				end
-    if count > 1 and lastauthoramp ~= nil and lastauthoramp ~= "" and not etal then
+			else
-        text[count-1] = text[count-1] .. " & " .. text[count];
+				one = person.last
-        text[count] = nil;
+				local first = person.first
-    end
+				if is_set(first) then
-    local result = table.concat(text, sep) -- construct list
+					if ( "vanc" == format ) then first = reducetoinitials(first) end
-    if etal then
+					one = one .. namesep .. first
-        local etal_text = cfg.message_list['et al'];
+				end
-        result = result .. " " .. etal_text;
+				if is_set(person.link) and person.link ~= control.page_name then
-    end
+					one = "[[" .. person.link .. "|" .. one .. "]]"		-- link author/editor if this page is not the author's/editor's page
+				end
-    -- if necessary wrap result in <span> tag to format in Small Caps
-    if ( "scap" == format ) then result =
+				if is_set(person.link) and ((nil ~= person.link:find("//")) or (nil ~= person.link:find("[%[%]]"))) then
-        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
+					one = one .. " " .. seterror( 'bad_authorlink' ) end	-- url or wikilink in author link;
-    end
+			end
-    return result, count
+			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
+	return result, count
 end
--- Generates a CITEREF anchor ID.
+--[[--------------------------< A N C H O R I D >--------------------------------------------------------------
+Generates a CITEREF anchor ID if we have at least one name or a date.  Otherwise returns an empty string.
+]]
 function anchorid( options )
-    return "CITEREF" .. mw.uri.anchorEncode( table.concat( options ) );
+	local id = table.concat( options );											-- concatenate names and year for CITEREF id
+	if is_set (id) then															-- if concatenation is not an empty string
+		return "CITEREF" .. id;													-- add the CITEREF portion
+	else
+		return '';																-- return an empty string; no reason to include CITEREF id in this citation
+	end
 end
--- Gets author list from the input arguments
+--[[
-function extractauthors(args)
+Gets name list from the input arguments
-    local authors = {};
-    local i = 1;
+Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
-    local last;
+Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
-    while true do
+find |last4= and |last5= then the search is done.
-        if i == 1 then
-            last = selectone( args, {"author" .. i .. "-last", "author-last" .. i,
+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=
-                "last" .. i, "surname" .. i, "Author" .. i, "author" .. i,
+are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
-                "author-last", "last", "surname", "Author", "author", "authors"}, 'redundant_parameters' );
+]]
-        else
+function extractnames(args, list_name)
-            last = selectone( args, {"author" .. i .. "-last", "author-last" .. i,
+	local names = {};			-- table of names
-                "last" .. i, "surname" .. i, "Author" .. i, "author" .. i}, 'redundant_parameters' );
+	local last;					-- individual name components
-        end
+	local first;
-        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
+	local link;
-            if i == 1 then
+	local mask;
-                authors[i] = {
+	local i = 1;				-- loop counter/indexer
-                    last = last,
+	local n = 1;				-- output table indexer
-                    first = selectone( args, {"author" .. i .. "-first", "author-first" .. i,
+	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)
-                        "first" .. i, "given" .. i, "author-first",
-                        "first", "given"}, 'redundant_parameters' ),
+	local err_msg_list_name = list_name:match ("(%w+)List") .. 's list';		-- modify AuthorList or EditorList for use in error messages if necessary
-                    link = selectone( args, {"author" .. i .. "-link", "author-link" .. i,
-                        "author" .. i .. "link", "authorlink" .. i, "author-link",
+	while true do
-                        "authorlink"}, 'redundant_parameters' ),
+		last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );		-- search through args for name components beginning at 1
-                    mask = selectone( args, {"author" .. i .. "-mask", "author-mask" .. i,
+		first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
-                        "author" .. i .. "mask", "authormask" .. i, "author-mask",
+		link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
-                        "authormask" }, 'redundant_parameters' )
+		mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
-                }
-            else
-                authors[i] = {
-                    last = last,
-                    first = selectone( args, {"author" .. i .. "-first", "author-first" .. i,
-                        "first" .. i, "given" .. i}, 'redundant_parameters' ),
-                    link = selectone( args, {"author" .. i .. "-link", "author-link" .. i,
-                        "author" .. i .. "link", "authorlink" .. i}, 'redundant_parameters' ),
-                    mask = selectone( args, {"author" .. i .. "-mask", "author-mask" .. i,
-                        "author" .. i .. "mask", "authormask" .. i}, 'redundant_parameters' )
-                }
-            end
-        else
-            break;
-        end
-        i = i + 1;
-    end
-    return authors;
-end
--- Gets editor list from the input arguments
+		if first and not last then												-- if there is a firstn without a matching lastn
-function extracteditors(args)
+			table.insert( z.message_tail, { seterror( 'first_missing_last', {err_msg_list_name, i}, true ) } );	-- add this error message
-    local editors = {};
+		elseif not first and not last then										-- if both firstn and lastn aren't found, are we done?
-    local i = 1;
+			count = count + 1;													-- number of times we haven't found last and first
-    local last;
+			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
-    while true do
+			end
-        if i == 1 then
+		else																	-- we have last with or without a first
-            last = selectone( args, {"editor" .. i .. "-last", "editor-last" .. i,
+			names[n] = {last = last, first = first, link = link, mask = mask};	-- add this name to our names list
-                "EditorSurname" .. i, "Editor" .. i, "editor" .. i, "editor-last",
+			n = n + 1;															-- point to next location in the names table
-                "EditorSurname", "Editor", "editor", "editors"}, 'redundant_parameters' );
+			if 1 == count then													-- if the previous name was missing
-        else
+				table.insert( z.message_tail, { seterror( 'missing_name', {err_msg_list_name, i-1}, true ) } );		-- add this error message
-            last = selectone( args, {"editor" .. i .. "-last", "editor-last" .. i,
+			end
-                "EditorSurname" .. i, "Editor" .. i, "editor" .. i}, 'redundant_parameters' );
+			count = 0;															-- reset the counter, we're looking for two consecutive missing names
-        end
+		end
-        if ( last and "" < last ) then -- just in case someone passed in an empty parameter
+		i = i + 1;																-- point to next args location
-            if i == 1 then
+	end
-                editors[i] = {
+	return names;																-- all done, return our list of names
-                    last = last,
-                    first = selectone( args, {"editor" .. i .. "-first",
-                        "editor-first" .. i, "EditorGiven" .. i, "editor-first",
-                        "EditorGiven"}, 'redundant_parameters' ),
-                    link = selectone( args, {"editor" .. i .. "-link", "editor-link" .. i,
-                        "editor" .. i .. "link", "editorlink" .. i, "editor-link",
-                        "editorlink"}, 'redundant_parameters' ),
-                    mask = selectone( args, {"editor" .. i .. "-mask", "editor-mask" .. i,
-                        "editor" .. i .. "mask", "editormask" .. i, "editor-mask",
-                        "editormask"}, 'redundant_parameters' )
-                }
-            else
-                editors[i] = {
-                    last = last,
-                    first = selectone( args, {"editor" .. i .. "-first",
-                        "editor-first" .. i, "EditorGiven" .. i}, 'redundant_parameters' ),
-                    link = selectone( args, {"editor" .. i .. "-link", "editor-link" .. i,
-                        "editor" .. i .. "link", "editorlink" .. i}, 'redundant_parameters' ),
-                    mask = selectone( args, {"editor" .. i .. "-mask", "editor-mask" .. i,
-                        "editor" .. i .. "mask", "editormask" .. i}, 'redundant_parameters' )
-                }
-            end
-        else
-            break;
-        end
-        i = i + 1;
-    end
-    return editors;
 end
 -- Populates ID table from arguments using configuration settings
 function extractids( args )
-    local id_list = {};
+	local id_list = {};
+	for k, v in pairs( cfg.id_handlers ) do
-    for k, v in pairs( cfg.id_handlers ) do
+		v = selectone( args, v.parameters, 'redundant_parameters' );
-        id_list[k] = selectone( args, v.parameters, 'redundant_parameters' );
+		if is_set(v) then id_list[k] = v; end
-    end
+	end
+	return id_list;
-    return id_list;
 end
--- Takes a table of IDs and turns it into a table of formatted ID outputs.
+--[[--------------------------< B U I L D I D L I S T >--------------------------------------------------------
-function buildidlist( id_list, options )
+Takes a table of IDs and turns it into a table of formatted ID outputs.
-    local handler;
-    local new_list = {};
-    for k, v in pairs( id_list ) do
-        handler = {};
-        --Becasue cfg is read-only we have to copy it the hard way.
-        for k2, v2 in pairs( cfg.id_handlers[k] ) do
-            handler[k2] = v2;
-        end
-        handler['id'] = v;
-        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
-            if 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 == 'OL' then
-                table.insert( new_list, {handler.label, openlibrary( v ) } );
-            elseif k == 'ISBN' then
-                local ISBN = internallinkid( handler );
-                if not checkisbn( v ) and ( options.IgnoreISBN == nil or options.IgnoreISBN == "" ) then
-                    ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
-                end
-                table.insert( new_list, {handler.label, ISBN } );
-            else
-                error( cfg.message_list['unknown_manual_ID'] );
-            end
-        else
-            error( cfg.message_list['unknown_ID_mode'] );
-        end
-    end
-    function comp( a, b )
+]]
-        return a[1] < b[1];
+function buildidlist( id_list, options )
-    end
+	local new_list, handler = {};
-    table.sort( new_list, comp );
+	function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
-    for k, v in ipairs( new_list ) do
-        new_list[k] = v[2];
+	for k, v in pairs( id_list ) do
-    end
+		-- fallback to read-only cfg
+		handler = setmetatable( { ['id'] = v }, fallback(k) );
-    return new_list;
+		if handler.mode == 'external' then
+			table.insert( new_list, {handler.label, externallinkid( handler ) } );
+		elseif handler.mode == 'internal' then
+			table.insert( new_list, {handler.label, internallinkid( handler ) } );
+		elseif handler.mode ~= 'manual' then
+			error( cfg.messages['unknown_ID_mode'] );
+		elseif k == 'DOI' then
+			table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
+		elseif k == 'ARXIV' then
+			table.insert( new_list, {handler.label, arxiv( v ) } );
+		elseif k == 'ASIN' then
+			table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
+		elseif k == 'LCCN' then
+			table.insert( new_list, {handler.label, lccn( v ) } );
+		elseif k == 'OL' then
+			table.insert( new_list, {handler.label, openlibrary( v ) } );
+		elseif k == 'PMC' then
+			table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
+		elseif k == 'PMID' then
+			table.insert( new_list, {handler.label, pmid( v ) } );
+		elseif k == 'ISSN' then
+			table.insert( new_list, {handler.label, issn( v ) } );
+		elseif k == 'ISBN' then
+			local ISBN = internallinkid( handler );
+			if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
+				ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
+			end
+			table.insert( new_list, {handler.label, ISBN } );
+		elseif k == 'USENETID' then
+			table.insert( new_list, {handler.label, message_id( v ) } );
+		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 )
+function selectone( args, possible, error_condition, index )
-    local value = nil;
+	local value = nil;
-    local selected = '';
+	local selected = '';
-    local error_list = {};
+	local error_list = {};
-    for _, v in ipairs( possible ) do
+	if index ~= nil then index = tostring(index); end
-        if args[v] ~= nil then
-            if value ~= nil then
+	-- Handle special case of "#" replaced by empty string
-                table.insert( error_list, v );
+	if index == '1' then
-            else
+		for _, v in ipairs( possible ) do
-                value = args[v];
+			v = v:gsub( "#", "" );
-                selected = v;
+			if is_set(args[v]) then
-            end
+				if value ~= nil and selected ~= v then
-        end
+					table.insert( error_list, v );
-    end
+				else
+					value = args[v];
-    if #error_list > 0 then
+					selected = v;
-        local error_str = "";
+				end
-        for _, k in ipairs( error_list ) do
+			end
-            if error_str ~= "" then error_str = error_str .. ", " end
+		end
-            error_str = error_str .. "<code>|" .. k .. "=</code>";
+	end
-        end
-        if #error_list > 1 then
+	for _, v in ipairs( possible ) do
-            error_str = error_str .. ", and ";
+		if index ~= nil then
-        else
+			v = v:gsub( "#", index );
-            error_str = error_str .. " and ";
+		end
-        end
+		if is_set(args[v]) then
-        error_str = error_str .. "<code>|" .. selected .. "=</code>";
+			if value ~= nil and selected ~=  v then
-        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
+				table.insert( error_list, v );
-    end
+			else
+				value = args[v];
-    return value, selected;
+				selected = v;
+			end
+		end
+	end
+	if #error_list > 0 then
+		local error_str = "";
+		for _, k in ipairs( error_list ) do
+			if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
+			error_str = error_str .. wrap_style ('parameter', k);
+		end
+		if #error_list > 1 then
+			error_str = error_str .. cfg.messages['parameter-final-separator'];
+		else
+			error_str = error_str .. cfg.messages['parameter-pair-separator'];
+		end
+		error_str = error_str .. wrap_style ('parameter', selected);
+		table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
+	end
+	return value, selected;
 end
---[[
+-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
-This is the main function foing the majority of the citation
+-- 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.atitle"] = data.Chapter;
+		OCinSoutput["rft.btitle"] = 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
+--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
+Validates language names provided in |language= parameter if not an ISO639-1 code.  Handles the special case that is Norwegian where
+ISO639-1 code 'no' is mapped to language name 'Norwegian Bokmål' by Extention:CLDR.
+Returns the language name and associated ISO639-1 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() will return a list of languages that aren't part of ISO639-1. Names that aren't ISO639-1 but that are included
+in the list will be found if that name is provided in the |language= parameter.  For example, if |language=Samaritan Aramaic, that name will be
+found with the associated code 'sam', not an ISO639-1 code.  When names are found and the associated code is not two characters, this function
+returns only the Wikimedia language name.
+Adapted from code taken from Module:Check ISO 639-1.
+]]
+function get_iso639_code (lang)
+	if 'norwegian' == lang:lower() then											-- special case related to Wikimedia remap of code 'no' at Extension:CLDR
+		return 'Norwegian', 'no';												-- Make sure rendered version is properly capitalized
+	end
+	local languages = mw.language.fetchLanguageNames('en', '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() then												-- ISO639-1 codes only
+				return name;													-- so return the name but not the code
+			end
+			return name, code;													-- found it, return name to ensure proper capitalization and the ISO639-1 code
+		end
+	end
+	return lang;																-- not valid language; return language in original case and nil for ISO639-1 code
+end
+--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
+Get language name from ISO639-1 code value provided.  If a code is valid use the returned name; if not, then use the value that was provided with the language parameter.
+There is an exception.  There are three ISO639-1 codes for Norewegian language variants.  There are two official variants: Norwegian Bokmål (code 'nb') and
+Norwegian Nynorsk (code 'nn').  The third, code 'no',  is defined by ISO639-1 as 'Norwegian' though in Norway this is pretty much meaningless.  However, it appears
+that on enwiki, editors are for the most part unaware of the nb and nn variants (compare page counts for these variants at Category:Articles with non-English-language external links.
+Because Norwegian Bokmål is the most common language variant, Media wiki has been modified to return Norwegian Bokmål for ISO639-1 code 'no'. Here we undo that and
+return 'Norwegian' when editors use |language=no.  We presume that editors don't know about the variants or can't descriminate between them.
+See Help talk:Citation Style_1#An ISO 639-1 language name test
+When |language= contains a valid ISO639-1 code, the page is assigned to the category for that code: Category:Norwegian-language sources (no) if
+the page is a mainspace page and the ISO639-1 code is not 'en'.  Similarly, if the  parameter is |language=Norwegian, it will be categorized in the same way.
+]]
+function language_parameter (lang, namespace)
+	local code;			-- the ISO639-1 two character code
+	local name;			-- the language name
+	local test='';
+	if 0 == namespace and (('en' == lang:lower()) or ('english' == lang:lower())) then
+		table.insert (z.maintenance_cats, 'CS1 maint: English language specified');		-- add maintenance category if |language=English or |language=en in article space
+	end
+	if 2 == lang:len() then														-- ISO639-1 language code are 2 characters (fetchLanguageName also supports 3 character codes)
+		name = mw.language.fetchLanguageName( lang:lower(), "en" );				-- get ISO 639-1 language name if Language is a proper code
+	end
+	if is_set (name) then														-- if Language specified a valid ISO639-1 code
+		code = lang:lower();													-- save it
+	else
+		name, code = get_iso639_code (lang);									-- attempt to get code from name (assign name here so that we are sure of proper capitalization)
+	end
+	if is_set (code) then
+		if 'no' == code then name = 'Norwegian' end;							-- override wikimedia when code is 'no'
+		if 0 == namespace and 'en' ~= code then									-- is this page main / article space and English not the language?
+			table.insert( z.properties_cats, 'CS1 ' .. name .. '-language sources (' .. code .. ')');	-- in main space and not English: categorize
+		end
+	else
+		table.insert (z.maintenance_cats, 'CS1 maint: Unrecognized language');	-- add maintenance category when |language= does not appear to be ISO 639-1 language
+	end
+	return (" " .. wrap_msg ('language', name));								-- wrap with '(in ...)'
+end
+--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
+When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish
+rendered style.
+]]
+function get_settings_from_cite_class (ps, ref, cite_class)
+local sep;
+	if (cite_class == "citation") then											-- for citation templates (CS2)
+		sep = ',';																-- set citation separator to its default (comma)
+		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
+	else																		-- not a citation template so CS1
+		sep = '.';																-- set cite xxx separator to its default (period)
+		if not is_set (ps) then													-- if |postscript= has not been set
+			ps = '.';															-- set cs1 default
+		end
+	end
+	return sep, ps, ref															-- return them all
+end
+--[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------
+Establish basic style settings to be used when rendering the citation.  Uses |mode= if set and valid or uses
+config.CitationClass from the template's #invoke: to establish style.
+]]
+function set_style (mode, ps, ref, cite_class)
+local sep;
+	if is_set (mode) then
+		if 'cs2' == mode then											-- if this template is to be rendered in CS2 (citation) style
+			sep = ',';															-- separate elements with a comma
+			if not is_set (ps) then												-- unless explicitely set to something
+				ps = '';														-- make sure it isn't nil
+			end
+			if not is_set (ref) then											-- unless explicitely set to something
+				ref = 'harv';													-- set so this template renders with CITEREF anchor id
+			end
+		elseif 'cs1' == mode then										-- if this template is to be rendered in CS1 (cite xxx) style
+			sep = '.';															-- separate elements with a period
+			if not is_set (ps) then												-- unless explicitely set to something
+				ps = '.';														-- terminate the rendered citation with a period
+			end
+		else																	-- anything but cs1 or cs2
+			table.insert( z.message_tail, { seterror( 'invalid_param_val', {'mode', mode}, true ) } );		-- add error message
+			sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class);	-- get settings based on the template's CitationClass
+		end
+	else													-- when |mode= empty or omitted
+		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
+	return sep, ps, ref
+end
+--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
+This is the main function doing the majority of the citation
 formatting.
 ]]
 function citation0( config, args)
-    -- Load Input Parameters
+	--[[
+	Load Input Parameters
+	The argument_wrapper facilitates the mapping of multiple
+	aliases to single internal variable.
+	]]
+	local A = argument_wrapper( args );
-    local i
+	local i
-    local PPrefix = config.PPrefix or "p.&nbsp;"
+	local PPrefix = A['PPrefix']
-    local PPPrefix = config.PPPrefix or "pp.&nbsp;"
+	local PPPrefix = A['PPPrefix']
-    if ( nil ~= args.nopp ) then PPPrefix = "" PPrefix = "" end
+	if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
-    -- Pick out the relevant fields from the arguments.  Different citation templates
+	-- Pick out the relevant fields from the arguments.  Different citation templates
-    -- define different field names for the same underlying things.
+	-- define different field names for the same underlying things.
-    local Authors = args.authors
+	local Authors = A['Authors'];
-    local a = extractauthors( args );
+	local a = extractnames( args, 'AuthorList' );
-    local Coauthors = selectone( args, {'coauthors', 'coauthor' }, 'redundant_parameters' );
+	local Coauthors = A['Coauthors'];
-    local Others = args.others
+	local Others = A['Others'];
-    local Editors = args.editors
+	local Editors = A['Editors'];
-    local e = extracteditors( args );
+	local e = extractnames( args, 'EditorList' );
-    local Year = args.year
+	local NameListFormat = A['NameListFormat'];									-- replaces |author-format= and |editor-format=
-    local PublicationDate = selectone( args, {'publicationdate', 'publication-date' }, 'redundant_parameters' );
+	if is_set (NameListFormat) and ('vanc' ~= NameListFormat) then											-- only accepted value for this parameter is 'vanc'
-    local OrigYear = args.origyear
+		table.insert( z.message_tail, { seterror( 'invalid_param_val', {'name-list-format', NameListFormat}, true ) } );	-- not vanc so add error message
-    local Date = args.date
+		NameListFormat = '';													-- set to empty string
-    local LayDate = args.laydate
+	end
-    ------------------------------------------------- Get title data
-    local Title = args.title or args.encyclopaedia or args.encyclopedia or args.dictionary
-    local BookTitle = args.booktitle
-    local Conference = args.conference
-    local TransTitle = selectone( args, {'trans-title', 'trans_title' }, 'redundant_parameters' );
-    local TitleNote = args.department
-    local TitleLink = selectone( args, {'titlelink', 'episodelink' }, 'redundant_parameters' );
-    local Chapter = selectone( args, {'chapter', 'contribution', 'entry' }, 'redundant_parameters' );
-    local ChapterLink = args.chapterlink
-    local TransChapter = selectone( args, {'trans-chapter', 'trans_chapter' }, 'redundant_parameters' );
-    local TitleType = args.type
-    local ArchiveURL = selectone( args, {'archive-url', 'archiveurl' }, 'redundant_parameters' );
-    local URL = selectone( args, {'url', 'URL'}, 'redundant_parameters' );
-    local ChapterURL = selectone( args, {'chapter-url', 'chapterurl', 'contribution-url', 'contributionurl' }, 'redundant_parameters' );
-    local ConferenceURL = selectone( args, {'conference-url', 'conferenceurl' }, 'redundant_parameters' );
-    local Periodical = selectone( args, {'journal', 'newspaper', 'magazine', 'work', 'website',
-        'periodical', 'encyclopedia', 'encyclopaedia'}, 'redundant_parameters' );
-    if ( config.CitationClass == "encyclopaedia" ) then
-        if ( args.article and args.article ~= "") then
-            if ( Title and Title ~= "") then Periodical = Title end
-            Chapter = args.article
-            TransChapter = TransTitle
-            Title = nil
-            TransTitle = nil
-        elseif ( Chapter == nil or Chapter == '' ) then
-            if Title ~= args.encyclopedia then
-                Chapter = Title
-                TransChapter = TransTitle
-                Title = nil
-                TransTitle = nil
-            end
-        end
-        if ( Periodical and Periodical ~= "") then
-            if Periodical == Title or Periodical == Chapter then Periodical = nil end
-        end
-    end
-    local Series = selectone( args, {'series', 'version'}, 'redundant_parameters' );
-    local Volume = args.volume
-    local Issue = selectone( args, {'issue', 'number'}, 'redundant_parameters' );
-    local Position = nil
-    local Page, Pages, At, page_type;
-    Page, page_type = selectone( args, {'p', 'page', 'pp', 'pages', 'at'},
-        'extra_pages' );
-    if page_type == 'pp' or page_type == 'pages' then
-        Pages = hyphentodash( Page );
-        Page = nil;
-    elseif page_type == 'at' then
-        At = Page;
-        Page = nil;
-    end
-    local Edition = args.edition
-    local PublicationPlace = selectone( args, {'publication-place', 'publicationplace' }, 'redundant_parameters' );
-    local Place = selectone( args, {'place', 'location'}, 'redundant_parameters' );
-    if PublicationPlace == nil and Place ~= nil then
-        PublicationPlace = Place;
-    end
-    if PublicationPlace == Place then Place = nil end
-    local PublisherName = args.publisher
-    local SubscriptionRequired = args.subscription
-    local Via = args.via
-    local AccessDate = selectone( args, {'access-date', 'accessdate' }, 'redundant_parameters' );
-    local ArchiveDate = selectone( args, {'archive-date', 'archivedate' }, 'redundant_parameters' );
-    local Agency = args.agency
-    local DeadURL = args.deadurl or "yes"           -- Only used if ArchiveURL is present.
-    local Language = selectone( args, {'language', 'in'}, 'redundant_parameters' );
-    local Format = args.format
-    local Ref = selectone( args, {'ref', 'Ref'}, 'redundant_parameters' );
-    local DoiBroken = selectone( args, {'doi_inactivedate', 'doi_brokendate', 'DoiBroken'}, 'redundant_parameters' );
+	local Year = A['Year'];
-    local ID = selectone( args, {'id', 'ID', 'docket'}, 'redundant_parameters' );
+	local PublicationDate = A['PublicationDate'];
-    local ASINTLD = selectone( args, {'ASIN-TLD', 'asin-tld'}, 'redundant_parameters' );
+	local OrigYear = A['OrigYear'];
-    local IgnoreISBN = selectone( args, {'ignore-isbn-error', 'ignoreisbnerror'}, 'redundant_parameters' );
+	local Date = A['Date'];
+	local LayDate = A['LayDate'];
+	------------------------------------------------- Get title data
+	local Title = A['Title'];
+	local ScriptTitle = A['ScriptTitle'];
+	local BookTitle = A['BookTitle'];
+	local Conference = A['Conference'];
+	local TransTitle = A['TransTitle'];
+	local TitleNote = A['TitleNote'];
+	local TitleLink = A['TitleLink'];
+	local Chapter = A['Chapter'];
+	local ChapterLink = A['ChapterLink'];										-- deprecated
+	local TransChapter = A['TransChapter'];
+	local TitleType = A['TitleType'];
+	local Degree = A['Degree'];
+	local Docket = A['Docket'];
+	local ArchiveURL = A['ArchiveURL'];
+	local URL = A['URL']
+	local URLorigin = A:ORIGIN('URL');											-- get name of parameter that holds URL
+	local ChapterURL = A['ChapterURL'];
+	local ChapterURLorigin = A:ORIGIN('ChapterURL');							-- get name of parameter that holds ChapterURL
+	local ConferenceURL = A['ConferenceURL'];
+	local ConferenceURLorigin = A:ORIGIN('ConferenceURL');						-- get name of parameter that holds ConferenceURL
+	local Periodical = A['Periodical'];
-    local ID_list = extractids( args );
+	local Series = A['Series'];
+	local Volume = A['Volume'];
-    local Quote = selectone( args, {'quote', 'quotation'}, 'redundant_parameters' );
+	local Issue = A['Issue'];
-    local PostScript = args.postscript or "."
+	local Position = '';
-    local LaySummary = args.laysummary
+	local Page = A['Page'];
-    local LaySource = args.laysource
+	local Pages = hyphentodash( A['Pages'] );
-    local Transcript = args.transcript
+	local At = A['At'];
-    local TranscriptURL = selectone( args, {'transcript-url', 'transcripturl'}, 'redundant_parameters' );
-    local sepc = args.separator or "."
-    local LastAuthorAmp = args.lastauthoramp
-    local no_tracking_cats = selectone( args, {"template doc demo", 'nocat',
-        'notracking', "no-tracking"}, 'redundant_parameters' ) or "";
-    if ( config.CitationClass == "journal" ) then
+	local Edition = A['Edition'];
-        if (URL == nil or URL == "") then
+	local PublicationPlace = A['PublicationPlace']
-            if (ID_list['PMC'] ~= nil) then
+	local Place = A['Place'];
-                local Embargo = args.embargo or args.Embargo;
-                if Embargo ~= nil then
+	local PublisherName = A['PublisherName'];
-                    local lang = mw.getContentLanguage();
+	local RegistrationRequired = A['RegistrationRequired'];
-                    local good1, result1, good2, result2;
+	local SubscriptionRequired = A['SubscriptionRequired'];
-                    good1, result1 = pcall( lang.formatDate, lang, 'U', Embargo );
+	local Via = A['Via'];
-                    good2, result2 = pcall( lang.formatDate, lang, 'U' );
+	local AccessDate = A['AccessDate'];
+	local ArchiveDate = A['ArchiveDate'];
+	local Agency = A['Agency'];
+	local DeadURL = A['DeadURL']
+	local Language = A['Language'];
+	local Format = A['Format'];
+	local ChapterFormat = A['ChapterFormat'];
+	local DoiBroken = A['DoiBroken'];
+	local ID = A['ID'];
+	local ASINTLD = A['ASINTLD'];
+	local IgnoreISBN = A['IgnoreISBN'];
+	local Embargo = A['Embargo'];
-                    if good1 and good2 and tonumber( result1 ) < tonumber( result2 ) then
+	local ID_list = extractids( args );
-                        URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
-                    end
-                else
-                    URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
-                end
-            end
-        end
-    end
-    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
+	local Quote = A['Quote'];
-    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
-    if ( BookTitle ) then
-        Chapter = Title
-        ChapterLink = TitleLink
-        TransChapter = TransTitle
-        Title = BookTitle
-        TitleLink = nil
-        TransTitle = nil
-    end
-    -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
-    if config.CitationClass == "episode" then
-        local AirDate = args.airdate
-        local SeriesLink = args.serieslink
-        local Season = args.season
-        local SeriesNumber = args.seriesnumber or args.seriesno
-        local Network = args.network
-        local Station = args.station
-        local s = {}
-        if Issue ~= nil then table.insert(s, cfg.message_list["episode"] .. " " .. Issue) Issue = nil end
-        if Season ~= nil then table.insert(s, cfg.message_list["season"] .. " " .. Season) end
-        if SeriesNumber ~= nil then table.insert(s, cfg.message_list["series"] .. " " .. SeriesNumber) end
-        local n = {}
-        if Network ~= nil then table.insert(n, Network) end
-        if Station ~= nil then table.insert(n, Station) end
-        Date = Date or AirDate
-        Chapter = Title
-        ChapterLink = TitleLink
-        TransChapter = TransTitle
-        Title = Series
-        TitleLink = SeriesLink
-        TransTitle = nil
-        local Sep = args["series-separator"] or args["separator"] or ". "
-        Series = table.concat(s, Sep)
-        ID = table.concat(n, Sep)
-    end
-    -- These data form a COinS tag (see <http://ocoins.info/>) which allows
-    -- automated tools to parse the citation information.
-    local OCinSdata = {} -- COinS metadata excluding id, bibcode, doi, etc.
-    local ctx_ver = "Z39.88-2004"
-    OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
-    if ( nil ~= Periodical ) then
-        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"
-        OCinSdata["rft.genre"] = "article"
-        OCinSdata["rft.jtitle"] = Periodical
-        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
-    end
-    if ( nil ~= Chapter and "" ~= Chapter) then
-        OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
-        OCinSdata["rft.genre"] = "bookitem"
-        OCinSdata["rft.btitle"] = Chapter
-        if ( nil ~= Title ) then OCinSdata["rft.atitle"] = Title end
-    else
-        OCinSdata["rft.genre"] = "book"
-        if ( nil ~= Title ) then OCinSdata["rft.btitle"] = Title end
-    end
-    OCinSdata["rft.place"] = PublicationPlace
-    OCinSdata["rft.date"] = Date or Year or PublicationDate
-    OCinSdata["rft.series"] = Series
-    OCinSdata["rft.volume"] = Volume
-    OCinSdata["rft.issue"] = Issue
-    OCinSdata["rft.pages"] = Page or Pages or At
-    OCinSdata["rft.edition"] = Edition
-    OCinSdata["rft.pub"] = PublisherName
-    for k, v in pairs( ID_list ) do
-        if k == 'ISBN' then
-            v = cleanisbn( v );
-        end
-        if string.sub( cfg.id_handlers[k].COinS or "info", 1, 4 ) ~= 'info' then
-            OCinSdata[ cfg.id_handlers[k].COinS ] = v;
-        end
-    end
-    OCinSdata.rft_id = URL or ChapterURL
-    local last, first;
+	local LayURL = A['LayURL'];
-    local OCinSauthors = {};
+	local LaySource = A['LaySource'];
-    for k, v in ipairs( a ) do
+	local Transcript = A['Transcript'];
-        last = v.last;
+	local TranscriptURL = A['TranscriptURL']
-        first = v.first;
+	local TranscriptURLorigin = A:ORIGIN('TranscriptURL');						-- get name of parameter that holds TranscriptURL
-        if k == 1 then
-            if last ~= nil then
-                OCinSdata["rft.aulast"] = last;
-            end
-            if first ~= nil then
-                OCinSdata["rft.aufirst"] = first;
-            end
-        end
-        if last ~= nil and first ~= nil then
-            table.insert( OCinSauthors, last .. (args.NameSep or ", ") .. first );
-    	elseif last ~= nil then
-            table.insert( OCinSauthors, last );
-        end
-    end
-    local OCinSids = {} -- COinS data only for id, bibcode, doi, pmid, etc.
+	local LastAuthorAmp = A['LastAuthorAmp'];
-    for k, v in pairs( ID_list ) do
+	local no_tracking_cats = A['NoTracking'];
-        if string.sub( cfg.id_handlers[k].COinS or "", 1, 4 ) == 'info' then
-            OCinSids[ cfg.id_handlers[k].COinS ] = v;
-        end
-    end
-    local OCinStitle = "ctx_ver=" .. ctx_ver  -- such as "Z39.88-2004"
+--these are used by cite interview
-    for name,value in pairs(OCinSdata) do
+	local Callsign = A['Callsign'];
-        OCinStitle = OCinStitle .. "&" .. name .. "=" .. mw.uri.encode( removewikilink(value) );
+	local City = A['City'];
-    end
+	local Program = A['Program'];
-    for _, value in ipairs(OCinSauthors) do
-        OCinStitle = OCinStitle .. "&rft.au=" .. mw.uri.encode( removewikilink(value) );
-    end
-    for name,value in pairs(OCinSids) do
-        OCinStitle = OCinStitle .. "&rft_id=" .. mw.uri.encode(name .. "/" .. removewikilink(value) );
-    end
-    local this_page = mw.title.getCurrentTitle();
-    OCinStitle = OCinStitle .. "&rfr_id=info:sid/" .. mw.site.server:match( "[^/]*$" ) .. ":"
-       .. this_page.prefixedText  -- end COinS data by page's non-encoded pagename
-    if (Periodical ~= nil and Periodical ~= "") and
+--local variables that are not cs1 parameters
-        (Chapter == nil or Chapter == '') and
+	local use_lowercase;								-- controls capitalization of certain static text
-        (Title ~= nil and Title ~= "") then
+	local this_page = mw.title.getCurrentTitle();		-- also used for COinS and for language
-            Chapter = Title
+	local anchor_year;									-- used in the CITEREF identifier
-            ChapterLink = TitleLink
+	local COinS_date;									-- used in the COinS metadata
-            TransChapter = TransTitle
-            Title = nil
-            TitleLink = nil
-            TransTitle = nil
-    end
-    -- Now perform various field substitutions.
+-- set default parameter values defined by |mode= parameter.  If |mode= is empty or omitted, use CitationClass to set these values
-    -- We also add leading spaces and surrounding markup and punctuation to the
+	local sepc;											-- separator between citation elements for CS1 a period, for CS2, a comma
-    -- various parts of the citation, but only when they are non-nil.
+	local PostScript;
-    if ( Authors == nil ) then
+	local Ref;
-        local Maximum = tonumber( (selectone( args, {"display-authors", "displayauthors"}, 'redundant_parameters' )) );
+	sepc, PostScript, Ref = set_style (A['Mode']:lower(), A['PostScript'], A['Ref'], config.CitationClass);
+	use_lowercase = ( sepc == ',' );					-- used to control capitalization for certain static text
-        -- Preserve old-style implicit et al.
-        if Maximum == nil and #a == 9 then
-            Maximum = 8;
-            table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
-        elseif Maximum == nil then
-            Maximum = #a + 1;
-        end
-        local control = {
-            sep = (args["author-separator"] or ";") .. " ",
-            namesep = (args["author-name-separator"] or args["name-separator"] or ",") .. " ",
-            format = selectone( args, {"author-format", "authorformat" }, 'redundant_parameters' ),
-            maximum = Maximum,
-            lastauthoramp = LastAuthorAmp
-        }
-        -- If the coauthor field is also used, prevent ampersand and et al. formatting.
-        if Coauthors ~= nil and Coauthors ~= "" then
-            control.lastauthoramp = nil;
-            control.maximum = #a + 1;
-        end
-        Authors = listpeople(control, a)
-    end
-    local EditorCount
-    if ( Editors == nil ) then
-        local Maximum = tonumber( (selectone( args, {"display-editors", "displayeditors"}, 'redundant_parameters' )) );
-        -- Preserve old-style implicit et al.
+--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 Maximum == nil and #e == 4 then
+	if not is_set(no_tracking_cats) then				-- ignore if we are already not going to categorize this page
-            Maximum = 3;
+		if inArray (this_page.nsText, cfg.uncategorized_namespaces) then
-            table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
+			no_tracking_cats = "true";					-- set no_tracking_cats
-        elseif Maximum == nil then
+		end
-            Maximum = #e + 1;
+	end
-        end
-        local control = {
+-- check for extra |page=, |pages= or |at= parameters.
-            sep = (args["editor-separator"] or ";") .. " ",
+	if is_set(Page) then
-            namesep = (args["editor-name-separator"] or args["name-separator"] or ",") .. " ",
+		if is_set(Pages) or is_set(At) then
-            format = selectone( args, {"editor-format", "editorformat" }, 'redundant_parameters' ),
+			Page = Page .. " " .. seterror('extra_pages');	-- add error message
-            maximum = Maximum,
+			Pages = '';										-- unset the others
-            lastauthoramp = LastAuthorAmp
+			At = '';
-            }
+		end
+	elseif is_set(Pages) then
+		if is_set(At) then
+			Pages = Pages .. " " .. seterror('extra_pages');	-- add error messages
+			At = '';											-- unset
+		end
+	end
-        Editors, EditorCount = listpeople(control, e)
+-- both |publication-place= and |place= (|location=) allowed if different
-    else
+	if not is_set(PublicationPlace) and is_set(Place) then
-        EditorCount = 1;
+		PublicationPlace = Place;							-- promote |place= (|location=) to |publication-place
-    end
+	end
-    if ( Date == nil or Date == "") then
---   there's something hinky with how this adds dashes to perfectly-good free-standing years
+	if PublicationPlace == Place then Place = ''; end		-- don't need both if they are the same
---[[        Date = Year
-        if ( Date ~= nil ) then
+--[[
-            local Month = args.month
+Parameter remapping for cite encyclopedia:
-            if ( Month == nil ) then
+When the citation has these parameters:
-                local Began = args.began
+	|encyclopedia and |title then map |title to |article and |encyclopedia to |title
-                local Ended = args.ended
+	|encyclopedia and |article then map |encyclopedia to |title
-                if Began ~= nil and Ended ~= nil then
+	|encyclopedia then map |encyclopedia to |title
-                    Month = Began .. "&ndash;" .. Ended
-                else
-                    Month = "&ndash;"
-                end
-            end
-            Date = Month .. " " .. Date
-            local Day = args.day
-            if ( Day ~= nil ) then Date = Day .. " " .. Date end
-        end
-]] -- so let's use the original version for now
-        Date = Year
-        if ( Date ~= nil and Date ~="") then
-            local Month = args.month
-            if ( Month ~= nil and Month ~= "") then
-                Date = Month .. " " .. Date
-                local Day = args.day
-                if ( Day ~= nil ) then Date = Day .. " " .. Date end
-                else Month = ""
-            end
-            else Date = ""
-        end
-    end
-    if ( PublicationDate == Date or PublicationDate == Year ) then PublicationDate = nil end
-    if( (Date == nil or Date == "") and PublicationDate ~= nil ) then
-        Date = PublicationDate;
-        PublicationDate = nil;
-    end
-    -- Captures the value for Date prior to adding parens or other textual transformations
+	|trans_title maps to |trans_chapter when |title is re-mapped
-    local DateIn = Date
+	|url maps to |chapterurl when |title is remapped
-    if ( URL == nil or URL == '' ) and
-            ( ChapterURL == nil or ChapterURL == '' ) and
-            ( ArchiveURL == nil or ArchiveURL == '' ) and
-            ( ConferenceURL == nil or ConferenceURL == '' ) and
-            ( TranscriptURL == nil or TranscriptURL == '' ) then
-        -- Test if cite web is called without giving a URL
+All other combinations of |encyclopedia, |title, and |article are not modified
-        if ( config.CitationClass == "web" ) then
+TODO: script-title to script-chapter if and when we support script-chapter
-            table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
+]]
-        end
-        -- Test if accessdate is given without giving a URL
+local Encyclopedia = A['Encyclopedia'];
-        if ( AccessDate ~= nil and AccessDate ~= '' ) then
-            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
-            AccessDate = nil;
-        end
-        -- Test if format is given without giving a URL
-        if ( Format ~= nil and Format ~= '' ) then
-            Format = Format .. seterror( 'format_missing_url' );
-        end
-    end
-    -- Test if citation has no title
+	if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then	-- test code for citation
-    if ( Chapter == nil or Chapter == "" ) and
+		if is_set(Periodical) then					-- Periodical is set when |encyclopedia is set
-            ( Title == nil or Title == "" ) and
+			if is_set(Title) then
-            ( Periodical == nil or Periodical == "" ) and
+				if not is_set(Chapter) then
-            ( Conference == nil or Conference == "" ) and
+					Chapter = Title;				-- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
-            ( TransTitle == nil or TransTitle == "" ) and
+					TransChapter = TransTitle;
-            ( TransChapter == nil or TransChapter == "" ) then
+					ChapterURL = URL;
-        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
+					Title = Periodical;
-    end
+					ChapterFormat = Format;
+					Periodical = '';				-- redundant so unset
+					TransTitle = '';				-- redundant so unset
+					URL = '';						-- redundant so unset
+					Format = '';					-- redundant so unset
+				end
+			else									-- |title not set
+				Title = Periodical;					-- |encyclopedia set and |article set or not set so map |encyclopedia to |title
+				Periodical = '';					-- redundant so unset
+			end
+		end
+	end
-    if ( Format ~= nil and Format ~="" ) then
+-- Special case for cite techreport.
-        Format = " (" .. Format .. ")" else Format = "" end
+	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'
-    local OriginalURL = URL
+			if not is_set(ID) then					-- can we use ID for the "number"?
-    DeadURL = DeadURL:lower();
+				ID = Issue;							-- yes, use it
-    if ( ArchiveURL and "" < ArchiveURL ) then
+				Issue = "";							-- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
-        if ( DeadURL ~= "no" ) then
+			else									-- can't use ID so emit error message
-            URL = ArchiveURL
+				ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
-        end
+			end
-    end
+		end
+	end
-    if ( TransTitle and "" < TransTitle ) then TransTitle = " [" .. TransTitle .. "&#93;" else TransTitle = "" end
+-- special case for cite interview
-    if ( TransChapter and "" < TransChapter ) then TransChapter = " [" .. TransChapter .. "&#93;" else TransChapter = "" end
+	if (config.CitationClass == "interview") then
+		if is_set(Program) then
-    -- Format chapter / article title
+			ID = ' ' .. Program;
-    if ( Chapter ~= nil and Chapter ~= "" ) then
+		end
-        if ( ChapterLink and "" < ChapterLink ) then Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]" end
+		if is_set(Callsign) then
-        if ( Periodical and "" < Periodical ) and (Title ~= nil and Title ~= "" )
+			if is_set(ID) then
-        then
+				ID = ID .. sepc .. ' ' .. Callsign;
-            Chapter = "''" .. safeforitalics(Chapter) .. "''"
+			else
-        else
+				ID = ' ' .. Callsign;
-            Chapter = "\"" .. Chapter .. "\""
+			end
-        end
+		end
-    else
+		if is_set(City) then
-        Chapter = "";
+			if is_set(ID) then
-    end
+				ID = ID .. sepc .. ' ' .. City;
+			else
-    local TransError = ""
+				ID = ' ' .. City;
-    if TransChapter ~= "" and Chapter == "" then
+			end
-        TransError = " " .. seterror( 'trans_missing_chapter' );
+		end
-    end
-    Chapter = Chapter .. TransChapter
-    if Chapter ~= "" then
-        if ( ChapterLink == nil ) then
-            if ( ChapterURL and "" < ChapterURL ) then
-                Chapter = externallink( ChapterURL, Chapter ) .. TransError;
-                if URL == nil or URL == "" then
-                    Chapter = Chapter .. Format;
-                    Format = "";
-                end
-            elseif ( URL and "" < URL ) then
-                Chapter = externallink( URL, Chapter ) .. TransError .. Format;
-                URL = nil
-                Format = ""
-            else
-                Chapter = Chapter .. TransError;
-            end
-        elseif ChapterURL ~= nil and ChapterURL ~= "" then
-            Chapter = Chapter .. " " .. externallink( ChapterURL ) ..
-                TransError;
-        else
-            Chapter = Chapter .. TransError;
-        end
-        Chapter = Chapter .. sepc .. " " -- with end-space
-    elseif ChapterURL ~= nil and ChapterURL ~= "" then
-        Chapter = " " .. externallink( ChapterURL ) .. sepc .. " ";
-    end
-    -- Format main title.
-    if ( Title and "" < Title ) then
-        if ( TitleLink and "" < TitleLink ) then
-            Title = "[[" .. TitleLink .. "|" .. Title .. "]]" end
-        if ( Periodical and "" < Periodical ) then
-            Title = "\"" .. Title .. "\""
-        elseif ( config.CitationClass == "web"
-                or config.CitationClass == "news"
-                or config.CitationClass == "pressrelease" ) and
-                Chapter == "" then
-            Title = "\"" .. Title .. "\""
-        else
-            Title = "''" .. safeforitalics(Title) .. "''"
-        end
-    else
-        Title = "";
-    end
-    local TransError = "";
-    if TransTitle ~= "" and Title == "" then
-        TransError = " " .. seterror( 'trans_missing_title' );
-    end
-    Title = Title .. TransTitle
-    if Title ~= "" then
-        if ( TitleLink == nil and URL and "" < URL ) then
-            Title = externallink( URL, Title ) .. TransError .. Format
-            URL = nil
-            Format = ''
-        else
-            Title = Title .. TransError;
-        end
-    end
-    if ( Place ~= nil and Place ~= "" ) then
+		if is_set(Others) then
-        if sepc == '.' then
+			if is_set(TitleType) then
-            Place = " " .. cfg.message_list['written'] .. " " .. Place .. sepc .. " ";
+				Others = ' ' .. TitleType .. ' with ' .. Others;
-        else
+				TitleType = '';
-            Place = " " .. cfg.message_list['written']:lower() .. " " .. Place .. sepc .. " ";
+			else
-        end
+				Others = ' ' .. 'Interview with ' .. Others;
-    else
+			end
-        Place = "";
+		else
-    end
+			Others = '(Interview)';
+		end
-    if ( Conference ~= nil and Conference ~="" ) then
+	end
-        if ( ConferenceURL ~= nil ) then
-            Conference = externallink( ConferenceURL, Conference );
-        end
-        Conference = " " .. Conference
-    elseif ConferenceURL ~= nil and ConferenceURL ~= "" then
-        Conference = " " .. externallink( ConferenceURL );
-    else
-        Conference = ""
-    end
-    if ( nil ~= Position or nil ~= Page or nil ~= Pages ) then At = nil end
-    if ( nil == Position and "" ~= Position ) then
-        local Minutes = args.minutes
-        if ( nil ~= Minutes ) then
-            Position = " " .. Minutes .. " " .. cfg.message_list['minutes'];
-        else
-            local Time = args.time
-            if ( nil ~= Time ) then
-                local TimeCaption = args.timecaption
-                if TimeCaption == nil then
-                    TimeCaption = cfg.message_list['event'];
-                    if sepc ~= '.' then
-                        TimeCaption = TimeCaption:lower();
-                    end
-                end
-                Position = " " .. TimeCaption .. " " .. Time
-            else
-                Position = ""
-            end
-        end
-    else
-        Position = " " .. Position
-    end
-    if ( nil == Page or "" == Page ) then
-        Page = ""
-        if ( nil == Pages or "" == Pages) then
-            Pages = ""
-        elseif ( Periodical ~= nil and Periodical ~= "" and
-                 config.CitationClass ~= "encyclopaedia" and
-                 config.CitationClass ~= "web" and
-                 config.CitationClass ~= "book" and
-                 config.CitationClass ~= "news") then
-            Pages = ": " .. Pages
-        else
-            if ( tonumber(Pages) ~= nil ) then
-              Pages = sepc .." " .. PPrefix .. Pages
-            else Pages = sepc .." " .. PPPrefix .. Pages
-            end
-        end
-    else
-        Pages = ""
-        if ( Periodical ~= nil and Periodical ~= "" and
-             config.CitationClass ~= "encyclopaedia" and
-             config.CitationClass ~= "web" and
-             config.CitationClass ~= "book" and
-             config.CitationClass ~= "news") then
-            Page = ": " .. Page
-        else
-            Page = sepc .." " .. PPrefix .. Page
-        end
-    end
-    if ( At ~= nil and At ~="") then At = sepc .. " " .. At
-    else At = "" end
-    if ( Coauthors == nil ) then Coauthors = "" end
-    if ( Others ~= nil and Others ~="" ) then
-        Others = sepc .. " " .. Others else Others = "" end
-    if ( TitleType ~= nil and TitleType ~="" ) then
-        TitleType = " (" .. TitleType .. ")" else TitleType = "" end
-    if ( TitleNote ~= nil and TitleNote ~="" ) then
-        TitleNote = sepc .. " " .. TitleNote else TitleNote = "" end
-    if ( Language ~= nil and Language ~="" ) then
-        Language = " (" .. cfg.message_list['in'] .. " " .. Language .. ")" else Language = "" end
-    if ( Edition ~= nil and Edition ~="" ) then
-        Edition = " (" .. Edition .. " " .. cfg.message_list['edition'] .. ")" else Edition = "" end
-    if ( Volume ~= nil and Volume ~="" )
-    then
-        if ( mw.ustring.len(Volume) > 4 )
-          then Volume = sepc .." " .. Volume
-          else Volume = " <b>" .. hyphentodash(Volume) .. "</b>"
-        end
-    else Volume = "" end
-    if ( Issue ~= nil and Issue ~="" ) then
-        Issue = " (" .. Issue .. ")" else Issue = "" end
-    if ( Series ~= nil and Series ~="" ) then
-        Series = sepc .. " " .. Series else Series = "" end
-    if ( OrigYear ~= nil and OrigYear ~="" ) then
-        OrigYear = " [" .. OrigYear .. "]" else OrigYear = "" end
-    if ( Agency ~= nil and Agency ~="" ) then
-        Agency = sepc .. " " .. Agency else Agency = "" end
-    ------------------------------------ totally unrelated data
-    if ( Date ~= nil ) then Date = Date else Date = "" end
-    if ( Via ~= nil and Via ~="" ) then
-        Via = " &mdash; " .. cfg.message_list['via'] .. " " .. Via else Via = "" end
-    if ( AccessDate ~= nil and AccessDate ~="" )
-    then local retrv_text = " " .. cfg.message_list['retrieved'] .. " "
-         if (sepc ~= ".") then retrv_text = retrv_text:lower() end
-         AccessDate = '<span class="reference-accessdate">' .. sepc
-             .. retrv_text .. AccessDate .. '</span>'
-    else AccessDate = "" end
-    if ( SubscriptionRequired ~= nil and
-         SubscriptionRequired ~= "" ) then
-        SubscriptionRequired = sepc .. " " .. cfg.message_list['subscription'];
-    else
-        SubscriptionRequired = ""
-    end
-    if ( ID ~= nil and ID ~="") then ID = sepc .." ".. ID else ID="" end
-    ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN} );
+-- special case for cite mailing list
+	if (config.CitationClass == "mailinglist") then
+		Periodical = A ['MailingList'];
+	end
-    if ( URL ~= nil and URL ~="") then
+--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
-        URL = " " .. externallink( URL, URL );
+	if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
-        local error_text = seterror( 'bare_url_missing_title' );
+		if not is_embargoed(Embargo) then
-        if config.CitationClass == "web" then
+			URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC'];	-- set url to be the same as the PMC external link if not embargoed
-            URL = URL .. " " .. seterror( 'cite_web_title' );
+			URLorigin = cfg.id_handlers['PMC'].parameters[1];		-- set URLorigin to parameter name for use in error message if citation is missing a |title=
-        else
+		end
-            URL = URL .. error_text;
+	end
-        end
-    else
-        URL = ""
-    end
-    if ( Quote and Quote ~="" ) then
+-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
-        if Quote:sub(1,1) == '"' and Quote:sub(-1,-1) == '"' then
+	if 'conference' == config.CitationClass then
-            Quote = Quote:sub(2,-2);
+		if is_set(BookTitle) then
-        end
+			Chapter = Title;
+--			ChapterLink = TitleLink;											-- |chapterlink= is deprecated
-        Quote = sepc .." \"" .. Quote .. "\""
+			ChapterURL = URL;
-        PostScript = ""
+			ChapterURLorigin = URLorigin;
-    else
+			URLorigin = '';
-        if ( PostScript == nil) then PostScript = "" end
+			ChapterFormat = Format;
-        Quote = ""
+			TransChapter = TransTitle;
-    end
+			Title = BookTitle;
+			Format = '';
-    local Archived
+--			TitleLink = '';
-    if ( nil ~= ArchiveURL and "" ~= ArchiveURL ) then
+			TransTitle = '';
-        if ( ArchiveDate ~= nil and ArchiveDate ~="" ) then
+			URL = '';
-            ArchiveDate = " " .. ArchiveDate
+		end
-        else
+	else
-            ArchiveDate = " " .. seterror('archive_missing_date') .. " "
+		Conference = '';														-- not cite conference so make sure this is empty string
-        end
+	end
-        local arch_text = cfg.message_list['archived'];
-        if (sepc ~= ".") then arch_text = arch_text:lower() end
-        if ( "no" == DeadURL ) then
-            Archived = sepc .. " " .. externallink( ArchiveURL, arch_text ) .. " " ..
-                cfg.message_list['from'] .. " " .. cfg.message_list['original'] .. " " ..
-                cfg.message_list['on'] .. ArchiveDate
-            if OriginalURL == nil or OriginalUrl == '' then
-                Archived = Archived .. " " .. seterror('archive_missing_url_not_dead');
-            end
-        else
-            if OriginalURL ~= nil and OriginalURL ~= '' then
-                Archived = sepc .. " " .. arch_text .. " " .. cfg.message_list['from'] ..
-                    " " .. externallink( OriginalURL, cfg.message_list['original'] ) .. " "
-                    .. cfg.message_list['on'] .. ArchiveDate
-            else
-                if config.CitationClass ~= 'web' then
-                    Archived = sepc .. " " .. arch_text .. " " .. cfg.message_list['from'] .. " " ..
-                    cfg.message_list['original'] .. seterror('archive_missing_url') .. " " .. cfg.message_list['on'] .. ArchiveDate
-                else
-                    Archived = sepc .. " " .. arch_text .. " " .. cfg.message_list['from'] .. " " ..
-                    cfg.message_list['original'] .. seterror('archive_missing_url_web') .. " " .. cfg.message_list['on'] .. ArchiveDate
-                end
-            end
-        end
-    else
-        Archived = ""
-    end
-    local Lay
-    if ( nil ~= LaySummary and "" ~= LaySummary ) then
-        if ( LayDate ~= nil ) then LayDate = " (" .. LayDate .. ")" else LayDate = "" end
-        if ( LaySource ~= nil ) then
-            LaySource = " &ndash; ''" .. safeforitalics(LaySource) .. "''"
-        else
-            LaySource = ""
-        end
-        if sepc == '.' then
-            Lay = sepc .. " [" .. LaySummary .. " " .. cfg.message_list['lay summary'] .. "]" .. LaySource .. LayDate
-        else
-            Lay = sepc .. " [" .. LaySummary .. " " .. cfg.message_list['lay summary']:lower() .. "]" .. LaySource .. LayDate
-        end
-    else
-        Lay = ""
-    end
-    if ( nil ~= Transcript and "" ~= Transcript ) then
-        if ( TranscriptURL ~= nil ) then Transcript = externallink( TranscriptURL, Transcript ) end
-    elseif TranscriptURL ~= nil and TranscriptURL ~= "" then
-        Transcript = externallink( TranscriptURL )
-    else
-        Transcript = ""
-    end
-    local Publisher = ""
-    if ( Periodical and Periodical ~= "" and
-         config.CitationClass ~= "encyclopaedia" and
-         config.CitationClass ~= "web" and
-         config.CitationClass ~= "pressrelease" ) then
-        if ( PublisherName ~= nil and PublisherName ~="" ) then
-            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
-                Publisher = PublicationPlace .. ": " .. PublisherName;
-            else
-                Publisher = PublisherName;
-            end
-        elseif (PublicationPlace ~= nil and PublicationPlace ~= '') then
-            Publisher= PublicationPlace;
-        else
-            Publisher = "";
-        end
-        if ( PublicationDate and PublicationDate ~="" ) then
-            if Publisher ~= '' then
-                Publisher = Publisher .. ", " .. cfg.message_list['published'] .. " " .. PublicationDate;
-            else
-                Publisher = PublicationDate;
-            end
-        end
-        if Publisher ~= "" then
-            Publisher = " (" .. Publisher .. ")";
-        end
-    else
-        if ( PublicationDate and PublicationDate ~="" ) then
-            PublicationDate = " (" .. cfg.message_list['published'] .. " " .. PublicationDate .. ")"
-        else
-            PublicationDate = ""
-        end
-        if ( PublisherName ~= nil and PublisherName ~="" ) then
-            if (PublicationPlace ~= nil and PublicationPlace ~= '') then
-                Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
-            else
-                Publisher = sepc .. " " .. PublisherName .. PublicationDate;
-            end
-        elseif (PublicationPlace ~= nil and 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 ( Periodical ~= nil and Periodical ~="" ) then
-        if ( Title and Title ~= "" ) or ( TitleNote and TitleNote ~= "" ) then
-            Periodical = sepc .. " ''" .. safeforitalics(Periodical) .. "''"
-        else
-            Periodical = "''" .. safeforitalics(Periodical) .. "''"
-        end
-    else Periodical = "" end
-    -- Piece all bits together at last.  Here, all should be non-nil.
+-- Account for the oddity that is {{cite episode}}, before generation of COinS data.
-    -- We build things this way because it is more efficient in LUA
+--[[	-- {{cite episode}} is not currently supported by this module
-    -- not to keep reassigning to the same string variable over and over.
+	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]]
-    local tcommon
+-- 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 ( ( (config.CitationClass == "journal") or (config.CitationClass == "citation") )  and
+	if is_set(Date) then
-         Periodical ~= "" ) then
+		if is_set (Year) then
-        if (Others ~= "") then Others = Others .. sepc .. " " end
+			table.insert( z.maintenance_cats, "CS1 maint: Date and year");		-- add to maint category
-        tcommon = safejoin( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series,
+		end
-            Language, Edition, Publisher, Agency, Volume, Issue, Position}, sepc );
+	else
-    else
+		Date = Year;						-- promote Year to Date
-        tcommon = safejoin( {Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language,
+		Year = nil;							-- make nil so Year as empty string isn't used for CITEREF
-            Volume, Issue, Others, Edition, Publisher, Agency, Position}, sepc );
+		if is_set(Date) then
-    end
+			local Month = A['Month'];
+			if is_set(Month) then
-    if #ID_list > 0 then
+				Date = Month .. " " .. Date;
-        ID_list = safejoin( { sepc .. " ",  table.concat( ID_list, sepc .. " " ), ID }, sepc );
+			end
-    else
+		elseif is_set(PublicationDate) then	-- use PublicationDate when |date= and |year= are not set
-        ID_list = ID;
+			Date = PublicationDate;			-- promote PublicationDate to Date
-    end
+			PublicationDate = '';			-- unset, no longer needed
-    local idcommon = safejoin( { ID_list, URL, Archived, AccessDate, Via, SubscriptionRequired, Lay, Quote }, sepc );
+		end
+	end
-    local text
+	if PublicationDate == Date then PublicationDate = ''; end	-- if PublicationDate is same as Date, don't display in rendered citation
-    local pgtext = Page .. Pages .. At
-    if ( "" ~= Authors ) then
-        if (Coauthors ~= "")
-          then Authors = Authors .. "; " .. Coauthors
-        end
-        if ( "" ~= Date )
-          then Date = " ("..Date..")" .. OrigYear .. sepc .. " "
-          else
-            if ( string.sub(Authors,-1,-1) == sepc) --check end character
-              then Authors = Authors .. " "
-              else Authors = Authors .. sepc .. " "
-            end
-        end
-        if ( "" ~= Editors) then
-            local in_text = " in "
-            if (sepc == '.') then in_text = " In " end
-            if (string.sub(Editors,-1,-1) == sepc)
-                then Editors = in_text .. Editors .. " "
-                else Editors = in_text .. Editors .. sepc .. " "
-            end
-        end
-        text = safejoin( {Authors, Date, Chapter, Place, Editors, tcommon }, sepc );
-        text = safejoin( {text, pgtext, idcommon}, sepc );
-    elseif ( "" ~= Editors) then
-        if ( "" ~= Date ) then
-            if EditorCount <= 1 then
-                Editors = Editors .. ", " .. cfg.message_list['editor'];
-            else
-                Editors = Editors .. ", " .. cfg.message_list['editors'];
-            end
-            Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "
-        else
-            if EditorCount <= 1 then
-                Editors = Editors .. " (" .. cfg.message_list['editor'] .. ")" .. sepc .. " "
-            else
-                Editors = Editors .. " (" .. cfg.message_list['editors'] .. ")" .. sepc .. " "
-            end
-        end
-        text = safejoin( {Editors, Date, Chapter, Place, tcommon}, sepc );
-        text = safejoin( {text, pgtext, idcommon}, sepc );
-    else
-        if ( "" ~= Date ) then
-            if ( string.sub(tcommon,-1,-1) ~= sepc )
-              then Date = sepc .." " .. Date .. OrigYear
-              else Date = " " .. Date .. OrigYear
-            end
-        end -- endif ""~=Date
-        if ( config.CitationClass=="journal" and 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 PostScript ~= '' and PostScript ~= nil and PostScript ~= sepc then
-        text = safejoin( {text, sepc}, sepc );  --Deals with italics, spaces, etc.
-        text = text:sub(1,-2); --Remove final seperator
-    end
-    text = safejoin( {text, PostScript}, sepc );
-    -- Now enclose the whole thing in a <span/> element
-    if ( Year == nil ) then
-        if ( DateIn ~= nil and DateIn ~= "" ) then
-            Year = selectyear( DateIn )
-        elseif( PublicationDate ~= nil and PublicationDate ~= "" ) then
-            Year = selectyear( PublicationDate )
-        else
-            Year = ""
-        end
-    end
-    local classname = "citation"
-    if ( config.CitationClass ~= "citation" )
-       then classname = "citation " .. (config.CitationClass or "") end
-    local options = { class=classname }
-    if ( Ref ~= nil ) then
-        local id = Ref
-        if ( "harv" == Ref ) then
-            local names = {} --table of last names & year
-            if ( "" ~= Authors ) then
-                for i,v in ipairs(a) do
-                    names[i] = v.last
-                    if i == 4 then break end
-                end
-            elseif ( "" ~= Editors ) then
-                for i,v in ipairs(e) do
-                    names[i] = v.last
-                    if i == 4 then break end
-                end
-            end
-            names[ #names + 1 ] = Year;
-            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 options.id ~= nil then
-        text = '<span id="' .. wikiescape(options.id) ..'" class="' .. wikiescape(options.class) .. '">' .. text .. "</span>";
-    else
-        text = '<span class="' .. wikiescape(options.class) .. '">' .. text .. "</span>";
-    end
-    local empty_span = '<span style="display:none;">&nbsp;</span>';
+--[[
+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
-    -- Note: Using display: none on then COinS span breaks some clients.
+we get the date used in the metadata.
-    local OCinS = '<span title="' .. wikiescape(OCinStitle) .. '" class="Z3988">' .. empty_span .. '</span>';
-    text = text .. OCinS;
+Date validation supporting code is in Module:Citation/CS1/Date_validation
+]]
-    if #z.message_tail ~= 0 then
+	anchor_year, COinS_date, error_message = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
-        for i,v in ipairs( z.message_tail ) do
+		['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
-            if v[1] ~= nil and v[1] ~= "" then
+	if is_set(error_message) then
-                if i == #z.message_tail then
+		table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } );	-- add this error message
-                    text = text .. errorcomment( v[1], v[2] );
+	end
-                else
-                    text = text .. errorcomment( v[1] .. "; ", v[2] );
+-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
-                end
+	-- Test if citation has no title
-            end
+	if	not is_set(Title) and
-        end
+--		not is_set(Periodical) and			-- not a title
-    end
+--		not is_set(Conference) and			-- not a title
+		not is_set(TransTitle) and
-    if no_tracking_cats == '' then
+		not is_set(ScriptTitle) then
-        for _, v in ipairs( z.error_categories ) do
+		table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
-            text = text .. '[[Category:' .. v ..']]';
+	end
-        end
-    end
+	if 'none' == Title and is_set(Periodical) and not (( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia))) then								-- special case
+		Title = '';																-- set title to empty string
-    return text
+		table.insert( z.maintenance_cats, "CS1 maint: Untitled periodical");	-- add to maint category
+	end
+	-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
+	-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
+	-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
+	-- is the article title, and Chapter is a section within the article.  So, we remap
+	local coins_chapter = Chapter;												-- default assuming that remapping not required
+	local coins_title = Title;													-- et tu
+	if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
+		if is_set (Chapter) and is_set (Title) and is_set (Periodical) then		-- if all are used then
+			coins_chapter = Title;												-- remap
+			coins_title = Periodical;
+		end
+	end
+	-- this is the function call to COinS()
+	local OCinSoutput = COinS{
+		['Periodical'] = Periodical,
+		['Chapter'] = strip_apostrophe_markup (coins_chapter),					-- Chapter stripped of bold / italic wikimarkup
+		['Title'] = make_coins_title (coins_title, ScriptTitle),				-- Title and ScriptTitle stripped of bold / italic wikimarkup
+		['PublicationPlace'] = PublicationPlace,
+		['Date'] = first_set(COinS_date, Date),		-- COinS_date has correctly formatted date if Date is valid; any reason to keep Date here?  Should we be including invalid dates in metadata?
+		['Series'] = Series,
+		['Volume'] = Volume,
+		['Issue'] = Issue,
+		['Pages'] = get_coins_pages (first_set(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,
+	};
+--[[Why is this here?  Why are we mapping Title to Chapter when Periodical is set?
+	if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
+		Chapter = Title;
+		ChapterLink = TitleLink;
+		TransChapter = TransTitle;
+		Title = '';
+		TitleLink = '';
+		TransTitle = '';
+	end
+]]
+-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
+	if 'newsgroup' == config.CitationClass then
+		if is_set (PublisherName) then
+			PublisherName = '[[Newsgroup]]:&nbsp;' ..  externallink( 'news:' .. PublisherName, PublisherName );
+		end
+	end
+	-- Now perform various field substitutions.
+	-- We also add leading spaces and surrounding markup and punctuation to the
+	-- various parts of the citation, but only when they are non-nil.
+	if not is_set(Authors) then
+		local Maximum = tonumber( A['DisplayAuthors'] );
+		if is_set (Maximum) then
+			if Maximum >= #a then												-- if display-authors value greater than or equal to number of authors
+				table.insert( z.maintenance_cats, "CS1 maint: display-authors");	-- add maintenance category because display-authors parameter may be removed
+			end
+		else
+			Maximum = #a + 1;													-- number of authors + 1
+		end
+		local control = {
+			format = NameListFormat,											-- empty string or 'vanc'
+			maximum = Maximum,
+			lastauthoramp = LastAuthorAmp,
+			page_name = this_page.text				-- get current page name so that we don't wikilink to it via authorlinkn
+		};
+		-- 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 = {
+			format = NameListFormat,											-- empty string or 'vanc'
+			maximum = Maximum,
+			lastauthoramp = LastAuthorAmp,
+			page_name = this_page.text				-- get current page name so that we don't wikilink to it via editorlinkn
+		};
+		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_msg ('cartography', Cartography, use_lowercase);
+		end
+		Scale = A['Scale'];
+		if is_set( Scale ) then
+			Scale = sepc .. " " .. Scale;
+		end
+	end
+	Format = is_set(Format) and " (" .. Format .. ")" or "";
+	if  not is_set(URL) and
+		not is_set(ArchiveURL) and
+		not is_set(ConferenceURL) and											-- TODO: keep this here? conference as part of cite web or cite podcast?
+		not is_set(TranscriptURL) then
+		-- Test if cite web or cite podcast |url= is missing or empty
+		if inArray(config.CitationClass, {"web","podcast", "mailinglist"}) 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) and not is_set(ChapterURL)then					-- ChapterURL may be set when the others are not set; TODO: move this to a separate test?
+			table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
+			AccessDate = '';
+		end
+		-- Test if format is given without giving a URL
+		if is_set(Format) then
+			Format = Format .. seterror( 'format_missing_url', {'format', 'url'} );
+		end
+	end
+--[[
+	-- Test if citation has no title
+	if	not is_set(Title) and
+--		not is_set(Periodical) and			-- not a title
+--		not is_set(Conference) and			-- not a title
+		not is_set(TransTitle) and
+		not is_set(ScriptTitle) then
+		table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
+	end
+	if 'none' == Title and is_set(Periodical) then								-- special case
+		Title = '';																-- set title to empty string
+		table.insert( z.maintenance_cats, "CS1 maint: Untitled periodical");	-- add to maint category
+	end
+]]
+	local OriginalURL;
+	DeadURL = DeadURL:lower();													-- used later when assembling archived text
+	if is_set( ArchiveURL ) then
+		if is_set (URL) then
+			OriginalURL = URL;													-- save copy of original source URL
+			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
+			end
+		elseif is_set (ChapterURL) then 										-- URL not set so if chapter-url is set apply archive url to it
+			OriginalURL = ChapterURL;											-- save copy of source chapter's url for archive text
+			if 'no' ~= DeadURL then
+				ChapterURL = ArchiveURL											-- swap-in the archive's url
+				URLorigin = A:ORIGIN('ArchiveURL')								-- name of archive url parameter for error messages
+			end
+		end
+	end
+	if inArray(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup"}) or
+		('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
+			if is_set (Chapter) or is_set (TransChapter) or is_set (ChapterURL)then	-- chapter parameters not supported for these citation types
+				table.insert( z.message_tail, { seterror( 'chapter_ignored', {}, true ) } );		-- add error message
+				Chapter = '';														-- set to empty string to be safe with concatenation
+				TransChapter = '';
+				ChapterURL = '';
+			end
+	else																		-- otherwise, format chapter / article title
+		Chapter = format_chapter_title (Chapter, TransChapter, ChapterURL, ChapterURLorigin);
+		if is_set (Chapter) then
+			ChapterFormat = is_set(ChapterFormat) and " (" .. ChapterFormat .. ")" or "";
+			if is_set(ChapterFormat) and not is_set (ChapterURL) then			-- Test if |chapter-format= is given without giving a |chapter-url=
+				ChapterFormat = ChapterFormat .. seterror( 'format_missing_url', {'chapter-format', 'chapter-url'} );
+			end
+			Chapter = Chapter .. ChapterFormat .. sepc .. ' ';
+		end
+	end
+	-- Format main title.
+	if is_set(TitleLink) and is_set(Title) then
+		Title = "[[" .. TitleLink .. "|" .. Title .. "]]"
+	end
+	if inArray(config.CitationClass, {"web","news","journal","pressrelease","podcast", "newsgroup", "mailinglist"}) or
+		('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
+			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
+	TransError = "";
+	if is_set(TransTitle) then
+		if is_set(Title) then
+			TransTitle = " " .. TransTitle;
+		else
+			TransError = " " .. seterror( 'trans_missing_title' );
+		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_msg ('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 = ": " .. Pages;
+			elseif tonumber(Pages) ~= nil then
+				Pages = sepc .." " .. PPrefix .. Pages;
+			else
+				Pages = sepc .." " .. PPPrefix .. Pages;
+			end
+		end
+	else
+		if is_set(Periodical) and
+			not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
+			Page = ": " .. Page;
+		else
+			Page = sepc .." " .. PPrefix .. Page;
+		end
+	end
+	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_msg ('section', Section, true);
+			end
+			if is_set( Inset ) then
+				Inset = ", " .. wrap_msg ('inset', Inset, true);
+			end
+		else
+			if is_set( Section ) then
+				Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
+				if is_set( Inset ) then
+					Inset = ", " .. wrap_msg ('inset', Inset, true);
+				end
+			elseif is_set( Inset ) then
+				Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
+			end
+		end
+		At = At .. Section .. Inset;
+	end
+	if is_set (Language) then
+		Language = language_parameter (Language, this_page.namespace);			-- format, categories (article namespace only), name from ISO639-1, etc
+	else
+		Language="";															-- language not specified so make sure this is an empty string;
+	end
+	Others = is_set(Others) and (sepc .. " " .. Others) or "";
+-- handle type parameter for those CS1 citations that have default values
+	if inArray(config.CitationClass, {"AV-media-notes", "DVD-notes", "mailinglist", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
+		TitleType = set_titletype (config.CitationClass, TitleType);
+		if is_set(Degree) and "Thesis" == TitleType then	-- special case for cite thesis
+			TitleType = Degree .. " thesis";
+		end
+	end
+	if is_set(TitleType) then					-- if type parameter is specified
+		TitleType = " (" .. TitleType .. ")";	-- display it in parentheses
+	end
+	TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
+	Edition = is_set(Edition) and (" " .. wrap_msg ('edition', Edition)) or "";
+	Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
+	Series = is_set(Series) and (sepc .. " " .. Series) or "";
+	OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
+	Agency = is_set(Agency) and (sepc .. " " .. Agency) or "";
+	if is_set(Volume) then
+		if ( mw.ustring.len(Volume) > 4 )
+		  then Volume = sepc .." " .. Volume;
+		  else Volume = " <b>" .. hyphentodash(Volume) .. "</b>";
+		end
+	end
+	------------------------------------ totally unrelated data
+	if is_set(Via) then
+		Via = " " .. wrap_msg ('via', Via);
+	end
+--[[
+Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link
+note is displayed. There are no error messages for this condition.
+]]
+	if inArray(SubscriptionRequired:lower(), {'yes', 'true', 'y'}) then
+		SubscriptionRequired = sepc .. " " .. cfg.messages['subscription'];		-- subscription required message
+	elseif inArray(RegistrationRequired:lower(), {'yes', 'true', 'y'}) then
+		SubscriptionRequired = sepc .. " " .. cfg.messages['registration'];		-- registration required message
+	else
+		SubscriptionRequired = '';												-- either or both might be set to something other than yes true y
+	end
+	if is_set(AccessDate) then
+		local retrv_text = " " .. cfg.messages['retrieved']
+		AccessDate = nowrap_date (AccessDate);									-- wrap in nowrap span if date in appropriate format
+		if (sepc ~= ".") then retrv_text = retrv_text:lower() end				-- if 'citation', lower case
+		AccessDate = substitute (retrv_text, AccessDate);						-- add retrieved text
+																				-- neither of these work; don't know why; it seems that substitute() isn't being called
+		AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate});	-- allow editors to hide accessdates
+	end
+	if is_set(ID) then ID = sepc .." ".. ID; end
+   	if "thesis" == config.CitationClass and is_set(Docket) then
+		ID = sepc .." Docket ".. Docket .. ID;
+	end
+   	if "report" == config.CitationClass and is_set(Docket) then					-- for cite report when |docket= is set
+		ID = sepc .. ' ' .. Docket;												-- overwrite ID even if |id= is set
+	end
+	ID_list = 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_style ('quoted-text', Quote ); 				-- wrap in <q>...</q> tags
+		PostScript = "";														-- CS1 does not supply terminal punctuation when |quote= is set
+	end
+	local Archived
+	if is_set(ArchiveURL) then
+		if not is_set(ArchiveDate) then
+			ArchiveDate = seterror('archive_missing_date');
+		end
+		if "no" == DeadURL then
+			local arch_text = cfg.messages['archived'];
+			if sepc ~= "." then arch_text = arch_text:lower() end
+			Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
+				{ externallink( ArchiveURL, arch_text ), ArchiveDate } );
+			if not is_set(OriginalURL) then
+				Archived = Archived .. " " .. seterror('archive_missing_url');
+			end
+		elseif is_set(OriginalURL) then
+			local arch_text = cfg.messages['archived-dead'];
+			if sepc ~= "." then arch_text = arch_text:lower() end
+			Archived = sepc .. " " .. substitute( arch_text,
+				{ externallink( OriginalURL, cfg.messages['original'] ), ArchiveDate } );
+		else
+			local arch_text = cfg.messages['archived-missing'];
+			if sepc ~= "." then arch_text = arch_text:lower() end
+			Archived = sepc .. " " .. substitute( arch_text,
+				{ seterror('archive_missing_url'), ArchiveDate } );
+		end
+	else
+		Archived = ""
+	end
+	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_msg ('published', PublicationDate);
+			else
+				Publisher = PublicationDate;
+			end
+		end
+		if is_set(Publisher) then
+			Publisher = " (" .. Publisher .. ")";
+		end
+	else
+		if is_set(PublicationDate) then
+			PublicationDate = " (" .. wrap_msg ('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_style ('italic-title', Periodical)
+		else
+			Periodical = wrap_style ('italic-title', Periodical)
+		end
+	end
+--[[
+Handle the oddity that is cite speech.  This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so 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
+			local sep = '; ';
+			if 'vanc' == NameListFormat then
+				sep = ', ';
+			end
+			Authors = Authors .. sep .. 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 and for YMD dates that require disambiguation
+			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", "false", "n"}) then
+		for _, v in ipairs( z.error_categories ) do
+			text = text .. '[[Category:' .. v ..']]';
+		end
+		for _, v in ipairs( z.maintenance_cats ) do								-- append maintenance categories
+			text = text .. '[[Category:' .. v ..']]';
+		end
+		for _, v in ipairs( z.properties_cats ) do								-- append maintenance categories
+			text = text .. '[[Category:' .. v ..']]';
+		end
+	end
+	return 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()
+	local pframe = frame:getParent()
-    local args = {};
+	if nil ~= string.find( frame:getTitle(), 'sandbox', 1, true ) then				-- did the {{#invoke:}} use sandbox version?
-    local suggestions = {};
+		cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' );	-- load sandbox versions of Configuration and Whitelist and ...
-    local error_text, error_state;
+		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' );
-    for k, v in pairs( pframe.args ) do
+		dates = require('Module:Citation/CS1/Date_validation/sandbox').dates	-- ... sandbox version of date validation code
-        if v ~= '' then
+	else																	-- otherwise
-            if not validate( k ) then
+		cfg = mw.loadData( 'Module:Citation/CS1/Configuration' );			-- load live versions of Configuration and Whitelist and ...
-                error_text = "";
+		whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' );
-                if type( k ) ~= 'string' then
+		dates = require('Module:Citation/CS1/Date_validation').dates		-- ... live version of date validation code
-                    -- Exclude empty numbered parameters
+	end
-                    if v:match("%S+") ~= nil then
-                        error_text, error_state = seterror( 'text_ignored', {v}, true );
+	local args = {};
-                    end
+	local suggestions = {};
-                elseif validate( k:lower() ) then
+	local error_text, error_state;
-                    error_text, error_state = seterror( 'parameter_ignored_suggest', {k, k:lower()}, true );
-                else
+	local config = {};
-                    if #suggestions == 0 then
+	for k, v in pairs( frame.args ) do
-                        suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions' );
+		config[k] = v;
-                    end
+		args[k] = v;
-                    if suggestions[ k:lower() ] ~= nil then
+	end
-                        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 k == 'postscript' then
-            args[k] = v;
-        end
-    end
-    local config = {};
+	for k, v in pairs( pframe.args ) do
-    for k, v in pairs( frame.args ) do
+		if v ~= '' then
-        config[k] = v;
+			if not validate( k ) then
-        if args[k] == nil and (v ~= '' or k == 'postscript') then
+				error_text = "";
-            args[k] = v;
+				if type( k ) ~= 'string' then
-        end
+					-- Exclude empty numbered parameters
-    end
+					if v:match("%S+") ~= nil then
+						error_text, error_state = seterror( 'text_ignored', {v}, true );
-    return citation0( config, args)
+					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( 'Module: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
----------------------------------------------------------------------
---NOTES
---
--- NOTE A1: This Lua module was originally designed to handle a mix
---      of citation styles, crossing Vancouver style with Wikipedia's
---      local Citation Style 1 (CS1) from {Template:Citation/core}.
---      However, the conflicting positions of parameters, scattered
---      in twisted locations across this module, led to a separate
---      variation just to untangle the CS1 format of citations.
---
--- NOTE D2: The placement of dots and other separators between the
---      displayed parameters has been a continual headache, to keep
---      coordinated with the data in parentheses "(data)". There
---      has been a need to pre-check for the existence of related
---      options, to keep from putting double-dots ".." in some cases.
---      In particular, the omission of the "title=" parameter has led
---      to several cases of a spurious dot ". ." because the original
---      design had treated the title as a mandatory parameter.
---
-------------------------------------------------------------------------
---HISTORY:
---18Oct2012 Fixed lead-space in Chapter by omitting " ".
---18Oct2012 Fixed lead-space in Chapter/Title as end " " of Authors/Date/...
---19Oct2012 Put HISTORY comments to log major changes (not typos).
---19Oct2012 Fixed extra dot ".." in Title by omitting at end of "tcommon=...".
---19Oct2012 For pages, put &nbsp in "p.&nbsp;" etc.
---19Oct2012 Enhanced "pages=" to detect lone page as "p." else "pp." prefix.
---19Oct2012 Fixed to show "." after Periodical name (work, newspaper...).
---19Oct2012 Fixed web-link to have spaces "[...  Archived] from the original".
---19Oct2012 Fixed to show ";" between authors & coauthors.
---19Oct2012 Fixed to omit extra "." after coauthors.
---20Oct2012 Fixed COinS data to not urlencode all, as "ctx_ver=Z39.88-2004"
---20Oct2012 Fixed COinS to not end as "&" but use lead "&rft...=" form.
---20Oct2012 Fixed COinS to not url.encode page's "rfr_id=..." pagename.
---20Oct2012 Fixed COinS data when "web" to default to rft.genre "book".
---05Nov2012 Add a span wrapper even when there is no Ref parameter
---15Feb2013 Added Agency for "agency=xx".
---19Feb2013 Put NOTES comments to explain module operation.
---19Feb2013 Copied as Module:Citation/CS1 to alter to match wp:CS1 form.
---19Feb2013 Changed OrigYear to use [__] for CS1 style.
---19Feb2013 Fixed to not show duplicate Publisher/Agency.
---19Feb2013 Moved page-number parameters to after final date.
---19Feb2013 Fixed to not put double-dots after title again.
---20Feb2013 Changed to omit dot "." if already ends with dot.
---20Feb2013 If class "journal" shows Publisher after Periodical/Series.
---20Feb2013 Shifted Format to after Language, and Others after Volume.
---20Feb2013 Set AccessDate + <span class="reference-accessdate">
---20Feb2013 Fixed url when deadurl=no.
---20Feb2013 Added sepc for separator character between parameters.
---20Feb2013 Put "OCLC" for "Online Computer Library Center".
---20Feb2013 Fix empty "authorlink=" as person.link ~= "".
---20Feb2013 Added space after AuthorSep & AuthorNameSep.
---21Feb2013 Added args.contributor (was missing parameter).
---21Feb2013 Fixed EditorSep (was misspelled "EdithorSep").
---21Feb2013 Set OCinSdata.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"
---21Feb2013 Checked to omit blank codes (asin= | doi= etc.).
---21Feb2013 Set enddot to end line if not config.CitationClass "citation".
---21Feb2013 Fixed to show "issn=x" as the ISSN code.
---21Feb2013 Fixed to show "id=x" after Zbl code.
---21Feb2013 Changed to omit double-dot before date when already dot.
---21Feb2013 Order config.CitationClass "citation": Volume, Issue, Publisher.
---21Feb2013 Put warning "Bad DOI (expected "10."..)" in DOI result.
---21Feb2013 Automatically unbolded volume+comma when > 4 long.
---21Feb2013 Changed to allow lowercase "asin-tld".
---22Feb2013 Fixed ref=harv to extract Year from Date.
---22Feb2013 Set Harvard refer. span id if config.CitationClass "citation".
---22Feb2013 Fixed config.CitationClass "citation" as span class="citation".
---22Feb2013 Capitalized "Archived/Retrieved" only when sepc is dot ".".
---23Feb2013 Fixed author editor for "in" or "In" and put space after sepc.
---23Feb2013 Changed to omit dot in "et al." when sepc is "." separator.
---23Feb2013 Fixed "author1-first" to also get args.given or args.given1.
---23Feb2013 Fixed args.article to set Title, after Periodical is Title.
---23Feb2013 Fixed to allow blank Title (such as "contribution=mytitle").
---23Feb2013 Fixed double-dot ".." at end of Editors list
---26Feb2013 Moved "issue=" data to show before "page=".
---26Feb2013 Moved "type=" data to show after "format=".
---26Feb2013 For "pmc=" link, omitted suffix "/?tool=pmcentrez".
---27Feb2013 For coauthors, omitted extra separator after authors.
---27Feb2013 For date, allowed empty date to use month/day/year.
---27Feb2013 Fixed double-dot ".." at end of authors/coauthors list.
---27Feb2013 Reset editor suffix as ", ed." when date exists.
---27Feb2013 Removed duplicate display of "others=" data.
---27Feb2013 Removed parentheses "( )" around "department" TitleNote.
---05Mar2013 Moved Language to follow Periodical or Series.
---05Mar2013 Fixed Edition to follow Series or Volume.
---05Mar2013 Fixed class encyclopaedia to show article as quoted Chapter.
---05Mar2013 Fixed class encyclopaedia to show page as "pp." or "p.".
---07Mar2013 Changed class encyclopaedia to omit "( )" around publisher.
---07Mar2013 Fixed end double-dot by string.sub(idcommon,-1,-1) was "-1,1".
---13Mar2013 Removed enddot "." after "quote=" parameter.
---13Mar2013 Changed config.CitationClass "news" to use "p." page format.
---13Mar2013 Fixed missing "location=" when "web" or "encyclopaedia".
---14Mar2013 Fixed end double-dot after book/work title.
---14Mar2013 Fixed double-dot before "p." or "pp." page number.
---14Mar2013 Fixed config.CitationClass "book" to use p./pp. page.
---18Mar2013 Fixed "page=" to override "pages=" as in markup-based cites.
---19Mar2013 Fixed date of class=journal Periodical to show after page.
---19Mar2013 Changed null "postscript=" to suppress end-dot of citation.
---20Mar2013 If CitationClass is journal, show "others=" before title.
---20Mar2013 If CitationClass is book, show "others=" before edition.
---20Mar2013 If CitationClass is journal, adjust "others=" to have sepc.
---20Mar2013 For class "journal", use book format unless Periodical set.
---03Apr2013 Changed safejoin() to omit "." after wikilink ".]]" end dot.
---03Apr2013 Changed safejoin() to omit "." after external ".]" end dot.
---03Apr2013 Changed safejoin() to omit "." at italic wikilink ".]]" end.
---03Apr2013 Changed safejoin() to omit "." at italic external ".]" end.
---04Apr2013 Moved sepc before <span class="reference-accessdate"> for "..".
---
---End

Difference between revisions of "Module:Citation/CS1"

Latest revision as of 01:27, 15 February 2015

Personal tools

Namespaces

Variants

Views

Actions

Search

Navigation

Toolbox

Share