Module:Citation/CS1: Difference between revisions

Jump to navigation Jump to search
m17
(test)
(m17)
 
(9 intermediate revisions by the same user not shown)
Line 37: Line 37:
     end
     end
     return false;
     return false;
end
--[[
Categorize and emit an error message when the citation contains one or more deprecated parameters.  Because deprecated parameters (currently |day=, |month=,
|coauthor=, and |coauthors=) aren't related to each other and because these parameters may be concatenated into the variables used by |date= and |author#= (and aliases)
details of which parameter caused the error message are not provided.  Only one error message is emitted regarless of the number of deprecated parameters in the citation.
]]
function deprecated_parameter()
if true ~= Page_in_deprecated_cat then -- if we haven't been here before then set a
Page_in_deprecated_cat=true; -- sticky flag so that if there are more than one deprecated parameter the category is added only once
table.insert( z.message_tail, { seterror( 'deprecated_params', {error_message}, true ) } ); -- add error message
end
end
end


-- Populates numbered arguments in a message string using an argument table.
-- Populates numbered arguments in a message string using an argument table.
function substitute( msg, args )
function substitute( msg, args )
    return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
-- return args and tostring( mw.message.newRawMessage( msg, args ) ) or msg;
return args and mw.message.newRawMessage( msg, args ):plain() or msg;
end
 
--[[
Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote mark contained in a |title= or |chapter= parameter's value.
This function will positive kern  either single or double quotes:
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
]]
function kern_quotes (str)
local left='<span style="padding-left:0.2em;">%1</span>'; -- spacing to use when title contains leading single or double quote mark
local right='<span style="padding-right:0.2em;">%1</span>'; -- spacing to use when title contains trailing single or double quote mark
if  str:match ("^[\"\'][^\']") then
str = string.gsub( str, "^[\"\']", left, 1 ); -- replace (captured) leading single or double quote with left-side <span>
end
if str:match ("[^\'][\"\']$") then
str = string.gsub( str, "[\"\']$", right, 1 ); -- replace (captured) trailing single or double quote with right-side <span>
end
return str;
end
end


Line 105: Line 137:
end
end


-- Checks that parameter name is valid using the whitelist
--[[
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 )
function validate( name )
    name = tostring( name );
local name = tostring( name );
   
local state = whitelist.basic_arguments[ name ];
    -- Normal arguments
    if whitelist.basic_arguments[ name ] then
-- Normal arguments
        return true;
if true == state then return true; end -- valid actively supported parameter
    end
if false == state then
   
deprecated_parameter (); -- parameter is deprecated but still supported
    -- Arguments with numbers in them
return true;
    name = name:gsub( "%d+", "#" );
end
    if whitelist.numbered_arguments[ name ] then
        return true;
-- Arguments with numbers in them
    end
name = name:gsub( "%d+", "#" ); -- replace digit(s) with # (last25 becomes last#
   
state = whitelist.numbered_arguments[ name ];
    -- Not found, argument not supported.
if true == state then return true; end -- valid actively supported parameter
    return false
if false == state then
deprecated_parameter (); -- parameter is deprecated but still supported
return true;
end
return false; -- Not supported because not found or name is set to nil
end
end


Line 218: Line 262:
end
end


-- Formats a DOI and checks for DOI errors.
--[[
function doi(id, inactive)
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
     local cat = ""
contains only digits and is less than test_limit; the value in local variable test_limit will need to be updated periodically as more PMIDs are issued.
     local handler = cfg.id_handlers['DOI'];
]]
      
function pmid(id)
local test_limit = 30000000; -- update this value as PMIDs approach
local handler = cfg.id_handlers['PMID'];
local err_cat =  ''; -- presume that PMID is valid
if id:match("[^%d]") then -- if PMID has anything but digits
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
else -- PMID is only digits
local id_num = tonumber(id); -- convert id to a number for range testing
if 1 > id_num or test_limit < id_num then -- if PMID is outside test limit boundaries
err_cat = ' ' .. seterror( 'bad_pmid' ); -- set an error message
end
end
return externallinkid({link = handler.link, label = handler.label,
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode}) .. err_cat;
end
 
--[[
Determines if a PMC identifier's online version is embargoed. Compares the date in |embargo= against today's date.  If embargo date is
in the future, returns true; otherwse, returns false because the embargo has expired or |embargo= not set in this cite.
]]
function is_embargoed(embargo)
if is_set(embargo) then
local lang = mw.getContentLanguage();
local good1, embargo_date, good2, todays_date;
good1, embargo_date = pcall( lang.formatDate, lang, 'U', embargo );
good2, todays_date = pcall( lang.formatDate, lang, 'U' );
if good1 and good2 and tonumber( embargo_date ) >= tonumber( todays_date ) then --is embargo date is in the future?
return true; -- still embargoed
end
end
return false; -- embargo expired or |embargo= not set
end
 
--[[
Formats a PMC and checks 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.
]]
function pmc(id, embargo)
local handler = cfg.id_handlers['PMC'];
   
local text;
 
if is_embargoed(embargo) then
text="[[" .. handler.link .. "|" .. handler.label .. "]]:" .. handler.separator .. id; --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})
end
return text;
end
 
-- Formats a DOI and checks for DOI errors.
function doi(id, inactive)
     local cat = ""
     local handler = cfg.id_handlers['DOI'];
      
     local text;
     local text;
    if is_set(inactive) 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.messages['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–]-[^%.,]$") then -- doi must begin with '10.', must not contain spaces or endashes, and must not end with period or comma
cat = ' ' .. seterror( 'bad_doi' );
end
return text .. inactive .. cat  
end
end


Line 264: Line 373:


--[[
--[[
Determines whether an URL string is valid
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:


At present the only check is whether the string appears to
|issn=0819 4327 gives: [http://www.worldcat.org/issn/0819 4327 0819 4327]  -- can't have spaces in an external link
be prefixed with a URI schemeIt is not determined whether
the URI scheme is valid or whether the URL is otherwise well
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
formed.
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 messageThe issn is always displayed with a hyphen, even if the issn was given as a single group of 8 digits.
]]
]]
function checkurl( url_str )
function issn(id)
    -- Protocol-relative or URL scheme
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate
    return url_str:sub(1,2) == "//" or url_str:match( "^[^/]*:" ) ~= nil;
local handler = cfg.id_handlers['ISSN'];
end
local text;
local valid_issn = true;


-- Removes irrelevant text and dashes from ISBN number
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and ndashes from the issn
-- Similar to that used for Special:BookSources
 
function cleanisbn( isbn_str )
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 didgits long, containing only 0-9 or X in the last position
    return isbn_str:gsub( "[^-0-9X]", "" );
valid_issn=false; -- wrong length or improper character
end
else
valid_issn=is_valid_isxn(id, 8); -- validate issn
end


-- Determines whether an ISBN string is valid
if true == valid_issn then
function checkisbn( isbn_str )
id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version
    isbn_str = cleanisbn( isbn_str ):gsub( "-", "" );
else
    local len = isbn_str:len();
id = issn_copy; -- if not valid, use the show the invalid issn with error message
end
    if len ~= 10 and len ~= 13 then
        return false;
text = externallinkid({link = handler.link, label = handler.label,
    end
prefix=handler.prefix,id=id,separator=handler.separator, encode=handler.encode})
   
   
    local temp = 0;
if false == valid_issn then
    if len == 10 then
text = text .. ' ' .. seterror( 'bad_issn' ) -- add an error message if the issn is invalid
        if isbn_str:match( "^%d*X?$" ) == nil then return false; end
end  
        isbn_str = { isbn_str:byte(1, len) };
        for i, v in ipairs( isbn_str ) do
return text
            if v == string.byte( "X" ) then
                temp = temp + 10*( 11 - i );
            else
                temp = temp + tonumber( string.char(v) )*(11-i);
            end
        end
        return temp % 11 == 0;
    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
end


-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
--[[
function removewikilink( str )
This function sets default title types (equivalent to the citation including |type=<default value>) for those citations that have defaults.
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
Also handles the special case where it is desireable to omit the title type from the rendered citation (|type=none).
        return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
]]
    end));
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 "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 "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
end


-- Escape sequences for content that will be used for URL descriptions
-- returns a number according to the month in a date: 1 for January, etc.  Capitalization and spelling must be correct. If not a valid month, returns 0
function safeforurl( str )
function get_month_number (month)
    if str:match( "%[%[.-%]%]" ) ~= nil then
local long_months = {['January']=1, ['February']=2, ['March']=3, ['April']=4, ['May']=5, ['June']=6, ['July']=7, ['August']=8, ['September']=9, ['October']=10, ['November']=11, ['December']=12};
        table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
local short_months = {['Jan']=1, ['Feb']=2, ['Mar']=3, ['Apr']=4, ['May']=5, ['Jun']=6, ['Jul']=7, ['Aug']=8, ['Sep']=9, ['Oct']=10, ['Nov']=11, ['Dec']=12};
    end
local temp;
   
