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

Revision as of 17:21, 27 September 2020

Latest revision as of 22:48, 17 August 2024

(97 intermediate revisions by 9 users not shown)

Line 1:

--[[

History of changes since last sync: 20202024-0708-1117

2020-07-16: deprecate editors; see Help_talk:Citation_Style_1#Editors

2020-07-26: add |subject-mask= parameters; deprecate non-hyphenated subjectlink params; see Help_talk:Citation_Style_1#%7Csubject-link%3D_and_%7Csubject-mask%3D

2020-09-02: add orig-date parameter; see Help_talk:Citation_Style_1#cite_news_should_have_two_dates

2020-09-09: remove support for |series-separator=; see Help_talk:Citation_Style_1#last-author-amp%3D

2020-09-10: remove support for |ignoreisbnerror=, |doi-broken=, |doi-inactive-date= and rename |embargo= to |pmc-embargo-date=; see Help_talk:Citation_Style_1#Deprecating_some_unused_parameter_aliases

2020-09-10: remove support for |interviewerlink= and |interviewermask=; add support for missing aliases |author-given=, |author-surname=, |author-given#=, |author#-given=, |author-surname#=, |author#-surname=, |interviewer-given#=, |interviewer#-given=, |interviewer-surname#=, |interviewer#-surname=, |display-subjects=; see Help_talk:Citation_Style_1#name-given= and -surname parameter variants

2020-09-11: moved |transcript=, |transcript-format=, |transcripturl=,|transcript-url=, and |inset= to unique arguments table; see Help_talk:Citation_Style_1#transcript

2020-09-11: moved |mailinglist=, |mailing-list= to unique arguments table; see Help_talk:Citation_Style_1#mailinglist

2020-09-16: remove support for unused aliases |displayeditors=, |editormask= and enumerated forms; see Help_talk:Citation_Style_1#name-given= and -surname parameter variants

2020-09-19: deprecate |displayauthors= as well as |editorlink=, |authormask= and enumerated forms; see Help_talk:Citation_Style_1#name-given=_and_-surname_parameter_variants

2020-09-19: deprecate |ignore-isbn-error; see Help_talk:Citation_Style_1#Replacing_ignore-isbn-error=_and_doi-broken=_by_isbn/doi=((invalid-value))_syntax

2020-09-22: remove support for unused aliases |notracking= and |no-cat=, made |no-tracking= the canonical form for now; see Help_talk:Citation_Style_1#no-cat_parameter_cleanup

2020-09-27: add trans/script/pages support for quotes; see Help_talk:Citation_Style_1#trans-quote?

]]

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

Line 22 ⟶ 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

nil - these parameters are no longer supported. remove entirely

]]

