Module:Citation/CS1: Difference between revisions
en>Trappist the monk sync from sandbox; |
m 1 revision imported: Fix for LUA errors |
||
| (3 intermediate revisions by 3 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 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 344: | 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 | 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,032: | 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,607: | Line 2,610: | ||
--[[--------------------------< | --[[--------------------------< M O D E _ S E T >-------------------------------------------------------------- | ||
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 | local function mode_set (Mode, Mode_origin) | ||
--[[ | local mode; | ||
if cfg.global_cs1_config_t['Mode'] then -- global setting in {{cs1 config}}; 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 (Mode, Mode_origin, cfg.keywords_lists['mode'], ''); | |||
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 | |||
]] | |||
local function quote_make (quote, trans_quote, script_quote, quote_page, quote_pages, nopp, sepc, postscript) | |||
if utilities.is_set (quote) or utilities.is_set (trans_quote) or utilities.is_set (script_quote) 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 (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 | if utilities.is_set (trans_quote) then | ||
utilities. | 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 | ||
if utilities.is_set (quote_page) or utilities.is_set (quote_pages) then -- add page prefix | |||
local quote_prefix = ''; | |||
if utilities.is_set (quote_page) then | |||
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 not nopp then | |||
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_page}), '', '', ''; | |||
else | |||
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, quote_page}), '', '', ''; | |||
end | |||
elseif utilities.is_set (quote_pages) then | |||
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. | |||
if tonumber(quote_pages) ~= nil and not nopp then -- if only digits, assume single page | |||
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, quote_pages}), '', ''; | |||
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 | ||
return quote, quote_page, quote_pages, postscript; | |||
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= | |||
]] | |||
local function check_publisher_name (publisher) | |||
local patterns_t = { | |||
'^[%w%s]+%s*:%s*[%w%s]+$', -- plain text <location>: <publisher> | |||
'^%[+[%w%s:|]+%]+%s*:%s*[%w%s]+$', -- partially wikilinked [[<location>]]: <publisher> | |||
'^[%w%s]+%s*:%s*%[+[%w%s:|]+%]+$', -- partially wikilinked <location>: [[<publisher>]] | |||
'^%[+[%w%s:|]+%]+%s*:%s*%[+[%w%s:|]+%]+$', -- wikilinked [[<location>]]: [[<publisher>]] | |||
} | |||
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 | |||
--[[--------------------------< I S _ P A G E _ A R T _ N U M >------------------------------------------------ | |||
if ' | |||
compare the trailing (rightmost) characters of the |doi= value against the whole value assigned to |page(s)=. | |||
return boolean true when: | |||
|page(s)= has exactly 8 digits and a dot between the fourth and fifth digits matches the trailing 9 characters | |||
of the |doi= value: |page=12345678 → |page=1234.5678 matches |doi=10.xxxx/yyyy1234.5678 | |||
|page(s)= is 5 or more characters and matches |doi= values's trailing characters | |||
|page(s)= begins with a lowercase 'e' and |page(s)= without the 'e' matches |doi= values's trailing | |||
characters: |page=e12345 → |page=12345 matches |doi=10.xxxx/yyyy12345 | |||
|page(s)= begins with a uppercase 'CD' followed by (typically) six digits matches |doi= values that ends with | |||
'CDxxxxxx.pubx' (where 'x' is any single digit) | |||
return nil when |page(s)= values: | |||
are ranges separated by underscore, hyphen, emdash, endash, figure dash, or minus character | |||
are comma- or semicolon-separated lists of pages | |||
have external urls (has text 'http') | |||
are digit-only values less than 10000 | |||
do not match |doi= values's trailing characters | |||
]] | |||
local function is_page_art_num (page, doi) | |||
if not (utilities.is_set (page) and utilities.is_set (doi)) then -- both required | |||
return; -- abandon; nothing to do | |||
end | |||
if page:match ('[,;_−–—‒%-]') then -- when |page(s)= might be a page range or a separated list of pages | |||
return; -- abandon | |||
end | |||
page = page:lower(); -- because doi names are case insensitive | |||
doi = doi:lower(); -- force these to lowercase for testing | |||
if page:match ('http') then -- when |page(s)= appears to hold a url | |||
return; -- abandon | |||
end | |||
if tonumber (page) then -- is |page(s)= digits only | |||
if 10000 > tonumber (page) then -- when |page(s)= less than 10000 | |||
return; -- abandon | |||
end | |||
if doi:match (page .. '$') then -- digits only page number match the last digits in |doi=? | |||
return true; | |||
end | |||
if 8 == page:len() then -- special case when |page(s)= is exactly 8 digits | |||
local dot_page = page:gsub ('(%d%d%d%d)(%d%d%d%d)', '%1.%2'); -- make a |page=xxxx.yyyy version commonly used in |doi= | |||
if doi:match (dot_page .. '$') then -- 8-digit dotted page number match the last characters in |doi=? | |||
return true; | |||
end | |||
end | end | ||
else -- here when |page(s)= is alpha-numeric | |||
if 4 < page:len() then -- when |page(s)= is five or more characters | |||
if doi:match (page .. '$') then -- alpha-numeric page match the last characters in |doi=? | |||
return true; | |||
end | |||
local epage = page:match ('^e([%w]+)$'); -- if first character of |page= is 'e', remove it | |||
if epage and doi:match (epage .. '$') then -- page number match the last characters in |doi=? | |||
return true; | |||
end | end | ||
local cdpage = page:match ('^cd%d+$'); -- if first characters of |page= are 'CD' and last characters are digits (typically 6 digits) | |||
if cdpage and doi:match (cdpage .. '%.pub%d$') then -- page number matches doi 'CDxxxxxx.pubx' where 'x' is a digit | |||
return true; | |||
end | end | ||
end | end | ||
end | end | ||
end | |||
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------ | |||
This is the main function doing the majority of the citation formatting. | |||
]] | |||
local function citation0( config, args ) | |||
--[[ | |||
Load Input Parameters | |||
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable. | |||
]] | |||
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 | local author_etal; | ||
local | local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors= | ||
local Authors; | |||
local NameListStyle; | |||
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 | 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 | |||
NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], ''); | |||
if | |||
end | end | ||
if utilities.is_set ( | 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 (' | utilities.set_message ('maint_overridden_setting'); -- set a maint message | ||
end | end | ||
local Collaboration = A['Collaboration']; | |||
local | |||
do -- to limit scope of selected | |||
local selected = select_author_editor_source (A['Vauthors'], A['Authors'], args, 'AuthorList'); | |||
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 | ||
local editor_etal; | |||
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors= | |||
do -- to limit scope of selected | |||
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn | |||
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= | |||
elseif 2 == selected then | |||
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be | |||
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn= | |||
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 | 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 | |||
if | c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn= | ||
if not utilities. | 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 | end | ||
if 0 == #a then -- |contributor= requires |author= | |||
if | 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 | ||
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 | |||
if utilities. | |||
end | end | ||
Contribution = nil; -- unset | |||
end | end | ||
if utilities.in_array ( | local Title = A['Title']; | ||
local TitleLink = A['TitleLink']; | |||
local auto_select = ''; -- default is auto | |||
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 | ||
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 | local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used | ||
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}} | |||
Chapter = ''; -- unset for now; will be reset later from |map= if present | |||
if | |||
end | end | ||
local | local Periodical = A['Periodical']; | ||
local | local Periodical_origin = A:ORIGIN('Periodical'); | ||
local | local ScriptPeriodical = A['ScriptPeriodical']; | ||
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical'); | |||
local TransPeriodical = A['TransPeriodical']; | |||
local TransPeriodical_origin = A:ORIGIN ('TransPeriodical'); | |||
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 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 | |||
if | elseif utilities.is_set (TransPeriodical) then | ||
utilities.set_message (' | 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 | ||
local | if utilities.is_set (Periodical) then | ||
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 | |||
if ' | if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}} | ||
if utilities.is_set ( | 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 (' | utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'mailinglist')}); | ||
end | end | ||
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 | -- web and news not tested for now because of | ||
-- 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 | |||
-- 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 | ||
local | local Volume; | ||
if 'citation' == config.CitationClass then | |||
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 | |||
Volume = A['Volume']; -- but does for all other 'periodicals' | |||
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 | local Issue; | ||
if 'citation' == config.CitationClass then | |||
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 | 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 | ||
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 | |||
ArticleNumber = A['ArticleNumber']; | |||
end | |||
extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i'); | |||
local Page; | |||
local Pages; | |||
local At; | |||
local QuotePage; | |||
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 | |||
local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil); | local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil); | ||
local Mode = mode_set (A['Mode'], A:ORIGIN('Mode')); | |||
-- separator character and postscript | |||
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass); | |||
local Quote; | |||
Quote, QuotePage, QuotePages, PostScript = quote_make (A['Quote'], A['TransQuote'], A['ScriptQuote'], QuotePage, QuotePages, NoPP, sepc, PostScript); | |||
local | local Edition = A['Edition']; | ||
local | local PublicationPlace = place_check (A['PublicationPlace'], A:ORIGIN('PublicationPlace')); | ||
local Place = place_check (A['Place'], A:ORIGIN('Place')); | |||
local | |||
local PublisherName = A['PublisherName']; | |||
local PublisherName_origin = A:ORIGIN('PublisherName'); | |||
if utilities.is_set (PublisherName) and (cfg.keywords_xlate['none'] ~= PublisherName) then | |||
local i = 0; | |||
PublisherName, i = utilities.strip_apostrophe_markup (PublisherName); -- strip apostrophe markup so that metadata isn't contaminated; publisher is never italicized | |||
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 | |||
if ('document' == config.CitationClass) and not utilities.is_set (PublisherName) then | |||
utilities.set_message ('err_missing_publisher', {config.CitationClass, 'publisher'}); | |||
end | |||
local | local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup? | ||
local | local Newsgroup_origin = A:ORIGIN('Newsgroup'); | ||
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 | PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS | ||
end | |||
if 'book' == config.CitationClass or 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and not utilities.is_set (Periodical)) then | |||
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 | ||
end | |||
local URL = A['URL']; -- TODO: better way to do this for URL, ChapterURL, and MapURL? | |||
local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), cfg.keywords_lists['url-access'], nil); | |||
if not utilities.is_set (URL) and utilities.is_set (UrlAccess) then | |||
UrlAccess = nil; | |||
utilities.set_message ('err_param_access_requires_param', 'url'); | |||
end | |||
local ChapterURL = A['ChapterURL']; | |||
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 | |||
ChapterUrlAccess = nil; | |||
utilities.set_message ('err_param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}); | |||
end | |||
local MapUrlAccess = is_valid_parameter_value (A['MapUrlAccess'], A:ORIGIN('MapUrlAccess'), cfg.keywords_lists['url-access'], nil); | |||
if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then | |||
MapUrlAccess = nil; | |||
utilities.set_message ('err_param_access_requires_param', {'map-url'}); | |||
end | |||
local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language | |||
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 | |||
local coins_pages; | |||
local | |||
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At); | |||
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 | |||
if | |||
end | end | ||
elseif | 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 | |||
-- | local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL | ||
local | local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL | ||
local ScriptChapter = A['ScriptChapter']; | |||
local | 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']; | |||
-- | --[[ | ||
Parameter remapping for cite encyclopedia: | |||
When the citation has these parameters: | |||
|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 | |||
|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 | |||
local ScriptEncyclopedia = A['ScriptEncyclopedia']; | |||
local TransEncyclopedia = A['TransEncyclopedia']; | |||
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}} | |||
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then | |||
if utilities.is_set (Encyclopedia) then | |||
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 | end | ||
elseif utilities.is_set (TransEncyclopedia) then | |||
utilities.set_message ('err_trans_missing_title', {'encyclopedia'}); | |||
end | end | ||
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}} | |||
if ' | utilities.set_message ('err_periodical_ignored', {Periodical_origin}); | ||
end | |||
if utilities.is_set (Encyclopedia) or utilities.is_set (ScriptEncyclopedia) then | |||
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia for rendering; {{citation}} could (not legitimately) have both; use Encyclopedia | |||
Periodical_origin = A:ORIGIN ('Encyclopedia'); | |||
ScriptPeriodical = ScriptEncyclopedia; | |||
ScriptPeriodical_origin = A:ORIGIN ('ScriptEncyclopedia'); | |||
if utilities.is_set (Title) or utilities.is_set (ScriptTitle) then | |||
if not utilities.is_set (Chapter) then | |||
Chapter = Title; -- |encyclopedia= and |title= are set so map |title= params to |article= params for rendering | |||
ScriptChapter = ScriptTitle; | |||
ScriptChapter_origin = A:ORIGIN('ScriptTitle') | |||
TransChapter = TransTitle; | |||
ChapterURL = URL; | |||
ChapterURL_origin = URL_origin; | |||
ChapterUrlAccess = UrlAccess; | |||
ChapterFormat = Format; | |||
if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then | |||
Chapter = utilities.make_wikilink (TitleLink, Chapter); | |||
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 | |||
if utilities.is_set ( | |||
-- special case for cite techreport. | |||
local ID = A['ID']; | |||
if (config.CitationClass == "techreport") then -- special case for cite techreport | |||
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 | |||
ChapterLink = TitleLink; -- | 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 | |||
end | |||
-- Account for the oddity that is {{cite conference}}, before generation of COinS data. | |||
local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode | |||
local Conference = A['Conference']; | |||
local BookTitle = A['BookTitle']; | |||
local TransTitle_origin = A:ORIGIN ('TransTitle'); | |||
if 'conference' == config.CitationClass then | |||
if utilities.is_set (BookTitle) then | |||
Chapter = Title; | |||
Chapter_origin = 'title'; | |||
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated | |||
ChapterURL = URL; | ChapterURL = URL; | ||
ChapterUrlAccess = UrlAccess; | ChapterUrlAccess = UrlAccess; | ||
ChapterURL_origin = URL_origin; | ChapterURL_origin = URL_origin; | ||
URL_origin = ''; | |||
ChapterFormat = Format; | ChapterFormat = Format; | ||
TransChapter = TransTitle; | |||
TransChapter_origin = TransTitle_origin; | |||
Title = BookTitle; | |||
Format = ''; | |||
-- TitleLink = ''; | |||
TransTitle = ''; | 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 | |||
-- | |||
local | -- cite map oddities | ||
local | local Cartography = ""; | ||
if | local Scale = ""; | ||
local Sheet = A['Sheet'] or ''; | |||
if utilities.is_set ( | 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 | 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; | |||
ChapterFormat = A['MapFormat']; | |||
Cartography = A['Cartography']; | |||
if utilities.is_set ( Cartography ) then | |||
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase); | |||
end | |||
Scale = A['Scale']; | |||
if utilities.is_set ( Scale ) then | |||
Scale = sepc .. " " .. Scale; | |||
if | |||
end | end | ||
end | end | ||
if | -- 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 | |||
local Network = A['Network']; | |||
local Station = A['Station']; | |||
local s, n = {}, {}; | |||
-- 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']; | |||
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? | |||
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'season') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message | |||
SeriesNumber = ''; -- unset; prefer |season= over |seriesno= | |||
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 | |||
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 | |||
TitleLink = SeriesLink; | |||
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number | |||
if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL | |||
Chapter = utilities.make_wikilink (ChapterLink, Chapter); | |||
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode; | |||
Series = utilities.make_wikilink (ChapterLink, Series); | |||
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); | |||
if | |||
utilities. | |||
end | end | ||
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized | |||
end | |||
end | |||
-- end of {{cite episode}} stuff | |||
-- handle type parameter for those CS1 citations that have default values | |||
local TitleType = A['TitleType']; | |||
local Degree = A['Degree']; | |||
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); | |||
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis | |||
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower(); | |||
end | end | ||
end | end | ||
if | if utilities.is_set (TitleType) then -- if type parameter is specified | ||
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses | |||
-- TODO: Hack on TitleType to fix bunched parentheses problem | |||
end | |||
end | |||
-- legacy: promote PublicationDate to Date if neither Date nor Year are set. | |||
local | local Date = A['Date']; | ||
local | local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging | ||
local PublicationDate = A['PublicationDate']; | |||
local | local Year = A['Year']; | ||
if utilities.is_set (Year) then | |||
validation.year_check (Year); -- returns nothing; emits maint message when |year= doesn't hold a 'year' value | |||
if utilities. | |||
end | end | ||
if not utilities.is_set (Date) then | |||
Date = Year; -- promote Year to Date | |||
Year = nil; -- make nil so Year as empty string isn't used for CITEREF | |||
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 | |||
if utilities.is_set ( | |||
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 | ||
--[[ | |||
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'], ''); | |||
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 | end | ||
local ArchiveURL; | |||
local ArchiveDate; | |||
local ArchiveFormat = A['ArchiveFormat']; | |||
-- | local archive_url_timestamp; -- timestamp from wayback machine url | ||
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 | |||
local AccessDate = A['AccessDate']; | |||
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')}, | |||
}; | |||
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 | |||
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate | |||
end | |||
if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate | |||
modified = true; | |||
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category | |||
end | |||
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki | |||
if | 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 modified then -- if the date_parameters_list values were modified | |||
AccessDate = date_parameters_list['access-date'].val; -- overwrite date holding parameters with modified values | |||
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 | |||
if archive_url_timestamp and utilities.is_set (ArchiveDate) then | |||
validation.archive_date_check (ArchiveDate, archive_url_timestamp, DF); -- does YYYYMMDD in archive_url_timestamp match date in ArchiveDate | |||
end | |||
else | |||
utilities.set_message ('err_bad_date', {utilities.make_sep_list (#error_list, error_list)}); -- add this error message | |||
end | end | ||
end -- end of do | |||
if utilities.in_array (config.CitationClass, {'book', 'encyclopaedia'}) or -- {{cite book}}, {{cite encyclopedia}}; TODO: {{cite conference}} and others? | |||
('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) or -- {{citation}} as an encylopedia citation | |||
('citation' == config.CitationClass and not utilities.is_set (Periodical)) then -- {{citation}} as a book citation | |||
if utilities.is_set (PublicationPlace) then | |||
if not utilities.is_set (PublisherName) 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 | |||
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 | ||
end | |||
local ID_list = {}; -- sequence table of rendered identifiers | |||
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 | |||
if utilities. | local ID_support = { | ||
{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, -- for |doi= | |||
ASINTLD = A['ASINTLD'], -- for |asin= | |||
Embargo = Embargo, -- for |pmc= | |||
Class = Class, -- for |arxiv= | |||
CitationClass = config.CitationClass, -- for |arxiv= | |||
Year=anchor_year, -- for |isbn= | |||
}, 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 | ||
-- Link the title of the work if no |url= was provided, but we have a |pmc= or a |doi= with |doi-access=free | |||
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 | |||
utilities.set_message (' | end | ||
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. | |||
-- Test if citation has no title | |||
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 | |||
if utilities.is_set ( | |||
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and | |||
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and | |||
(utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and | |||
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites | |||
Title = ''; -- set title to empty string | |||
utilities.set_message ('maint_untitled'); -- add maint cat | |||
end | |||
if 'journal' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Periodical) and 'journal' == Periodical_origin) then | |||
if is_page_art_num (((utilities.is_set (Page) and Page) or (utilities.is_set (Pages) and Pages)) or nil, ID_list_coins['DOI']) then -- does |page(s)= look like it holds an article number | |||
utilities.set_message ('maint_page_art_num'); -- add maint cat | |||
end | end | ||
end | end | ||
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information. | |||
-- handle the oddity that is cite encyclopedia and {{citation |encyclopedia=something}}. Here we presume that | |||
-- when Periodical, Title, and Chapter are all set, then Periodical is the book (encyclopedia) title, Title | |||
-- 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 coins_title = Title; -- et tu | |||
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then | |||
if utilities.is_set (Chapter) and utilities.is_set (Title) and utilities.is_set (Periodical) then -- if all are used then | |||
coins_chapter = Title; -- remap | |||
coins_title = Periodical; | |||
end | 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. | |||
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 | end | ||
-- | -- 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 )); | |||
if | |||
end | end | ||
local Editors; | |||
local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list | |||
local Contributors; -- assembled contributors name list | |||
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 | end | ||
do -- now do interviewers | |||
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayInterviewers'], A['DisplayInterviewers'], A:ORIGIN ('DisplayInterviewers'), #interviewers_list); | |||
control.maximum, interviewer_etal = get_display_names (display_names, #interviewers_list, 'interviewers', interviewer_etal, param); | |||
Interviewers = list_people (control, interviewers_list, interviewer_etal); | |||
end | end | ||
do -- now do translators | |||
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayTranslators'], A['DisplayTranslators'], A:ORIGIN ('DisplayTranslators'), #t); | |||
control.maximum, translator_etal = get_display_names (display_names, #t, 'translators', translator_etal, param); | |||
Translators = list_people (control, t, translator_etal); | |||
end | end | ||
do -- now do contributors | |||
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayContributors'], A['DisplayContributors'], A:ORIGIN ('DisplayContributors'), #c); | |||
control.maximum, contributor_etal = get_display_names (display_names, #c, 'contributors', contributor_etal, param); | |||
Contributors = list_people (control, c, contributor_etal); | |||
end | end | ||
do -- now do authors | |||
local display_names, param = display_names_select (cfg.global_cs1_config_t['DisplayAuthors'], A['DisplayAuthors'], A:ORIGIN ('DisplayAuthors'), #a, author_etal); | |||
control.maximum, author_etal = get_display_names (display_names, #a, 'authors', author_etal, param); | |||
last_first_list = list_people (control, a, author_etal); | |||
if utilities.is_set (Authors) then | |||
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al. | |||
if author_etal then | |||
Authors = Authors .. ' ' .. cfg.messages['et al']; -- add et al. to authors parameter | |||
end | |||
else | else | ||
Authors = last_first_list; -- either an author name list or an empty string | |||
end | end | ||
end -- end of do | |||
if utilities.is_set (Authors) and utilities.is_set (Collaboration) then | |||
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al. | |||
end | |||
end | |||
end | end | ||
if utilities. | local ConferenceFormat = A['ConferenceFormat']; | ||
local ConferenceURL = A['ConferenceURL']; | |||
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url'); | |||
Format = style_format (Format, URL, 'format', 'url'); | |||
-- special case for chapter format so no error message or cat when chapter not supported | |||
if not (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or | |||
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia))) then | |||
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url'); | |||
end | end | ||
if not utilities.is_set (URL) then | |||
if utilities.in_array (config.CitationClass, {"web", "podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist | |||
('citation' == config.CitationClass and ('website' == Periodical_origin or 'script-website' == ScriptPeriodical_origin)) then -- and required for {{citation}} with |website= or |script-website= | |||
utilities.set_message ('err_cite_web_url'); | |||
end | |||
-- do we have |accessdate= without either |url= or |chapter-url=? | |||
if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set; | |||
utilities.set_message ('err_accessdate_missing_url'); | |||
AccessDate = ''; | |||
end | end | ||
end | end | ||
local | local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], ''); | ||
if | local OriginalURL | ||
local OriginalURL_origin | |||
local OriginalFormat | |||
local OriginalAccess; | |||
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text | |||
if utilities.is_set ( ArchiveURL ) then | |||
if utilities.is_set (ChapterURL) then -- if chapter-url= is set apply archive url to it | |||
OriginalURL = ChapterURL; -- save copy of source chapter's url for archive text | |||
OriginalURL_origin = ChapterURL_origin; -- name of |chapter-url= parameter for error messages | |||
OriginalFormat = ChapterFormat; -- and original |chapter-format= | |||
if 'live' ~= UrlStatus then | |||
ChapterURL = ArchiveURL -- swap-in the archive's URL | |||
ChapterURL_origin = A:ORIGIN('ArchiveURL') -- name of |archive-url= parameter for error messages | |||
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format | |||
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs | |||
end | end | ||
elseif utilities.is_set (URL) then | |||
OriginalURL = URL; -- save copy of original source URL | |||
OriginalURL_origin = URL_origin; -- name of URL parameter for error messages | |||
OriginalFormat = Format; -- and original |format= | |||
OriginalAccess = UrlAccess; | |||
if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it | |||
URL = ArchiveURL -- swap-in the archive's URL | |||
URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages | |||
Format = ArchiveFormat or ''; -- swap in archive's format | |||
UrlAccess = nil; -- restricted access levels do not make sense for archived URLs | |||
end | end | ||
end | end | ||
elseif utilities.is_set (UrlStatus) then -- if |url-status= is set when |archive-url= is not set | |||
utilities.set_message ('maint_url_status'); -- add maint cat | |||
end | end | ||
if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia | |||
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) then | |||
local chap_param; | |||
if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters | |||
chap_param = A:ORIGIN ('Chapter') | |||
elseif utilities.is_set (TransChapter) then | |||
chap_param = A:ORIGIN ('TransChapter') | |||
elseif utilities.is_set (ChapterURL) then | |||
chap_param = A:ORIGIN ('ChapterURL') | |||
elseif utilities.is_set (ScriptChapter) then | |||
chap_param = ScriptChapter_origin; | |||
else utilities.is_set (ChapterFormat) | |||
chap_param = A:ORIGIN ('ChapterFormat') | |||
end | |||
if utilities.is_set (chap_param) then -- if we found one | |||
utilities.set_message ('err_chapter_ignored', {chap_param}); -- add error message | |||
Chapter = ''; -- and set them to empty string to be safe with concatenation | |||
TransChapter = ''; | |||
ChapterURL = ''; | |||
ScriptChapter = ''; | |||
ChapterFormat = ''; | |||
end | |||
else -- otherwise, format chapter / article title | |||
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value | |||
if utilities.is_set ( | if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s) | ||
if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title | |||
no_quotes = true; -- then render it unquoted | |||
end | |||
end | end | ||
Chapter = format_chapter_title (ScriptChapter, ScriptChapter_origin, Chapter, Chapter_origin, TransChapter, TransChapter_origin, ChapterURL, ChapterURL_origin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter | |||
if utilities.is_set (Chapter) then | |||
Chapter = Chapter .. ChapterFormat ; | |||
if 'map' == config.CitationClass and utilities.is_set (TitleType) then | |||
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title | |||
end | |||
Chapter = Chapter .. sepc .. ' '; | |||
elseif utilities.is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ... | |||
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it | |||
end | end | ||
end | end | ||
-- Format main title | |||
local plain_title = false; | |||
local accept_title; | |||
Title, accept_title = utilities.has_accept_as_written (Title, true); -- remove accept-this-as-written markup when it wraps all of <Title> | |||
if accept_title and ('' == Title) then -- only support forced empty for now "(())" | |||
Title = cfg.messages['notitle']; -- replace by predefined "No title" message | |||
-- TODO: utilities.set_message ( 'err_redundant_parameters', ...); -- issue proper error message instead of muting | |||
ScriptTitle = ''; -- just mute for now | |||
TransTitle = ''; -- just mute for now | |||
plain_title = true; -- suppress text decoration for descriptive title | |||
utilities.set_message ('maint_untitled'); -- add maint cat | |||
end | end | ||
if | |||
if not accept_title then -- <Title> not wrapped in accept-as-written markup | |||
if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title= | |||
Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three | |||
elseif not mw.ustring.find (Title, '%.%s*%a%.$') and -- end of title is not a 'dot-(optional space-)letter-dot' initialism ... | |||
not mw.ustring.find (Title, '%s+%a%.$') then -- ...and not a 'space-letter-dot' initial (''Allium canadense'' L.) | |||
Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters | |||
end | |||
utilities. | |||
if utilities.is_set (ArchiveURL) and is_archived_copy (Title) then | |||
utilities.set_message ('maint_archived_copy'); -- add maintenance category before we modify the content of Title | |||
end | |||
if is_generic ('generic_titles', Title) then | |||
utilities.set_message ('err_generic_title'); -- set an error message | |||
end | |||
end | |||
if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'document', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'medrxiv', 'ssrn'}) or | |||
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) or | |||
('map' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)))) then -- special case for cite map when the map is in a periodical treat as an article | |||
Title = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from module provided quote marks | |||
Title = utilities.wrap_style ('quoted-title', Title); | |||
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped | |||
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); | |||
elseif plain_title or ('report' == config.CitationClass) then -- no styling for cite report and descriptive titles (otherwise same as above) | |||
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped | |||
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title | |||
else | else | ||
Title = utilities.wrap_style ('italic-title', Title); | |||
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped | |||
TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle); | |||
end | end | ||
if utilities.is_set (TransTitle) then | |||
if utilities.is_set (Title) then | |||
if utilities.is_set ( | TransTitle = " " .. TransTitle; | ||
if utilities. | |||
else | else | ||
utilities.set_message ('err_trans_missing_title', {'title'}); | |||
utilities.set_message (' | |||
end | end | ||
end | end | ||
if utilities.is_set ( | if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs? | ||
if utilities.is_set (TitleLink) and utilities.is_set (URL) then | |||
utilities.set_message ('err_wikilink_in_url'); -- set an error message because we can't have both | |||
TitleLink = ''; -- unset | |||
end | end | ||
if utilities.is_set ( | if not utilities.is_set (TitleLink) and utilities.is_set (URL) then | ||
Title = external_link (URL, Title, URL_origin, UrlAccess) .. TransTitle .. Format; | |||
URL = ''; -- unset these because no longer needed | |||
Format = ""; | |||
elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then | |||
local ws_url; | |||
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here | |||
if ws_url then | |||
Title = external_link (ws_url, Title .. ' ', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | |||
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title}); | |||
Title = Title .. TransTitle; | |||
else | |||
local | Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle; | ||
else | |||
end | end | ||
else | else | ||
local ws_url, ws_label, L; -- Title has italic or quote markup by the time we get here which causes is_wikilink() to return 0 (not a wikilink) | |||
ws_url, ws_label, L = wikisource_url_make (Title:gsub('^[\'"]*(.-)[\'"]*$', '%1')); -- make ws URL from |title= interwiki link (strip italic or quote markup); link portion L becomes tooltip label | |||
if ws_url then | |||
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup | |||
Title = external_link (ws_url, Title .. ' ', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this? | |||
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title}); | |||
Title = Title .. TransTitle; | |||
else | |||
Title = Title .. TransTitle; | |||
end | |||
end | end | ||
else | |||
Title = TransTitle; | |||
end | |||
if utilities.is_set (Place) then | |||
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " "; | |||
end | end | ||
-- We check length of PostScript here because it will have been nuked by | local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL | ||
-- the quote parameters. We'd otherwise emit a message even if there wasn't | if utilities.is_set (Conference) then | ||
-- a displayed postscript. | if utilities.is_set (ConferenceURL) then | ||
-- TODO: Should the max size (1) be configurable? | Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil ); | ||
-- TODO: Should we check a specific pattern? | end | ||
if utilities.is_set(PostScript) and mw.ustring.len(PostScript) > 1 then | Conference = sepc .. " " .. Conference .. ConferenceFormat; | ||
utilities.set_message ('maint_postscript') | elseif utilities.is_set (ConferenceURL) then | ||
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil ); | |||
end | |||
local Position = ''; | |||
if not utilities.is_set (Position) then | |||
local Minutes = A['Minutes']; | |||
local Time = A['Time']; | |||
if utilities.is_set (Minutes) then | |||
if utilities.is_set (Time) then --TODO: make a function for this and similar? | |||
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'minutes') .. cfg.presentation['sep_list_pair'] .. utilities.wrap_style ('parameter', 'time')}); | |||
end | |||
Position = " " .. Minutes .. " " .. cfg.messages['minutes']; | |||
else | |||
if utilities.is_set (Time) then | |||
local TimeCaption = A['TimeCaption'] | |||
if not utilities.is_set (TimeCaption) then | |||
TimeCaption = cfg.messages['event']; | |||
if sepc ~= '.' then | |||
TimeCaption = TimeCaption:lower(); | |||
end | |||
end | |||
Position = " " .. TimeCaption .. " " .. Time; | |||
end | |||
end | |||
else | |||
Position = " " .. Position; | |||
At = ''; | |||
end | |||
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase); | |||
At = utilities.is_set (At) and (sepc .. " " .. At) or ""; | |||
Position = utilities.is_set (Position) and (sepc .. " " .. Position) or ""; | |||
if config.CitationClass == 'map' then | |||
local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier | |||
local Inset = A['Inset']; | |||
if utilities.is_set ( Inset ) then | |||
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase); | |||
end | |||
if utilities.is_set ( Sections ) then | |||
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase); | |||
elseif utilities.is_set ( Section ) then | |||
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase); | |||
end | |||
At = At .. Inset .. Section; | |||
end | |||
local Others = A['Others']; | |||
if utilities.is_set (Others) and 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor= | |||
if config.CitationClass == "AV-media-notes" | |||
or config.CitationClass == "audio-visual" then -- special maint for AV/M which has a lot of 'false' positives right now | |||
utilities.set_message ('maint_others_avm') | |||
else | |||
utilities.set_message ('maint_others'); | |||
end | |||
end | |||
Others = utilities.is_set (Others) and (sepc .. " " .. Others) or ""; | |||
if utilities.is_set (Translators) then | |||
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc); | |||
end | |||
if utilities.is_set (Interviewers) then | |||
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc); | |||
end | |||
local TitleNote = A['TitleNote']; | |||
TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or ""; | |||
if utilities.is_set (Edition) then | |||
if Edition:match ('%f[%a][Ee]d%n?%.?$') or Edition:match ('%f[%a][Ee]dition$') then -- Ed, ed, Ed., ed., Edn, edn, Edn., edn. | |||
utilities.set_message ('err_extra_text_edition'); -- add error message | |||
end | |||
Edition = " " .. wrap_msg ('edition', Edition); | |||
else | |||
Edition = ''; | |||
end | |||
Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum | |||
local Agency = A['Agency'] or ''; -- |agency= is supported by {{cite magazine}}, {{cite news}}, {{cite press release}}, {{cite web}}, and certain {{citation}} templates | |||
if utilities.is_set (Agency) then -- this testing done here because {{citation}} supports 'news' citations | |||
if utilities.in_array (config.CitationClass, {'magazine', 'news', 'pressrelease', 'web'}) or ('citation' == config.CitationClass and utilities.in_array (Periodical_origin, {"magazine", "newspaper", "work"})) then | |||
Agency = wrap_msg ('agency', {sepc, Agency}); -- format for rendering | |||
else | |||
Agency = ''; -- unset; not supported | |||
utilities.set_message ('err_parameter_ignored', {'agency'}); -- add error message | |||
end | |||
end | |||
Volume = format_volume_issue (Volume, Issue, ArticleNumber, config.CitationClass, Periodical_origin, sepc, use_lowercase); | |||
if utilities.is_set (AccessDate) then | |||
local retrv_text = " " .. cfg.messages['retrieved'] | |||
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format | |||
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case | |||
AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text | |||
AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates | |||
end | |||
if utilities.is_set (ID) then ID = sepc .. " " .. ID; end | |||
local Docket = A['Docket']; | |||
if "thesis" == config.CitationClass and utilities.is_set (Docket) then | |||
ID = sepc .. " Docket " .. Docket .. ID; | |||
end | |||
if "report" == config.CitationClass and utilities.is_set (Docket) then -- for cite report when |docket= is set | |||
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set | |||
end | |||
if utilities.is_set (URL) then | |||
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess ); | |||
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. | |||
-- TODO: Should the max size (1) be configurable? | |||
-- TODO: Should we check a specific pattern? | |||
if utilities.is_set(PostScript) and mw.ustring.len(PostScript) > 1 then | |||
utilities.set_message ('maint_postscript') | |||
end | |||
local Archived; | |||
if utilities.is_set (ArchiveURL) then | |||
if not utilities.is_set (ArchiveDate) then -- ArchiveURL set but ArchiveDate not set | |||
utilities.set_message ('err_archive_missing_date'); -- emit an error message | |||
ArchiveURL = ''; -- empty string for concatenation | |||
ArchiveDate = ''; -- empty string for concatenation | |||
end | |||
else | |||
if utilities.is_set (ArchiveDate) then -- ArchiveURL not set but ArchiveDate is set | |||
utilities.set_message ('err_archive_date_missing_url'); -- emit an error message | |||
ArchiveURL = ''; -- empty string for concatenation | |||
ArchiveDate = ''; -- empty string for concatenation | |||
end | |||
end | |||
if utilities.is_set (ArchiveURL) then | |||
local arch_text; | |||
if "live" == UrlStatus then | |||
arch_text = cfg.messages['archived']; | |||
if sepc ~= "." then arch_text = arch_text:lower() end | |||
if utilities.is_set (ArchiveDate) then | |||
Archived = sepc .. ' ' .. utilities.substitute ( cfg.messages['archived-live'], | |||
{external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil) .. ArchiveFormat, ArchiveDate } ); | |||
else | |||
Archived = ''; | |||
end | |||
if not utilities.is_set (OriginalURL) then | |||
utilities.set_message ('err_archive_missing_url'); | |||
Archived = ''; -- empty string for concatenation | |||
end | |||
elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown' | |||
if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then | |||
arch_text = cfg.messages['archived-unfit']; | |||
if sepc ~= "." then arch_text = arch_text:lower() end | |||
Archived = sepc .. ' ' .. arch_text .. ArchiveDate; -- format already styled | |||
if 'bot: unknown' == UrlStatus then | |||
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added | |||
else | |||
utilities.add_prop_cat ('unfit'); -- and add a category if not already added | |||
end | |||
else -- UrlStatus is empty, 'dead' | |||
arch_text = cfg.messages['archived-dead']; | |||
if sepc ~= "." then arch_text = arch_text:lower() end | |||
if utilities.is_set (ArchiveDate) then | |||
Archived = sepc .. " " .. utilities.substitute ( arch_text, | |||
{ external_link( OriginalURL, cfg.messages['original'], OriginalURL_origin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled | |||
else | |||
Archived = ''; -- unset for concatenation | |||
end | |||
end | |||
else -- OriginalUrl not set | |||
utilities.set_message ('err_archive_missing_url'); | |||
Archived = ''; -- empty string for concatenation | |||
end | |||
elseif utilities.is_set (ArchiveFormat) then | |||
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message | |||
else | |||
Archived = ''; | |||
end | |||
local TranscriptURL = A['TranscriptURL'] | |||
local TranscriptFormat = A['TranscriptFormat']; | |||
TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl'); | |||
local Transcript = A['Transcript']; | |||
local TranscriptURL_origin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL | |||
if utilities.is_set (Transcript) then | |||
if utilities.is_set (TranscriptURL) then | |||
Transcript = external_link( TranscriptURL, Transcript, TranscriptURL_origin, nil ); | |||
end | |||
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat; | |||
elseif utilities.is_set (TranscriptURL) then | |||
Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil ); | |||
end | |||
local Publisher; | |||
if utilities.is_set (PublicationDate) then | |||
PublicationDate = wrap_msg ('published', PublicationDate); | |||
end | |||
if utilities.is_set (PublisherName) then | |||
if utilities.is_set (PublicationPlace) then | |||
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate; | |||
else | |||
Publisher = sepc .. " " .. PublisherName .. PublicationDate; | |||
end | |||
elseif utilities.is_set (PublicationPlace) then | |||
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate; | |||
else | |||
Publisher = PublicationDate; | |||
end | end | ||
-- Several of the above rely upon detecting this as nil, so do it last. | |||
if utilities.is_set ( | if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then | ||
if utilities.is_set (Title) or utilities.is_set (TitleNote) then | |||
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin); | |||
else | |||
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin); | |||
if utilities.is_set ( | |||
end | end | ||
end | end | ||
if utilities.is_set ( | local Language = A['Language']; | ||
if utilities.is_set (Language) then | |||
if " | Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc. | ||
else | |||
Language=''; -- language not specified so make sure this is an empty string; | |||
if utilities.is_set ( | --[[ TODO: need to extract the wrap_msg from language_parameter | ||
so that we can solve parentheses bunching problem with Format/Language/TitleType | |||
]] | |||
end | |||
--[[ | |||
Handle the oddity that is cite speech. This code overrides whatever may be the value assigned to TitleNote (through |department=) and forces it to be " (Speech)" so that | |||
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided). | |||
]] | |||
if "speech" == config.CitationClass then -- cite speech only | |||
TitleNote = TitleType; -- move TitleType to TitleNote so that it renders ahead of |event= | |||
TitleType = ''; -- and unset | |||
if utilities.is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter | |||
if utilities.is_set (Conference) then -- and if |event= is set | |||
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering | |||
end | end | ||
end | |||
end | |||
-- Piece all bits together at last. Here, all should be non-nil. | |||
-- We build things this way because it is more efficient in LUA | |||
-- not to keep reassigning to the same string variable over and over. | |||
local tcommon; | |||
local tcommon2; -- used for book cite when |contributor= is set | |||
if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites | |||
if utilities.is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc. | |||
tcommon = safe_join ({Title, TitleNote}, sepc); -- author and other stuff will come after this and before tcommon2 | |||
tcommon2 = safe_join ({TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc); | |||
else | |||
tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Volume, Others, Edition, Publisher}, sepc); | |||
end | end | ||
elseif 'map' == config.CitationClass then -- special cases for cite map | |||
if utilities.is_set (Chapter) then -- map in a book; TitleType is part of Chapter | |||
tcommon = safe_join ({Title, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc); | |||
elseif utilities.is_set (Periodical) then -- map in a periodical | |||
tcommon = safe_join ({Title, TitleType, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc); | |||
else -- a sheet or stand-alone map | |||
Publisher | tcommon = safe_join ({Title, TitleType, Edition, Scale, Series, Language, Cartography, Others, Publisher}, sepc); | ||
else | end | ||
Publisher | |||
end | elseif 'episode' == config.CitationClass then -- special case for cite episode | ||
elseif | tcommon = safe_join ({Title, TitleNote, TitleType, Series, Language, Edition, Publisher}, sepc); | ||
Publisher | |||
else | else -- all other CS1 templates | ||
Publisher | tcommon = safe_join ({Title, TitleNote, Conference, Periodical, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc); | ||
end | end | ||
if #ID_list > 0 then | |||
if | ID_list = safe_join( { sepc .. " ", table.concat( ID_list, sepc .. " " ), ID }, sepc ); | ||
else | |||
ID_list = ID; | |||
end | end | ||
local | local Via = A['Via']; | ||
Via = utilities.is_set (Via) and wrap_msg ('via', Via) or ''; | |||
local idcommon; | |||
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript | |||
idcommon = safe_join( { ID_list, URL, Archived, Transcript, AccessDate, Via, Quote }, sepc ); | |||
else | else | ||
idcommon = safe_join( { ID_list, URL, Archived, AccessDate, Via, Quote }, sepc ); | |||
end | end | ||
local text; | |||
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At; | |||
local OrigDate = A['OrigDate']; | |||
OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or ''; | |||
if utilities.is_set (Date) then | |||
if utilities.is_set (Authors) or utilities.is_set (Editors) then -- date follows authors or editors when authors not set | |||
Date = " (" .. Date .. ")" .. OrigDate .. sepc .. " "; -- in parentheses | |||
else -- neither of authors and editors set | |||
if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc | |||
Date = " " .. Date .. OrigDate; -- Date does not begin with sepc | |||
else | |||
Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc | |||
end | end | ||
end | end | ||
end | end | ||
if utilities.is_set (Authors) then | |||
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Authors termination | |||
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space | |||
end | |||
if utilities.is_set (Editors) then | |||
local in_text = ''; | |||
local post_text = ''; | |||
if utilities.is_set (Chapter) and 0 == #c then | |||
in_text = cfg.messages['in'] .. ' '; | |||
if utilities.is_set (Contributors) then -- | if (sepc ~= '.') then | ||
in_text = in_text:lower(); -- lowercase for cs2 | |||
end | |||
end | |||
if EditorCount <= 1 then | |||
post_text = ' (' .. cfg.messages['editor'] .. ')'; -- be consistent with no-author, no-date case | |||
else | |||
post_text = ' (' .. cfg.messages['editors'] .. ')'; | |||
end | |||
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space | |||
end | |||
if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc. | |||
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' '; | |||
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2 | |||
Authors = by_text .. Authors; -- author follows title so tweak it here | |||
if utilities.is_set (Editors) and utilities.is_set (Date) then -- when Editors make sure that Authors gets terminated | |||
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space | |||
end | |||
if (not utilities.is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination | |||
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space | |||
end | |||
text = safe_join( {Contributors, Date, Chapter, tcommon, Authors, Place, Editors, tcommon2, pgtext, idcommon }, sepc ); | |||
else | else | ||
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc ); | |||
end | end | ||
elseif utilities.is_set (Editors) then | |||
elseif | if utilities.is_set (Date) then | ||
if utilities.is_set ( | if EditorCount <= 1 then | ||
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editor']; | |||
else | |||
Editors = Editors .. cfg.presentation['sep_name'] .. cfg.messages['editors']; | |||
end | |||
else | |||
if EditorCount <= 1 then | |||
Editors = Editors .. " (" .. cfg.messages['editor'] .. ")" .. sepc .. " " | |||
else | |||
Editors = Editors .. " (" .. cfg.messages['editors'] .. ")" .. sepc .. " " | |||
end | |||
end | end | ||
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc ); | |||
else | else | ||
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then | |||
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc ); | |||
else | |||
text = safe_join( {Chapter, Place, tcommon, Date, pgtext, idcommon}, sepc ); | |||
end | |||
end | end | ||
if utilities.is_set (PostScript) and PostScript ~= sepc then | |||
text = safe_join( {text, sepc}, sepc ); -- Deals with italics, spaces, etc. | |||
if '.' == sepc then -- remove final seperator if present | |||
text = text:gsub ('%' .. sepc .. '$', ''); -- dot must be escaped here | |||
else | |||
text = mw.ustring.gsub (text, sepc .. '$', ''); -- using ustring for non-dot sepc (likely a non-Latin character) | |||
end | |||
end | |||
local | text = safe_join( {text, PostScript}, sepc ); | ||
-- Now enclose the whole thing in a <cite> element | |||
if ' | local options_t = {}; | ||
options_t.class = cite_class_attribute_make (config.CitationClass, Mode); | |||
local Ref = is_valid_parameter_value (A['Ref'], A:ORIGIN('Ref'), cfg.keywords_lists['ref'], nil, true); -- nil when |ref=harv; A['Ref'] else | |||
if 'none' ~= cfg.keywords_xlate[(Ref and Ref:lower()) or ''] then | |||
local namelist_t = {}; -- holds selected contributor, author, editor name list | |||
local year = first_set ({Year, anchor_year}, 2); -- Year first for legacy citations and for YMD dates that require disambiguation | |||
if #c > 0 then -- if there is a contributor list | |||
namelist_t = c; -- select it | |||
elseif #a > 0 then -- or an author list | |||
namelist_t = a; | |||
elseif #e > 0 then -- or an editor list | |||
namelist_t = e; | |||
end | |||
local citeref_id; | |||
if #namelist_t > 0 then -- if there are names in namelist_t | |||
citeref_id = make_citeref_id (namelist_t, year); -- go make the CITEREF anchor | |||
if mw.uri.anchorEncode (citeref_id) == ((Ref and mw.uri.anchorEncode (Ref)) or '') then -- Ref may already be encoded (by {{sfnref}}) so citeref_id must be encoded before comparison | |||
utilities.set_message ('maint_ref_duplicates_default'); | |||
end | |||
else | |||
citeref_id = ''; -- unset | |||
end | |||
options_t.id = Ref or citeref_id; | |||
end | end | ||
if string.len (text:gsub('%b<>', '')) <= 2 then -- remove html and html-like tags; then get length of what remains; | |||
z.error_cats_t = {}; -- blank the categories list | |||
if utilities.is_set ( | z.error_msgs_t = {}; -- blank the error messages list | ||
OCinSoutput = nil; -- blank the metadata string | |||
text = ''; -- blank the the citation | |||
utilities.set_message ('err_empty_citation'); -- set empty citation message and category | |||
if ( | end | ||
local render_t = {}; -- here we collect the final bits for concatenation into the rendered citation | |||
if utilities.is_set (options_t.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags | |||
table.insert (render_t, utilities.substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options_t.id), mw.text.nowiki(options_t.class), text})); -- when |ref= is set or when there is a namelist | |||
else | |||
table.insert (render_t, utilities.substitute (cfg.presentation['cite'], {mw.text.nowiki(options_t.class), text})); -- when |ref=none or when namelist_t empty and |ref= is missing or is empty | |||
end | |||
if OCinSoutput then -- blanked when citation is 'empty' so don't bother to add boilerplate metadata span | |||
table.insert (render_t, utilities.substitute (cfg.presentation['ocins'], OCinSoutput)); -- format and append metadata to the citation | |||
end | |||
local template_name = ('citation' == config.CitationClass) and 'citation' or 'cite ' .. (cfg.citation_class_map_t[config.CitationClass] or config.CitationClass); | |||
local template_link = '[[Template:' .. template_name .. '|' .. template_name .. ']]'; | |||
local msg_prefix = '<code class="cs1-code">{{' .. template_link .. '}}</code>: '; | |||
if 0 ~= #z.error_msgs_t then | |||
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_e, template_link)); | |||
table.insert (render_t, ' '); -- insert a space between citation and its error messages | |||
table.sort (z.error_msgs_t); -- sort the error messages list; sorting includes wrapping <span> and <code> tags; hidden-error sorts ahead of visible-error | |||
local hidden = true; -- presume that the only error messages emited by this template are hidden | |||
for _, v in ipairs (z.error_msgs_t) do -- spin through the list of error messages | |||
if v:find ('cs1-visible-error', 1, true) then -- look for the visible error class name | |||
hidden = false; -- found one; so don't hide the error message prefix | |||
break; -- and done because no need to look further | |||
end | end | ||
end | end | ||
end | |||
if | z.error_msgs_t[1] = table.concat ({utilities.error_comment (msg_prefix, hidden), z.error_msgs_t[1]}); -- add error message prefix to first error message to prevent extraneous punctuation | ||
table.insert (render_t, table.concat (z.error_msgs_t, '; ')); -- make a big string of error messages and add it to the rendering | |||
end | |||
if 0 ~= #z.maint_cats_t then | |||
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_m, template_link)); | |||
table.sort (z.maint_cats_t); -- sort the maintenance messages list | |||
local maint_msgs_t = {}; -- here we collect all of the maint messages | |||
if 0 == #z.error_msgs_t then -- if no error messages | |||
table.insert (maint_msgs_t, msg_prefix); -- insert message prefix in maint message livery | |||
end | end | ||
for _, v in ipairs( z.maint_cats_t ) do -- append maintenance categories | |||
table.insert (maint_msgs_t, -- assemble new maint message and add it to the maint_msgs_t table | |||
table.concat ({v, ' (', utilities.substitute (cfg.messages[':cat wikilink'], v), ')'}) | |||
); | |||
end | end | ||
table.insert (render_t, utilities.substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs_t, ' '))); -- wrap the group of maint messages with proper presentation and save | |||
end | |||
if not no_tracking_cats then | |||
local sort_key; | |||
local cat_wikilink = 'cat wikilink'; | |||
if cfg.enable_sort_keys then -- when namespace sort keys enabled | |||
local namespace_number = mw.title.getCurrentTitle().namespace; -- get namespace number for this wikitext | |||
sort_key = (0 ~= namespace_number and (cfg.name_space_sort_keys[namespace_number] or cfg.name_space_sort_keys.other)) or nil; -- get sort key character; nil for mainspace | |||
cat_wikilink = (not sort_key and 'cat wikilink') or 'cat wikilink sk'; -- make <cfg.messages> key | |||
end | |||
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})); | |||
end | end | ||
if cfg.id_limits_data_load_fail then -- boolean true when load failed | |||
if | 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 | |||
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 | |||
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v)); -- no sort keys | |||
end | end | ||
end | end | ||
-- | return table.concat (render_t); -- make a big string and done | ||
end | |||
--[[--------------------------< V A L I D A T E >-------------------------------------------------------------- | |||
Looks for a parameter's name in one of several whitelists. | |||
Parameters in the whitelist can have three values: | |||
true - active, supported parameters | |||
false - deprecated, supported parameters | |||
nil - unsupported parameters | |||
]] | |||
if | local function validate (name, cite_class, empty) | ||
local name = tostring (name); | |||
local enum_name; -- parameter name with enumerator (if any) replaced with '#' | |||
local state; | |||
local function state_test (state, name) -- local function to do testing of state values | |||
if true == state then return true; end -- valid actively supported parameter | |||
if false == state then | |||
if empty then return nil; end -- empty deprecated parameters are treated as unknowns | |||
deprecated_parameter (name); -- parameter is deprecated but still supported | |||
return true; | |||
end | |||
if 'tracked' == state then | |||
local base_name = name:gsub ('%d', ''); -- strip enumerators from parameter names that have them to get the base name | |||
utilities.add_prop_cat ('tracked-param', {base_name}, base_name); -- add a properties category; <base_name> modifies <key> | |||
return true; | |||
end | |||
return nil; | |||
end | end | ||
if | if name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted | ||
return nil; | |||
end | end | ||
-- replace enumerator digit(s) with # (|last25= becomes |last#=) (mw.ustring because non-Western 'local' digits) | |||
enum_name = mw.ustring.gsub (name, '%d+$', '#'); -- where enumerator is last charaters in parameter name (these to protect |s2cid=) | |||
enum_name = mw.ustring.gsub (enum_name, '%d+([%-l])', '#%1'); -- where enumerator is in the middle of the parameter name; |author#link= is the oddity | |||
if 'document' == cite_class then -- special case for {{cite document}} | |||
state = whitelist.document_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters | |||
if true == state_test (state, name) then return true; end | |||
return false; | |||
end | |||
if utilities.in_array (cite_class, whitelist.preprint_template_list_t) then -- limited parameter sets allowed for these templates | |||
state = whitelist.limited_parameters_t[enum_name]; -- this list holds enumerated and nonenumerated parameters | |||
if true == state_test (state, name) then return true; end | |||
state = whitelist.preprint_arguments_t[cite_class][name]; -- look in the parameter-list for the template identified by cite_class | |||
if true == state_test (state, name) then return true; end | |||
return false; -- not supported because not found or name is set to nil | |||
end -- end limited parameter-set templates | |||
if utilities.in_array (cite_class, whitelist.unique_param_template_list_t) then -- template-specific parameters for templates that accept parameters from the basic argument list | |||
state = whitelist.unique_arguments_t[cite_class][name]; -- look in the template-specific parameter-lists for the template identified by cite_class | |||
if true == state_test (state, name) then return true; end | |||
end -- if here, fall into general validation | |||
state = whitelist.common_parameters_t[enum_name]; -- all other templates; all normal parameters allowed; this list holds enumerated and nonenumerated parameters | |||
if true == state_test (state, name) then return true; end | |||
return false; -- not supported because not found or name is set to nil | |||
end | |||
--[=[-------------------------< I N T E R _ W I K I _ C H E C K >---------------------------------------------- | |||
check <value> for inter-language interwiki-link markup. <prefix> must be a MediaWiki-recognized language | |||
code. when these values have the form (without leading colon): | |||
[[<prefix>:link|label]] return label as plain-text | |||
[[<prefix>:link]] return <prefix>:link as plain-text | |||
return value as is else | |||
]=] | |||
local function inter_wiki_check (parameter, value) | |||
local prefix = value:match ('%[%[(%a+):'); -- get an interwiki prefix if one exists | |||
local _; | |||
if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so | |||
utilities.set_message ('err_bad_paramlink', parameter); -- emit an error message | |||
_, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink | |||
end | end | ||
return | return value; | ||
end | end | ||
--[[--------------------------< | --[[--------------------------< M I S S I N G _ P I P E _ C H E C K >------------------------------------------ | ||
Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal | |||
sign, compare the alphanumeric string to the list of cs1|2 parameters. If found, then the string is possibly a | |||
parameter that is missing its pipe. There are two tests made: | |||
{{cite ... |title=Title access-date=2016-03-17}} -- the first parameter has a value and whitespace separates that value from the missing pipe parameter name | |||
{{cite ... |title=access-date=2016-03-17}} -- the first parameter has no value (whitespace after the first = is trimmed by MediaWiki) | |||
cs1|2 shares some parameter names with XML/HTML attributes: class=, title=, etc. To prevent false positives XML/HTML | |||
tags are removed before the search. | |||
If a missing pipe is detected, this function adds the missing pipe maintenance category. | |||
]] | ]] | ||
local function | local function missing_pipe_check (parameter, value) | ||
local capture; | |||
value = value:gsub ('%b<>', ''); -- remove XML/HTML tags because attributes: class=, title=, etc. | |||
local | |||
capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes | |||
if capture and validate (capture) then -- if the capture is a valid parameter name | |||
utilities.set_message ('err_missing_pipe', parameter); | |||
end | end | ||
end | |||
--[[--------------------------< H A S _ E X T R A N E O U S _ P U N C T >-------------------------------------- | |||
look for extraneous terminal punctuation in most parameter values; parameters listed in skip table are not checked | |||
]] | |||
return | local function has_extraneous_punc (param, value) | ||
end | if 'number' == type (param) then | ||
return; | |||
end | |||
param = param:gsub ('%d+', '#'); -- enumerated name-list mask params allow terminal punct; normalize | |||
if cfg.punct_skip[param] then | |||
return; -- parameter name found in the skip table so done | |||
end | |||
if value:match ('[,;:]$') then | |||
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat | |||
end | |||
if value:match ('^=') then -- sometimes an extraneous '=' character appears ... | |||
utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat | |||
end | |||
end | |||
--[[--------------------------< H A S _ T W L _ U R L >-------------------------------------------------------- | |||
if | |||
look for The Wikipedia Library urls in url-holding parameters. TWL urls are accessible only for readers who are | |||
active extended confirmed Wikipedia editors. This function sets an error message when such urls are discovered | |||
and when appropriate, sets the |<param>-url-access=subscription. returns nothing. | |||
looks for: '.wikipedialibrary.idm.oclc.org' | |||
]] | |||
local function has_twl_url (url_params_t, cite_args_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, param); -- add parameter name to the error list | |||
end | |||
end | |||
if 0 ~= #url_error_t then -- non-zero when there are errors | |||
table.sort (url_error_t); -- sor for error messaging | |||
for i, param in ipairs (url_error_t) do | |||
if cfg.url_access_map_t[param] then -- if <param> has a matching -access parameter | |||
cite_args_t[cfg.url_access_map_t[param]] = cfg.keywords_xlate.subscription; -- set |<param>-url-access=subscription | |||
end | |||
url_error_t[i] = utilities.wrap_style ('parameter', param); -- make the parameter pretty for error message | |||
end | |||
utilities.set_message ('err_param_has_twl_url', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message | |||
end | |||
end | end | ||
--[ | --[[--------------------------< H A S _ E X T R A N E O U S _ U R L >------------------------------------------ | ||
look for extraneous url parameter values; parameters listed in skip table are not checked | |||
]] | |||
local function has_extraneous_url (non_url_param_t) | |||
local url_error_t = {}; | |||
local function | |||
local | |||
check_for_url (non_url_param_t, url_error_t); -- extraneous url check | |||
utilities.set_message (' | if 0 ~= #url_error_t then -- non-zero when there are errors | ||
table.sort (url_error_t); | |||
utilities.set_message ('err_param_has_ext_link', {utilities.make_sep_list (#url_error_t, url_error_t)}); -- add this error message | |||
end | end | ||
end | end | ||
--[[--------------------------< | --[[--------------------------< _ C I T A T I O N >------------------------------------------------------------ | ||
Module entry point | |||
frame – from template call (citation()); may be nil when called from another module | |||
args_t – table of all cs1|2 parameters in the template (the parent frame) | |||
config_t – table of template-supplied parameter (the #invoke frame) | |||
]] | ]] | ||
local function | local function _citation (frame, args_t, config_t) -- 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 | |||
if | |||
end | 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 = (( | local sandbox = ((config_t.SandboxPath and '' ~= config_t.SandboxPath) and config_t.SandboxPath) or '/sandbox'; -- sandbox path from {{#invoke:Citation/CS1/sandbox|citation|SandboxPath=/...}} | ||
is_sandbox = nil ~= string.find (frame:getTitle(), sandbox, 1, true); -- is this invoke the sandbox module? | is_sandbox = nil ~= string.find (frame:getTitle(), sandbox, 1, true); -- is this invoke the sandbox module? | ||
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 | ||
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,407: | Line 4,589: | ||
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); | ||
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,415: | Line 4,596: | ||
z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities | ||
local cite_args_t = {}; -- because args_t is the parent (template) frame args (which cannot be modified); params and their values will be placed here | |||
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}')); | is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}')); | ||
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,424: | Line 4,605: | ||
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( | for k, v in pairs (args_t) 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,430: | Line 4,611: | ||
k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- for enumerated parameters, translate 'local' digits to Western 0-9 | k = mw.ustring.gsub (k, '%d', cfg.date_names.local_digits); -- for enumerated parameters, translate 'local' digits to Western 0-9 | ||
end | end | ||
if not validate( k, | if not validate( k, config_t.CitationClass ) then | ||
if type (k) ~= 'string' then -- exclude empty numbered parameters | if type (k) ~= 'string' then -- exclude empty numbered parameters | ||
if v:match("%S+") ~= nil then | if v:match("%S+") ~= nil then | ||
error_text = utilities.set_message ('err_text_ignored', {v}); | error_text = utilities.set_message ('err_text_ignored', {v}); | ||
end | end | ||
elseif validate (k:lower(), | elseif validate (k:lower(), config_t.CitationClass) then | ||
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, k:lower()}); -- suggest the lowercase version of the parameter | error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, k:lower()}); -- suggest the lowercase version of the parameter | ||
else | else | ||
| Line 4,445: | Line 4,626: | ||
if capture then -- if the pattern matches | if capture then -- if the pattern matches | ||
param = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator) | param = utilities.substitute (param, capture); -- add the capture to the suggested parameter (typically the enumerator) | ||
if validate (param, | if validate (param, config_t.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists) | ||
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message | error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message | ||
else | else | ||
| Line 4,454: | Line 4,635: | ||
end | end | ||
if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an explicit suggestion? | if not utilities.is_set (error_text) then -- couldn't match with a pattern, is there an explicit suggestion? | ||
if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], | if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], config_t.CitationClass) then | ||
utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}); | utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}); | ||
else | else | ||
| Line 4,464: | Line 4,645: | ||
end | end | ||
cite_args_t[k] = v; -- save this parameter and its value | |||
elseif not utilities.is_set (v) then -- for empty parameters | elseif not utilities.is_set (v) then -- for empty parameters | ||
if not validate (k, | if not validate (k, config_t.CitationClass, true) then -- is this empty parameter a valid parameter | ||
k = ('' == k) and '(empty string)' or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text | k = ('' == k) and '(empty string)' or k; -- when k is empty string (or was space(s) trimmed to empty string), replace with descriptive text | ||
table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list | table.insert (empty_unknowns, utilities.wrap_style ('parameter', k)); -- format for error message and add to the list | ||
end | end | ||
end | |||
end | |||
end | end | ||
| Line 4,484: | Line 4,662: | ||
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 (cite_args_t) do | |||
if 'string' == type (k) then -- don't evaluate positional parameters | if 'string' == type (k) then -- don't evaluate positional parameters | ||
has_invisible_chars (k, v); -- look for invisible characters | has_invisible_chars (k, v); -- look for invisible characters | ||
| Line 4,492: | Line 4,672: | ||
has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values | has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values | ||
missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe? | missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe? | ||
cite_args_t[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label | |||
if 'string' == type (k) | if 'string' == type (k) then -- when parameter k is not positional | ||
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 ( | has_extraneous_url (non_url_param_t); -- look for url in parameter values where a url does not belong | ||
has_twl_url (url_param_t, cite_args_t); -- look for url-holding parameters that hold a The Wikipedia Library url | |||
return table.concat ({ | return table.concat ({ | ||
frame:extensionTag ('templatestyles', '', {src=styles}), | frame:extensionTag ('templatestyles', '', {src='Module:Citation/CS1' .. sandbox .. '/styles.css'}), | ||
citation0( | citation0 (config_t, cite_args_t) | ||
}); | }); | ||
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,511: | Line 4,714: | ||
]] | ]] | ||
return {citation = citation} | return { | ||
citation = citation, -- template entry point | |||
_citation = _citation, -- module entry point | |||
} | |||