Ikwipedia

Module:Citation/CS1: Difference between revisions

sync from sandbox;
 
m 1 revision imported
 
(4 intermediate revisions by 2 users not shown)
Line 30: Line 30:
local added_numeric_name_errs; -- Boolean flag so we only emit one numeric name error / category and stop testing names once an error is encountered
local added_numeric_name_errs; -- Boolean flag so we only emit one numeric name error / category and stop testing names once an error is encountered
local added_numeric_name_maint; -- Boolean flag so we only emit one numeric name maint category and stop testing names once a category has been emitted
local added_numeric_name_maint; -- Boolean flag so we only emit one numeric name maint category and stop testing names once a category has been emitted
local Frame; -- holds the module's frame table
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
local is_sandbox; -- true when using sandbox modules to render citation
local is_sandbox; -- true when using sandbox modules to render citation
Line 148: Line 147:
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
'[%a%d]+%:?'                                                            -- IPv6 address
}
}


Line 245: Line 245:
local function link_param_ok (value)
local function link_param_ok (value)
local scheme, domain;
local scheme, domain;
if value:find ('[<>%[%]|{}]') then -- if any prohibited characters
if value:find ('[<>%[%]|{}]') then                                         -- if any prohibited characters
return false;
return false;
end
end
Line 343: Line 343:
elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text
elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
elseif value:match ('//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; may have leading or trailing plain text
elseif value:match ('^//%S+') or value:match ('%s//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; authority indicator (//) must be be preceded nothing or by whitespace
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain
scheme, domain = split_url (value:match ('(//%S+)')); -- what is left should be the domain
else
else
Line 2,031: Line 2,031:


local function get_v_name_table (vparam, output_table, output_link_table)
local function get_v_name_table (vparam, output_table, output_link_table)
local _, accept = utilities.has_accept_as_written (vparam);
if accept then
utilities.add_prop_cat ('vanc-accept'); -- add properties category
end
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas
local name_table = mw.text.split(vparam, "%s*,%s*"); -- names are separated by commas
local wl_type, label, link; -- wl_type not used here; just a placeholder
local wl_type, label, link; -- wl_type not used here; just a placeholder
Line 2,606: Line 2,610:




--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
--[[--------------------------< M O D E _ S E T >--------------------------------------------------------------


This is the main function doing the majority of the citation formatting.
fetch global mode setting from {{cs1 config}} (if present) or from |mode= (if present); global setting overrides
local |mode= parameter value. When both are present, emit maintenance message


]]
]]


local function citation0( config, args )
local function mode_set (Mode, Mode_origin)
--[[  
local mode;
Load Input Parameters
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}}; nil when empty or assigned value invalid
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
mode = is_valid_parameter_value (cfg.global_cs1_config_t['Mode'], 'cs1 config: mode', cfg.keywords_lists['mode'], ''); -- error messaging 'param' here is a hoax
]]
else
local A = argument_wrapper ( args );
mode = is_valid_parameter_value (Mode, Mode_origin, cfg.keywords_lists['mode'], '');
local i
end
 
if cfg.global_cs1_config_t['Mode'] and utilities.is_set (Mode) then -- when template has |mode=<something> which global setting has overridden
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end
return mode;
end
 
 
--[[--------------------------< Q U O T E _ M A K E >----------------------------------------------------------
 
create quotation from |quote=, |trans-quote=, and/or script-quote= with or without |quote-page= or |quote-pages=
 
when any of those three quote parameters are set, this function unsets <PostScript>.  When none of those parameters
are set, |quote-page= and |quote-pages= are unset to nil so that they are not included in the template's metadata
 
]]


-- Pick out the relevant fields from the arguments. Different citation templates
local function quote_make (quote, trans_quote, script_quote, quote_page, quote_pages, nopp, sepc, postscript)
-- define different field names for the same underlying things.
if utilities.is_set (quote) or utilities.is_set (trans_quote) or utilities.is_set (script_quote) then


local author_etal;
if utilities.is_set (quote) then
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
if quote:sub(1, 1) == '"' and quote:sub(-1, -1) == '"' then -- if first and last characters of quote are quote marks
local Authors;
quote = quote:sub(2, -2); -- strip them off
local NameListStyle;
end
if cfg.global_cs1_config_t['NameListStyle'] then -- global setting in {{cs1 config}} overrides local |name-list-style= parameter value; nil when empty or assigned value invalid
end
NameListStyle = is_valid_parameter_value (cfg.global_cs1_config_t['NameListStyle'], 'cs1 config: name-list-style', cfg.keywords_lists['name-list-style'], ''); -- error messaging 'param' here is a hoax
else
quote = kern_quotes (quote); -- kern if needed
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
quote = utilities.wrap_style ('quoted-text', quote ); -- wrap in <q>...</q> tags
if utilities.is_set (script_quote) then
quote = script_concatenate (quote, script_quote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
end
end


if cfg.global_cs1_config_t['NameListStyle'] and utilities.is_set (A['NameListStyle']) then -- when template has |name-list-style=<something> which global setting has overridden
if utilities.is_set (trans_quote) then
utilities.set_message ('maint_overridden_setting'); -- set a maint message
if trans_quote:sub(1, 1) == '"' and trans_quote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
trans_quote = trans_quote:sub(2, -2); -- strip them off
end
quote = quote .. " " .. utilities.wrap_style ('trans-quoted-title', trans_quote );
end
end


local Collaboration = A['Collaboration'];
if utilities.is_set (quote_page) or utilities.is_set (quote_pages) then -- add page prefix
 
local quote_prefix = '';
do -- to limit scope of selected
if utilities.is_set (quote_page) then
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
extra_text_in_page_check (quote_page, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
if 1 == selected then
if not nopp then
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_page}), '', '', '';
elseif 2 == selected then
else
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_page}), '', '', '';
a, author_etal = parse_vauthors_veditors (args, A['Vauthors'], 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
end
elseif 3 == selected then
elseif utilities.is_set (quote_pages) then
Authors = A['Authors']; -- use content of |people= or |credits=; |authors= is deprecated; TODO: constrain |people= and |credits= to cite av media, episode, serial?
extra_text_in_page_check (quote_pages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
end
if tonumber(quote_pages) ~= nil and not nopp then -- if only digits, assume single page
if utilities.is_set (Collaboration) then
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_pages}), '', '';
author_etal = true; -- so that |display-authors=etal not required
elseif not nopp then
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, quote_pages}), '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_pages}), '', '';
end
end
                       
quote = quote_prefix .. ": " .. quote;
else
quote = sepc .. " " .. quote;
end
end
postscript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
elseif utilities.is_set (quote_page) or utilities.is_set (quote_pages) then
quote_page = nil; -- unset; these require |quote=; TODO: error message?
quote_pages = nil;
end
end


local editor_etal;
return quote, quote_page, quote_pages, postscript;
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
end
 
 
--[[--------------------------< C H E C K _ P U B L I S H E R _ N A M E >--------------------------------------
 
look for variations of '<text>: <text>' that might be '<location>: <publisher>' in |publisher= parameter value.
when found, emit a maintenance message; return nil else
 
<publisher> is the value assigned to |publisher= or |institution=
 
]]


do -- to limit scope of selected
local function check_publisher_name (publisher)
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
local patterns_t = {
if 1 == selected then
'^[%w%s]+%s*:%s*[%w%s]+$', -- plain text <location>: <publisher>
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
'^%[+[%w%s:|]+%]+%s*:%s*[%w%s]+$', -- partially wikilinked [[<location>]]: <publisher>
elseif 2 == selected then
'^[%w%s]+%s*:%s*%[+[%w%s:|]+%]+$', -- partially wikilinked <location>: [[<publisher>]]
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
'^%[+[%w%s:|]+%]+%s*:%s*%[+[%w%s:|]+%]+$', -- wikilinked [[<location>]]: [[<publisher>]]
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
}
for _, pattern in ipairs (patterns_t) do -- spin through the patterns_t sequence
if mw.ustring.match (publisher, pattern) then -- does this pattern match?
utilities.set_message ('maint_publisher_location'); -- set a maint message
return; -- and done
end
end
end
end
end
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases
 