local basic_argumentsbasic_arguments_t = {

['accessdate'] = true,

['access-date'] = true,

Line 37 ⟶ 27:

['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 51 ⟶ 42:

['authorlink'] = true,

['author-link'] = true,

['authormask'] = false, -- deprecated

['author-mask'] = true,

['authors'] = true,

['bibcode'] = true,

['bibcode-access'] = true,

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

['booktitle'] = true,

['book-title'] = true,

['cartography'] = true,

['chapter'] = true,

['chapter-format'] = true,

['chapterurl'] = true,

['chapter-url'] = true,

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

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

['collaboration'] = true,

['conference'] = true,

['conference-format'] = true,

['conferenceurl'] = true,

['conference-url'] = true,

['contribution'] = true,

['contribution-format'] = true,

['contributionurl'] = true,

['contribution-url'] = true,

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

Line 84 ⟶ 64:

['contributor-mask'] = true,

['date'] = true,

['degree'] = true,

['department'] = true,

['df'] = true,

['dictionary'] = true,

['displayauthors'] = false, -- deprecated

['display-authors'] = true,

['display-contributors'] = true,

Line 95 ⟶ 73:

['display-subjects'] = true,

['display-translators'] = true,

['docket'] = true,

['doi'] = true,

['DOI'] = true,

Line 106 ⟶ 83:

['editor-last'] = true,

['editor-surname'] = true,

['editorlink'] = false, -- deprecated

['editor-link'] = true,

['editor-mask'] = true,

['editors'] = false, -- deprecated

['eissn'] = true,

['EISSN'] = true,

Line 119 ⟶ 94:

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

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

['event'] = true,

['event-format'] = true,

['eventurl'] = true,

['event-url'] = true,

['first'] = true,

['format'] = true,

Line 129 ⟶ 100:

['HDL'] = true,

['hdl-access'] = true,

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

['id'] = true,

['ID'] = true,

['ignore-isbn-errorinstitution'] = falsetrue, -- deprecatedconstrain to cite thesis?

['institution'] = true,

['interviewer'] = true,

['interviewer-first'] = true,

Line 143 ⟶ 113:

['isbn'] = true,

['ISBN'] = true,

['isbn13'] = true,

['ISBN13'] = true,

['ismn'] = true,

['ISMN'] = true,

Line 159 ⟶ 127:

['language'] = true,

['last'] = true,

['lastauthoramp'] = false, -- deprecated

['last-author-amp'] = false, -- deprecated

['laydate'] = true,

['lay-date'] = true,

['laysource'] = true,

['lay-source'] = true,

['lay-format'] = true,

['layurl'] = true,

['lay-url'] = true,

['lccn'] = true,

['LCCN'] = true,

Line 173 ⟶ 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,

['MR'] = true,

['name-list-formatstyle'] = true,

['newspaper'] = true,

['nocat'] = true,

['nopp'] = true,

['no-pp'] = true,

['no-tracking'] = true,

Line 199 ⟶ 157:

['page'] = true,

['pages'] = true,

['people'] = true,

['periodical'] = true,

['place'] = true,

Line 209 ⟶ 166:

['postscript'] = true,

['pp'] = true,

['publicationdate'] = true,

['publication-date'] = true,

['publicationplace'] = true,

['publication-place'] = true,

['publisher'] = true,

Line 227 ⟶ 182:

['script-chapter'] = true,

['script-contribution'] = true,

['script-encyclopaedia'] = true,

['script-encyclopedia'] = true,

['script-entry'] = true,

['script-journal'] = true,

Line 237 ⟶ 194:

['script-website'] = true,

['script-work'] = true,

['season'] = true,

['section'] = true,

['section-format'] = true,

['sectionurl'] = true,

['section-url'] = true,

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

['series'] = true,

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

['serieslink'] = true,

['series-link'] = true,

['seriesno'] = true,

['series-no'] = true,

['seriesnumber'] = 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,

['subjectlink'] = false, -- deprecated

['subject-given'] = true,

['subject-last'] = true,

['subject-link'] = true,

['subject-mask'] = true,

['subject-surname'] = true,

['surname'] = true,

['s2cid'] = true,

Line 261 ⟶ 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?

['timecaption'] = true,

['time-caption'] = true,

['title'] = true,

['titlelink'] = true,

['title-link'] = true,

['title-note'] = true,

['translator'] = true,

['translator-first'] = true,

Line 277 ⟶ 229:

['trans-chapter'] = true,

['trans-contribution'] = true,

['trans-encyclopaedia'] = true,

['trans-encyclopedia'] = true,

['trans-entry'] = true,

['trans-journal'] = true,

Line 302 ⟶ 256:

['zbl'] = true,

['ZBL'] = true,

}

local numbered_argumentsnumbered_arguments_t = {

['author#'] = true,

['author-first#'] = true,

Line 320 ⟶ 274:

['author-mask#'] = true,

['author#-mask'] = true,

['authormask#'] = false, -- deprecated

['author#mask'] = false, -- deprecated

['contributor#'] = true,

['contributor-first#'] = true,

Line 346 ⟶ 298:

['editor-link#'] = true,

['editor#-link'] = true,

['editorlink#'] = false, -- deprecated

['editor#link'] = false, -- deprecated

['editor-mask#'] = true,

['editor#-mask'] = true,

Line 368 ⟶ 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,

['subjectlink#'] = false, -- deprecated

['subject#link'] = false, -- deprecated

['subject-mask#'] = true,

['subject#-mask'] = true,

['subject-surname#'] = true,

['subject#-surname'] = true,

['surname#'] = true,

['translator#'] = true,

Line 388 ⟶ 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/tracked/nil as above.

]]

local preprint_argumentspreprint_arguments_t = {

arxiv = {

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

Line 413 ⟶ 370:

citeseerx = {

['citeseerx'] = true,

},

medrxiv = {

['medrxiv'] = true,

},

ssrn = {

['ssrn'] = true,

['SSRN'] = true,

['ssrn-access'] = true,

},

}

Line 423 ⟶ 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

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the

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

parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates. These parameters are common to

here.

all three templates

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

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

]]

local limited_basic_argumentslimited_basic_arguments_t = {

['at'] = true,

['author'] = true,

Line 441 ⟶ 404:

['authorlink'] = true,

['author-mask'] = true,

['authormask'] = false, -- deprecated

['authors'] = true,

['collaboration'] = true,

['date'] = true,

['df'] = true,

['display-authors'] = true,

['displayauthors'] = false, -- deprecated

['first'] = true,

['given'] = true,

['language'] = true,

['last'] = true,

['last-author-amp'] = false, -- deprecated

['lastauthoramp'] = false, -- deprecated

['mode'] = true,

['name-list-formatstyle'] = true,

['nocat'] = true,

['no-tracking'] = true,

['p'] = true,

Line 470 ⟶ 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 492 ⟶ 447:

['author-mask#'] = true,

['author#-mask'] = true,

['authormask#'] = false, -- deprecated

['author#mask'] = false, -- deprecated

['first#'] = true,

['given#'] = true,

Line 506 ⟶ 459:

table are the template's CitationClass parameter value

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

]]

local unique_argumentsunique_arguments_t = {

['audio-visual'] = {

['people'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcripturl'] = true,

['transcript-url'] = true,

},

conference = {

['book-title'] = true,

['conference'] = true,

['conference-format'] = true,

['conference-url'] = true,

['event'] = true,

},

episode = {

Line 521 ⟶ 481:

['air-date'] = true,

['credits'] = true,

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

['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'] = true,

['transcript-url'] = true,

},

mailinglist = {

['mailinglist'] = true,

['mailing-list'] = true,

},

map = {

['cartography'] = true,

['inset'] = true,

['map'] = true,

['map-format'] = true,

['mapurl'] = true,

['map-url'] = true,

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

Line 550 ⟶ 512:

['message-id'] = true,

['newsgroup'] = true,

},

report = {

['docket'] = true,

},

serial = {

Line 556 ⟶ 521:

['credits'] = true,

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

['episodelinkepisode-link'] = true, -- aliasesalias of |title-link=

['episode-link'] = true,

['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 571 ⟶ 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 583 ⟶ 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

};