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

Revision as of 10:58, 4 September 2020

Latest revision as of 22:48, 17 August 2024

(118 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-08-23: add |title-doi= and |chapter-doi= parameters to allow users to be specific about DOI type as we may need to distinguish between them in the future; see Help_talk:Citation_Style_1#Auto-linking_for_book_chapters

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

]]

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

Line 13 ⟶ 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 whitelistbasic_arguments_t = {}

local basic_arguments = {

['accessdate'] = true,

['access-date'] = true,

Line 30 ⟶ 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 39 ⟶ 37:

['author'] = true,

['author-first'] = true,

['author-given'] = true,

['author-last'] = true,

['author-surname'] = true,

['authorlink'] = true,

['author-link'] = true,

['authormask'] = true,

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

['contributor'] = true,

['contributor-first'] = true,

['contributor-last'] = true,

['contributor-given'] = true,

['contributor-last'] = true,

['contributor-surname'] = true,

['contributor-link'] = true,

['contributor-mask'] = true,

['date'] = true,

['degree'] = true,

['department'] = true,

['df'] = true,

['dictionary'] = true,

['displayauthors'] = true,

['display-authors'] = true,

['display-contributors'] = true,

['displayeditors'] = true,

['display-editors'] = true,

['display-interviewers'] = true,

['display-subjects'] = true,

['display-translators'] = true,

['docket'] = true,

['doi'] = true,

['DOI'] = true,

['doi-access'] = true,

['doi-broken'] = true,

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

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

['edition'] = true,

['editor'] = true,

Line 99 ⟶ 82:

['editor-given'] = true,

['editor-last'] = true,

['editorlinkeditor-surname'] = true,

['editor-link'] = true,

['editormask'] = true,

['editor-mask'] = true,

['editors'] = false,

['editor-surname'] = true,

['eissn'] = true,

['EISSN'] = true,

['embargo'] = true,

['encyclopaedia'] = true,

['encyclopedia'] = true,

Line 115 ⟶ 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 125 ⟶ 100:

['HDL'] = true,

['hdl-access'] = true,

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

['id'] = true,

['ID'] = true,

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

['ignoreisbnerror'] = true,

['ignore-isbn-error'] = true,

['inset'] = true,

['institution'] = true,

['interviewer'] = true,

['interviewer-first'] = true,

['interviewer-given'] = true,

['interviewer-last'] = true,

['interviewerlinkinterviewer-surname'] = true,

['interviewer-link'] = true,

['interviewermask'] = true,

['interviewer-mask'] = true,

['isbn'] = true,

['ISBN'] = true,

['isbn13'] = true,

['ISBN13'] = true,

['ismn'] = true,

['ISMN'] = true,

Line 157 ⟶ 127:

['language'] = true,

['last'] = true,

['lastauthoramp'] = false,

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

['laydate'] = true,

['lay-date'] = true,

['laysource'] = true,

['lay-source'] = true,

['lay-format'] = true,

['layurl'] = true,

['lay-url'] = true,

['lccn'] = true,

['LCCN'] = true,

['___location'] = true,

['magazine'] = true,

['mailinglist'] = true, -- cite mailing list only

['mailing-list'] = true, -- cite mailing list only

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

['no-cat'] = true,

['nopp'] = true,

['no-pp'] = true,

['notracking'] = true,

['no-tracking'] = true,

['number'] = true,

Line 201 ⟶ 157:

['page'] = true,

['pages'] = true,

['people'] = true,

['periodical'] = true,

['place'] = true,

['pmc'] = true,

['PMC'] = true,

['pmc-embargo-date'] = true,

['pmid'] = true,

['PMID'] = true,

['postscript'] = true,

['pp'] = true,

['publicationdate'] = true,

['publication-date'] = true,

['publicationplace'] = true,

['publication-place'] = true,

['publisher'] = true,

['quotation'] = true,

['quote'] = true,

['quote-page'] = true,

['quote-pages'] = true,

['ref'] = true,

['rfc'] = true,

Line 226 ⟶ 182:

['script-chapter'] = true,

['script-contribution'] = true,

['script-encyclopaedia'] = true,

['script-encyclopedia'] = true,

['script-entry'] = true,

['script-journal'] = true,

Line 231 ⟶ 189:

['script-newspaper'] = true,

['script-periodical'] = true,

['script-quote'] = true,

['script-section'] = true,

['script-title'] = true,

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

['series-separator'] = true,

['ssrn'] = true,

['SSRN'] = true,

['ssrn-access'] = true,

['subject'] = true,

['subjectlinksubject-first'] = falsetrue,

['subject-given'] = true,

['subject-last'] = true,

['subject-link'] = true,

['subject-mask'] = true,

['subject-surname'] = true,

['surname'] = true,

['s2cid'] = true,

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

['title-doi'] = true,

['titlelink'] = true,

['title-link'] = true,

['transcripttitle-note'] = true,

['transcript-format'] = true,

['transcripturl'] = true,

['transcript-url'] = true,

['translator'] = true,

['translator-first'] = true,

['translator-last'] = true,

['translator-given'] = true,

['translator-last'] = true,

['translator-surname'] = true,

['translator-link'] = true,

Line 281 ⟶ 229:

['trans-chapter'] = true,

['trans-contribution'] = true,

['trans-encyclopaedia'] = true,

['trans-encyclopedia'] = true,

['trans-entry'] = true,

['trans-journal'] = true,

Line 286 ⟶ 236:

['trans-newspaper'] = true,

['trans-periodical'] = true,

['trans-quote'] = true,

['trans-section'] = true,

['trans-title'] = true,

Line 305 ⟶ 256:

['zbl'] = true,

['ZBL'] = true,

}