temp=long_months[month];
    return str:gsub( '[%[%]\n]', {   
if temp then return temp; end -- if month is the long-form name
        ['['] = '&#91;',
temp=short_months[month];
        [']'] = '&#93;',
if temp then return temp; end -- if month is the short-form name
        ['\n'] = ' ' } );
return 0; -- misspelled, improper case, or not a month name
end
end


-- Converts a hyphen to a dash
-- returns a number according to the sequence of seasons in a year: 1 for Winter, etc.  Capitalization and spelling must be correct. If not a valid season, returns 0
function hyphentodash( str )
function get_season_number (season)
    if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
local season_list = {['Winter']=1, ['Spring']=2, ['Summer']=3, ['Fall']=4, ['Autumn']=4}
        return str;
local temp;
    end  
temp=season_list[season];
    return str:gsub( '-', '–' );
if temp then return temp; end -- if season is a valid name return its number
return 0; -- misspelled, improper case, or not a season name
end
end


-- Protects a string that will be wrapped in wiki italic markup '' ... ''
--[[
function safeforitalics( str )
Returns true if day is less than or equal to the number of days in month; else returns false.
    --[[ Note: We can not use <i> for italics, as the expected behavior for
 
    italics specified by ''...'' in the title is that they will be inverted
Assumes Julian calendar prior to year 1582 and Gregorian calendar thereafter. Accounts for Julian calendar leap years before 1582 and Gregorian leap years after 1582.
    (i.e. unitalicized) in the resulting referencesIn addition, <i> and ''
Where the two calendars overlap (1582 to approximately 1923) dates are assumed to be Gregorian.
    tend to interact poorly under Mediawiki's HTML tidy. ]]
]]
   
function is_valid_date (year, month, day)
    if not is_set(str) then
local days_in_month = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
        return str;
local month_length;
    else
if (2==month) then -- if February
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
month_length = 28; -- then 28 days unless
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
if 1582 > tonumber(year) then -- Julian calendar
       
if 0==(year%4) then
        -- Remove newlines as they break italics.
month_length = 29;
        return str:gsub( '\n', ' ' );
end
    end
else -- Gregorian calendar
if (0==(year%4) and (0~=(year%100) or 0==(year%400))) then -- is a leap year?
month_length = 29; -- if leap year then 29 days in February
end
end
else
month_length=days_in_month[month];
end
 
if tonumber (day) > month_length then
return false;
end
return true;
end
 
--[[
Check a pair of months or seasons to see if both are valid members of a month or season pair.
 
Month pairs are expected to be left to right, earliest to latest in time. Similarly, seasons are also left to right, earliest to latest in time. There is
an oddity with seasons.  Winter is assigned a value of 1, spring 2, ..., fall and autumn 4Because winter can follow fall/autumn at the end of a calender year, a special test
is made to see if |date=Fall-Winter yyyy (4-1) is the date.
]]
 
function is_valid_month_season_range(range_start, range_end)
local range_start_number = get_month_number (range_start);
if 0 == range_start_number then -- is this a month range?
local range_start_number = get_season_number (range_start); -- not a month; is it a season? get start season number
local range_end_number = get_season_number (range_end); -- get end season number
 
if 0 ~= range_start_number then -- is start of range a season?
if range_start_number < range_end_number then -- range_start is a season
return true; -- return true when range_end is also a season and follows start season; else false
end
if 4 == range_start_number and 1 == range_end_number then -- special case when range is Fall-Winter or Autumn-Winter
return true;
end
end
return false; -- range_start is not a month or a season; or range_start is a season and range_end is not; or improper season sequence
end
 
local range_end_number = get_month_number (range_end); -- get end month number
if range_start_number < range_end_number then -- range_start is a month; does range_start precede range_end?
return true; -- if yes, return true
end
return false; -- range_start month number is greater than or equal to range end number; or range end isn't a month
end
end


--[[
--[[
Joins a sequence of strings together while checking for duplicate separation
Check date format to see that it is one of the formats approved by MOS:DATE: MMMM D, YYYY; D MMMM YYYY; MMMM YYYY; YYYY-MM-DD; YYYY.
characters.
Additionally, check the date to see that it is a real date: no 31 in 30-day months; no 29 February when not a leap year.  Months, both long-form and three
character abbreviations, and seasons must be spelled correctly.
 
If the date fails the fomat tests, this function returns false but does not return values for anchor_year and COinS_date.  When this happens, the date parameter is
used in the COinS metadata and the CITEREF identifier gets its year from the year parameter if present.
 
Inputs:
date_string - date string from date-holding parameters (date, year, accessdate, embargo, archivedate, etc)
 
Returns:
false if date string is not a real date; else
true, anchor_year, COinS_date
anchor_year can be used in CITEREF anchors
COinS_date is date_string without anchor_year disambiguator if any
]]
]]
function safejoin( tbl, duplicate_char )
function check_date (date_string)
    --[[
local year;
    Note: we use string functions here, rather than ustring functions.
local month=0; -- assume that month and day are not used; if either is zero then final year/month/day validation is not necessary
   
local day=0;
    This has considerably faster performance and should work correctly as
local day2=0; -- second day in a day range
    long as the duplicate_char is strict ASCII.  The strings
local anchor_year;
    in tbl may be ASCII or UTF8.
local coins_date;
    ]]
 
   
if date_string:match("^%d%d%d%d%-%d%d%-%d%d$") then -- Year-initial numerical year month day format
    local str = '';
year, month, day=string.match(date_string, "(%d%d%d%d)%-(%d%d)%-(%d%d)");
    local comp = '';
month=tonumber(month);
    local end_chr = '';
if 12 < month or 1 > month or 1583 > tonumber(year) then return false; end -- month number not valid or not Gregorian calendar
    local trim;
anchor_year = year;
    for _, value in ipairs( tbl ) do
 
        if value == nil then value = ''; end
elseif date_string:match("^%a+ +[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month-initial: month day, year
       
month, day, anchor_year, year=string.match(date_string, "(%a+)%s*(%d%d?),%s*((%d%d%d%d)%a?)");
        if str == '' then
month = get_month_number (month);
            str = value;
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
        elseif value ~= '' then
            if value:sub(1,1) == '<' then
elseif date_string:match("^%a+ +[1-9]%d?–[1-9]%d?, +[1-9]%d%d%d%a?$") then -- month-initial day range: month day–day, year; days are separated by endash
                -- Special case of values enclosed in spans and other markup.
month, day, day2, anchor_year, year=string.match(date_string, "(%a+) +(%d%d?)–(%d%d?), +((%d%d%d%d)%a?)");
                comp = value:gsub( "%b<>", "" );
if tonumber(day) >= tonumber(day2) then return false; end -- date range order is left to right: earlier to later; dates may not be the same;
            else
month = get_month_number (month);
                comp = value;
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
            end
 
           
elseif date_string:match("^[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day-initial: day month year
            if comp:sub(1,1) == duplicate_char then
day, month, anchor_year, year=string.match(date_string, "(%d%d*)%s*(%a+)%s*((%d%d%d%d)%a?)");
                trim = false;
month = get_month_number (month);
                end_chr = str:sub(-1,-1);
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
 
                if end_chr == duplicate_char then
elseif date_string:match("^[1-9]%d?–[1-9]%d? +%a+ +[1-9]%d%d%d%a?$") then -- day-range-initial: day–day month year; days are separated by endash
                    str = str:sub(1,-2);
day, day2, month, anchor_year, year=string.match(date_string, "(%d%d?)–(%d%d?) +(%a+) +((%d%d%d%d)%a?)");
                elseif end_chr == "'" then
if tonumber(day) >= tonumber(day2) then return false; end -- date range order is left to right: earlier to later; dates may not be the same;
                    if str:sub(-3,-1) == duplicate_char .. "''" then
month = get_month_number (month);
                        str = str:sub(1, -4) .. "''";
if 0 == month then return false; end -- return false if month text isn't one of the twelve months
                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
 
                        trim = true;
elseif mw.ustring.match (date_string, "^%a+–%a+ +[1-9]%d%d%d%a?$") then -- month/season range year; months separated by endash
                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
local month2
                        trim = true;
month, month2, anchor_year, year=mw.ustring.match (date_string, "(%a+)[%-/–](%a+)%s*((%d%d%d%d)%a?)");
                    end
if false == is_valid_month_season_range(month, month2) then
                elseif end_chr == "]" then
return false;
                    if str:sub(-3,-1) == duplicate_char .. "]]" then
end
                        trim = true;
                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
elseif date_string:match("^%a+ +%d%d%d%d%a?$") then -- month/season year
                        trim = true;
month, anchor_year, year=string.match(date_string, "(%a+)%s*((%d%d%d%d)%a?)");
                    end
if 0 == get_month_number (month) then -- if month text isn't one of the twelve months, might be a season
                elseif end_chr == " " then
if 0 == get_season_number (month) then -- not a month, is it a season?
                    if str:sub(-2,-1) == duplicate_char .. " " then
return false; -- return false not a month or one of the five seasons
                        str = str:sub(1,-3);
end
                    end
end
                end
 
elseif date_string:match("^[1-9]%d%d%d?%a?$") then -- year; here accept either YYY or YYYY
anchor_year, year=string.match(date_string, "((%d%d%d%d?)%a?)");
 
else
return false; -- date format not one of the MOS:DATE approved formats
end
 
if 0~=month and 0~=day then -- check year month day dates for validity
if 0~=day2 then -- If there is a second day (d–d Mmm YYYY or Mmm d–d, YYYY) test the second date
if false==is_valid_date(year,month,day2) then
return false; -- second date in date range string is not a real date return false; unset anchor_year and coins_date
end -- if second date range string is valid, fall through to test the first date range
end
if false==is_valid_date(year,month,day) then
return false; -- date string is not a real date return false; unset anchor_year and coins_date
end
end
 
coins_date= mw.ustring.gsub( date_string, "–", "-" ); -- if here, then date_string is valid; set coins_date and replace any ndash with a hyphen
return true, anchor_year, coins_date; -- format is good and date string represents a real date
end
 
--[[
Cycle the date-holding parameters in passed table date_parameters_list through check_date() to check compliance with MOS:DATE. For all valid dates, check_date() returns
true and values for anchor_year (used in CITEREF identifiers) and COinS_date (used in the COinS metadata).  The |date= parameter test is unique.  This function only
accepts anchor_year and COinS_date results from the |date= parameter test and |date= is the only date-holding parameter that is allowed to contain the no-date keywords
"n.d." or "nd" (without quotes).
 
Unlike most error messages created in this module, only one error message is created by this function. Because all of the date holding parameters are processed serially,
a single error message is created as the dates are tested.
]]
 
function dates(date_parameters_list)
local anchor_year; -- will return as nil if the date being tested is not |date=
local COinS_date; -- will return as nil if the date being tested is not |date=
local error_message ="";
local good_date=false;
for k, v in pairs(date_parameters_list) do -- for each date-holding parameter in the list
if is_set(v) then -- if the parameter has a value
if v:match("^c%. [1-9]%d%d%d?%a?$") then -- special case for c. year or with or without CITEREF disambiguator - only |date= and |year=
if 'date'==k then
good_date, anchor_year, COinS_date = true, v:match("((c%. [1-9]d%d%d?)%a?)"); -- anchor year and COinS_date only from |date= parameter
elseif 'year'==k then
good_date = true;
end
elseif 'year'==k then -- if the parameter is |year= (but not c. year)
if v:match("^[1-9]%d%d%d?%a?$") then -- year with or without CITEREF disambiguator
good_date =  true;
end
elseif 'date'==k then -- if the parameter is |date=
if v:match("n%.d%.%a?") then -- if |date=n.d. with or without a CITEREF disambiguator
good_date, anchor_year, COinS_date = true, v:match("((n%.d%.)%a?)"); --"n.d."; no error when date parameter is set to no date
elseif v:match("nd%a?$") then -- if |date=nd with or without a CITEREF disambiguator
good_date, anchor_year, COinS_date = true, v:match("((nd)%a?)"); --"nd"; no error when date parameter is set to no date
else
good_date, anchor_year, COinS_date = check_date (v); -- go test the date
end
else -- any other date-holding parameter
good_date = check_date (v); -- go test the date
end
if false==good_date then -- assemble one error message so we don't add the tracking category multiple times
if is_set(error_message) then -- once we've added the first portion of the error message ...
error_message=error_message .. ", "; -- ... add a comma space separator
end
error_message=error_message .. "&#124;" .. k .. "="; -- add the failed parameter
end
end
end
if is_set(error_message) then
table.insert( z.message_tail, { seterror( 'bad_date', {error_message}, true ) } ); -- add this error message
end
 
return anchor_year, COinS_date; -- and done
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


                if trim then
-- Removes irrelevant text and dashes from ISBN number
                    if value ~= comp then
-- Similar to that used for Special:BookSources
                        local dup2 = duplicate_char;
function cleanisbn( isbn_str )
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
    return isbn_str:gsub( "[^-0-9X]", "" );
                       
end
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
                    else
                        value = value:sub( 2, -1 );
                    end
                end
            end
            str = str .. value;
        end
    end
    return str;
end


--[[
--[[
Return the year portion of a date string, if possible.
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. ISBN-13 is checked in checkisbn().
Returns empty string if the argument can not be interpreted
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,
as a year.
spaces and other non-isxn characters.
]]
]]
function selectyear( str )
function is_valid_isxn (isxn_str, len)
    -- Is the input a simple number?
local temp = 0;
    local num = tonumber( str );
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes
    if num ~= nil and num > 0 and num < 2100 and num == math.floor(num) then
len = len+1; -- adjust to be a loop counter
        return str;
for i, v in ipairs( isxn_str ) do -- loop through all of the bytes and calculate the checksum
    else
if v == string.byte( "X" ) then -- if checkdigit is X
        -- Use formatDate to interpret more complicated formats
temp = temp + 10*( len - i ); -- it represents 10 decimal
        local lang = mw.getContentLanguage();
else
        local good, result;
temp = temp + tonumber( string.char(v) )*(len-i);
        good, result = pcall( lang.formatDate, lang, 'Y', str )
end
        if good then
end
            return result;
return temp % 11 == 0; -- returns true if calculation result is zero
        else
            -- Can't make sense of this input, return blank.
            return "";
        end
    end
end
end


-- Attempts to convert names to initials.
-- Determines whether an ISBN string is valid
function reducetoinitials(first)
function checkisbn( isbn_str )
    local initials = {}
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
    for word in string.gmatch(first, "%S+") do
isbn_str = isbn_str:gsub( "-", "" ):gsub( " ", "" ); -- remove hyphens and spaces
         table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
local len = isbn_str:len();
if len ~= 10 and len ~= 13 then
return false;
end
 
if len == 10 then
if isbn_str:match( "^%d*X?$" ) == nil then return false; end
return is_valid_isxn(isbn_str, 10);
else
local temp = 0;
if isbn_str:match( "^97[89]%d*$" ) == nil then return false; end -- isbn13 begins with 978 or 979
isbn_str = { isbn_str:byte(1, len) };
for i, v in ipairs( isbn_str ) do
temp = temp + (3 - 2*(i % 2)) * tonumber( string.char(v) );
end
return temp % 10 == 0;
end
end
 
-- Gets the display text for a wikilink like [[A|B]] or [[B]] gives B
function removewikilink( str )
    return (str:gsub( "%[%[([^%[%]]*)%]%]", function(l)
        return l:gsub( "^[^|]*|(.*)$", "%1" ):gsub("^%s*(.-)%s*$", "%1");
    end));
end
 
-- Escape sequences for content that will be used for URL descriptions
function safeforurl( str )
    if str:match( "%[%[.-%]%]" ) ~= nil then
         table.insert( z.message_tail, { seterror( 'wikilink_in_url', {}, true ) } );
     end
     end
     return table.concat(initials) -- Vancouver format does not include spaces.
   
     return str:gsub( '[%[%]\n]', {   
        ['['] = '&#91;',
        [']'] = '&#93;',
        ['\n'] = ' ' } );
end
end


-- Formats a list of people (e.g. authors / editors)
-- Converts a hyphen to a dash
function listpeople(control, people)
function hyphentodash( str )
     local sep = control.sep;
     if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then
     local namesep = control.namesep
        return str;
     local format = control.format
     end   
     local maximum = control.maximum
     return str:gsub( '-', '–' );
     local lastauthoramp = control.lastauthoramp;
end
     local text = {}
 
     local etal = false;
-- Protects a string that will be wrapped in wiki italic markup '' ... ''
function safeforitalics( str )
     --[[ Note: We can not use <i> for italics, as the expected behavior for
     italics specified by ''...'' in the title is that they will be inverted
     (i.e. unitalicized) in the resulting references.  In addition, <i> and ''
     tend to interact poorly under Mediawiki's HTML tidy. ]]
      
      
     if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
     if not is_set(str) then
    if maximum ~= nil and maximum < 1 then return "", 0; end
        return str;
    else
        if str:sub(1,1) == "'" then str = "<span />" .. str; end
        if str:sub(-1,-1) == "'" then str = str .. "<span />"; end
       
        -- Remove newlines as they break italics.
        return str:gsub( '\n', ' ' );
    end
end
 
--[[
Joins a sequence of strings together while checking for duplicate separation
characters.
]]
function safejoin( tbl, duplicate_char )
    --[[
    Note: we use string functions here, rather than ustring functions.
   
    This has considerably faster performance and should work correctly as
    long as the duplicate_char is strict ASCII.  The strings
    in tbl may be ASCII or UTF8.
    ]]
      
      
     for i,person in ipairs(people) do
    local str = '';
         if is_set(person.last) then
    local comp = '';
            local mask = person.mask
    local end_chr = '';
            local one
    local trim;
            local sep_one = sep;
     for _, value in ipairs( tbl ) do
            if maximum ~= nil and i > maximum then
         if value == nil then value = ''; end
                etal = true;
       
                break;
        if str == '' then
            elseif (mask ~= nil) then
            str = value;
                local n = tonumber(mask)
        elseif value ~= '' then
                 if (n ~= nil) then
            if value:sub(1,1) == '<' then
                    one = string.rep("&mdash;",n)
                 -- Special case of values enclosed in spans and other markup.
                else
                comp = value:gsub( "%b<>", "" );
                    one = mask;
                    sep_one = " ";
                end
             else
             else
                 one = person.last
                 comp = value;
                local first = person.first
                if is_set(first) then
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
                    one = one .. namesep .. first
                end
                if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
             end
             end
             table.insert( text, one )
              
            table.insert( text, sep_one )
            if comp:sub(1,1) == duplicate_char then
        end
                trim = false;
    end
                end_chr = str:sub(-1,-1);
 
                -- str = str .. "<HERE(enchr=" .. end_chr.. ")"
    local count = #text / 2;
                if end_chr == duplicate_char then
    if count > 0 then  
                    str = str:sub(1,-2);
        if count > 1 and is_set(lastauthoramp) and not etal then
                elseif end_chr == "'" then
            text[#text-2] = " & ";
                    if str:sub(-3,-1) == duplicate_char .. "''" then
        end
                        str = str:sub(1, -4) .. "''";
        text[#text] = nil;  
                    elseif str:sub(-5,-1) == duplicate_char .. "]]''" then
    end
                        trim = true;
   
                    elseif str:sub(-4,-1) == duplicate_char .. "]''" then
    local result = table.concat(text) -- construct list
                        trim = true;
    if etal then  
                    end
        local etal_text = cfg.messages['et al'];
                elseif end_chr == "]" then
        result = result .. " " .. etal_text;
                    if str:sub(-3,-1) == duplicate_char .. "]]" then
    end
                        trim = true;
   
                    elseif str:sub(-2,-1) == duplicate_char .. "]" then
    -- if necessary wrap result in <span> tag to format in Small Caps
                        trim = true;
    if ( "scap" == format ) then result =  
                    end
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
                elseif end_chr == " " then
    end  
                    if str:sub(-2,-1) == duplicate_char .. " " then
    return result, count
                        str = str:sub(1,-3);
end
                    end
                end


-- Generates a CITEREF anchor ID.
                if trim then
function anchorid( options )
                    if value ~= comp then
    return "CITEREF" .. table.concat( options );
                        local dup2 = duplicate_char;
end
                        if dup2:match( "%A" ) then dup2 = "%" .. dup2; end
                       
                        value = value:gsub( "(%b<>)" .. dup2, "%1", 1 )
                    else
                        value = value:sub( 2, -1 );
                    end
                end
            end
            str = str .. value;
        end
    end
    return str;
end


-- Gets name list from the input arguments
-- Attempts to convert names to initials.
function extractnames(args, list_name)
function reducetoinitials(first)
     local names = {};
     local initials = {}
     local i = 1;
     for word in string.gmatch(first, "%S+") do
    local last;
         table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops.
   
    while true do
         last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
        if not is_set(last) then
            -- just in case someone passed in an empty parameter
            break;
        end
        names[i] = {
            last = last,
            first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
        };
        i = i + 1;
     end
     end
     return names;
     return table.concat(initials) -- Vancouver format does not include spaces.
end
end


-- Populates ID table from arguments using configuration settings
-- Formats a list of people (e.g. authors / editors)
function extractids( args )
function listpeople(control, people)
     local id_list = {};
     local sep = control.sep;
     for k, v in pairs( cfg.id_handlers ) do   
     local namesep = control.namesep
        v = selectone( args, v.parameters, 'redundant_parameters' );
    local format = control.format
        if is_set(v) then id_list[k] = v; end
    local maximum = control.maximum
     end
     local lastauthoramp = control.lastauthoramp;
    return id_list;
     local text = {}
end
    local etal = false;
 
-- 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;
     if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
    if maximum ~= nil and maximum < 1 then return "", 0; end
      
      
     for k, v in pairs( id_list ) do
     for i,person in ipairs(people) do
         -- fallback to read-only cfg
         if is_set(person.last) then
        handler = setmetatable( { ['id'] = v }, fallback(k) );
             local mask = person.mask
       
            local one
        if handler.mode == 'external' then
             local sep_one = sep;
             table.insert( new_list, {handler.label, externallinkid( handler ) } );
            if maximum ~= nil and i > maximum then
        elseif handler.mode == 'internal' then
                etal = true;
             table.insert( new_list, {handler.label, internallinkid( handler ) } );
                break;
        elseif handler.mode ~= 'manual' then
            elseif (mask ~= nil) then
            error( cfg.messages['unknown_ID_mode'] );
                local n = tonumber(mask)
        elseif k == 'DOI' then
                if (n ~= nil) then
            table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
                    one = string.rep("&mdash;",n)
        elseif k == 'ASIN' then
                else
            table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );  
                    one = mask;
        elseif k == 'OL' then
                    sep_one = " ";
             table.insert( new_list, {handler.label, openlibrary( v ) } );
                end
        elseif k == 'ISBN' then
             else
            local ISBN = internallinkid( handler );
                one = person.last
            if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
                local first = person.first
                ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
                if is_set(first) then
                    if ( "vanc" == format ) then first = reducetoinitials(first) end
                    one = one .. namesep .. first
                end
                if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end
             end
             end
             table.insert( new_list, {handler.label, ISBN } );               
             table.insert( text, one )
        else
             table.insert( text, sep_one )
             error( cfg.messages['unknown_manual_ID'] );
         end
         end
     end
     end
      
 
     function comp( a, b )
     local count = #text / 2;
        return a[1] < b[1];
     if count > 0 then
        if count > 1 and is_set(lastauthoramp) and not etal then
            text[#text-2] = " & ";
        end
        text[#text] = nil;  
     end
     end
      
      
     table.sort( new_list, comp );
     local result = table.concat(text) -- construct list
     for k, v in ipairs( new_list ) do
     if etal then
         new_list[k] = v[2];
         local etal_text = cfg.messages['et al'];
        result = result .. " " .. etal_text;
     end
     end
      
      
     return new_list;
    -- if necessary wrap result in <span> tag to format in Small Caps
    if ( "scap" == format ) then result =
        '<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>';
    end
     return result, count
end
end
 
 
-- Chooses one matching parameter from a list of parameters to consider
-- Generates a CITEREF anchor ID.
-- Generates an error if more than one match is present.
function anchorid( options )
function selectone( args, possible, error_condition, index )
    return "CITEREF" .. table.concat( options );
     local value = nil;
end
     local selected = '';
 
     local error_list = {};
-- Gets name list from the input arguments
function extractnames(args, list_name)
     local names = {};
     local i = 1;
     local last;
      
      
     if index ~= nil then index = tostring(index); end
     while true do
   
        last = selectone( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i );
    -- Handle special case of "#" replaced by empty string
        if not is_set(last) then
    if index == '1' then
            -- just in case someone passed in an empty parameter
         for _, v in ipairs( possible ) do
            break;
             v = v:gsub( "#", "" );
        end
             if is_set(args[v]) then
         names[i] = {
                if value ~= nil and selected ~= v then
             last = last,
                    table.insert( error_list, v );
             first = selectone( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i ),
                else
            link = selectone( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ),
                    value = args[v];
            mask = selectone( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i )
                    selected = v;
        };
                end
        i = i + 1;
            end
        end       
     end
     end
      
     return names;
     for _, v in ipairs( possible ) do
end
         if index ~= nil then
 
            v = v:gsub( "#", index );
-- Populates ID table from arguments using configuration settings
        end
function extractids( args )
         if is_set(args[v]) then
    local id_list = {};
            if value ~= nil and selected ~=  v then
     for k, v in pairs( cfg.id_handlers ) do  
                table.insert( error_list, v );
         v = selectone( args, v.parameters, 'redundant_parameters' );
            else
         if is_set(v) then id_list[k] = v; end
                value = args[v];
                selected = v;
            end
        end
     end
     end
   
     return id_list;
    if #error_list > 0 then
        local error_str = "";
        for _, k in ipairs( error_list ) do
            if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
            error_str = error_str .. wrap( 'parameter', k );
        end
        if #error_list > 1 then
            error_str = error_str .. cfg.messages['parameter-final-separator'];
        else
            error_str = error_str .. cfg.messages['parameter-pair-separator'];
        end
        error_str = error_str .. wrap( 'parameter', selected );
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
    end
   
     return value, selected;
end
end


-- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse
-- Takes a table of IDs and turns it into a table of formatted ID outputs.
-- the citation information.
function buildidlist( id_list, options )
function COinS(data)
     local new_list, handler = {};
     if 'table' ~= type(data) or nil == next(data) then
        return '';
    end
      
      
     local ctx_ver = "Z39.88-2004";
     function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end;
      
      
     -- treat table strictly as an array with only set values.
     for k, v in pairs( id_list ) do
    local OCinSoutput = setmetatable( {}, {
        -- fallback to read-only cfg
         __newindex = function(self, key, value)
        handler = setmetatable( { ['id'] = v }, fallback(k) );
             if is_set(value) then
       
                rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
        if handler.mode == 'external' then
             end
            table.insert( new_list, {handler.label, externallinkid( handler ) } );
         end
         elseif handler.mode == 'internal' then
     });
            table.insert( new_list, {handler.label, internallinkid( handler ) } );
        elseif handler.mode ~= 'manual' then
             error( cfg.messages['unknown_ID_mode'] );
        elseif k == 'DOI' then
            table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } );
        elseif k == 'ASIN' then
            table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } );
        elseif k == 'OL' then
            table.insert( new_list, {handler.label, openlibrary( v ) } );
        elseif k == 'PMC' then
            table.insert( new_list, {handler.label, pmc( v, options.Embargo ) } );
        elseif k == 'PMID' then
            table.insert( new_list, {handler.label, pmid( v ) } );
        elseif k == 'ISSN' then
        table.insert( new_list, {handler.label, issn( v ) } );
        elseif k == 'ISBN' then
            local ISBN = internallinkid( handler );
            if not checkisbn( v ) and not is_set(options.IgnoreISBN) then
                ISBN = ISBN .. seterror( 'bad_isbn', {}, false, " ", "" );
             end
            table.insert( new_list, {handler.label, ISBN } );               
         else
            error( cfg.messages['unknown_manual_ID'] );
        end
    end
      
    function comp( a, b ) -- used in following table.sort()
        return a[1] < b[1];
    end
      
      
     if is_set(data.Chapter) then
     table.sort( new_list, comp );
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
     for k, v in ipairs( new_list ) do
        OCinSoutput["rft.genre"] = "bookitem";
         new_list[k] = v[2];
        OCinSoutput["rft.btitle"] = data.Chapter;
        OCinSoutput["rft.atitle"] = data.Title;
     elseif is_set(data.Periodical) then
         OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
        OCinSoutput["rft.genre"] = "article";
        OCinSoutput["rft.jtitle"] = data.Periodical;
        OCinSoutput["rft.atitle"] = data.Title;
    else
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
        OCinSoutput["rft.genre"] = "book"
        OCinSoutput["rft.btitle"] = data.Title;
     end
     end
      
      
     OCinSoutput["rft.place"] = data.PublicationPlace;
     return new_list;
    OCinSoutput["rft.date"] = data.Date;
end
    OCinSoutput["rft.series"] = data.Series;
 
    OCinSoutput["rft.volume"] = data.Volume;
-- Chooses one matching parameter from a list of parameters to consider
    OCinSoutput["rft.issue"] = data.Issue;
-- Generates an error if more than one match is present.
     OCinSoutput["rft.pages"] = data.Pages;
function selectone( args, possible, error_condition, index )
     OCinSoutput["rft.edition"] = data.Edition;
     local value = nil;
     OCinSoutput["rft.pub"] = data.PublisherName;
     local selected = '';
     local error_list = {};
      
      
     for k, v in pairs( data.ID_list ) do
     if index ~= nil then index = tostring(index); end
        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;
     -- Handle special case of "#" replaced by empty string
     for k, v in ipairs( data.Authors ) do
     if index == '1' then
        last, first = v.last, v.first;
        for _, v in ipairs( possible ) do
        if k == 1 then
            v = v:gsub( "#", "" );
            if is_set(last) then
            if is_set(args[v]) then
                 OCinSoutput["rft.aulast"] = last;
                if value ~= nil and selected ~= v then
                    table.insert( error_list, v );
                 else
                    value = args[v];
                    selected = v;
                end
             end
             end
             if is_set(first) then  
        end       
                 OCinSoutput["rft.aufirst"] = first;
    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 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
     end
     end
      
      
     OCinSoutput.rft_id = data.URL;
     if #error_list > 0 then
    OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
        local error_str = "";
     OCinSoutput = setmetatable( OCinSoutput, nil );
        for _, k in ipairs( error_list ) do
            if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end
            error_str = error_str .. wrap( 'parameter', k );
        end
        if #error_list > 1 then
            error_str = error_str .. cfg.messages['parameter-final-separator'];
        else
            error_str = error_str .. cfg.messages['parameter-pair-separator'];
        end
        error_str = error_str .. wrap( 'parameter', selected );
        table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } );
     end
      
      
    -- sort with version string always first, and combine.
     return value, selected;
    table.sort( OCinSoutput );
    table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver );  -- such as "Z39.88-2004"
     return table.concat(OCinSoutput, "&");
end
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.
formatting.
function COinS(data)
]]
     if 'table' ~= type(data) or nil == next(data) then