local Chapter_origin = A:ORIGIN ('Chapter');
local Contribution; -- because contribution is required for contributor(s)
if 'contribution' == Chapter_origin then
Contribution = Chapter; -- get the name of the contribution
end
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
if 0 < #c then
if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=
utilities.set_message ('err_contributor_missing_required_param', 'contribution'); -- add missing contribution error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
if 0 == #a then -- |contributor= requires |author=
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
else -- if not a book cite
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
end
Contribution = nil; -- unset
end


local Title = A['Title'];
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
local TitleLink = A['TitleLink'];


local auto_select = ''; -- default is auto
This is the main function doing the majority of the citation formatting.
local accept_link;
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
auto_select = TitleLink; -- remember selection for later
TitleLink = ''; -- treat as if |title-link= would have been empty
end


TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set
]]


local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
local function citation0( config, args )
if 'map' == config.CitationClass and 'section' == Chapter_origin then
--[[
Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}}
Load Input Parameters
Chapter = ''; -- unset for now; will be reset later from |map= if present
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
end
]]
local A = argument_wrapper ( args );
local i
 
-- Pick out the relevant fields from the arguments.  Different citation templates
-- define different field names for the same underlying things.


local Periodical = A['Periodical'];
local author_etal;
local Periodical_origin = A:ORIGIN('Periodical');
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local ScriptPeriodical = A['ScriptPeriodical'];
local Authors;
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
local NameListStyle;
local TransPeriodical = A['TransPeriodical'];
if cfg.global_cs1_config_t['NameListStyle'] then -- global setting in {{cs1 config}} overrides local |name-list-style= parameter value; nil when empty or assigned value invalid
local TransPeriodical_origin =  A:ORIGIN ('TransPeriodical');
NameListStyle = is_valid_parameter_value (cfg.global_cs1_config_t['NameListStyle'], 'cs1 config: name-list-style', cfg.keywords_lists['name-list-style'], ''); -- error messaging 'param' here is a hoax
else
if (utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical))) then
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
local param;
if utilities.is_set (Periodical) then -- get a parameter name from one of these periodical related meta-parameters
Periodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = Periodical_origin -- get parameter name for error messaging
elseif utilities.is_set (TransPeriodical) then
TransPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = TransPeriodical_origin; -- get parameter name for error messaging
elseif utilities.is_set (ScriptPeriodical) then
ScriptPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = ScriptPeriodical_origin; -- get parameter name for error messaging
end
end


if utilities.is_set (param) then -- if we found one
if cfg.global_cs1_config_t['NameListStyle'] and utilities.is_set (A['NameListStyle']) then -- when template has |name-list-style=<something> which global setting has overridden
utilities.set_message ('err_periodical_ignored', {param}); -- emit an error message
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end
end
end


if utilities.is_set (Periodical) then
local Collaboration = A['Collaboration'];
local i;
 
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
do -- to limit scope of selected
if i then -- non-zero when markup was stripped so emit an error message
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList');
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
if 1 == selected then
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
elseif 2 == selected then
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
a, author_etal = parse_vauthors_veditors (args, A['Vauthors'], 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
elseif 3 == selected then
Authors = A['Authors']; -- use content of |people= or |credits=; |authors= is deprecated; TODO: constrain |people= and |credits= to cite av media, episode, serial?
end
if utilities.is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
end
end
end
end


if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
local editor_etal;
if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error TODO: make a function for this and similar?
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')});
end


Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
do -- to limit scope of selected
Periodical_origin = A:ORIGIN('MailingList');
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
end
if 1 == selected then
 
e, editor_etal = extract_names (args, 'EditorList'); -- fetch editor list from |editorn= / |editor-lastn= / |editor-firstn=, |editor-linkn=, and |editor-maskn=
-- web and news not tested for now because of
elseif 2 == selected then
-- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
-- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
if p[config.CitationClass]  then
utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]});
end
end
end
end
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases
local Chapter_origin = A:ORIGIN ('Chapter');
local Contribution; -- because contribution is required for contributor(s)
if 'contribution' == Chapter_origin then
Contribution = Chapter; -- get the name of the contribution
end
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
local Volume;
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
if 'citation' == config.CitationClass then
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
if utilities.is_set (Periodical) then
if not utilities.in_array (Periodical_origin, cfg.citation_no_volume_t) then -- {{citation}} does not render |volume= when these parameters are used
if 0 < #c then
Volume = A['Volume']; -- but does for all other 'periodicals'
if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=
utilities.set_message ('err_contributor_missing_required_param', 'contribution'); -- add missing contribution error message
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
elseif utilities.is_set (ScriptPeriodical) then
if 0 == #a then -- |contributor= requires |author=
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
Volume = A['Volume']; -- but does for all other 'periodicals'
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
else
Volume = A['Volume']; -- and does for non-'periodical' cites
end
end
elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
else -- if not a book cite
Volume = A['Volume'];
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
end
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');
end
Contribution = nil; -- unset
end


local Issue;
local Title = A['Title'];
if 'citation' == config.CitationClass then
local TitleLink = A['TitleLink'];
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, cfg.citation_issue_t) then -- {{citation}} may render |issue= when these parameters are used
Issue = utilities.hyphen_to_dash (A['Issue']);
end
elseif utilities.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 (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
Issue = utilities.hyphen_to_dash (A['Issue']);
end
end
local ArticleNumber;


if utilities.in_array (config.CitationClass, {'journal', 'conference'}) or ('citation' == config.CitationClass and utilities.is_set (Periodical) and 'journal' == Periodical_origin) then
local auto_select = ''; -- default is auto
ArticleNumber = A['ArticleNumber'];
local accept_link;
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
auto_select = TitleLink; -- remember selection for later
TitleLink = ''; -- treat as if |title-link= would have been empty
end
end


extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');
TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set


local Page;
local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
local Pages;
if 'map' == config.CitationClass and 'section' == Chapter_origin then
local At;
Section = A['Chapter']; -- get |section= from |chapter= alias list; |chapter= and the other aliases not supported in {{cite map}}
local QuotePage;
Chapter = ''; -- unset for now; will be reset later from |map= if present
local QuotePages;
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then -- TODO: rewrite to emit ignored parameter error message?
Page = A['Page'];
Pages = utilities.hyphen_to_dash (A['Pages']);
At = A['At'];
QuotePage = A['QuotePage'];
QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
end
end


local Edition = A['Edition'];
local Periodical = A['Periodical'];
local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
local Periodical_origin = A:ORIGIN('Periodical');
local Place = place_check (A['Place'], A:ORIGIN('Place'));
local ScriptPeriodical = A['ScriptPeriodical'];
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
local TransPeriodical = A['TransPeriodical'];
local TransPeriodical_origin =  A:ORIGIN ('TransPeriodical');
local PublisherName = A['PublisherName'];
if (utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical))) then
local PublisherName_origin = A:ORIGIN('PublisherName');
local param;
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then
if utilities.is_set (Periodical) then -- get a parameter name from one of these periodical related meta-parameters
local i = 0;
Periodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized
param = Periodical_origin -- get parameter name for error messaging
if i and (0 < i) then -- non-zero when markup was stripped so emit an error message
elseif utilities.is_set (TransPeriodical) then
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
TransPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = TransPeriodical_origin; -- get parameter name for error messaging
elseif utilities.is_set (ScriptPeriodical) then
ScriptPeriodical = ''; -- unset because not valid {{cite book}} or {{cite encyclopedia}} parameters
param = ScriptPeriodical_origin; -- get parameter name for error messaging
end
 
