Module:Citation/CS1/Whitelist/sandbox: Difference between revisions

Revision as of 15:12, 15 April 2021

Latest revision as of 22:48, 17 August 2024

(68 intermediate revisions by 8 users not shown)

Line 1:

--[[

History of changes since last sync: 20212024-0408-1017

2021-04-15: Remove support for previously deprecated parameters |booktitle=, |chapterurl=, |episodelink=, |mailinglist=, |mapurl=, |nopp=, |publicationdate=, |publicationplace=, |serieslink=, |transcripturl=

2021-04-15: Reinstate "true" value for previously "discouraged" parameters per RFC reclose: {{oldid2|1017952182|RFC:_Citation_Style_1_parameter_naming_convention|RFC reclose}}

]]

--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------

Line 12 ⟶ 11:

true - these parameters are valid and supported parameters

false - these parameters are deprecated but still supported

tracked - these parameters are valid and supported parameters tracked in an eponymous properties category

discouraged - pre-deprecation purgatory; may someday be deprecated; or not

nil - these parameters are no longer supported. remove entirely

]]

local basic_argumentsbasic_arguments_t = {

['accessdate'] = 'true',

['access-date'] = true,

['agency'] = true,

['archivedate'] = 'true',

['archive-date'] = true,

['archive-format'] = true,

['archiveurl'] = 'true',

['archive-url'] = true,

['article'] = true,

['article-format'] = true,

['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value

['article-url'] = true,

['article-url-access'] = true,

Line 40:

['author-last'] = true,

['author-surname'] = true,

['authorlink'] = 'true',

['author-link'] = true,

['author-mask'] = true,

['authors'] = true,

['bibcode'] = true,

['bibcode-access'] = true,

['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier

['book-title'] = true,

['cartography'] = true,

['chapter'] = true,

['chapter-format'] = true,

Line 55 ⟶ 52:

['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier

['collaboration'] = true,

['conference'] = true,

['conference-format'] = true,

['conference-url'] = true,

['contribution'] = true,

['contribution-format'] = true,

Line 70 ⟶ 64:

['contributor-mask'] = true,

['date'] = true,

['degree'] = true,

['department'] = true,

['df'] = true,

Line 80 ⟶ 73:

['display-subjects'] = true,

['display-translators'] = true,

['docket'] = true,

['doi'] = true,

['DOI'] = true,

Line 102 ⟶ 94:

['entry-url-access'] = true,

['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier

['event'] = true, -- synonym of conference in /Config, but used in Cite speech?

['first'] = true,

['format'] = true,

Line 109 ⟶ 100:

['HDL'] = true,

['hdl-access'] = true,

['host'] = true, -- unique to certain templates?

['id'] = true,

['ID'] = true,

['institution'] = true, -- constrain to cite thesis?

['interviewer'] = true,

['interviewer-first'] = true,

Line 122 ⟶ 113:

['isbn'] = true,

['ISBN'] = true,

['isbn13'] = true,

['ISBN13'] = true,

['ismn'] = true,

['ISMN'] = true,

Line 138 ⟶ 127:

['language'] = true,

['last'] = true,

['lay-date'] = true,

['lay-source'] = true,

['lay-format'] = true,

['lay-url'] = true,

['lccn'] = true,

['LCCN'] = true,

Line 147 ⟶ 132:

['magazine'] = true,

['medium'] = true,

['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier

['minutes'] = true,

['minutes'] = true, -- constrain to cite AV media and podcast?

['mode'] = true,

['mr'] = true,

Line 162 ⟶ 148:

['ol-access'] = true,

['orig-date'] = true,

['origyear'] = 'true',

['orig-year'] = true,

['osti'] = true,

Line 171 ⟶ 157:

['page'] = true,

['pages'] = true,

['people'] = true,

['periodical'] = true,

['place'] = true,

Line 197 ⟶ 182:

['script-chapter'] = true,

['script-contribution'] = true,

['script-encyclopaedia'] = true,

['script-encyclopedia'] = true,

['script-entry'] = true,

['script-journal'] = true,

Line 207 ⟶ 194:

['script-website'] = true,

['script-work'] = true,

['season'] = true,

['section'] = true,

['section-format'] = true,

Line 213 ⟶ 199:

['section-url-access'] = true,

['series'] = true,

['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier

['series-link'] = true,

['series-no'] = true,

['series-number'] = true,

['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier

['SSRN'] = true,

['ssrn-access'] = true,

['subject'] = true,

['subject-first'] = true,

['subject-given'] = true,

['subject-last'] = true,

['subject-link'] = true,

['subject-mask'] = true,

['subject-surname'] = true,

['surname'] = true,

['s2cid'] = true,

Line 226 ⟶ 214:

['s2cid-access'] = true,

['template-doc-demo'] = true,

['time'] = true, -- constrain to cite av media and podcast?

['time-caption'] = true, -- constrain to cite av media and podcast?

['title'] = true,

['title-link'] = true,

['title-note'] = true,

['translator'] = true,

['translator-first'] = true,

Line 240 ⟶ 229:

['trans-chapter'] = true,

['trans-contribution'] = true,

['trans-encyclopaedia'] = true,

['trans-encyclopedia'] = true,

['trans-entry'] = true,

['trans-journal'] = true,

Line 265 ⟶ 256:

['zbl'] = true,

['ZBL'] = true,

}

local numbered_argumentsnumbered_arguments_t = {

['author#'] = true,

['author-first#'] = true,

Line 279 ⟶ 270:

['author-link#'] = true,

['author#-link'] = true,

['authorlink#'] = 'true',

['author#link'] = 'true',

['author-mask#'] = true,

['author#-mask'] = true,

Line 327 ⟶ 318:

['last#'] = true,

['subject#'] = true,

['subject-first#'] = true,

['subject#-first'] = true,

['subject-given#'] = true,

['subject#-given'] = true,

['subject-last#'] = true,

['subject#-last'] = true,

['subject-link#'] = true,

['subject#-link'] = true,

['subject-mask#'] = true,

['subject#-mask'] = true,

['subject-surname#'] = true,

['subject#-surname'] = true,

['surname#'] = true,

['translator#'] = true,

Line 345 ⟶ 344:

['translator-mask#'] = true,

['translator#-mask'] = true,

}

--[[--------------------------< P R E P R I N T S U P P O R T E D P A R A M E T E R S >--------------------

Cite arXiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn are preprint templates that use the limited set of parameters

set of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a

supplemented with a template-specific list of parameters that are required by the particular template and may be exclusive to one of the

exclusive to one of the preprint templates. Some of these parameters may also be available to the general cs1|2
templates.

Same conventions for true/false/dicouragedtracked/nil as above.

]]

local preprint_argumentspreprint_arguments_t = {

arxiv = {

['arxiv'] = true, -- cite arxiv and arxiv identifiers

Line 370:

citeseerx = {

['citeseerx'] = true,

},

medrxiv = {

['medrxiv'] = true,

},

ssrn = {

['ssrn'] = true,

['SSRN'] = true,

['ssrn-access'] = true,

},

}

Line 380 ⟶ 384:

--[[--------------------------< L I M I T E D S U P P O R T E D P A R A M E T E R S >----------------------

cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn templates are preprint templates so are allowed only a

allowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined
here.

This list of parameters also used by {{cite document}}

Same conventions for true/false/dicouragedtracked/nil as above.

]]

local limited_basic_argumentslimited_basic_arguments_t = {

['at'] = true,

['author'] = true,

Line 395 ⟶ 402:

['author-surname'] = true,

['author-link'] = true,

['authorlink'] = 'true',

['author-mask'] = true,

['authors'] = true,

['collaboration'] = true,

['date'] = true,

Line 421 ⟶ 427:

['title'] = true,

['trans-title'] = true,

['url'] = true,

['URL'] = true,

['vauthors'] = true,

['year'] = true,

}

local limited_numbered_argumentslimited_numbered_arguments_t = {

['author#'] = true,

['author-first#'] = true,

Line 439 ⟶ 443:

['author-link#'] = true,

['author#-link'] = true,

['authorlink#'] = 'true',

['author#link'] = 'true',

['author-mask#'] = true,

['author#-mask'] = true,

Line 455 ⟶ 459:

table are the template's CitationClass parameter value

Same conventions for true/false/dicouragedtracked/nil as above.

]]

local unique_argumentsunique_arguments_t = {

['audio-visual'] = {

['people'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcript-url'] = true,

},

conference = {

['book-title'] = true,

['conference'] = true,

['conference-format'] = true,

['conference-url'] = true,

['event'] = true,

},

episode = {

['airdate'] = 'true',

['air-date'] = true,

['credits'] = true,

['episode-link'] = true, -- alias of |title-link=

['network'] = true,

['people'] = true,

['season'] = true,

['series-link'] = true,

['series-no'] = true,

['series-number'] = true,

['station'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcripturl'] = false,

['transcript-url'] = true,

},

Line 481 ⟶ 497:

},

map = {

['cartography'] = true,

['inset'] = true,

['map'] = true,

Line 495 ⟶ 512:

['message-id'] = true,

['newsgroup'] = true,

},

report = {

['docket'] = true,

},

serial = {

['airdate'] = 'true',

['air-date'] = true,

['credits'] = true,

['episode'] = true, -- cite serial only TODO: make available to cite episode?

['episodelink'] = false,

['episode-link'] = true, -- alias of |title-link=

['network'] = true,

['people'] = true,

['series-link'] = true,

['station'] = true,

},

speech = {

['conference'] = true,

['conference-format'] = true,

['conference-url'] = true,

['event'] = true,

},

thesis = {

['degree'] = true,

['docket'] = true,

},

}

--[[--------------------------< C I T E _ D O C U M E N T >----------------------------------------------------

Special case for cite document. This template takes the limited basic and limited enumerated parameters plus

others that are apply only to standalone published sources that cannot be cited any other way; no url, book,

periodical, etc parameters; limited support for name lists and named identifiers.

when validating parameters in {{cite document}} templates, the basic and

]]

local document_arguments_t = {

['bibcode'] = true,

['bibcode-access'] = true,

['doi'] = true,

['DOI'] = true,

['doi-access'] = true,

['doi-broken-date'] = true,

['hdl'] = true,

['HDL'] = true,

['hdl-access'] = true,

['id'] = true,

['ID'] = true,

['jfm'] = true,

['JFM'] = true,

['lang'] = true,

['___location'] = true,

['mr'] = true,

['MR'] = true,

['no-pp'] = true,

['orig-date'] = true,

['origyear'] = true,

['orig-year'] = true,

['osti'] = true,

['OSTI'] = true,

['osti-access'] = true,

['place'] = true,

['publisher'] = true,

['quote-page'] = true,

['quote-pages'] = true,

['script-quote'] = true,

['script-title'] = true,

['title-link'] = true,

['translator'] = true,

['translator-first'] = true,

['translator-given'] = true,

['translator-last'] = true,

['translator-surname'] = true,

['translator-link'] = true,

['translator-mask'] = true,

['trans-quote'] = true,

['type'] = true,

['zbl'] = true,

['ZBL'] = true,

}

local document_numbered_arguments_t = {

['translator#'] = true,

['translator-first#'] = true,

['translator#-first'] = true,

['translator-given#'] = true,

['translator#-given'] = true,

['translator-last#'] = true,

['translator#-last'] = true,

['translator-surname#'] = true,

['translator#-surname'] = true,

['translator-link#'] = true,

['translator#-link'] = true,

['translator-mask#'] = true,

['translator#-mask'] = true,

}

--[[--------------------------< L I S T _ C O M B I N E >------------------------------------------------------

makes one table from a list of tables. <lists_t> is a sequence of tables to be combined

]]

local function list_combine (lists_t)

local out_t = {};

for _, list_t in ipairs (lists_t) do -- for each list in <lists_t>

for k, v in pairs (list_t) do -- extract each k/v pair

out_t[k] = v; -- add to <out_t>

end

end

return out_t; -- and done

end

Line 516 ⟶ 637:

local function template_list_get (t)

local outout_t = {}; -- a table for output

for k, _ in pairs (t) do -- spin through the table and collect the keys

table.insert (outout_t, k) -- add each key to the output table

end

return outout_t; -- and done

end

Line 528 ⟶ 649:

return {

preprint_arguments_t = preprint_arguments_t,

basic_arguments = basic_arguments,

preprint_template_list_t = template_list_get (preprint_arguments_t), -- make a template list from preprint_arguments{} table

numbered_arguments = numbered_arguments,

unique_arguments_t = unique_arguments_t,

limited_basic_arguments = limited_basic_arguments,

unique_param_template_list_t = template_list_get (unique_arguments_t), -- make a template list from unique_arguments{} table

limited_numbered_arguments = limited_numbered_arguments,

document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});

preprint_arguments = preprint_arguments,

common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});

preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table

limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});

unique_arguments = unique_arguments,

unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table

};