function citation0( config, args)
        return '';
     --[[
     end
    Load Input Parameters
      
    The argment_wrapper facillitates the mapping of multiple
     local ctx_ver = "Z39.88-2004";
    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
     -- treat table strictly as an array with only set values.
    -- define different field names for the same underlying things.   
     local OCinSoutput = setmetatable( {}, {
     local Authors = A['Authors'];
        __newindex = function(self, key, value)
    local a = extractnames( args, 'AuthorList' );
            if is_set(value) then
 
                rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } );
    local Coauthors = A['Coauthors'];
            end
     local Others = A['Others'];
        end
     local Editors = A['Editors'];
     });
     local e = extractnames( args, 'EditorList' );
      
 
     if is_set(data.Chapter) then
    local Year = A['Year'];
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    local PublicationDate = A['PublicationDate'];
        OCinSoutput["rft.genre"] = "bookitem";
    local OrigYear = A['OrigYear'];
        OCinSoutput["rft.btitle"] = data.Chapter;
    local Date = A['Date'];
        OCinSoutput["rft.atitle"] = data.Title;
    local LayDate = A['LayDate'];
     elseif is_set(data.Periodical) then
    ------------------------------------------------- Get title data
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal";
    local Title = A['Title'];
        OCinSoutput["rft.genre"] = "article";
    local BookTitle = A['BookTitle'];
        OCinSoutput["rft.jtitle"] = data.Periodical;
    local Conference = A['Conference'];
        OCinSoutput["rft.atitle"] = data.Title;
     local TransTitle = A['TransTitle'];
     else
    local TitleNote = A['TitleNote'];
        OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book";
    local TitleLink = A['TitleLink'];
        OCinSoutput["rft.genre"] = "book"
    local Chapter = A['Chapter'];
        OCinSoutput["rft.btitle"] = data.Title;
    local ChapterLink = A['ChapterLink'];
     end
    local TransChapter = A['TransChapter'];
    local TitleType = A['TitleType'];
    local ArchiveURL = A['ArchiveURL'];
     local URL = A['URL']
    local URLorigin = A:ORIGIN('URL');
    local ChapterURL = A['ChapterURL'];
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
     local Periodical = A['Periodical'];
      
      
     if ( config.CitationClass == "encyclopaedia" ) then
     OCinSoutput["rft.place"] = data.PublicationPlace;
        if not is_set(Chapter) then
    OCinSoutput["rft.date"] = data.Date;
            if not is_set(Title) then
    OCinSoutput["rft.series"] = data.Series;
                Title = Periodical;
    OCinSoutput["rft.volume"] = data.Volume;
                Periodical = '';
    OCinSoutput["rft.issue"] = data.Issue;
            else
    OCinSoutput["rft.pages"] = data.Pages;
                Chapter = Title
    OCinSoutput["rft.edition"] = data.Edition;
                TransChapter = TransTitle
    OCinSoutput["rft.pub"] = data.PublisherName;
                Title = '';
   
                TransTitle = '';
    for k, v in pairs( data.ID_list ) do
             end
        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
     end
     end
    local Series = A['Series'];
    local Volume = A['Volume'];
    local Issue = A['Issue'];
    local Position = '';
    local Page, Pages, At, page_type;
      
      
     Page = A['Page'];
     local last, first;
     Pages = hyphentodash( A['Pages'] );
     for k, v in ipairs( data.Authors ) do
    At = A['At'];
        last, first = v.last, v.first;
   
        if k == 1 then
    if is_set(Page) then
            if is_set(last) then
        if is_set(Pages) or is_set(At) then
                OCinSoutput["rft.aulast"] = last;
            Page = Page .. " " .. seterror('extra_pages');
            end
            Pages = '';
            if is_set(first) then  
             At = '';
                OCinSoutput["rft.aufirst"] = first;
             end
         end
         end
    elseif is_set(Pages) then
        if is_set(last) and is_set(first) then
        if is_set(At) then
             OCinSoutput["rft.au"] = table.concat{ last, ", ", first };
             Pages = Pages .. " " .. seterror('extra_pages');
        elseif is_set(last) then
             At = '';
             OCinSoutput["rft.au"] = last;
         end
         end
     end  
     end
      
      
     local Edition = A['Edition'];
     OCinSoutput.rft_id = data.URL;
     local PublicationPlace = A['PublicationPlace']
     OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage };
     local Place = A['Place'];
     OCinSoutput = setmetatable( OCinSoutput, nil );
      
      
     if not is_set(PublicationPlace) and is_set(Place) then
     -- sort with version string always first, and combine.
        PublicationPlace = Place;
    table.sort( OCinSoutput );
     end
    table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver ); -- such as "Z39.88-2004"
   
     return table.concat(OCinSoutput, "&");
    if PublicationPlace == Place then Place = ''; end