if utilities.is_set (param) then -- if we found one
utilities.set_message ('err_periodical_ignored', {param}); -- emit an error message
end
end
end
end
 
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then
if utilities.is_set (Periodical) then
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'});
local i;
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
if i then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
end
end
end


local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
local Newsgroup_origin = A:ORIGIN('Newsgroup');
if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error TODO: make a function for this and similar?
 
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')});
if 'newsgroup' == config.CitationClass then
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
end
end


PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
Periodical_origin = A:ORIGIN('MailingList');
end
end


local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL?
-- web and news not tested for now because of
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
-- Wikipedia:Administrators%27_noticeboard#Is_there_a_semi-automated_tool_that_could_fix_these_annoying_"Cite_Web"_errors?
if not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then
-- local p = {['journal'] = 'journal', ['magazine'] = 'magazine', ['news'] = 'newspaper', ['web'] = 'website'}; -- for error message
UrlAccess = nil;
local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message
utilities.set_message ('err_param_access_requires_param', 'url');
if p[config.CitationClass]  then
utilities.set_message ('err_missing_periodical', {config.CitationClass, p[config.CitationClass]});
end
end
end
local ChapterURL = A['ChapterURL'];
local Volume;
local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
if 'citation' == config.CitationClass then
if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then
if utilities.is_set (Periodical) then
ChapterUrlAccess = nil;
if not utilities.in_array (Periodical_origin, cfg.citation_no_volume_t) then -- {{citation}} does not render |volume= when these parameters are used
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')});
Volume = A['Volume']; -- but does for all other 'periodicals'
end
end
elseif utilities.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 utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
Volume = A['Volume'];
end
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');


local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
local Issue;
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then
if 'citation' == config.CitationClass then
MapUrlAccess = nil;
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, cfg.citation_issue_t) then -- {{citation}} may render |issue= when these parameters are used
utilities.set_message ('err_param_access_requires_param', {'map-url'});
Issue = utilities.hyphen_to_dash (A['Issue']);
end
end
 
elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
Issue = utilities.hyphen_to_dash (A['Issue']);
 
-- check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
if not utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if cfg.uncategorized_namespaces[this_page.namespace] then -- is this page's namespace id one of the uncategorized namespace ids?
no_tracking_cats = "true"; -- set no_tracking_cats
end
for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
if this_page.text:match (v) then -- test page name against each pattern
no_tracking_cats = "true"; -- set no_tracking_cats
break; -- bail out if one is found
end
end
end
end
end
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
utilities.select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'err_redundant_parameters'); -- this is a dummy call simply to get the error message and category
local coins_pages;
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);
local ArticleNumber;


local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);
if utilities.in_array (config.CitationClass, {'journal', 'conference'}) or ('citation' == config.CitationClass and utilities.is_set (Periodical) and 'journal' == Periodical_origin) then
 
ArticleNumber = A['ArticleNumber'];
if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
utilities.add_prop_cat ('location-test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
if PublicationPlace == Place then
Place = ''; -- unset; don't need both if they are the same
end
elseif not utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- when only |place= (|location=) is set ...
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
extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');


local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local Page;
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local Pages;
local ScriptChapter = A['ScriptChapter'];
local At;
local ScriptChapter_origin = A:ORIGIN ('ScriptChapter');
local QuotePage;
local Format = A['Format'];
local QuotePages;
local ChapterFormat = A['ChapterFormat'];
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then -- TODO: rewrite to emit ignored parameter error message?
local TransChapter = A['TransChapter'];
Page = A['Page'];
local TransChapter_origin = A:ORIGIN ('TransChapter');
Pages = utilities.hyphen_to_dash (A['Pages']);
local TransTitle = A['TransTitle'];
At = A['At'];
local ScriptTitle = A['ScriptTitle'];
QuotePage = A['QuotePage'];
QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
--[[
end
Parameter remapping for cite encyclopedia:
 
When the citation has these parameters:
local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= for rendering
|encyclopedia= and |article= then map |encyclopedia= to |title= for rendering


|trans-title= maps to |trans-chapter= when |title= is re-mapped
local Mode = mode_set (A['Mode'], A:ORIGIN('Mode'));
|url= maps to |chapter-url= when |title= is remapped
All other combinations of |encyclopedia=, |title=, and |article= are not modified
]]


local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
-- separator character and postscript
local ScriptEncyclopedia = A['ScriptEncyclopedia'];
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
local TransEncyclopedia = A['TransEncyclopedia'];
local Quote;
Quote, QuotePage, QuotePages, PostScript = quote_make (A['Quote'], A['TransQuote'], A['ScriptQuote'], QuotePage, QuotePages, NoPP, sepc, PostScript);


if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
local Edition = A['Edition'];
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace'));
if utilities.is_set (Encyclopedia) then
local Place = place_check (A['Place'], A:ORIGIN('Place'));
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
else
local PublisherName = A['PublisherName'];
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('ScriptEncyclopedia')});
local PublisherName_origin = A:ORIGIN('PublisherName');
end
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then
Encyclopedia = nil; -- unset these because not supported by this template
local i = 0;
ScriptEncyclopedia = nil;
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized
TransEncyclopedia = nil;
if i and (0 < i) then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
end
end
elseif utilities.is_set (TransEncyclopedia) then
end
utilities.set_message ('err_trans_missing_title', {'encyclopedia'});
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'});
end
end


if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
if utilities.is_set (Periodical) and utilities.is_set (Encyclopedia) then -- when both parameters set emit an error message; {{citation}} only; Periodical not allowed in {{cite encyclopedia}}
local Newsgroup_origin = A:ORIGIN('Newsgroup');
utilities.set_message ('err_periodical_ignored', {Periodical_origin});
 
if 'newsgroup' == config.CitationClass then
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
end
end


if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then
PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia
end
Periodical_origin = A:ORIGIN ('Encyclopedia');
 
ScriptPeriodical = ScriptEncyclopedia;
if 'book' == config.CitationClass or 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and not utilities.is_set (Periodical)) then
ScriptPeriodical_origin = A:ORIGIN ('ScriptEncyclopedia');
local accept;
PublisherName, accept = utilities.has_accept_as_written (PublisherName); -- check for and remove accept-as-written markup from |publisher= wrapped
if not accept then -- when no accept-as-written markup
check_publisher_name (PublisherName); -- emit maint message when |publisher= might be prefixed with publisher's location
end
end


if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then
local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL?
if not utilities.is_set (Chapter) then
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil);
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= params to |article= params for rendering
ScriptChapter = ScriptTitle;
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
UrlAccess = nil;
TransChapter = TransTitle;
utilities.set_message ('err_param_access_requires_param', 'url');
ChapterURL = URL;
end
ChapterURL_origin = URL_origin;
ChapterUrlAccess = UrlAccess;
local ChapterURL = A['ChapterURL'];
ChapterFormat = Format;
local ChapterUrlAccess = is_valid_parameter_value (A['ChapterUrlAccess'], A:ORIGIN('ChapterUrlAccess'), cfg.keywords_lists['url-access'], nil);
 