local numbered_argumentsnumbered_arguments_t = {

['author#'] = true,

['author-first#'] = true,

['author#-first'] = true,

['author-given#'] = true,

['author#-given'] = true,

['author-last#'] = true,

['author#-last'] = true,

['author-surname#'] = true,

['author#-surname'] = true,

['author-link#'] = true,

['author#link'] = true,

['author#-link'] = true,

['authorlink#'] = true,

['author#link'] = true,

['author-mask#'] = true,

['author#mask'] = true,

['author#-mask'] = true,

['authormask#'] = true,

['contributor#'] = true,

['contributor-first#'] = true,

['contributor#-first'] = true,

['contributor-last#'] = true,

['contributor#-last'] = true,

['contributor-given#'] = true,

['contributor#-given'] = true,

['contributor-last#'] = true,

['contributor#-last'] = true,

['contributor-surname#'] = true,

['contributor#-surname'] = true,

Line 337 ⟶ 290:

['editor-first#'] = true,

['editor#-first'] = true,

['editor#-given'] = true,

['editor-given#'] = true,

['editor#-given'] = true,

['editor-last#'] = true,

['editor#-last'] = true,

['editor-surname#'] = true,

['editor#-surname'] = true,

['editor-link#'] = true,

['editor#link'] = true,

['editor#-link'] = true,

['editorlink#'] = true,

['editor-mask#'] = true,

['editor#mask'] = true,

['editor#-mask'] = true,

['editormask#'] = true,

['editor#-surname'] = true,

['editor-surname#'] = true,

['first#'] = true,

['given#'] = true,

Line 357 ⟶ 306:

['interviewer-first#'] = true,

['interviewer#-first'] = true,

['interviewer-given#'] = true,

['interviewer#-given'] = true,

['interviewer-last#'] = true,

['interviewer#-last'] = true,

['interviewer-surname#'] = true,

['interviewer#-surname'] = true,

['interviewer-link#'] = true,

['interviewer#-link'] = true,

Line 365 ⟶ 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'] = false,

['subject#-link'] = true,

['subjectlink#'] = false,

['subject-mask#'] = true,

['subject#-mask'] = true,

['subject-surname#'] = true,

['subject#-surname'] = true,

['surname#'] = true,

['translator#'] = true,

['translator-first#'] = true,

['translator#-first'] = true,

['translator-last#'] = true,

['translator#-last'] = true,

['translator-given#'] = true,

['translator#-given'] = true,

['translator-last#'] = true,

['translator#-last'] = true,

['translator-surname#'] = true,

['translator#-surname'] = true,

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

['class'] = true, -- cite arxiv only

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

},

Line 410 ⟶ 370:

citeseerx = {

['citeseerx'] = true,

},

medrxiv = {

['medrxiv'] = true,

},

ssrn = {

['ssrn'] = true,

['SSRN'] = true,

['ssrn-access'] = true,

},

}

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

['author-first'] = true,

['author-given'] = true,

['author-last'] = true,

['authorlinkauthor-surname'] = true,

['author-link'] = true,

['authormaskauthorlink'] = true,

['author-mask'] = true,

['authors'] = true,

['collaboration'] = true,

['date'] = true,

['df'] = true,

['displayauthors'] = true,

['display-authors'] = true,

['first'] = true,

Line 447 ⟶ 412:

['language'] = true,

['last'] = true,

['lastauthoramp'] = false,

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

['mode'] = true,

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

['nocat'] = true,

['no-cat'] = true,

['notracking'] = true,

['no-tracking'] = true,

['p'] = true,

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

['author#-first'] = true,

['author-given#'] = true,

['author#-given'] = true,

['author-last#'] = true,

['author#-last'] = true,

['author-surname#'] = true,

['author#-surname'] = true,

['author-link#'] = true,

['author#link'] = true,

['author#-link'] = true,

['authorlink#'] = true,

['author#link'] = true,

['author-mask#'] = true,

['author#mask'] = true,

['author#-mask'] = true,

['authormask#'] = true,

['first#'] = true,

['given#'] = true,

Line 496 ⟶ 456:

--[[--------------------------< U N I Q U E _ A R G U M E N T S >----------------------------------------------

someSome templates have unique parameters. Those templates and their unique parameters are listed here. Keys in this

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,

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

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

['episode-link'] = true,

['network'] = true,

['people'] = true,

['season'] = true,

['series-link'] = true,

['series-no'] = true,

['series-number'] = true,

['station'] = true,

['transcript'] = true,

['transcript-format'] = true,

['transcript-url'] = true,

},

mailinglist = {

['mailing-list'] = true,

},

map = {

['cartography'] = true,

['inset'] = true,

['map'] = true,

['map-format'] = true,

['mapurl'] = true,

['map-url'] = true,

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

Line 528 ⟶ 512:

['message-id'] = true,

['newsgroup'] = true,

},

report = {

['docket'] = true,

},

serial = {

Line 534 ⟶ 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 549 ⟶ 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 561 ⟶ 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

};