end
   
 
    local PublisherName = A['PublisherName'];
--[[
    local SubscriptionRequired = A['SubscriptionRequired'];
This is the main function doing the majority of the citation
    local Via = A['Via'];
formatting.
    local AccessDate = A['AccessDate'];
]]
    local ArchiveDate = A['ArchiveDate'];
function citation0( config, args)
    local Agency = A['Agency'];
     --[[  
     local DeadURL = A['DeadURL']
     Load Input Parameters
    local Language = A['Language'];
     The argment_wrapper facillitates the mapping of multiple
     local Format = A['Format'];
     aliases to single internal variable.
     local Ref = A['Ref'];
     ]]
      
     local A = argument_wrapper( args );
     local DoiBroken = A['DoiBroken'];
    local ID = A['ID'];
     local ASINTLD = A['ASINTLD'];
    local IgnoreISBN = A['IgnoreISBN'];


     local ID_list = extractids( args );
     local i
    local PPrefix = A['PPrefix']
    local PPPrefix = A['PPPrefix']
    if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end
      
      
     local Quote = A['Quote'];
     -- Pick out the relevant fields from the arguments.  Different citation templates
    local PostScript = A['PostScript'];
     -- define different field names for the same underlying things.   
    local LayURL = A['LayURL'];
     local Authors = A['Authors'];
     local LaySource = A['LaySource'];
     local a = extractnames( args, 'AuthorList' );
     local Transcript = A['Transcript'];
     local TranscriptURL = A['TranscriptURL']
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
    local sepc = A['Separator'];
    local LastAuthorAmp = A['LastAuthorAmp'];
    local no_tracking_cats = A['NoTracking'];


     local use_lowercase = ( sepc ~= '.' );
     local Coauthors = A['Coauthors'];
     local this_page = mw.title.getCurrentTitle(); --Also used for COinS
     local Others = A['Others'];
      
     local Editors = A['Editors'];
     if not is_set(no_tracking_cats) then
     local e = extractnames( args, 'EditorList' );
        for k, v in pairs( cfg.uncategorized_namespaces ) do
            if this_page.nsText == v then
                no_tracking_cats = "true";
                break;
            end
        end
    end


     if ( config.CitationClass == "journal" ) then
     local Year = A['Year'];
        if not is_set(URL) and is_set(ID_list['PMC']) then
    local PublicationDate = A['PublicationDate'];
            local Embargo = A['Embargo'];
    local OrigYear = A['OrigYear'];
            if is_set(Embargo) then
    local Date = A['Date'];
                local lang = mw.getContentLanguage();
    local LayDate = A['LayDate'];
                local good1, result1, good2, result2;
    ------------------------------------------------- Get title data
                good1, result1 = pcall( lang.formatDate, lang, 'U', Embargo );
    local Title = A['Title'];
                good2, result2 = pcall( lang.formatDate, lang, 'U' );
    local BookTitle = A['BookTitle'];
               
    local Conference = A['Conference'];
                if good1 and good2 and tonumber( result1 ) < tonumber( result2 ) then
    local TransTitle = A['TransTitle'];
                    URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
    local TitleNote = A['TitleNote'];
                    URLorigin = cfg.id_handlers['PMC'].parameters[1];
    local TitleLink = A['TitleLink'];
                end
    local Chapter = A['Chapter'];
            else
    local ChapterLink = A['ChapterLink'];
                URL = "http://www.ncbi.nlm.nih.gov/pmc/articles/PMC" .. ID_list['PMC'];
    local TransChapter = A['TransChapter'];
                URLorigin = cfg.id_handlers['PMC'].parameters[1];
    local TitleType = A['TitleType'];
            end
    local Degree = A['Degree'];
        end
    local Docket = A['Docket'];
     end
    local ArchiveURL = A['ArchiveURL'];
    local URL = A['URL']
    local URLorigin = A:ORIGIN('URL');
    local ChapterURL = A['ChapterURL'];
    local ChapterURLorigin = A:ORIGIN('ChapterURL');
    local ConferenceURL = A['ConferenceURL'];
    local ConferenceURLorigin = A:ORIGIN('ConferenceURL');
     local Periodical = A['Periodical'];


    -- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