if not utilities.is_set (ChapterURL) and utilities.is_set (ChapterUrlAccess) then
if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then
ChapterUrlAccess = nil;
Chapter = utilities.make_wikilink (TitleLink, Chapter);
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')});
end
Title = Periodical; -- now map |encyclopedia= params to |title= params for rendering
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
URL = '';
Format = '';
TitleLink = '';
end
elseif utilities.is_set (Chapter) or utilities.is_set (ScriptChapter) then -- |title= not set
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= for rendering
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
end
end
end
end


-- special case for cite techreport.
local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil);
local ID = A['ID'];
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then
if (config.CitationClass == "techreport") then -- special case for cite techreport
MapUrlAccess = nil;
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
utilities.set_message ('err_param_access_requires_param', {'map-url'});
if not utilities.is_set (ID) then -- can we use ID for the "number"?
end
ID = A['Number']; -- yes, use it
 
else -- ID has a value so emit error message
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'number')});
local no_tracking_cats = is_valid_parameter_value (A['NoTracking'], A:ORIGIN('NoTracking'), cfg.keywords_lists['yes_true_y'], nil);
 
-- check this page to see if it is in one of the namespaces that cs1 is not supposed to add to the error categories
if not utilities.is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if cfg.uncategorized_namespaces[this_page.namespace] then -- is this page's namespace id one of the uncategorized namespace ids?
no_tracking_cats = "true"; -- set no_tracking_cats
end
for _, v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
if this_page.text:match (v) then -- test page name against each pattern
no_tracking_cats = "true"; -- set no_tracking_cats
break; -- bail out if one is found
end
end
end
end
end
end
-- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)
utilities.select_one (args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'err_redundant_parameters'); -- this is a dummy call simply to get the error message and category


-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
local coins_pages;
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
local Conference = A['Conference'];
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);
local BookTitle = A['BookTitle'];
 
local TransTitle_origin = A:ORIGIN ('TransTitle');
if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
if 'conference' == config.CitationClass then
utilities.add_prop_cat ('location-test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
if utilities.is_set (BookTitle) then
if PublicationPlace == Place then
Chapter = Title;
Place = ''; -- unset; don't need both if they are the same
Chapter_origin = 'title';
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
URL_origin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
TransChapter_origin = TransTitle_origin;
Title = BookTitle;
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
end
elseif 'speech' ~= config.CitationClass then
elseif not utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- when only |place= (|location=) is set ...
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
end
-- CS1/2 mode
local Mode;
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}} overrides local |mode= parameter value; nil when empty or assigned value invalid
Mode = is_valid_parameter_value (cfg.global_cs1_config_t['Mode'], 'cs1 config: mode', cfg.keywords_lists['mode'], ''); -- error messaging 'param' here is a hoax
else
Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], '');
end


if cfg.global_cs1_config_t['Mode'] and utilities.is_set (A['Mode']) then -- when template has |mode=<something> which global setting has overridden
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
utilities.set_message ('maint_overridden_setting'); -- set a maint message
end


-- separator character and postscript
local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
-- controls capitalization of certain static text
local ScriptChapter = A['ScriptChapter'];
local use_lowercase = ( sepc == ',' );
local ScriptChapter_origin = A:ORIGIN ('ScriptChapter');
local Format = A['Format'];
local ChapterFormat = A['ChapterFormat'];
local TransChapter = A['TransChapter'];
local TransChapter_origin = A:ORIGIN ('TransChapter');
local TransTitle = A['TransTitle'];
local ScriptTitle = A['ScriptTitle'];
-- cite map oddities
--[[
local Cartography = "";
Parameter remapping for cite encyclopedia:
local Scale = "";
When the citation has these parameters:
local Sheet = A['Sheet'] or '';
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title= for rendering
local Sheets = A['Sheets'] or '';
|encyclopedia= and |article= then map |encyclopedia= to |title= for rendering
if config.CitationClass == "map" then
if utilities.is_set (Chapter) then --TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'map') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', Chapter_origin)}); -- add error message
end
Chapter = A['Map'];
Chapter_origin = A:ORIGIN('Map');
ChapterURL = A['MapURL'];
ChapterURL_origin = A:ORIGIN('MapURL');
TransChapter = A['TransMap'];
ScriptChapter = A['ScriptMap']
ScriptChapter_origin = A:ORIGIN('ScriptMap')


ChapterUrlAccess = MapUrlAccess;
|trans-title= maps to |trans-chapter= when |title= is re-mapped
ChapterFormat = A['MapFormat'];
|url= maps to |chapter-url= when |title= is remapped
All other combinations of |encyclopedia=, |title=, and |article= are not modified
]]


Cartography = A['Cartography'];
local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
if utilities.is_set ( Cartography ) then
local ScriptEncyclopedia = A['ScriptEncyclopedia'];
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
local TransEncyclopedia = A['TransEncyclopedia'];
end
Scale = A['Scale'];
if utilities.is_set ( Scale ) then
Scale = sepc .. " " .. Scale;
end
end


-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
local Series = A['Series'];
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
if utilities.is_set (Encyclopedia) then
local SeriesLink = A['SeriesLink'];
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
else
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('ScriptEncyclopedia')});
end
Encyclopedia = nil; -- unset these because not supported by this template
ScriptEncyclopedia = nil;
TransEncyclopedia = nil;
end
elseif utilities.is_set (TransEncyclopedia) then
utilities.set_message ('err_trans_missing_title', {'encyclopedia'});
end


SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set
if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
if utilities.is_set (Periodical) and utilities.is_set (Encyclopedia) then -- when both parameters set emit an error message; {{citation}} only; Periodical not allowed in {{cite encyclopedia}}
utilities.set_message ('err_periodical_ignored', {Periodical_origin});
end


local Network = A['Network'];
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then
local Station = A['Station'];
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia
local s, n = {}, {};
Periodical_origin = A:ORIGIN ('Encyclopedia');
-- do common parameters first
ScriptPeriodical = ScriptEncyclopedia;
if utilities.is_set (Network) then table.insert(n, Network); end
ScriptPeriodical_origin = A:ORIGIN ('ScriptEncyclopedia');
if utilities.is_set (Station) then table.insert(n, Station); end
ID = table.concat(n, sepc .. ' ');
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];


if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set TODO: make a function for this and similar?
if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
if not utilities.is_set (Chapter) then
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= params to |article= params for rendering
end
ScriptChapter = ScriptTitle;
-- assemble a table of parts concatenated later into Series
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
TransChapter = TransTitle;
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
ChapterURL = URL;
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
ChapterURL_origin = URL_origin;
Issue = ''; -- unset because this is not a unique parameter
ChapterUrlAccess = UrlAccess;
ChapterFormat = Format;
Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
ChapterLink = TitleLink; -- alias |episode-link=
TransChapter = TransTitle;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
ChapterFormat = Format;


Title = Series; -- promote series to title
if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then
TitleLink = SeriesLink;
Chapter = utilities.make_wikilink (TitleLink, Chapter);
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
end
Title = Periodical; -- now map |encyclopedia= params to |title= params for rendering
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
URL = '';
Format = '';
TitleLink = '';
end
elseif utilities.is_set (Chapter) or utilities.is_set (ScriptChapter) then -- |title= not set
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title= for rendering
ScriptTitle = ScriptPeriodical or '';
TransTitle = TransEncyclopedia or '';
Periodical = ''; -- redundant so unset
ScriptPeriodical = '';
end
end
end


if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL
-- special case for cite techreport.
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
local ID = A['ID'];
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode;
if (config.CitationClass == "techreport") then -- special case for cite techreport
Series = utilities.make_wikilink (ChapterLink, Series);
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if not utilities.is_set (ID) then -- can we use ID for the "number"?
ID = A['Number']; -- yes, use it
else -- ID has a value so emit error message
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'number')});
end
end
URL = ''; -- unset
TransTitle = '';
ScriptTitle = '';
Format = '';
else -- now oddities that are cite serial
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
Series = utilities.make_wikilink (SeriesLink, Series);
end
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
end
end
end
end
-- end of {{cite episode}} stuff


