Module:Citation/CS1: Difference between revisions
Synch from sandbox; Migrate cite thesis and cite techreport; ISBN & ISSN tweaks; Deprecated parameter tracking; Add date validation;
m>Trappist the monk (ISSN error detection; Expand uncategorized namespaces; Reg/Sub required msg tweak; Trap coauthors without authors; Hide error messages;) |
m>Trappist the monk (Synch from sandbox; Migrate cite thesis and cite techreport; ISBN & ISSN tweaks; Deprecated parameter tracking; Add date validation;) |
||
Line 6: | Line 6: | ||
-- Include translation message hooks, ID and error handling configuration settings. | -- Include translation message hooks, ID and error handling configuration settings. | ||
local cfg = mw.loadData( 'Module:Citation/CS1/Configuration' ); | local cfg = mw.loadData( 'Module:Citation/CS1/Configuration/sandbox' ); | ||
-- Contains a list of all recognized parameters | -- Contains a list of all recognized parameters | ||
local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist' ); | local whitelist = mw.loadData( 'Module:Citation/CS1/Whitelist/sandbox' ); | ||
-- Whether variable is set or not | -- Whether variable is set or not | ||
Line 37: | Line 37: | ||
end | end | ||
return false; | return false; | ||
end | |||
-- Add this page to the deprecated parameter tracking category | |||
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.error_categories, "Pages containing cite templates with deprecated parameters" ); -- add page to category | |||
end | |||
end | end | ||
Line 307: | Line 315: | ||
]] | ]] | ||
function issn(id) | function issn(id) | ||
local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate | local issn_copy = id; -- save a copy of unadulterated issn; use this version for display if issn does not validate | ||
local handler = cfg.id_handlers['ISSN']; | local handler = cfg.id_handlers['ISSN']; | ||
local text; | local text; | ||
local valid_issn = true; | local valid_issn = true; | ||
id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and ndashes from the issn | id=id:gsub( "[%s-–]", "" ); -- strip spaces, hyphens, and ndashes from the issn | ||
if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 didgits long, containing only 0-9 or X in the last position | if 8 ~= id:len() or nil == id:match( "^%d*X?$" ) then -- validate the issn: 8 didgits long, containing only 0-9 or X in the last position | ||
valid_issn=false; -- wrong length or improper character | valid_issn=false; -- wrong length or improper character | ||
else | else | ||
valid_issn=is_valid_isxn(id, 8); -- validate issn | |||
end | end | ||
if true == valid_issn then | if true == valid_issn then | ||
id = | id = string.sub( id, 1, 4 ) .. "-" .. string.sub( id, 5 ); -- if valid, display correctly formatted version | ||
else | else | ||
id = issn_copy; -- if not valid, use the show the invalid issn with error message | id = issn_copy; -- if not valid, use the show the invalid issn with error message | ||
Line 347: | Line 344: | ||
end | end | ||
-- returns a number according to the month in a date 1 for January, etc. If not a valid month, returns 0 | |||
function get_month_number (month) | |||
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}; | |||
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}; | |||
local temp; | |||
temp=long_months[month:lower()]; | |||
if temp then return temp; end -- if month is the long-form name | |||
temp=short_months[month:lower()]; | |||
if temp then return temp; end -- if month is the short-form name | |||
return 0; -- misspelled or not a month name | |||
end | |||
-- returns true if date has one of the five seasons. Else false. | |||
function is_valid_season (season) | |||
if inArray( season, {'winter', 'spring', 'summer', 'fall', 'autumn'} ) then | |||
return true; | |||
end | |||
return false; | |||
end | |||
--[[ | --[[ | ||
Returns true if day is less than or equal to the number of days in month; else returns false. | |||
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. | |||
Where the two calendars overlap (1582 to approximately 1923) dates are assumed to be Gregorian. | |||
the | |||
]] | ]] | ||
function | function is_valid_date (year, month, day) | ||
local days_in_month = {31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31}; | |||
local month_length; | |||
if (2==month) then -- if February | |||
month_length = 28; -- then 28 days unless | |||
if 1582 > tonumber(year) then -- Julian calendar | |||
if 0==(year%4) then | |||
month_length = 29; | |||
end | |||
else -- Gregorian calendar | |||
if (0==(year%4) and (0~=(year%100) or 0==(year%400))) then -- date specifies 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 | end | ||
-- | --Check a pair of months or seasons to see if both are valid members of a month or season pair. | ||
-- | |||
function is_valid_month_season_range(range_start, range_end) | |||
if 0 == get_month_number (range_start:lower()) then -- is this a month range? | |||
if true == is_valid_season (range_start:lower()) then -- not a month range, is this a season range? | |||
return is_valid_season (range_end:lower()); -- range_start is season; return true if range_end also a season; else false | |||
end | |||
return false; -- range_start is not a month or a season | |||
end | |||
if 0 == get_month_number (range_end:lower()) then -- range_start is a month; is range_end also a month? | |||
return false; -- not a month range | |||
end | |||
return true; | |||
end | end | ||
-- | --[[ | ||
function | 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. | ||
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. | |||
end | 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 disambiguators if any | |||
]] | |||
function check_date (date_string) | |||
local year; | |||
local month; | |||
local day; | |||
local anchor_year; | |||
local coins_date; | |||
if date_string:match("^%d%d%d%d%-%d%d%-%d%d$") then -- Year-initial numerical year month day format | |||
coins_date = date_string:match("%d%d%d%d%-%d%d%-%d%d"); | |||
year, month, day=string.match(date_string, "(%d%d%d%d)%-(%d%d)%-(%d%d)"); | |||
anchor_year = year; | |||
month=tonumber(month); | |||
if 12 < month or 1 > month then return false; end | |||
elseif date_string:match("^%a+%s*%d%d*%s*,%s*%d%d%d%d%a?$") then -- month-initial: month day, year | |||
coins_date = date_string:match("%a+%s*%d%d*%s*,%s*%d%d%d%d"); | |||
month, day, anchor_year, year=string.match(date_string, "(%a+)%s*(%d%d*)%s*,%s*((%d%d%d%d)%a?)"); | |||
month = get_month_number (month:lower()); | |||
if 0 == month then return false; end -- return false if month text isn't one of the twelve months | |||
elseif date_string:match("^%d%d*%s*%a+%s*%d%d%d%d%a?$") then -- date-initial: day month year | |||
coins_date = date_string:match("%d%d*%s*%a+%s*%d%d%d%d"); | |||
day, month, anchor_year, year=string.match(date_string, "(%d%d*)%s*(%a+)%s*((%d%d%d%d)%a?)"); | |||
month = get_month_number (month:lower()); | |||
if 0 == month then return false; end -- return false if month text isn't one of the twelve months | |||
elseif mw.ustring.match (date_string, "^%a+%s*[%s%-/–]%s*%a+%s*%d%d%d%d%a?$") then -- month/season range year | |||
local month2 | |||
coins_date = mw.ustring.match (date_string, "%a+%s*[%s%-/–]%s*%a+%s*%d%d%d%d"); | |||
coins_date= mw.ustring.gsub( coins_date, "–", "-" ); -- replace ndash with hyphen | |||
month, month2, anchor_year, year=mw.ustring.match (date_string, "(%a+)%s*[%s%-/–]%s*(%a+)%s*((%d%d%d%d)%a?)"); | |||
day=0; -- mark day as not used | |||
if false == is_valid_month_season_range(month, month2) then | |||
return false; | |||
end | |||
elseif date_string:match("^%a+%s*%d%d%d%d%a?$") then -- month/season year | |||
coins_date = date_string:match("%a+%s*%d%d%d%d"); | |||
month, anchor_year, year=string.match(date_string, "(%a+)%s*((%d%d%d%d)%a?)"); | |||
day=0; -- mark day as not used | |||
local season=month; -- copy | |||
month = get_month_number (month:lower()); | |||
if month == 0 then -- if month text isn't one of the twelve months, might be a season | |||
if false == is_valid_season (season:lower()) then | |||
return false; -- return false not a month or one of the five seasons | |||
end | |||
end | |||
elseif date_string:match("^%d%d%d%d?%a?$") then -- year; here accept either YYY or YYYY | |||
coins_date = date_string:match("^%d%d%d%d?"); | |||
anchor_year, year=string.match(date_string, "((%d%d%d%d?)%a?)"); | |||
month, day = 0, 0; -- mark day and month as not used | |||
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 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 | |||
return true, anchor_year, coins_date; -- format is good and date string represents a real date | |||
end | |||
--[[ | |||
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%.%s%d%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%.%s%d%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("^%d%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 .. "|" .. 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 | end | ||
-- | --[[ | ||
Determines whether an 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 | end | ||
-- | -- Removes irrelevant text and dashes from ISBN number | ||
-- Similar to that used for Special:BookSources | |||
function cleanisbn( isbn_str ) | |||
] | return isbn_str:gsub( "[^-0-9X]", "" ); | ||
end | |||
--[[ | |||
ISBN-10 and ISSN validator code calculates checksum across all isbn/issn digits including the check digit. If the number is valid the result will be 0. | |||
Before calling this function, issbn/issn must be checked for length and stripped of dashes, spaces and other non-isxn characters. | |||
]] | |||
function is_valid_isxn (isxn_str, len) | |||
local temp = 0; | |||
isxn_str = { isxn_str:byte(1, len) }; -- make a table of bytes | |||
len = len+1; -- adjust to be a loop counter | |||
for i, v in ipairs( isxn_str ) do -- loop through all of the byte an calculate the checksum | |||
if v == string.byte( "X" ) then -- if checkdigit is X | |||
temp = temp + 10*( len - i ); -- it represents 10 decimal | |||
else | |||
temp = temp + tonumber( string.char(v) )*(len-i); | |||
end | |||
end | |||
return temp % 11 == 0; -- returns true if calculation result is zero | |||
end | |||
-- Determines whether an ISBN string is valid | |||
function checkisbn( isbn_str ) | |||
isbn_str = cleanisbn( isbn_str ):gsub( "-", "" ); | |||
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 str | |||
return str:gsub( '[%[%]\n]', { | |||
['['] = '[', | |||
[']'] = ']', | |||
['\n'] = ' ' } ); | |||
end | |||
]] | -- Converts a hyphen to a dash | ||
function hyphentodash( str ) | |||
if not is_set(str) or str:match( "[%[%]{}<>]" ) ~= nil then | |||
if | |||
return str; | return str; | ||
end | |||
return str:gsub( '-', '–' ); | |||
end | end | ||
-- | -- Protects a string that will be wrapped in wiki italic markup '' ... '' | ||
function | 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 | if not is_set(str) then | ||
return str; | |||
else | |||
if str:sub(1,1) == "'" then str = "<span />" .. str; end | |||
if | if str:sub(-1,-1) == "'" then str = str .. "<span />"; end | ||
-- Remove newlines as they break italics. | |||
return str:gsub( '\n', ' ' ); | |||
end | end | ||
end | |||
--[[ | |||
Joins a sequence of strings together while checking for duplicate separation | |||
characters. | |||
]] | |||
function safejoin( tbl, duplicate_char ) | |||
--[[ | |||
Note: we use string functions here, rather than ustring functions. | |||
This has considerably faster performance and should work correctly as | |||
long as the duplicate_char is strict ASCII. The strings | |||
in tbl may be ASCII or UTF8. | |||
]] | |||
local str = ''; | |||
local comp = ''; | |||
local end_chr = ''; | |||
local trim; | |||
for _, value in ipairs( tbl ) do | |||
if value == nil then value = ''; end | |||
-- | if str == '' then | ||
str = value; | |||
elseif value ~= '' then | |||
end | if value:sub(1,1) == '<' then | ||
-- Special case of values enclosed in spans and other markup. | |||
comp = value:gsub( "%b<>", "" ); | |||
else | |||
comp = value; | |||
end | |||
if comp:sub(1,1) == duplicate_char then | |||
trim = false; | |||
end_chr = str:sub(-1,-1); | |||
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" | |||
if end_chr == duplicate_char then | |||
str = str:sub(1,-2); | |||
elseif end_chr == "'" then | |||
if str:sub(-3,-1) == duplicate_char .. "''" then | |||
str = str:sub(1, -4) .. "''"; | |||
elseif str:sub(-5,-1) == duplicate_char .. "]]''" then | |||
trim = true; | |||
elseif str:sub(-4,-1) == duplicate_char .. "]''" then | |||
trim = true; | |||
end | |||
elseif end_chr == "]" then | |||
if str:sub(-3,-1) == duplicate_char .. "]]" then | |||
end | trim = true; | ||
elseif str:sub(-2,-1) == duplicate_char .. "]" then | |||
trim = true; | |||
end | |||
elseif end_chr == " " then | |||
if str:sub(-2,-1) == duplicate_char .. " " then | |||
str = str:sub(1,-3); | |||
end | |||
end | |||
if trim then | |||
if value ~= comp then | |||
local dup2 = duplicate_char; | |||
if dup2:match( "%A" ) then dup2 = "%" .. dup2; end | |||
value = value:gsub( "(%b<>)" .. dup2, "%1", 1 ) | |||
else | |||
value = value:sub( 2, -1 ); | |||
end | |||
end | |||
end | |||
str = str .. value; | |||
end | |||
end | end | ||
return | return str; | ||
end | |||
--[[ | |||
Return the year portion of a date string, if possible. | |||
Returns empty string if the argument can not be interpreted | |||
as a year. | |||
BUG: If editors set |date=n.d or |date=n.da then selectyear() returns the current year for use in CITEREF. These "dates" are caught by dates(). | |||
]] | |||
function selectyear( str ) | |||
-- Is the input a simple number? | |||
local num = tonumber( str ); | |||
if num ~= nil and num > 0 and num < 2100 and num == math.floor(num) then | |||
return str; | |||
else | |||
-- Use formatDate to interpret more complicated formats | |||
local lang = mw.getContentLanguage(); | |||
local good, result; | |||
good, result = pcall( lang.formatDate, lang, 'Y', str ); | |||
if good then return result; end -- if good | |||
end | |||
end | end | ||
-- | -- Attempts to convert names to initials. | ||
function | function reducetoinitials(first) | ||
local | local initials = {} | ||
for word in string.gmatch(first, "%S+") do | |||
table.insert(initials, string.sub(word,1,1)) -- Vancouver format does not include full stops. | |||
end | |||
return table.concat(initials) -- Vancouver format does not include spaces. | |||
end | |||
-- Formats a list of people (e.g. authors / editors) | |||
function listpeople(control, people) | |||
local sep = control.sep; | |||
local namesep = control.namesep | |||
local format = control.format | |||
local maximum = control.maximum | |||
local lastauthoramp = control.lastauthoramp; | |||
local text = {} | |||
local etal = false; | |||
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end | |||
if maximum ~= nil and maximum < 1 then return "", 0; end | |||
for | for i,person in ipairs(people) do | ||
if is_set(person.last) then | |||
local mask = person.mask | |||
local one | |||
local sep_one = sep; | |||
if maximum ~= nil and i > maximum then | |||
etal = true; | |||
break; | |||
elseif (mask ~= nil) then | |||
local n = tonumber(mask) | |||
if (n ~= nil) then | |||
one = string.rep("—",n) | |||
else | |||
one = mask; | |||
sep_one = " "; | |||
end | |||
else | |||
one = person.last | |||
local first = person.first | |||
if is_set(first) then | |||
if ( "vanc" == format ) then first = reducetoinitials(first) end | |||
one = one .. namesep .. first | |||
end | |||
if is_set(person.link) then one = "[[" .. person.link .. "|" .. one .. "]]" end | |||
end | end | ||
table.insert( | table.insert( text, one ) | ||
table.insert( text, sep_one ) | |||
end | |||
end | |||
local count = #text / 2; | |||
if count > 0 then | |||
if count > 1 and is_set(lastauthoramp) and not etal then | |||
text[#text-2] = " & "; | |||
end | end | ||
text[#text] = nil; | |||
end | end | ||
local result = table.concat(text) -- construct list | |||
if etal then | |||
local etal_text = cfg.messages['et al']; | |||
result = result .. " " .. etal_text; | |||
end | end | ||
-- if necessary wrap result in <span> tag to format in Small Caps | |||
if ( "scap" == format ) then result = | |||
'<span class="smallcaps" style="font-variant:small-caps">' .. result .. '</span>'; | |||
end | end | ||
return result, count | |||
return | end | ||
-- Generates a CITEREF anchor ID. | |||
function anchorid( options ) | |||
return "CITEREF" .. table.concat( options ); | |||
end | end | ||
-- | -- Gets name list from the input arguments | ||
function extractnames(args, list_name) | |||
function | local names = {}; | ||
local | local i = 1; | ||
local | local last; | ||
local | |||
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; | |||
if is_set( | |||
end | 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; | |||
end | |||
-- Populates ID table from arguments using configuration settings | |||
function extractids( args ) | |||
local id_list = {}; | |||
for k, v in pairs( cfg.id_handlers ) do | |||
if | v = selectone( args, v.parameters, 'redundant_parameters' ); | ||
if is_set(v) then id_list[k] = v; end | |||
end | end | ||
return id_list; | |||
return | |||
end | end | ||
-- | -- Takes a table of IDs and turns it into a table of formatted ID outputs. | ||
function buildidlist( id_list, options ) | |||
function | local new_list, handler = {}; | ||
function fallback(k) return { __index = function(t,i) return cfg.id_handlers[k][i] end } end; | |||
-- | for k, v in pairs( id_list ) do | ||
-- fallback to read-only cfg | |||
handler = setmetatable( { ['id'] = v }, fallback(k) ); | |||
if handler.mode == 'external' then | |||
table.insert( new_list, {handler.label, externallinkid( handler ) } ); | |||
elseif handler.mode == 'internal' then | |||
table.insert( new_list, {handler.label, internallinkid( handler ) } ); | |||
elseif handler.mode ~= 'manual' then | |||
error( cfg.messages['unknown_ID_mode'] ); | |||
elseif k == 'DOI' then | |||
table.insert( new_list, {handler.label, doi( v, options.DoiBroken ) } ); | |||
elseif k == 'ASIN' then | |||
table.insert( new_list, {handler.label, amazon( v, options.ASINTLD ) } ); | |||
elseif k == '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 == '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 | end | ||
table.insert( new_list, {handler.label, ISBN } ); | |||
else | |||
error( cfg.messages['unknown_manual_ID'] ); | |||
end | end | ||
end | |||
function comp( a, b ) | |||
return a[1] < b[1]; | |||
end | end | ||
table.sort( new_list, comp ); | |||
for k, v in ipairs( new_list ) do | |||
new_list[k] = v[2]; | |||
end | |||
return new_list; | |||
end | |||
-- Chooses one matching parameter from a list of parameters to consider | |||
-- Generates an error if more than one match is present. | |||
function selectone( args, possible, error_condition, index ) | |||
local value = nil; | |||
local selected = ''; | |||
local error_list = {}; | |||
if index ~= nil then index = tostring(index); end | |||
-- Handle special case of "#" replaced by empty string | |||
for | if index == '1' then | ||
for _, v in ipairs( possible ) do | |||
v = v:gsub( "#", "" ); | |||
if is_set(args[v]) then | |||
if value ~= nil and selected ~= v then | |||
table.insert( error_list, v ); | |||
else | |||
value = args[v]; | |||
selected = v; | |||
end | |||
end | end | ||
end | |||
end | |||
end | end | ||
for _, v in ipairs( possible ) do | |||
if index ~= nil then | |||
v = v:gsub( "#", index ); | |||
end | |||
if is_set(args[v]) then | |||
if value ~= nil and selected ~= v then | |||
table.insert( error_list, v ); | |||
else | |||
value = args[v]; | |||
selected = v; | |||
end | |||
end | |||
end | |||
if #error_list > 0 then | |||
local error_str = ""; | |||
for _, k in ipairs( error_list ) do | |||
if error_str ~= "" then error_str = error_str .. cfg.messages['parameter-separator'] end | |||
error_str = error_str .. wrap( 'parameter', k ); | |||
end | |||
if #error_list > 1 then | |||
error_str = error_str .. cfg.messages['parameter-final-separator']; | |||
else | |||
error_str = error_str .. cfg.messages['parameter-pair-separator']; | |||
end | |||
error_str = error_str .. wrap( 'parameter', selected ); | |||
table.insert( z.message_tail, { seterror( error_condition, {error_str}, true ) } ); | |||
end | |||
return value, selected; | |||
return | |||
end | end | ||
-- | -- COinS metadata (see <http://ocoins.info/>) allows automated tools to parse | ||
-- the citation information. | |||
function COinS(data) | |||
if 'table' ~= type(data) or nil == next(data) then | |||
function | return ''; | ||
end | |||
local ctx_ver = "Z39.88-2004"; | |||
local | |||
-- | -- treat table strictly as an array with only set values. | ||
local OCinSoutput = setmetatable( {}, { | |||
local | __newindex = function(self, key, value) | ||
if is_set(value) then | |||
rawset( self, #self+1, table.concat{ key, '=', mw.uri.encode( removewikilink( value ) ) } ); | |||
end | |||
end | |||
}); | |||
if is_set(data.Chapter) then | |||
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"; | |||
OCinSoutput["rft.genre"] = "bookitem"; | |||
OCinSoutput["rft.btitle"] = data.Chapter; | |||
OCinSoutput["rft.atitle"] = data.Title; | |||
elseif is_set(data.Periodical) then | |||
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:journal"; | |||
OCinSoutput["rft.genre"] = "article"; | |||
OCinSoutput["rft.jtitle"] = data.Periodical; | |||
OCinSoutput["rft.atitle"] = data.Title; | |||
else | |||
OCinSoutput.rft_val_fmt = "info:ofi/fmt:kev:mtx:book"; | |||
OCinSoutput["rft.genre"] = "book" | |||
OCinSoutput["rft.btitle"] = data.Title; | |||
end | |||
OCinSoutput["rft.place"] = data.PublicationPlace; | |||
OCinSoutput["rft.date"] = data.Date; | |||
if | OCinSoutput["rft.series"] = data.Series; | ||
OCinSoutput["rft.volume"] = data.Volume; | |||
OCinSoutput["rft.issue"] = data.Issue; | |||
OCinSoutput["rft.pages"] = data.Pages; | |||
OCinSoutput["rft.edition"] = data.Edition; | |||
OCinSoutput["rft.pub"] = data.PublisherName; | |||
for k, v in pairs( data.ID_list ) do | |||
local id, value = cfg.id_handlers[k].COinS; | |||
if k == 'ISBN' then value = cleanisbn( v ); else value = v; end | |||
if string.sub( id or "", 1, 4 ) == 'info' then | |||
OCinSoutput["rft_id"] = table.concat{ id, "/", v }; | |||
else | |||
OCinSoutput[ id ] = value; | |||
end | |||
end | |||
local last, first; | |||
for k, v in ipairs( data.Authors ) do | |||
last, first = v.last, v.first; | |||
if k == 1 then | |||
if is_set(last) then | |||
OCinSoutput["rft.aulast"] = last; | |||
end | |||
if is_set(first) then | |||
OCinSoutput["rft.aufirst"] = first; | |||
end | |||
end | |||
if is_set(last) and is_set(first) then | |||
OCinSoutput["rft.au"] = table.concat{ last, ", ", first }; | |||
elseif is_set(last) then | |||
OCinSoutput["rft.au"] = last; | |||
end | end | ||
end | end | ||
OCinSoutput.rft_id = data.URL; | |||
OCinSoutput.rfr_id = table.concat{ "info:sid/", mw.site.server:match( "[^/]*$" ), ":", data.RawPage }; | |||
OCinSoutput = setmetatable( OCinSoutput, nil ); | |||
-- sort with version string always first, and combine. | |||
table.sort( OCinSoutput ); | |||
table.insert( OCinSoutput, 1, "ctx_ver=" .. ctx_ver ); -- such as "Z39.88-2004" | |||
return table.concat(OCinSoutput, "&"); | |||
end | |||
--[[ | |||
This is the main function foing the majority of the citation | |||
formatting. | |||
]] | |||
function citation0( config, args) | |||
--[[ | |||
Load Input Parameters | |||
local | The argment_wrapper facillitates the mapping of multiple | ||
local | aliases to single internal variable. | ||
]] | |||
local A = argument_wrapper( args ); | |||
local i | |||
local PPrefix = A['PPrefix'] | |||
local PPPrefix = A['PPPrefix'] | |||
if is_set( A['NoPP'] ) then PPPrefix = "" PPrefix = "" end | |||
-- Pick out the relevant fields from the arguments. Different citation templates | |||
-- define different field names for the same underlying things. | |||
local Authors = A['Authors']; | |||
local a = extractnames( args, 'AuthorList' ); | |||
local Coauthors = A['Coauthors']; | |||
local | local Others = A['Others']; | ||
local | local Editors = A['Editors']; | ||
local e = extractnames( args, 'EditorList' ); | |||
local | |||
local | |||
local | |||
local | |||
local | local Year = A['Year']; | ||
local PublicationDate = A['PublicationDate']; | |||
local | local OrigYear = A['OrigYear']; | ||
local | local Date = A['Date']; | ||
local | local LayDate = A['LayDate']; | ||
local | ------------------------------------------------- Get title data | ||
local | local Title = A['Title']; | ||
local | local BookTitle = A['BookTitle']; | ||
local | local Conference = A['Conference']; | ||
local | local TransTitle = A['TransTitle']; | ||
local | local TitleNote = A['TitleNote']; | ||
local | local TitleLink = A['TitleLink']; | ||
local Chapter = A['Chapter']; | |||
local | local ChapterLink = A['ChapterLink']; | ||
local | local TransChapter = A['TransChapter']; | ||
local TitleType = A['TitleType']; | |||
local Degree = A['Degree']; | |||
local Docket = A['Docket']; | |||
local ArchiveURL = A['ArchiveURL']; | |||
local URL = A['URL'] | |||
local URLorigin = A:ORIGIN('URL'); | |||
local ChapterURL = A['ChapterURL']; | |||
local ChapterURLorigin = A:ORIGIN('ChapterURL'); | |||
local ConferenceURL = A['ConferenceURL']; | |||
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); | |||
local Periodical = A['Periodical']; | |||
if not is_set( | if ( config.CitationClass == "encyclopaedia" ) then | ||
if not is_set(Chapter) then | |||
if not is_set(Title) then | |||
Title = Periodical; | |||
Periodical = ''; | |||
else | |||
Chapter = Title | |||
TransChapter = TransTitle | |||
Title = ''; | |||
TransTitle = ''; | |||
end | end | ||
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']; | |||
Pages = hyphentodash( A['Pages'] ); | |||
At = A['At']; | |||
if is_set(Page) then | |||
if is_set( | if is_set(Pages) or is_set(At) then | ||
Page = Page .. " " .. seterror('extra_pages'); | |||
Pages = ''; | |||
At = ''; | |||
end | |||
elseif is_set(Pages) then | |||
if is_set(At) then | |||
Pages = Pages .. " " .. seterror('extra_pages'); | |||
At = ''; | |||
end | |||
end | |||
local Edition = A['Edition']; | |||
local PublicationPlace = A['PublicationPlace'] | |||
local Place = A['Place']; | |||
if not is_set(PublicationPlace) and is_set(Place) then | |||
PublicationPlace = Place; | |||
end | end | ||
if PublicationPlace == Place then Place = ''; end | |||
local | local PublisherName = A['PublisherName']; | ||
local RegistrationRequired = A['RegistrationRequired']; | |||
local SubscriptionRequired = A['SubscriptionRequired']; | |||
local Via = A['Via']; | |||
local AccessDate = A['AccessDate']; | |||
local ArchiveDate = A['ArchiveDate']; | |||
local Agency = A['Agency']; | |||
local DeadURL = A['DeadURL'] | |||
local Language = A['Language']; | |||
local Format = A['Format']; | |||
local Ref = A['Ref']; | |||
local DoiBroken = A['DoiBroken']; | |||
-- Special case for cite techreport. | |||
local ID = A['ID']; | |||
if (config.CitationClass == "techreport") then -- special case for cite techreport | |||
if is_set(Issue) then -- cite techreport uses 'number', which everything else aliases 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>|id=</code> and <code>|number=</code>'); | |||
end | |||
end | |||
end | |||
local ASINTLD = A['ASINTLD']; | |||
local IgnoreISBN = A['IgnoreISBN']; | |||
local Embargo = A['Embargo']; | |||
local ID_list = extractids( args ); | |||
local Quote = A['Quote']; | |||
local PostScript = A['PostScript']; | |||
local LayURL = A['LayURL']; | |||
local LaySource = A['LaySource']; | |||
local Transcript = A['Transcript']; | |||
local TranscriptURL = A['TranscriptURL'] | |||
local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); | |||
local sepc = A['Separator']; | |||
local LastAuthorAmp = A['LastAuthorAmp']; | |||
local no_tracking_cats = A['NoTracking']; | |||
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 | |||
local anchor_year; -- used in the CITEREF identifier | |||
local COinS_date; -- used in the COinS metadata | |||
-- Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. | |||
-- 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. | |||
anchor_year, COinS_date = dates({['accessdate']=AccessDate, ['airdate']=AirDate, ['archivedate']=ArchiveDate, ['date']=Date, ['doi_brokendate']=DoiBroken, | |||
['embargo']=Embargo, ['laydate']=LayDate, ['publicationdate']=PublicationDate, ['year']=Year}); | |||
if not is_set(Year) then -- prevent Year from being set from DateIn TODO: eliminate the need for this? | |||
if is_set(anchor_year) then | |||
Year = anchor_year; | |||
end | |||
end | |||
-- At this point fields may be nil if they weren't specified in the template use. We can use that fact. | |||
-- | -- Account for the oddity that is {{cite conference}}, before generation of COinS data. | ||
if | 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. | |||
if config.CitationClass == "episode" then | |||
local AirDate = A['AirDate']; | |||
local SeriesLink = A['SeriesLink']; | |||
local Season = A['Season']; | |||
local SeriesNumber = A['SeriesNumber']; | |||
if | local Network = A['Network']; | ||
local | local Station = A['Station']; | ||
local s, n = {}, {}; | |||
local Sep = (first_set(A["SeriesSeparator"], A["Separator"]) or "") .. " "; | |||
if is_set(Issue) then table.insert(s, cfg.messages["episode"] .. " " .. Issue); Issue = ''; end | |||
if is_set(Season) then table.insert(s, cfg.messages["season"] .. " " .. Season); end | |||
if is_set(SeriesNumber) then table.insert(s, cfg.messages["series"] .. " " .. SeriesNumber); end | |||
if is_set(Network) then table.insert(n, Network); end | |||
if is_set(Station) then table.insert(n, Station); end | |||
Date = Date or AirDate; | |||
Chapter = Title; | |||
ChapterLink = TitleLink; | |||
TransChapter = TransTitle; | |||
Title = Series; | |||
TitleLink = SeriesLink; | |||
TransTitle = ''; | |||
Series = table.concat(s, Sep); | |||
ID = table.concat(n, Sep); | |||
end | end | ||
-- COinS metadata (see <http://ocoins.info/>) for | |||
-- automated parsing of citation information. | |||
local OCinSoutput = COinS{ | |||
['Periodical'] = Periodical, | |||
['Chapter'] = Chapter, | |||
['Title'] = Title, | |||
['PublicationPlace'] = PublicationPlace, | |||
['Date'] = first_set(COinS_date, Date, Year, PublicationDate), | |||
['Series'] = Series, | |||
['Volume'] = Volume, | |||
['Issue'] = Issue, | |||
['Pages'] = first_set(Page, Pages, At), | |||
['Edition'] = Edition, | |||
['PublisherName'] = PublisherName, | |||
['URL'] = first_set( URL, ChapterURL ), | |||
['Authors'] = a, | |||
['ID_list'] = ID_list, | |||
['RawPage'] = this_page.prefixedText, | |||
}; | |||
if is_set(Periodical) and not is_set(Chapter) and is_set(Title) then | |||
Chapter = Title; | |||
ChapterLink = TitleLink; | |||
TransChapter = TransTitle; | |||
Title = ''; | |||
TitleLink = ''; | |||
TransTitle = ''; | |||
if | |||
end | end | ||
-- | -- Now perform various field substitutions. | ||
-- We also add leading spaces and surrounding markup and punctuation to the | |||
-- various parts of the citation, but only when they are non-nil. | |||
if | if not is_set(Authors) then | ||
local Maximum = tonumber( A['DisplayAuthors'] ); | |||
-- | -- Preserve old-style implicit et al. | ||
if ( | if not is_set(Maximum) and #a == 9 then | ||
table.insert( z.message_tail, { seterror( ' | Maximum = 8; | ||
table.insert( z.message_tail, { seterror('implict_etal_author', {}, true ) } ); | |||
elseif not is_set(Maximum) then | |||
Maximum = #a + 1; | |||
end | end | ||
local control = { | |||
sep = A["AuthorSeparator"] .. " ", | |||
namesep = (first_set(A["AuthorNameSeparator"], A["NameSeparator"]) or "") .. " ", | |||
format = A["AuthorFormat"], | |||
maximum = Maximum, | |||
lastauthoramp = LastAuthorAmp | |||
}; | |||
-- | -- If the coauthor field is also used, prevent ampersand and et al. formatting. | ||
if is_set( | if is_set(Coauthors) then | ||
control.lastauthoramp = nil; | |||
control.maximum = #a + 1; | |||
deprecated_parameter(); -- |coauthor= and |coathors= are deprecated; add this page to deprecated parameter category | |||
end | end | ||
Authors = listpeople(control, a) | |||
end | end | ||
if not is_set(Authors) and is_set(Coauthors) then -- coauthors aren't displayed if one of authors=, authorn=, or lastn= isn't specified | |||
table.insert( z.message_tail, { seterror('coauthors_missing_author', {}, true) } ); -- emit error message | |||
deprecated_parameter(); -- |coauthor= and |coathors= are deprecated; add this page to deprecated parameter category | |||
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 | ||
local Cartography = ""; | |||
if is_set( | local Scale = ""; | ||
if config.CitationClass == "map" then | |||
if not is_set( Authors ) and is_set( PublisherName ) then | |||
Authors = PublisherName; | |||
PublisherName = ""; | |||
end | |||
Cartography = A['Cartography']; | |||
if is_set( Cartography ) then | |||
Cartography = sepc .. " " .. wrap( 'cartography', Cartography, use_lowercase ); | |||
end | |||
Scale = A['Scale']; | |||
if is_set( Scale ) then | |||
Scale = sepc .. " " .. Scale; | |||
end | |||
end | end | ||
if not is_set(Date) then | |||
Date = Year; | |||
if is_set(Date) then | |||
local Month = A['Month']; | |||
if is_set(Month) then | |||
deprecated_parameter(); -- |month= (and also |day=) is deprecated; add this page to deprecated parameter category | |||
Date = Month .. " " .. Date; | |||
local Day = A['Day'] | |||
if is_set(Day) then Date = Day .. " " .. Date end | |||
end | |||
end | end | ||
end | end | ||
if inArray(PublicationDate, {Date, Year}) then PublicationDate = ''; end | |||
if not is_set(Date) and is_set(PublicationDate) then | |||
Date = PublicationDate; | |||
PublicationDate = ''; | |||
end | |||
-- Captures the value for Date prior to adding parens or other textual transformations | |||
local DateIn = Date; | |||
if is_set( | if not is_set(URL) and | ||
not is_set(ChapterURL) and | |||
not is_set(ArchiveURL) and | |||
not is_set(ConferenceURL) and | |||
not is_set(TranscriptURL) then | |||
-- Test if cite web is called without giving a URL | |||
if ( config.CitationClass == "web" ) 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 | ||
if is_set( | -- Test if citation has no title | ||
if not is_set(Chapter) and | |||
not is_set(Title) and | |||
not is_set(Periodical) and | |||
not is_set(Conference) and | |||
not is_set(TransTitle) and | |||
not is_set(TransChapter) then | |||
table.insert( z.message_tail, { seterror( 'citation_missing_title', {}, true ) } ); | |||
end | end | ||
Format = is_set(Format) and " (" .. Format .. ")" or ""; | |||
if is_set( | |||
if | local OriginalURL = URL | ||
DeadURL = DeadURL:lower(); | |||
if is_set( ArchiveURL ) then | |||
if ( DeadURL ~= "no" ) then | |||
URL = ArchiveURL | |||
URLorigin = A:ORIGIN('ArchiveURL') | |||
end | end | ||
end | end | ||
-- Format chapter / article title | |||
if is_set(Chapter) and is_set(ChapterLink) then | |||
if is_set( | Chapter = "[[" .. ChapterLink .. "|" .. Chapter .. "]]"; | ||
end | end | ||
if is_set(Periodical) and is_set(Title) then | |||
if is_set( | Chapter = wrap( 'italic-title', Chapter ); | ||
TransChapter = wrap( 'trans-italic-title', TransChapter ); | |||
else | |||
Chapter = wrap( 'quoted-title', Chapter ); | |||
TransChapter = wrap( 'trans-quoted-title', TransChapter ); | |||
end | end | ||
if is_set( | local TransError = "" | ||
if is_set( | if is_set(TransChapter) then | ||
if not is_set(Chapter) then | |||
TransError = " " .. seterror( 'trans_missing_chapter' ); | |||
else | |||
TransChapter = " " .. TransChapter; | |||
end | end | ||
end | end | ||
if not is_set( | Chapter = Chapter .. TransChapter; | ||
if is_set(Chapter) then | |||
if not is_set(ChapterLink) then | |||
if is_set(ChapterURL) then | |||
Chapter = externallink( ChapterURL, Chapter ) .. TransError; | |||
if not is_set(URL) then | |||
Chapter = Chapter .. Format; | |||
Format = ""; | |||
end | |||
elseif is_set(URL) then | |||
Chapter = externallink( URL, Chapter ) .. TransError .. Format; | |||
URL = ""; | |||
Format = ""; | |||
else | |||
Chapter = Chapter .. TransError; | |||
end | |||
elseif is_set(ChapterURL) then | |||
Chapter = Chapter .. " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. | |||
TransError; | |||
else | else | ||
Chapter = Chapter .. TransError; | |||
end | end | ||
Chapter = Chapter .. sepc .. " " -- with end-space | |||
elseif is_set(ChapterURL) then | |||
Chapter = " " .. externallink( ChapterURL, nil, ChapterURLorigin ) .. sepc .. " "; | |||
end | |||
-- Format main title. | |||
if is_set(TitleLink) and is_set(Title) then | |||
Title = "[[" .. TitleLink .. "|" .. Title .. "]]" | |||
end | |||
if is_set(Periodical) then | |||
Title = wrap( 'quoted-title', Title ); | |||
TransTitle = wrap( 'trans-quoted-title', TransTitle ); | |||
elseif inArray(config.CitationClass, {"web","news","pressrelease","conference"}) and | |||
not is_set(Chapter) then | |||
Title = wrap( 'quoted-title', Title ); | |||
TransTitle = wrap( 'trans-quoted-title', TransTitle ); | |||
else | else | ||
Title = wrap( 'italic-title', Title ); | |||
TransTitle = wrap( 'trans-italic-title', TransTitle ); | |||
end | end | ||
if | TransError = ""; | ||
if is_set( | if is_set(TransTitle) then | ||
if not is_set(Title) then | |||
TransError = " " .. seterror( 'trans_missing_title' ); | |||
else | |||
TransTitle = " " .. TransTitle; | |||
end | end | ||
end | |||
if is_set( | |||
Title = Title .. TransTitle; | |||
if is_set(Title) then | |||
if not is_set(TitleLink) and is_set(URL) then | |||
Title = externallink( URL, Title ) .. TransError .. Format | |||
URL = ""; | |||
Format = ""; | |||
else | else | ||
Title = Title .. TransError; | |||
end | end | ||
end | end | ||
if is_set(Place) then | |||
Place = " " .. wrap( 'written', Place, use_lowercase ) .. sepc .. " "; | |||
if | end | ||
if is_set(Conference) then | |||
if is_set(ConferenceURL) then | |||
Conference = externallink( ConferenceURL, Conference ); | |||
end | |||
Conference = sepc .. " " .. Conference | |||
elseif is_set(ConferenceURL) then | |||
Conference = sepc .. " " .. externallink( ConferenceURL, nil, ConferenceURLorigin ); | |||
end | |||
if not is_set(Position) then | |||
local Minutes = A['Minutes']; | |||
if is_set(Minutes) then | |||
Position = " " .. Minutes .. " " .. cfg.messages['minutes']; | |||
else | else | ||
if is_set( | local Time = A['Time']; | ||
if is_set(Time) then | |||
if is_set( | local TimeCaption = A['TimeCaption'] | ||
if not is_set(TimeCaption) then | |||
TimeCaption = cfg.messages['event']; | |||
if sepc ~= '.' then | |||
TimeCaption = TimeCaption:lower(); | |||
end | |||
end | end | ||
elseif is_set( Inset ) then | Position = " " .. TimeCaption .. " " .. Time; | ||
Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase ); | end | ||
end | end | ||
end | else | ||
Position = " " .. Position; | |||
At = ''; | |||
end | |||
if not is_set(Page) then | |||
if is_set(Pages) then | |||
if is_set(Periodical) and | |||
not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then | |||
Pages = ": " .. Pages; | |||
elseif tonumber(Pages) ~= nil then | |||
Pages = sepc .." " .. PPrefix .. Pages; | |||
else | |||
Pages = sepc .." " .. PPPrefix .. Pages; | |||
end | |||
end | |||
else | |||
if is_set(Periodical) and | |||
not inArray(config.CitationClass, {"encyclopaedia","web","book","news"}) then | |||
Page = ": " .. Page; | |||
else | |||
Page = sepc .." " .. PPrefix .. Page; | |||
end | |||
end | |||
At = is_set(At) and (sepc .. " " .. At) or ""; | |||
Position = is_set(Position) and (sepc .. " " .. Position) or ""; | |||
if config.CitationClass == 'map' then | |||
local Section = A['Section']; | |||
local Inset = A['Inset']; | |||
if first_set( Pages, Page, At ) ~= nil or sepc ~= '.' then | |||
if is_set( Section ) then | |||
Section = ", " .. wrap( 'section', Section, true ); | |||
end | |||
if is_set( Inset ) then | |||
Inset = ", " .. wrap( 'inset', Inset, true ); | |||
end | |||
else | |||
if is_set( Section ) then | |||
Section = sepc .. " " .. wrap( 'section', Section, use_lowercase ); | |||
if is_set( Inset ) then | |||
Inset = ", " .. wrap( 'inset', Inset, true ); | |||
end | |||
elseif is_set( Inset ) then | |||
Inset = sepc .. " " .. wrap( 'inset', Inset, use_lowercase ); | |||
end | |||
end | |||
At = At .. Section .. Inset; | At = At .. Section .. Inset; | ||
end | end | ||
--[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them. If a match is found, | --[[Look in the list of iso639-1 language codes to see if the value provided in the language parameter matches one of them. If a match is found, | ||
use that value; if not, then use the value that was provided with the language parameter. | use that value; if not, then use the value that was provided with the language parameter. | ||
Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English). | Categories are assigned in a manner similar to the {{xx icon}} templates - categorizes only mainspace citations and only when the language code is not 'en' (English). | ||
]] | ]] | ||
if is_set (Language) then | if is_set (Language) then | ||
local name = cfg.iso639_1[Language:lower()]; -- get the language name if Language parameter has a valid iso 639-1 code | 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 | if nil == name then | ||
Language=" " .. wrap( 'language', Language ); -- no match, use parameter's value | Language=" " .. wrap( 'language', Language ); -- no match, use parameter's value | ||
else | 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? | 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 | Language=" " .. wrap( 'language', name .. '[[Category:Articles with ' .. name .. '-language external links]]' ); -- in main space and not English: categorize | ||
else | else | ||
Language=" " .. wrap( 'language', name ); --not in mainspace or language is English so don't categorize | Language=" " .. wrap( 'language', name ); --not in mainspace or language is English so don't categorize | ||
end | end | ||
end | end | ||
else | else | ||
Language=""; -- language not specified so make sure this is an empty string; | 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 "pressrelease" == config.CitationClass then -- if this citation is cite press release | |||
if not is_set (TitleType) then | |||
TitleType = "Press release"; -- if type not specified, display the press release annotation | |||
else | |||
if "none" == TitleType then TitleType = ""; end -- if |type=none then type parameter not displayed | |||
end | |||
elseif "techreport" == config.CitationClass then -- if this citation is cite techreport | |||
if not is_set (TitleType) then | |||
TitleType = "Technical report"; -- if type not specified, display the techreport annotation | |||
else | |||
if "none" == TitleType then TitleType = ""; end -- if |type=none then type parameter not displayed; |number=, if set, will be displayed | |||
end | |||
elseif "thesis" == config.CitationClass then -- if this citation is cite thesis | |||
if not is_set (TitleType) then | |||
if is_set(Degree) then -- if type not specified, display one of the thesis annotations | |||
TitleType = Degree .. " thesis"; -- if a degree (masters, PhD, ...) is specified include it in the display | |||
else | |||
TitleType = "Thesis"; -- otherwise display the simple thesis annotation | |||
end | |||
else | |||
if "none" == TitleType then TitleType = ""; end -- if |type=none then type parameter not displayed | |||
end | |||
end | |||
if is_set(TitleType) then -- if type parameter is specified | |||
TitleType = " (" .. TitleType .. ")"; -- display it in parentheses | |||
end | |||
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or ""; | |||
Edition = is_set(Edition) and (" " .. wrap( 'edition', Edition )) or ""; | |||
Issue = is_set(Issue) and (" (" .. Issue .. ")") or ""; | |||
Series = is_set(Series) and (sepc .. " " .. Series) or ""; | |||
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; | |||
Agency = is_set(Agency) and (sepc .. " " .. Agency) or ""; | |||
if is_set(Volume) then | |||
if ( mw.ustring.len(Volume) > 4 ) | |||
then Volume = sepc .." " .. Volume; | |||
else Volume = " <b>" .. hyphentodash(Volume) .. "</b>"; | |||
end | |||
end | |||
------------------------------------ totally unrelated data | |||
--[[ Loosely mimic {{subscription required}} template; Via parameter identifies a delivery source that is not the publisher; these sources often, but not always, exist | |||
behind a registration or paywall. So here, we've chosen to decouple via from subscription (via has never been part of the registration required template). | |||
Subscription implies paywall; Registration does not. If both are used in a citation, the subscription required link note is displayed. There are no error messages for this condition. | |||
]] | |||
if is_set(Via) then | |||
Via = " " .. wrap( 'via', Via ); | |||
end | |||
if is_set(SubscriptionRequired) then | |||
SubscriptionRequired = sepc .. " " .. cfg.messages['subscription']; --here when 'via' parameter not used but 'subscription' is | |||
elseif is_set(RegistrationRequired) then | |||
SubscriptionRequired = sepc .. " " .. cfg.messages['registration']; --here when 'via' and 'subscription' parameters not used but 'registration' is | |||
end | |||
if is_set(AccessDate) then | |||
local retrv_text = " " .. cfg.messages['retrieved'] | |||
if (sepc ~= ".") then retrv_text = retrv_text:lower() end | |||
AccessDate = '<span class="reference-accessdate">' .. sepc | |||
.. substitute( retrv_text, {AccessDate} ) .. '</span>' | |||
end | |||
if is_set(ID) then ID = sepc .." ".. ID; end | |||
if "thesis" == config.CitationClass and is_set(Docket) then | |||
ID = sepc .." Docket ".. Docket .. ID; | |||
end | end | ||
ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} ); | ID_list = buildidlist( ID_list, {DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo} ); | ||
Line 1,680: | Line 1,934: | ||
end | end | ||
end | end | ||
names[ #names + 1 ] = Year or anchor_year; -- Year first for legacy citations | |||
id = anchorid(names) | id = anchorid(names) | ||
end | end |