--[[
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
|encyclopedia and |article then map |encyclopedia to |title
|encyclopedia then map |encyclopedia to |title
 
|trans_title maps to |trans_chapter when |title is re-mapped
 
All other combinations of |encyclopedia, |title, and |article are not modified
]]
if ( config.CitationClass == "encyclopaedia" ) then
if is_set(Periodical) then -- Periodical is set when |encyclopedia is set
if is_set(Title) then
if not is_set(Chapter) then
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
TransChapter = TransTitle;
Title = Periodical;
Periodical = ''; -- redundant so unset
TransTitle = ''; -- redundant so unset
end
else -- |title not set
Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
Periodical = ''; -- redundant so unset
end
end
end
 
local Series = A['Series'];
    local Volume = A['Volume'];
    local Issue = A['Issue'];
    local Position = '';
    local Page, Pages, At, page_type;
   
    Page = A['Page'];
    Pages = hyphentodash( A['Pages'] );
    At = A['At'];
      
      
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
     if is_set(Page) then
     if is_set(BookTitle) then
         if is_set(Pages) or is_set(At) then
         Chapter = Title;
            Page = Page .. " " .. seterror('extra_pages');
        ChapterLink = TitleLink;
            Pages = '';
        TransChapter = TransTitle;
            At = '';
        Title = BookTitle;
        end
        TitleLink = '';
     elseif is_set(Pages) then
        TransTitle = '';
        if is_set(At) then
    end
            Pages = Pages .. " " .. seterror('extra_pages');
     -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
            At = '';
    if config.CitationClass == "episode" then
         end
        local AirDate = A['AirDate'];
    end   
        local SeriesLink = A['SeriesLink'];
   
         local Season = A['Season'];
    local Edition = A['Edition'];
        local SeriesNumber = A['SeriesNumber'];
    local PublicationPlace = A['PublicationPlace']
        local Network = A['Network'];
    local Place = A['Place'];
        local Station = A['Station'];
   
        local s, n = {}, {};
    if not is_set(PublicationPlace) and is_set(Place) then
        local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
         PublicationPlace = Place;
       
        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
      
      
     -- COinS metadata (see <http://ocoins.info/>) for
     if PublicationPlace == Place then Place = ''; end
     -- automated parsing of citation information.
      
     local OCinSoutput = COinS{
     local PublisherName = A['PublisherName'];
        ['Periodical'] = Periodical,
    local RegistrationRequired = A['RegistrationRequired'];
        ['Chapter'] = Chapter,
    local SubscriptionRequired = A['SubscriptionRequired'];
        ['Title'] = Title,
    local Via = A['Via'];
        ['PublicationPlace'] = PublicationPlace,
    local AccessDate = A['AccessDate'];
        ['Date'] = first_set(Date, Year, PublicationDate),
    local ArchiveDate = A['ArchiveDate'];
        ['Series'] = Series,
    local Agency = A['Agency'];
        ['Volume'] = Volume,
    local DeadURL = A['DeadURL']
        ['Issue'] = Issue,
    local Language = A['Language'];
        ['Pages'] = first_set(Page, Pages, At),
    local Format = A['Format'];
        ['Edition'] = Edition,
    local Ref = A['Ref'];
        ['PublisherName'] = PublisherName,
   
        ['URL'] = first_set( URL, ChapterURL ),
    local DoiBroken = A['DoiBroken'];
        ['Authors'] = a,
        ['ID_list'] = ID_list,
-- Special case for cite techreport.
        ['RawPage'] = this_page.prefixedText,
local ID = A['ID'];
     };
if (config.CitationClass == "techreport") then -- special case for cite techreport
if is_set(Issue) then -- cite techreport uses 'number', which other citations aliase to 'issue'
if not is_set(ID) then -- can we use ID for the "number"?
ID = Issue; -- yes, use it
Issue = ""; -- unset Issue so that "number" isn't duplicated in the rendered citation or COinS metadata
else -- can't use ID so emit error message
ID = ID .. " " .. seterror('redundant_parameters', '<code>&#124;id=</code> and <code>&#124;number=</code>');
end
end
end
    local ASINTLD = A['ASINTLD'];
    local IgnoreISBN = A['IgnoreISBN'];
     local Embargo = A['Embargo'];


     if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
     local ID_list = extractids( args );
        Chapter = Title;
   
        ChapterLink = TitleLink;
    local Quote = A['Quote'];
        TransChapter = TransTitle;
    local PostScript = A['PostScript'];
        Title = '';
    local LayURL = A['LayURL'];
        TitleLink = '';
    local LaySource = A['LaySource'];
        TransTitle = '';
    local Transcript = A['Transcript'];
    local TranscriptURL = A['TranscriptURL']
    local TranscriptURLorigin = A:ORIGIN('TranscriptURL');
    local sepc = A['Separator'];
    local LastAuthorAmp = A['LastAuthorAmp'];
    local no_tracking_cats = A['NoTracking'];
 
    local use_lowercase = ( sepc ~= '.' );
    local this_page = mw.title.getCurrentTitle();  --Also used for COinS and for language
   
    if not is_set(no_tracking_cats) then
        for k, v in pairs( cfg.uncategorized_namespaces ) do
            if this_page.nsText == v then
                no_tracking_cats = "true";
                break;
            end
        end
     end
     end


    -- Now perform various field substitutions.
local anchor_year; -- used in the CITEREF identifier
    -- We also add leading spaces and surrounding markup and punctuation to the
local COinS_date; -- used in the COinS metadata
    -- various parts of the citation, but only when they are non-nil.
 
    if not is_set(Authors) then
-- legacy: promote concatenation of |day=, |month=, and |year= to Date if Date not set; or, promote PublicationDate to Date if neither Date nor Year are set.
        local Maximum = tonumber( A['DisplayAuthors'] );
if not is_set(Date) then
       
Date = Year; -- promote Year to Date
        -- Preserve old-style implicit et al.
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
        if not is_set(Maximum) and #a == 9 then  
if is_set(Date) then
            Maximum = 8;
local Month = A['Month'];
            table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
if is_set(Month) then
        elseif not is_set(Maximum) then
Date = Month .. " " .. Date;
            Maximum = #a + 1;
local Day = A['Day']
        end
if is_set(Day) then Date = Day .. " " .. Date end
           
end
        local control = {  
elseif is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
            sep = A["AuthorSeparator"] .. " ",
Date = PublicationDate; -- promonte PublicationDate to Date
            namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
PublicationDate = ''; -- unset, no longer needed
            format = A["AuthorFormat"],
end
            maximum = Maximum,
end
            lastauthoramp = LastAuthorAmp
 
        };
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
       
 
        -- If the coauthor field is also used, prevent ampersand and et al. formatting.
-- Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates.
        if is_set(Coauthors) then
-- TODO: 2013-10-27: AirDate is nil when dates() is called because it hasn't been set yet.  Move the call to dates() or set AirDate earlier.
            control.lastauthoramp = nil;
anchor_year, COinS_date = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken,
            control.maximum = #a + 1;
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year});
         end
 
          
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
         Authors = listpeople(control, a)
 
--Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set
if config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
if not is_embargoed(Embargo) then
URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed
URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=
end
end
 
    -- Account for the oddity that is {{cite conference}}, before generation of COinS data.
    if is_set(BookTitle) then
        Chapter = Title;
        ChapterLink = TitleLink;
        TransChapter = TransTitle;
         Title = BookTitle;
         TitleLink = '';
         TransTitle = '';
     end
     end
 
     -- Account for the oddity that is {{cite episode}}, before generation of COinS data.
     local EditorCount
     if config.CitationClass == "episode" then
     if not is_set(Editors) then
         local AirDate = A['AirDate'];
         local Maximum = tonumber( A['DisplayEditors'] );
         local SeriesLink = A['SeriesLink'];
         -- Preserve old-style implicit et al.
         local Season = A['Season'];
         if not is_set(Maximum) and #e == 4 then
        local SeriesNumber = A['SeriesNumber'];
            Maximum = 3;
        local Network = A['Network'];
            table.insert( z.message_tail, { seterror('implict_etal_editor', {}, true) } );
        local Station = A['Station'];
         elseif not is_set(Maximum) then
        local s, n = {}, {};
            Maximum = #e + 1;
         local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " ";
         end
          
 
         if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end
         local control = {
        if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end
            sep = A["EditorSeparator"] .. " ",
        if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end
            namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
        if is_set(Network) then table.insert(n, Network); end
            format = A['EditorFormat'],
        if is_set(Station) then table.insert(n, Station); end
            maximum = Maximum,
       
            lastauthoramp = LastAuthorAmp
        Date = Date or AirDate;
         };
        Chapter = Title;
 
        ChapterLink = TitleLink;
         Editors, EditorCount = listpeople(control, e);
        TransChapter = TransTitle;
    else
        Title = Series;
         EditorCount = 1;
        TitleLink = SeriesLink;
         TransTitle = '';
       
         Series = table.concat(s, Sep);
         ID = table.concat(n, Sep);
     end
     end
 
   
     local Cartography = "";
     -- COinS metadata (see <http://ocoins.info/>) for
     local Scale = "";
     -- automated parsing of citation information.
     if config.CitationClass == "map" then
     local OCinSoutput = COinS{
         if not is_set( Authors ) and is_set( PublisherName ) then
         ['Periodical'] = Periodical,
            Authors = PublisherName;
        ['Chapter'] = Chapter,
            PublisherName = "";
         ['Title'] = Title,
         end
         ['PublicationPlace'] = PublicationPlace,
         Cartography = A['Cartography'];
         ['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?
         if is_set( Cartography ) then
        ['Series'] = Series,
            Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
         ['Volume'] = Volume,
         end       
         ['Issue'] = Issue,
         Scale = A['Scale'];
         ['Pages'] = first_set(Page, Pages, At),
         if is_set( Scale ) then
        ['Edition'] = Edition,
            Scale = sepc .. " " .. Scale;
         ['PublisherName'] = PublisherName,
         end       
        ['URL'] = first_set( URL, ChapterURL ),
    end
         ['Authors'] = a,
   
         ['ID_list'] = ID_list,
    if not is_set(Date) then
        ['RawPage'] = this_page.prefixedText,
         Date = Year;
     };
         if is_set(Date) then
 
            local Month = A['Month'];
     if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then
            if is_set(Month) then
         Chapter = Title;
                Date = Month .. " " .. Date;
        ChapterLink = TitleLink;
                local Day = A['Day']
        TransChapter = TransTitle;
                if is_set(Day) then Date = Day .. " " .. Date end
        Title = '';
            end
        TitleLink = '';
        end
         TransTitle = '';
     end
   
     if inArray(PublicationDate, {Date, Year}) then PublicationDate = ''; end
    if not is_set(Date) and is_set(PublicationDate) then
         Date = PublicationDate;
         PublicationDate = '';
     end
     end


     -- Captures the value for Date prior to adding parens or other textual transformations
     -- Now perform various field substitutions.
     local DateIn = Date;
     -- 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(URL) and
     if not is_set(Authors) then
         not is_set(ChapterURL) and
         local Maximum = tonumber( A['DisplayAuthors'] );
        not is_set(ArchiveURL) and
        not is_set(ConferenceURL) and
        not is_set(TranscriptURL) then
          
          
         -- Test if cite web is called without giving a URL
         -- Preserve old-style implicit et al.
         if ( config.CitationClass == "web" ) then
         if not is_set(Maximum) and #a == 9 then  
             table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
            Maximum = 8;
         end
             table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } );
        elseif not is_set(Maximum) then
            Maximum = #a + 1;
         end
           
        local control = {
            sep = A["AuthorSeparator"] .. " ",
            namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ",
            format = A["AuthorFormat"],
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
        };
          
          
         -- Test if accessdate is given without giving a URL
         -- If the coauthor field is also used, prevent ampersand and et al. formatting.
         if is_set(AccessDate) then
         if is_set(Coauthors) then
             table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
             control.lastauthoramp = nil;
             AccessDate = '';
             control.maximum = #a + 1;
         end
         end
          
          
         -- Test if format is given without giving a URL
         Authors = listpeople(control, a)
         if is_set(Format) then
    end
             Format = Format .. seterror( 'format_missing_url' );
 
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
         end
        local control = {
            sep = A["EditorSeparator"] .. " ",
            namesep = (first_set(A["EditorNameSeparator"], A["NameSeparator"]) or "") .. " ",
            format = A['EditorFormat'],
            maximum = Maximum,
            lastauthoramp = LastAuthorAmp
        };
        Editors, EditorCount = listpeople(control, e);
    else
        EditorCount = 1;
     end
     end
      
 
     -- Test if citation has no title
     local Cartography = "";
     if not is_set(Chapter) and
     local Scale = "";
         not is_set(Title) and
     if config.CitationClass == "map" then
        not is_set(Periodical) and
         if not is_set( Authors ) and is_set( PublisherName ) then
         not is_set(Conference) and
            Authors = PublisherName;
         not is_set(TransTitle) and
            PublisherName = "";
         not is_set(TransChapter) then
         end
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
         Cartography = A['Cartography'];
         if is_set( Cartography ) then
            Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase );
        end       
        Scale = A['Scale'];
        if is_set( Scale ) then
            Scale = sepc .. " " .. Scale;
        end       
     end
     end
      
      
     Format = is_set(Format) and " (" .. Format .. ")" or "";
     if  not is_set(URL) and
   
        not is_set(ChapterURL) and
    local OriginalURL = URL
        not is_set(ArchiveURL) and
    DeadURL = DeadURL:lower();
        not is_set(ConferenceURL) and
    if is_set( ArchiveURL ) then
        not is_set(TranscriptURL) then
         if ( DeadURL ~= "no" ) then
       
             URL = ArchiveURL
        -- Test if cite web or cite podcast |url= is missing or empty
            URLorigin = A:ORIGIN('ArchiveURL')