-- handle type parameter for those CS1 citations that have default values
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
local TitleType = A['TitleType'];
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode
local Degree = A['Degree'];
local Conference = A['Conference'];
if utilities.in_array (config.CitationClass, {'AV-media-notes', 'document', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
local BookTitle = A['BookTitle'];
TitleType = set_titletype (config.CitationClass, TitleType);
local TransTitle_origin = A:ORIGIN ('TransTitle');
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
if 'conference' == config.CitationClass then
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
if utilities.is_set (BookTitle) then
end
Chapter = Title;
end
Chapter_origin = 'title';
 
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
if utilities.is_set (TitleType) then -- if type parameter is specified
ChapterURL = URL;
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
ChapterUrlAccess = UrlAccess;
-- TODO: Hack on TitleType to fix bunched parentheses problem
ChapterURL_origin = URL_origin;
URL_origin = '';
ChapterFormat = Format;
TransChapter = TransTitle;
TransChapter_origin = TransTitle_origin;
Title = BookTitle;
Format = '';
-- TitleLink = '';
TransTitle = '';
URL = '';
end
elseif 'speech' ~= config.CitationClass then
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end
end
local use_lowercase = ( sepc == ',' ); -- controls capitalization of certain static text
-- cite map oddities
local Cartography = "";
local Scale = "";
local Sheet = A['Sheet'] or '';
local Sheets = A['Sheets'] or '';
if config.CitationClass == "map" then
if utilities.is_set (Chapter) then --TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'map') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', Chapter_origin)}); -- add error message
end
Chapter = A['Map'];
Chapter_origin = A:ORIGIN('Map');
ChapterURL = A['MapURL'];
ChapterURL_origin = A:ORIGIN('MapURL');
TransChapter = A['TransMap'];
ScriptChapter = A['ScriptMap']
ScriptChapter_origin = A:ORIGIN('ScriptMap')


-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
ChapterUrlAccess = MapUrlAccess;
local Date = A['Date'];
ChapterFormat = A['MapFormat'];
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
local PublicationDate = A['PublicationDate'];
local Year = A['Year'];


if utilities.is_set (Year) then
Cartography = A['Cartography'];
validation.year_check (Year); -- returns nothing; emits maint message when |year= doesn't hold a 'year' value
if utilities.is_set ( Cartography ) then
end
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
end
if not utilities.is_set (Date) then
Scale = A['Scale'];
Date = Year; -- promote Year to Date
if utilities.is_set ( Scale ) then
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
Scale = sepc .. " " .. Scale;
if not utilities.is_set (Date) and utilities.is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
Date_origin = A:ORIGIN('PublicationDate'); -- save the name of the promoted parameter
else
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter
end
end
else
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging
end
end


if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
local Series = A['Series'];
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
local SeriesLink = A['SeriesLink'];


--[[
SeriesLink = link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wiki-markup in |series-link= or wiki-markup in |series= when |series-link= is set
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.
Date validation supporting code is in Module:Citation/CS1/Date_validation
]]


local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
local Network = A['Network'];
if not utilities.is_set (DF) then
local Station = A['Station'];
DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template
local s, n = {}, {};
end
-- do common parameters first
if utilities.is_set (Network) then table.insert(n, Network); end
if utilities.is_set (Station) then table.insert(n, Station); end
ID = table.concat(n, sepc .. ' ');
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];


local ArchiveURL;
if utilities.is_set (Season) and utilities.is_set (SeriesNumber) then -- these are mutually exclusive so if both are set TODO: make a function for this and similar?
local ArchiveDate;
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
local ArchiveFormat = A['ArchiveFormat'];
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
local archive_url_timestamp; -- timestamp from wayback machine url
end
-- assemble a table of parts concatenated later into Series
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter
ArchiveURL, ArchiveDate, archive_url_timestamp = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
Chapter = Title; -- promote title parameters to chapter
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
ArchiveURL, ArchiveDate = is_unique_archive_url (ArchiveURL, URL, ChapterURL, A:ORIGIN('ArchiveURL'), ArchiveDate); -- add error message when URL or ChapterURL == ArchiveURL
ChapterLink = TitleLink; -- alias |episode-link=
TransChapter = TransTitle;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
ChapterFormat = Format;
 
Title = Series; -- promote series to title
TitleLink = SeriesLink;
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number


local AccessDate = A['AccessDate'];
if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
local DoiBroken = A['DoiBroken'];
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode;
local Embargo = A['Embargo'];
Series = utilities.make_wikilink (ChapterLink, Series);
local anchor_year; -- used in the CITEREF identifier
end
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
URL = ''; -- unset
local error_message = '';
TransTitle = '';
-- AirDate has been promoted to Date so not necessary to check it
ScriptTitle = '';
local date_parameters_list = {
Format = '';
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
['date'] = {val = Date, name = Date_origin},
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')},
['year'] = {val = Year, name = A:ORIGIN ('Year')},
};
 
local error_list = {};
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);
 
if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;  
validation.year_date_check (Year, A:ORIGIN ('Year'), Date, A:ORIGIN ('Date'), error_list);
end
 
if 0 == #error_list then -- error free dates only; 0 when error_list is empty
local modified = false; -- flag
if utilities.is_set (DF) then -- if we need to reformat dates
else -- now oddities that are cite serial
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of cite serial
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
Series = utilities.make_wikilink (SeriesLink, Series);
end
end
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
end
end
-- end of {{cite episode}} stuff


