Module:Citation/CS1: Difference between revisions
Undid revision 913814858 by Trappist the monk (talk) This edit has introduced citation errors all over the project. Please troubleshoot before implementing this change. See [https://en.wikipedia.org/wiki/Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_%22Cite_Web%22_errors?]
(sync from sandbox;) |
(Undid revision 913814858 by Trappist the monk (talk) This edit has introduced citation errors all over the project. Please troubleshoot before implementing this change. See [https://en.wikipedia.org/wiki/Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_%22Cite_Web%22_errors?]) |
||
Line 7: | Line 7: | ||
local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities | local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities | ||
add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink | add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink; | ||
local z ={}; -- tables in Module:Citation/CS1/Utilities | local z ={}; -- tables in Module:Citation/CS1/Utilities | ||
Line 71: | Line 70: | ||
added_prop_cats [key] = true; -- note that we've added this category | added_prop_cats [key] = true; -- note that we've added this category | ||
key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname | key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?', '%1'); -- strip lang code from keyname | ||
table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table | table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table | ||
end | end | ||
end | end | ||
Line 151: | Line 150: | ||
domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once | domain = domain:gsub ('^//', ''); -- strip '//' from domain name if present; done here so we only have to do it once | ||
if not domain:match ('^[% | if not domain:match ('^[%a%d]') then -- first character must be letter or digit | ||
return false; | return false; | ||
end | end | ||
Line 158: | Line 157: | ||
return false; | return false; | ||
end | end | ||
-- Do most common case first | |||
if domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.%a%a+$') then -- three or more character hostname.hostname or hostname.tld | |||
return true; | |||
'%f[% | elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix | ||
'%f[%a][qxz]%.com$' | return true; | ||
'%f[%a][iq]%.net$' | elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname | ||
'%f[% | return true; | ||
'%f[% | elseif domain:match ('%f[%a%d][%a%d]%.today') then -- one character/digit .today hostname | ||
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?' | return true; | ||
elseif domain:match ('%f[%a%d][%a%d]%.org$') then -- one character/digit .org hostname | |||
return true; | |||
elseif domain:match ('%f[%a][qxz]%.com$') then -- assigned one character .com hostname (x.com times out 2015-12-10) | |||
return true; | |||
elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10) | |||
return true; | |||
elseif domain:match ('%f[%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars) | |||
return true; | |||
elseif domain:match ('%f[%a%d][%a%d][%a%d]%.%a%a+$') then -- two character hostname and tld | |||
return true; | |||
elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address | |||
return true; | |||
else | |||
return false; | |||
end | end | ||
end | end | ||
Line 445: | Line 445: | ||
if not added_deprecated_cat then | if not added_deprecated_cat then | ||
added_deprecated_cat = true; -- note that we've added this category | added_deprecated_cat = true; -- note that we've added this category | ||
table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message | table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message | ||
end | end | ||
end | end | ||
Line 527: | Line 527: | ||
is not added. At this time there is no error message for this condition. | is not added. At this time there is no error message for this condition. | ||
Supports |script-title= | Supports |script-title= and |script-chapter= | ||
TODO: error messages when prefix is invalid ISO639-1 code; when script_value has prefix but no script; | |||
]] | ]] | ||
local function format_script_value (script_value | local function format_script_value (script_value) | ||
local lang=''; -- initialize to empty string | local lang=''; -- initialize to empty string | ||
local name; | local name; | ||
Line 537: | Line 538: | ||
lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script | lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script | ||
if not is_set (lang) then | if not is_set (lang) then | ||
return ''; -- script_value was just the prefix so return empty string | return ''; -- script_value was just the prefix so return empty string | ||
end | end | ||
Line 548: | Line 548: | ||
add_prop_cat ('script_with_name', {name, lang}) | add_prop_cat ('script_with_name', {name, lang}) | ||
else | else | ||
add_prop_cat ('script') | |||
end | end | ||
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute | lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute | ||
else | else | ||
lang = ''; -- invalid so set lang to empty string | lang = ''; -- invalid so set lang to empty string | ||
end | end | ||
end | end | ||
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl | script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl | ||
Line 570: | Line 567: | ||
]] | ]] | ||
local function script_concatenate (title, script | local function script_concatenate (title, script) | ||
if is_set (script) then | if is_set (script) then | ||
script = format_script_value (script | script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error | ||
if is_set (script) then | if is_set (script) then | ||
title = title .. ' ' .. script; -- concatenate title and script title | title = title .. ' ' .. script; -- concatenate title and script title | ||
Line 596: | Line 593: | ||
local msg; | local msg; | ||
msg = cfg.messages[key]:lower(); -- set the message to lower case before | msg = cfg.messages[key]:lower(); -- set the message to lower case before | ||
return substitute( msg, str ); | return substitute( msg, str ); -- including template text | ||
else | else | ||
return substitute( cfg.messages[key], str ); | return substitute( cfg.messages[key], str ); | ||
Line 651: | Line 648: | ||
end | end | ||
return ws_url, ws_label, L or D; | return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil | ||
end | end | ||
Line 694: | Line 659: | ||
]] | ]] | ||
local function format_chapter_title (scriptchapter | local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access) | ||
local chapter_error = ''; | local chapter_error = ''; | ||
local ws_url, ws_label, L = wikisource_url_make (chapter); | local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource url and label from a wikisource interwiki link | ||
if ws_url then | if ws_url then | ||
ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters | ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters | ||
Line 712: | Line 677: | ||
end | end | ||
chapter = script_concatenate (chapter, scriptchapter | chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
if is_set (chapterurl) then | if is_set (chapterurl) then | ||
chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | ||
elseif ws_url then | elseif ws_url then | ||
chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? | chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this? | ||
chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter}); | chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter}); | ||
end | end | ||
Line 726: | Line 691: | ||
chapter = chapter .. ' ' .. transchapter; | chapter = chapter .. ' ' .. transchapter; | ||
else -- here when transchapter without chapter or script-chapter | else -- here when transchapter without chapter or script-chapter | ||
chapter = transchapter; | chapter = transchapter; -- | ||
chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'}); | chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'}); | ||
end | end | ||
Line 732: | Line 697: | ||
-- if is_set (chapterurl) then | -- if is_set (chapterurl) then | ||
-- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | -- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate | ||
-- end | -- end | ||
Line 835: | Line 800: | ||
-- maybe let through instead of raising an error? | -- maybe let through instead of raising an error? | ||
-- v, origin[k] = args[k], k; | -- v, origin[k] = args[k], k; | ||
error( cfg.messages['unknown_argument_map'] | error( cfg.messages['unknown_argument_map'] ); | ||
end | end | ||
Line 1,074: | Line 1,039: | ||
local function is_good_vanc_name (last, first) | local function is_good_vanc_name (last, first) | ||
local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it | local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it | ||
if is_set (suffix) then | if is_set (suffix) then | ||
Line 1,272: | Line 1,237: | ||
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) | etal = true; -- set flag (may have been set previously here or by |display-<names>=etal) | ||
if not nocat then -- no categorization for |vauthors= | if not nocat then -- no categorization for |vauthors= | ||
table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added | table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added | ||
end | end | ||
end | end | ||
Line 1,916: | Line 1,881: | ||
if not is_set (value) then | if not is_set (value) then | ||
return true; -- an empty parameter is ok | return true; -- an empty parameter is ok | ||
elseif in_array (value, possible) then | elseif in_array(value:lower(), possible) then | ||
return true; | return true; | ||
else | else | ||
Line 2,026: | Line 1,991: | ||
if is_journal then | if is_journal then | ||
return substitute (cfg.messages['j-page(s)'], pages), '', '', ''; | return substitute (cfg.messages['j-page(s)'], pages), '', '', ''; | ||
elseif tonumber(pages) ~= nil and not nopp then | elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number | ||
return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', ''; | return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', ''; | ||
elseif not nopp then | elseif not nopp then | ||
Line 2,143: | Line 2,108: | ||
err_msg = 'liveweb'; | err_msg = 'liveweb'; | ||
else | else | ||
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation | path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation | ||
if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here | if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here | ||
Line 2,270: | Line 2,235: | ||
end | end | ||
if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc' | if not is_valid_parameter_value (NameListFormat, 'name-list-format', cfg.keywords['name-list-format']) then -- only accepted value for this parameter is 'vanc' | ||
NameListFormat = ''; -- anything else, set to empty string | NameListFormat = ''; -- anything else, set to empty string | ||
end | end | ||
if is_set (Others) then | |||
if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor= | |||
add_maint_cat ('others'); | |||
end | end | ||
end | |||
local Year = A['Year']; | local Year = A['Year']; | ||
Line 2,297: | Line 2,262: | ||
local Chapter = A['Chapter']; | local Chapter = A['Chapter']; | ||
local ScriptChapter = A['ScriptChapter']; | local ScriptChapter = A['ScriptChapter']; | ||
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode | local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode | ||
local TransChapter = A['TransChapter']; | local TransChapter = A['TransChapter']; | ||
Line 2,310: | Line 2,274: | ||
ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) | ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) | ||
local | local DeadURL = A['DeadURL'] | ||
if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes' | |||
if not is_valid_parameter_value ( | DeadURL = ''; -- anything else, set to empty string | ||
end | |||
local URL = A['URL'] | local URL = A['URL'] | ||
local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL | local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL | ||
Line 2,335: | Line 2,287: | ||
local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL | local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL | ||
local Periodical = A['Periodical']; | local Periodical = A['Periodical']; | ||
local | local Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter | ||
local Series = A['Series']; | local Series = A['Series']; | ||
Line 2,365: | Line 2,297: | ||
local At; | local At; | ||
if | if in_array (config.CitationClass, cfg.templates_using_volume) then | ||
Volume = A['Volume']; | Volume = A['Volume']; | ||
end | end | ||
-- conference & map books do not support issue | |||
if in_array (config.CitationClass, cfg.templates_using_issue) and not (in_array (config.CitationClass, {'conference', 'map'}) and not is_set (Periodical))then | |||
Issue = hyphen_to_dash (A['Issue']); | |||
end | |||
local Position = ''; | local Position = ''; | ||
if not in_array (config.CitationClass, cfg.templates_not_using_page) then | if not in_array (config.CitationClass, cfg.templates_not_using_page) then | ||
Line 2,404: | Line 2,316: | ||
local PublisherName = A['PublisherName']; | local PublisherName = A['PublisherName']; | ||
local RegistrationRequired = A['RegistrationRequired']; | local RegistrationRequired = A['RegistrationRequired']; | ||
if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then | if not is_valid_parameter_value (RegistrationRequired, 'registration', cfg.keywords ['yes_true_y']) then | ||
Line 2,432: | Line 2,334: | ||
table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } ); | table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } ); | ||
end | end | ||
if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set | if is_set (UrlAccess) and is_set (SubscriptionRequired) then -- while not aliases, these are much the same so if both are set | ||
table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message | table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'url-access') .. ' and ' .. wrap_style ('parameter', 'subscription')}, true ) } ); -- add error message | ||
Line 2,443: | Line 2,345: | ||
local ChapterUrlAccess = A['ChapterUrlAccess']; | local ChapterUrlAccess = A['ChapterUrlAccess']; | ||
if not is_valid_parameter_value (ChapterUrlAccess, | if not is_valid_parameter_value (ChapterUrlAccess, 'chapter-url-access', cfg.keywords ['url-access']) then -- same as url-access | ||
ChapterUrlAccess = nil; | ChapterUrlAccess = nil; | ||
end | end | ||
if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then | if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then | ||
ChapterUrlAccess = nil; | ChapterUrlAccess = nil; | ||
table.insert( z.message_tail, { set_error( 'param_access_requires_param', { | table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'chapter-url'}, true ) } ); | ||
end | end | ||
Line 2,478: | Line 2,371: | ||
local ID_list = extract_ids( args ); | local ID_list = extract_ids( args ); | ||
local ID_access_levels = extract_id_access_levels( args, ID_list ); | local ID_access_levels = extract_id_access_levels( args, ID_list ); | ||
Line 2,517: | Line 2,407: | ||
end | end | ||
local sepc; | local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma | ||
local PostScript; | local PostScript; | ||
local Ref; | local Ref; | ||
sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); | sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); | ||
use_lowercase = ( sepc == ',' ); | use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text | ||
--check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | --check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories | ||
Line 2,537: | Line 2,427: | ||
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) | -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it) | ||
select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category | select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category | ||
local coins_pages; | local coins_pages; | ||
Line 2,550: | Line 2,440: | ||
end | end | ||
-- both |publication-place= and |place= (|location=) allowed if different | |||
PublicationPlace = Place; | if not is_set(PublicationPlace) and is_set(Place) then | ||
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place | |||
end | end | ||
if PublicationPlace == Place then Place = ''; end | if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same | ||
--[[ | --[[ | ||
Line 2,561: | Line 2,452: | ||
|encyclopedia and |title then map |title to |article and |encyclopedia to |title | |encyclopedia and |title then map |title to |article and |encyclopedia to |title | ||
|encyclopedia and |article then map |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 | |trans-title maps to |trans-chapter when |title is re-mapped | ||
|url maps to |chapterurl when |title is remapped | |url maps to |chapterurl when |title is remapped | ||
Line 2,572: | Line 2,464: | ||
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation | if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation | ||
if is_set (Periodical) then -- Periodical is set when |encyclopedia is set | if is_set(Periodical) then -- Periodical is set when |encyclopedia is set | ||
if is_set(Title) or is_set (ScriptTitle) then | if is_set(Title) or is_set (ScriptTitle) then | ||
if not is_set(Chapter) then | if not is_set(Chapter) then | ||
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title | Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title | ||
ScriptChapter = ScriptTitle; | ScriptChapter = ScriptTitle; | ||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
ChapterURL = URL; | ChapterURL = URL; | ||
Line 2,594: | Line 2,485: | ||
ScriptTitle = ''; | ScriptTitle = ''; | ||
end | end | ||
else -- |title not set | |||
Title = Periodical; -- |encyclopedia set and |article set so map |encyclopedia to |title | Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title | ||
Periodical = ''; -- redundant so unset | Periodical = ''; -- redundant so unset | ||
end | end | ||
Line 2,615: | Line 2,506: | ||
if (config.CitationClass == "mailinglist") then | if (config.CitationClass == "mailinglist") then | ||
Periodical = A ['MailingList']; | Periodical = A ['MailingList']; | ||
elseif 'mailinglist' == | elseif 'mailinglist' == A:ORIGIN('Periodical') then | ||
Periodical = ''; -- unset because mailing list is only used for cite mailing list | Periodical = ''; -- unset because mailing list is only used for cite mailing list | ||
end | end | ||
Line 2,648: | Line 2,539: | ||
Chapter = A['Map']; | Chapter = A['Map']; | ||
ChapterURL = A['MapURL']; | ChapterURL = A['MapURL']; | ||
ChapterUrlAccess = | ChapterUrlAccess = UrlAccess; | ||
TransChapter = A['TransMap']; | TransChapter = A['TransMap']; | ||
ChapterURLorigin = A:ORIGIN('MapURL'); | ChapterURLorigin = A:ORIGIN('MapURL'); | ||
Line 2,692: | Line 2,583: | ||
-- assemble a table of parts concatenated later into Series | -- assemble a table of parts concatenated later into Series | ||
if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end | if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end | ||
if is_set(SeriesNumber) then table.insert(s, wrap_msg (' | if is_set(SeriesNumber) then table.insert(s, wrap_msg ('series', SeriesNumber, use_lowercase)); end | ||
if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end | if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end | ||
Issue = ''; -- unset because this is not a unique parameter | Issue = ''; -- unset because this is not a unique parameter | ||
Line 2,698: | Line 2,589: | ||
Chapter = Title; -- promote title parameters to chapter | Chapter = Title; -- promote title parameters to chapter | ||
ScriptChapter = ScriptTitle; | ScriptChapter = ScriptTitle; | ||
ChapterLink = TitleLink; -- alias episodelink | ChapterLink = TitleLink; -- alias episodelink | ||
TransChapter = TransTitle; | TransChapter = TransTitle; | ||
Line 2,729: | Line 2,619: | ||
-- end of {{cite episode}} stuff | -- end of {{cite episode}} stuff | ||
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data. | ||
do | do | ||
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx | if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then | ||
if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates | if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates | ||
table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message | table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message | ||
end | |||
if 'arxiv' == config.CitationClass then | |||
Periodical = 'arXiv'; -- set to arXiv for COinS; after that, must be set to empty string | |||
end | |||
if 'biorxiv' == config.CitationClass then | |||
Periodical = 'bioRxiv'; -- set to bioRxiv for COinS; after that, must be set to empty string | |||
end | end | ||
if 'citeseerx' == config.CitationClass then | |||
Periodical = 'CiteSeerX'; -- set to CiteSeerX for COinS; after that, must be set to empty string | |||
end | |||
end | end | ||
end | end | ||
Line 2,870: | Line 2,770: | ||
end | end | ||
end | end | ||
if 'none' == Title and | if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites | ||
Title = ''; -- set title to empty string | |||
add_maint_cat ('untitled'); | |||
end | end | ||
check_for_url ({ -- add error message when any of these parameters | check_for_url ({ -- add error message when any of these parameters contains a URL | ||
['title']=Title, | ['title']=Title, | ||
[A:ORIGIN('Chapter')]=Chapter, | [A:ORIGIN('Chapter')]=Chapter, | ||
[ | [A:ORIGIN('Periodical')]=Periodical, | ||
[ | [A:ORIGIN('PublisherName')] = PublisherName | ||
}); | }); | ||
Line 2,906: | Line 2,803: | ||
-- this is the function call to COinS() | -- this is the function call to COinS() | ||
local OCinSoutput = COinS({ | local OCinSoutput = COinS({ | ||
['Periodical'] = | ['Periodical'] = Periodical, | ||
['Encyclopedia'] = | ['Encyclopedia'] = Encyclopedia, | ||
['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup | ['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup | ||
['Degree'] = Degree; -- cite thesis only | ['Degree'] = Degree; -- cite thesis only | ||
Line 2,918: | Line 2,815: | ||
['Volume'] = Volume, | ['Volume'] = Volume, | ||
['Issue'] = Issue, | ['Issue'] = Issue, | ||
['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links | ['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links | ||
['Edition'] = Edition, | ['Edition'] = Edition, | ||
['PublisherName'] = PublisherName, | ['PublisherName'] = PublisherName, | ||
['URL'] = first_set ({ChapterURL, URL}, 2), | ['URL'] = first_set ({ChapterURL, URL}, 2), | ||
['Authors'] = coins_author, | ['Authors'] = coins_author, | ||
Line 2,927: | Line 2,824: | ||
}, config.CitationClass); | }, config.CitationClass); | ||
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx | -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data. | ||
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx | if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, or CiteSeerX now unset so it isn't displayed | ||
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal | Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal | ||
end | end | ||
Line 2,935: | Line 2,832: | ||
if 'newsgroup' == config.CitationClass then | if 'newsgroup' == config.CitationClass then | ||
if is_set (PublisherName) then | if is_set (PublisherName) then | ||
PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, | PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, A:ORIGIN('PublisherName'), nil )); | ||
end | end | ||
end | end | ||
-- Now perform various field substitutions. | -- Now perform various field substitutions. | ||
Line 2,984: | Line 2,883: | ||
control.maximum , contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal); | control.maximum , contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal); | ||
Contributors = list_people (control, c, contributor_etal); | Contributors = list_people (control, c, contributor_etal); | ||
-- control.maximum = #c; -- number of contributors | |||
-- Contributors = list_people(control, c, false); -- et al not currently supported | |||
end | end | ||
do -- now do authors | do -- now do authors | ||
Line 3,015: | Line 2,916: | ||
-- special case for chapter format so no error message or cat when chapter not supported | -- special case for chapter format so no error message or cat when chapter not supported | ||
if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx | if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or | ||
('citation' == config.CitationClass and | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then | ||
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | ||
end | end | ||
if not is_set(URL) then | if not is_set(URL) then | ||
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) | if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) then -- |url= required for cite web, cite podcast, and cite mailinglist | ||
table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } ); | |||
end | end | ||
Line 3,034: | Line 2,934: | ||
local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; | local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess; | ||
DeadURL = DeadURL:lower(); -- used later when assembling archived text | |||
if is_set( ArchiveURL ) then | if is_set( ArchiveURL ) then | ||
if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it | if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it | ||
Line 3,041: | Line 2,940: | ||
OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages | OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages | ||
OriginalFormat = ChapterFormat; -- and original |chapter-format= | OriginalFormat = ChapterFormat; -- and original |chapter-format= | ||
if 'no' ~= DeadURL then | |||
ChapterURL = ArchiveURL -- swap-in the archive's url | ChapterURL = ArchiveURL -- swap-in the archive's url | ||
ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages | ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages | ||
Line 3,053: | Line 2,951: | ||
OriginalFormat = Format; -- and original |format= | OriginalFormat = Format; -- and original |format= | ||
OriginalAccess = UrlAccess; | OriginalAccess = UrlAccess; | ||
if 'no' ~= DeadURL then -- if URL set then archive-url applies to it | |||
URL = ArchiveURL -- swap-in the archive's url | URL = ArchiveURL -- swap-in the archive's url | ||
URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages | URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages | ||
Line 3,063: | Line 2,960: | ||
end | end | ||
if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx | if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia | ||
('citation' == config.CitationClass and | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then | ||
local chap_param; | local chap_param; | ||
if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters | if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters | ||
Line 3,073: | Line 2,970: | ||
chap_param = A:ORIGIN ('ChapterURL') | chap_param = A:ORIGIN ('ChapterURL') | ||
elseif is_set (ScriptChapter) then | elseif is_set (ScriptChapter) then | ||
chap_param = | chap_param = A:ORIGIN ('ScriptChapter') | ||
else is_set (ChapterFormat) | else is_set (ChapterFormat) | ||
chap_param = A:ORIGIN ('ChapterFormat') | chap_param = A:ORIGIN ('ChapterFormat') | ||
Line 3,094: | Line 2,991: | ||
end | end | ||
Chapter = format_chapter_title (ScriptChapter | Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter | ||
if is_set (Chapter) then | if is_set (Chapter) then | ||
Chapter = Chapter .. ChapterFormat ; | Chapter = Chapter .. ChapterFormat ; | ||
Line 3,122: | Line 3,019: | ||
end | end | ||
if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx | if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) or | ||
('citation' == config.CitationClass and | ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or | ||
('map' == config.CitationClass and | ('map' == config.CitationClass and is_set (Periodical)) then -- special case for cite map when the map is in a periodical treat as an article | ||
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks | Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from Module provided quote marks | ||
Title = wrap_style ('quoted-title', Title); | Title = wrap_style ('quoted-title', Title); | ||
Title = script_concatenate (Title, ScriptTitle | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
TransTitle= wrap_style ('trans-quoted-title', TransTitle ); | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); | ||
elseif 'report' == config.CitationClass then -- no styling for cite report | elseif 'report' == config.CitationClass then -- no styling for cite report | ||
Title = script_concatenate (Title, ScriptTitle | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title | TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title | ||
else | else | ||
Title = wrap_style ('italic-title', Title); | Title = wrap_style ('italic-title', Title); | ||
Title = script_concatenate (Title, ScriptTitle | Title = script_concatenate (Title, ScriptTitle); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped | ||
TransTitle = wrap_style ('trans-italic-title', TransTitle); | TransTitle = wrap_style ('trans-italic-title', TransTitle); | ||
end | end | ||
Line 3,266: | Line 3,163: | ||
end | end | ||
Series = is_set (Series) and | Series = is_set(Series) and (sepc .. " " .. Series) or ""; | ||
OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation | |||
Agency = is_set (Agency) and | |||
Agency = is_set(Agency) and (sepc .. " " .. Agency) or ""; | |||
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); | Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase); | ||
------------------------------------ totally unrelated data | ------------------------------------ totally unrelated data | ||
if is_set(Via) then | |||
Via = " " .. wrap_msg ('via', Via); | |||
end | |||
--[[ | --[[ | ||
Line 3,324: | Line 3,225: | ||
ArchiveDate = set_error('archive_missing_date'); | ArchiveDate = set_error('archive_missing_date'); | ||
end | end | ||
if " | if "no" == DeadURL then | ||
local arch_text = cfg.messages['archived']; | local arch_text = cfg.messages['archived']; | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
Archived = sepc .. " " .. substitute( cfg.messages['archived- | Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'], | ||
{ external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } ); | ||
if not is_set(OriginalURL) then | if not is_set(OriginalURL) then | ||
Archived = Archived .. " " .. set_error('archive_missing_url'); | Archived = Archived .. " " .. set_error('archive_missing_url'); | ||
end | end | ||
elseif is_set(OriginalURL) then -- | elseif is_set(OriginalURL) then -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped' | ||
local arch_text = cfg.messages['archived-dead']; | local arch_text = cfg.messages['archived-dead']; | ||
if sepc ~= "." then arch_text = arch_text:lower() end | if sepc ~= "." then arch_text = arch_text:lower() end | ||
if in_array ( | if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then | ||
Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | Archived = sepc .. " " .. 'Archived from the original on ' .. ArchiveDate; -- format already styled | ||
if 'bot: unknown' == | if 'bot: unknown' == DeadURL then | ||
add_maint_cat ('bot:_unknown'); -- and add a category if not already added | add_maint_cat ('bot:_unknown'); -- and add a category if not already added | ||
else | else | ||
add_maint_cat ('unfit'); -- and add a category if not already added | add_maint_cat ('unfit'); -- and add a category if not already added | ||
end | end | ||
else -- | else -- DeadURL is empty, 'yes', 'true', or 'y' | ||
Archived = sepc .. " " .. substitute( arch_text, | Archived = sepc .. " " .. substitute( arch_text, | ||
{ external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | ||
Line 3,401: | Line 3,302: | ||
-- 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 | 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 .. " " .. | Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical) | ||
else | else | ||
Periodical = | Periodical = wrap_style ('italic-title', Periodical) | ||
end | end | ||
end | end | ||
Line 3,413: | Line 3,314: | ||
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided). | the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided). | ||
]] | ]] | ||
if "speech" == config.CitationClass then | if "speech" == config.CitationClass then -- cite speech only | ||
TitleNote = " (Speech)"; | TitleNote = " (Speech)"; -- annotate the citation | ||
if is_set (Periodical) then | if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter | ||
if is_set (Conference) then | if is_set (Conference) then -- and if |event= is set | ||
Conference = Conference .. sepc .. " "; | Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering | ||
end | end | ||
end | end | ||
Line 3,542: | Line 3,443: | ||
if is_set(PostScript) and PostScript ~= sepc then | if is_set(PostScript) and PostScript ~= sepc then | ||
text = safe_join( {text, sepc}, sepc ); | text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc. | ||
text = text:sub(1,-sepc:len()-1); | text = text:sub(1,-sepc:len()-1); | ||
end | end | ||
Line 3,594: | Line 3,495: | ||
end | end | ||
table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation | table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation | ||
if 0 ~= #z.message_tail then | if 0 ~= #z.message_tail then | ||
Line 3,654: | Line 3,555: | ||
local state; | local state; | ||
if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx | if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- limited parameter sets allowed for these templates | ||
state = whitelist.limited_basic_arguments[name]; | state = whitelist.limited_basic_arguments[name]; | ||
if true == state then return true; end -- valid actively supported parameter | if true == state then return true; end -- valid actively supported parameter | ||
Line 3,720: | Line 3,621: | ||
value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc | value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc | ||
capture = value:match ('%s+(%a[% | capture = value:match ('%s+(%a[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes | ||
if capture and validate (capture) then -- if the capture is a valid parameter name | if capture and validate (capture) then -- if the capture is a valid parameter name | ||
table.insert( z.message_tail, {set_error ('missing_pipe',parameter)}); | table.insert( z.message_tail, {set_error ('missing_pipe',parameter)}); | ||
Line 3,727: | Line 3,628: | ||
--[[--------------------------< | --[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------ | ||
This is used by templates such as {{cite book}} to create the actual citation text. | This is used by templates such as {{cite book}} to create the actual citation text. | ||
Line 3,797: | Line 3,681: | ||
is_wikilink = utilities.is_wikilink; | is_wikilink = utilities.is_wikilink; | ||
make_wikilink = utilities.make_wikilink; | make_wikilink = utilities.make_wikilink; | ||
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | ||
Line 3,878: | Line 3,761: | ||
if 'string' == type (k) then -- don't evaluate positional parameters | if 'string' == type (k) then -- don't evaluate positional parameters | ||
has_invisible_chars (k, v); | has_invisible_chars (k, v); | ||
end | end | ||
end | end |