if inArray(config.CitationClass, {"web","podcast"}) then
table.insert( z.message_tail, { seterror( 'cite_web_url', {}, true ) } );
end
       
        -- Test if accessdate is given without giving a URL
        if is_set(AccessDate) then
            table.insert( z.message_tail, { seterror( 'accessdate_missing_url', {}, true ) } );
            AccessDate = '';
        end
       
        -- Test if format is given without giving a URL
         if is_set(Format) then
             Format = Format .. seterror( 'format_missing_url' );
         end
         end
     end
     end
      
      
     -- Format chapter / article title
    -- Test if citation has no title
     if is_set(Chapter) and is_set(ChapterLink) then  
    if  not is_set(Chapter) and
        not is_set(Title) and
        not is_set(Periodical) and
        not is_set(Conference) and
        not is_set(TransTitle) and
        not is_set(TransChapter) then
        table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } );
    end
   
    Format = is_set(Format) and " (" .. Format .. ")" or "";
   
    local OriginalURL = URL
    DeadURL = DeadURL:lower();
    if is_set( ArchiveURL ) then
        if ( DeadURL ~= "no" ) then
            URL = ArchiveURL
            URLorigin = A:ORIGIN('ArchiveURL')
        end
    end
   
     -- Format chapter / article title
     if is_set(Chapter) and is_set(ChapterLink) then  
         Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
         Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]";
     end
     end
