更改
跳到导航
跳到搜索
第1行：
第1行： + − ]] − local dates, year_date_check, reformat_dates, date_hyphen_to_dash, -- functions in Module:Citation/CS1/Date_validation+ − date_name_xlate − local is_set, in_array, substitute, error_comment, set_error, select_one, -- functions in Module:Citation/CS1/Utilities+ − add_maint_cat, wrap_style, safe_for_italics, is_wikilink, make_wikilink, − strip_apostrophe_markup; − + − + − + − + + − + − delare variables here that have page-wide scope that are not brought in from other modules; thatare created here+ − + − + − + − + − + + 第48行：
第47行： − + − end − end − − − --[[--------------------------< A D D _ P R O P _ C A T >-------------------------------------------------------- − − Adds a category to z.properties_cats using names from the configuration file with additional text if any. − − foreign_lang_source and foreign_lang_source_2 keys have a language code appended to them so that multiple languages − may be categorized but multiples of the same language are not categorized. − − added_prop_cats is a table declared in page scope variables above − − ]] − − local function add_prop_cat (key, arguments) − if not added_prop_cats [key] then − added_prop_cats [key] = true; -- note that we've added this category − key = key:gsub ('(foreign_lang_source_?2?)%a%a%a?[%a%-]*', '%1'); -- strip lang code from keyname − table.insert( z.properties_cats, substitute (cfg.prop_cats [key], arguments)); -- make name then add to table 第81行：
第60行： − + − + − + − + − table.insert( z.message_tail, { set_error( 'vancouver', {source}, true ) } );+ − end+ 第95行：
第74行： − + 第118行：
第97行： − + − rfc952 (modified by rfc 1123) requires the first and last character of a hostname to be a letter or a digit. Between+ − + − + − + − + 第140行：
第119行： − + 第155行：
第134行： − + − + − + − + 第171行：
第150行： − + 第186行：
第165行： − + 第195行：
第174行： − + − + 第205行：
第184行： − + − + − + − + + + + 第223行：
第205行： − + − + − if is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then+ − + + + + + + + 第240行：
第228行： − + − + − + − + − + 第259行：
第247行： − + − + 第268行：
第256行： − + + + + 第275行：
第266行： − + − + + + + + + − + − table.insert( z.message_tail, { set_error( 'bad_paramlink', orig)}); -- url or wikilink in |title= with |title-link=; + + + + 第294行：
第293行： − + − + − + − + 第305行：
第304行： − + − + 第316行：
第315行： − + 第323行：
第322行： − + − + − + − + 第336行：
第335行： − + − + − + − + − + − + 第358行：
第357行： − + − local error_message = ''; − + − if is_set(error_message) then -- once we've added the first portion of the error message ... + − error_message=error_message .. ", "; -- ... add a comma space separator − end − error_message=error_message .. "|" .. k .. "="; -- add the failed parameter − end − if is_set (error_message) then -- done looping, if there is an error message, display it − table.insert( z.message_tail, { set_error( 'param_has_ext_link', {error_message}, true ) } ); 第382行：
第374行： − table.insert( z.message_tail, { set_error( 'wikilink_in_url', {}, true ) } ); + 第398行：
第390行： − + − + − + − + − error_str = set_error( 'bare_url_missing_title', { wrap_style ('parameter', source) }, false, " " ); + − + − + − error_str = set_error( 'bad_url', {wrap_style ('parameter', source)}, false, " " ) .. error_str; + − + − + − + − + − + − + − + 第438行：
第430行： − + 第445行：
第437行： − table.insert( z.message_tail, { set_error( 'deprecated_params', {name}, true ) } ); -- add error message + 第452行：
第444行： − + 第458行：
第450行： − + − + − + − + − local cap2=''; − + − + + − + − + − + − + − + − + − + − + − + − + − + 第509行：
第501行： − + − + − + 第523行：
第515行： − + 第534行：
第526行： − -- if script_value:match('^%l%l%s*:') then -- if first 3 non-space characters are script language prefix − -- lang = script_value:match('^(%l%l)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script − + − table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing title part'}, true ) } ); -- prefix without 'title'; add error message + − + − -- script_value = script_value:gsub ('^%l%l%s*:%s*', ''); -- strip prefix from script − + − + − table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'unknown language code'}, true ) } ); -- unknown script-language; add error message + − table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'invalid language code'}, true ) } ); -- invalid language code; add error message + − table.insert( z.message_tail, { set_error( 'script_parameter', {script_param, 'missing prefix'}, true ) } ); -- no language code prefix; add error message + − + 第569行：
第558行： − + − + + − + − + − + 第593行：
第583行： − + 第599行：
第589行： − + − + − + − makes a wikisource url from wikisource interwiki link. returns the url and appropriate label; nil else.+ + 第617行：
第608行： + − + − + − + − 'https://en.wikisource.org/wiki/', -- prefix + − + − + − + − + − 'https://en.wikisource.org/wiki/', -- prefix + − + − + − + − 'https://en.wikisource.org/wiki/', -- prefix + − + − + − + − + − + − + − + − local periodical_error = ''; − + − + − + − + − + − + − + − + − periodical_error = ' ' .. set_error ('trans_missing_title', {'periodical'}); + − + − + − + − + + − + − local chapter_error = '';+ − − − + − + − + − + − + − + − + − + − + − transchapter = wrap_style ('trans-quoted-title', transchapter); + − + − + − + − + − chapter_error = ' ' .. set_error ('trans_missing_title', {'chapter'}); + + − -- if is_set (chapterurl) then+ − -- chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate − -- end − − − + − + − + − + − + − + + − + − + − + 第760行：
第748行： − local dummy; -- end of matching string; not used but required to hold end position when a capture is returned − + − local stripmarker, apostrophe;+ − + − + − − while cfg.invisible_chars[i] do + − + − + − + − + − + + + 第783行：
第771行： − + − + − + − + − + − table.insert( z.message_tail, { set_error( 'invisible_char', {err_msg, wrap_style ('parameter', param), position}, true ) } ); -- add error message + − i=i+1; -- bump our index − + − + − + + − + − + − + 第829行：
第817行： − + − + 第843行：
第831行： − + 第854行：
第842行： − + − + − + + 第864行：
第853行： − + − + − + − + 第879行：
第868行： − + − + − + + + − + − + − + 第898行：
第889行： − --[[--------------------------< H Y P H E N _ T O _ D A S H >--------------------------------------------------+ − − Converts a hyphen to a dash under certain conditions. The hyphen must separate like items; unlike items are − returned unmodified. These forms are modified: − letter - letter (A - B) − digit - digit (4-5) − digit separator digit - digit separator digit (4.1-4.5 or 4-1-4-5) − letterdigit - letterdigit (A1-A5) (an optional separator between letter and digit is supported – a.1-a.5 or a-1-a-5) − digitletter - digitletter (5a - 5d) (an optional separator between letter and digit is supported – 5.a-5.d or 5-a-5-d) − − any other forms are returned unmodified. − − str may be a comma- or semicolon-separated list − − ]] − − local function hyphen_to_dash( str ) − if not is_set (str) then − return str; − end − − str, count = str:gsub ('^%(%((.+)%)%)$', '%1'); -- remove accept-this-as-written markup when it wraps all of str − if 0 ~= count then -- non-zero when markup removed; zero else − return str; -- nothing to do, we're done − end − − str = str:gsub ('&[nm]dash;', {['–'] = '–', ['—'] = '—'}); -- replace — and – entities with their characters; semicolon mucks up the text.split − str = str:gsub ('-', '-'); -- replace html numeric entity with hyphen character − − local out = {}; − local list = mw.text.split (str, '%s*[,;]%s*'); -- split str at comma or semicolon separators if there are any − − for _, item in ipairs (list) do -- for each item in the list − if mw.ustring.match (item, '^%w*[%.%-]?%w+%s*[%-–—]%s*%w*[%.%-]?%w+$') then -- if a hyphenated range or has endash or emdash separators − if item:match ('^%a+[%.%-]?%d+%s*%-%s*%a+[%.%-]?%d+$') or -- letterdigit hyphen letterdigit (optional separator between letter and digit) − item:match ('^%d+[%.%-]?%a+%s*%-%s*%d+[%.%-]?%a+$') or -- digitletter hyphen digitletter (optional separator between digit and letter) − item:match ('^%d+[%.%-]%d+%s*%-%s*%d+[%.%-]%d+$') or -- digit separator digit hyphen digit separator digit − item:match ('^%d+%s*%-%s*%d+$') or -- digit hyphen digit − item:match ('^%a+%s*%-%s*%a+$') then -- letter hyphen letter − item = item:gsub ('(%w*[%.%-]?%w+)%s*%-%s*(%w*[%.%-]?%w+)', '%1–%2'); -- replace hyphen, remove extraneous space characters − else − item = mw.ustring.gsub (item, '%s*[–—]%s*', '–'); -- for endash or emdash separated ranges, replace em with en, remove extraneous white space − end − end − item = item:gsub ('^%(%((.+)%)%)$', '%1'); -- remove the accept-this-as-written markup − table.insert (out, item); -- add the (possibly modified) item to the output table − end − − return table.concat (out, ', '); -- concatenate the output table into a comma separated string − end − − − 第957行：
第896行： − + − + − + − + − + − + − + − + 第978行：
第917行： − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + 第1,027行：
第966行： − + 第1,034行：
第973行： − + − + + − + 第1,048行：
第988行： − + − + − + − + − These things are not currently possible in this module so are left to the editor to do.+ + + − + + 第1,061行：
第1,004行： − + + − + − + − + − + + + + 第1,077行：
第1,024行： − + − local first, suffix = first:match ('(.-),?%s*([%dJS][%drndth]+)%.?$') or first; -- if first has something that looks like a generational suffix, get it + − + − + + + + + − + 第1,088行：
第1,039行： − + − + 第1,097行：
第1,048行： − + − + + − + − + + + − + + − + − + 第1,121行：
第1,076行： − + 第1,129行：
第1,084行： − 第1,145行：
第1,099行： − + − + 第1,154行：
第1,108行： − + + + + + + + + − Formats a list of people (e.g. authors / editors) + − + − + − + − local lastauthoramp = control.lastauthoramp;+ − − + − + − lastauthoramp = nil; -- unset because isn't used by Vancouver style − + − + − + − + − + − + − + − + + − elseif (mask ~= nil) then + − + − + − + + + + − + − + − + − + − + − + − + − + − if is_set(person.link) and person.link ~= control.page_name then − one = make_wikilink (person.link, one); -- link author/editor if this page is not the author's/editor's page − end − + − table.insert( text, sep_one )+ + + + + + − + − + − + − text[#text-2] = " & "; -- replace last separator with ampersand text + + + + + + + + + − text[#text] = nil; -- erase the last separator + − + − + − + − + − + − + − + + − + + − + − + − + − + − + + + + + + + + + − table.insert (names, year); -- add the year at the end+ − + − + − return "CITEREF" .. id; -- add the CITEREF portion + + + + + + + + + + + + + + + − return ''; -- return an empty string; no reason to include CITEREF id in this citation + + + + + + − + − + − + + − + − + + 第1,269行：
第1,273行： − + − + 第1,277行：
第1,281行： − table.insert( z.message_tail, {set_error ('etal', {param})}); -- and set an error if not added + 第1,283行：
第1,287行： − + − + − Evaluates the content of author and editor parameters for extranious editor annotations: ed, ed., eds, (Ed.), etc.+ − These annotation do not belong in author parameters and are redundant in editor parameters. If found, the function+ − adds the editor markup maintenance category.+ + + − + − local _, pattern; + − local patterns = cfg.editor_markup_patterns; -- get patterns from configuration+ − + − if is_set (name) then − for _, pattern in ipairs (patterns) do -- spin through patterns table and − if name:match (pattern) then − add_maint_cat ('extra_text_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template − break; − end − return name; -- and done − + + + + + + − Evaluates the content of author and editor (surnames only) parameters for multiple names. Multiple names are+ − indicated if there is more than one comma and or semicolon. If found, the function adds the multiple name − (author or editor) maintenance category. − + − + − + + + + + + + + − if 1 < count then -- param could be |author= or |editor= so one separator character is acceptable + − add_maint_cat ('mult_names', cfg.special_case_translation [list_name]); -- more than one separator indicates multiple names so add a maint cat for this template + + + + − return name; -- and done − + − This function calls various name checking functions used to validate the content of the various name-holding+ − parameters.+ + + + + + + + + + − + − if is_set (last) then+ − + − last = last:match ('^%(%((.*)%)%)$'); -- strip parens + − else+ − last = name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only) + − last = name_has_ed_markup (last, list_name); -- check for extraneous 'editor' annotation+ + + + + + + + + − + − if first:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written + − first = first:match ('^%(%((.*)%)%)$'); -- strip parens + − else + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − end+ + + − --[[--------------------------< E X T R A C T _ N A M E S >---------------------------------------------------- − + − + − + + + − + − + + + − + − + − + + − + − + − + − + − + − + − + − + − + − + − + − + − + − table.insert( z.message_tail, { set_error( 'first_missing_last', {first_alias, first_alias:gsub('first', 'last')}, true ) } ); -- add this error message + + + + + 第1,404行：
第1,486行： − + + + + + + − + − table.insert( z.message_tail, { set_error( 'missing_name', {list_name:match ("(%w+)List"):lower(), i-1}, true ) } ); -- add this error message + 第1,416行：
第1,503行： − + − + − Validates language names provided in |language= parameter if not an ISO639-1 or 639-2 code.+ − Returns the language name and associated two- or three-character code. Because case of the source may be incorrect+ − or different from the case that WikiMedia uses, the name comparisons are done in lower case and when a match is+ − found, the Wikimedia version (assumed to be correct) is returned along with the code. When there is no match, we+ − return the original language name string.+ + + + + + − mw.language.fetchLanguageNames(<local wiki language>, 'all') returns a list of languages that in some cases may include+ − extensions. For example, code 'cbk-zam' and its associated name 'Chavacano de Zamboanga' (MediaWiki does not support − code 'cbk' or name 'Chavacano'. Most (all?) of these languages are not used a 'language' codes per se, rather they − are used as sub-domain names: cbk-zam.wikipedia.org. A list of language names and codes supported by fetchLanguageNames() − can be found at Template:Citation Style documentation/language/doc − Names that are included in the list will be found if that name is provided in the |language= parameter. For example,+ − if |language=Chavacano de Zamboanga, that name will be found with the associated code 'cbk-zam'. When names are found − and the associated code is not two or three characters, this function returns only the WikiMedia language name. − Some language names have multiple entries under different codes:+ − Aromanian has code rup and code roa-rup + − When this occurs, this function returns the language name and the 2- or 3-character code+ + − Adapted from code taken from Module:Check ISO 639-1.+ + + + − + + + + + + + + + − local function get_iso639_code (lang, this_wiki_code)+ − if cfg.lang_name_remap[lang:lower()] then -- if there is a remapped name (because MediaWiki uses something that we don't think is correct) + − + + − local ietf_code; -- because some languages have both ietf-like codes and iso 639-like codes + − local ietf_name; + + + + − local languages = mw.language.fetchLanguageNames(this_wiki_code, 'all') -- get a list of language names known to Wikimedia + − -- ('all' is required for North Ndebele, South Ndebele, and Ojibwa) − local langlc = mw.ustring.lower(lang); -- lower case version for comparisons − for code, name in pairs(languages) do -- scan the list to see if we can find our language + − + − if 2 == code:len() or 3 == code:len() then -- two- or three-character codes only; extensions not supported + − return name, code; -- so return the name and the code+ − end − ietf_code = code; -- remember that we found an ietf-like code and save its name − ietf_name = name; -- but keep looking for a 2- or 3-char code − -- didn't find name with 2- or 3-char code; if ietf-like code found return − return ietf_code and ietf_name or lang; -- associated name; return original language text else − + − + − + + − + − + − + + − + − + + − + − + + − + + − + − − local this_wiki_name = mw.language.fetchLanguageName(cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name − names_table = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list + − for _, lang in ipairs (names_table) do -- reuse lang + − name = cfg.lang_code_remap[lang:lower()]; -- first see if this is a code that is not supported by MediaWiki but is in remap − if name then -- there was a remapped code so+ − if not lang:match ('^%a%a%a?%-x%-%a+$') then -- if not a private ietf tag+ − lang = lang:gsub ('^(%a%a%a?)%-.*', '%1'); -- strip ietf tags from code − end − else − if lang:match ('^%a%a%-') then -- strip ietf tags from code; TODO: is there a need to support 3-char with tag? − lang = lang:match ('(%a%a)%-') -- keep only 639-1 code portion to lang; TODO: do something with 3166 alpha 2 country code? − end − if 2 == lang:len() or 3 == lang:len() then -- if two-or three-character code − name = mw.language.fetchLanguageName (lang:lower(), cfg.this_wiki_code); -- get language name if |language= is a proper code − end − end − + − code = lang:lower(); -- save it + − else − name, code = get_iso639_code (lang, cfg.this_wiki_code); -- attempt to get code from name (assign name here so that we are sure of proper capitalization) − end − − if is_set (code) then -- only 2- or 3-character codes − name = cfg.lang_code_remap[code] or name; -- override wikimedia when they misuse language codes/names − + − + − + − + − + − + − add_maint_cat ('unknown_lang'); -- add maint category if not already added + + 第1,541行：
第1,623行： − + − code = #language_list -- reuse code as number of languages in the list + − + − name = table.concat (language_list, cfg.messages['parameter-pair-separator']) -- insert '<space>and<space>' between two language names − elseif 2 < code then − name = table.concat (language_list, ', '); -- and concatenate with '<comma><space>' separators − name = name:gsub (', ([^,]+)$', cfg.messages['parameter-final-separator'] .. '%1'); -- replace last '<comma><space>' separator with '<comma><space>and<space>' separator − end − if this_wiki_name == name then 第1,559行：
第1,635行： − + − Set style settings for CS1 citation templates. Returns separator and postscript settings+ − At en.wiki, for cs1:+ − ps gets: '.'+ − sep gets: '.'+ − + − + − ps = cfg.presentation['ps_cs1']; -- terminate the rendered citation + + + + + + + − + + − --[[--------------------------< S E T _ C S 2 _ S T Y L E >----------------------------------------------------+ − + − Set style settings for CS2 citation templates. Returns separator, postscript, ref settings − At en.wiki, for cs2: − ps gets: '' (empty string - no terminal punctuation) − sep gets: ',' − + − + − ps = cfg.presentation['ps_cs2']; -- terminate the rendered citation + + + + + + + + − + − ref = "harv"; -- set default |ref=harv + + + + + + + − + + − + − When |mode= is not set or when its value is invalid, use config.CitationClass and parameter values to establish+ − rendered style.+ − ]]+ − local function get_settings_from_cite_class (ps, ref, cite_class)+ − local sep; − if (cite_class == "citation") then -- for citation templates (CS2) − sep, ps, ref = set_cs2_style (ps, ref); − else -- not a citation template so CS1 − sep, ps = set_cs1_style (ps); − end − − return sep, ps, ref -- return them all − end − − − --[[--------------------------< S E T _ S T Y L E >------------------------------------------------------------ − − Establish basic style settings to be used when rendering the citation. Uses |mode= if set and valid or uses − config.CitationClass from the template's #invoke: to establish style. − − ]] − − local function set_style (mode, ps, ref, cite_class) − local sep; − if 'cs2' == mode then -- if this template is to be rendered in CS2 (citation) style − sep, ps, ref = set_cs2_style (ps, ref); − elseif 'cs1' == mode then -- if this template is to be rendered in CS1 (cite xxx) style − sep, ps = set_cs1_style (ps); − else -- anything but cs1 or cs2 − sep, ps, ref = get_settings_from_cite_class (ps, ref, cite_class); -- get settings based on the template's CitationClass − end − if 'none' == ps:lower() then -- if assigned value is 'none' then − ps = ''; -- set to empty string − end − − return sep, ps, ref − end − − − --[=[-------------------------< I S _ P D F >------------------------------------------------------------------ − − Determines if a url has the file extension that is one of the pdf file extensions used by [[MediaWiki:Common.css]] when − applying the pdf icon to external links. − − returns true if file extension is one of the recognized extensions, else false − − 第1,655行：
第1,705行： − + − + − + − + + 第1,665行：
第1,716行： − + − + − + − format = format .. set_error( 'format_missing_url', {fmt_param, url_param} ); -- add an error message + − + − + 第1,679行：
第1,730行： − + − + − + − + − + − + − + − + − + 第1,702行：
第1,753行： − + − + 第1,710行：
第1,761行： − add_maint_cat ('disp_name', cfg.special_case_translation [list_name]); + + − table.insert( z.message_tail, { set_error( 'invalid_param_val', {'display-' .. list_name, max}, true ) } ); -- add error message + 第1,722行：
第1,774行： − + − + − + − + − + − + + − + − local good_pattern = '^P[^%.Pp]'; -- ok to begin with uppercase P: P7 (pg 7 of section P) but not p123 (page 123) TODO: add Gg for PG or Pg? + − local bad_pattern = '^[Pp]?[Pp]%.?[ %d]'; + − + − if not page:match (good_pattern) and (page:match (bad_pattern) or page:match ('^[Pp]ages?')) then+ − add_maint_cat ('extra_text'); + − + + + − + − split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled+ − parentheses to also have commas; in the old version of the code, the doubled parnetheses were included in the − rendered citation and in the metadata. Individual author names may be wikilinked − − |vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.)) − ]=]+ + + + − local function get_v_name_table (vparam, output_table, output_link_table)+ − 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 place holder + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + − + − + − + − + 第1,781行：
第1,878行： − + 第1,794行：
第1,891行： − + − + 第1,814行：
第1,911行： − if v_name:match ('^%(%(.+%)%)$') then -- corporate authors are wrapped in doubled parentheses to supress vanc formatting and error detection + − first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor+ − last = v_name:match ('^%(%((.+)%)%)$') -- remove doubled parntheses+ + + + − + − + − + − + − + + − + − + + + + + + − + − + − first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor − + − + − + − + − + 第1,852行：
第1,957行： − + − + − + − + 第1,867行：
第1,972行： − + − + − similarly, |editorn= (and aliases) highest and |editors= lowest+ 第1,878行：
第1,983行： − + − + − + − + − + − + − + − + − + − + 第1,900行：
第2,005行： − table.insert( z.message_tail, { set_error( 'redundant_parameters', + − {err_name .. '-name-list parameters'}, true ) } ); -- add error message − + − + 第1,914行：
第2,018行： − + + + − + − + − elseif in_array (value, possible) then + + + + + − table.insert( z.message_tail, { set_error( 'invalid_param_val', {name, value}, true ) } ); -- not an allowed value so add error message + 第1,943行：
第2,053行： − + − + − + 第1,961行：
第2,071行： − + + + + + + + − + − + − return wrap_msg ('vol-no', {sepc, volume, issue}, lower); + − elseif is_set (volume) then+ − return wrap_msg ('vol', {sepc, volume}, lower); + − else + − + + + + + + + + + + + + + − + − + − local vol = ''; -- here for all cites except magazine + − + − + − if volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')then -- volume value is all digits or all uppercase roman numerals+ − vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- render in bold face+ − elseif (4 < mw.ustring.len(volume)) then -- not all digits or roman numerals and longer than 4 characters+ − vol = substitute (cfg.messages['j-vol'], {sepc, volume}); -- not bold+ − add_prop_cat ('long_vol'); − else -- four or less characters − vol = substitute (cfg.presentation['vol-bold'], {sepc, hyphen_to_dash(volume)}); -- bold − end − end − if is_set (issue) then − − return vol; 第2,010行：
第2,130行： − + 第2,016行：
第2,136行： − + 第2,025行：
第2,145行： − + − + − + − + − + − + − + − + − + − + 第2,055行：
第2,175行： − + − + 第2,066行：
第2,186行： − + − + − + − + − + − + − + − + − + − + − + − + − + − + − + 第2,106行：
第2,226行： + + + + + + + + + + + + + + + + − + − + − + − + − + − + − + 第2,133行：
第2,269行： − + − + − + 第2,143行：
第2,279行： − + − + − + − + − + − + − + − + − + + − + + + + + − + − + − + − + − + − + − + − table.insert( z.message_tail, { set_error( 'archive_url', {err_msg}, true ) } ); -- add error message and + − + − + + − + 第2,185行：
第2,327行： − + 第2,192行：
第2,334行： − + − add_maint_cat ('location'); -- yep, add maint cat + 第2,204行：
第2,346行： − + − This is the main function doing the majority of the citation formatting.+ − + − + − + + + + + + + + + + + + + + + + + + + − + − − local Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], ''); − + − 第2,235行：
第2,392行： − NameListFormat = 'vanc'; -- override whatever |name-list-format= might be + − add_maint_cat ('authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO: + − + − − local Others = A['Others']; − local Editors; − + − NameListFormat = 'vanc'; -- override whatever |name-list-format= might be + − elseif 3 == selected then − Editors = A['Editors']; -- use content of |editors= − add_maint_cat ('editors'); -- but add a maint cat because use of this parameter is discouraged − + − + − 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 interviewer_etal;+ − local interviewers_list = {}; − − interviewers_list = extract_names (args, 'InterviewerList'); -- process preferred interviewers parameters − − local contributor_etal; − local Contributors; -- assembled contributors name list + − local Contribution = A['Contribution'];+ − − + − table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'contribution')}); -- add missing contribution error message + − table.insert( z.message_tail, { set_error( 'contributor_missing_required_param', 'author')}); -- add missing author error message + − + − table.insert( z.message_tail, { set_error( 'contributor_ignored')}); -- add contributor ignored error message + − if is_set (Others) then+ − if 0 == #a and 0 == #e then -- add maint cat when |others= has value and used without |author=, |editor= − add_maint_cat ('others'); − end − end − − local Year = A['Year']; − local PublicationDate = A['PublicationDate']; − local OrigYear = A['OrigYear']; − local Date = A['Date']; − local LayDate = A['LayDate']; − ------------------------------------------------- Get title data − − local ScriptTitle = A['ScriptTitle']; − local BookTitle = A['BookTitle']; − local Conference = A['Conference']; − local TransTitle = A['TransTitle']; − local TitleNote = A['TitleNote']; − link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wikimarkup in |title-link= or wikimarkup in |title= when |title-link= is set − + − + − local ScriptChapterOrigin = A:ORIGIN ('ScriptChapter'); + − local ChapterLink -- = A['ChapterLink']; -- deprecated as a parameter but still used internally by cite episode+ − local TransChapter = A['TransChapter']; + − local TitleType = A['TitleType'];+ − local Degree = A['Degree'];+ − local Docket = A['Docket']; − local ArchiveFormat = A['ArchiveFormat']; − local ArchiveDate; + − local ArchiveURL; − ArchiveURL, ArchiveDate = archive_url_check (A['ArchiveURL'], A['ArchiveDate']) + − + − local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');+ + + − − local URL = A['URL'] − local URLorigin = A:ORIGIN('URL'); -- get name of parameter that holds URL − local ChapterURL = A['ChapterURL']; − local ChapterURLorigin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL − local ConferenceFormat = A['ConferenceFormat']; − local ConferenceURL = A['ConferenceURL']; − local ConferenceURLorigin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL − if is_set (Periodical) then+ − Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter+ − local i;+ − Periodical, i = strip_apostrophe_markup (Periodical); -- strip appostrophe markup so that metadata isn't contaminated + − if i then -- non-zero when markup was stripped so emit an error message+ − table.insert( z.message_tail, {set_error ('apostrophe_markup', {Periodical_origin}, true)});+ − end + − local ScriptPeriodical = A['ScriptPeriodical']; + − local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');+ − -- 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? − − -- 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 − table.insert( z.message_tail, {set_error ('missing_periodical', {config.CitationClass, p[config.CitationClass]}, true)}); − end − + + + + + − + + + + + + + + + − + − local Page; − local Pages; − local At; − − + − + − + 第2,392行：
第2,511行： − + + + − + − + − + − + − + − + + − + − + + + − + 第2,420行：
第2,544行： − if is_set (PublisherName) then+ − local i=0;+ − PublisherName, i = strip_apostrophe_markup (PublisherName); -- strip appostrophe markup so that metadata isn't contaminated; publisher is never italicized+ + + + + − if i then -- non-zero when markup was stripped so emit an error message+ − table.insert( z.message_tail, {set_error ('apostrophe_markup', {PublisherName_origin}, true)});+ − end+ + + + + + + + − if not is_set(URL) and is_set(UrlAccess) then+ − UrlAccess = nil;+ − table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'url'}, true ) } );+ − end+ − + + + − if not is_set(ChapterURL) and is_set(ChapterUrlAccess) then+ − ChapterUrlAccess = nil;+ − table.insert( z.message_tail, { set_error( 'param_access_requires_param', {A:ORIGIN('ChapterUrlAccess'):gsub ('%-access', '')}, true ) } );+ − end+ − if not is_set(A['MapURL']) and is_set(MapUrlAccess) then+ − MapUrlAccess = nil;+ − table.insert( z.message_tail, { set_error( 'param_access_requires_param', {'map-url'}, true ) } );+ − end+ − − local Via = A['Via']; − local AccessDate = A['AccessDate']; − local Agency = A['Agency']; − − local Language = A['Language']; − local Format = A['Format']; − local ChapterFormat = A['ChapterFormat']; − local DoiBroken = A['DoiBroken']; − local ID = A['ID']; − local ASINTLD = A['ASINTLD']; − local IgnoreISBN = is_valid_parameter_value (A['IgnoreISBN'], A:ORIGIN('IgnoreISBN'), cfg.keywords_lists['yes_true_y'], nil); − local Embargo = A['Embargo']; − local Class = A['Class']; -- arxiv class identifier − − local ID_list = extract_ids( args ); − if is_set (DoiBroken) and not ID_list['DOI'] then − table.insert( z.message_tail, { set_error( 'doibroken_missing_doi', A:ORIGIN('DoiBroken'))}); − end − local ID_access_levels = extract_id_access_levels( args, ID_list ); − − local Quote = A['Quote']; − − local LayFormat = A['LayFormat']; − local LayURL = A['LayURL']; − local LaySource = A['LaySource']; − local Transcript = A['Transcript']; − local TranscriptFormat = A['TranscriptFormat']; − local TranscriptURL = A['TranscriptURL'] − local TranscriptURLorigin = A:ORIGIN('TranscriptURL'); -- get name of parameter that holds TranscriptURL − − local LastAuthorAmp = is_valid_parameter_value (A['LastAuthorAmp'], A:ORIGIN('LastAuthorAmp'), cfg.keywords_lists['yes_true_y'], nil); + − --local variables that are not cs1 parameters+ − local use_lowercase; -- controls capitalization of certain static text+ − local this_page = mw.title.getCurrentTitle(); -- also used for COinS and for language+ − local anchor_year; -- used in the CITEREF identifier − local COinS_date = {}; -- holds date info extracted from |date= for the COinS metadata by Module:Date verification − − local DF = is_valid_parameter_value (A['DF'], A:ORIGIN('DF'), cfg.keywords_lists['df'], ''); − if not is_set (DF) then − DF = cfg.global_df; -- local df if present overrides global df set by {{use xxx date}} template − end − − local sepc; -- separator between citation elements for CS1 a period, for CS2, a comma − local PostScript; − local Ref; − sepc, PostScript, Ref = set_style (Mode:lower(), A['PostScript'], A['Ref'], config.CitationClass); − use_lowercase = ( sepc == ',' ); -- used to control capitalization for certain static text − − − − − + 第2,510行：
第2,599行： − + − -- check for extra |page=, |pages= or |at= parameters. (also sheet and sheets while we're at it)+ − − + − + − + − + − -- if not is_set(PublicationPlace) and is_set(Place) then -- both |publication-place= and |place= (|location=) allowed if different − -- PublicationPlace = Place; -- promote |place= (|location=) to |publication-place − -- end − -- + + + + + + + + + + + − + − + − + − + − + − + − + − + − + − + − + + + + + + + + + + + + + + + + + − ScriptChapterOrigin = A:ORIGIN('ScriptTitle') + + + − + − + 第2,573行：
第2,686行： − + − + 第2,580行：
第2,693行： − + + − + − + − table.insert( z.message_tail, { set_error('redundant_parameters', {wrap_style ('parameter', 'id') .. ' and ' .. wrap_style ('parameter', 'number')}, true )}); + − end − − -- special case for cite mailing list − if (config.CitationClass == "mailinglist") then − Periodical = A ['MailingList']; − elseif 'mailinglist' == Periodical_origin then − Periodical = ''; -- unset because mailing list is only used for cite mailing list + + + + − + − + + − ChapterURLorigin = URLorigin; + − URLorigin = ''; + + − + 第2,618行：
第2,731行： − + + + + + + + + 第2,625行：
第2,745行： + + + + − ChapterURLorigin = A:ORIGIN('MapURL'); + − ScriptChapterOrigin = A:ORIGIN('ScriptMap') + 第2,636行：
第2,760行： − + − + 第2,646行：
第2,770行： + − local AirDate = A['AirDate']; − + 第2,656行：
第2,780行： − + − + − if not is_set (Date) and is_set (AirDate) then -- promote airdate to date − Date = AirDate; − end − − + − table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'season') .. ' and ' .. wrap_style ('parameter', 'seriesno')}, true ) } ); -- add error message + − + − + − + − -- ScriptChapterOrigin = 'title';+ − ScriptChapterOrigin = A:ORIGIN('ScriptTitle'); + − − ChapterURLorigin = A:ORIGIN('URL'); + 第2,692行：
第2,811行： − + − + − + − + 第2,704行：
第2,823行： − + − + − + − + − do + − if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then+ − if not is_set (ID_list[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates+ − table.insert( z.message_tail, { set_error( config.CitationClass .. '_missing', {}, true ) } ); -- add error message − end − − Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass]; − end − end − − -- handle type parameter for those CS1 citations that have default values − − + − + − + + + + − + − + 第2,761行：
第2,874行： + + + + + + + + + + + + + + + + + + + + + + − + − + − + − + − + − + − + − + − + + + − + − + − local mismatch = year_date_check (Year, Date) + − if 0 == mismatch then -- |year= does not match a year-value in |date= − if is_set (error_message) then -- if there is already an error message − error_message = error_message .. ', '; -- tack on this additional message − end − error_message = error_message .. '|year= / |date= mismatch'; − elseif 1 == mismatch then -- |year= matches year-value in |date= − add_maint_cat ('date_year'); − end − + − + − + − + − add_maint_cat ('date_format'); -- hyphens were converted so add maint category + − + − -- uncomment these three lines. Not supported by en.wiki (for obvious reasons)+ − -- set date_name_xlate() second argument to true to translate English digits to local digits (will translate ymd dates)+ − -- if date_name_xlate (date_parameters_list, false) then+ − + − -- end 第2,822行：
第2,950行： − table.insert( z.message_tail, { set_error( 'bad_date', {error_message}, true ) } ); -- add this error message + − + − -- Here we unset Embargo if PMC not embargoed (|embargo= not set in the citation) or if the embargo time has expired. Otherwise, holds embargo date + − Embargo = is_embargoed (Embargo);+ − + − + − + − URL=cfg.id_handlers['PMC'].prefix .. ID_list['PMC']; -- set url to be the same as the PMC external link if not embargoed+ − URLorigin = cfg.id_handlers['PMC'].parameters[1]; -- set URLorigin to parameter name for use in error message if citation is missing a |title=+ − if is_set(AccessDate) then -- access date requires |url=; pmc created url is not |url= + − table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); + − AccessDate = ''; -- unset + + + + + + + + + + + + + + + + + + + + + + + + + + + + 第2,844行：
第2,999行： − + − not is_set(TransTitle) and+ − not is_set(ScriptTitle) then − if 'episode' == config.CitationClass then -- special case for cite episode; TODO: is there a better way to do this? − table.insert( z.message_tail, { set_error( 'citation_missing_title', {'series'}, true ) } ); − else − table.insert( z.message_tail, { set_error( 'citation_missing_title', {'title'}, true ) } ); − end − + − + − + − add_maint_cat ('untitled'); + − − check_for_url ({ -- add error message when any of these parameters hold a URL − ['title']=Title, − [A:ORIGIN('Chapter')]=Chapter, − [Periodical_origin] = Periodical, − [PublisherName_origin] = PublisherName − }); 第2,876行：
第3,018行： − + − + 第2,886行：
第3,028行： + + + − + − + − + − + − + + − + − + − + − + − + − if is_set (PublisherName) then+ − PublisherName = substitute (cfg.messages['newsgroup'], external_link( 'news:' .. PublisherName, PublisherName, PublisherName_origin, nil )); − end + + + + + + + + + + + + + − local EditorCount; -- used only for choosing {ed.) or (eds.) annotation at end of editor name-list − + − lastauthoramp = LastAuthorAmp, − page_name = this_page.text, -- get current page name so that we don't wikilink to it via editorlinkn − + − last_first_list, EditorCount = list_people(control, e, editor_etal); + − − if is_set (Editors) then − Editors, editor_etal = name_has_etal (Editors, editor_etal, false, 'editors'); -- find and remove variations on et al. − if editor_etal then − Editors = Editors .. ' ' .. cfg.messages['et al']; -- add et al. to editors parameter beause |display-editors=etal − EditorCount = 2; -- with et al., |editors= is multiple names; spoof to display (eds.) annotation − else − EditorCount = 2; -- we don't know but assume |editors= is multiple names; spoof to display (eds.) annotation − end − else − Editors = last_first_list; -- either an author name list or an empty string − end 第2,957行：
第3,099行： − + − + − + − + − + − + 第2,983行：
第3,125行： − + 第2,989行：
第3,131行： − -- apply |[xx-]format= styling; at the end, these parameters hold correctly styled format annotation, + − -- an error message if the associated url is not set, or an empty string for concatenation+ − ArchiveFormat = style_format (ArchiveFormat, ArchiveURL, 'archive-format', 'archive-url'); − LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url'); − TranscriptFormat = style_format (TranscriptFormat, TranscriptURL, 'transcript-format', 'transcripturl'); − + − + − + − + − table.insert( z.message_tail, { set_error( 'cite_web_url', {}, true ) } ); + − + − table.insert( z.message_tail, { set_error( 'accessdate_missing_url', {}, true ) } ); + − + + + + + − + − + − OriginalURLorigin = ChapterURLorigin; -- name of chapter-url parameter for error messages + − + − ChapterURLorigin = A:ORIGIN('ArchiveURL') -- name of archive-url parameter for error messages + − + − + − OriginalURLorigin = URLorigin; -- name of url parameter for error messages + − + − + − URLorigin = A:ORIGIN('ArchiveURL') -- name of archive url parameter for error messages + − + − end + + + − + − + − + − + − + − + − + − + − + − table.insert( z.message_tail, { set_error( 'chapter_ignored', {chap_param}, true ) } ); -- add error message + 第3,070行：
第3,215行： − + − + − + − + − + − + − + − + − + − add_maint_cat ('archived_copy'); -- add maintenance category before we modify the content of Title + + + + + + + + + − + − Title= Title:gsub ('^%(%((.*)%)%)$', '%1') -- remove the markup+ − else − − + + + + + + + + + − + − + − + − + − + − + − + − + − + − + − + − + − + − + − local TransError = "";+ − + − − TransError = " " .. set_error( 'trans_missing_title', {'title'} ); + − + − + − + + + + + + − + − + − + − + − + − + − + − + − + − + − + − + − + − + + − + − + − + + − + − + − table.insert( z.message_tail, { set_error( 'redundant_parameters', {wrap_style ('parameter', 'minutes') .. ' and ' .. wrap_style ('parameter', 'time')}, true ) } ); + − + − + 第3,201行：
第3,366行： − + − + − local Section = A['Section'];+ − − + − + − + 第3,220行：
第3,384行： − + − Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc + − else+ − Language=""; -- language not specified so make sure this is an empty string; + − --[[ TODO: need to extract the wrap_msg from language_parameter+ − so that we can solve parentheses bunching problem with Format/Language/TitleType+ − ]]+ + − + − − + − + − + − + − + − add_maint_cat ('extra_text', 'edition'); + + 第3,248行：
第3,413行： − + − OrigYear = is_set (OrigYear) and wrap_msg ('origyear', OrigYear) or ''; + − + − ------------------------------------ totally unrelated data+ − Via = is_set (Via) and wrap_msg ('via', Via) or ''; − − − + − + − + − + − + + + − + − ID_list = build_id_list( ID_list, {IdAccessLevels=ID_access_levels, DoiBroken = DoiBroken, ASINTLD = ASINTLD, IgnoreISBN = IgnoreISBN, Embargo=Embargo, Class = Class} ); + + + − + − URL = " " .. external_link( URL, nil, URLorigin, UrlAccess );+ − end+ + − if 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+ + − + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + − + − + + + + + + + + + + − + − + + − + − { external_link( ArchiveURL, arch_text, A:ORIGIN('ArchiveURL'), nil ) .. ArchiveFormat, ArchiveDate } );+ − + − Archived = Archived .. " " .. set_error('archive_missing_url'); + + + + + + − + − + − + − add_maint_cat ('bot:_unknown'); -- and add a category if not already added + − add_maint_cat ('unfit'); -- and add a category if not already added + − + − { external_link( OriginalURL, cfg.messages['original'], OriginalURLorigin, OriginalAccess ) .. OriginalFormat, ArchiveDate } ); -- format already styled+ + + + + − Archived = sepc .. " " .. substitute( arch_text, + − { set_error('archive_missing_url'), ArchiveDate } );+ − + − + − + − + − + − + + + + + 第3,343行：
第3,572行： − + − + − + − + + + + + + − + − + − + − + − + − + 第3,372行：
第3,606行： + + − + − + − + − + − + − + − + + + + + + + + + + + − + − + − + + + 第3,401行：
第3,649行： − + − + − + − + 第3,413行：
第3,661行： − + − + 第3,435行：
第3,683行： + + 第3,445行：
第3,695行： − + − + − + + + − + − + − + − + − + − + − + 第3,476行：
第3,728行： − + − + − + 第3,490行：
第3,742行： − + − + 第3,506行：
第3,758行： − + 第3,513行：
第3,765行： − + − + − + − + − + − + − if is_set(config.CitationClass) and config.CitationClass ~= "citation" then+ − options.class = config.CitationClass;+ − options.class = "citation " .. config.CitationClass; -- class=citation required for blue highlight when used with |ref=+ − else+ − options.class = "citation";+ − end+ − − − local id = Ref − if ('harv' == Ref ) then − local namelist = {}; -- 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 = c; -- select it+ − elseif #a > 0 then -- or an author list+ − namelist = a;+ − elseif #e > 0 then -- or an editor list+ − namelist = e;+ − end+ − if #namelist > 0 then -- if there are names in namelist+ − id = anchor_id (namelist, year); -- go make the CITEREF anchor+ − else + − id = ''; -- unset + + + + − options.id = id; + − + − + − + − + − z.message_tail = {}; + + + − + − + − + − + − + + + − + − + − + − + − if i == #z.message_tail then+ − table.insert (render, error_comment( v[1], v[2] ));+ − else + − table.insert (render, error_comment( v[1] .. "; ", v[2] ));+ − end + + + + + + + + + + − + − + − + − local maint = {}; -- here we assemble a maintenence message+ − + − table.insert (maint, ' ('); -- open the link text+ − table.insert (maint, make_wikilink (':Category:' .. v, 'link')); -- add the link+ − table.insert (maint, ')'); -- and close it+ − table.insert (maint_msgs, table.concat (maint)); -- assemble new maint message and add it to the maint_msgs table+ + + + + + + − + − + − -- no_tracking_cats = no_tracking_cats:lower(); − -- if in_array(no_tracking_cats, {"", "no", "false", "n"}) then − + − + − + − + − + − + − + 第3,623行：
第3,889行： − + + − + − if in_array (cite_class, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- limited parameter sets allowed for these templates − state = whitelist.limited_basic_arguments[name]; + + + + + + + + + + + + − + + + + + + − if true == state then return true; end -- valid actively supported parameter − if false == state then − deprecated_parameter (name); -- parameter is deprecated but still supported − return true; − end − name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) + − + − + − if false == state then − deprecated_parameter (name); -- parameter is deprecated but still supported − return true; − end + + + + + − + − + − if false == state then − deprecated_parameter (name); -- parameter is deprecated but still supported − return true; − end − name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits) + − + + − if true == state then return true; end -- valid actively supported parameter + − + − deprecated_parameter (name); -- parameter is deprecated but still supported + − return true; + + + + + + + + + + + + + + + + + + + − + − 第3,679行：
第3,971行： − + − + − + − + 第3,691行：
第3,983行： − + − + − table.insert( z.message_tail, {set_error ('missing_pipe',parameter)}); + 第3,707行：
第3,999行： + + + + + 第3,712行：
第4,009行： − add_maint_cat ('extra_punct'); -- has extraneous punctuation; add maint cat + + + + + + + + + + + + + + + + + + + + + 第3,724行：
第4,041行： − + + − + − + 第3,745行：
第4,063行： − − + − − dates = validation.dates; -- imported functions from Module:Citation/CS1/Date validation − year_date_check = validation.year_date_check; − reformat_dates = validation.reformat_dates; − date_hyphen_to_dash = validation.date_hyphen_to_dash; − date_name_xlate = validation.date_name_xlate; − − is_set = utilities.is_set; -- imported functions from Module:Citation/CS1/Utilities − in_array = utilities.in_array; − substitute = utilities.substitute; − error_comment = utilities.error_comment; − set_error = utilities.set_error; − select_one = utilities.select_one; − add_maint_cat = utilities.add_maint_cat; − wrap_style = utilities.wrap_style; − safe_for_italics = utilities.safe_for_italics; − is_wikilink = utilities.is_wikilink; − make_wikilink = utilities.make_wikilink; − strip_apostrophe_markup = utilities.strip_apostrophe_markup; − extract_ids = identifiers.extract_ids; -- imported functions from Module:Citation/CS1/Identifiers + − build_id_list = identifiers.build_id_list; − is_embargoed = identifiers.is_embargoed; − extract_id_access_levels = identifiers.extract_id_access_levels; − − make_coins_title = metadata.make_coins_title; -- imported functions from Module:Citation/CS1/COinS − get_coins_pages = metadata.get_coins_pages; − COinS = metadata.COinS; − + − + − + − + + + 第3,800行：
第4,093行： − error_text = "";+ − − -- Exclude empty numbered parameters − + − + − + − + 第3,817行：
第4,108行： − + − + − + − + − + − + − error_text, error_state = set_error( 'parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]}, true ); + − error_text, error_state = set_error( 'parameter_ignored', {k}, true ); + − if error_text ~= '' then − table.insert( z.message_tail, {error_text, error_state} ); − end − missing_pipe_check (k, v); -- do we think that there is a parameter that is missing a pipe? + − + − args[k] = v;+ − elseif args[k] ~= nil or (k == 'postscript') then -- here when v is empty string+ − args[k] = v; -- why do we do this? we don't support 'empty' parameters+ − + + + + + + + + + + + + + + + + − + − has_extraneous_punc (k, v); -- look for extraneous terminal punctuation in parameter values+ + + + + + + − + + + + + + +
无编辑摘要
require ('Module:No globals');
--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------
each of these counts against the Lua upvalue limit
]]
local z ={}; -- tables in Module:Citation/CS1/Utilities
local validation; -- functions in Module:Citation/CS1/Date_validation
local extract_ids, extract_id_access_levels, build_id_list, is_embargoed; -- functions in Module:Citation/CS1/Identifiers
local utilities; -- functions in Module:Citation/CS1/Utilities
local z ={}; -- table of tables in Module:Citation/CS1/Utilities
local make_coins_title, get_coins_pages, COinS; -- functions in Module:Citation/CS1/COinS
local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers
local metadata; -- functions in Module:Citation/CS1/COinS
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
local cfg = {}; -- table of configuration tables that are defined in Module:Citation/CS1/Configuration
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist
local whitelist = {}; -- table of tables listing valid template parameter names; defined in Module:Citation/CS1/Whitelist
--[[--------------------------< P A G E S C O P E V A R I A B L E S >--------------------------------------
--[[------------------< P A G E S C O P E V A R I A B L E S >---------------
declare variables here that have page-wide scope that are not brought in from
and used here
other modules; that are created here and used here
]]
]]
local added_deprecated_cat; -- boolean flag so that the category is added only once
local added_deprecated_cat; -- Boolean flag so that the category is added only once
local added_prop_cats = {}; -- list of property categories that have been added to z.properties_cats
local added_vanc_errs; -- Boolean flag so we only emit one Vancouver error / category
local added_vanc_errs; -- boolean flag so we only emit one Vancouver error / category
local added_generic_name_errs; -- Boolean flag so we only emit one generic name error / category and stop testing names once an error is encountered
local Frame; -- holds the module's frame table
local Frame; -- holds the module's frame table
local is_preview_mode; -- true when article is in preview mode; false when using 'Preview page with this template' (previewing the module)
local is_sandbox; -- true when using sandbox modules to render citation
local i = 1;
local i = 1;
while i <= count do -- loop through all items in list
while i <= count do -- loop through all items in list
if is_set( list[i] ) then
if utilities.is_set( list[i] ) then
return list[i]; -- return the first set list member
return list[i]; -- return the first set list member
end
end
i = i + 1; -- point to next
i = i + 1; -- point to next
end
end
end
end
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
To prevent duplication, added_vanc_errs is nil until an error message is emitted.
added_vanc_errs is a boolean declared in page scope variables above
added_vanc_errs is a Boolean declared in page scope variables above
]]
]]
local function add_vanc_error (source)
local function add_vanc_error (source, position)
if not added_vanc_errs then
if added_vanc_errs then return end
added_vanc_errs = true; -- note that we've added this category
added_vanc_errs = true; -- note that we've added this category
utilities.set_message ('err_vancouver', {source, position});
end
end
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
--[[--------------------------< I S _ S C H E M E >------------------------------------------------------------
does this thing that purports to be a uri scheme seem to be a valid scheme? The scheme is checked to see if it
does this thing that purports to be a URI scheme seem to be a valid scheme? The scheme is checked to see if it
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
is in agreement with http://tools.ietf.org/html/std66#section-3.1 which says:
Scheme names consist of a sequence of characters beginning with a
Scheme names consist of a sequence of characters beginning with a
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
Single character names are generally reserved; see https://tools.ietf.org/html/draft-ietf-dnsind-iana-dns-01#page-15;
see also [[Single-letter second-level domain]]
see also [[Single-letter second-level domain]]
list of tlds: https://www.iana.org/domains/root/db
list of TLDs: https://www.iana.org/domains/root/db
RFC 952 (modified by RFC 1123) requires the first and last character of a hostname to be a letter or a digit. Between
the first and last characters the name may use letters, digits, and the hyphen.
the first and last characters the name may use letters, digits, and the hyphen.
Also allowed are IPv4 addresses. IPv6 not supported
Also allowed are IPv4 addresses. IPv6 not supported
domain is expected to be stripped of any path so that the last character in the last character of the tld. tld
domain is expected to be stripped of any path so that the last character in the last character of the TLD. tld
is two or more alpha characters. Any preceding '//' (from splitting a url with a scheme) will be stripped
is two or more alpha characters. Any preceding '//' (from splitting a URL with a scheme) will be stripped
here. Perhaps not necessary but retained incase it is necessary for IPv4 dot decimal.
here. Perhaps not necessary but retained in case it is necessary for IPv4 dot decimal.
There are several tests:
There are several tests:
the first character of the whole domain name including subdomains must be a letter or a digit
the first character of the whole domain name including subdomains must be a letter or a digit
internationalized domain name (ascii characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the tld) see https://tools.ietf.org/html/rfc3490
internationalized domain name (ASCII characters with .xn-- ASCII Compatible Encoding (ACE) prefix xn-- in the TLD) see https://tools.ietf.org/html/rfc3490
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
single-letter/digit second-level domains in the .org, .cash, and .today TLDs
q, x, and z SL domains in the .com TLD
q, x, and z SL domains in the .com TLD
IPv4 dot-decimal address format; TLD not allowed
IPv4 dot-decimal address format; TLD not allowed
returns true if domain appears to be a proper name and tld or IPv4 address, else false
returns true if domain appears to be a proper name and TLD or IPv4 address, else false
]=]
]=]
end
end
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at wikisource
if domain:match ('^%a+:') then -- hack to detect things that look like s:Page:Title where Page: is namespace at Wikisource
return false;
return false;
end
end
local patterns = { -- patterns that look like urls
local patterns = { -- patterns that look like URLs
'%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
'%f[%w][%w][%w%-]+[%w]%.%a%a+$', -- three or more character hostname.hostname or hostname.tld
'%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
'%f[%w][%w][%w%-]+[%w]%.xn%-%-[%w]+$', -- internationalized domain name with ACE prefix
'%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
'%f[%a][qxz]%.com$', -- assigned one character .com hostname (x.com times out 2015-12-10)
'%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
'%f[%a][iq]%.net$', -- assigned one character .net hostname (q.net registered but not active 2015-12-10)
'%f[%w][%w]%.%a%a$', -- one character hostname and cctld (2 chars)
'%f[%w][%w]%.%a%a$', -- one character hostname and ccTLD (2 chars)
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and tld
'%f[%w][%w][%w]%.%a%a+$', -- two character hostname and TLD
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
'^%d%d?%d?%.%d%d?%d?%.%d%d?%d?%.%d%d?%d?', -- IPv4 address
}
}
for _, pattern in ipairs (patterns) do -- loop through the patterns list
for _, pattern in ipairs (patterns) do -- loop through the patterns list
if domain:match (pattern) then
if domain:match (pattern) then
return true; -- if a match then we think that this thing that purports to be a url is a url
return true; -- if a match then we think that this thing that purports to be a URL is a URL
end
end
end
end
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
--[[--------------------------< I S _ U R L >------------------------------------------------------------------
returns true if the scheme and domain parts of a url appear to be a valid url; else false.
returns true if the scheme and domain parts of a URL appear to be a valid URL; else false.
This function is the last step in the validation process. This function is separate because there are cases that
This function is the last step in the validation process. This function is separate because there are cases that
local function is_url (scheme, domain)
local function is_url (scheme, domain)
if is_set (scheme) then -- if scheme is set check it and domain
if utilities.is_set (scheme) then -- if scheme is set check it and domain
return is_scheme (scheme) and is_domain_name (domain);
return is_scheme (scheme) and is_domain_name (domain);
else
else
return is_domain_name (domain); -- scheme not set when url is protocol relative
return is_domain_name (domain); -- scheme not set when URL is protocol-relative
end
end
end
end
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
--[[--------------------------< S P L I T _ U R L >------------------------------------------------------------
Split a url into a scheme, authority indicator, and domain.
Split a URL into a scheme, authority indicator, and domain.
First remove Fully Qualified Domain Name terminator (a dot following tld) (if any) and any path(/), query(?) or fragment(#).
First remove Fully Qualified Domain Name terminator (a dot following TLD) (if any) and any path(/), query(?) or fragment(#).
If protocol relative url, return nil scheme and domain else return nil for both scheme and domain.
If protocol-relative URL, return nil scheme and domain else return nil for both scheme and domain.
When not protocol relative, get scheme, authority indicator, and domain. If there is an authority indicator (one
When not protocol-relative, get scheme, authority indicator, and domain. If there is an authority indicator (one
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.
or more '/' characters immediately following the scheme's colon), make sure that there are only 2.
Any URL that does not have news: scheme must have authority indicator (//). TODO: are there other common schemes
like news: that don't use authority indicator?
Strip off any port and path;
Strip off any port and path;
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
url_str = url_str:gsub ('([%a%d])%.?[/%?#].*$', '%1'); -- strip FQDN terminator and path(/), query(?), fragment (#) (the capture prevents false replacement of '//')
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol relative url
if url_str:match ('^//%S*') then -- if there is what appears to be a protocol-relative URL
domain = url_str:match ('^//(%S*)')
domain = url_str:match ('^//(%S*)')
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name
elseif url_str:match ('%S-:/*%S+') then -- if there is what appears to be a scheme, optional authority indicator, and domain name
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
scheme, authority, domain = url_str:match ('(%S-:)(/*)(%S+)'); -- extract the scheme, authority indicator, and domain portions
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
if utilities.is_set (authority) then
authority = authority:gsub ('//', '', 1); -- replace place 1 pair of '/' with nothing;
return scheme; -- return scheme only making domain nil which will cause an error message
if utilities.is_set(authority) then -- if anything left (1 or 3+ '/' where authority should be) then
return scheme; -- return scheme only making domain nil which will cause an error message
end
else
if not scheme:match ('^news:') then -- except for news:..., MediaWiki won't link URLs that do not have authority indicator; TODO: a better way to do this test?
return scheme; -- return scheme only making domain nil which will cause an error message
end
end
end
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
domain = domain:gsub ('(%a):%d+', '%1'); -- strip port number if present
--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------
--[[--------------------------< L I N K _ P A R A M _ O K >---------------------------------------------------
checks the content of |title-link=, |series-link=, |author-link= etc for properly formatted content: no wikilinks, no urls
checks the content of |title-link=, |series-link=, |author-link=, etc. for properly formatted content: no wikilinks, no URLs
Link parameters are to hold the title of a wikipedia article so none of the WP:TITLESPECIALCHARACTERS are allowed:
Link parameters are to hold the title of a Wikipedia article, so none of the WP:TITLESPECIALCHARACTERS are allowed:
# < > [ ] | { } _
# < > [ ] | { } _
except the underscore which is used as a space in wiki urls and # which is used for section links
except the underscore which is used as a space in wiki URLs and # which is used for section links
returns false when the value contains any of these characters.
returns false when the value contains any of these characters.
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid url (the
When there are no illegal characters, this function returns TRUE if value DOES NOT appear to be a valid URL (the
|<param>-link= parameter is ok); else false when value appears to be a valid url (the |<param>-link= parameter is NOT ok).
|<param>-link= parameter is ok); else false when value appears to be a valid URL (the |<param>-link= parameter is NOT ok).
]]
]]
end
end
scheme, domain = split_url (value); -- get scheme or nil and domain or nil from url;
scheme, domain = split_url (value); -- get scheme or nil and domain or nil from URL;
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid url
return not is_url (scheme, domain); -- return true if value DOES NOT appear to be a valid URL
end
end
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.
Use link_param_ok() to validate |<param>-link= value and its matching |<title>= value.
|<title>= may be wikilinked but not when |<param>-link= has a value. This function emits an error message when
|<title>= may be wiki-linked but not when |<param>-link= has a value. This function emits an error message when
that condition exists
that condition exists
check <link> for inter-language interwiki-link prefix. prefix must be a MediaWiki-recognized language
code and must begin with a colon.
]]
]]
local function link_title_ok (link, lorig, title, torig)
local function link_title_ok (link, lorig, title, torig)
local orig;
local orig;
if utilities.is_set (link) then -- don't bother if <param>-link doesn't have a value
if is_set (link) then -- don't bother if <param>-link doesn't have a value
if not link_param_ok (link) then -- check |<param>-link= markup
if not link_param_ok (link) then -- check |<param>-link= markup
orig = lorig; -- identify the failing link parameter
orig = lorig; -- identify the failing link parameter
elseif title:find ('%[%[') then -- check |title= for wikilink markup
elseif title:find ('%[%[') then -- check |title= for wikilink markup
orig = torig; -- identify the failing |title= parameter
orig = torig; -- identify the failing |title= parameter
elseif link:match ('^%a+:') then -- if the link is what looks like an interwiki
local prefix = link:match ('^(%a+):'):lower(); -- get the interwiki prefix
if cfg.inter_wiki_map[prefix] then -- if prefix is in the map, must have preceding colon
orig = lorig; -- flag as error
end
end
end
end
end
if is_set (orig) then
if utilities.is_set (orig) then
link = ''; -- unset
utilities.set_message ('err_bad_paramlink', orig); -- URL or wikilink in |title= with |title-link=;
end
end
return link; -- link if ok, empty string else
end
end
Determines whether a URL string appears to be valid.
Determines whether a URL string appears to be valid.
First we test for space characters. If any are found, return false. Then split the url into scheme and domain
First we test for space characters. If any are found, return false. Then split the URL into scheme and domain
portions, or for protocol relative (//example.com) urls, just the domain. Use is_url() to validate the two
portions, or for protocol-relative (//example.com) URLs, just the domain. Use is_url() to validate the two
portions of the url. If both are valid, or for protocol relative if domain is valid, return true, else false.
portions of the URL. If both are valid, or for protocol-relative if domain is valid, return true, else false.
Because it is different from a standard url, and because this module used external_link() to make external links
Because it is different from a standard URL, and because this module used external_link() to make external links
that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name
that work for standard and news: links, we validate newsgroup names here. The specification for a newsgroup name
is at https://tools.ietf.org/html/rfc5536#section-3.1.4
is at https://tools.ietf.org/html/rfc5536#section-3.1.4
local function check_url( url_str )
local function check_url( url_str )
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper url
if nil == url_str:match ("^%S+$") then -- if there are any spaces in |url=value it can't be a proper URL
return false;
return false;
end
end
local scheme, domain;
local scheme, domain;
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from url;
scheme, domain = split_url (url_str); -- get scheme or nil and domain or nil from URL;
if 'news:' == scheme then -- special case for newsgroups
if 'news:' == scheme then -- special case for newsgroups
end
end
return is_url (scheme, domain); -- return true if value appears to be a valid url
return is_url (scheme, domain); -- return true if value appears to be a valid URL
end
end
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
Return true if a parameter value has a string that begins and ends with square brackets [ and ] and the first
non-space characters following the opening bracket appear to be a url. The test will also find external wikilinks
non-space characters following the opening bracket appear to be a URL. The test will also find external wikilinks
that use protocol relative urls. Also finds bare urls.
that use protocol-relative URLs. Also finds bare URLs.
The frontier pattern prevents a match on interwiki links which are similar to scheme:path urls. The tests that
The frontier pattern prevents a match on interwiki-links which are similar to scheme:path URLs. The tests that
find bracketed urls are required because the parameters that call this test (currently |title=, |chapter=, |work=,
find bracketed URLs are required because the parameters that call this test (currently |title=, |chapter=, |work=,
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
and |publisher=) may have wikilinks and there are articles or redirects like '//Hus' so, while uncommon, |title=[[//Hus]]
is possible as might be [[en://Hus]].
is possible as might be [[en://Hus]].
local scheme, domain;
local scheme, domain;
if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext wikilink with scheme and domain: [xxxx://yyyyy.zzz]
if value:match ('%f[%[]%[%a%S*:%S+.*%]') then -- if ext. wikilink with scheme and domain: [xxxx://yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
scheme, domain = split_url (value:match ('%f[%[]%[(%a%S*:%S+).*%]'));
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol relative ext wikilink: [//yyyyy.zzz]
elseif value:match ('%f[%[]%[//%S+.*%]') then -- if protocol-relative ext. wikilink: [//yyyyy.zzz]
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
scheme, domain = split_url (value:match ('%f[%[]%[(//%S+).*%]'));
elseif value:match ('%a%S*:%S+') then -- if bare url with scheme; may have leading or trailing plain text
elseif value:match ('%a%S*:%S+') then -- if bare URL with scheme; may have leading or trailing plain text
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
scheme, domain = split_url (value:match ('(%a%S*:%S+)'));
elseif value:match ('//%S+') then -- if protocol relative bare url: //yyyyy.zzz; may have leading or trailing plain text
elseif value:match ('//%S+') then -- if protocol-relative bare URL: //yyyyy.zzz; may have leading or trailing plain text
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
return false; -- didn't find anything that is obviously a url
return false; -- didn't find anything that is obviously a URL
end
end
return is_url (scheme, domain); -- return true if value appears to be a valid url
return is_url (scheme, domain); -- return true if value appears to be a valid URL
end
end
]]
]]
local function check_for_url (parameter_list)
local function check_for_url (parameter_list, error_list)
for k, v in pairs (parameter_list) do -- for each parameter in the list
for k, v in pairs (parameter_list) do -- for each parameter in the list
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a url add an error message
if is_parameter_ext_wikilink (v) then -- look at the value; if there is a URL add an error message
table.insert (error_list, utilities.wrap_style ('parameter', k));
end
end
end
end
end
end
local function safe_for_url( str )
local function safe_for_url( str )
if str:match( "%[%[.-%]%]" ) ~= nil then
if str:match( "%[%[.-%]%]" ) ~= nil then
utilities.set_message ('err_wikilink_in_url', {});
end
end
]]
]]
local function external_link( URL, label, source, access)
local function external_link (URL, label, source, access)
local error_str = "";
local err_msg = '';
local domain;
local domain;
local path;
local path;
local base_url;
local base_url;
if not is_set( label ) then
if not utilities.is_set (label) then
label = URL;
label = URL;
if is_set( source ) then
if utilities.is_set (source) then
utilities.set_message ('err_bare_url_missing_title', {utilities.wrap_style ('parameter', source)});
else
else
error( cfg.messages["bare_url_no_origin"] );
error (cfg.messages["bare_url_no_origin"]);
end
end
end
end
if not check_url( URL ) then
if not check_url (URL) then
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)});
end
end
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the url into scheme plus domain and path
domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path
if path then -- if there is a path portion
if path then -- if there is a path portion
path = path:gsub ('[%[%]]', {['[']='%5b',[']']='%5d'}); -- replace '[' and ']' with their percent encoded values
path = path:gsub ('[%[%]]', {['['] = '%5b', [']'] = '%5d'}); -- replace '[' and ']' with their percent-encoded values
URL = table.concat ({domain, path}); -- and reassemble
URL = table.concat ({domain, path}); -- and reassemble
end
end
base_url = table.concat({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wikimarkup url
base_url = table.concat ({ "[", URL, " ", safe_for_url (label), "]" }); -- assemble a wiki-markup URL
if is_set (access) then -- access level (subscription, registration, limited)
if utilities.is_set (access) then -- access level (subscription, registration, limited)
base_url = substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
base_url = utilities.substitute (cfg.presentation['ext-link-access-signal'], {cfg.presentation[access].class, cfg.presentation[access].title, base_url}); -- add the appropriate icon
end
end
return table.concat ({base_url, error_str});
return base_url;
end
end
parameters in the citation.
parameters in the citation.
added_deprecated_cat is a boolean declared in page scope variables above
added_deprecated_cat is a Boolean declared in page scope variables above
]]
]]
if not added_deprecated_cat then
if not added_deprecated_cat then
added_deprecated_cat = true; -- note that we've added this category
added_deprecated_cat = true; -- note that we've added this category
utilities.set_message ('err_deprecated_params', {name}); -- add error message
end
end
end
end
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
--[=[-------------------------< K E R N _ Q U O T E S >--------------------------------------------------------
Apply kerning to open the space between the quote mark provided by the Module and a leading or trailing quote
Apply kerning to open the space between the quote mark provided by the module and a leading or trailing quote
mark contained in a |title= or |chapter= parameter's value.
mark contained in a |title= or |chapter= parameter's value.
"'Unkerned title with leading and trailing single quote marks'"
"'Unkerned title with leading and trailing single quote marks'"
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
" 'Kerned title with leading and trailing single quote marks' " (in real life the kerning isn't as wide as this example)
Double single quotes (italic or bold wikimarkup) are not kerned.
Double single quotes (italic or bold wiki-markup) are not kerned.
Replaces unicode quotemarks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
Replaces Unicode quote marks in plain text or in the label portion of a [[L|D]] style wikilink with typewriter
quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks.
quote marks regardless of the need for kerning. Unicode quote marks are not replaced in simple [[D]] wikilinks.
Call this function for chapter titles, for website titles, etc; not for book titles.
Call this function for chapter titles, for website titles, etc.; not for book titles.
]=]
]=]
local function kern_quotes (str)
local function kern_quotes (str)
local cap='';
local cap = '';
local wl_type, label, link;
local wl_type, label, link;
wl_type, label, link = is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
wl_type, label, link = utilities.is_wikilink (str); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks
str = substitute (cfg.presentation['kern-wl-both'], str);
str = utilities.substitute (cfg.presentation['kern-left'], str);
str = utilities.substitute (cfg.presentation['kern-right'], str);
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks
str = substitute (cfg.presentation['kern-wl-left'], str);
str = utilities.substitute (cfg.presentation['kern-left'], str);
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks
str = substitute (cfg.presentation['kern-wl-right'], str);
str = utilities.substitute (cfg.presentation['kern-right'], str);
end
end
else -- plain text or [[L|D]]; text in label variable
else -- plain text or [[L|D]]; text in label variable
label= mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label = mw.ustring.gsub (label, '[“”]', '\"'); -- replace “” (U+201C & U+201D) with " (typewriter double quote mark)
label= mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)
cap, cap2 = mw.ustring.match (label, "^([\"\'])([^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
cap = mw.ustring.match (label, "^([\"\'][^\'].+)"); -- match leading double or single quote but not doubled single quotes (italic markup)
if is_set (cap) then
if utilities.is_set (cap) then
label = substitute (cfg.presentation['kern-left'], {cap, cap2});
label = utilities.substitute (cfg.presentation['kern-left'], cap);
end
end
cap, cap2 = mw.ustring.match (label, "^(.+[^\'])([\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
cap = mw.ustring.match (label, "^(.+[^\'][\"\'])$") -- match trailing double or single quote but not doubled single quotes (italic markup)
if is_set (cap) then
if utilities.is_set (cap) then
label = substitute (cfg.presentation['kern-right'], {cap, cap2});
label = utilities.substitute (cfg.presentation['kern-right'], cap);
end
end
if 2 == wl_type then
if 2 == wl_type then
str = make_wikilink (link, label); -- reassemble the wikilink
str = utilities.make_wikilink (link, label); -- reassemble the wikilink
else
else
str = label;
str = label;
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
--[[--------------------------< F O R M A T _ S C R I P T _ V A L U E >----------------------------------------
|script-title= holds title parameters that are not written in Latin based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
|script-title= holds title parameters that are not written in Latin-based scripts: Chinese, Japanese, Arabic, Hebrew, etc. These scripts should
not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
not be italicized and may be written right-to-left. The value supplied by |script-title= is concatenated onto Title after Title has been wrapped
in italic markup.
in italic markup.
Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate rtl languages from the English left to right.
Regardless of language, all values provided by |script-title= are wrapped in <bdi>...</bdi> tags to isolate RTL languages from the English left to right.
|script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO639-1 language code and a colon:
|script-title= provides a unique feature. The value in |script-title= may be prefixed with a two-character ISO 639-1 language code and a colon:
|script-title=ja:*** *** (where * represents a Japanese character)
|script-title=ja:*** *** (where * represents a Japanese character)
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
Spaces between the two-character code and the colon and the colon and the first script character are allowed:
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
Spaces preceding the prefix are allowed: |script-title = ja:*** ***
The prefix is checked for validity. If it is a valid ISO639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
The prefix is checked for validity. If it is a valid ISO 639-1 language code, the lang attribute (lang="ja") is added to the <bdi> tag so that browsers can
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute
know the language the tag contains. This may help the browser render the script more correctly. If the prefix is invalid, the lang attribute
is not added. At this time there is no error message for this condition.
is not added. At this time there is no error message for this condition.
local lang=''; -- initialize to empty string
local lang=''; -- initialize to empty string
local name;
local name;
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
if script_value:match('^%l%l%l?%s*:') then -- if first 3 or 4 non-space characters are script language prefix
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script
if not is_set (lang) then
if not utilities.is_set (lang) then
utilities.set_message ('err_script_parameter', {script_param, 'missing title part'}); -- prefix without 'title'; add error message
return ''; -- script_value was just the prefix so return empty string
return ''; -- script_value was just the prefix so return empty string
end
end
-- if we get this far we have prefix and script
-- if we get this far we have prefix and script
name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
name = cfg.lang_code_remap[lang] or mw.language.fetchLanguageName( lang, cfg.this_wiki_code ); -- get language name so that we can use it to categorize
if is_set (name) then -- is prefix a proper ISO 639-1 language code?
if utilities.is_set (name) then -- is prefix a proper ISO 639-1 language code?
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script
-- is prefix one of these language codes?
-- is prefix one of these language codes?
if in_array (lang, cfg.script_lang_codes) then
if utilities.in_array (lang, cfg.script_lang_codes) then
add_prop_cat ('script_with_name', {name, lang})
utilities.add_prop_cat ('script', {name, lang})
else
else
utilities.set_message ('err_script_parameter', {script_param, 'unknown language code'}); -- unknown script-language; add error message
end
end
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute
else
else
utilities.set_message ('err_script_parameter', {script_param, 'invalid language code'}); -- invalid language code; add error message
lang = ''; -- invalid so set lang to empty string
lang = ''; -- invalid so set lang to empty string
end
end
else
else
utilities.set_message ('err_script_parameter', {script_param, 'missing prefix'}); -- no language code prefix; add error message
end
end
script_value = substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is rtl
script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL
return script_value;
return script_value;
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script value has been
Initially for |title= and |script-title=, this function concatenates those two parameter values after the script
wrapped in <bdi> tags.
value has been wrapped in <bdi> tags.
]]
]]
local function script_concatenate (title, script, script_param)
local function script_concatenate (title, script, script_param)
if is_set (script) then
if utilities.is_set (script) then
script = format_script_value (script, script_param); -- <bdi> tags, lang atribute, categorization, etc; returns empty string on error
script = format_script_value (script, script_param); -- <bdi> tags, lang attribute, categorization, etc.; returns empty string on error
if is_set (script) then
if utilities.is_set (script) then
title = title .. ' ' .. script; -- concatenate title and script title
title = title .. ' ' .. script; -- concatenate title and script title
end
end
local function wrap_msg (key, str, lower)
local function wrap_msg (key, str, lower)
if not is_set( str ) then
if not utilities.is_set ( str ) then
return "";
return "";
end
end
local msg;
local msg;
msg = cfg.messages[key]:lower(); -- set the message to lower case before
msg = cfg.messages[key]:lower(); -- set the message to lower case before
return substitute( msg, str ); -- including template text
return utilities.substitute ( msg, str ); -- including template text
else
else
return substitute( cfg.messages[key], str );
return utilities.substitute ( cfg.messages[key], str );
end
end
end
end
--[[--------------------------< W I K I S O U R C E _ U R L _ M A K E >----------------------------------------
--[[----------------< W I K I S O U R C E _ U R L _ M A K E >-------------------
Makes a Wikisource URL from Wikisource interwiki-link. Returns the URL and appropriate
label; nil else.
str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
str is the value assigned to |chapter= (or aliases) or |title= or |title-link=
local wl_type, D, L;
local wl_type, D, L;
local ws_url, ws_label;
local ws_url, ws_label;
local wikisource_prefix = table.concat ({'https://', cfg.this_wiki_code, '.wikisource.org/wiki/'});
wl_type, D, L = is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
wl_type, D, L = utilities.is_wikilink (str); -- wl_type is 0 (not a wikilink), 1 (simple wikilink), 2 (complex wikilink)
if 0 == wl_type then -- not a wikilink; might be from |title-link=
if 0 == wl_type then -- not a wikilink; might be from |title-link=
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if is_set (str) then
if utilities.is_set (str) then
ws_url = table.concat ({ -- build a wikisource url
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title
str, -- article title
});
});
ws_label = str; -- label for the url
ws_label = str; -- label for the URL
end
end
elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]]
elseif 1 == wl_type then -- simple wikilink: [[Wikisource:ws article]]
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
str = D:match ('^[Ww]ikisource:(.+)') or D:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if is_set (str) then
if utilities.is_set (str) then
ws_url = table.concat ({ -- build a wikisource url
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title
str, -- article title
});
});
ws_label = str; -- label for the url
ws_label = str; -- label for the URL
end
end
elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]])
elseif 2 == wl_type then -- non-so-simple wikilink: [[Wikisource:ws article|displayed text]] ([[L|D]])
str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
str = L:match ('^[Ww]ikisource:(.+)') or L:match ('^[Ss]:(.+)'); -- article title from interwiki link with long-form or short-form namespace
if is_set (str) then
if utilities.is_set (str) then
ws_label = D; -- get ws article name from display portion of interwiki link
ws_label = D; -- get ws article name from display portion of interwiki link
ws_url = table.concat ({ -- build a wikisource url
ws_url = table.concat ({ -- build a Wikisource URL
wikisource_prefix, -- prefix
str, -- article title without namespace from link portion of wikilink
str, -- article title without namespace from link portion of wikilink
});
});
end
end
end
end
if ws_url then
if ws_url then
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable url
ws_url = mw.uri.encode (ws_url, 'WIKI'); -- make a usable URL
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent encoding of anchor
ws_url = ws_url:gsub ('%%23', '#'); -- undo percent-encoding of fragment marker
end
end
return ws_url, ws_label, L or D; -- return proper url or nil and a label or nil
return ws_url, ws_label, L or D; -- return proper URL or nil and a label or nil
end
end
--[[--------------------------< F O R M A T _ P E R I O D I C A L >--------------------------------------------
--[[----------------< F O R M A T _ P E R I O D I C A L >-----------------------
Format the four periodical parameters: |script-<periodical>=, |<periodical>=, and |trans-<periodical>= into a single Periodical meta-
Format the three periodical parameters: |script-<periodical>=, |<periodical>=,
parameter.
and |trans-<periodical>= into a single Periodical meta-parameter.
]]
]]
local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)
if not is_set (periodical) then
if not utilities.is_set (periodical) then
periodical = ''; -- to be safe for concatenation
periodical = ''; -- to be safe for concatenation
else
else
periodical = wrap_style ('italic-title', periodical); -- style
periodical = utilities.wrap_style ('italic-title', periodical); -- style
end
end
periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
periodical = script_concatenate (periodical, script_periodical, script_periodical_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
if is_set (trans_periodical) then
if utilities.is_set (trans_periodical) then
trans_periodical = wrap_style ('trans-italic-title', trans_periodical);
trans_periodical = utilities.wrap_style ('trans-italic-title', trans_periodical);
if is_set (periodical) then
if utilities.is_set (periodical) then
periodical = periodical .. ' ' .. trans_periodical;
periodical = periodical .. ' ' .. trans_periodical;
else -- here when transchapter without chapter or script-chapter
else -- here when trans-periodical without periodical or script-periodical
periodical = trans_periodical;
periodical = trans_periodical;
utilities.set_message ('err_trans_missing_title', {'periodical'});
end
end
end
end
return periodical .. periodical_error;
return periodical;
end
end
--[[--------------------------< F O R M A T _ C H A P T E R _ T I T L E >--------------------------------------
--[[------------------< F O R M A T _ C H A P T E R _ T I T L E >---------------
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=, and |chapter-url= into a single Chapter meta-
Format the four chapter parameters: |script-chapter=, |chapter=, |trans-chapter=,
parameter (chapter_url_source used for error messages).
and |chapter-url= into a single chapter meta- parameter (chapter_url_source used
for error messages).
]]
]]
local function format_chapter_title (scriptchapter, script_chapter_source, chapter, transchapter, chapterurl, chapter_url_source, no_quotes, access)
local function format_chapter_title (script_chapter, script_chapter_source, chapter, chapter_source, trans_chapter, trans_chapter_source, chapter_url, chapter_url_source, no_quotes, access)
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource URL and label from a wikisource interwiki link
local ws_url, ws_label, L = wikisource_url_make (chapter); -- make a wikisource url and label from a wikisource interwiki link
if ws_url then
if ws_url then
ws_label = ws_label:gsub ('_', ''); -- replace underscore separaters with space characters
ws_label = ws_label:gsub ('_', ' '); -- replace underscore separators with space characters
chapter = ws_label;
chapter = ws_label;
end
end
if not is_set (chapter) then
if not utilities.is_set (chapter) then
chapter = ''; -- to be safe for concatenation
chapter = ''; -- to be safe for concatenation
else
else
if false == no_quotes then
if false == no_quotes then
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from Module provided quote marks
chapter = kern_quotes (chapter); -- if necessary, separate chapter title's leading and trailing quote marks from module provided quote marks
chapter = wrap_style ('quoted-title', chapter);
chapter = utilities.wrap_style ('quoted-title', chapter);
end
end
end
end
chapter = script_concatenate (chapter, scriptchapter, script_chapter_source); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
chapter = script_concatenate (chapter, script_chapter, script_chapter_source); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
if is_set (chapterurl) then
if utilities.is_set (chapter_url) then
chapter = external_link (chapterurl, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
chapter = external_link (chapter_url, chapter, chapter_url_source, access); -- adds bare_url_missing_title error if appropriate
elseif ws_url then
elseif ws_url then
chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this?
chapter = external_link (ws_url, chapter .. ' ', 'ws link in chapter'); -- adds bare_url_missing_title error if appropriate; space char to move icon away from chap text; TODO: better way to do this?
chapter = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
chapter = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, chapter});
end
end
if is_set (transchapter) then
if utilities.is_set (trans_chapter) then
trans_chapter = utilities.wrap_style ('trans-quoted-title', trans_chapter);
if is_set (chapter) then
if utilities.is_set (chapter) then
chapter = chapter .. ' ' .. transchapter;
chapter = chapter .. ' ' .. trans_chapter;
else -- here when transchapter without chapter or script-chapter
else -- here when trans_chapter without chapter or script-chapter
chapter = transchapter;
chapter = trans_chapter;
chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>
utilities.set_message ('err_trans_missing_title', {chapter_source});
end
end
end
end
return chapter;
return chapter .. chapter_error;
end
end
--[[--------------------------< H A S _ I N V I S I B L E _ C H A R S >----------------------------------------
--[[----------------< H A S _ I N V I S I B L E _ C H A R S >-------------------
This function searches a parameter's value for nonprintable or invisible characters. The search stops at the
This function searches a parameter's value for non-printable or invisible characters.
first match.
The search stops at the first match.
This function will detect the visible replacement character when it is part of the wikisource.
This function will detect the visible replacement character when it is part of the Wikisource.
Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers (gallery, math, pre, ref)
Detects but ignores nowiki and math stripmarkers. Also detects other named stripmarkers
and identifies them with a slightly different error message. See also coins_cleanup().
(gallery, math, pre, ref) and identifies them with a slightly different error message.
See also coins_cleanup().
Output of this function is an error message that identifies the character or the Unicode group, or the stripmarker
Output of this function is an error message that identifies the character or the
that was detected along with its position (or, for multi-byte characters, the position of its first byte) in the
Unicode group, or the stripmarker that was detected along with its position (or,
parameter value.
for multi-byte characters, the position of its first byte) in the parameter value.
]]
]]
local function has_invisible_chars (param, v)
local function has_invisible_chars (param, v)
local position = ''; -- position of invisible char or starting position of stripmarker
local position = ''; -- position of invisible char or starting position of stripmarker
local capture; -- used by stripmarker detection to hold name of the stripmarker
local capture; -- used by stripmarker detection to hold name of the stripmarker
local i=1;
local stripmarker; -- boolean set true when a stripmarker is found
capture = string.match (v, '[%w%p ]*'); -- test for values that are simple ASCII text and bypass other tests if true
capture = string.match (v, '[%w%p ]*'); -- Test for values that are simple ASCII text and bypass other tests if true
if capture == v then -- if same there are no Unicode characters
if capture == v then -- if same there are no unicode characters
return;
return;
end
end
for _, invisible_char in ipairs (cfg.invisible_chars) do
local char=cfg.invisible_chars[i][1] -- the character or group name
local char_name = invisible_char[1]; -- the character or group name
local pattern=cfg.invisible_chars[i][2] -- the pattern used to find it
local pattern = invisible_char[2]; -- the pattern used to find it
position, dummy, capture = mw.ustring.find (v, pattern) -- see if the parameter value contains characters that match the pattern
position, _, capture = mw.ustring.find (v, pattern); -- see if the parameter value contains characters that match the pattern
if position and (char == 'zero width joiner') then -- if we found a zero width joiner character
if position and (cfg.invisible_defs.zwj == capture) then -- if we found a zero-width joiner character
if mw.ustring.find (v, cfg.indic_script) then -- its ok if one of the indic scripts
if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts
position = nil; -- unset position
elseif cfg.emoji[mw.ustring.codepoint (v, position+1)] then -- is zwj followed by a character listed in emoji{}?
position = nil; -- unset position
position = nil; -- unset position
end
end
if position then
if position then
if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition)
if 'nowiki' == capture or 'math' == capture or -- nowiki and math stripmarkers (not an error condition)
('templatestyles' == capture and in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters
('templatestyles' == capture and utilities.in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters
stripmarker = true; -- set a flag
stripmarker = true; -- set a flag
elseif true == stripmarker and 'delete' == char then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
elseif true == stripmarker and cfg.invisible_defs.del == capture then -- because stripmakers begin and end with the delete char, assume that we've found one end of a stripmarker
position = nil; -- unset
position = nil; -- unset
else
else
local err_msg;
local err_msg;
if capture then
if capture and not (cfg.invisible_defs.del == capture or cfg.invisible_defs.zwj == capture) then
err_msg = capture .. ' ' .. char;
err_msg = capture .. ' ' .. char_name;
else
else
err_msg = char .. ' ' .. 'character';
err_msg = char_name .. ' ' .. 'character';
end
end
utilities.set_message ('err_invisible_char', {err_msg, utilities.wrap_style ('parameter', param), position}); -- add error message
return; -- and done with this parameter
return; -- and done with this parameter
end
end
end
end
end
end
end
end
--[[--------------------------< A R G U M E N T _ W R A P P E R >----------------------------------------------
--[[-------------------< A R G U M E N T _ W R A P P E R >----------------------
Argument wrapper. This function provides support for argument mapping defined in the configuration file so that
Argument wrapper. This function provides support for argument mapping defined
multiple names can be transparently aliased to single internal variable.
in the configuration file so that multiple names can be transparently aliased to
single internal variable.
]]
]]
local function argument_wrapper( args )
local function argument_wrapper ( args )
local origin = {};
local origin = {};
return setmetatable({
return setmetatable({
ORIGIN = function( self, k )
ORIGIN = function ( self, k )
local dummy = self[k]; --force the variable to be loaded.
local dummy = self[k]; -- force the variable to be loaded.
return origin[k];
return origin[k];
end
end
if type( list ) == 'table' then
if type( list ) == 'table' then
v, origin[k] = select_one( args, list, 'redundant_parameters' );
v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' );
if origin[k] == nil then
if origin[k] == nil then
origin[k] = ''; -- Empty string, not nil
origin[k] = ''; -- Empty string, not nil
end
end
elseif list ~= nil then
elseif list ~= nil then
-- Empty strings, not nil;
-- Empty strings, not nil;
if v == nil then
if v == nil then
v = cfg.defaults[k] or '';
v = '';
origin[k] = '';
origin[k] = '';
end
end
--[[--------------------------< N O W R A P _ D A T E >--------------------------------------------------------
--[[--------------------------< N O W R A P _ D A T E >-------------------------
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>. When date is DD MMMM YYYY or is
When date is YYYY-MM-DD format wrap in nowrap span: <span ...>YYYY-MM-DD</span>.
MMMM DD, YYYY then wrap in nowrap span: <span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
When date is DD MMMM YYYY or is MMMM DD, YYYY then wrap in nowrap span:
<span ...>DD MMMM</span> YYYY or <span ...>MMMM DD,</span> YYYY
DOES NOT yet support MMMM YYYY or any of the date ranges.
DOES NOT yet support MMMM YYYY or any of the date ranges.
local function nowrap_date (date)
local function nowrap_date (date)
local cap='';
local cap = '';
local cap2='';
local cap2 = '';
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
if date:match("^%d%d%d%d%-%d%d%-%d%d$") then
date = substitute (cfg.presentation['nowrap1'], date);
date = utilities.substitute (cfg.presentation['nowrap1'], date);
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
elseif date:match("^%a+%s*%d%d?,%s+%d%d%d%d$") or date:match ("^%d%d?%s*%a+%s+%d%d%d%d$") then
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
cap, cap2 = string.match (date, "^(.*)%s+(%d%d%d%d)$");
date = substitute (cfg.presentation['nowrap2'], {cap, cap2});
date = utilities.substitute (cfg.presentation['nowrap2'], {cap, cap2});
end
end
--[[--------------------------< S E T _ T I T L E T Y P E >----------------------------------------------------
--[[--------------------------< S E T _ T I T L E T Y P E >---------------------
This function sets default title types (equivalent to the citation including |type=<default value>) for those templates that have defaults.
This function sets default title types (equivalent to the citation including
Also handles the special case where it is desirable to omit the title type from the rendered citation (|type=none).
|type=<default value>) for those templates that have defaults. Also handles the
special case where it is desirable to omit the title type from the rendered citation
(|type=none).
]]
]]
local function set_titletype (cite_class, title_type)
local function set_titletype (cite_class, title_type)
if is_set(title_type) then
if utilities.is_set (title_type) then
if "none" == title_type then
if 'none' == cfg.keywords_xlate[title_type] then
title_type = ""; -- if |type=none then type parameter not displayed
title_type = ''; -- if |type=none then type parameter not displayed
end
end
return title_type; -- if |type= has been set to any other value use that value
return title_type; -- if |type= has been set to any other value use that value
--[[--------------------------< S A F E _ J O I N >-----------------------------
--[[--------------------------< S A F E _ J O I N >------------------------------------------------------------
Joins a sequence of strings together while checking for duplicate separation characters.
Joins a sequence of strings together while checking for duplicate separation characters.
local function safe_join( tbl, duplicate_char )
local function safe_join( tbl, duplicate_char )
local f = {}; -- create a function table appropriate to type of 'dupicate character'
local f = {}; -- create a function table appropriate to type of 'duplicate character'
if 1 == #duplicate_char then -- for single byte ascii characters use the string library functions
if 1 == #duplicate_char then -- for single byte ASCII characters use the string library functions
f.gsub=string.gsub
f.gsub = string.gsub
f.match=string.match
f.match = string.match
f.sub=string.sub
f.sub = string.sub
else -- for multi-byte characters use the ustring library functions
else -- for multi-byte characters use the ustring library functions
f.gsub=mw.ustring.gsub
f.gsub = mw.ustring.gsub
f.match=mw.ustring.match
f.match = mw.ustring.match
f.sub=mw.ustring.sub
f.sub = mw.ustring.sub
end
end
str = value; -- assign value to it (first time through the loop)
str = value; -- assign value to it (first time through the loop)
elseif value ~= '' then
elseif value ~= '' then
if value:sub(1,1) == '<' then -- Special case of values enclosed in spans and other markup.
if value:sub(1, 1) == '<' then -- special case of values enclosed in spans and other markup.
comp = value:gsub( "%b<>", "" ); -- remove html markup (<span>string</span> -> string)
comp = value:gsub( "%b<>", "" ); -- remove HTML markup (<span>string</span> -> string)
else
else
comp = value;
comp = value;
end
end
-- typically duplicate_char is sepc
-- typically duplicate_char is sepc
if f.sub(comp, 1,1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
if f.sub(comp, 1, 1) == duplicate_char then -- is first character same as duplicate_char? why test first character?
-- Because individual string segments often (always?) begin with terminal punct for the
-- Because individual string segments often (always?) begin with terminal punct for the
-- preceding segment: 'First element' .. 'sepc next element' .. etc?
-- preceding segment: 'First element' .. 'sepc next element' .. etc.?
trim = false;
trim = false;
end_chr = f.sub(str, -1,-1); -- get the last character of the output string
end_chr = f.sub(str, -1, -1); -- get the last character of the output string
-- str = str .. "<HERE(enchr=" .. end_chr.. ")" -- debug stuff?
-- str = str .. "<HERE(enchr=" .. end_chr .. ")" -- debug stuff?
if end_chr == duplicate_char then -- if same as separator
if end_chr == duplicate_char then -- if same as separator
str = f.sub(str, 1,-2); -- remove it
str = f.sub(str, 1, -2); -- remove it
elseif end_chr == "'" then -- if it might be wikimarkup
elseif end_chr == "'" then -- if it might be wiki-markup
if f.sub(str, -3,-1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
if f.sub(str, -3, -1) == duplicate_char .. "''" then -- if last three chars of str are sepc''
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
str = f.sub(str, 1, -4) .. "''"; -- remove them and add back ''
elseif f.sub(str, -5,-1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
elseif f.sub(str, -5, -1) == duplicate_char .. "]]''" then -- if last five chars of str are sepc]]''
trim = true; -- why? why do this and next differently from previous?
trim = true; -- why? why do this and next differently from previous?
elseif f.sub(str, -4,-1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
elseif f.sub(str, -4, -1) == duplicate_char .. "]''" then -- if last four chars of str are sepc]''
trim = true; -- same question
trim = true; -- same question
end
end
elseif end_chr == "]" then -- if it might be wikimarkup
elseif end_chr == "]" then -- if it might be wiki-markup
if f.sub(str, -3,-1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
if f.sub(str, -3, -1) == duplicate_char .. "]]" then -- if last three chars of str are sepc]] wikilink
trim = true;
trim = true;
elseif f.sub(str, -3,-1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
elseif f.sub(str, -3, -1) == duplicate_char .. '"]' then -- if last three chars of str are sepc"] quoted external link
trim = true;
trim = true;
elseif f.sub(str, -2,-1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
elseif f.sub(str, -2, -1) == duplicate_char .. "]" then -- if last two chars of str are sepc] external link
trim = true;
trim = true;
elseif f.sub(str, -4,-1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.
trim = true;
trim = true;
end
end
elseif end_chr == " " then -- if last char of output string is a space
elseif end_chr == " " then -- if last char of output string is a space
if f.sub(str, -2,-1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
if f.sub(str, -2, -1) == duplicate_char .. " " then -- if last two chars of str are <sepc><space>
str = f.sub(str, 1,-3); -- remove them both
str = f.sub(str, 1, -3); -- remove them both
end
end
end
end
if trim then
if trim then
if value ~= comp then -- value does not equal comp when value contains html markup
if value ~= comp then -- value does not equal comp when value contains HTML markup
local dup2 = duplicate_char;
local dup2 = duplicate_char;
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
if f.match(dup2, "%A" ) then dup2 = "%" .. dup2; end -- if duplicate_char not a letter then escape it
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows html markup
value = f.gsub(value, "(%b<>)" .. dup2, "%1", 1 ) -- remove duplicate_char if it follows HTML markup
else
else
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character
value = f.sub(value, 2, -1 ); -- remove duplicate_char when it is first character
end
end
end
end
str = str .. value; --add it to the output string
str = str .. value; -- add it to the output string
end
end
end
end
--[[--------------------------< I S _ S U F F I X >------------------------------------------------------------
--[[--------------------------< I S _ S U F F I X >-----------------------------
returns true is suffix is properly formed Jr, Sr, or ordinal in the range 2–9. Puncutation not allowed.
returns true if suffix is properly formed Jr, Sr, or ordinal in the range 1–9.
Puncutation not allowed.
]]
]]
local function is_suffix (suffix)
local function is_suffix (suffix)
if in_array (suffix, {'Jr', 'Sr', '2nd', '3rd'}) or suffix:match ('^%dth$') then
if utilities.in_array (suffix, {'Jr', 'Sr', 'Jnr', 'Snr', '1st', '2nd', '3rd'}) or suffix:match ('^%dth$') then
return true;
return true;
end
end
--[[--------------------------< I S _ G O O D _ V A N C _ N A M E >--------------------------------------------
--[[--------------------< I S _ G O O D _ V A N C _ N A M E >-------------------
For Vancouver Style, author/editor names are supposed to be rendered in Latin (read ASCII) characters. When a name
For Vancouver style, author/editor names are supposed to be rendered in Latin
uses characters that contain diacritical marks, those characters are to converted to the corresponding Latin character.
(read ASCII) characters. When a name uses characters that contain diacritical
When a name is written using a non-Latin alphabet or logogram, that name is to be transliterated into Latin characters.
marks, those characters are to be converted to the corresponding Latin
character. When a name is written using a non-Latin alphabet or logogram, that
name is to be transliterated into Latin characters. The module doesn't do this
so editors may/must.
This test allows |first= and |last= names to contain any of the letters defined in the four Unicode Latin character sets
This test allows |first= and |last= names to contain any of the letters defined
in the four Unicode Latin character sets
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
[http://www.unicode.org/charts/PDF/U0000.pdf C0 Controls and Basic Latin] 0041–005A, 0061–007A
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
[http://www.unicode.org/charts/PDF/U0080.pdf C1 Controls and Latin-1 Supplement] 00C0–00D6, 00D8–00F6, 00F8–00FF
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
[http://www.unicode.org/charts/PDF/U0180.pdf Latin Extended-B] 0180–01BF, 01C4–024F
|lastn= also allowed to contain hyphens, spaces, and apostrophes. (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|lastn= also allowed to contain hyphens, spaces, and apostrophes.
(http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
|firstn= also allowed to contain hyphens, spaces, apostrophes, and periods
This original test:
This original test:
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$") or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
if nil == mw.ustring.find (last, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%']*$")
was written ouside of the code editor and pasted here because the code editor gets confused between character insertion point and cursor position.
or nil == mw.ustring.find (first, "^[A-Za-zÀ-ÖØ-öø-ƿDŽ-ɏ%-%s%'%.]+[2-6%a]*$") then
The test has been rewritten to use decimal character escape sequence for the individual bytes of the unicode characters so that it is not necessary
was written outside of the code editor and pasted here because the code editor
to use an external editor to maintain this code.
gets confused between character insertion point and cursor position. The test has
been rewritten to use decimal character escape sequence for the individual bytes
of the Unicode characters so that it is not necessary to use an external editor
to maintain this code.
\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
\195\128-\195\150 – À-Ö (U+00C0–U+00D6 – C0 controls)
]]
]]
local function is_good_vanc_name (last, first)
local function is_good_vanc_name (last, first, suffix, position)
if not suffix then
if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix
if is_set (suffix) then
first = first:match ('(.-)[,%s]+'); -- get name/initials
suffix = first:match ('[,%s]+(.+)$'); -- get generational suffix
end
end
if utilities.is_set (suffix) then
if not is_suffix (suffix) then
if not is_suffix (suffix) then
add_vanc_error ('suffix');
add_vanc_error (cfg.err_msg_supl.suffix, position);
return false; -- not a name with an appropriate suffix
return false; -- not a name with an appropriate suffix
end
end
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or
if nil == mw.ustring.find (last, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%']*$") or
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then
nil == mw.ustring.find (first, "^[A-Za-z\195\128-\195\150\195\152-\195\182\195\184-\198\191\199\132-\201\143%-%s%'%.]*$") then
add_vanc_error ('non-Latin character');
add_vanc_error (cfg.err_msg_supl['non-Latin char'], position);
return false; -- not a string of latin characters; Vancouver requires Romanization
return false; -- not a string of Latin characters; Vancouver requires Romanization
end;
end;
return true;
return true;
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
--[[--------------------------< R E D U C E _ T O _ I N I T I A L S >------------------------------------------
Attempts to convert names to initials in support of |name-list-format=vanc.
Attempts to convert names to initials in support of |name-list-style=vanc.
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
Names in |firstn= may be separated by spaces or hyphens, or for initials, a period.
See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35062/.
Vancouver style requires family rank designations (Jr, II, III, etc) to be rendered as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
Vancouver style requires family rank designations (Jr, II, III, etc.) to be rendered
This code only accepts and understands generational suffix in the Vancouver format because Roman numerals look like, and can be mistaken for, initials.
as Jr, 2nd, 3rd, etc. See http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35085/.
This code only accepts and understands generational suffix in the Vancouver format
because Roman numerals look like, and can be mistaken for, initials.
This function uses ustring functions because firstname initials may be any of the unicode Latin characters accepted by is_good_vanc_name ().
This function uses ustring functions because firstname initials may be any of the
Unicode Latin characters accepted by is_good_vanc_name ().
]]
]]
local function reduce_to_initials(first)
local function reduce_to_initials(first, position)
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");
if not name then -- if not initials and a suffix
if not name then -- if not initials and a suffix
name = mw.ustring.match(first, "^(%u+)$"); -- is it just intials?
name = mw.ustring.match(first, "^(%u+)$"); -- is it just initials?
end
end
return first; -- one or two initials and a valid suffix so nothing to do
return first; -- one or two initials and a valid suffix so nothing to do
else
else
add_vanc_error ('suffix'); -- one or two initials with invalid suffix so error message
add_vanc_error (cfg.err_msg_supl.suffix, position); -- one or two initials with invalid suffix so error message
return first; -- and return first unmolested
return first; -- and return first unmolested
end
end
end
end
end -- if here then name has 3 or more uppercase letters so treat them as a word
end -- if here then name has 3 or more uppercase letters so treat them as a word
local initials, names = {}, {}; -- tables to hold name parts and initials
local initials, names = {}, {}; -- tables to hold name parts and initials
end
end
if 3 > i then
if 3 > i then
table.insert (initials, mw.ustring.sub(names[i],1,1)); -- insert the intial at end of initials table
table.insert (initials, mw.ustring.sub(names[i], 1, 1)); -- insert the initial at end of initials table
end
end
i = i+1; -- bump the counter
i = i + 1; -- bump the counter
end
end
--[[--------------------------< L I S T _ P E O P L E >-------------------------------------------------------
--[[--------------------------< L I S T _ P E O P L E >--------------------------
Formats a list of people (authors, contributors, editors, interviewers, translators)
names in the list will be linked when
|<name>-link= has a value
|<name>-mask- does NOT have a value; masked names are presumed to have been
rendered previously so should have been linked there
when |<name>-mask=0, the associated name is not rendered
]]
]]
local function list_people(control, people, etal)
local function list_people (control, people, etal)
local sep;
local sep;
local namesep;
local namesep;
local format = control.format
local format = control.format;
local maximum = control.maximum
local maximum = control.maximum;
local name_list = {};
local text = {}
if 'vanc' == format then -- Vancouver-like author/editor name styling?
if 'vanc' == format then -- Vancouver-like name styling?
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between authors is a comma
sep = cfg.presentation['sep_nl_vanc']; -- name-list separator between names is a comma
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
namesep = cfg.presentation['sep_name_vanc']; -- last/first separator is a space
else
else
sep = cfg.presentation['sep_nl']; -- name-list separator between authors is a semicolon
sep = cfg.presentation['sep_nl']; -- name-list separator between names is a semicolon
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
namesep = cfg.presentation['sep_name']; -- last/first separator is <comma><space>
end
end
if sep:sub(-1,-1) ~= " " then sep = sep .. " " end
if sep:sub (-1, -1) ~= " " then sep = sep .. " " end
if is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for authors
if utilities.is_set (maximum) and maximum < 1 then return "", 0; end -- returned 0 is for EditorCount; not used for other names
for i,person in ipairs(people) do
for i, person in ipairs (people) do
if is_set(person.last) then
if utilities.is_set (person.last) then
local mask = person.mask
local mask = person.mask;
local one
local one;
local sep_one = sep;
local sep_one = sep;
if is_set (maximum) and i > maximum then
if utilities.is_set (maximum) and i > maximum then
etal = true;
etal = true;
break;
break;
end
local n = tonumber(mask)
if (n ~= nil) then
if mask then
one = string.rep("—",n)
local n = tonumber (mask); -- convert to a number if it can be converted; nil else
if n then
one = 0 ~= n and string.rep("—", n) or nil; -- make a string of (n > 0) mdashes, nil else, to replace name
person.link = nil; -- don't create link to name if name is replaces with mdash string or has been set nil
else
else
one = mask;
one = mask; -- replace name with mask text (must include name-list separator)
sep_one = " ";
sep_one = " "; -- modify name-list separator
end
end
else
else
one = person.last
one = person.last; -- get surname
local first = person.first
local first = person.first -- get given name
if is_set(first) then
if utilities.is_set (first) then
if ( "vanc" == format ) then -- if vancouver format
if ("vanc" == format) then -- if Vancouver format
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)
if not person.corporate and is_good_vanc_name (one, first) then -- and name is all Latin characters; corporate authors not tested
if not person.corporate and is_good_vanc_name (one, first, nil, i) then -- and name is all Latin characters; corporate authors not tested
first = reduce_to_initials(first) -- attempt to convert first name(s) to initials
first = reduce_to_initials (first, i); -- attempt to convert first name(s) to initials
end
end
end
end
one = one .. namesep .. first;
one = one .. namesep .. first;
end
end
end
end
table.insert( text, one )
if utilities.is_set (person.link) then
one = utilities.make_wikilink (person.link, one); -- link author/editor
end
if one then -- if <one> has a value (name, mdash replacement, or mask text replacement)
table.insert (name_list, one); -- add it to the list of names
table.insert (name_list, sep_one); -- add the proper name-list separator
end
end
end
end
end
local count = #text / 2; -- (number of names + number of separators) divided by 2
local count = #name_list / 2; -- (number of names + number of separators) divided by 2
if count > 0 then
if 0 < count then
if count > 1 and is_set(lastauthoramp) and not etal then
if 1 < count and not etal then
if 'amp' == format then
name_list[#name_list-2] = " & "; -- replace last separator with ampersand text
elseif 'and' == format then
if 2 == count then
name_list[#name_list-2] = cfg.presentation.sep_nl_and; -- replace last separator with 'and' text
else
name_list[#name_list-2] = cfg.presentation.sep_nl_end; -- replace last separator with '(sep) and' text
end
end
end
end
name_list[#name_list] = nil; -- erase the last separator
end
end
local result = table.concat(text) -- construct list
local result = table.concat (name_list); -- construct list
if etal and is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
if etal and utilities.is_set (result) then -- etal may be set by |display-authors=etal but we might not have a last-first list
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've go a last-first list and etal so add et al.
result = result .. sep .. ' ' .. cfg.messages['et al']; -- we've got a last-first list and etal so add et al.
end
end
return result, count
return result, count; -- return name-list string and count of number of names (count used for editor names only)
end
end
--[[--------------------------< A N C H O R _ I D >------------------------------------------------------------
--[[--------------------< M A K E _ C I T E R E F _ I D >-----------------------
Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise returns an empty string.
Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise
returns an empty string.
namelist is one of the contributor-, author-, or editor-name lists chosen in that order. year is Year or anchor_year.
namelist is one of the contributor-, author-, or editor-name lists chosen in that
order. year is Year or anchor_year.
]]
]]
local function anchor_id (namelist, year)
local names={}; -- a table for the one to four names and year
local function make_citeref_id (namelist, year)
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
local names={}; -- a table for the one to four names and year
names[i] = v.last
for i,v in ipairs (namelist) do -- loop through the list and take up to the first four last names
if i == 4 then break end -- if four then done
names[i] = v.last
if i == 4 then break end -- if four then done
end
table.insert (names, year); -- add the year at the end
local id = table.concat(names); -- concatenate names and year for CITEREF id
if utilities.is_set (id) then -- if concatenation is not an empty string
return "CITEREF" .. id; -- add the CITEREF portion
else
return ''; -- return an empty string; no reason to include CITEREF id in this citation
end
end
end
local id = table.concat(names); -- concatenate names and year for CITEREF id
if is_set (id) then -- if concatenation is not an empty string
--[[--------------------------< C I T E _ C L A S S _A T T R I B U T E _M A K E >------------------------------
construct <cite> tag class attribute for this citation.
<cite_class> – config.CitationClass from calling template
<mode> – value from |mode= parameter
]]
local function cite_class_attribute_make (cite_class, mode)
local class_t = {};
table.insert (class_t, 'citation'); -- required for blue highlight
if 'citation' ~= cite_class then
table.insert (class_t, cite_class); -- identify this template for user css
table.insert (class_t, utilities.is_set (mode) and mode or 'cs1'); -- identify the citation style for user css or javascript
else
else
table.insert (class_t, utilities.is_set (mode) and mode or 'cs2'); -- identify the citation style for user css or javascript
end
for _, prop_key in ipairs (z.prop_keys_t) do
table.insert (class_t, prop_key); -- identify various properties for user css or javascript
end
end
return table.concat (class_t, ' '); -- make a big string and done
end
end
--[[--------------------------< N A M E _ H A S _ E T A L >----------------------------------------------------
--[[---------------------< N A M E _ H A S _ E T A L >--------------------------
Evaluates the content of name parameters (author, editor, etc) for variations on the theme of et al. If found,
Evaluates the content of name parameters (author, editor, etc.) for variations on
the et al. is removed, a flag is set to true and the function returns the modified name and the flag.
the theme of et al. If found, the et al. is removed, a flag is set to true and
the function returns the modified name and the flag.
This function never sets the flag to false but returns it's previous state because it may have been set by
This function never sets the flag to false but returns its previous state because
previous passes through this function or by the associated |display-<names>=etal parameter
it may have been set by previous passes through this function or by the associated
|display-<names>=etal parameter
]]
]]
local function name_has_etal (name, etal, nocat, param)
local function name_has_etal (name, etal, nocat, param)
if is_set (name) then -- name can be nil in which case just return
if utilities.is_set (name) then -- name can be nil in which case just return
local patterns = cfg.et_al_patterns; --get patterns from configuration
local patterns = cfg.et_al_patterns; -- get patterns from configuration
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
for _, pattern in ipairs (patterns) do -- loop through all of the patterns
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)
if not nocat then -- no categorization for |vauthors=
if not nocat then -- no categorization for |vauthors=
utilities.set_message ('err_etal', {param}); -- and set an error if not added
end
end
end
end
end
end
return name, etal; --
return name, etal;
end
end
--[[--------------------------< N A M E _ H A S _ E D _ M A R K U P >------------------------------------------
--[[---------------------< N A M E _ I S _ N U M E R I C >----------------------
Add maint cat when name parameter value does not contain letters. Does not catch
mixed alphanumeric names so |last=A. Green (1922-1987) does not get caught in the
current version of this test but |first=(1888) is caught.
returns nothing
]]
]]
local function name_has_ed_markup (name, list_name)
local function name_is_numeric (name, list_name)
if utilities.is_set (name) then
if mw.ustring.match (name, '^[%A]+$') then -- when name does not contain any letters
utilities.set_message ('maint_numeric_names', cfg.special_case_translation [list_name]); -- add a maint cat for this template
end
end
end
end
end
end
--[[--------------------------< N A M E _ H A S _ M U L T _ N A M E S >----------------------------------------
--[[-----------------< N A M E _ H A S _ M U L T _ N A M E S >------------------
Evaluates the content of last/surname (authors etc.) parameters for multiple names.
Multiple names are indicated if there is more than one comma or any "unescaped"
semicolons. Escaped semicolons are ones used as part of selected HTML entities.
If the condition is met, the function adds the multiple name maintenance category.
returns nothing
]]
]]
local function name_has_mult_names (name, list_name)
local function name_has_mult_names (name, list_name)
local count, _;
local _, commas, semicolons, nbsps;
if is_set (name) then
if utilities.is_set (name) then
_, count = name:gsub ('[;,]', ''); -- count the number of separator-like characters
_, commas = name:gsub (',', ''); -- count the number of commas
_, semicolons = name:gsub (';', ''); -- count the number of semicolons
-- nbsps probably should be its own separate count rather than merged in
-- some way with semicolons because Lua patterns do not support the
-- grouping operator that regex does, which means there is no way to add
-- more entities to escape except by adding more counts with the new
-- entities
_, nbsps = name:gsub (' ',''); -- count nbsps
-- There is exactly 1 semicolon per entity, so subtract nbsps
-- from semicolons to 'escape' them. If additional entities are added,
-- they also can be subtracted.
if 1 < commas or 0 < (semicolons - nbsps) then
utilities.set_message ('maint_mult_names', cfg.special_case_translation [list_name]); -- add a maint message
end
end
end
end
end
end
--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------
--[[--------------------------< I S _ G E N E R I C >----------------------------------------------------------
Compares values assigned to various parameter according to the string provided as <item> in the function call:
'generic_names': |last=, |first=, |editor-last=, etc value against list of known generic name patterns
'generic_titles': |title=
Returns true when pattern matches; nil else
The k/v pairs in cfg.special_case_translation[item] each contain two tables, one for English and one for another
'local' language.Each of those tables contain another table that holds the string or pattern (whole or fragment)
in index [1]. index [2] is a Boolean that tells string.find() or mw.ustring.find() to do plain-text search (true)
or a pattern search (false). The intent of all this complexity is to make these searches as fast as possible so
that we don't run out of processing time on very large articles.
]]
]]
local function name_checks (last, first, list_name)
local function is_generic (item, value)
local test_val;
if last:match ('^%(%(.*%)%)$') then -- if wrapped in doubled parentheses, accept as written
for _, generic_value in ipairs (cfg.special_case_translation[item]) do -- spin through the list of known generic value fragments
test_val = generic_value['en'][2] and value:lower() or value; -- when set to 'true', plaintext search using lowercase value
if test_val:find (generic_value['en'][1], 1, generic_value['en'][2]) then
return true; -- found English generic value so done
elseif generic_value['local'] then -- to keep work load down, generic_<value>['local'] should be nil except when there is a local version of the generic value
test_val = generic_value['local'][2] and mw.ustring.lower(value) or value; -- when set to 'true', plaintext search using lowercase value
if mw.ustring.find (test_val, generic_value['local'][1], 1, generic_value['local'][2]) then -- mw.ustring() because might not be Latin script
return true; -- found local generic value so done
end
end
end
end
end
if is_set (first) then
end
--[[--------------------------< N A M E _ I S _ G E N E R I C >------------------------------------------------
first = name_has_ed_markup (first, list_name); -- check for extraneous 'editor' annotation
calls is_generic() to determine if <name> is a 'generic name' listed in cfg.generic_names; <name_alias> is the
parameter name used in error messaging
]]
local function name_is_generic (name, name_alias)
if not added_generic_name_errs and is_generic ('generic_names', name) then
utilities.set_message ('err_generic_name', name_alias); -- set an error message
added_generic_name_errs = true;
end
end
--[[--------------------------< N A M E _ C H E C K S >--------------------------------------------------------
This function calls various name checking functions used to validate the content of the various name-holding parameters.
]]
local function name_checks (last, first, list_name, last_alias, first_alias)
local accept_name;
if utilities.is_set (last) then
last, accept_name = utilities.has_accept_as_written (last); -- remove accept-this-as-written markup when it wraps all of <last>
if not accept_name then -- <last> not wrapped in accept-as-written markup
name_has_mult_names (last, list_name); -- check for multiple names in the parameter (last only)
name_is_numeric (last, list_name); -- check for names that are composed of digits and punctuation
name_is_generic (last, last_alias); -- check for names found in the generic names list
end
end
if utilities.is_set (first) then
first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first>
if not accept_name then -- <first> not wrapped in accept-as-written markup
name_is_numeric (first, list_name); -- check for names that are composed of digits and punctuation
name_is_generic (first, first_alias); -- check for names found in the generic names list
end
local wl_type, D = utilities.is_wikilink (first);
if 0 ~= wl_type then
first = D;
utilities.set_message ('err_bad_paramlink', first_alias);
end
end
end
end
return last, first; -- done
return last, first; -- done
end
--[[----------------------< E X T R A C T _ N A M E S >-------------------------
Gets name list from the input arguments
Gets name list from the input arguments
Searches through args in sequential order to find |lastn= and |firstn= parameters (or their aliases), and their matching link and mask parameters.
Searches through args in sequential order to find |lastn= and |firstn= parameters
Stops searching when both |lastn= and |firstn= are not found in args after two sequential attempts: found |last1=, |last2=, and |last3= but doesn't
(or their aliases), and their matching link and mask parameters. Stops searching
find |last4= and |last5= then the search is done.
when both |lastn= and |firstn= are not found in args after two sequential attempts:
found |last1=, |last2=, and |last3= but doesn't find |last4= and |last5= then the
search is done.
This function emits an error message when there is a |firstn= without a matching |lastn=. When there are 'holes' in the list of last names, |last1= and |last3=
This function emits an error message when there is a |firstn= without a matching
are present but |last2= is missing, an error message is emitted. |lastn= is not required to have a matching |firstn=.
|lastn=. When there are 'holes' in the list of last names, |last1= and |last3=
are present but |last2= is missing, an error message is emitted. |lastn= is not
required to have a matching |firstn=.
When an author or editor parameter contains some form of 'et al.', the 'et al.' is stripped from the parameter and a flag (etal) returned
When an author or editor parameter contains some form of 'et al.', the 'et al.'
that will cause list_people() to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps 'et al.' out of the
is stripped from the parameter and a flag (etal) returned that will cause list_people()
template's metadata. When this occurs, the page is added to a maintenance category.
to add the static 'et al.' text from Module:Citation/CS1/Configuration. This keeps
'et al.' out of the template's metadata. When this occurs, an error is emitted.
]]
]]
local function extract_names(args, list_name)
local function extract_names(args, list_name)
local names = {}; -- table of names
local names = {}; -- table of names
local last; -- individual name components
local last; -- individual name components
local first;
local first;
local link;
local link;
local mask;
local mask;
local i = 1; -- loop counter/indexer
local i = 1; -- loop counter/indexer
local n = 1; -- output table indexer
local n = 1; -- output table indexer
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
local count = 0; -- used to count the number of times we haven't found a |last= (or alias for authors, |editor-last or alias for editors)
local etal=false; -- return value set to true when we find some form of et al. in an author parameter
local etal = false; -- return value set to true when we find some form of et al. in an author parameter
local last_alias, first_alias; -- selected parameter aliases used in error messaging
local last_alias, first_alias, link_alias; -- selected parameter aliases used in error messaging
while true do
while true do
last, last_alias = select_one( args, cfg.aliases[list_name .. '-Last'], 'redundant_parameters', i ); -- search through args for name components beginning at 1
last, last_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'err_redundant_parameters', i ); -- search through args for name components beginning at 1
first, first_alias = select_one( args, cfg.aliases[list_name .. '-First'], 'redundant_parameters', i );
first, first_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'err_redundant_parameters', i );
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i );
link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i );
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al.
last, etal = name_has_etal (last, etal, false, last_alias); -- find and remove variations on et al.
first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.
first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.
last, first= name_checks (last, first, list_name); -- multiple names, extraneous annotation, etc checks
last, first = name_checks (last, first, list_name, last_alias, first_alias); -- multiple names, extraneous annotation, etc. checks
if first and not last then -- if there is a firstn without a matching lastn
if first and not last then -- if there is a firstn without a matching lastn
local alias = first_alias:find ('given', 1, true) and 'given' or 'first'; -- get first or given form of the alias
utilities.set_message ('err_first_missing_last', {
first_alias, -- param name of alias missing its mate
first_alias:gsub (alias, {['first'] = 'last', ['given'] = 'surname'}), -- make param name appropriate to the alias form
}); -- add this error message
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
elseif not first and not last then -- if both firstn and lastn aren't found, are we done?
count = count + 1; -- number of times we haven't found last and first
count = count + 1; -- number of times we haven't found last and first
end
end
else -- we have last with or without a first
else -- we have last with or without a first
link_title_ok (link, list_name:match ("(%w+)List"):lower() .. '-link' .. i, last, list_name:match ("(%w+)List"):lower() .. '-last' .. i); -- check for improper wikimarkup
local result;
link = link_title_ok (link, link_alias, last, last_alias); -- check for improper wiki-markup
if first then
link = link_title_ok (link, link_alias, first, first_alias); -- check for improper wiki-markup
end
names[n] = {last = last, first = first, link = link, mask = mask, corporate=false}; -- add this name to our names list (corporate for |vauthors= only)
names[n] = {last = last, first = first, link = link, mask = mask, corporate = false}; -- add this name to our names list (corporate for |vauthors= only)
n = n + 1; -- point to next location in the names table
n = n + 1; -- point to next location in the names table
if 1 == count then -- if the previous name was missing
if 1 == count then -- if the previous name was missing
utilities.set_message ('err_missing_name', {list_name:match ("(%w+)List"):lower(), i - 1}); -- add this error message
end
end
count = 0; -- reset the counter, we're looking for two consecutive missing names
count = 0; -- reset the counter, we're looking for two consecutive missing names
end
end
return names, etal; -- all done, return our list of names
return names, etal; -- all done, return our list of names and the etal flag
end
end
--[[--------------------------< G E T _ I S O 6 3 9 _ C O D E >------------------------------------------------
--[[--------------------------< N A M E _ T A G _ G E T >------------------------------------------------------
attempt to decode |language=<lang_param> and return language name and matching tag; nil else.
This function looks for:
<lang_param> as a tag in cfg.lang_code_remap{}
<lang_param> as a name in cfg.lang_name_remap{}
<lang_param> as a name in cfg.mw_languages_by_name_t
<lang_param> as a tag in cfg.mw_languages_by_tag_t
when those fail, presume that <lang_param> is an IETF-like tag that MediaWiki does not recognize. Strip all
script, region, variant, whatever subtags from <lang_param> to leave just a two or three character language tag
and look for the new <lang_param> in cfg.mw_languages_by_tag_t{}
on success, return name and matching tag; on failure return nil
]]
local function name_tag_get (lang_param)
local lang_param_lc = mw.ustring.lower (lang_param); -- use lowercase as an index into the various tables
local name;
local tag;
name = cfg.lang_code_remap[lang_param_lc]; -- assume <lang_param_lc> is a tag; attempt to get remapped language name
if name then -- when <name>, <lang_param> is a tag for a remapped language name
return name, lang_param; -- so return <name> from remap and <lang_param>
end
]]
tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- still assuming that <lang_param_lc> is a tag; strip script, region, variant subtags
name = cfg.lang_code_remap[tag]; -- attempt to get remapped language name with language subtag only
if name then -- when <name>, <tag> is a tag for a remapped language name
return name, tag; -- so return <name> from remap and <tag>
end
if cfg.lang_name_remap[lang_param_lc] then -- not a tag, assume <lang_param_lc> is a name; attempt to get remapped language tag
return cfg.lang_name_remap[lang_param_lc][1], cfg.lang_name_remap[lang_param_lc][2]; -- for this <lang_param_lc>, return a (possibly) new name and appropriate tag
end
tag = cfg.mw_languages_by_name_t[lang_param_lc]; -- assume that <lang_param_lc> is a language name; attempt to get its matching tag
return cfg.lang_name_remap[lang:lower()][1], cfg.lang_name_remap[lang:lower()][2]; -- for this language 'name', return a possibly new name and appropriate code
if tag then
return cfg.mw_languages_by_tag_t[tag], tag; -- <lang_param_lc> is a name so return the name from the table and <tag>
end
end
name = cfg.mw_languages_by_tag_t[lang_param_lc]; -- assume that <lang_param_lc> is a tag; attempt to get its matching language name
if name then
return name, lang_param; -- <lang_param_lc> is a tag so return <name> and the tag
end
tag = lang_param_lc:match ('^(%a%a%a?)%-.*'); -- is <lang_param_lc> an IETF-like tag that MediaWiki doesn't recognize? <tag> gets the language subtag; nil else
if tag then
if langlc == mw.ustring.lower(name) then
name = cfg.mw_languages_by_tag_t[tag]; -- attempt to get a language name using the shortened <tag>
if name then
return name, tag; -- <lang_param_lc> is an unrecognized IETF-like tag so return <name> and language subtag
end
end
end
end
end
end
--[[--------------------------< L A N G U A G E _ P A R A M E T E R >------------------------------------------
--[[-------------------< L A N G U A G E _ P A R A M E T E R >------------------
Gets language name from a provided two- or three-character ISO 639 code. If a code is recognized by MediaWiki,
Gets language name from a provided two- or three-character ISO 639 code. If a code
use the returned name; if not, then use the value that was provided with the language parameter.
is recognized by MediaWiki, use the returned name; if not, then use the value that
was provided with the language parameter.
When |language= contains a recognized language (either code or name), the page is assigned to the category for
When |language= contains a recognized language (either code or name), the page is
that code: Category:Norwegian-language sources (no). For valid three-character code languages, the page is assigned
assigned to the category for that code: Category:Norwegian-language sources (no).
to the single category for '639-2' codes: Category:CS1 ISO 639-2 language sources.
For valid three-character code languages, the page is assigned to the single category
for '639-2' codes: Category:CS1 ISO 639-2 language sources.
Languages that are the same as the local wiki are not categorized. MediaWiki does not recognize three-character
Languages that are the same as the local wiki are not categorized. MediaWiki does
equivalents of two-character codes: code 'ar' is recognized bit code 'ara' is not.
not recognize three-character equivalents of two-character codes: code 'ar' is
recognized but code 'ara' is not.
This function supports multiple languages in the form |language=nb, French, th where the language names or codes are
This function supports multiple languages in the form |language=nb, French, th
separated from each other by commas.
where the language names or codes are separated from each other by commas with
optional space characters.
]]
]]
local function language_parameter (lang)
local function language_parameter (lang)
local code; -- the two- or three-character language code
local tag; -- some form of IETF-like language tag; language subtag with optional region, sript, vatiant, etc subtags
local lang_subtag; -- ve populates |language= with mostly unecessary region subtags the MediaWiki does not recognize; this is the base language subtag
local name; -- the language name
local name; -- the language name
local language_list = {}; -- table of language names to be rendered
local language_list = {}; -- table of language names to be rendered
local names_table = {}; -- table made from the value assigned to |language=
local names_t = {}; -- table made from the value assigned to |language=
local this_wiki_name = mw.language.fetchLanguageName (cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name
names_t = mw.text.split (lang, '%s*,%s*'); -- names should be a comma separated list
for _, lang in ipairs (names_t) do -- reuse lang here because we don't yet know if lang is a language name or a language tag
name, tag = name_tag_get (lang); -- attempt to get name/tag pair for <lang>
if is_set (name) then -- if |language= specified a valid code
if utilities.is_set (tag) then
lang_subtag = tag:lower():gsub ('^(%a%a%a?)%-.*', '%1'); -- for categorization, strip any IETF-like tags from language tag
if cfg.this_wiki_code ~= code then -- when the language is not the same as this wiki's language
if cfg.this_wiki_code ~= lang_subtag then -- when the language is not the same as this wiki's language
if 2 == code:len() then -- and is a two-character code
if 2 == lang_subtag:len() then -- and is a two-character tag
add_prop_cat ('foreign_lang_source' .. code, {name, code}); -- categorize it; code appended to allow for multiple language categorization
utilities.add_prop_cat ('foreign-lang-source', {name, lang_subtag}, lang_subtag); -- categorize it; tag appended to allow for multiple language categorization
else -- or is a recognized language (but has a three-character code)
else -- or is a recognized language (but has a three-character tag)
add_prop_cat ('foreign_lang_source_2' .. code, {code}); -- categorize it differently TODO: support mutliple three-character code categories per cs1|2 template
utilities.add_prop_cat ('foreign-lang-source-2', {lang_subtag}, lang_subtag); -- categorize it differently TODO: support multiple three-character tag categories per cs1|2 template?
end
end
elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled
add_prop_cat ('local_lang_source', {name, code}); -- categorize it
utilities.add_prop_cat ('local-lang-source', {name, lang_subtag}); -- categorize it
end
end
else
else
name = lang; -- return whatever <lang> has so that we show something
utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added
end
end
name = ''; -- so we can reuse it
name = ''; -- so we can reuse it
end
end
name = utilities.make_sep_list (#language_list, language_list);
if 2 >= code then
if (1 == #language_list) and (lang_subtag == cfg.this_wiki_code) then -- when only one language, find lang name in this wiki lang name; for |language=en-us, 'English' in 'American English'
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
return ''; -- if one language and that language is this wiki's return an empty string (no annotation)
end
end
--[[--------------------------< S E T _ C S 1 _ S T Y L E >----------------------------------------------------
--[[-----------------------< S E T _ C S _ S T Y L E >--------------------------
Gets the default CS style configuration for the given mode.
Returns default separator and either postscript as passed in or the default.
In CS1, the default postscript and separator are '.'.
In CS2, the default postscript is the empty string and the default separator is ','.
]]
]]
local function set_cs1_style (ps)
local function set_cs_style (postscript, mode)
if not is_set (ps) then -- unless explicitely set to something
if utilities.is_set(postscript) then
-- emit a maintenance message if user postscript is the default cs1 postscript
-- we catch the opposite case for cs2 in set_style
if mode == 'cs1' and postscript == cfg.presentation['ps_' .. mode] then
utilities.set_message ('maint_postscript');
end
else
postscript = cfg.presentation['ps_' .. mode];
end
end
return cfg.presentation['sep_cs1'], ps; -- element separator
return cfg.presentation['sep_' .. mode], postscript;
end
end
--[[--------------------------< S E T _ S T Y L E >-----------------------------
Sets the separator and postscript styles. Checks the |mode= first and the
#invoke CitationClass second. Removes the postscript if postscript == none.
]]
]]
local function set_cs2_style (ps, ref)
local function set_style (mode, postscript, cite_class)
if not is_set (ps) then -- if |postscript= has not been set, set cs2 default
local sep;
if 'cs2' == mode then
sep, postscript = set_cs_style (postscript, 'cs2');
elseif 'cs1' == mode then
sep, postscript = set_cs_style (postscript, 'cs1');
elseif 'citation' == cite_class then
sep, postscript = set_cs_style (postscript, 'cs2');
else
sep, postscript = set_cs_style (postscript, 'cs1');
end
end
if not is_set (ref) then -- if |ref= is not set
if cfg.keywords_xlate[postscript:lower()] == 'none' then
-- emit a maintenance message if user postscript is the default cs2 postscript
-- we catch the opposite case for cs1 in set_cs_style
if 'cs2' == mode or 'citation' == cite_class then
utilities.set_message ('maint_postscript');
end
postscript = '';
end
end
return cfg.presentation['sep_cs2'], ps, ref; -- element separator
return sep, postscript
end
end
--[[--------------------------< G E T _ S E T T I N G S _ F R O M _ C I T E _ C L A S S >----------------------
--[=[-------------------------< I S _ P D F >-----------------------------------
Determines if a URL has the file extension that is one of the PDF file extensions
used by [[MediaWiki:Common.css]] when applying the PDF icon to external links.
returns true if file extension is one of the recognized extensions, else false
]=]
]=]
local function is_pdf (url)
local function is_pdf (url)
--[[--------------------------< S T Y L E _ F O R M A T >------------------------------------------------------
--[[--------------------------< S T Y L E _ F O R M A T >-----------------------
Applies css style to |format=, |chapter-format=, etc. Also emits an error message if the format parameter does
Applies CSS style to |format=, |chapter-format=, etc. Also emits an error message
not have a matching url parameter. If the format parameter is not set and the url contains a file extension that
if the format parameter does not have a matching URL parameter. If the format parameter
is recognized as a pdf document by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
is not set and the URL contains a file extension that is recognized as a PDF document
by MediaWiki's commons.css, this code will set the format parameter to (PDF) with
the appropriate styling.
the appropriate styling.
local function style_format (format, url, fmt_param, url_param)
local function style_format (format, url, fmt_param, url_param)
if is_set (format) then
if utilities.is_set (format) then
format = wrap_style ('format', format); -- add leading space, parentheses, resize
format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize
if not is_set (url) then
if not utilities.is_set (url) then
utilities.set_message ('err_format_missing_url', {fmt_param, url_param}); -- add an error message
end
end
elseif is_pdf (url) then -- format is not set so if url is a pdf file then
elseif is_pdf (url) then -- format is not set so if URL is a PDF file then
format = wrap_style ('format', 'PDF'); -- set format to pdf
format = utilities.wrap_style ('format', 'PDF'); -- set format to PDF
else
else
format = ''; -- empty string for concatenation
format = ''; -- empty string for concatenation
--[[--------------------------< G E T _ D I S P L A Y _ N A M E S >--------------------------------------------
--[[---------------------< G E T _ D I S P L A Y _ N A M E S >------------------
Returns a number that defines the number of names displayed for author and editor name lists and a boolean flag
Returns a number that defines the number of names displayed for author and editor
to indicate when et al. should be appended to the name list.
name lists and a Boolean flag to indicate when et al. should be appended to the name list.
When the value assigned to |display-xxxxors= is a number greater than or equal to zero, return the number and
When the value assigned to |display-xxxxors= is a number greater than or equal to zero,
the previous state of the 'etal' flag (false by default but may have been set to true if the name list contains
return the number and the previous state of the 'etal' flag (false by default
some variant of the text 'et al.').
but may have been set to true if the name list contains some variant of the text 'et al.').
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number that is one greater than the
When the value assigned to |display-xxxxors= is the keyword 'etal', return a number
number of authors in the list and set the 'etal' flag true. This will cause the list_people() to display all of
that is one greater than the number of authors in the list and set the 'etal' flag true.
the names in the name list followed by 'et al.'
This will cause the list_people() to display all of the names in the name list followed by 'et al.'
In all other cases, returns nil and the previous state of the 'etal' flag.
In all other cases, returns nil and the previous state of the 'etal' flag.
]]
]]
local function get_display_names (max, count, list_name, etal)
local function get_display_names (max, count, list_name, etal, param)
if is_set (max) then
if utilities.is_set (max) then
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
if 'etal' == max:lower():gsub("[ '%.]", '') then -- the :gsub() portion makes 'etal' from a variety of 'et al.' spellings and stylings
max = count + 1; -- number of authors + 1 so display all author name plus et al.
max = count + 1; -- number of authors + 1 so display all author name plus et al.
max = tonumber (max); -- make it a number
max = tonumber (max); -- make it a number
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors
utilities.set_message ('err_disp_name', {param, max}); -- add error message
max = nil;
end
end
else -- not a valid keyword or number
else -- not a valid keyword or number
utilities.set_message ('err_disp_name', {param, max}); -- add error message
max = nil; -- unset; as if |display-xxxxors= had not been set
max = nil; -- unset; as if |display-xxxxors= had not been set
end
end
--[[--------------------------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >------------------------------
--[[----------< E X T R A _ T E X T _ I N _ P A G E _ C H E C K >---------------
Adds page to Category:CS1 maint: extra text if |page= or |pages= has what appears to be some form of p. or pp.
Adds error if |page=, |pages=, |quote-page=, |quote-pages= has what appears to be
abbreviation in the first characters of the parameter content.
some form of p. or pp. abbreviation in the first characters of the parameter content.
check Page and Pages for extraneous p, p., pp, and pp. at start of parameter value:
check page for extraneous p, p., pp, pp., pg, pg. at start of parameter value:
good pattern: '^P[^%.P%l]' matches when |page(s)= begins PX or P# but not Px where x and X are letters and # is a dgiit
good pattern: '^P[^%.P%l]' matches when page begins PX or P# but not Px
bad pattern: '^[Pp][Pp]' matches matches when |page(s)= begins pp or pP or Pp or PP
where x and X are letters and # is a digit
bad pattern: '^[Pp][PpGg]' matches when page begins pp, pP, Pp, PP, pg, pG, Pg, PG
]]
]]
local function extra_text_in_page_check (page)
local function extra_text_in_page_check (val, name)
if not val:match (cfg.vol_iss_pg_patterns.good_ppattern) then
for _, pattern in ipairs (cfg.vol_iss_pg_patterns.bad_ppatterns) do -- spin through the selected sequence table of patterns
if val:match (pattern) then -- when a match, error so
utilities.set_message ('err_extra_text_pages', name); -- add error message
return; -- and done
end
end
end
end
end
end
--[=[-------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
--[[--------------------------< E X T R A _ T E X T _ I N _ V O L _ I S S _ C H E C K >------------------------
Adds error if |volume= or |issue= has what appears to be some form of redundant 'type' indicator.
For |volume=:
'V.', or 'Vol.' (with or without the dot) abbreviations or 'Volume' in the first characters of the parameter
content (all case insensitive). 'V' and 'v' (without the dot) are presumed to be roman numerals so
are allowed.
For |issue=:
'No.', 'I.', 'Iss.' (with or without the dot) abbreviations, or 'Issue' in the first characters of the
parameter content (all case insensitive).
local i = 1;
Single character values ('v', 'i', 'n') allowed when not followed by separator character ('.', ':', '=', or
whitespace character) – param values are trimmed of whitespace by MediaWiki before delivered to the module.
<val> is |volume= or |issue= parameter value
<name> is |volume= or |issue= parameter name for error message
<selector> is 'v' for |volume=, 'i' for |issue=
sets error message on failure; returns nothing
]]
local function extra_text_in_vol_iss_check (val, name, selector)
if not utilities.is_set (val) then
return;
end
local patterns = 'v' == selector and cfg.vol_iss_pg_patterns.vpatterns or cfg.vol_iss_pg_patterns.ipatterns;
local handler = 'v' == selector and 'err_extra_text_volume' or 'err_extra_text_issue';
val = val:lower(); -- force parameter value to lower case
for _, pattern in ipairs (patterns) do -- spin through the selected sequence table of patterns
if val:match (pattern) then -- when a match, error so
utilities.set_message (handler, name); -- add error message
return; -- and done
end
end
end
--[=[-------------------------< G E T _ V _ N A M E _ T A B L E >----------------------------------------------
split apart a |vauthors= or |veditors= parameter. This function allows for corporate names, wrapped in doubled
parentheses to also have commas; in the old version of the code, the doubled parentheses were included in the
rendered citation and in the metadata. Individual author names may be wikilinked
|vauthors=Jones AB, [[E. B. White|White EB]], ((Black, Brown, and Co.))
]=]
local function get_v_name_table (vparam, output_table, output_link_table)
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 i = 1;
while name_table[i] do
while name_table[i] do
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parens
if name_table[i]:match ('^%(%(.*[^%)][^%)]$') then -- first segment of corporate with one or more commas; this segment has the opening doubled parentheses
local name = name_table[i];
local name = name_table[i];
i=i+1; -- bump indexer to next segment
i = i + 1; -- bump indexer to next segment
while name_table[i] do
while name_table[i] do
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
name = name .. ', ' .. name_table[i]; -- concatenate with previous segments
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parens
if name_table[i]:match ('^.*%)%)$') then -- if this table member has the closing doubled parentheses
break; -- and done reassembling so
break; -- and done reassembling so
end
end
i=i+1; -- bump indexer
i = i + 1; -- bump indexer
end
end
table.insert (output_table, name); -- and add corporate name to the output table
table.insert (output_table, name); -- and add corporate name to the output table
table.insert (output_link_table, ''); -- no wikilink
table.insert (output_link_table, ''); -- no wikilink
else
else
wl_type, label, link = is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
wl_type, label, link = utilities.is_wikilink (name_table[i]); -- wl_type is: 0, no wl (text in label variable); 1, [[D]]; 2, [[L|D]]
table.insert (output_table, label); -- add this name
table.insert (output_table, label); -- add this name
if 1 == wl_type then
if 1 == wl_type then
end
end
end
end
i = i+1;
i = i + 1;
end
end
return output_table;
return output_table;
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
Author / editor names in |vauthors= or |veditors= must be in Vancouver system style. Corporate or institutional names
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
may sometimes be required and because such names will often fail the is_good_vanc_name() and other format compliance
tests, are wrapped in doubled paranethese ((corporate name)) to suppress the format tests.
tests, are wrapped in doubled parentheses ((corporate name)) to suppress the format tests.
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
Supports generational suffixes Jr, 2nd, 3rd, 4th–6th.
This function sets the vancouver error when a reqired comma is missing and when there is a space between an author's initials.
This function sets the Vancouver error when a required comma is missing and when there is a space between an author's initials.
]]
]]
for i, v_name in ipairs(v_name_table) do
for i, v_name in ipairs(v_name_table) do
first = ''; -- set to empty string for concatenation and because it may have been set for previous author/editor
local accept_name;
v_name, accept_name = utilities.has_accept_as_written (v_name); -- remove accept-this-as-written markup when it wraps all of <v_name>
if accept_name then
last = v_name;
corporate = true; -- flag used in list_people()
corporate = true; -- flag used in list_people()
elseif string.find(v_name, "%s") then
elseif string.find(v_name, "%s") then
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;
add_vanc_error ('punctuation');
add_vanc_error (cfg.err_msg_supl.punctuation, i);
end
end
local lastfirstTable = {}
local lastfirstTable = {}
lastfirstTable = mw.text.split(v_name, "%s")
lastfirstTable = mw.text.split(v_name, "%s+")
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be author intials
first = table.remove(lastfirstTable); -- removes and returns value of last element in table which should be initials or generational suffix
if is_suffix (first) then -- if a valid suffix
suffix = first -- save it as a suffix and
if not mw.ustring.match (first, '^%u+$') then -- mw.ustring here so that later we will catch non-Latin characters
suffix = first; -- not initials so assume that whatever we got is a generational suffix
first = table.remove(lastfirstTable); -- get what should be the initials from the table
first = table.remove(lastfirstTable); -- get what should be the initials from the table
end -- no suffix error message here because letter combination may be result of Romanization; check for digits?
end
last = table.concat(lastfirstTable, " ") -- returns a string that is the concatenation of all other names that are not initials
last = table.concat(lastfirstTable, ' ') -- returns a string that is the concatenation of all other names that are not initials and generational suffix
if not utilities.is_set (last) then
first = ''; -- unset
last = v_name; -- last empty because something wrong with first
add_vanc_error (cfg.err_msg_supl.name, i);
end
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then
add_vanc_error ('missing comma'); -- matches last II last; the case when a comma is missing
add_vanc_error (cfg.err_msg_supl['missing comma'], i); -- matches last II last; the case when a comma is missing
end
end
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test
if mw.ustring.match (v_name, ' %u %u$') then -- this test is in the wrong place TODO: move or replace with a more appropriate test
add_vanc_error ('name'); -- matches a space between two intiials
add_vanc_error (cfg.err_msg_supl.initials, i); -- matches a space between two initials
end
end
else
else
last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?
last = v_name; -- last name or single corporate name? Doesn't support multiword corporate names? do we need this?
end
end
if is_set (first) then
if utilities.is_set (first) then
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
if not mw.ustring.match (first, "^%u?%u$") then -- first shall contain one or two upper-case letters, nothing else
add_vanc_error ('initials'); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
add_vanc_error (cfg.err_msg_supl.initials, i); -- too many initials; mixed case initials (which may be ok Romanization); hyphenated initials
end
end
is_good_vanc_name (last, first); -- check first and last before restoring the suffix which may have a non-Latin digit
is_good_vanc_name (last, first, suffix, i); -- check first and last before restoring the suffix which may have a non-Latin digit
if is_set (suffix) then
if utilities.is_set (suffix) then
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials
suffix = ''; -- unset so we don't add this suffix to all subsequent names
suffix = ''; -- unset so we don't add this suffix to all subsequent names
else
else
if not corporate then
if not corporate then
is_good_vanc_name (last, '');
is_good_vanc_name (last, '', nil, i);
end
end
end
end
link = select_one( args, cfg.aliases[list_name .. '-Link'], 'redundant_parameters', i ) or v_link_table[i];
link = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_redundant_parameters', i ) or v_link_table[i];
mask = select_one( args, cfg.aliases[list_name .. '-Mask'], 'redundant_parameters', i );
mask = utilities.select_one ( args, cfg.aliases[list_name .. '-Mask'], 'err_redundant_parameters', i );
names[i] = {last = last, first = first, link = link, mask = mask, corporate=corporate}; -- add this assembled name to our names list
names[i] = {last = last, first = first, link = link, mask = mask, corporate = corporate}; -- add this assembled name to our names list
end
end
return names, etal; -- all done, return our list of names
return names, etal; -- all done, return our list of names
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
Select one of |authors=, |authorn= / |lastn / firstn=, or |vauthors= as the source of the author name list or
select one of |editors=, |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.
select one of |editorn= / editor-lastn= / |editor-firstn= or |veditors= as the source of the editor name list.
Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest and
Only one of these appropriate three will be used. The hierarchy is: |authorn= (and aliases) highest and |authors= lowest;
|editorn= (and aliases) highest and |veditors= lowest (support for |editors= withdrawn)
When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
When looking for |authorn= / |editorn= parameters, test |xxxxor1= and |xxxxor2= (and all of their aliases); stops after the second
Emits an error message when more than one xxxxor name source is provided.
Emits an error message when more than one xxxxor name source is provided.
In this function, vxxxxors = vauthors or veditors; xxxxors = authors or editors as appropriate.
In this function, vxxxxors = vauthors or veditors; xxxxors = authors as appropriate.
]]
]]
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local function select_author_editor_source (vxxxxors, xxxxors, args, list_name)
local lastfirst = false;
local lastfirst = false;
if select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice incase we have a |first1= without a |last1=; this ...
if utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 1 ) or -- do this twice in case we have a |first1= without a |last1=; this ...
select_one( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 1 ) or -- ... also catches the case where |first= is used with |vauthors=
select_one( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
utilities.select_one ( args, cfg.aliases[list_name .. '-Last'], 'none', 2 ) or
select_one( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
utilities.select_one ( args, cfg.aliases[list_name .. '-First'], 'none', 2 ) then
lastfirst=true;
lastfirst = true;
end
end
if (is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
if (utilities.is_set (vxxxxors) and true == lastfirst) or -- these are the three error conditions
(is_set (vxxxxors) and is_set (xxxxors)) or
(utilities.is_set (vxxxxors) and utilities.is_set (xxxxors)) or
(true == lastfirst and is_set (xxxxors)) then
(true == lastfirst and utilities.is_set (xxxxors)) then
local err_name;
local err_name;
if 'AuthorList' == list_name then -- figure out which name should be used in error message
if 'AuthorList' == list_name then -- figure out which name should be used in error message
err_name = 'editor';
err_name = 'editor';
end
end
utilities.set_message ('err_redundant_parameters', err_name .. '-name-list parameters'); -- add error message
end
end
if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
if true == lastfirst then return 1 end; -- return a number indicating which author name source to use
if is_set (vxxxxors) then return 2 end;
if utilities.is_set (vxxxxors) then return 2 end;
if is_set (xxxxors) then return 3 end;
if utilities.is_set (xxxxors) then return 3 end;
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
return 1; -- no authors so return 1; this allows missing author name test to run in case there is a first without last
end
end
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
This function is used to validate a parameter's assigned value for those parameters that have only a limited number
of allowable values (yes, y, true, live, dead, etc). When the parameter value has not been assigned a value (missing
of allowable values (yes, y, true, live, dead, etc.). When the parameter value has not been assigned a value (missing
or empty in the source template) the function returns the value specified by ret_val. If the parameter value is one
or empty in the source template) the function returns the value specified by ret_val. If the parameter value is one
of the list of allowed values returns the translated value; else, emits an error message and returns the value
of the list of allowed values returns the translated value; else, emits an error message and returns the value
specified by ret_val.
specified by ret_val.
TODO: explain <invert>
]]
]]
local function is_valid_parameter_value (value, name, possible, ret_val)
local function is_valid_parameter_value (value, name, possible, ret_val, invert)
if not is_set (value) then
if not utilities.is_set (value) then
return ret_val; -- an empty parameter is ok
return ret_val; -- an empty parameter is ok
end
if (not invert and utilities.in_array (value, possible)) then -- normal; <value> is in <possible> table
return cfg.keywords_xlate[value]; -- return translation of parameter keyword
return cfg.keywords_xlate[value]; -- return translation of parameter keyword
elseif invert and not utilities.in_array (value, possible) then -- invert; <value> is not in <possible> table
return value; -- return <value> as it is
else
else
utilities.set_message ('err_invalid_param_val', {name, value}); -- not an allowed value so add error message
return ret_val;
return ret_val;
end
end
local function terminate_name_list (name_list, sepc)
local function terminate_name_list (name_list, sepc)
if (string.sub (name_list,-3,-1) == sepc .. '. ') then -- if already properly terminated
if (string.sub (name_list, -3, -1) == sepc .. '. ') then -- if already properly terminated
return name_list; -- just return the name list
return name_list; -- just return the name list
elseif (string.sub (name_list,-1,-1) == sepc) or (string.sub (name_list,-3,-1) == sepc .. ']]') then -- if last name in list ends with sepc char
elseif (string.sub (name_list, -1, -1) == sepc) or (string.sub (name_list, -3, -1) == sepc .. ']]') then -- if last name in list ends with sepc char
return name_list .. " "; -- don't add another
return name_list .. " "; -- don't add another
else
else
return name_list .. sepc .. ' '; -- otherwise terninate the name list
return name_list .. sepc .. ' '; -- otherwise terminate the name list
end
end
end
end
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
local function format_volume_issue (volume, issue, cite_class, origin, sepc, lower)
if not is_set (volume) and not is_set (issue) then
if not utilities.is_set (volume) and not utilities.is_set (issue) then
return '';
return '';
end
end
-- same condition as in format_pages_sheets()
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
local is_numeric_vol = volume and (volume:match ('^[MDCLXVI]+$') or volume:match ('^%d+$')); -- is only uppercase roman numerals or only digits?
local is_long_vol = volume and (4 < mw.ustring.len(volume)); -- is |volume= value longer than 4 characters?
if 'magazine' == cite_class or (in_array (cite_class, {'citation', 'map'}) and 'magazine' == origin) then
if volume and (not is_numeric_vol and is_long_vol) then -- when not all digits or Roman numerals, is |volume= longer than 4 characters?
if is_set (volume) and is_set (issue) then
utilities.add_prop_cat ('long-vol'); -- yes, add properties cat
end
if is_journal then -- journal-style formatting
local vol = '';
return wrap_msg ('issue', {sepc, issue}, lower);
if utilities.is_set (volume) then
if is_numeric_vol then -- |volume= value all digits or all uppercase Roman numerals?
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, volume}); -- render in bold face
elseif is_long_vol then -- not all digits or Roman numerals; longer than 4 characters?
vol = utilities.substitute (cfg.messages['j-vol'], {sepc, utilities.hyphen_to_dash (volume)}); -- not bold
else -- four or fewer characters
vol = utilities.substitute (cfg.presentation['vol-bold'], {sepc, utilities.hyphen_to_dash (volume)}); -- bold
end
end
if utilities.is_set (issue) then
return vol .. utilities.substitute (cfg.messages['j-issue'], issue);
end
end
return vol;
end
end
if 'podcast' == cite_class and is_set (issue) then
if 'podcast' == cite_class and utilities.is_set (issue) then
return wrap_msg ('issue', {sepc, issue}, lower);
return wrap_msg ('issue', {sepc, issue}, lower);
end
end
-- all other types of citation
if utilities.is_set (volume) and utilities.is_set (issue) then
if is_set (volume) then
return wrap_msg ('vol-no', {sepc, utilities.hyphen_to_dash (volume), issue}, lower);
elseif utilities.is_set (volume) then
return wrap_msg ('vol', {sepc, utilities.hyphen_to_dash (volume)}, lower);
else
return wrap_msg ('issue', {sepc, issue}, lower);
return vol .. substitute (cfg.messages['j-issue'], issue);
end
end
end
end
local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
local function format_pages_sheets (page, pages, sheet, sheets, cite_class, origin, sepc, nopp, lower)
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
if 'map' == cite_class then -- only cite map supports sheet(s) as in-source locators
if is_set (sheet) then
if utilities.is_set (sheet) then
if 'journal' == origin then
if 'journal' == origin then
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
return '', '', wrap_msg ('j-sheet', sheet, lower), '';
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
return '', '', wrap_msg ('sheet', {sepc, sheet}, lower), '';
end
end
elseif is_set (sheets) then
elseif utilities.is_set (sheets) then
if 'journal' == origin then
if 'journal' == origin then
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
return '', '', '', wrap_msg ('j-sheets', sheets, lower);
end
end
local is_journal = 'journal' == cite_class or (in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
local is_journal = 'journal' == cite_class or (utilities.in_array (cite_class, {'citation', 'map', 'interview'}) and 'journal' == origin);
if is_set (page) then
if utilities.is_set (page) then
if is_journal then
if is_journal then
return substitute (cfg.messages['j-page(s)'], page), '', '', '';
return utilities.substitute (cfg.messages['j-page(s)'], page), '', '', '';
elseif not nopp then
elseif not nopp then
return substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
return utilities.substitute (cfg.messages['p-prefix'], {sepc, page}), '', '', '';
else
else
return substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
return utilities.substitute (cfg.messages['nopp'], {sepc, page}), '', '', '';
end
end
elseif is_set(pages) then
elseif utilities.is_set (pages) then
if is_journal then
if is_journal then
return substitute (cfg.messages['j-page(s)'], pages), '', '', '';
return utilities.substitute (cfg.messages['j-page(s)'], pages), '', '', '';
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
elseif tonumber(pages) ~= nil and not nopp then -- if pages is only digits, assume a single page number
return '', substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
return '', utilities.substitute (cfg.messages['p-prefix'], {sepc, pages}), '', '';
elseif not nopp then
elseif not nopp then
return '', substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
return '', utilities.substitute (cfg.messages['pp-prefix'], {sepc, pages}), '', '';
else
else
return '', substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
return '', utilities.substitute (cfg.messages['nopp'], {sepc, pages}), '', '';
end
end
end
end
returns one of the in-source locators: page, pages, or at.
returns one of the in-source locators: page, pages, or at.
If any of these are interwiki links to wikisource, returns the label portion of the interwikilink as plain text
If any of these are interwiki links to Wikisource, returns the label portion of the interwiki-link as plain text
for use in COinS. This COinS thing is done because here we convert an interwiki link to and external link and
for use in COinS. This COinS thing is done because here we convert an interwiki-link to an external link and
add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it?
add an icon span around that; get_coins_pages() doesn't know about the span. TODO: should it?
]]
]]
local function insource_loc_get (page, pages, at)
local function insource_loc_get (page, page_orig, pages, pages_orig, at)
local ws_url, ws_label, coins_pages, L; -- for wikisource interwikilinks; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
local ws_url, ws_label, coins_pages, L; -- for Wikisource interwiki-links; TODO: this corrupts page metadata (span remains in place after cleanup; fix there?)
if is_set (page) then
if utilities.is_set (page) then
if is_set (pages) or is_set(at) then
if utilities.is_set (pages) or utilities.is_set (at) then
pages = ''; -- unset the others
pages = ''; -- unset the others
at = '';
at = '';
end
end
extra_text_in_page_check (page); -- add this page to maint cat if |page= value begins with what looks like p. or pp.
extra_text_in_page_check (page, page_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
ws_url, ws_label, L = wikisource_url_make (page); -- make ws url from |page= interwiki link; link portion L becomes tool tip label
ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label
if ws_url then
if ws_url then
page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
page = external_link (ws_url, ws_label .. ' ', 'ws link in page'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
page = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
page = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, page});
coins_pages = ws_label;
coins_pages = ws_label;
end
end
elseif is_set (pages) then
elseif utilities.is_set (pages) then
if is_set (at) then
if utilities.is_set (at) then
at = ''; -- unset
at = ''; -- unset
end
end
extra_text_in_page_check (pages); -- add this page to maint cat if |pages= value begins with what looks like p. or pp.
extra_text_in_page_check (pages, pages_orig); -- emit error message when |page= value begins with what looks like p., pp., etc.
ws_url, ws_label, L = wikisource_url_make (pages); -- make ws url from |pages= interwiki link; link portion L becomes tool tip label
ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label
if ws_url then
if ws_url then
pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
pages = external_link (ws_url, ws_label .. ' ', 'ws link in pages'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
pages = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
pages = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, pages});
coins_pages = ws_label;
coins_pages = ws_label;
end
end
elseif is_set (at) then
elseif utilities.is_set (at) then
ws_url, ws_label, L = wikisource_url_make (at); -- make ws url from |at= interwiki link; link portion L becomes tool tip label
ws_url, ws_label, L = wikisource_url_make (at); -- make ws URL from |at= interwiki link; link portion L becomes tooltip label
if ws_url then
if ws_url then
at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
at = external_link (ws_url, ws_label .. ' ', 'ws link in at'); -- space char after label to move icon away from in-source text; TODO: a better way to do this?
at = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
at = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, at});
coins_pages = ws_label;
coins_pages = ws_label;
end
end
end
end
--[[--------------------------< I S _ U N I Q U E _ A R C H I V E _ U R L >------------------------------------
add error message when |archive-url= value is same as |url= or chapter-url= (or alias...) value
]]
local function is_unique_archive_url (archive, url, c_url, source, date)
if utilities.is_set (archive) then
if archive == url or archive == c_url then
utilities.set_message ('err_bad_url', {utilities.wrap_style ('parameter', source)}); -- add error message
return '', ''; -- unset |archive-url= and |archive-date= because same as |url= or |chapter-url=
end
end
return archive, date;
end
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
--[=[-------------------------< A R C H I V E _ U R L _ C H E C K >--------------------------------------------
Check archive.org urls to make sure they at least look like they are pointing at valid archives and not to the
Check archive.org URLs to make sure they at least look like they are pointing at valid archives and not to the
save snapshot url or to calendar pages. When the archive url is 'https://web.archive.org/save/' (or http://...)
save snapshot URL or to calendar pages. When the archive URL is 'https://web.archive.org/save/' (or http://...)
archive.org saves a snapshot of the target page in the url. That is something that Wikipedia should not allow
archive.org saves a snapshot of the target page in the URL. That is something that Wikipedia should not allow
unwitting readers to do.
unwitting readers to do.
When the archive.org url does not have a complete timestamp, archive.org chooses a snapshot according to its own
When the archive.org URL does not have a complete timestamp, archive.org chooses a snapshot according to its own
algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results.
algorithm or provides a calendar 'search' result. [[WP:ELNO]] discourages links to search results.
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
This function looks at the value assigned to |archive-url= and returns empty strings for |archive-url= and
|archive-date= and an error message when:
|archive-date= and an error message when:
|archive-url= holds an archive.org save command url
|archive-url= holds an archive.org save command URL
|archive-url= is an archive.org url that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
|archive-url= is an archive.org URL that does not have a complete timestamp (YYYYMMDDhhmmss 14 digits) in the
correct place
correct place
otherwise returns |archive-url= and |archive-date=
otherwise returns |archive-url= and |archive-date=
There are two mostly compatible archive.org urls:
There are two mostly compatible archive.org URLs:
//web.archive.org/<timestamp>... -- the old form
//web.archive.org/<timestamp>... -- the old form
//web.archive.org/web/<timestamp>... -- the new form
//web.archive.org/web/<timestamp>... -- the new form
we don't check for these specific flags but we do check the form.
we don't check for these specific flags but we do check the form.
This function supports a preview mode. When the article is rendered in preview mode, this funct may return a modified
This function supports a preview mode. When the article is rendered in preview mode, this function may return a modified
archive url:
archive URL:
for save command errors, return undated wildcard (/*/)
for save command errors, return undated wildcard (/*/)
for timestamp errors when the timestamp has a wildcard, return the url unmodified
for timestamp errors when the timestamp has a wildcard, return the URL unmodified
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)
for timestamp errors when the timestamp does not have a wildcard, return with timestamp limited to six digits plus wildcard (/yyyymm*/)
local function archive_url_check (url, date)
local function archive_url_check (url, date)
local err_msg = ''; -- start with the error message empty
local err_msg = ''; -- start with the error message empty
local path, timestamp, flag; -- portions of the archive.or url
local path, timestamp, flag; -- portions of the archive.org URL
if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine url
if (not url:match('//web%.archive%.org/')) and (not url:match('//liveweb%.archive%.org/')) then -- also deprecated liveweb Wayback machine URL
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
return url, date; -- not an archive.org archive, return ArchiveURL and ArchiveDate
end
end
if url:match('//web%.archive%.org/save/') then -- if a save command url, we don't want to allow saving of the target page
if url:match('//web%.archive%.org/save/') then -- if a save command URL, we don't want to allow saving of the target page
err_msg = 'save command';
err_msg = cfg.err_msg_supl.save;
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
url = url:gsub ('(//web%.archive%.org)/save/', '%1/*/', 1); -- for preview mode: modify ArchiveURL
elseif url:match('//liveweb%.archive%.org/') then
elseif url:match('//liveweb%.archive%.org/') then
err_msg = 'liveweb';
err_msg = cfg.err_msg_supl.liveweb;
else
else
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the url parts for evaluation
path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation
if not path then -- malformed in some way; pattern did not match
if not is_set(timestamp) or 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = cfg.err_msg_supl.timestamp;
err_msg = 'timestamp';
elseif 14 ~= timestamp:len() then -- path and flag optional, must have 14-digit timestamp here
err_msg = cfg.err_msg_supl.timestamp;
if '*' ~= flag then
if '*' ~= flag then
url=url:gsub ('(//web%.archive%.org/[^%d]*%d?%d?%d?%d?%d?%d?)[^/]*', '%1*', 1) -- for preview, modify ts to be yearmo* max (0-6 digits plus splat)
local replacement = timestamp:match ('^%d%d%d%d%d%d') or timestamp:match ('^%d%d%d%d'); -- get the first 6 (YYYYMM) or first 4 digits (YYYY)
if replacement then -- nil if there aren't at least 4 digits (year)
replacement = replacement .. string.rep ('0', 14 - replacement:len()); -- year or yearmo (4 or 6 digits) zero-fill to make 14-digit timestamp
url=url:gsub ('(//web%.archive%.org/[^%d]*)%d[^/]*', '%1' .. replacement .. '*', 1) -- for preview, modify ts to 14 digits plus splat for calendar display
end
end
end
elseif is_set(path) and 'web/' ~= path then -- older archive urls do not have the extra 'web/' path element
elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element
err_msg = 'path';
err_msg = cfg.err_msg_supl.path;
elseif is_set (flag) and not is_set (path) then -- flag not allowed with the old form url (without the 'web/' path element)
elseif utilities.is_set (flag) and not utilities.is_set (path) then -- flag not allowed with the old form URL (without the 'web/' path element)
err_msg = 'flag';
err_msg = cfg.err_msg_supl.flag;
elseif is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
elseif utilities.is_set (flag) and not flag:match ('%a%a_') then -- flag if present must be two alpha characters and underscore (requires 'web/' path element)
err_msg = 'flag';
err_msg = cfg.err_msg_supl.flag;
else
else
return url, date; -- return archiveURL and ArchiveDate
return url, date; -- return ArchiveURL and ArchiveDate
end
end
end
end
-- if here, something not right so
-- if here, something not right so
utilities.set_message ('err_archive_url', {err_msg}); -- add error message and
if is_set (Frame:preprocess('{{REVISIONID}}')) then
return '', ''; -- return empty strings for archiveURL and ArchiveDate
if is_preview_mode then
return url, date; -- preview mode so return ArchiveURL and ArchiveDate
else
else
return url, date; -- preview mode so return archiveURL and ArchiveDate
return '', ''; -- return empty strings for ArchiveURL and ArchiveDate
end
end
end
end
check |place=, |publication-place=, |location= to see if these params include digits. This function added because
check |place=, |publication-place=, |location= to see if these params include digits. This function added because
many editors mis-use location to specify the in-source location (|page(s)= and |at= are supposed to do that)
many editors misuse location to specify the in-source location (|page(s)= and |at= are supposed to do that)
returns the original parameter value without modification; added maint cat when parameter value contains digits
returns the original parameter value without modification; added maint cat when parameter value contains digits
local function place_check (param_val)
local function place_check (param_val)
if not is_set (param_val) then -- parameter empty or omitted
if not utilities.is_set (param_val) then -- parameter empty or omitted
return param_val; -- return that empty state
return param_val; -- return that empty state
end
end
if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
if mw.ustring.find (param_val, '%d') then -- not empty, are there digits in the parameter value
utilities.set_message ('maint_location'); -- yep, add maint cat
end
end
--[[--------------------------< C I T A T I O N 0 >------------------------------------------------------------
--[[--------------------------< I S _ A R C H I V E D _ C O P Y >----------------------------------------------
compares |title= to 'Archived copy' (placeholder added by bots that can't find proper title); if matches, return true; nil else
]]
]]
local function citation0( config, args)
local function is_archived_copy (title)
--[[
title = mw.ustring.lower(title); -- switch title to lower case
Load Input Parameters
if title:find (cfg.special_case_translation.archived_copy.en) then -- if title is 'Archived copy'
return true;
elseif cfg.special_case_translation.archived_copy['local'] then
if mw.ustring.find (title, cfg.special_case_translation.archived_copy['local']) then -- mw.ustring() because might not be Latin script
return true;
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.
The argument_wrapper facilitates the mapping of multiple aliases to single internal variable.
]]
]]
local A = argument_wrapper( args );
local A = argument_wrapper ( args );
local i
local i
-- Pick out the relevant fields from the arguments. Different citation templates
-- Pick out the relevant fields from the arguments. Different citation templates
-- define different field names for the same underlying things.
-- define different field names for the same underlying things.
local author_etal;
local author_etal;
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=
local Authors;
local Authors;
local NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');
local NameListFormat = is_valid_parameter_value (A['NameListFormat'], A:ORIGIN('NameListFormat'), cfg.keywords_lists['name-list-format'], '');
local Collaboration = A['Collaboration'];
local Collaboration = A['Collaboration'];
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=
elseif 2 == selected then
elseif 2 == selected then
NameListStyle = 'vanc'; -- override whatever |name-list-style= might be
a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=
elseif 3 == selected then
elseif 3 == selected then
Authors = A['Authors']; -- use content of |authors=
Authors = A['Authors']; -- use content of |authors=
if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
if 'authors' == A:ORIGIN('Authors') then -- but add a maint cat if the parameter is |authors=
utilities.set_message ('maint_authors'); -- because use of this parameter is discouraged; what to do about the aliases is a TODO:
end
end
end
end
if is_set (Collaboration) then
if utilities.is_set (Collaboration) then
author_etal = true; -- so that |display-authors=etal not required
author_etal = true; -- so that |display-authors=etal not required
end
end
end
end
local editor_etal;
local editor_etal;
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=
do -- to limit scope of selected
do -- to limit scope of selected
local selected = select_author_editor_source (A['Veditors'], A['Editors'], args, 'EditorList');
local selected = select_author_editor_source (A['Veditors'], nil, args, 'EditorList'); -- support for |editors= withdrawn
if 1 == selected then
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=
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
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=
e, editor_etal = parse_vauthors_veditors (args, args.veditors, 'EditorList'); -- fetch editor list from |veditors=, |editor-linkn=, and |editor-maskn=
end
end
end
end
local translator_etal;
local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases
local Chapter_origin = A:ORIGIN ('Chapter');
local Translators; -- assembled translators name list
local Contribution; -- because contribution is required for contributor(s)
if 'contribution' == Chapter_origin then
Contribution = Chapter; -- get the name of the contribution
end
local Interviewers; -- used later
local c = {}; -- contributors list from |contributor-lastn= / contributor-firstn= pairs
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 in_array(config.CitationClass, {"book","citation"}) and not is_set(A['Periodical']) then -- |contributor= and |contribution= only supported in book cites
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=
if 0 < #c then
if 0 < #c then
if not is_set (Contribution) then -- |contributor= requires |contribution=
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
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
if 0 == #a then -- |contributor= requires |author=
if 0 == #a then -- |contributor= requires |author=
utilities.set_message ('err_contributor_missing_required_param', 'author'); -- add missing author error message
c = {}; -- blank the contributors' table; it is used as a flag later
c = {}; -- blank the contributors' table; it is used as a flag later
end
end
end
end
else -- if not a book cite
else -- if not a book cite
if select_one (args, cfg.aliases['ContributorList-Last'], 'redundant_parameters', 1 ) then -- are there contributor name list parameters?
if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?
utilities.set_message ('err_contributor_ignored'); -- add contributor ignored error message
end
end
Contribution = nil; -- unset
Contribution = nil; -- unset
end
end
local Title = A['Title'];
local Title = A['Title'];
local TitleLink = A['TitleLink'];
local TitleLink = A['TitleLink'];
local Chapter = A['Chapter'];
local auto_select = ''; -- default is auto
local ScriptChapter = A['ScriptChapter'];
local accept_link;
TitleLink, accept_link = utilities.has_accept_as_written (TitleLink, true); -- test for accept-this-as-written markup
if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords
auto_select = TitleLink; -- remember selection for later
TitleLink = ''; -- treat as if |title-link= would have been empty
end
TitleLink = link_title_ok (TitleLink, A:ORIGIN ('TitleLink'), Title, 'title'); -- check for wiki-markup in |title-link= or wiki-markup in |title= when |title-link= is set
local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used
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
end
local Periodical = A['Periodical'];
local Periodical = A['Periodical'];
local Periodical_origin = '';
local Periodical_origin = '';
if utilities.is_set (Periodical) then
Periodical_origin = A:ORIGIN('Periodical'); -- get the name of the periodical parameter
local i;
Periodical, i = utilities.strip_apostrophe_markup (Periodical); -- strip apostrophe markup so that metadata isn't contaminated
if i then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {Periodical_origin});
end
end
end
if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}
if utilities.is_set (Periodical) and utilities.is_set (A ['MailingList']) then -- both set emit an error TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', Periodical_origin) .. ' and ' .. utilities.wrap_style ('parameter', 'mailinglist')});
if not (is_set (Periodical) or is_set (ScriptPeriodical)) then -- 'periodical' templates require periodical parameter
end
end
local TransPeriodical = A['TransPeriodical'];
Periodical = A ['MailingList']; -- error or no, set Periodical to |mailinglist= value because this template is {{cite mailing list}}
Periodical_origin = A:ORIGIN('MailingList');
end
local ScriptPeriodical = A['ScriptPeriodical'];
local Series = A['Series'];
-- 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
local Volume;
local Volume;
local Issue;
local ScriptPeriodical_origin = A:ORIGIN('ScriptPeriodical');
if 'citation' == config.CitationClass then
if 'citation' == config.CitationClass then
if is_set (Periodical) then
if utilities.is_set (Periodical) then
if not in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals'
if not utilities.in_array (Periodical_origin, {'website', 'mailinglist'}) then -- {{citation}} does not render volume for these 'periodicals' --TODO: move 'array' to ~/Configuration
Volume = A['Volume']; -- but does for all other 'periodicals'
Volume = A['Volume']; -- but does for all other 'periodicals'
end
end
elseif is_set (ScriptPeriodical) then
elseif utilities.is_set (ScriptPeriodical) then
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
if 'script-website' ~= ScriptPeriodical_origin then -- {{citation}} does not render volume for |script-website=
Volume = A['Volume']; -- but does for all other 'periodicals'
Volume = A['Volume']; -- but does for all other 'periodicals'
Volume = A['Volume']; -- and does for non-'periodical' cites
Volume = A['Volume']; -- and does for non-'periodical' cites
end
end
elseif in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
elseif utilities.in_array (config.CitationClass, cfg.templates_using_volume) then -- render |volume= for cs1 according to the configuration settings
Volume = A['Volume'];
Volume = A['Volume'];
end
end
extra_text_in_vol_iss_check (Volume, A:ORIGIN ('Volume'), 'v');
local Issue;
if 'citation' == config.CitationClass then
if 'citation' == config.CitationClass then
if is_set (Periodical) and in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals'
if utilities.is_set (Periodical) and utilities.in_array (Periodical_origin, {'journal', 'magazine', 'newspaper', 'periodical', 'work'}) or -- {{citation}} renders issue for these 'periodicals'--TODO: move 'array' to ~/Configuration
is_set (ScriptPeriodical) and in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals'
utilities.is_set (ScriptPeriodical) and utilities.in_array (ScriptPeriodical_origin, {'script-journal', 'script-magazine', 'script-newspaper', 'script-periodical', 'script-work'}) then -- and these 'script-periodicals'
Issue = hyphen_to_dash (A['Issue']);
Issue = utilities.hyphen_to_dash (A['Issue']);
end
end
elseif in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table
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 (in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (is_set (Periodical) or is_set (ScriptPeriodical))) then
if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then
Issue = hyphen_to_dash (A['Issue']);
Issue = utilities.hyphen_to_dash (A['Issue']);
end
end
end
end
extra_text_in_vol_iss_check (Issue, A:ORIGIN ('Issue'), 'i');
local Position = '';
local Page;
if not in_array (config.CitationClass, cfg.templates_not_using_page) then
local Pages;
local At;
if not utilities.in_array (config.CitationClass, cfg.templates_not_using_page) then
Page = A['Page'];
Page = A['Page'];
Pages = hyphen_to_dash (A['Pages']);
Pages = utilities.hyphen_to_dash (A['Pages']);
At = A['At'];
At = A['At'];
end
end
local PublisherName = A['PublisherName'];
local PublisherName = A['PublisherName'];
local PublisherName_origin = A:ORIGIN('PublisherName');
local PublisherName_origin = A:ORIGIN('PublisherName');
if utilities.is_set (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 then -- non-zero when markup was stripped so emit an error message
utilities.set_message ('err_apostrophe_markup', {PublisherName_origin});
end
end
local Newsgroup = A['Newsgroup']; -- TODO: strip apostrophe markup?
local Newsgroup_origin = A:ORIGIN('Newsgroup');
if 'newsgroup' == config.CitationClass then
if utilities.is_set (PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup
utilities.set_message ('err_parameter_ignored', {PublisherName_origin});
end
end
PublisherName = nil; -- ensure that this parameter is unset for the time being; will be used again after COinS
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);
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);
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);
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);
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 utilities.in_array (this_page.nsText, cfg.uncategorized_namespaces) then
--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 is_set (no_tracking_cats) then -- ignore if we are already not going to categorize this page
if in_array (this_page.nsText, cfg.uncategorized_namespaces) then
no_tracking_cats = "true"; -- set no_tracking_cats
no_tracking_cats = "true"; -- set no_tracking_cats
end
end
for _,v in ipairs (cfg.uncategorized_subpages) do -- cycle through page name patterns
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
if this_page.text:match (v) then -- test page name against each pattern
no_tracking_cats = "true"; -- set no_tracking_cats
no_tracking_cats = "true"; -- set no_tracking_cats
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
select_one( args, {'page', 'p', 'pp', 'pages', 'at', 'sheet', 'sheets'}, 'redundant_parameters' ); -- this is a dummy call simply to get the error message and category
local coins_pages;
local coins_pages;
Page, Pages, At, coins_pages = insource_loc_get (Page, Pages, At);
Page, Pages, At, coins_pages = insource_loc_get (Page, A:ORIGIN('Page'), Pages, A:ORIGIN('Pages'), At);
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);
if is_set (PublicationPlace) and is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different
add_prop_cat ('location test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
utilities.add_prop_cat ('location-test'); -- add property cat to evaluate how often PublicationPlace and Place are used together
if PublicationPlace == Place then
if PublicationPlace == Place then
Place = ''; -- unset; don't need both if they are the same
Place = ''; -- unset; don't need both if they are the same
end
end
elseif not is_set (PublicationPlace) and is_set (Place) then -- when only |place= (|location=) is set ...
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
PublicationPlace = Place; -- promote |place= (|location=) to |publication-place
end
end
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same
local URL_origin = A:ORIGIN('URL'); -- get name of parameter that holds URL
local ChapterURL_origin = A:ORIGIN('ChapterURL'); -- get name of parameter that holds ChapterURL
local ScriptChapter = A['ScriptChapter'];
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:
Parameter remapping for cite encyclopedia:
When the citation has these parameters:
When the citation has these parameters:
|encyclopedia and |title then map |title to |article and |encyclopedia to |title
|encyclopedia= and |title= then map |title= to |article= and |encyclopedia= to |title=
|encyclopedia and |article then map |encyclopedia to |title
|encyclopedia= and |article= then map |encyclopedia= to |title=
|trans-title maps to |trans-chapter when |title is re-mapped
|trans-title= maps to |trans-chapter= when |title= is re-mapped
|url maps to |chapterurl when |title is remapped
|url= maps to |chapter-url= when |title= is remapped
All other combinations of |encyclopedia, |title, and |article are not modified
All other combinations of |encyclopedia=, |title=, and |article= are not modified
]]
]]
local Encyclopedia = A['Encyclopedia'];
local Encyclopedia = A['Encyclopedia']; -- used as a flag by this module and by ~/COinS
if ( config.CitationClass == "encyclopaedia" ) or ( config.CitationClass == "citation" and is_set (Encyclopedia)) then -- test code for citation
if utilities.is_set (Encyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}
if is_set (Periodical) then -- Periodical is set when |encyclopedia is set
if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then
if is_set(Title) or is_set (ScriptTitle) then
utilities.set_message ('err_parameter_ignored', {A:ORIGIN ('Encyclopedia')});
if not is_set(Chapter) then
Encyclopedia = nil; -- unset because not supported by this template
Chapter = Title; -- |encyclopedia and |title are set so map |title to |article and |encyclopedia to |title
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 set emit an error TODO: make a function for this and similar?
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', A:ORIGIN ('Encyclopedia')) .. ' and ' .. utilities.wrap_style ('parameter', Periodical_origin)});
end
if utilities.is_set (Encyclopedia) then
Periodical = Encyclopedia; -- error or no, set Periodical to Encyclopedia; allow periodical without encyclopedia
Periodical_origin = A:ORIGIN ('Encyclopedia');
end
if utilities.is_set (Periodical) then -- Periodical is set when |encyclopedia= is set
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= to |article= and |encyclopedia= to |title=
ScriptChapter = ScriptTitle;
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle')
TransChapter = TransTitle;
TransChapter = TransTitle;
ChapterURL = URL;
ChapterURL = URL;
ChapterURL_origin = URL_origin;
ChapterUrlAccess = UrlAccess;
ChapterUrlAccess = UrlAccess;
if not is_set (ChapterURL) and is_set (TitleLink) then
if not utilities.is_set (ChapterURL) and utilities.is_set (TitleLink) then
Chapter = make_wikilink (TitleLink, Chapter);
Chapter = utilities.make_wikilink (TitleLink, Chapter);
end
end
Title = Periodical;
Title = Periodical;
ScriptTitle = '';
ScriptTitle = '';
end
end
elseif is_set (Chapter) then -- |title not set
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
Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title=
Periodical = ''; -- redundant so unset
Periodical = ''; -- redundant so unset
end
end
end
end
-- Special case for cite techreport.
-- special case for cite techreport.
local ID = A['ID'];
if (config.CitationClass == "techreport") then -- special case for cite techreport
if (config.CitationClass == "techreport") then -- special case for cite techreport
if is_set(A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'
if not is_set(ID) then -- can we use ID for the "number"?
if not utilities.is_set (ID) then -- can we use ID for the "number"?
ID = A['Number']; -- yes, use it
ID = A['Number']; -- yes, use it
else -- ID has a value so emit error message
else -- ID has a value so emit error message
utilities.set_message ('err_redundant_parameters', {utilities.wrap_style ('parameter', 'id') .. ' and ' .. utilities.wrap_style ('parameter', 'number')});
end
end
end
end
end
end
-- Account for the oddity that is {{cite conference}}, before generation of COinS data.
-- 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 'conference' == config.CitationClass then
if is_set(BookTitle) then
if utilities.is_set (BookTitle) then
Chapter = Title;
Chapter = Title;
-- ChapterLink = TitleLink; -- |chapterlink= is deprecated
Chapter_origin = 'title';
-- ChapterLink = TitleLink; -- |chapter-link= is deprecated
ChapterURL = URL;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
URL_origin = '';
ChapterFormat = Format;
ChapterFormat = Format;
TransChapter = TransTitle;
TransChapter = TransTitle;
TransChapter_origin = TransTitle_origin;
Title = BookTitle;
Title = BookTitle;
Format = '';
Format = '';
-- TitleLink = '';
-- TitleLink = '';
TransTitle = '';
TransTitle = '';
URL = '';
URL = '';
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
Conference = ''; -- not cite conference or cite speech so make sure this is empty string
end
end
-- CS1/2 mode
local Mode = is_valid_parameter_value (A['Mode'], A:ORIGIN('Mode'), cfg.keywords_lists['mode'], '');
-- separator character and postscript
local sepc, PostScript = set_style (Mode:lower(), A['PostScript'], config.CitationClass);
-- controls capitalization of certain static text
local use_lowercase = ( sepc == ',' );
-- cite map oddities
-- cite map oddities
local Cartography = "";
local Cartography = "";
local Sheets = A['Sheets'] or '';
local Sheets = A['Sheets'] or '';
if config.CitationClass == "map" then
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') .. ' and ' .. utilities.wrap_style ('parameter', Chapter_origin)}); -- add error message
end
Chapter = A['Map'];
Chapter = A['Map'];
Chapter_origin = A:ORIGIN('Map');
ChapterURL = A['MapURL'];
ChapterURL = A['MapURL'];
ChapterURL_origin = A:ORIGIN('MapURL');
TransChapter = A['TransMap'];
TransChapter = A['TransMap'];
ScriptChapter = A['ScriptMap']
ScriptChapter = A['ScriptMap']
ScriptChapter_origin = A:ORIGIN('ScriptMap')
ChapterUrlAccess = MapUrlAccess;
ChapterUrlAccess = MapUrlAccess;
Cartography = A['Cartography'];
Cartography = A['Cartography'];
if is_set( Cartography ) then
if utilities.is_set ( Cartography ) then
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
Cartography = sepc .. " " .. wrap_msg ('cartography', Cartography, use_lowercase);
end
end
Scale = A['Scale'];
Scale = A['Scale'];
if is_set( Scale ) then
if utilities.is_set ( Scale ) then
Scale = sepc .. " " .. Scale;
Scale = sepc .. " " .. Scale;
end
end
-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.
-- 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
if 'episode' == config.CitationClass or 'serial' == config.CitationClass then
local SeriesLink = A['SeriesLink'];
local SeriesLink = A['SeriesLink'];
link_title_ok (SeriesLink, A:ORIGIN ('SeriesLink'), Series, 'series'); -- check for wikimarkup in |series-link= or wikimarkup in |series= when |series-link= is set
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 Network = A['Network'];
local s, n = {}, {};
local s, n = {}, {};
-- do common parameters first
-- do common parameters first
if is_set(Network) then table.insert(n, Network); end
if utilities.is_set (Network) then table.insert(n, Network); end
if is_set(Station) then table.insert(n, Station); end
if utilities.is_set (Station) then table.insert(n, Station); end
ID = table.concat(n, sepc .. ' ');
ID = table.concat(n, sepc .. ' ');
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
if 'episode' == config.CitationClass then -- handle the oddities that are strictly {{cite episode}}
local Season = A['Season'];
local Season = A['Season'];
local SeriesNumber = A['SeriesNumber'];
local SeriesNumber = A['SeriesNumber'];
if is_set (Season) and is_set (SeriesNumber) then -- these are mutually exclusive so if both are set
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') .. ' and ' .. utilities.wrap_style ('parameter', 'seriesno')}); -- add error message
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
SeriesNumber = ''; -- unset; prefer |season= over |seriesno=
end
end
-- assemble a table of parts concatenated later into Series
-- assemble a table of parts concatenated later into Series
if is_set(Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if utilities.is_set (Season) then table.insert(s, wrap_msg ('season', Season, use_lowercase)); end
if is_set(SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
if utilities.is_set (SeriesNumber) then table.insert(s, wrap_msg ('seriesnum', SeriesNumber, use_lowercase)); end
if is_set(Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
if utilities.is_set (Issue) then table.insert(s, wrap_msg ('episode', Issue, use_lowercase)); end
Issue = ''; -- unset because this is not a unique parameter
Issue = ''; -- unset because this is not a unique parameter
Chapter = Title; -- promote title parameters to chapter
Chapter = Title; -- promote title parameters to chapter
ScriptChapter = ScriptTitle;
ScriptChapter = ScriptTitle;
ScriptChapter_origin = A:ORIGIN('ScriptTitle');
ChapterLink = TitleLink; -- alias |episode-link=
ChapterLink = TitleLink; -- alias episodelink
TransChapter = TransTitle;
TransChapter = TransTitle;
ChapterURL = URL;
ChapterURL = URL;
ChapterUrlAccess = UrlAccess;
ChapterUrlAccess = UrlAccess;
ChapterURL_origin = URL_origin;
Title = Series; -- promote series to title
Title = Series; -- promote series to title
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
Series = table.concat(s, sepc .. ' '); -- this is concatenation of season, seriesno, episode number
if is_set (ChapterLink) and not is_set (ChapterURL) then -- link but not URL
if utilities.is_set (ChapterLink) and not utilities.is_set (ChapterURL) then -- link but not URL
Chapter = make_wikilink (ChapterLink, Chapter);
Chapter = utilities.make_wikilink (ChapterLink, Chapter);
elseif is_set (ChapterLink) and is_set (ChapterURL) then -- if both are set, URL links episode;
elseif utilities.is_set (ChapterLink) and utilities.is_set (ChapterURL) then -- if both are set, URL links episode;
Series = make_wikilink (ChapterLink, Series);
Series = utilities.make_wikilink (ChapterLink, Series);
end
end
URL = ''; -- unset
URL = ''; -- unset
Issue = ''; -- unset because this parameter no longer supported by the citation/core version of 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?
Chapter = A['Episode']; -- TODO: make |episode= available to cite episode someday?
if is_set (Series) and is_set (SeriesLink) then
if utilities.is_set (Series) and utilities.is_set (SeriesLink) then
Series = make_wikilink (SeriesLink, Series);
Series = utilities.make_wikilink (SeriesLink, Series);
end
end
Series = wrap_style ('italic-title', Series); -- series is italicized
Series = utilities.wrap_style ('italic-title', Series); -- series is italicized
end
end
end
end
-- end of {{cite episode}} stuff
-- end of {{cite episode}} stuff
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.
-- 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', 'interview', 'mailinglist', 'map', 'podcast', 'pressrelease', 'report', 'speech', 'techreport', 'thesis'}) then
if in_array(config.CitationClass, {"AV-media-notes", "interview", "mailinglist", "map", "podcast", "pressrelease", "report", "techreport", "thesis"}) then
TitleType = set_titletype (config.CitationClass, TitleType);
TitleType = set_titletype (config.CitationClass, TitleType);
if is_set(Degree) and "Thesis" == TitleType then -- special case for cite thesis
if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
TitleType = Degree .. ' ' .. cfg.title_types ['thesis']:lower();
end
end
end
end
if is_set(TitleType) then -- if type parameter is specified
if utilities.is_set (TitleType) then -- if type parameter is specified
TitleType = substitute( cfg.messages['type'], TitleType); -- display it in parentheses
TitleType = utilities.substitute ( cfg.messages['type'], TitleType); -- display it in parentheses
-- TODO: Hack on TitleType to fix bunched parentheses problem
-- TODO: Hack on TitleType to fix bunched parentheses problem
end
end
-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
-- legacy: promote PublicationDate to Date if neither Date nor Year are set.
local Date = A['Date'];
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging
local PublicationDate = A['PublicationDate'];
local Year = A['Year'];
if not is_set (Date) then
if not utilities.is_set (Date) then
Date = Year; -- promote Year to Date
Date = Year; -- promote Year to Date
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
Year = nil; -- make nil so Year as empty string isn't used for CITEREF
if not is_set (Date) and is_set(PublicationDate) then -- use PublicationDate when |date= and |year= are not set
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
Date = PublicationDate; -- promote PublicationDate to Date
PublicationDate = ''; -- unset, no longer needed
PublicationDate = ''; -- unset, no longer needed
Date validation supporting code is in Module:Citation/CS1/Date_validation
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
local ArchiveURL;
local ArchiveDate;
local ArchiveFormat = A['ArchiveFormat'];
ArchiveURL, ArchiveDate = 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 LayDate = A['LayDate'];
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
do -- create defined block to contain local variables error_message, date_parameters_list, mismatch
local error_message = '';
local error_message = '';
-- AirDate has been promoted to Date so not necessary to check it
-- AirDate has been promoted to Date so not necessary to check it
local date_parameters_list = {
local date_parameters_list = {
['access-date'] = {val=AccessDate, name=A:ORIGIN ('AccessDate')},
['access-date'] = {val = AccessDate, name = A:ORIGIN ('AccessDate')},
['archive-date'] = {val=ArchiveDate, name=A:ORIGIN ('ArchiveDate')},
['archive-date'] = {val = ArchiveDate, name = A:ORIGIN ('ArchiveDate')},
['date'] = {val=Date, name=Date_origin},
['date'] = {val = Date, name = Date_origin},
['doi-broken-date'] = {val=DoiBroken, name=A:ORIGIN ('DoiBroken')},
['doi-broken-date'] = {val = DoiBroken, name = A:ORIGIN ('DoiBroken')},
['embargo'] = {val=Embargo, name=A:ORIGIN ('Embargo')},
['pmc-embargo-date'] = {val = Embargo, name = A:ORIGIN ('Embargo')},
['lay-date'] = {val=LayDate, name=A:ORIGIN ('LayDate')},
['lay-date'] = {val = LayDate, name = A:ORIGIN ('LayDate')},
['publication-date'] ={val=PublicationDate, name=A:ORIGIN ('PublicationDate')},
['publication-date'] = {val = PublicationDate, name = A:ORIGIN ('PublicationDate')},
['year'] = {val=Year, name=A:ORIGIN ('Year')},
['year'] = {val = Year, name = A:ORIGIN ('Year')},
};
};
anchor_year, Embargo, error_message = dates(date_parameters_list, COinS_date);
local error_list = {};
anchor_year, Embargo = validation.dates(date_parameters_list, COinS_date, error_list);
-- start temporary Julian / Gregorian calendar uncertainty categorization
-- start temporary Julian / Gregorian calendar uncertainty categorization
if COinS_date.inter_cal_cat then
if COinS_date.inter_cal_cat then
add_prop_cat ('jul_greg_uncertainty');
utilities.add_prop_cat ('jul-greg-uncertainty');
end
end
-- end temporary Julian / Gregorian calendar uncertainty categorization
-- end temporary Julian / Gregorian calendar uncertainty categorization
if is_set (Year) and is_set (Date) then -- both |date= and |year= not normally needed;
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
end
if not is_set(error_message) then -- error free dates only
if 0 == #error_list then -- error free dates only; 0 when error_list is empty
local modified = false; -- flag
local modified = false; -- flag
if is_set (DF) then -- if we need to reformat dates
if utilities.is_set (DF) then -- if we need to reformat dates
modified = reformat_dates (date_parameters_list, DF, false); -- reformat to DF format, use long month names if appropriate
modified = validation.reformat_dates (date_parameters_list, DF); -- reformat to DF format, use long month names if appropriate
end
end
if true == date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
if true == validation.date_hyphen_to_dash (date_parameters_list) then -- convert hyphens to dashes where appropriate
modified = true;
modified = true;
utilities.set_message ('maint_date_format'); -- hyphens were converted so add maint category
end
end
-- for those wikis that can and want to have English date names translated to the local language,
-- for those wikis that can and want to have English date names translated to the local language; not supported at en.wiki
if cfg.date_name_auto_xlate_enable and validation.date_name_xlate (date_parameters_list, cfg.date_digit_auto_xlate_enable ) then
utilities.set_message ('maint_date_auto_xlated'); -- add maint cat
modified = true;
-- modified = true;
end
if modified then -- if the date_parameters_list values were modified
if modified then -- if the date_parameters_list values were modified
end
end
else
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
end -- end of do
-- Account for the oddity that is {{cite journal}} with |pmc= set and |url= not set. Do this after date check but before COInS.
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 config.CitationClass == "journal" and not is_set(URL) and is_set(ID_list['PMC']) then
local ID_support = {
if not is_set (Embargo) then -- if not embargoed or embargo has expired
{A['ASINTLD'], 'ASIN', 'err_asintld_missing_asin', A:ORIGIN ('ASINTLD')},
{DoiBroken, 'DOI', 'err_doibroken_missing_doi', A:ORIGIN ('DoiBroken')},
{Embargo, 'PMC', 'err_embargo_missing_pmc', A:ORIGIN ('Embargo')},
}
ID_list, ID_list_coins = identifiers.identifier_lists_get (args, {DoiBroken = DoiBroken, ASINTLD = A['ASINTLD'], Embargo = Embargo, Class = Class}, ID_support);
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list) then
if not utilities.is_set (ID_list_coins[config.CitationClass:upper()]) then -- |arxiv= or |eprint= required for cite arxiv; |biorxiv= & |citeseerx= required for their templates
utilities.set_message ('err_' .. config.CitationClass .. '_missing'); -- add error message
end
Periodical = ({['arxiv'] = 'arXiv', ['biorxiv'] = 'bioRxiv', ['citeseerx'] = 'CiteSeerX', ['ssrn'] = 'Social Science Research Network'})[config.CitationClass];
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
end
if utilities.is_set (URL) and 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
end
end
end
-- At this point fields may be nil if they weren't specified in the template use. We can use that fact.
-- 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
-- Test if citation has no title
if not is_set(Title) and
if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode
utilities.set_message ('err_citation_missing_title', {'episode' == config.CitationClass and 'series' or 'title'});
end
end
if 'none' == Title and
if utilities.in_array (cfg.keywords_xlate[Title], {'off', 'none'}) and
in_array (config.CitationClass, {'journal', 'citation'}) and
utilities.in_array (config.CitationClass, {'journal', 'citation'}) and
(is_set (Periodical) or is_set (ScriptPeriodical)) 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
('journal' == Periodical_origin or 'script-journal' == ScriptPeriodical_origin) then -- special case for journal cites
Title = ''; -- set title to empty string
Title = ''; -- set title to empty string
utilities.set_message ('maint_untitled'); -- add maint cat
end
end
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.
local coins_chapter = Chapter; -- default assuming that remapping not required
local coins_chapter = Chapter; -- default assuming that remapping not required
local coins_title = Title; -- et tu
local coins_title = Title; -- et tu
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and is_set (Encyclopedia)) then
if 'encyclopaedia' == config.CitationClass or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then
if is_set (Chapter) and is_set (Title) and is_set (Periodical) then -- if all are used 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_chapter = Title; -- remap
coins_title = Periodical;
coins_title = Periodical;
coins_author = c; -- use that instead
coins_author = c; -- use that instead
end
end
local QuotePage = A['QuotePage'];
local QuotePages = utilities.hyphen_to_dash (A['QuotePages']);
-- this is the function call to COinS()
-- this is the function call to COinS()
local OCinSoutput = COinS({
local OCinSoutput = metadata.COinS({
['Periodical'] = strip_apostrophe_markup (Periodical), -- no markup in the metadata
['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata
['Encyclopedia'] = strip_apostrophe_markup (Encyclopedia),
['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS
['Chapter'] = make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic wikimarkup
['Chapter'] = metadata.make_coins_title (coins_chapter, ScriptChapter), -- Chapter and ScriptChapter stripped of bold / italic / accept-as-written markup
['Degree'] = Degree; -- cite thesis only
['Degree'] = Degree; -- cite thesis only
['Title'] = make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic wikimarkup
['Title'] = metadata.make_coins_title (coins_title, ScriptTitle), -- Title and ScriptTitle stripped of bold / italic / accept-as-written markup
['PublicationPlace'] = PublicationPlace,
['PublicationPlace'] = PublicationPlace,
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;
['Season'] = COinS_date.rftssn,
['Season'] = COinS_date.rftssn,
['Quarter'] = COinS_date.rftquarter,
['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
['Chron'] = COinS_date.rftchron or (not COinS_date.rftdate and Date) or '', -- chron but if not set and invalid date format use Date; keep this last bit?
['Series'] = Series,
['Series'] = Series,
['Volume'] = Volume,
['Volume'] = Volume,
['Issue'] = Issue,
['Issue'] = Issue,
['Pages'] = coins_pages or get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At}, 5)), -- pages stripped of external links
['Pages'] = coins_pages or metadata.get_coins_pages (first_set ({Sheet, Sheets, Page, Pages, At, QuotePage, QuotePages}, 7)), -- pages stripped of external links
['Edition'] = Edition,
['Edition'] = Edition,
['PublisherName'] = PublisherName, -- any apostrophe markup already removed
['PublisherName'] = PublisherName or Newsgroup, -- any apostrophe markup already removed from PublisherName
['URL'] = first_set ({ChapterURL, URL}, 2),
['URL'] = first_set ({ChapterURL, URL}, 2),
['Authors'] = coins_author,
['Authors'] = coins_author,
['ID_list'] = ID_list,
['ID_list'] = ID_list_coins,
['RawPage'] = this_page.prefixedText,
['RawPage'] = this_page.prefixedText,
}, config.CitationClass);
}, config.CitationClass);
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data.
-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, and {{cite ssrn}} AFTER generation of COinS data.
if in_array (config.CitationClass, {'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn now unset so it isn't displayed
if utilities.in_array (config.CitationClass, whitelist.preprint_template_list) then -- we have set rft.jtitle in COinS to arXiv, bioRxiv, CiteSeerX, or ssrn now unset so it isn't displayed
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
Periodical = ''; -- periodical not allowed in these templates; if article has been published, use cite journal
end
end
-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text
-- special case for cite newsgroup. Do this after COinS because we are modifying Publishername to include some static text
if 'newsgroup' == config.CitationClass then
if 'newsgroup' == config.CitationClass and utilities.is_set (Newsgroup) then
PublisherName = utilities.substitute (cfg.messages['newsgroup'], external_link( 'news:' .. Newsgroup, Newsgroup, Newsgroup_origin, nil ));
end
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.
-- Now perform various field substitutions.
-- We also add leading spaces and surrounding markup and punctuation to the
-- We also add leading spaces and surrounding markup and punctuation to the
-- various parts of the citation, but only when they are non-nil.
-- various parts of the citation, but only when they are non-nil.
do
do
local last_first_list;
local last_first_list;
local control = {
local control = {
format = NameListFormat, -- empty string or 'vanc'
format = NameListStyle, -- empty string or 'vanc'
maximum = nil, -- as if display-authors or display-editors not set
maximum = nil, -- as if display-authors or display-editors not set
mode = Mode
mode = Mode
};
};
do -- do editor name list first because the now unsupported coauthors used to modify control table
do -- do editor name list first because the now unsupported coauthors used to modify control table
control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal);
control.maximum , editor_etal = get_display_names (A['DisplayEditors'], #e, 'editors', editor_etal, A:ORIGIN ('DisplayEditors'));
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
if 1 == EditorCount and (true == editor_etal or 1 < #e) then -- only one editor displayed but includes etal then
end
end
do -- now do interviewers
do -- now do interviewers
control.maximum , interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal);
control.maximum, interviewer_etal = get_display_names (A['DisplayInterviewers'], #interviewers_list, 'interviewers', interviewer_etal, A:ORIGIN ('DisplayInterviewers'));
Interviewers = list_people (control, interviewers_list, interviewer_etal);
Interviewers = list_people (control, interviewers_list, interviewer_etal);
end
end
do -- now do translators
do -- now do translators
control.maximum , translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal);
control.maximum, translator_etal = get_display_names (A['DisplayTranslators'], #t, 'translators', translator_etal, A:ORIGIN ('DisplayTranslators'));
Translators = list_people (control, t, translator_etal);
Translators = list_people (control, t, translator_etal);
end
end
do -- now do contributors
do -- now do contributors
control.maximum , contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal);
control.maximum, contributor_etal = get_display_names (A['DisplayContributors'], #c, 'contributors', contributor_etal, A:ORIGIN ('DisplayContributors'));
Contributors = list_people (control, c, contributor_etal);
Contributors = list_people (control, c, contributor_etal);
end
end
do -- now do authors
do -- now do authors
control.maximum , author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal);
control.maximum, author_etal = get_display_names (A['DisplayAuthors'], #a, 'authors', author_etal, A:ORIGIN ('DisplayAuthors'));
last_first_list = list_people(control, a, author_etal);
last_first_list = list_people (control, a, author_etal);
if is_set (Authors) then
if utilities.is_set (Authors) then
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
Authors, author_etal = name_has_etal (Authors, author_etal, false, 'authors'); -- find and remove variations on et al.
if author_etal then
if author_etal then
end -- end of do
end -- end of do
if is_set (Authors) and is_set (Collaboration) then
if utilities.is_set (Authors) and utilities.is_set (Collaboration) then
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
Authors = Authors .. ' (' .. Collaboration .. ')'; -- add collaboration after et al.
end
end
end
end
local ConferenceFormat = A['ConferenceFormat'];
local ConferenceURL = A['ConferenceURL'];
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');
Format = style_format (Format, URL, 'format', 'url');
Format = style_format (Format, URL, 'format', 'url');
-- special case for chapter format so no error message or cat when chapter not supported
-- special case for chapter format so no error message or cat when chapter not supported
if not (in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
if not (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia))) then
('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');
ChapterFormat = style_format (ChapterFormat, ChapterURL, 'chapter-format', 'chapter-url');
end
end
if not is_set(URL) then
if not utilities.is_set (URL) then
if in_array(config.CitationClass, {"web","podcast", "mailinglist"}) or -- |url= required for cite web, cite podcast, and cite mailinglist
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=
('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
end
-- do we have |accessdate= without either |url= or |chapter-url=?
-- do we have |accessdate= without either |url= or |chapter-url=?
if is_set(AccessDate) and not is_set(ChapterURL)then -- ChapterURL may be set when URL is not set;
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 = '';
AccessDate = '';
end
end
end
end
local OriginalURL, OriginalURLorigin, OriginalFormat, OriginalAccess;
local UrlStatus = is_valid_parameter_value (A['UrlStatus'], A:ORIGIN('UrlStatus'), cfg.keywords_lists['url-status'], '');
local OriginalURL
local OriginalURL_origin
local OriginalFormat
local OriginalAccess;
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
UrlStatus = UrlStatus:lower(); -- used later when assembling archived text
if is_set( ArchiveURL ) then
if utilities.is_set ( ArchiveURL ) then
if is_set (ChapterURL) then -- if chapter-url is set apply archive url to it
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 = 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=
OriginalFormat = ChapterFormat; -- and original |chapter-format=
if 'live' ~= UrlStatus then
if 'live' ~= UrlStatus then
ChapterURL = ArchiveURL -- swap-in the archive's url
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
ChapterFormat = ArchiveFormat or ''; -- swap in archive's format
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived urls
ChapterUrlAccess = nil; -- restricted access levels do not make sense for archived URLs
end
end
elseif is_set (URL) then
elseif utilities.is_set (URL) then
OriginalURL = URL; -- save copy of original source URL
OriginalURL = URL; -- save copy of original source URL
OriginalURL_origin = URL_origin; -- name of URL parameter for error messages
OriginalFormat = Format; -- and original |format=
OriginalFormat = Format; -- and original |format=
OriginalAccess = UrlAccess;
OriginalAccess = UrlAccess;
if 'live' ~= UrlStatus then -- if URL set then archive-url applies to it
if 'live' ~= UrlStatus then -- if URL set then |archive-url= applies to it
URL = ArchiveURL -- swap-in the archive's url
URL = ArchiveURL -- swap-in the archive's URL
URL_origin = A:ORIGIN('ArchiveURL') -- name of archive URL parameter for error messages
Format = ArchiveFormat or ''; -- swap in archive's format
Format = ArchiveFormat or ''; -- swap in archive's format
UrlAccess = nil; -- restricted access levels do not make sense for archived urls
UrlAccess = nil; -- restricted access levels do not make sense for archived URLs
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 in_array(config.CitationClass, {'web','news','journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
if utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or -- if any of the 'periodical' cites except encyclopedia
('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) then
('citation' == config.CitationClass and (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical)) and not utilities.is_set (Encyclopedia)) then
local chap_param;
local chap_param;
if is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
if utilities.is_set (Chapter) then -- get a parameter name from one of these chapter related meta-parameters
chap_param = A:ORIGIN ('Chapter')
chap_param = A:ORIGIN ('Chapter')
elseif is_set (TransChapter) then
elseif utilities.is_set (TransChapter) then
chap_param = A:ORIGIN ('TransChapter')
chap_param = A:ORIGIN ('TransChapter')
elseif is_set (ChapterURL) then
elseif utilities.is_set (ChapterURL) then
chap_param = A:ORIGIN ('ChapterURL')
chap_param = A:ORIGIN ('ChapterURL')
elseif is_set (ScriptChapter) then
elseif utilities.is_set (ScriptChapter) then
chap_param = ScriptChapterOrigin;
chap_param = ScriptChapter_origin;
else is_set (ChapterFormat)
else utilities.is_set (ChapterFormat)
chap_param = A:ORIGIN ('ChapterFormat')
chap_param = A:ORIGIN ('ChapterFormat')
end
end
if is_set (chap_param) then -- if we found one
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
Chapter = ''; -- and set them to empty string to be safe with concatenation
TransChapter = '';
TransChapter = '';
else -- otherwise, format chapter / article title
else -- otherwise, format chapter / article title
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
local no_quotes = false; -- default assume that we will be quoting the chapter parameter value
if is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if utilities.is_set (Contribution) and 0 < #c then -- if this is a contribution with contributor(s)
if in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
if utilities.in_array (Contribution:lower(), cfg.keywords_lists.contribution) then -- and a generic contribution title
no_quotes = true; -- then render it unquoted
no_quotes = true; -- then render it unquoted
end
end
end
end
Chapter = format_chapter_title (ScriptChapter, ScriptChapterOrigin, Chapter, TransChapter, ChapterURL, ChapterURLorigin, no_quotes, ChapterUrlAccess); -- Contribution is also in Chapter
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 is_set (Chapter) then
if utilities.is_set (Chapter) then
Chapter = Chapter .. ChapterFormat ;
Chapter = Chapter .. ChapterFormat ;
if 'map' == config.CitationClass and is_set (TitleType) then
if 'map' == config.CitationClass and utilities.is_set (TitleType) then
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
Chapter = Chapter .. ' ' .. TitleType; -- map annotation here; not after title
end
end
Chapter = Chapter.. sepc .. ' ';
Chapter = Chapter .. sepc .. ' ';
elseif is_set (ChapterFormat) then -- |chapter= not set but |chapter-format= is so ...
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
Chapter = ChapterFormat .. sepc .. ' '; -- ... ChapterFormat has error message, we want to see it
end
end
end
end
-- Format main title.
-- Format main title
if is_set (ArchiveURL) and mw.ustring.match (mw.ustring.lower(Title), cfg.special_case_translation['archived_copy']) then -- if title is 'Archived copy' (place holder added by bots that can't find proper 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 Title:match ('^%(%(.*%)%)$') then -- if keep as written markup:
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=
if '...' == Title:sub (-3) then -- if elipsis is the last three characters of |title=
Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three
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 ...
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.)
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
Title = mw.ustring.gsub(Title, '%' .. sepc .. '$', ''); -- remove any trailing separator character; sepc and ms.ustring() here for languages that use multibyte separator characters
end
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
end
end
if in_array(config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
if (not plain_title) and (utilities.in_array (config.CitationClass, {'web', 'news', 'journal', 'magazine', 'pressrelease', 'podcast', 'newsgroup', 'mailinglist', 'interview', 'arxiv', 'biorxiv', 'citeseerx', 'ssrn'}) or
('citation' == config.CitationClass and (is_set (Periodical) or is_set (ScriptPeriodical)) and not is_set (Encyclopedia)) 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 (is_set (Periodical) or is_set (ScriptPeriodical))) then -- special case for cite map when the map is in a periodical treat as an article
('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 = kern_quotes (Title); -- if necessary, separate title's leading and trailing quote marks from module provided quote marks
Title = wrap_style ('quoted-title', Title);
Title = utilities.wrap_style ('quoted-title', Title);
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle= wrap_style ('trans-quoted-title', TransTitle );
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle );
elseif 'report' == config.CitationClass then -- no styling for cite report
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 atribute, categorization, etc; must be done after title is wrapped
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle= wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle ); -- for cite report, use this form for trans-title
else
else
Title = wrap_style ('italic-title', Title);
Title = utilities.wrap_style ('italic-title', Title);
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang atribute, categorization, etc; must be done after title is wrapped
Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped
TransTitle = wrap_style ('trans-italic-title', TransTitle);
TransTitle = utilities.wrap_style ('trans-italic-title', TransTitle);
end
end
if utilities.is_set (TransTitle) then
if is_set(TransTitle) then
if utilities.is_set (Title) then
if is_set(Title) then
TransTitle = " " .. TransTitle;
TransTitle = " " .. TransTitle;
else
else
utilities.set_message ('err_trans_missing_title', {'title'});
end
end
end
end
if is_set(Title) then
if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs?
if not is_set (TitleLink) and is_set (URL) then
if utilities.is_set (TitleLink) and utilities.is_set (URL) then
Title = external_link (URL, Title, URLorigin, UrlAccess) .. TransTitle .. TransError .. Format;
utilities.set_message ('err_wikilink_in_url'); -- set an error message because we can't have both
TitleLink = ''; -- unset
end
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
URL = ''; -- unset these because no longer needed
Format = "";
Format = "";
elseif is_set (TitleLink) and not is_set (URL) then
elseif utilities.is_set (TitleLink) and not utilities.is_set (URL) then
local ws_url;
local ws_url;
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
ws_url = wikisource_url_make (TitleLink); -- ignore ws_label return; not used here
if ws_url then
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 = 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 = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});
Title = Title .. TransTitle .. TransError;
Title = Title .. TransTitle;
else
else
Title = make_wikilink (TitleLink, Title) .. TransTitle .. TransError;
Title = utilities.make_wikilink (TitleLink, Title) .. TransTitle;
end
end
else
else
local ws_url, ws_label;
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); -- make ws url from |title= interwiki link; link portion L becomes tool tip label
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
if ws_url then
Title = Title:gsub ('%b[]', ws_label); -- replace interwiki link with ws_label to retain markup
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 = 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 = substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});
Title = Title .. TransTitle .. TransError;
Title = Title .. TransTitle;
else
else
Title = Title .. TransTitle .. TransError;
Title = Title .. TransTitle;
end
end
end
end
else
else
Title = TransTitle .. TransError;
Title = TransTitle;
end
end
if is_set(Place) then
if utilities.is_set (Place) then
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
Place = " " .. wrap_msg ('written', Place, use_lowercase) .. sepc .. " ";
end
end
if is_set (Conference) then
local ConferenceURL_origin = A:ORIGIN('ConferenceURL'); -- get name of parameter that holds ConferenceURL
if is_set (ConferenceURL) then
if utilities.is_set (Conference) then
Conference = external_link( ConferenceURL, Conference, ConferenceURLorigin, nil );
if utilities.is_set (ConferenceURL) then
Conference = external_link( ConferenceURL, Conference, ConferenceURL_origin, nil );
end
end
Conference = sepc .. " " .. Conference .. ConferenceFormat;
Conference = sepc .. " " .. Conference .. ConferenceFormat;
elseif is_set(ConferenceURL) then
elseif utilities.is_set (ConferenceURL) then
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURLorigin, nil );
Conference = sepc .. " " .. external_link( ConferenceURL, nil, ConferenceURL_origin, nil );
end
end
if not is_set(Position) then
local Position = '';
if not utilities.is_set (Position) then
local Minutes = A['Minutes'];
local Minutes = A['Minutes'];
local Time = A['Time'];
local Time = A['Time'];
if is_set(Minutes) then
if utilities.is_set (Minutes) then
if is_set (Time) 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') .. ' and ' .. utilities.wrap_style ('parameter', 'time')});
end
end
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
Position = " " .. Minutes .. " " .. cfg.messages['minutes'];
else
else
if is_set(Time) then
if utilities.is_set (Time) then
local TimeCaption = A['TimeCaption']
local TimeCaption = A['TimeCaption']
if not is_set(TimeCaption) then
if not utilities.is_set (TimeCaption) then
TimeCaption = cfg.messages['event'];
TimeCaption = cfg.messages['event'];
if sepc ~= '.' then
if sepc ~= '.' then
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);
Page, Pages, Sheet, Sheets = format_pages_sheets (Page, Pages, Sheet, Sheets, config.CitationClass, Periodical_origin, sepc, NoPP, use_lowercase);
At = is_set(At) and (sepc .. " " .. At) or "";
At = utilities.is_set (At) and (sepc .. " " .. At) or "";
Position = is_set(Position) and (sepc .. " " .. Position) or "";
Position = utilities.is_set (Position) and (sepc .. " " .. Position) or "";
if config.CitationClass == 'map' then
if config.CitationClass == 'map' then
local Sections = A['Sections']; -- Section (singular) is an alias of Chapter so set earlier
local Sections = A['Sections'];
local Inset = A['Inset'];
local Inset = A['Inset'];
if is_set( Inset ) then
if utilities.is_set ( Inset ) then
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
Inset = sepc .. " " .. wrap_msg ('inset', Inset, use_lowercase);
end
end
if is_set( Sections ) then
if utilities.is_set ( Sections ) then
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
Section = sepc .. " " .. wrap_msg ('sections', Sections, use_lowercase);
elseif is_set( Section ) then
elseif utilities.is_set ( Section ) then
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
Section = sepc .. " " .. wrap_msg ('section', Section, use_lowercase);
end
end
end
end
if is_set (Language) then
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
end
Others = utilities.is_set (Others) and (sepc .. " " .. Others) or "";
Others = is_set(Others) and (sepc .. " " .. Others) or "";
if is_set (Translators) then
if utilities.is_set (Translators) then
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc);
Others = safe_join ({sepc .. ' ', wrap_msg ('translated', Translators, use_lowercase), Others}, sepc);
end
end
if is_set (Interviewers) then
if utilities.is_set (Interviewers) then
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc);
Others = safe_join ({sepc .. ' ', wrap_msg ('interview', Interviewers, use_lowercase), Others}, sepc);
end
end
TitleNote = is_set(TitleNote) and (sepc .. " " .. TitleNote) or "";
local TitleNote = A['TitleNote'];
if is_set (Edition) then
TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or "";
if Edition:match ('%f[%a][Ee]d%.?$') or Edition:match ('%f[%a][Ee]dition$') then
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
end
Edition = " " .. wrap_msg ('edition', Edition);
Edition = " " .. wrap_msg ('edition', Edition);
end
end
Series = is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum
local Agency = A['Agency'];
Agency = is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";
Agency = utilities.is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);
Volume = format_volume_issue (Volume, Issue, config.CitationClass, Periodical_origin, sepc, use_lowercase);
if utilities.is_set (AccessDate) then
if is_set(AccessDate) then
local retrv_text = " " .. cfg.messages['retrieved']
local retrv_text = " " .. cfg.messages['retrieved']
AccessDate = nowrap_date (AccessDate); -- wrap in nowrap span if date in appropriate format
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
if (sepc ~= ".") then retrv_text = retrv_text:lower() end -- if mode is cs2, lower case
AccessDate = substitute (retrv_text, AccessDate); -- add retrieved text
AccessDate = utilities.substitute (retrv_text, AccessDate); -- add retrieved text
AccessDate = substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
AccessDate = utilities.substitute (cfg.presentation['accessdate'], {sepc, AccessDate}); -- allow editors to hide accessdates
end
end
if is_set(ID) then ID = sepc .." ".. ID; end
if utilities.is_set (ID) then ID = sepc .. " " .. ID; end
if "thesis" == config.CitationClass and is_set(Docket) then
ID = sepc .." Docket ".. Docket .. ID;
local Docket = A['Docket'];
if "thesis" == config.CitationClass and utilities.is_set (Docket) then
ID = sepc .. " Docket " .. Docket .. ID;
end
end
if "report" == config.CitationClass and is_set(Docket) then -- for cite report when |docket= is set
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
ID = sepc .. ' ' .. Docket; -- overwrite ID even if |id= is set
end
end
if utilities.is_set (URL) then
URL = " " .. external_link( URL, nil, URL_origin, UrlAccess );
end
if is_set(URL) then
local Quote = A['Quote'];
local TransQuote = A['TransQuote'];
local ScriptQuote = A['ScriptQuote'];
if utilities.is_set (Quote) or utilities.is_set (TransQuote) or utilities.is_set (ScriptQuote) then
if utilities.is_set (Quote) then
if Quote:sub(1, 1) == '"' and Quote:sub(-1, -1) == '"' then -- if first and last characters of quote are quote marks
Quote = Quote:sub(2, -2); -- strip them off
end
end
end
Quote = sepc .." " .. wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
Quote = utilities.wrap_style ('quoted-text', Quote ); -- wrap in <q>...</q> tags
if utilities.is_set (ScriptQuote) then
Quote = script_concatenate (Quote, ScriptQuote, 'script-quote'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after quote is wrapped
end
if utilities.is_set (TransQuote) then
if TransQuote:sub(1, 1) == '"' and TransQuote:sub(-1, -1) == '"' then -- if first and last characters of |trans-quote are quote marks
TransQuote = TransQuote:sub(2, -2); -- strip them off
end
Quote = Quote .. " " .. utilities.wrap_style ('trans-quoted-title', TransQuote );
end
if utilities.is_set (QuotePage) or utilities.is_set (QuotePages) then -- add page prefix
local quote_prefix = '';
if utilities.is_set (QuotePage) then
extra_text_in_page_check (QuotePage, 'quote-page'); -- add to maint cat if |quote-page= value begins with what looks like p., pp., etc.
if not NoPP then
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePage}), '', '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePage}), '', '', '';
end
elseif utilities.is_set (QuotePages) then
extra_text_in_page_check (QuotePages, 'quote-pages'); -- add to maint cat if |quote-pages= value begins with what looks like p., pp., etc.
if tonumber(QuotePages) ~= nil and not NoPP then -- if only digits, assume single page
quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePages}), '', '';
elseif not NoPP then
quote_prefix = utilities.substitute (cfg.messages['pp-prefix'], {sepc, QuotePages}), '', '';
else
quote_prefix = utilities.substitute (cfg.messages['nopp'], {sepc, QuotePages}), '', '';
end
end
Quote = quote_prefix .. ": " .. Quote;
else
Quote = sepc .. " " .. Quote;
end
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
PostScript = ""; -- cs1|2 does not supply terminal punctuation when |quote= is set
end
end
local Archived
-- We check length of PostScript here because it will have been nuked by
if is_set(ArchiveURL) then
-- 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
local arch_text;
local arch_text;
if not is_set(ArchiveDate) then
if not utilities.is_set (ArchiveDate) then
ArchiveDate = set_error('archive_missing_date');
utilities.set_message ('err_archive_missing_date');
ArchiveDate = ''; -- empty string for concatenation
end
end
if "live" == UrlStatus then
if "live" == UrlStatus then
arch_text = cfg.messages['archived'];
arch_text = cfg.messages['archived'];
if sepc ~= "." then arch_text = arch_text:lower() end
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( cfg.messages['archived-live'],
if utilities.is_set (ArchiveDate) then
Archived = sepc .. ' ' .. utilities.substitute ( cfg.messages['archived-live'],
if not is_set (OriginalURL) then
{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
end
elseif is_set(OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'
if in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
if utilities.in_array (UrlStatus, {'unfit', 'usurped', 'bot: unknown'}) then
arch_text = cfg.messages['archived-unfit'];
arch_text = cfg.messages['archived-unfit'];
if sepc ~= "." then arch_text = arch_text:lower() end
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. arch_text .. ArchiveDate; -- format already styled
Archived = sepc .. ' ' .. arch_text .. ArchiveDate; -- format already styled
if 'bot: unknown' == UrlStatus then
if 'bot: unknown' == UrlStatus then
utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added
else
else
utilities.set_message ('maint_unfit'); -- and add a category if not already added
end
end
else -- UrlStatus is empty, 'dead'
else -- UrlStatus is empty, 'dead'
arch_text = cfg.messages['archived-dead'];
arch_text = cfg.messages['archived-dead'];
if sepc ~= "." then arch_text = arch_text:lower() end
if sepc ~= "." then arch_text = arch_text:lower() end
Archived = sepc .. " " .. substitute( arch_text,
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
end
else -- OriginalUrl not set
else -- OriginalUrl not set
arch_text = cfg.messages['archived-missing'];
arch_text = cfg.messages['archived-missing'];
if sepc ~= "." then arch_text = arch_text:lower() end
if sepc ~= "." then arch_text = arch_text:lower() end
utilities.set_message ('err_archive_missing_url');
Archived = ''; -- empty string for concatenation
end
end
elseif is_set (ArchiveFormat) then
elseif utilities.is_set (ArchiveFormat) then
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message
else
else
Archived = ""
Archived = '';
end
end
local Lay = '';
local Lay = '';
if is_set(LayURL) then
local LaySource = A['LaySource'];
if is_set(LayDate) then LayDate = " (" .. LayDate .. ")" end
local LayURL = A['LayURL'];
if is_set(LaySource) then
local LayFormat = A['LayFormat'];
LaySource = " – ''" .. safe_for_italics(LaySource) .. "''";
LayFormat = style_format (LayFormat, LayURL, 'lay-format', 'lay-url');
if utilities.is_set (LayURL) then
if utilities.is_set (LayDate) then LayDate = " (" .. LayDate .. ")" end
if utilities.is_set (LaySource) then
LaySource = " – ''" .. utilities.safe_for_italics (LaySource) .. "''";
else
else
LaySource = "";
LaySource = "";
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
Lay = sepc .. " " .. external_link( LayURL, cfg.messages['lay summary']:lower(), A:ORIGIN('LayURL'), nil ) .. LayFormat .. LaySource .. LayDate
end
end
elseif is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url=
elseif utilities.is_set (LayFormat) then -- Test if |lay-format= is given without giving a |lay-url=
Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message
Lay = sepc .. LayFormat; -- if set and LayURL not set, then LayFormat has error message
end
end
if is_set(Transcript) then
local TranscriptURL = A['TranscriptURL']
if is_set(TranscriptURL) then
local TranscriptFormat = A['TranscriptFormat'];
Transcript = external_link( TranscriptURL, Transcript, TranscriptURLorigin, nil );
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
end
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
Transcript = sepc .. ' ' .. Transcript .. TranscriptFormat;
elseif is_set(TranscriptURL) then
elseif utilities.is_set (TranscriptURL) then
Transcript = external_link( TranscriptURL, nil, TranscriptURLorigin, nil );
Transcript = external_link( TranscriptURL, nil, TranscriptURL_origin, nil );
end
end
local Publisher;
local Publisher;
if is_set(PublicationDate) then
if utilities.is_set (PublicationDate) then
PublicationDate = wrap_msg ('published', PublicationDate);
PublicationDate = wrap_msg ('published', PublicationDate);
end
end
if is_set(PublisherName) then
if utilities.is_set (PublisherName) then
if is_set(PublicationPlace) then
if utilities.is_set (PublicationPlace) then
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
Publisher = sepc .. " " .. PublicationPlace .. ": " .. PublisherName .. PublicationDate;
else
else
Publisher = sepc .. " " .. PublisherName .. PublicationDate;
Publisher = sepc .. " " .. PublisherName .. PublicationDate;
end
end
elseif is_set(PublicationPlace) then
elseif utilities.is_set (PublicationPlace) then
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
Publisher= sepc .. " " .. PublicationPlace .. PublicationDate;
else
else
end
end
local TransPeriodical = A['TransPeriodical'];
local TransPeriodical_origin = A:ORIGIN ('TransPeriodical');
-- Several of the above rely upon detecting this as nil, so do it last.
-- Several of the above rely upon detecting this as nil, so do it last.
if (is_set (Periodical) or is_set (ScriptPeriodical) or is_set (TransPeriodical)) then
if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then
if is_set(Title) or is_set(TitleNote) then
if utilities.is_set (Title) or utilities.is_set (TitleNote) then
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
Periodical = sepc .. " " .. format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
else
else
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical);
Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);
end
end
end
end
--[[
local Language = A['Language'];
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
if utilities.is_set (Language) then
Language = language_parameter (Language); -- format, categories, name from ISO639-1, etc.
else
Language=''; -- language not specified so make sure this is an empty string;
--[[ 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).
the annotation directly follows the |title= parameter value in the citation rather than the |event= parameter value (if provided).
]]
]]
if "speech" == config.CitationClass then -- cite speech only
if "speech" == config.CitationClass then -- cite speech only
TitleNote = " (Speech)"; -- annotate the citation
TitleNote = TitleType; -- move TitleType to TitleNote so that it renders ahead of |event=
if is_set (Periodical) then -- if Periodical, perhaps because of an included |website= or |journal= parameter
TitleType = ''; -- and unset
if is_set (Conference) then -- and if |event= is set
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
Conference = Conference .. sepc .. " "; -- then add appropriate punctuation to the end of the Conference variable before rendering
end
end
local tcommon2; -- used for book cite when |contributor= is set
local tcommon2; -- used for book cite when |contributor= is set
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
if is_set(Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here?
if utilities.is_set (Others) then Others = safe_join ({Others, sepc .. " "}, sepc) end -- add terminal punctuation & space; check for dup sepc; TODO why do we need to do this here?
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc );
tcommon = safe_join( {Others, Title, TitleNote, Conference, Periodical, Format, TitleType, Series, Language, Edition, Publisher, Agency, Volume}, sepc );
elseif in_array(config.CitationClass, {"book","citation"}) and not is_set(Periodical) then -- special cases for book cites
elseif utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (Periodical) then -- special cases for book cites
if is_set (Contributors) then -- when we are citing foreword, preface, introduction, etc
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
tcommon = safe_join( {Title, TitleNote}, sepc ); -- author and other stuff will come after this and before tcommon2
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
tcommon2 = safe_join( {Conference, Periodical, Format, TitleType, Series, Language, Volume, Others, Edition, Publisher, Agency}, sepc );
elseif 'map' == config.CitationClass then -- special cases for cite map
elseif 'map' == config.CitationClass then -- special cases for cite map
if is_set (Chapter) then -- map in a book; TitleType is part of Chapter
if utilities.is_set (Chapter) then -- map in a book; TitleType is part of Chapter
tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
tcommon = safe_join( {Title, Format, Edition, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
elseif is_set (Periodical) then -- map in a periodical
elseif utilities.is_set (Periodical) then -- map in a periodical
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
tcommon = safe_join( {Title, TitleType, Format, Periodical, Scale, Series, Language, Cartography, Others, Publisher, Volume}, sepc );
else -- a sheet or stand-alone map
else -- a sheet or stand-alone map
end
end
local Via = A['Via'];
Via = utilities.is_set (Via) and wrap_msg ('via', Via) or '';
local idcommon;
local idcommon;
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript
if 'audio-visual' == config.CitationClass or 'episode' == config.CitationClass then -- special case for cite AV media & cite episode position transcript
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
local pgtext = Position .. Sheet .. Sheets .. Page .. Pages .. At;
if is_set(Date) then
local OrigDate = A['OrigDate'];
if is_set (Authors) or is_set (Editors) then -- date follows authors or editors when authors not set
OrigDate = utilities.is_set (OrigDate) and wrap_msg ('origdate', OrigDate) or '';
Date = " (" .. Date ..")" .. OrigYear .. sepc .. " "; -- in paranetheses
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
else -- neither of authors and editors set
if (string.sub(tcommon,-1,-1) == sepc) then -- if the last character of tcommon is sepc
if (string.sub(tcommon, -1, -1) == sepc) then -- if the last character of tcommon is sepc
Date = " " .. Date .. OrigYear; -- Date does not begin with sepc
Date = " " .. Date .. OrigDate; -- Date does not begin with sepc
else
else
Date = sepc .. " " .. Date .. OrigYear; -- Date begins with sepc
Date = sepc .. " " .. Date .. OrigDate; -- Date begins with sepc
end
end
end
end
end
end
if is_set(Authors) then
if utilities.is_set (Authors) then
if (not is_set (Date)) then -- when date is set it's in parentheses; no Authors termination
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
Authors = terminate_name_list (Authors, sepc); -- when no date, terminate with 0 or 1 sepc and a space
end
end
if is_set(Editors) then
if utilities.is_set (Editors) then
local in_text = " ";
local in_text = " ";
local post_text = "";
local post_text = "";
if is_set(Chapter) and 0 == #c then
if utilities.is_set (Chapter) and 0 == #c then
in_text = in_text .. cfg.messages['in'] .. " "
in_text = in_text .. cfg.messages['in'] .. " "
if (sepc ~= '.') then
if (sepc ~= '.') then
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
Editors = terminate_name_list (in_text .. Editors .. post_text, sepc); -- terminate with 0 or 1 sepc and a space
end
end
if is_set (Contributors) then -- book cite and we're citing the intro, preface, etc
if utilities.is_set (Contributors) then -- book cite and we're citing the intro, preface, etc.
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
local by_text = sepc .. ' ' .. cfg.messages['by'] .. ' ';
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
if (sepc ~= '.') then by_text = by_text:lower() end -- lowercase for cs2
Authors = by_text .. Authors; -- author follows title so tweak it here
Authors = by_text .. Authors; -- author follows title so tweak it here
if is_set (Editors) and is_set (Date) then -- when Editors make sure that Authors gets terminated
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
Authors = terminate_name_list (Authors, sepc); -- terminate with 0 or 1 sepc and a space
end
end
if (not is_set (Date)) then -- when date is set it's in parentheses; no Contributors termination
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
Contributors = terminate_name_list (Contributors, sepc); -- terminate with 0 or 1 sepc and a space
end
end
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
text = safe_join( {Authors, Date, Chapter, Place, Editors, tcommon, pgtext, idcommon }, sepc );
end
end
elseif is_set(Editors) then
elseif utilities.is_set (Editors) then
if is_set(Date) then
if utilities.is_set (Date) then
if EditorCount <= 1 then
if EditorCount <= 1 then
Editors = Editors .. ", " .. cfg.messages['editor'];
Editors = Editors .. ", " .. cfg.messages['editor'];
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc );
text = safe_join( {Editors, Date, Chapter, Place, tcommon, pgtext, idcommon}, sepc );
else
else
if in_array(config.CitationClass, {"journal","citation"}) and is_set(Periodical) then
if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
text = safe_join( {Chapter, Place, tcommon, pgtext, Date, idcommon}, sepc );
else
else
end
end
if is_set(PostScript) and PostScript ~= sepc then
if utilities.is_set (PostScript) and PostScript ~= sepc then
text = safe_join( {text, sepc}, sepc ); --Deals with italics, spaces, etc.
text = safe_join( {text, sepc}, sepc ); -- Deals with italics, spaces, etc.
text = text:sub(1,-sepc:len()-1);
text = text:sub(1, -sepc:len() - 1);
end
end
text = safe_join( {text, PostScript}, sepc );
text = safe_join( {text, PostScript}, sepc );
-- Now enclose the whole thing in a <cite/> element
-- Now enclose the whole thing in a <cite> element
local options = {};
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 is_set(Ref) and Ref:lower() ~= "none" then -- set reference anchor if appropriate
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
end
else
citeref_id = ''; -- unset
end
end
options_t.id = Ref or citeref_id;
end
end
if string.len(text:gsub("<span[^>/]*>(.-)</span>", "%1"):gsub("%b<>","")) <= 2 then -- remove <span> tags and other html-like markup; then get length of what remains
if string.len (text:gsub('%b<>', '')) <= 2 then -- remove html and html-like tags; then get length of what remains;
z.error_categories = {};
z.error_cats_t = {}; -- blank the categories list
text = set_error('empty_citation');
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
end
end
local render = {}; -- here we collect the final bits for concatenation into the rendered citation
local render_t = {}; -- here we collect the final bits for concatenation into the rendered citation
if is_set(options.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
if utilities.is_set (options_t.id) then -- here we wrap the rendered citation in <cite ...>...</cite> tags
table.insert (render, substitute (cfg.presentation['cite-id'], {mw.uri.anchorEncode(options.id), mw.text.nowiki(options.class), text})); -- when |ref= is set
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
else
table.insert (render, substitute (cfg.presentation['cite'], {mw.text.nowiki(options.class), text})); -- all other cases
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
end
table.insert (render, substitute (cfg.presentation['ocins'], {OCinSoutput})); -- append metadata to the citation
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
if 0 ~= #z.message_tail then
local template_name = ('citation' == config.CitationClass) and 'citation' or 'cite ' .. (cfg.citation_class_map_t[config.CitationClass] or config.CitationClass);
table.insert (render, ' ');
local template_link = '[[Template:' .. template_name .. '|' .. template_name .. ']]'; -- TODO: if kept, these require some sort of i18n
for i,v in ipairs( z.message_tail ) do
local msg_prefix = '<code class="cs1-code">{{' .. template_link .. '}}</code>: ';
if is_set(v[1]) then
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
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
end
if 0 ~= #z.maintenance_cats then
if 0 ~= #z.maint_cats_t then
local maint_msgs = {}; -- here we collect all of the maint messages
mw.addWarning (utilities.substitute (cfg.messages.warning_msg_m, template_link));
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
table.sort (z.maint_cats_t); -- sort the maintenance messages list
table.insert (maint, v); -- maint msg is the category name
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
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, substitute (cfg.presentation['hidden-maint'], table.concat (maint_msgs, ' '))); -- wrap the group of maint message with proper presentation and save
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
end
if not no_tracking_cats then
if not no_tracking_cats then
for _, v in ipairs( z.error_categories ) do
for _, v in ipairs (z.error_cats_t) do -- append error categories
table.insert (render, make_wikilink ('Category:' .. v));
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
end
end
for _, v in ipairs( z.maintenance_cats ) do -- append maintenance categories
for _, v in ipairs (z.maint_cats_t) do -- append maintenance categories
table.insert (render, make_wikilink ('Category:' .. v));
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
end
end
for _, v in ipairs( z.properties_cats ) do -- append properties categories
for _, v in ipairs (z.prop_cats_t) do -- append properties categories
table.insert (render, make_wikilink ('Category:' .. v));
table.insert (render_t, utilities.substitute (cfg.messages['cat wikilink'], v));
end
end
end
end
return table.concat (render);
return table.concat (render_t); -- make a big string and done
end
end
]]
]]
local function validate (name, cite_class)
local function validate (name, cite_class, empty)
local name = tostring (name);
local name = tostring (name);
local enum_name; -- for enumerated parameters, is name with enumerator replaced with '#'
local state;
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 true == state then return true; end -- valid actively supported parameter
if false == state then
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
deprecated_parameter (name); -- parameter is deprecated but still supported
return true;
return true;
end
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
if name:find ('#') then -- # is a cs1|2 reserved character so parameters with # not permitted
return nil;
end
state = whitelist[cite_class .. '_basic_arguments'][name]; -- look in the parameter-list for the template identified by cite_class
if utilities.in_array (cite_class, whitelist.preprint_template_list ) then -- limited parameter sets allowed for these templates
state = whitelist.limited_basic_arguments[name];
if true == state_test (state, name) then return true; end
state = whitelist.preprint_arguments[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
-- limited enumerated parameters list
-- limited enumerated parameters list
enum_name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits)
state = whitelist.limited_numbered_arguments[name];
state = whitelist.limited_numbered_arguments[enum_name];
if true == state then return true; end -- valid actively supported parameter
if true == state_test (state, name) then return true; end
return false; -- not supported because not found or name is set to nil
return false; -- not supported because not found or name is set to nil
end -- end limited parameter-set templates
end -- end limited parameter-set templates
if utilities.in_array (cite_class, whitelist.unique_param_template_list) then -- experiment for template-specific parameters for templates that accept parameters from the basic argument list
state = whitelist.unique_arguments[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.basic_arguments[name]; -- all other templates; all normal parameters allowed
state = whitelist.basic_arguments[name]; -- all other templates; all normal parameters allowed
if true == state_test (state, name) then return true; end
if true == state then return true; end -- valid actively supported parameter
-- all enumerated parameters allowed
-- all enumerated parameters allowed
enum_name = name:gsub("%d+", "#" ); -- replace digit(s) with # (last25 becomes last#) (mw.ustring because non-Western 'local' digits)
state = whitelist.numbered_arguments[name];
state = whitelist.numbered_arguments[enum_name];
if true == state_test (state, name) then return true; end
return false; -- not supported because not found or name is set to nil
if false == state then
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 value;
return false; -- not supported because not found or name is set to nil
end
end
Look at the contents of a parameter. If the content has a string of characters and digits followed by an equal
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
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:
parameter that is missing its pipe. There are two tests made:
{{cite ... |title=Title access-date=2016-03-17}}
{{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 atributes: class=, title=, etc. To prevent false positives xml/html
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.
tags are removed before the search.
local function missing_pipe_check (parameter, value)
local function missing_pipe_check (parameter, value)
local capture;
local capture;
value = value:gsub ('%b<>', ''); -- remove xml/html tags because attributes: class=, title=, etc
value = value:gsub ('%b<>', ''); -- remove XML/HTML tags because attributes: class=, title=, etc.
capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
capture = value:match ('%s+(%a[%w%-]+)%s*=') or value:match ('^(%a[%w%-]+)%s*='); -- find and categorize parameters with possible missing pipes
if capture and validate (capture) then -- if the capture is a valid parameter name
if capture and validate (capture) then -- if the capture is a valid parameter name
utilities.set_message ('err_missing_pipe', parameter);
end
end
end
end
local function has_extraneous_punc (param, value)
local function has_extraneous_punc (param, value)
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
if cfg.punct_skip[param] then
return; -- parameter name found in the skip table so done
return; -- parameter name found in the skip table so done
if value:match ('[,;:]$') then
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 _ 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 (url_param_t)
local url_error_t = {};
check_for_url (url_param_t, url_error_t); -- extraneous url check
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
local function citation(frame)
local function citation(frame)
Frame = frame; -- save a copy incase we need to display an error message in preview mode
Frame = frame; -- save a copy in case we need to display an error message in preview mode
is_sandbox = nil ~= string.find (frame:getTitle(), 'sandbox', 1, true);
local pframe = frame:getParent()
local pframe = frame:getParent()
local validation, utilities, identifiers, metadata, styles;
local styles;
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
if is_sandbox then -- did the {{#invoke:}} use sandbox version?
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of support modules
cfg = mw.loadData ('Module:Citation/CS1/Configuration/sandbox'); -- load sandbox versions of support modules
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox');
whitelist = mw.loadData ('Module:Citation/CS1/Whitelist/sandbox');
metadata = require ('Module:Citation/CS1/COinS');
metadata = require ('Module:Citation/CS1/COinS');
styles = 'Module:Citation/CS1/styles.css';
styles = 'Module:Citation/CS1/styles.css';
end
end
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the cfg tables
utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
identifiers.set_selected_modules (cfg, utilities); -- so that functions in Identifiers can see the selected cfg tables and selected Utilities module
validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module
validation.set_selected_modules (cfg, utilities); -- so that functions in Date validataion can see selected cfg tables and the selected Utilities module
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module
metadata.set_selected_modules (cfg, utilities); -- so that functions in COinS can see the selected cfg tables and selected Utilities module
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
is_preview_mode = not utilities.is_set (frame:preprocess ('{{REVISIONID}}'));
local args = {}; -- table where we store all of the template's arguments
local args = {}; -- table where we store all of the template's arguments
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local suggestions = {}; -- table where we store suggestions if we need to loadData them
local error_text, error_state;
local error_text; -- used as a flag
local config = {}; -- table to store parameters from the module {{#invoke:}}
local config = {}; -- table to store parameters from the module {{#invoke:}}
for k, v in pairs( frame.args ) do
for k, v in pairs( frame.args ) do -- get parameters from the {{#invoke}} frame
config[k] = v;
config[k] = v;
-- args[k] = v; -- debug tool that allows us to render a citation from module {{#invoke:}}
-- args[k] = v; -- crude debug support that allows us to render a citation from module {{#invoke:}}; skips parameter validation; TODO: keep?
end
end
local capture; -- the single supported capture when matching unknown parameters using patterns
local capture; -- the single supported capture when matching unknown parameters using patterns
for k, v in pairs( pframe.args ) do
local empty_unknowns = {}; -- sequence table to hold empty unknown params for error message listing
for k, v in pairs( pframe.args ) do -- get parameters from the parent (template) frame
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
if ('string' == type (k)) then
if ('string' == type (k)) then
end
end
if not validate( k, config.CitationClass ) then
if not validate( k, config.CitationClass ) then
if type (k) ~= 'string' then -- exclude empty numbered parameters
if type( k ) ~= 'string' then
if v:match("%S+") ~= nil then
if v:match("%S+") ~= nil then
error_text, error_state = set_error( 'text_ignored', {v}, true );
error_text = utilities.set_message ('err_text_ignored', {v});
end
end
elseif validate( k:lower(), config.CitationClass ) then
elseif validate (k:lower(), config.CitationClass) then
error_text, error_state = set_error( 'parameter_ignored_suggest', {k, k:lower()}, true ); -- 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
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
if nil == suggestions.suggestions then -- if this table is nil then we need to load it
if nil ~= string.find (frame:getTitle(), 'sandbox', 1, true) then -- did the {{#invoke:}} use sandbox version?
if is_sandbox then -- did the {{#invoke:}} use sandbox version?
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version
suggestions = mw.loadData( 'Module:Citation/CS1/Suggestions/sandbox' ); -- use the sandbox version
else
else
end
end
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter
capture = k:match (pattern); -- the whole match if no caputre in pattern else the capture if a match
capture = k:match (pattern); -- the whole match if no capture in pattern else the capture if a match
if capture then -- if the pattern matches
if capture then -- if the pattern matches
param = 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, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists)
if validate (param, config.CitationClass) then -- validate the suggestion to make sure that the suggestion is supported by this template (necessary for limited parameter lists)
error_text, error_state = set_error ('parameter_ignored_suggest', {k, param}, true); -- set the suggestion error message
error_text = utilities.set_message ('err_parameter_ignored_suggest', {k, param}); -- set the suggestion error message
else
else
error_text, error_state = set_error( 'parameter_ignored', {param}, true ); -- suggested param not supported by this template
error_text = utilities.set_message ('err_parameter_ignored', {k}); -- suggested param not supported by this template
v = ''; -- unset
v = ''; -- unset
end
end
end
end
end
end
if not is_set (error_text) then -- couldn't match with a pattern, is there an expicit 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 then
if (suggestions.suggestions[ k:lower() ] ~= nil) and validate (suggestions.suggestions[ k:lower() ], config.CitationClass) then
utilities.set_message ('err_parameter_ignored_suggest', {k, suggestions.suggestions[ k:lower() ]});
else
else
utilities.set_message ('err_parameter_ignored', {k});
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)
end
end
end
end
end
end
end
end
-- TODO: is this the best place for this translation?
args[k] = v; -- save this parameter and its value
elseif not utilities.is_set (v) then -- for empty parameters
if not validate (k, config.CitationClass, true) then -- is this empty parameter a valid parameter
end
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
end
-- crude debug support that allows us to render a citation from module {{#invoke:}} TODO: keep?
-- elseif args[k] ~= nil or (k == 'postscript') then -- when args[k] has a value from {{#invoke}} frame (we don't normally do that)
-- args[k] = v; -- overwrite args[k] with empty string from pframe.args[k] (template frame); v is empty string here
end -- not sure about the postscript bit; that gets handled in parameter validation; historical artifact?
end
end
if 0 ~= #empty_unknowns then -- create empty unknown error message
utilities.set_message ('err_param_unknown_empty', {
1 == #empty_unknowns and '' or 's',
utilities.make_sep_list (#empty_unknowns, empty_unknowns)
});
end
local url_param_t = {};
for k, v in pairs( args ) do
for k, v in pairs( args ) 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);
has_invisible_chars (k, v); -- look for invisible characters
end
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?
args[k] = inter_wiki_check (k, v); -- when language interwiki-linked parameter missing leading colon replace with wiki-link label
if 'string' == type (k) and not cfg.url_skip[k] then -- when parameter k is not positional and not in url skip table
url_param_t[k] = v; -- make a parameter/value list for extraneous url check
end
end
end
end
return table.concat ({citation0( config, args), frame:extensionTag ('templatestyles', '', {src=styles})});
has_extraneous_url (url_param_t); -- look for url in parameter values where a url does not belong
return table.concat ({
frame:extensionTag ('templatestyles', '', {src=styles}),
citation0( config, args)
});
end
end
--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------
--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------