if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
-- handle type parameter for those CS1 citations that have default values
modified = true;
local TitleType = A['TitleType'];
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category
local Degree = A['Degree'];
end
if utilities.in_array (config.CitationClass, {'AV-media-notes', 'document', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
TitleType = set_titletype (config.CitationClass, TitleType);
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
end
modified = true;
end
end


if modified then -- if the date_parameters_list values were modified
if utilities.is_set (TitleType) then -- if type parameter is specified
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
ArchiveDate = date_parameters_list['archive-date'].val;
-- TODO: Hack on TitleType to fix bunched parentheses problem
Date = date_parameters_list['date'].val;
end
DoiBroken = date_parameters_list['doi-broken-date'].val;
PublicationDate = date_parameters_list['publication-date'].val;
end


if archive_url_timestamp and utilities.is_set (ArchiveDate) then
-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
validation.archive_date_check (ArchiveDate, archive_url_timestamp, DF); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate
local Date = A['Date'];
end
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
else
local PublicationDate = A['PublicationDate'];
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message
local Year = A['Year'];
end
end -- end of do


if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others?
if utilities.is_set (Year) then
('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) or -- {{citation}} as an encylopedia citation
validation.year_check (Year); -- returns nothing; emits maint message when |year= doesn't hold a 'year' value
('citation' == config.CitationClass and not utilities.is_set (Periodical)) then -- {{citation}} as a book citation
end
if utilities.is_set (PublicationPlace) then
if not utilities.is_set (PublisherName) then
if not utilities.is_set (Date) then
local date = COinS_date.rftdate and tonumber (COinS_date.rftdate:match ('%d%d%d%d')); -- get year portion of COinS date (because in Arabic numerals); convert string to number
Date = Year; -- promote Year to Date
if date and (1850 <= date) then -- location has no publisher; if date is 1850 or later
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
utilities.set_message ('maint_location_no_publisher'); -- add maint cat
if not utilities.is_set (Date) and utilities.is_set (PublicationDate) then -- use PublicationDate when |date= and |year= are not set
end
Date = PublicationDate; -- promote PublicationDate to Date
else -- PublisherName has a value
PublicationDate = ''; -- unset, no longer needed
if cfg.keywords_xlate['none'] == PublisherName then -- if that value is 'none' (only for book and encyclopedia citations)
Date_origin = A:ORIGIN('PublicationDate'); -- save the name of the promoted parameter
PublisherName = ''; -- unset
else
end
Date_origin = A:ORIGIN('Year'); -- save the name of the promoted parameter
end
end
end
else
Date_origin = A:ORIGIN('Date'); -- not a promotion; name required for error messaging
end
end


local ID_list = {}; -- sequence table of rendered identifiers
if PublicationDate == Date then PublicationDate = ''; end -- if PublicationDate is same as Date, don't display in rendered citation
local ID_list_coins = {}; -- table of identifiers and their values from args; key is same as cfg.id_handlers's key
 
local Class = A['Class']; -- arxiv class identifier
--[[
Go test all of the date-holding parameters for valid MOS:DATE format and make sure that dates are real dates. This must be done before we do COinS because here is where
we get the date used in the metadata.
local ID_support = {
Date validation supporting code is in Module:Citation/CS1/Date_validation
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
]]
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
}


ID_list, ID_list_coins = identifiers.identifier_lists_get (args, {DoiBroken = DoiBroken, ASINTLD = A['ASINTLD'], Embargo = Embargo, Class = Class}, ID_support);
local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], '');
if not utilities.is_set (DF) then
DF = cfg.global_df; -- local |df= if present overrides global df set by {{use xxx date}} template
end


-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, {{cite ssrn}}, before generation of COinS data.
local ArchiveURL;
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv=, |citeseerx=, |medrxiv=, |ssrn= required for their templates
local ArchiveDate;
if not (args[cfg.id_handlers[config.CitationClass:upper()].parameters[1]] or -- can't use ID_list_coins k/v table here because invalid parameters omitted
local ArchiveFormat = A['ArchiveFormat'];
args[cfg.id_handlers[config.CitationClass:upper()].parameters[2]]) then -- which causes unexpected parameter missing error message
local archive_url_timestamp; -- timestamp from wayback machine url
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
end
ArchiveURL, ArchiveDate, archive_url_timestamp = archive_url_check (A['ArchiveURL'], A['ArchiveDate'])
ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url');
ArchiveURL, ArchiveDate = is_unique_archive_url (ArchiveURL, URL, ChapterURL, A:ORIGIN('ArchiveURL'), ArchiveDate); -- add error message when URL or ChapterURL == ArchiveURL


Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['medrxiv'] = 'medRxiv', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
local AccessDate = A['AccessDate'];
end
local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification
local DoiBroken = A['DoiBroken'];
local Embargo = A['Embargo'];
local anchor_year; -- used in the CITEREF identifier
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
local error_message = '';
-- AirDate has been promoted to Date so not necessary to check it
local date_parameters_list = {
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
['date'] = {val = Date, name = Date_origin},
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')},
['year'] = {val = Year, name = A:ORIGIN ('Year')},
};


-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free
local error_list = {};
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);


if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead
if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;
if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled
validation.year_date_check (Year, A:ORIGIN ('Year'), Date, A:ORIGIN ('Date'), error_list);
if identifiers.auto_link_urls[auto_select] then -- manual selection
end
URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link
 
URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
if 0 == #error_list then -- error free dates only; 0 when error_list is empty
elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC
local modified = false; -- flag
URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed
URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
if utilities.is_set (DF) then -- if we need to reformat dates
elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
URL = identifiers.auto_link_urls['doi'];
URL_origin = cfg.id_handlers['DOI'].parameters[1];
end
end
end


if utilities.is_set (URL) then -- set when using an identifier-created URL
if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
if utilities.is_set (AccessDate) then -- |access-date= requires |url=; identifier-created URL is not |url=
modified = true;
utilities.set_message ('err_accessdate_missing_url'); -- add an error message
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category
AccessDate = ''; -- unset
end
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
modified = true;
end
end


if utilities.is_set (ArchiveURL) then -- |archive-url= requires |url=; identifier-created URL is not |url=
if modified then -- if the date_parameters_list values were modified
utilities.set_message ('err_archive_missing_url'); -- add an error message
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values
ArchiveURL = ''; -- unset
ArchiveDate = date_parameters_list['archive-date'].val;
Date = date_parameters_list['date'].val;
DoiBroken = date_parameters_list['doi-broken-date'].val;
PublicationDate = date_parameters_list['publication-date'].val;
end
end
end
end


-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
if archive_url_timestamp and utilities.is_set (ArchiveDate) then
-- Test if citation has no title
validation.archive_date_check (ArchiveDate, archive_url_timestamp, DF); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
end
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
else
end
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message
end
end -- end of do


if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others?
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) or -- {{citation}} as an encylopedia citation
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and
('citation' == config.CitationClass and not utilities.is_set (Periodical)) then -- {{citation}} as a book citation
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
if utilities.is_set (PublicationPlace) then
Title = ''; -- set title to empty string
if not utilities.is_set (PublisherName) then
utilities.set_message ('maint_untitled'); -- add maint cat
local date = COinS_date.rftdate and tonumber (COinS_date.rftdate:match ('%d%d%d%d')); -- get year portion of COinS date (because in Arabic numerals); convert string to number
if date and (1850 <= date) then -- location has no publisher; if date is 1850 or later
utilities.set_message ('maint_location_no_publisher'); -- add maint cat
end
else -- PublisherName has a value
if cfg.keywords_xlate['none'] == PublisherName then -- if that value is 'none' (only for book and encyclopedia citations)
PublisherName = ''; -- unset
end
end
end
end
end


-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
local ID_list = {}; -- sequence table of rendered identifiers
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
local ID_list_coins = {}; -- table of identifiers and their values from args; key is same as cfg.id_handlers's key
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
local Class = A['Class']; -- arxiv class identifier
-- is the article title, and Chapter is a section within the article.  So, we remap
local coins_chapter = Chapter; -- default assuming that remapping not required
local ID_support = {
local coins_title = Title; -- et tu
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
coins_chapter = Title; -- remap
}
coins_title = Periodical;
 
ID_list, ID_list_coins = identifiers.identifier_lists_get (args, {DoiBroken = DoiBroken, ASINTLD = A['ASINTLD'], Embargo = Embargo, Class = Class, Year=anchor_year}, ID_support);
 
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, {{cite ssrn}}, before generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv=, |citeseerx=, |medrxiv=, |ssrn= required for their templates
if not (args[cfg.id_handlers[config.CitationClass:upper()].parameters[1]] or -- can't use ID_list_coins k/v table here because invalid parameters omitted
args[cfg.id_handlers[config.CitationClass:upper()].parameters[2]]) then -- which causes unexpected parameter missing error message
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
end
end
Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['medrxiv'] = 'medRxiv', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
end
end
local coins_author = a; -- default for coins rft.au
if 0 < #c then -- but if contributor list
coins_author = c; -- use that instead
end
-- this is the function call to COinS()
local OCinSoutput = metadata.COinS({
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
['Degree'] = Degree; -- cite thesis only
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date.* has correctly formatted date values if Date is valid;
['Season'] = COinS_date.rftssn,
['Quarter'] = COinS_date.rftquarter,
['Chron'] =  COinS_date.rftchron,
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['ArticleNumber'] = ArticleNumber,
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['ID_list'] = ID_list_coins,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);


-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, and {{cite ssrn}} AFTER generation of COinS data.
-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, medRxiv, or ssrn now unset so it isn't displayed
 
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
if config.CitationClass == "journal" and not utilities.is_set (URL) and not utilities.is_set (TitleLink) and not utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) then -- TODO: remove 'none' once existing citations have been switched to 'off', so 'none' can be used as token for "no title" instead
if 'none' ~= cfg.keywords_xlate[auto_select] then -- if auto-linking not disabled
if identifiers.auto_link_urls[auto_select] then -- manual selection
URL = identifiers.auto_link_urls[auto_select]; -- set URL to be the same as identifier's external link
URL_origin = cfg.id_handlers[auto_select:upper()].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['pmc'] then -- auto-select PMC
URL = identifiers.auto_link_urls['pmc']; -- set URL to be the same as the PMC external link if not embargoed
URL_origin = cfg.id_handlers['PMC'].parameters[1]; -- set URL_origin to parameter name for use in error message if citation is missing a |title=
elseif identifiers.auto_link_urls['doi'] then -- auto-select DOI
URL = identifiers.auto_link_urls['doi'];
URL_origin = cfg.id_handlers['DOI'].parameters[1];
end
end
 
