Module:Citation/CS1: Difference between revisions

 

--[[--------------------------< F O R W A R D D E C L A R A T I O N S >--------------------------------------

 

local utilities; -- functions in Module:Citation/CS1/Utilities

 

local identifiers; -- functions and tables in Module:Citation/CS1/Identifiers

 

 

 

 

]]

local added_deprecated_cat; -- Boolean flag so that the category is added only once

local added_vanc_errs; -- Boolean flag so we only emit one Vancouver error / category

local Frame; -- holds the module's frame table

 

 

]]

 

end

 

end

 

if domain:match ('%f[%w][%w]%.' .. d) then

return true

 

local function link_title_ok (link, lorig, title, torig)

if utilities.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 utilities.is_set (orig) then

link = ''; -- unset

end

]]

 

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

end

end

end

local function safe_for_url( str )

if str:match( "%[%[.-%]%]" ) ~= nil then

end

]]

 

local domain;

local path;

local base_url;

 

label = URL;

else

end

end

end

domain, path = URL:match ('^([/%.%-%+:%a%d]+)([/%?#].*)$'); -- split the URL into scheme plus domain and path

if path then -- if there is a path portion

URL = table.concat ({domain, path}); -- and reassemble

end

 

 

if utilities.is_set (access) then -- access level (subscription, registration, limited)

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

 

if not added_deprecated_cat then

added_deprecated_cat = true; -- note that we've added this category

end

end

local function kern_quotes (str)

local cap = '';

local wl_type, label, link;

 

if 1 == wl_type then -- [[D]] simple wikilink with or without quote marks

if mw.ustring.match (str, '%[%[[\"“”\'‘’].+[\"“”\'‘’]%]%]') then -- leading and trailing quote marks

elseif mw.ustring.match (str, '%[%[[\"“”\'‘’].+%]%]') then -- leading quote marks

elseif mw.ustring.match (str, '%[%[.+[\"“”\'‘’]%]%]') then -- trailing quote marks

end

 

label = mw.ustring.gsub (label, '[‘’]', '\''); -- replace ‘’ (U+2018 & U+2019) with ' (typewriter single quote mark)

 

if utilities.is_set (cap) then

end

if utilities.is_set (cap) then

end

lang = script_value:match('^(%l%l%l?)%s*:%s*%S.*'); -- get the language prefix or nil if there is no script

if not utilities.is_set (lang) then

return ''; -- script_value was just the prefix so return empty string

end

-- 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

script_value = script_value:gsub ('^%l+%s*:%s*', ''); -- strip prefix from script

-- is prefix one of these language codes?

if utilities.in_array (lang, cfg.script_lang_codes) then

else

end

lang = ' lang="' .. lang .. '" '; -- convert prefix into a lang attribute

else

lang = ''; -- invalid so set lang to empty string

end

else

end

script_value = utilities.substitute (cfg.presentation['bdi'], {lang, script_value}); -- isolate in case script is RTL

--[[--------------------------< S C R I P T _ C O N C A T E N A T E >------------------------------------------

 

]]

 

 

local function format_periodical (script_periodical, script_periodical_source, periodical, trans_periodical)

 

if not utilities.is_set (periodical) then

else -- here when trans-periodical without periodical or script-periodical

periodical = trans_periodical;

end

end

 

end

 

 

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

if ws_url then

chapter = trans_chapter;

chapter_source = trans_chapter_source:match ('trans%-?(.+)'); -- when no chapter, get matching name from trans-<param>

end

end

 

end

 

local function has_invisible_chars (param, v)

local position = ''; -- position of invisible char or starting position of stripmarker

local capture; -- used by stripmarker detection to hold name of the stripmarker

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

end

 

if mw.ustring.find (v, cfg.indic_script) then -- it's ok if one of the Indic scripts

position = nil; -- unset position

end

('templatestyles' == capture and utilities.in_array (param, {'id', 'quote'})) then -- templatestyles stripmarker allowed in these parameters

stripmarker = true; -- set a flag

position = nil; -- unset

