Module:Citation/CS1: Difference between revisions

    (sync from sandbox;)
    (sync from sandbox;)
    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,
    strip_apostrophe_markup;


    local z ={}; -- tables in Module:Citation/CS1/Utilities
    local z ={}; -- tables in Module:Citation/CS1/Utilities
    Line 70: Line 71:
    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 150: Line 151:
    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 ('^[%a%d]') then -- first character must be letter or digit
    if not domain:match ('^[%w]') then -- first character must be letter or digit
    return false;
    return false;
    end
    end
    Line 157: Line 158:
    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
    local patterns = { -- patterns that look like urls
    return true;
    '%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
    elseif domain:match ('%f[%a%d][%a%d][%a%d%-]+[%a%d]%.xn%-%-[%a%d]+$') then -- internationalized domain name with ACE prefix
    '%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
    return true;
    '%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
    elseif domain:match ('%f[%a%d][%a%d]%.cash$') then -- one character/digit .cash hostname
    '%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
    return true;
    '%f[%w][%w]%.%a%a$', -- one character hostname and cctld (2 chars)
    elseif domain:match ('%f[%a%d][%a%d]%.today') then -- one character/digit .today hostname
    '%f[%w][%w][%w]%.%a%a+$', -- two character hostname and tld
    return true;
    '^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
    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)
    for _, pattern in ipairs (patterns) do -- loop through the patterns list
    return true;
    if domain:match (pattern) then
    elseif domain:match ('%f[%a][iq]%.net$') then -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
    return true; -- if a match then we think that this thing that purports to be a url is a url
    return true;
    end
    elseif domain:match ('%f[%a%d][%a%d]%.%a%a$') then -- one character hostname and cctld (2 chars)
    end
    return true;
     
    elseif domain:match ('%f[%a%d][%a%d][%a%d]%.%a%a+$') then -- two character hostname and tld
    for _, d in ipairs ({'cash', 'company', 'today', 'org'}) do -- look for single letter second level domain names for these top level domains
    return true;
    if domain:match ('%f[%w][%w]%.' .. d) then
    elseif domain:match ('^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?') then -- IPv4 address
    return true
    return true;
    end
    else
    return false;
    end
    end
    return false; -- no matches, we don't know what this thing is
    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= and |script-chapter=
    Supports |script-title=, |script-chapter=, |script-<periodical>=


    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, script_param)
    local lang=''; -- initialize to empty string
    local lang=''; -- initialize to empty string
    local name;
    local name;
    Line 538: Line 537:
    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
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message
    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')
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message
    end
    end
    lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
    lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
    else
    else
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message
    lang = ''; -- invalid so set lang to empty string
    lang = ''; -- invalid so set lang to empty string
    end
    end
    else
    table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message
    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 567: Line 570:
    ]]
    ]]


    local function script_concatenate (title, script)
    local function script_concatenate (title, script, script_param)
    if is_set (script) then
    if is_set (script) then
    script = format_script_value (script); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
    script = format_script_value (script, script_param); -- <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 593: Line 596:
    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 ); -- including template text
    return substitute( msg, str ); -- including template text
    else
    else
    return substitute( cfg.messages[key], str );
    return substitute( cfg.messages[key], str );
    Line 648: Line 651:
    end
    end


    return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil
    return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil
    end
     
     
    --[[--------------------------< F O R M A T _ P E R I O D I C A L >--------------------------------------------
     
    Format the four periodical parameters: |script-<periodical>=, |<periodical>=, and |trans-<periodical>= into a single Periodical meta-
    parameter.
     
    ]]
     
    local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
    local periodical_error = '';
     
    if not is_set (periodical) then
    periodical = ''; -- to be safe for concatenation
    else
    periodical = wrap_style ('italic-title', periodical); -- style
    end
     
    periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
     
    if is_set (trans_periodical) then
    trans_periodical = wrap_style ('trans-italic-title', trans_periodical);
    if is_set (periodical) then
    periodical = periodical ..  ' ' .. trans_periodical;
    else -- here when transchapter without chapter or script-chapter
    periodical = trans_periodical;
    periodical_error = ' ' .. set_error ('trans_missing_title', {'periodical'});
    end
    end
     
    return periodical .. periodical_error;
    end
    end


    Line 659: Line 694:
    ]]
    ]]


    local function format_chapter_title (scriptchapter, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access)
    local function format_chapter_title (scriptchapter, script_chapter_source, 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); -- make a wikisource url and label from a wikisource interwiki link
    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 677: Line 712:
    end
    end


    chapter = script_concatenate (chapter, scriptchapter) -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    chapter = script_concatenate (chapter, scriptchapter, script_chapter_source); -- <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 .. '&nbsp;', '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 .. '&nbsp;', '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 691: Line 726:
    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 697: Line 732:


    -- 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 800: Line 835:
    -- 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'] .. ': ' .. k);
    end
    end
    Line 1,039: Line 1,074:


    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,237: Line 1,272:
    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,881: Line 1,916:
    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:lower(), possible) then
    elseif in_array (value, possible) then
    return true;
    return true;
    else
    else
    Line 1,991: Line 2,026:
    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 -- if pages is only digits, assume a single page number
    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,108: Line 2,143:
    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,235: Line 2,270:
    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 is_set (Others) then
    if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
    if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor=
    add_maint_cat ('others');
    add_maint_cat ('others');
    end
    end
    end
    end


    local Year = A['Year'];
    local Year = A['Year'];
    Line 2,262: Line 2,297:
    local Chapter = A['Chapter'];
    local Chapter = A['Chapter'];
    local ScriptChapter = A['ScriptChapter'];
    local ScriptChapter = A['ScriptChapter'];
    local ScriptChapterOrigin = A:ORIGIN ('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,274: Line 2,310:
    ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
    ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
    local DeadURL = A['DeadURL']
    local UrlStatus = A['UrlStatus'];
    if not is_valid_parameter_value (DeadURL, 'dead-url', cfg.keywords ['deadurl']) then -- set in config.defaults to 'yes'
    if 'url-status' == A:ORIGIN ('UrlStatus') then -- interim: TODO: this line goes away
    DeadURL = ''; -- anything else, set to empty string
    if not is_valid_parameter_value (UrlStatus, 'url-status', cfg.keywords ['url-status']) then -- set in config.defaults to 'dead'
    end
    UrlStatus = ''; -- anything else, set to empty string
     
    end -- interim: TODO: this line goes away
    elseif is_set (A:ORIGIN ('UrlStatus')) then -- interim: while both |dead-url= and |url-status= allowed use separate keyword lists; TODO: remove this section
    if not is_valid_parameter_value (UrlStatus, A:ORIGIN ('UrlStatus'), cfg.keywords ['deadurl']) then -- interim: assume |dead-url=; use those keywords; TODO: this line goes away
    UrlStatus = ''; -- anything else, set to empty string; interim: TODO: this line goes away
    end -- interim: TODO: this line goes away
    end -- interim: TODO: this line goes away
    if in_array (UrlStatus, {'yes', 'true', 'y'}) then -- TODO: remove this whole thing when |dead-url=[yes|no] parameters removed from articles
    UrlStatus = 'dead';
    elseif 'no' == UrlStatus then
    UrlStatus = 'live';
    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,287: Line 2,335:
    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 Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
    local Periodical_origin = '';
    if is_set (Periodical) then
    Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
    local i;
    Periodical, i = strip_apostrophe_markup (Periodical); -- strip appostrophe markup so that metadata isn't contaminated
    if i then -- non-zero when markup was stripped so emit an error message
    table.insert( z.message_tail, {set_error ('apostrophe_markup', {Periodical_origin}, true)});
    end
    end
     
    local ScriptPeriodical = A['ScriptPeriodical'];
    local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
     
    if not (is_set (Periodical) or is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
    local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
    if p[config.CitationClass]  then
    table.insert( z.message_tail, {set_error ('missing_periodical', {config.CitationClass, p[config.CitationClass]}, true)});
    end
    end
     
    local TransPeriodical =  A['TransPeriodical'];


    local Series = A['Series'];
    local Series = A['Series'];
    Line 2,297: Line 2,365:
    local At;
    local At;


    if in_array (config.CitationClass, cfg.templates_using_volume) then
    if 'citation' == config.CitationClass then
    if is_set (Periodical) then
    if not in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals'
    Volume = A['Volume']; -- but does for all other 'periodicals'
    end
    elseif is_set (ScriptPeriodical) then
    if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
    Volume = A['Volume']; -- but does for all other 'periodicals'
    end
    else
    Volume = A['Volume']; -- and does for non-'periodical' cites
    end
    elseif in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
    Volume = A['Volume'];
    Volume = A['Volume'];
    end
    if 'citation' == config.CitationClass then
    if is_set (Periodical) and in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals'
    is_set (ScriptPeriodical) and in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals'
    Issue = hyphen_to_dash (A['Issue']);
    end
    elseif in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
    if not (in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (is_set (Periodical) or is_set (ScriptPeriodical))) then
    Issue = hyphen_to_dash (A['Issue']);
    end
    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,316: Line 2,404:
    local PublisherName = A['PublisherName'];
    local PublisherName = A['PublisherName'];
    local PublisherName_origin = A:ORIGIN('PublisherName');
    if is_set (PublisherName) then
    local i=0;
    PublisherName, i = strip_apostrophe_markup (PublisherName); -- strip appostrophe markup so that metadata isn't contaminated; publisher is never italicized
    if i then -- non-zero when markup was stripped so emit an error message
    table.insert( z.message_tail, {set_error ('apostrophe_markup', {PublisherName_origin}, true)});
    end
    end
    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,334: Line 2,432:
    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,345: Line 2,443:


    local ChapterUrlAccess = A['ChapterUrlAccess'];
    local ChapterUrlAccess = A['ChapterUrlAccess'];
    if not is_valid_parameter_value (ChapterUrlAccess, 'chapter-url-access', cfg.keywords ['url-access']) then -- same as url-access
    if not is_valid_parameter_value (ChapterUrlAccess, A:ORIGIN('ChapterUrlAccess'), 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', {'chapter-url'}, true ) } );
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}, true ) } );
    end
     
    local MapUrlAccess = A['MapUrlAccess'];
    if not is_valid_parameter_value (MapUrlAccess, 'map-url-access', cfg.keywords ['url-access']) then
    MapUrlAccess = nil;
    end
    if not is_set(A['MapURL']) and is_set(MapUrlAccess) then
    MapUrlAccess = nil;
    table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'map-url'}, true ) } );
    end
    end


    Line 2,371: Line 2,478:


    local ID_list = extract_ids( args );
    local ID_list = extract_ids( args );
    if is_set (DoiBroken) and not ID_list['DOI'] then
    table.insert( z.message_tail, { set_error( 'doibroken_missing_doi', A:ORIGIN('DoiBroken'))});
    end
    local ID_access_levels = extract_id_access_levels( args, ID_list );
    local ID_access_levels = extract_id_access_levels( args, ID_list );


    Line 2,407: Line 2,517:
    end
    end


    local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma
    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 == ',' ); -- used to control capitalization for certain static text
    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,427: Line 2,537:


    -- 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,440: Line 2,550:
    end
    end


    -- both |publication-place= and |place= (|location=) allowed if different
    if not is_set(PublicationPlace) and is_set(Place) then -- both |publication-place= and |place= (|location=) allowed if different
    if not is_set(PublicationPlace) and is_set(Place) then
    PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
    PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
    end
    end
    if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
    if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
    --[[
    --[[
    Line 2,452: Line 2,561:
    |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,464: Line 2,572:


    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;
    ScriptChapterOrigin = 'title';
    TransChapter = TransTitle;
    TransChapter = TransTitle;
    ChapterURL = URL;
    ChapterURL = URL;
    Line 2,485: Line 2,594:
    ScriptTitle = '';
    ScriptTitle = '';
    end
    end
    else -- |title not set
    elseif is_set (Chapter) then -- |title not set
    Title = Periodical; -- |encyclopedia set and |article set or not set so map |encyclopedia to |title
    Title = Periodical; -- |encyclopedia set and |article set so map |encyclopedia to |title
    Periodical = ''; -- redundant so unset
    Periodical = ''; -- redundant so unset
    end
    end
    Line 2,506: Line 2,615:
    if (config.CitationClass == "mailinglist") then
    if (config.CitationClass == "mailinglist") then
    Periodical = A ['MailingList'];
    Periodical = A ['MailingList'];
    elseif 'mailinglist' == A:ORIGIN('Periodical') then
    elseif 'mailinglist' == Periodical_origin 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,539: Line 2,648:
    Chapter = A['Map'];
    Chapter = A['Map'];
    ChapterURL = A['MapURL'];
    ChapterURL = A['MapURL'];
    ChapterUrlAccess = UrlAccess;
    ChapterUrlAccess = MapUrlAccess;
    TransChapter = A['TransMap'];
    TransChapter = A['TransMap'];
    ChapterURLorigin = A:ORIGIN('MapURL');
    ChapterURLorigin = A:ORIGIN('MapURL');
    Line 2,583: Line 2,692:
    -- 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 ('series', SeriesNumber, use_lowercase)); end
    if is_set(SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', 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,589: Line 2,698:
    Chapter = Title; -- promote title parameters to chapter
    Chapter = Title; -- promote title parameters to chapter
    ScriptChapter = ScriptTitle;
    ScriptChapter = ScriptTitle;
    ScriptChapterOrigin = 'title';
    ChapterLink = TitleLink; -- alias episodelink
    ChapterLink = TitleLink; -- alias episodelink
    TransChapter = TransTitle;
    TransChapter = TransTitle;
    Line 2,619: Line 2,729:
    -- end of {{cite episode}} stuff
    -- end of {{cite episode}} stuff


    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, before generation of COinS data.
    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.
    do
    do
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx'}) then
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) 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 = ({['arxiv'] = 'arXiv', ['biorxiv'] = bioRxiv, ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
    Periodical = 'CiteSeerX'; -- set to CiteSeerX for COinS; after that, must be set to empty string
    end
    end
    end
    end
    end
    Line 2,770: Line 2,870:
    end
    end
    end
    end
     
    if 'none' == Title and in_array (config.CitationClass, {'journal', 'citation'}) and is_set (Periodical) and 'journal' == A:ORIGIN('Periodical') then -- special case for journal cites
    if 'none' == Title and
    Title = ''; -- set title to empty string
    in_array (config.CitationClass, {'journal', 'citation'}) and
    add_maint_cat ('untitled');
    (is_set (Periodical) or is_set (ScriptPeriodical)) and
    ('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) 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 contains a URL
    check_for_url ({ -- add error message when any of these parameters hold a URL
    ['title']=Title,
    ['title']=Title,
    [A:ORIGIN('Chapter')]=Chapter,
    [A:ORIGIN('Chapter')]=Chapter,
    [A:ORIGIN('Periodical')]=Periodical,
    [Periodical_origin] = Periodical,
    [A:ORIGIN('PublisherName')] = PublisherName
    [PublisherName_origin] = PublisherName
    });
    });


    Line 2,803: Line 2,906:
    -- this is the function call to COinS()
    -- this is the function call to COinS()
    local OCinSoutput = COinS({
    local OCinSoutput = COinS({
    ['Periodical'] = Periodical,
    ['Periodical'] = strip_apostrophe_markup (Periodical), -- no markup in the metadata
    ['Encyclopedia'] = Encyclopedia,
    ['Encyclopedia'] = strip_apostrophe_markup (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,815: Line 2,918:
    ['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, -- any apostrophe markup already removed
    ['URL'] = first_set ({ChapterURL, URL}, 2),
    ['URL'] = first_set ({ChapterURL, URL}, 2),
    ['Authors'] = coins_author,
    ['Authors'] = coins_author,
    Line 2,824: Line 2,927:
    }, config.CitationClass);
    }, config.CitationClass);


    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, and {{cite citeseerx}} AFTER generation of COinS data.
    -- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data.
    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
    if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn 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,832: Line 2,935:
    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, A:ORIGIN('PublisherName'), nil ));
    PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, PublisherName_origin, nil ));
    end
    end
    end
    end


    -- Now perform various field substitutions.
    -- Now perform various field substitutions.
    Line 2,883: Line 2,984:
    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 2,916: Line 3,015:


    -- 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'}) or
    if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia))) then
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) 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"}) then -- |url= required for cite web, cite podcast, and cite mailinglist
    if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist
    table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
    ('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website=
    table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } );
    end
    end
    Line 2,934: Line 3,034:


    local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
    local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
    DeadURL = DeadURL:lower(); -- used later when assembling archived text
    -- DeadURL = DeadURL:lower(); -- used later when assembling archived text
    UrlStatus = UrlStatus: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 2,940: Line 3,041:
    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
    -- if 'no' ~= DeadURL then
    if 'live' ~= UrlStatus 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 2,951: Line 3,053:
    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
    -- if 'no' ~= DeadURL then -- if URL set then archive-url applies to it
    if 'live' ~= UrlStatus 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 2,960: Line 3,063:
    end
    end


    if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx'}) or -- if any of the 'periodical' cites except encyclopedia
    if in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) then
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) 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 2,970: Line 3,073:
    chap_param = A:ORIGIN ('ChapterURL')
    chap_param = A:ORIGIN ('ChapterURL')
    elseif is_set (ScriptChapter) then
    elseif is_set (ScriptChapter) then
    chap_param = A:ORIGIN ('ScriptChapter')
    chap_param = ScriptChapterOrigin;
    else is_set (ChapterFormat)
    else is_set (ChapterFormat)
    chap_param = A:ORIGIN ('ChapterFormat')
    chap_param = A:ORIGIN ('ChapterFormat')
    Line 2,991: Line 3,094:
    end
    end


    Chapter = format_chapter_title (ScriptChapter, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
    Chapter = format_chapter_title (ScriptChapter, ScriptChapterOrigin, 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,019: Line 3,122:
    end
    end
    if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx'}) or
    if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
    ('citation' == config.CitationClass and is_set (Periodical) and not is_set (Encyclopedia)) or
    ('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) or
    ('map' == config.CitationClass and is_set (Periodical)) then -- special case for cite map when the map is in a periodical treat as an article
    ('map' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical))) 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); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <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); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <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); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
    Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <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,163: Line 3,266:
    end
    end


    Series = is_set(Series) and (sepc .. " " .. Series) or "";
    Series = is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
    OrigYear = is_set(OrigYear) and (" [" .. OrigYear .. "]") or ""; -- TODO: presentation
    OrigYear = is_set (OrigYear) and wrap_msg ('origyear', OrigYear) or '';
     
    Agency = is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";
    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 = is_set (Via) and  wrap_msg ('via', Via) or '';
    Via = " " .. wrap_msg ('via', Via);
    end


    --[[
    --[[
    Line 3,225: Line 3,324:
    ArchiveDate = set_error('archive_missing_date');
    ArchiveDate = set_error('archive_missing_date');
    end
    end
    if "no" == DeadURL then
    if "live" == UrlStatus then
    local arch_text = cfg.messages['archived'];
    local arch_text = cfg.messages['archived'];
    if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
    Archived = sepc .. " " .. substitute( cfg.messages['archived-not-dead'],
    Archived = sepc .. " " .. substitute( cfg.messages['archived-live'],
    { 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 -- DeadURL is empty, 'yes', 'true', 'y', 'unfit', 'usurped'
    elseif is_set(OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
    local arch_text = cfg.messages['archived-dead'];
    local arch_text = cfg.messages['archived-dead'];
    if sepc ~= "." then arch_text = arch_text:lower() end
    if sepc ~= "." then arch_text = arch_text:lower() end
    if in_array (DeadURL, {'unfit', 'usurped', 'bot: unknown'}) then
    if in_array (UrlStatus, {'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' == DeadURL then
    if 'bot: unknown' == UrlStatus 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 -- DeadURL is empty, 'yes', 'true', or 'y'
    else -- UrlStatus is empty, 'dead'
    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,302: Line 3,401:
    -- Several of the above rely upon detecting this as nil, so do it last.
    -- Several of the above rely upon detecting this as nil, so do it last.
    if is_set(Periodical) then
    if (is_set (Periodical) or is_set (ScriptPeriodical) or is_set (TransPeriodical)) then
    if is_set(Title) or is_set(TitleNote) then  
    if is_set(Title) or is_set(TitleNote) then  
    Periodical = sepc .. " " .. wrap_style ('italic-title', Periodical)  
    Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
    else  
    else  
    Periodical = wrap_style ('italic-title', Periodical)
    Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
    end
    end
    end
    end
    Line 3,314: Line 3,413:
    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 -- cite speech only
    if "speech" == config.CitationClass then -- cite speech only
    TitleNote = " (Speech)"; -- annotate the citation
    TitleNote = " (Speech)"; -- annotate the citation
    if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter  
    if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter  
    if is_set (Conference) then -- and if |event= is set
    if is_set (Conference) then -- and if |event= is set
    Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
    Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
    end
    end
    end
    end
    Line 3,443: Line 3,542:
    if is_set(PostScript) and PostScript ~= sepc then
    if is_set(PostScript) and PostScript ~= sepc then
    text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc.
    text = 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,495: Line 3,594:
    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,555: Line 3,654:
    local state;
    local state;
    if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx'}) then -- limited parameter sets allowed for these templates
    if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) 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,621: Line 3,720:
    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[%a%d]+)%s*=') or value:match ('^(%a[%a%d]+)%s*='); -- find and categorize parameters with possible missing pipes
    capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%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,628: Line 3,727:




    --[[--------------------------< C S 1 . C I T A T I O N >------------------------------------------------------
    --[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >--------------------------------------
     
    look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked
     
    ]]
     
    local function has_extraneous_punc (param, value)
    if cfg.punct_skip[param] then
    return; -- parameter name found in the skip table so done
    end
    if value:match ('[,;:]$') then
    add_maint_cat ('extra_punct'); -- has extraneous punctuation; add maint cat
    end
    end
     
     
    --[[--------------------------< 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,681: Line 3,797:
    is_wikilink = utilities.is_wikilink;
    is_wikilink = utilities.is_wikilink;
    make_wikilink = utilities.make_wikilink;
    make_wikilink = utilities.make_wikilink;
    strip_apostrophe_markup = utilities.strip_apostrophe_markup;


    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,761: Line 3,878:
    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);
    has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values
    end
    end
    end
    end
    Retrieved from "https://nonbinary.wiki/wiki/Module:Citation/CS1"