if utilities.is_set (URL) then -- set when using an identifier-created URL
if utilities.is_set (AccessDate) then -- |access-date= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_accessdate_missing_url'); -- add an error message
AccessDate = ''; -- unset
end
 
if utilities.is_set (ArchiveURL) then -- |archive-url= requires |url=; identifier-created URL is not |url=
utilities.set_message ('err_archive_missing_url'); -- add an error message
ArchiveURL = ''; -- unset
end
end
end
end


-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
-- At this point fields may be nil if they weren't specified in the template use.  We can use that fact.
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
-- Test if citation has no title
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
end
end


local Editors;
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
local Contributors; -- assembled contributors name list
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and
local contributor_etal;
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
local Translators; -- assembled translators name list
Title = ''; -- set title to empty string
local translator_etal;
utilities.set_message ('maint_untitled'); -- add maint cat
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
end
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
 
local Interviewers;
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
local interviewers_list = {};
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that
interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title
local interviewer_etal;
-- is the article title, and Chapter is a section within the article.  So, we remap
-- Now perform various field substitutions.
local coins_chapter = Chapter; -- default assuming that remapping not required
-- We also add leading spaces and surrounding markup and punctuation to the
local coins_title = Title; -- et tu
-- various parts of the citation, but only when they are non-nil.
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
do
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then
local last_first_list;
coins_chapter = Title; -- remap
local control = {  
coins_title = Periodical;
format = NameListStyle, -- empty string, '&', 'amp', 'and', or 'vanc'
end
maximum = nil, -- as if display-authors or display-editors not set
end
mode = Mode
local coins_author = a; -- default for coins rft.au
};
if 0 < #c then -- but if contributor list
 
coins_author = c; -- use that instead
do -- do editor name list first because the now unsupported coauthors used to modify control table
end
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayEditors'], A['DisplayEditors'], A:ORIGIN ('DisplayEditors'), #e);
control.maximum, editor_etal = get_display_names (display_names, #e, 'editors', editor_etal, param);
-- this is the function call to COinS()
local OCinSoutput = metadata.COinS({
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
['Degree'] = Degree; -- cite thesis only
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date.* has correctly formatted date values if Date is valid;
['Season'] = COinS_date.rftssn,
['Quarter'] = COinS_date.rftquarter,
['Chron'] =  COinS_date.rftchron,
['Series'] = Series,
['Volume'] = Volume,
['Issue'] = Issue,
['ArticleNumber'] = ArticleNumber,
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
['Edition'] = Edition,
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['ID_list'] = ID_list_coins,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);
 
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite medrxiv}}, and {{cite ssrn}} AFTER generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list_t) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, medRxiv, or ssrn now unset so it isn't displayed
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
end


Editors, EditorCount = list_people (control, e, editor_etal);
-- special case for cite newsgroup.  Do this after COinS because we are modifying Publishername to include some static text
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
end


if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then  
local Editors;
EditorCount = 2; -- spoof to display (eds.) annotation
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list
end
local Contributors; -- assembled contributors name list
end
local contributor_etal;
local Translators; -- assembled translators name list
local translator_etal;
local t = {}; -- translators list from |translator-lastn= / translator-firstn= pairs
t = extract_names (args, 'TranslatorList'); -- fetch translator list from |translatorn= / |translator-lastn=, -firstn=, -linkn=, -maskn=
local Interviewers;
local interviewers_list = {};
interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters
local interviewer_etal;
-- Now perform various field substitutions.
-- We also add leading spaces and surrounding markup and punctuation to the
-- various parts of the citation, but only when they are non-nil.
do
local last_first_list;
local control = {
format = NameListStyle, -- empty string, '&', 'amp', 'and', or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
mode = Mode
};
 
do -- do editor name list first because the now unsupported coauthors used to modify control table
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayEditors'], A['DisplayEditors'], A:ORIGIN ('DisplayEditors'), #e);
control.maximum, editor_etal = get_display_names (display_names, #e, 'editors', editor_etal, param);
 
Editors, EditorCount = list_people (control, e, editor_etal);
 
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then  
EditorCount = 2; -- spoof to display (eds.) annotation
end
end
do -- now do interviewers
do -- now do interviewers
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayInterviewers'], A['DisplayInterviewers'], A:ORIGIN ('DisplayInterviewers'), #interviewers_list);
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayInterviewers'], A['DisplayInterviewers'], A:ORIGIN ('DisplayInterviewers'), #interviewers_list);
Line 3,787: Line 3,907:
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
end
end
local Quote = A['Quote'];
local TransQuote = A['TransQuote'];
local ScriptQuote = A['ScriptQuote'];
if utilities.is_set (Quote) or utilities.is_set (TransQuote) or utilities.is_set (ScriptQuote) then
if utilities.is_set (Quote) then
if Quote:sub(1, 1) == '"' and Quote:sub(-1, -1) == '"' then -- if first and last characters of quote are quote marks
Quote = Quote:sub(2, -2); -- strip them off
end
end
Quote = kern_quotes (Quote); -- kern if needed
Quote = utilities.wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
if utilities.is_set (ScriptQuote) then
-- We check length of PostScript here because it will have been nuked by
Quote = script_concatenate (Quote, ScriptQuote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
-- the quote parameters. We'd otherwise emit a message even if there wasn't
end
 
if utilities.is_set (TransQuote) then
if TransQuote:sub(1, 1) == '"' and TransQuote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
TransQuote = TransQuote:sub(2, -2); -- strip them off
end
Quote = Quote .. " " .. utilities.wrap_style ('trans-quoted-title', TransQuote );
end
 
if utilities.is_set (QuotePage) or utilities.is_set (QuotePages) then -- add page prefix
local quote_prefix = '';
if utilities.is_set (QuotePage) then
extra_text_in_page_check (QuotePage, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
if not NoPP then
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePage}), '', '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePage}), '', '', '';
end
elseif utilities.is_set (QuotePages) then
extra_text_in_page_check (QuotePages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
if tonumber(QuotePages) ~= nil and not NoPP then -- if only digits, assume single page
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePages}), '', '';
elseif not NoPP then
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, QuotePages}), '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePages}), '', '';
end
end
                       