Line 1,122: Line 1,549:
         TransChapter = wrap( 'trans-italic-title', TransChapter );
         TransChapter = wrap( 'trans-italic-title', TransChapter );
     else
     else
Chapter = kern_quotes (Chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
         Chapter = wrap( 'quoted-title', Chapter );
         Chapter = wrap( 'quoted-title', Chapter );
         TransChapter = wrap( 'trans-quoted-title', TransChapter );
         TransChapter = wrap( 'trans-quoted-title', TransChapter );
Line 1,169: Line 1,597:
      
      
     if is_set(Periodical) then
     if is_set(Periodical) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
         Title = wrap( 'quoted-title', Title );
         Title = wrap( 'quoted-title', Title );
         TransTitle = wrap( 'trans-quoted-title', TransTitle );
         TransTitle = wrap( 'trans-quoted-title', TransTitle );
     elseif inArray(config.CitationClass, {"web","news","pressrelease","conference"}) and
     elseif inArray(config.CitationClass, {"web","news","pressrelease","conference","podcast"}) and
             not is_set(Chapter) then
             not is_set(Chapter) then
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks
         Title = wrap( 'quoted-title', Title );
         Title = wrap( 'quoted-title', Title );
         TransTitle = wrap( 'trans-quoted-title', TransTitle );
         TransTitle = wrap( 'trans-quoted-title', TransTitle );
Line 1,239: Line 1,669:
         if is_set(Pages) then
         if is_set(Pages) then
             if is_set(Periodical) and
             if is_set(Periodical) and
                 not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then
                 not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
                 Pages = ": " .. Pages;
                 Pages = ": " .. Pages;
             elseif tonumber(Pages) ~= nil then
             elseif tonumber(Pages) ~= nil then
Line 1,249: Line 1,679:
     else
     else
         if is_set(Periodical) and
         if is_set(Periodical) and
             not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then
             not inArray(config.CitationClass, {"encyclopaedia","web","book","news","podcast"}) then
             Page = ": " .. Page;
             Page = ": " .. Page;
         else
         else
Line 1,280: Line 1,710:
         At = At .. Section .. Inset;         
         At = At .. Section .. Inset;         
     end     
     end     
   
 
    Others = is_set(Others) and (sepc .. " " .. Others) or "";
--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them.  If a match is found,
    TitleType = is_set(TitleType) and (" (" .. TitleType .. ")") or "";
use that value; if not, then use the value that was provided with the language parameter.
    TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
    Language = is_set(Language) and (" " .. wrap( 'language', Language )) or "";
Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English).
     Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
]]
     Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
if is_set (Language) then
-- local name = mw.language.fetchLanguageName( Language:lower(), "en" ); -- experiment: this seems to return correct ISO 639-1 language names
local name = cfg.iso639_1[Language:lower()]; -- get the language name if Language parameter has a valid iso 639-1 code
if nil == name then
Language=" " .. wrap( 'language', Language ); -- no match, use parameter's value
else
if 0 == this_page.namespace and 'en' ~= Language:lower() then --found a match; is this page main / article space and English not the language?
Language=" " .. wrap( 'language', name .. '[[Category:Articles with ' .. name .. '-language external links]]' ); -- in main space and not English: categorize
else
Language=" " .. wrap( 'language', name ); --not in mainspace or language is English so don't categorize
end
end
else
Language=""; -- language not specified so make sure this is an empty string;
end
 
Others = is_set(Others) and (sepc .. " " .. Others) or "";
 
-- handle type parameter for those CS1 citations that have default values
 
if inArray(config.CitationClass, {"podcast","pressrelease","techreport","thesis"}) then
TitleType = set_titletype (config.CitationClass, TitleType);
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. " thesis";
end
end
 
if is_set(TitleType) then -- if type parameter is specified
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses
end
 
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
     Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or "";
     Issue = is_set(Issue) and (" (" .. Issue .. ")") or "";
     Series = is_set(Series) and (sepc .. " " .. Series) or "";
     Series = is_set(Series) and (sepc .. " " .. Series) or "";
     OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
     OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or "";
Line 1,299: Line 1,762:
      
      
     ------------------------------------ totally unrelated data
     ------------------------------------ totally unrelated data
     -- Mimic {{subscription required}} template;  
     --[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist
    behind a registration or paywall.  So here, we've chosen to decouple via from subscription (via has never been part of the registration required template).
   
    Subscription implies paywall; Registration does not.  If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition.
    ]]
     if is_set(Via) then
     if is_set(Via) then
         Via = " " .. wrap( 'via', Via );
         Via = " " .. wrap( 'via', Via );
         SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --citation always requires subscription if 'via' parameter is used
    end
     elseif is_set(SubscriptionRequired) then
 
         SubscriptionRequired = sepc .. " " .. cfg.messages['subscription_no_via']; --here when 'via' parameter not used but 'subscription' is
if is_set(SubscriptionRequired) then
         SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is
     elseif is_set(RegistrationRequired) then
         SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is
     end
     end


Line 1,315: Line 1,785:
      
      
     if is_set(ID) then ID = sepc .." ".. ID; end
     if is_set(ID) then ID = sepc .." ".. ID; end
  if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
end
      
      
     ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN} );
     ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} );


     if is_set(URL) then
     if is_set(URL) then
Line 1,385: Line 1,859:
     local Publisher;
     local Publisher;
     if is_set(Periodical) and
     if is_set(Periodical) and
         not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease"}) then
         not inArray(config.CitationClass, {"encyclopaedia","web","pressrelease","podcast"}) then
         if is_set(PublisherName) then
         if is_set(PublisherName) then
             if is_set(PublicationPlace) then
             if is_set(PublicationPlace) then
Line 1,409: Line 1,883:
     else
     else
         if is_set(PublicationDate) then
         if is_set(PublicationDate) then
             PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
             PublicationDate = " (" .. wrap( 'published', PublicationDate ) .. ")";
         end
         end
         if is_set(PublisherName) then
         if is_set(PublisherName) then
             if is_set(PublicationPlace) then
             if is_set(PublicationPlace) then
                 Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
                 Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
             else
             else
                 Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
                 Publisher = sepc .. " " .. PublisherName .. PublicationDate;   
             end             
             end             
         elseif is_set(PublicationPlace) then  
         elseif is_set(PublicationPlace) then  
             Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
             Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
         else  
         else  
             Publisher = PublicationDate;
             Publisher = PublicationDate;
         end
         end
     end
     end
      
      
     -- Several of the above rely upon detecting this as nil, so do it last.
     -- Several of the above rely upon detecting this as nil, so do it last.
     if is_set(Periodical) then
     if is_set(Periodical) then
         if is_set(Title) or is_set(TitleNote) then  
         if is_set(Title) or is_set(TitleNote) then  
             Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
             Periodical = sepc .. " " .. wrap( 'italic-title', Periodical )  
         else  
         else  
             Periodical = wrap( 'italic-title', Periodical )
             Periodical = wrap( 'italic-title', Periodical )
         end
         end
     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.
     -- Piece all bits together at last.  Here, all should be non-nil.
Line 1,530: Line 2,017:


     -- Now enclose the whole thing in a <span/> element
     -- Now enclose the whole thing in a <span/> element
    if not is_set(Year) then
        if is_set(DateIn) then
            Year = selectyear( DateIn );
        elseif is_set(PublicationDate) then
            Year = selectyear( PublicationDate );
        end
    end
   
     local options = {};
     local options = {};
      
      
Line 1,561: Line 2,040:
                 end
                 end
             end
             end
            names[ #names + 1 ] = Year;
names[ #names + 1 ] = first_set(Year, anchor_year); -- Year first for legacy citations
             id = anchorid(names)
             id = anchorid(names)
         end
         end
14,061

edits

Navigation menu