else

local err_msg;

else

end

 

return; -- and done with this parameter

end

end

end

end

return setmetatable({

ORIGIN = function ( self, k )

return origin[k];

end

v, origin[k] = utilities.select_one ( args, list, 'err_redundant_parameters' );

if origin[k] == nil then

end

elseif list ~= nil then

end

 

 

--[[--------------------------< S A F E _ J O I N >-----------------------------

trim = false;

end_chr = f.sub(str, -1, -1); -- get the last character of the output string

if end_chr == duplicate_char then -- if same as separator

elseif end_chr == "'" then -- if it might be wiki-markup

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]]''

end

elseif end_chr == "]" then -- if it might be wiki-markup

trim = true;

trim = true;

trim = true;

elseif f.sub(str, -4, -1) == duplicate_char .. "'']" then -- normal case when |url=something & |title=Title.

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>

end

end

end

end

end

end

--[[--------------------------< I S _ S U F F I X >-----------------------------

 

Puncutation not allowed.

 

 

For Vancouver style, author/editor names are supposed to be rendered in Latin

 

This test allows |first= and |last= names to contain any of the letters defined

]]

 

if not suffix then

if first:find ('[,%s]') then -- when there is a space or comma, might be first name/initials + generational suffix

if utilities.is_set (suffix) then

if not is_suffix (suffix) then

return false; -- not a name with an appropriate suffix

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

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

return false; -- not a string of Latin characters; Vancouver requires Romanization

end;

]]

 

local name, suffix = mw.ustring.match(first, "^(%u+) ([%dJS][%drndth]+)$");

 

return first; -- one or two initials and a valid suffix so nothing to do

else

return first; -- and return first unmolested

end

end

if 3 > i then

end

i = i + 1; -- bump the counter

return table.concat(initials) -- Vancouver format does not include spaces.

end

 

if ("vanc" == format) then -- if Vancouver format

one = one:gsub ('%.', ''); -- remove periods from surnames (http://www.ncbi.nlm.nih.gov/books/NBK7271/box/A35029/)

end

end

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

 

 

 

Generates a CITEREF anchor ID if we have at least one name or a date. Otherwise

]]

 

end

else

end

end

 

etal = true; -- set flag (may have been set previously here or by |display-<names>=etal)

if not nocat then -- no categorization for |vauthors=

end

end

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

 

 

 

 

]]

 

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

end

end

first, accept_name = utilities.has_accept_as_written (first); -- remove accept-this-as-written markup when it wraps all of <first>

 

name_is_numeric (first, list_name); -- check for names that are composed of digits and punctuation

end

end

 

--[[----------------------< E X T R A C T _ N A M E S >-------------------------

Gets name list from the input arguments

 

link, link_alias = utilities.select_one ( args, cfg.aliases[list_name .. '-Link'], 'err_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.

first, etal = name_has_etal (first, etal, false, first_alias); -- find and remove variations on et al.

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

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

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

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

n = n + 1; -- point to next location in the names table

if 1 == count then -- if the previous name was missing

end

count = 0; -- reset the counter, we're looking for two consecutive missing names

 

 

 

 

 

 

 

 

 

 

end

 

 

end

end

end

 

 

local function language_parameter (lang)

local name; -- the language name

local language_list = {}; -- table of language names to be rendered

 

local this_wiki_name = mw.language.fetchLanguageName (cfg.this_wiki_code, cfg.this_wiki_code); -- get this wiki's language name

 

 

 

 

end

elseif cfg.local_lang_cat_enable then -- when the language and this wiki's language are the same and categorization is enabled

end

else

utilities.set_message ('maint_unknown_lang'); -- add maint category if not already added

end

name = utilities.make_sep_list (#language_list, language_list);

return ''; -- if one language and that language is this wiki's return an empty string (no annotation)

end

 

 

 

 

]]

 

end

end

 

 

 

 

]]

 

local sep;

end

 

end

end

 

format = utilities.wrap_style ('format', format); -- add leading space, parentheses, resize