Quote = quote_prefix .. ": " .. Quote;
else
Quote = sepc .. " " .. Quote;
end
 
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
end
-- We check length of PostScript here because it will have been nuked by
-- the quote parameters. We'd otherwise emit a message even if there wasn't
-- a displayed postscript.
-- a displayed postscript.
-- TODO: Should the max size (1) be configurable?
-- TODO: Should the max size (1) be configurable?
Line 3,888: Line 3,955:
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
else
else
utilities.set_message ('maint_unfit'); -- and add a category if not already added
utilities.add_prop_cat ('unfit'); -- and add a category if not already added
end
end
else -- UrlStatus is empty, 'dead'
else -- UrlStatus is empty, 'dead'
Line 4,205: Line 4,272:
for _, v in ipairs (z.error_cats_t) do -- append error categories
for _, v in ipairs (z.error_cats_t) do -- append error categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
if cfg.id_limits_data_load_fail then -- boolean true when load failed
utilities.set_message ('maint_id_limit_load_fail'); -- done here because this maint cat emits no message
end
end
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
table.insert (render_t, utilities.substitute (cfg.messages[cat_wikilink], {v, sort_key}));
end
end
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v)); -- no sort keys
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v)); -- no sort keys
Line 4,354: Line 4,423:
if value:match ('^=') then -- sometimes an extraneous '=' character appears ...
if value:match ('^=') then -- sometimes an extraneous '=' character appears ...
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat
end
end
--[[--------------------------< H A S _ T W L _ U R L >--------------------------------------------------------
look for The Wikipedia Library urls in url-holding parameters.  TWL urls are accessible for readers who are not
active extended confirmed Wikipedia editors.  This function emits an error message when such urls are discovered.
looks for: '.wikipedialibrary.idm.oclc.org'
]]
local function has_twl_url (url_params_t)
local url_error_t = {}; -- sequence of url-holding parameters that have a TWL url
for param, value in pairs (url_params_t) do
if value:find ('%.wikipedialibrary%.idm%.oclc%.org') then -- has the TWL base url?
table.insert (url_error_t, utilities.wrap_style ('parameter', param)); -- add parameter name to the list
end
end
if 0 ~= #url_error_t then -- non-zero when there are errors
table.sort (url_error_t);
utilities.set_message ('err_param_has_twl_url', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message
return true;
end
end
end
end
Line 4,364: Line 4,458:
]]
]]


local function has_extraneous_url (url_param_t)
local function has_extraneous_url (non_url_param_t)
local url_error_t = {};
local url_error_t = {};
check_for_url (url_param_t, url_error_t); -- extraneous url check
check_for_url (non_url_param_t, url_error_t); -- extraneous url check
if 0 ~= #url_error_t then -- non-zero when there are errors
if 0 ~= #url_error_t then -- non-zero when there are errors
table.sort (url_error_t);
table.sort (url_error_t);
Line 4,375: Line 4,469:




--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
--[[--------------------------< _ C I T A T I O N >------------------------------------------------------------
 
Module entry point


This is used by templates such as {{cite book}} to create the actual citation text.
frame – from template call (citation()); may be nil when called from another module
args – table of all cs1|2 parameters in the template (the template frame)
config – table of template-supplied parameter (the #invoke frame)


]]
]]


local function citation(frame)
local function _citation (frame, args, config) -- save a copy in case we need to display an error message in preview mode
Frame = frame; -- save a copy in case we need to display an error message in preview mode
if not frame then
 
frame = mw.getCurrentFrame(); -- if called from another module, get a frame for frame-provided functions
local config = {}; -- table to store parameters from the module {{#invoke:}}
end
for k, v in pairs( frame.args ) do -- get parameters from the {{#invoke}} frame
config[k] = v;
-- args[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
end
-- i18n: set the name that your wiki uses to identify sandbox subpages from sandbox template invoke (or can be set here)
-- i18n: set the name that your wiki uses to identify sandbox subpages from sandbox template invoke (or can be set here)
local sandbox = ((config.SandboxPath and '' ~= config.SandboxPath) and config.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}}
local sandbox = ((config.SandboxPath and '' ~= config.SandboxPath) and config.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}}
Line 4,394: Line 4,488:
sandbox = is_sandbox and sandbox or ''; -- use i18n sandbox to load sandbox modules when this module is the sandox; live modules else
sandbox = is_sandbox and sandbox or ''; -- use i18n sandbox to load sandbox modules when this module is the sandox; live modules else


local pframe = frame:getParent()
local styles;
cfg = mw.loadData ('Module:Citation/CS1/Configuration' .. sandbox); -- load sandbox versions of support modules when {{#invoke:Citation/CS1/sandbox|...}}; live modules else
cfg = mw.loadData ('Module:Citation/CS1/Configuration' .. sandbox); -- load sandbox versions of support modules when {{#invoke:Citation/CS1/sandbox|...}}; live modules else
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist' .. sandbox);
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist' .. sandbox);
Line 4,403: Line 4,494:
identifiers = require ('Module:Citation/CS1/Identifiers' .. sandbox);
identifiers = require ('Module:Citation/CS1/Identifiers' .. sandbox);
metadata = require ('Module:Citation/CS1/COinS' .. sandbox);
metadata = require ('Module:Citation/CS1/COinS' .. sandbox);
styles = 'Module:Citation/CS1' .. sandbox .. '/styles.css';


utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
Line 4,414: Line 4,504:
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));


local args = {}; -- table where we store all of the template's arguments
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local error_text; -- used as a flag
local error_text; -- used as a flag
Line 4,420: Line 4,509:
local capture; -- the single supported capture when matching unknown parameters using patterns
local capture; -- the single supported capture when matching unknown parameters using patterns
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
for k, v in pairs( pframe.args ) do -- get parameters from the parent (template) frame
for k, v in pairs( args ) do -- get parameters from the parent (template) frame
v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string
v = mw.ustring.gsub (v, '^%s*(.-)%s*$', '%1'); -- trim leading/trailing whitespace; when v is only whitespace, becomes empty string
if v ~= '' then
if v ~= '' then
Line 4,480: Line 4,569:
end
end


local url_param_t = {};
local non_url_param_t = {}; -- table of parameters and values that are not url-holding parameters
local url_param_t = {}; -- table of url-holding paramters and their values


for k, v in pairs( args ) do
for k, v in pairs( args ) do
Line 4,490: Line 4,580:
args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label
args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label


if 'string' == type (k) and not cfg.url_skip[k] then -- when parameter k is not positional and not in url skip table
if 'string' == type (k) then -- when parameter k is not positional
url_param_t[k] = v; -- make a parameter/value list for extraneous url check
if not cfg.url_skip[k] then -- and not in url skip table
non_url_param_t[k] = v; -- make a parameter/value list for extraneous url check
else -- and is in url skip table (a url-holding parameter)
url_param_t[k] = v; -- make a parameter/value list to check for values that are The Wikipedia Library url
end
end
end
end
end


has_extraneous_url (url_param_t); -- look for url in parameter values where a url does not belong
has_extraneous_url (non_url_param_t); -- look for url in parameter values where a url does not belong
 
if has_twl_url (url_param_t) then -- look for url-holding parameters that hold a The Wikipedia Library url
args['url-access'] = 'subscription';
end
return table.concat ({
return table.concat ({
frame:extensionTag ('templatestyles', '', {src=styles}),
frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1' .. sandbox .. '/styles.css'}),
citation0( config, args)
citation0( config, args)
});
});
end
--[[--------------------------< C I T A T I O N >--------------------------------------------------------------
Template entry point
]]
local function citation (frame)
local config_t = {}; -- table to store parameters from the module {{#invoke:}}
local args_t = frame:getParent().args; -- get template's preset parameters
for k, v in pairs (frame.args) do -- get parameters from the {{#invoke}} frame
config_t[k] = v;
-- args_t[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
end
return _citation (frame, args_t, config_t)
end
end


Line 4,507: Line 4,621:
]]
]]


return {citation = citation};
return {
citation = citation, -- template entry point
_citation = _citation, -- module entry point
}
Retrieved from "https://en.ikwipedia.org/wiki/Module:Citation/CS1"