if not utilities.is_set (url) then

end

elseif is_pdf (url) then -- format is not set so if URL is a PDF file 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

max = tonumber (max); -- make it a number

if max >= count then -- if |display-xxxxors= value greater than or equal to number of authors/editors

max = nil;

end

else -- not a valid keyword or number

max = nil; -- unset; as if |display-xxxxors= had not been set

end

]]

 

 

end

end

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];

while name_table[i] do

name = name .. ', ' .. name_table[i]; -- concatenate with previous segments

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;

elseif string.find(v_name, "%s") then

if v_name:find('[;%.]') then -- look for commonly occurring punctuation characters;

end

local lastfirstTable = {}

first = ''; -- unset

last = v_name; -- last empty because something wrong with first

end

if mw.ustring.match (last, '%a+%s+%u+%s+%a+') then

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

end

else

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

end

if utilities.is_set (suffix) then

first = first .. ' ' .. suffix; -- if there was a suffix concatenate with the initials

else

if not corporate then

end

end

err_name = 'editor';

end

end

 

of the list of allowed values returns the translated value; else, emits an error message and returns the value

specified by ret_val.

 

]]

 

if not utilities.is_set (value) then

return ret_val; -- an empty parameter is ok

return cfg.keywords_xlate[value]; -- return translation of parameter keyword

else

return ret_val;

end

 

 

 

 

]]

return '';

end

end

 

if 'podcast' == cite_class and utilities.is_set (issue) then

return wrap_msg ('issue', {sepc, issue}, lower);

end

end

end

end

end

 

]]

 

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?)

 

at = '';

end

 

ws_url, ws_label, L = wikisource_url_make (page); -- make ws URL from |page= interwiki link; link portion L becomes tooltip label

at = ''; -- unset

end

 

ws_url, ws_label, L = wikisource_url_make (pages); -- make ws URL from |pages= interwiki link; link portion L becomes tooltip label

return page, pages, at, coins_pages;

end

 

else

path, timestamp, flag = url:match('//web%.archive%.org/([^%d]*)(%d+)([^/]*)/'); -- split out some of the URL parts for evaluation

err_msg = cfg.err_msg_supl.timestamp;

if '*' ~= flag then

end

elseif utilities.is_set (path) and 'web/' ~= path then -- older archive URLs do not have the extra 'web/' path element

end

-- if here, something not right so

return url, date; -- preview mode so return ArchiveURL and ArchiveDate

end

end

return param_val; -- and done

end

 

]]

 

--[[

Load Input Parameters

-- Pick out the relevant fields from the arguments. Different citation templates

-- define different field names for the same underlying things.

 

local author_etal;

local a = {}; -- authors list from |lastn= / |firstn= pairs or |vauthors=

local Authors;

local NameListStyle = is_valid_parameter_value (A['NameListStyle'], A:ORIGIN('NameListStyle'), cfg.keywords_lists['name-list-style'], '');

local Collaboration = A['Collaboration'];

a, author_etal = extract_names (args, 'AuthorList'); -- fetch author list from |authorn= / |lastn= / |firstn=, |author-linkn=, and |author-maskn=

elseif 2 == selected then

a, author_etal = parse_vauthors_veditors (args, args.vauthors, 'AuthorList'); -- fetch author list from |vauthors=, |author-linkn=, and |author-maskn=

elseif 3 == selected then

end

end

 

local editor_etal;

local e = {}; -- editors list from |editor-lastn= / |editor-firstn= pairs or |veditors=

 

do -- to limit scope of selected

end

end

local Chapter = A['Chapter']; -- done here so that we have access to |contribution= from |chapter= aliases

local Chapter_origin = A:ORIGIN ('Chapter');

local Contribution; -- because contribution is required for contributor(s)

end

if utilities.in_array (config.CitationClass, {"book", "citation"}) and not utilities.is_set (A['Periodical']) then -- |contributor= and |contribution= only supported in book cites

c = extract_names (args, 'ContributorList'); -- fetch contributor list from |contributorn= / |contributor-lastn=, -firstn=, -linkn=, -maskn=

if 0 < #c then

if not utilities.is_set (Contribution) then -- |contributor= requires |contribution=

c = {}; -- blank the contributors' table; it is used as a flag later

end

if 0 == #a then -- |contributor= requires |author=

c = {}; -- blank the contributors' table; it is used as a flag later

end

else -- if not a book cite

if utilities.select_one (args, cfg.aliases['ContributorList-Last'], 'err_redundant_parameters', 1 ) then -- are there contributor name list parameters?

end

Contribution = nil; -- unset

end

 

local Title = A['Title'];

local TitleLink = A['TitleLink'];

 

local auto_select = ''; -- default is auto

local accept_link;

if (not accept_link) and utilities.in_array (TitleLink, {'none', 'pmc', 'doi'}) then -- check for special keywords

end

 

 

local Section = ''; -- {{cite map}} only; preset to empty string for concatenation if not used

 

local Periodical = A['Periodical'];

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

end

end

 

if 'mailinglist' == config.CitationClass then -- special case for {{cite mailing list}}

end

 

 

local ScriptPeriodical = A['ScriptPeriodical'];

 

-- web and news not tested for now because of

local p = {['journal'] = 'journal', ['magazine'] = 'magazine'}; -- for error message

if p[config.CitationClass] then

end

end

local Volume;

if 'citation' == config.CitationClass then

if utilities.is_set (Periodical) then

Volume = A['Volume']; -- but does for all other 'periodicals'

end

Volume = A['Volume'];

end

 

if 'citation' == config.CitationClass then

end

elseif utilities.in_array (config.CitationClass, cfg.templates_using_issue) then -- conference & map books do not support issue; {{citation}} listed here because included in settings table

if not (utilities.in_array (config.CitationClass, {'conference', 'map', 'citation'}) and not (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical))) then

end

end

 

Page = A['Page'];

At = A['At'];

end

 

local Edition = A['Edition'];

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

end

end

if 'newsgroup' == config.CitationClass then

if utilities.is_set (PublisherName) then -- general use parameter |publisher= not allowed in cite newsgroup

end

 

end

 

local UrlAccess = is_valid_parameter_value (A['UrlAccess'], A:ORIGIN('UrlAccess'), 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;

end

 

if not utilities.is_set (A['MapURL']) and utilities.is_set (MapUrlAccess) then

MapUrlAccess = nil;

end

 

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

no_tracking_cats = "true"; -- set no_tracking_cats

end

local coins_pages;

 

local NoPP = is_valid_parameter_value (A['NoPP'], A:ORIGIN('NoPP'), cfg.keywords_lists['yes_true_y'], nil);

 

if utilities.is_set (PublicationPlace) and utilities.is_set (Place) then -- both |publication-place= and |place= (|location=) allowed if different

if PublicationPlace == Place then

Place = ''; -- unset; don't need both if they are the same

 

if PublicationPlace == Place then Place = ''; end -- don't need both if they are the same

--[[

if utilities.is_set (Encyclopedia) then -- emit error message when Encyclopedia set but template is other than {{cite encyclopedia}} or {{citation}}

if 'encyclopaedia' ~= config.CitationClass and 'citation' ~= config.CitationClass then

Encyclopedia = nil; -- unset because not supported by this template

end

 

if ('encyclopaedia' == config.CitationClass) or ('citation' == config.CitationClass and utilities.is_set (Encyclopedia)) then

end

 

TransChapter = TransTitle;

ChapterURL = URL;

 

ChapterUrlAccess = UrlAccess;

ScriptTitle = '';

end

Title = Periodical; -- |encyclopedia= set and |article= set so map |encyclopedia= to |title=

Periodical = ''; -- redundant so unset

 

-- special case for cite techreport.

if (config.CitationClass == "techreport") then -- special case for cite techreport

if utilities.is_set (A['Number']) then -- cite techreport uses 'number', which other citations alias to 'issue'

ID = A['Number']; -- yes, use it

else -- ID has a value so emit error message

end

end

 

-- Account for the oddity that is {{cite conference}}, before generation of COinS data.

if 'conference' == config.CitationClass then

if utilities.is_set (BookTitle) then

Conference = ''; -- not cite conference or cite speech so make sure this is empty string

end

-- cite map oddities

local Cartography = "";

local Sheets = A['Sheets'] or '';

if config.CitationClass == "map" then

end

Chapter = A['Map'];

 

-- Account for the oddities that are {{cite episode}} and {{cite serial}}, before generation of COinS data.

if 'episode' == config.CitationClass or 'serial' == config.CitationClass then

local SeriesLink = A['SeriesLink'];

local SeriesNumber = A['SeriesNumber'];

 

SeriesNumber = ''; -- unset; prefer |season= over |seriesno=

end

ChapterURL = URL;

ChapterUrlAccess = UrlAccess;

Title = Series; -- promote series to title

TitleLink = SeriesLink;

TransTitle = '';

ScriptTitle = '';

else -- now oddities that are cite serial

 

-- handle type parameter for those CS1 citations that have default values

TitleType = set_titletype (config.CitationClass, TitleType);

if utilities.is_set (Degree) and "Thesis" == TitleType then -- special case for cite thesis

 

-- legacy: promote PublicationDate to Date if neither Date nor Year are set.

local Date_origin; -- to hold the name of parameter promoted to Date; required for date error messaging

 

if not utilities.is_set (Date) then

Date validation supporting code is in Module:Citation/CS1/Date_validation

]]

do -- create defined block to contain local variables error_message, date_parameters_list, mismatch

local error_message = '';

-- start temporary Julian / Gregorian calendar uncertainty categorization

if COinS_date.inter_cal_cat then

end

-- end temporary Julian / Gregorian calendar uncertainty categorization

 

if utilities.is_set (Year) and utilities.is_set (Date) then -- both |date= and |year= not normally needed;

end

end

 

if modified then -- if the date_parameters_list values were modified

end

else

end

end -- end of do

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

 

 

-- Account for the oddities that are {{cite arxiv}}, {{cite biorxiv}}, {{cite citeseerx}}, {{cite ssrn}}, before generation of COinS data.

end

 

 

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

URL = identifiers.auto_link_urls['doi'];

URL_origin = cfg.id_handlers['DOI'].parameters[1];

end

 

end

end

-- Test if citation has no title

if not utilities.is_set (Title) and not utilities.is_set (TransTitle) and not utilities.is_set (ScriptTitle) then -- has special case for cite episode

end

 

utilities.set_message ('maint_untitled'); -- add maint cat

end

 

-- COinS metadata (see <http://ocoins.info/>) for automated parsing of citation information.

coins_author = c; -- use that instead

end

-- this is the function call to COinS()

local OCinSoutput = metadata.COinS({

['Periodical'] = utilities.strip_apostrophe_markup (Periodical), -- no markup in the metadata

['Encyclopedia'] = Encyclopedia, -- just a flag; content ignored by ~/COinS

['Degree'] = Degree; -- cite thesis only

['PublicationPlace'] = PublicationPlace,

['Date'] = COinS_date.rftdate, -- COinS_date has correctly formatted date if Date is valid;

['Volume'] = Volume,

['Issue'] = Issue,

['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,

end

 

-- Now perform various field substitutions.

-- We also add leading spaces and surrounding markup and punctuation to the

-- various parts of the citation, but only when they are non-nil.

do

local last_first_list;

 

do -- do editor name list first because the now unsupported coauthors used to modify control table

Editors, EditorCount = list_people (control, e, editor_etal);

 

end

do -- now do interviewers

Interviewers = list_people (control, interviewers_list, interviewer_etal);

end

do -- now do translators

Translators = list_people (control, t, translator_etal);

end

do -- now do contributors

Contributors = list_people (control, c, contributor_etal);

end

do -- now do authors

 

 

if utilities.is_set (Authors) then

end

 

ConferenceFormat = style_format (ConferenceFormat, ConferenceURL, 'conference-format', 'conference-url');

Format = style_format (Format, URL, 'format', 'url');

 

-- special case for chapter format so no error message or cat when chapter not supported

if 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=

end

-- do we have |accessdate= without either |url= or |chapter-url=?

if utilities.is_set (AccessDate) and not utilities.is_set (ChapterURL) then -- ChapterURL may be set when URL is not set;

AccessDate = '';

end

end

 

UrlStatus = UrlStatus:lower(); -- used later when assembling archived text

if utilities.is_set ( ArchiveURL ) then

UrlAccess = nil; -- restricted access levels do not make sense for archived URLs

end

end

 

 

if utilities.is_set (chap_param) then -- if we found one

Chapter = ''; -- and set them to empty string to be safe with concatenation

TransChapter = '';

end

 

if '...' == Title:sub (-3) then -- if ellipsis is the last three characters of |title=

Title = Title:gsub ('(%.%.%.)%.+$', '%1'); -- limit the number of dots to three

end

 

end

end

Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped

TransTitle = utilities.wrap_style ('trans-quoted-title', TransTitle );

Title = script_concatenate (Title, ScriptTitle, 'script-title'); -- <bdi> tags, lang attribute, categorization, etc.; must be done after title is wrapped

else

Title = utilities.wrap_style ('italic-title', Title);

end

 

if utilities.is_set (TransTitle) then

if utilities.is_set (Title) then

TransTitle = " " .. TransTitle;

else

end

end

if utilities.is_set (Title) then -- TODO: is this the right place to be making Wikisource URLs?

if utilities.is_set (TitleLink) and utilities.is_set (URL) then

TitleLink = ''; -- unset

end

if not utilities.is_set (TitleLink) and utilities.is_set (URL) then

URL = ''; -- unset these because no longer needed

Format = "";

Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title-link'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?

Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], TitleLink, Title});

else

end

else

Title = external_link (ws_url, Title .. '&nbsp;', 'ws link in title'); -- space char after Title to move icon away from italic text; TODO: a better way to do this?

Title = utilities.substitute (cfg.presentation['interwiki-icon'], {cfg.presentation['class-wikisource'], L, Title});

else

end

end

else

end

 

end

 

if utilities.is_set (Conference) then

if utilities.is_set (ConferenceURL) then

end

 

if not utilities.is_set (Position) then

local Minutes = A['Minutes'];

 

if utilities.is_set (Minutes) then

end

Position = " " .. Minutes .. " " .. cfg.messages['minutes'];

end

 

end

Others = utilities.is_set (Others) and (sepc .. " " .. Others) or "";

end

TitleNote = utilities.is_set (TitleNote) and (sepc .. " " .. TitleNote) or "";

if utilities.is_set (Edition) then

if Edition:match ('%f[%a][Ee]d%n?%.?$') or Edition:match ('%f[%a][Ee]dition$') then -- Ed, ed, Ed., ed., Edn, edn, Edn., edn.

end

Edition = " " .. wrap_msg ('edition', Edition);

 

Series = utilities.is_set (Series) and wrap_msg ('series', {sepc, Series}) or ""; -- not the same as SeriesNum

Agency = utilities.is_set (Agency) and wrap_msg ('agency', {sepc, Agency}) or "";

 

if utilities.is_set (AccessDate) then

if utilities.is_set (ID) then ID = sepc .. " " .. ID; end

if "thesis" == config.CitationClass and utilities.is_set (Docket) then

ID = sepc .. " Docket " .. Docket .. ID;

end

 

if utilities.is_set (Quote) or utilities.is_set (TransQuote) or utilities.is_set (ScriptQuote) then

 

end

end

if utilities.is_set (ScriptQuote) then

end

 

end

 

local quote_prefix = '';

if utilities.is_set (QuotePage) then

if not NoPP then

quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePage}), '', '', '';

end

elseif utilities.is_set (QuotePages) then

if tonumber(QuotePages) ~= nil and not NoPP then -- if only digits, assume single page

quote_prefix = utilities.substitute (cfg.messages['p-prefix'], {sepc, QuotePages}), '', '';

end

if utilities.is_set (ArchiveURL) then

local arch_text;

if not utilities.is_set (ArchiveDate) then

end

if "live" == UrlStatus then

arch_text = cfg.messages['archived'];

if sepc ~= "." then arch_text = arch_text:lower() end

if not utilities.is_set (OriginalURL) then

end

elseif utilities.is_set (OriginalURL) then -- UrlStatus is empty, 'dead', 'unfit', 'usurped', 'bot: unknown'

arch_text = cfg.messages['archived-unfit'];

if sepc ~= "." then arch_text = arch_text:lower() end

if 'bot: unknown' == UrlStatus then

utilities.set_message ('maint_bot_unknown'); -- and add a category if not already added

arch_text = cfg.messages['archived-dead'];

if sepc ~= "." then arch_text = arch_text:lower() end

end

else -- OriginalUrl not set

arch_text = cfg.messages['archived-missing'];

if sepc ~= "." then arch_text = arch_text:lower() end

end

elseif utilities.is_set (ArchiveFormat) then

Archived = ArchiveFormat; -- if set and ArchiveURL not set ArchiveFormat has error message

else

end

local Lay = '';

if utilities.is_set (LayURL) then

if utilities.is_set (LayDate) then LayDate = " (" .. LayDate .. ")" end

end

 

if utilities.is_set (Transcript) then

if utilities.is_set (TranscriptURL) then

end

-- Several of the above rely upon detecting this as nil, so do it last.

if (utilities.is_set (Periodical) or utilities.is_set (ScriptPeriodical) or utilities.is_set (TransPeriodical)) then

Periodical = format_periodical (ScriptPeriodical, ScriptPeriodical_origin, Periodical, TransPeriodical, TransPeriodical_origin);

end

end

 

]]

if "speech" == config.CitationClass then -- cite speech only

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

if utilities.in_array (config.CitationClass, {"journal", "citation"}) and utilities.is_set (Periodical) then

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 );

end

local idcommon;

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;

 

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

if utilities.is_set (Date) then

if EditorCount <= 1 then

else

end

else

text = safe_join( {text, PostScript}, sepc );

 

 

end

end

end

end

 

else

end

 

 

end

end

end

 

end

end

if not no_tracking_cats then

end

end

end

end

 

end

 

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

if prefix and cfg.inter_wiki_map[prefix:lower()] then -- if prefix is in the map, needs preceding colon so

_, value, _ = utilities.is_wikilink (value); -- extract label portion from wikilink

end

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

end

end

if value:match ('[,;:]$') then

utilities.set_message ('maint_extra_punct'); -- has extraneous punctuation; add maint cat

end

end

local function citation(frame)

Frame = frame; -- save a copy in case we need to display an error message in preview mode

local pframe = frame:getParent()

local styles;

 

utilities.set_selected_modules (cfg); -- so that functions in Utilities can see the selected cfg tables

 

z = utilities.z; -- table of error and category tables in Module:Citation/CS1/Utilities

 

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 capture; -- the single supported capture when matching unknown parameters using patterns

end

if not validate( k, config.CitationClass ) then

if v:match("%S+") ~= nil then

end

else

if nil == suggestions.suggestions then -- if this table is nil then we need to load it

end

for pattern, param in pairs (suggestions.patterns) do -- loop through the patterns to see if we can suggest a proper parameter

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)

else

v = ''; -- unset

end

end

end

else

v = ''; -- unset value assigned to unrecognized parameters (this for the limited parameter lists)

end

end

end

end

 

 

if 0 ~= #empty_unknowns then -- create empty unknown error message

1 == #empty_unknowns and '' or 's',

utilities.make_sep_list (#empty_unknowns, empty_unknowns)

end

 

for k, v in pairs( args ) do

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

end

 

return table.concat ({

});

end

 

--[[--------------------------< E X P O R T E D F U N C T I O N S >------------------------------------------