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

From blackwiki
Jump to navigation Jump to search
test>Trappist the monk
m (1 revision imported)
 
(47 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
--[[
 
--[[
History of changes since last sync: 2020-01-11
+
History of changes since last sync: 2020-07-11
 
+
2020-07-16: deprecate editors; see Help_talk:Citation_Style_1#Editors
2020-02-21: add support for |s2cid=; see Help_talk:Citation_Style_1#Request_to_add_Semantic_Scholar_IDs_to_the_citation_template
+
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-03-07: add support for |sbn=; see Help_talk:Citation_Style_1#Suggestion_to_add_support_for_SBN_parameter
+
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
  
 
]]
 
]]
Line 15: Line 24:
 
 
 
]]
 
]]
 
local whitelist = {}
 
  
 
local basic_arguments = {
 
local basic_arguments = {
Line 22: Line 29:
 
['access-date'] = true,
 
['access-date'] = true,
 
['agency'] = true,
 
['agency'] = true,
-- ['airdate'] = true, -- cite episode and cite serial only
 
-- ['air-date'] = true, -- cite episode and cite serial only
 
 
['archivedate'] = true,
 
['archivedate'] = true,
 
['archive-date'] = true,
 
['archive-date'] = true,
Line 33: Line 38:
 
['article-url'] = true,
 
['article-url'] = true,
 
['article-url-access'] = true,
 
['article-url-access'] = true,
['arxiv'] = true,
+
['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier
 
['asin'] = true,
 
['asin'] = true,
 
['ASIN'] = true,
 
['ASIN'] = true,
Line 40: Line 45:
 
['author'] = true,
 
['author'] = true,
 
['author-first'] = true,
 
['author-first'] = true,
 +
['author-given'] = true,
 
['author-last'] = true,
 
['author-last'] = true,
 +
['author-surname'] = true,
 
['authorlink'] = true,
 
['authorlink'] = true,
 
['author-link'] = true,
 
['author-link'] = true,
['authormask'] = true,
+
['authormask'] = false, -- deprecated
 
['author-mask'] = true,
 
['author-mask'] = true,
 
['authors'] = true,
 
['authors'] = true,
Line 70: Line 77:
 
['contributor'] = true,
 
['contributor'] = true,
 
['contributor-first'] = true,
 
['contributor-first'] = true,
 +
['contributor-given'] = true,
 
['contributor-last'] = true,
 
['contributor-last'] = true,
['contributor-given'] = true,
 
 
['contributor-surname'] = true,
 
['contributor-surname'] = true,
 
['contributor-link'] = true,
 
['contributor-link'] = true,
 
['contributor-mask'] = true,
 
['contributor-mask'] = true,
-- ['credits'] = true, -- cite episode, cite serial
 
 
['date'] = true,
 
['date'] = true,
 
['degree'] = true,
 
['degree'] = true,
Line 81: Line 87:
 
['df'] = true,
 
['df'] = true,
 
['dictionary'] = true,
 
['dictionary'] = true,
['displayauthors'] = true,
+
['displayauthors'] = false, -- deprecated
 
['display-authors'] = true,
 
['display-authors'] = true,
 
['display-contributors'] = true,
 
['display-contributors'] = true,
['displayeditors'] = true,
 
 
['display-editors'] = true,
 
['display-editors'] = true,
 
['display-interviewers'] = true,
 
['display-interviewers'] = true,
 +
['display-subjects'] = true,
 
['display-translators'] = true,
 
['display-translators'] = true,
 
['docket'] = true,
 
['docket'] = true,
Line 92: Line 98:
 
['DOI'] = true,
 
['DOI'] = true,
 
['doi-access'] = true,
 
['doi-access'] = true,
['doi-broken'] = true,
 
 
['doi-broken-date'] = true,
 
['doi-broken-date'] = true,
['doi-inactive-date'] = true,
 
 
['edition'] = true,
 
['edition'] = true,
 
['editor'] = true,
 
['editor'] = true,
Line 100: Line 104:
 
['editor-given'] = true,
 
['editor-given'] = true,
 
['editor-last'] = true,
 
['editor-last'] = true,
['editorlink'] = true,
+
['editor-surname'] = true,
 +
['editorlink'] = false, -- deprecated
 
['editor-link'] = true,
 
['editor-link'] = true,
['editormask'] = true,
 
 
['editor-mask'] = true,
 
['editor-mask'] = true,
['editors'] = true,
+
['editors'] = false, -- deprecated
['editor-surname'] = true,
 
 
['eissn'] = true,
 
['eissn'] = true,
 
['EISSN'] = true,
 
['EISSN'] = true,
['embargo'] = true,
 
 
['encyclopaedia'] = true,
 
['encyclopaedia'] = true,
 
['encyclopedia'] = true,
 
['encyclopedia'] = true,
Line 115: Line 117:
 
['entry-url'] = true,
 
['entry-url'] = true,
 
['entry-url-access'] = true,
 
['entry-url-access'] = true,
-- ['episode'] = true, -- cite serial only TODO: make available to cite episode?
+
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
-- ['episodelink'] = true, -- cite episode and cite serial
 
-- ['episode-link'] = true, -- cite episode and cite serial
 
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
 
 
['event'] = true,
 
['event'] = true,
 
['event-format'] = true,
 
['event-format'] = true,
Line 132: Line 131:
 
['id'] = true,
 
['id'] = true,
 
['ID'] = true,
 
['ID'] = true,
['ignoreisbnerror'] = true,
+
['ignore-isbn-error'] = false, -- deprecated
['ignore-isbn-error'] = true,
+
-- ['inset'] = true,
['inset'] = true,
 
 
['institution'] = true,
 
['institution'] = true,
 
['interviewer'] = true,
 
['interviewer'] = true,
 
['interviewer-first'] = true,
 
['interviewer-first'] = true,
 +
['interviewer-given'] = true,
 
['interviewer-last'] = true,
 
['interviewer-last'] = true,
['interviewerlink'] = true,
+
['interviewer-surname'] = true,
 
['interviewer-link'] = true,
 
['interviewer-link'] = true,
['interviewermask'] = true,
 
 
['interviewer-mask'] = true,
 
['interviewer-mask'] = true,
 
['isbn'] = true,
 
['isbn'] = true,
Line 161: Line 159:
 
['language'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last'] = true,
['lastauthoramp'] = true,
+
['lastauthoramp'] = false, -- deprecated
['last-author-amp'] = true,
+
['last-author-amp'] = false, -- deprecated
 
['laydate'] = true,
 
['laydate'] = true,
 
['lay-date'] = true,
 
['lay-date'] = true,
Line 174: Line 172:
 
['location'] = true,
 
['location'] = true,
 
['magazine'] = true,
 
['magazine'] = true,
['mailinglist'] = true, -- cite mailing list only
+
-- ['mailinglist'] = true, -- cite mailing list only
['mailing-list'] = true, -- cite mailing list only
+
-- ['mailing-list'] = true, -- cite mailing list only
['map'] = true, -- cite map only
 
['map-format'] = true, -- cite map only
 
['mapurl'] = true, -- cite map only
 
['map-url'] = true, -- cite map only
 
['map-url-access'] = true, -- cite map only
 
 
['medium'] = true,
 
['medium'] = true,
-- ['message-id'] = true, -- cite newsgroup
 
 
['minutes'] = true,
 
['minutes'] = true,
 
['mode'] = true,
 
['mode'] = true,
Line 188: Line 180:
 
['MR'] = true,
 
['MR'] = true,
 
['name-list-format'] = true,
 
['name-list-format'] = true,
-- ['network'] = true, -- cite episode and cite serial only
 
['newsgroup'] = true,
 
 
['newspaper'] = true,
 
['newspaper'] = true,
 
['nocat'] = true,
 
['nocat'] = true,
['no-cat'] = true,
 
 
['nopp'] = true,
 
['nopp'] = true,
 
['no-pp'] = true,
 
['no-pp'] = true,
['notracking'] = true,
 
 
['no-tracking'] = true,
 
['no-tracking'] = true,
 
['number'] = true,
 
['number'] = true,
Line 203: Line 191:
 
['OL'] = true,
 
['OL'] = true,
 
['ol-access'] = true,
 
['ol-access'] = true,
 +
['orig-date'] = true,
 
['origyear'] = true,
 
['origyear'] = true,
 
['orig-year'] = true,
 
['orig-year'] = true,
Line 217: Line 206:
 
['pmc'] = true,
 
['pmc'] = true,
 
['PMC'] = true,
 
['PMC'] = true,
 +
['pmc-embargo-date'] = true,
 
['pmid'] = true,
 
['pmid'] = true,
 
['PMID'] = true,
 
['PMID'] = true,
Line 240: Line 230:
 
['script-journal'] = true,
 
['script-journal'] = true,
 
['script-magazine'] = true,
 
['script-magazine'] = true,
['script-map'] = true,
 
 
['script-newspaper'] = true,
 
['script-newspaper'] = true,
 
['script-periodical'] = true,
 
['script-periodical'] = true,
Line 250: Line 239:
 
['section'] = true,
 
['section'] = true,
 
['section-format'] = true,
 
['section-format'] = true,
['sections'] = true, -- cite map only
 
 
['sectionurl'] = true,
 
['sectionurl'] = true,
 
['section-url'] = true,
 
['section-url'] = true,
Line 261: Line 249:
 
['seriesnumber'] = true,
 
['seriesnumber'] = true,
 
['series-number'] = true,
 
['series-number'] = true,
['series-separator'] = true,
 
['sheet'] = true, -- cite map only
 
['sheets'] = true, -- cite map only
 
 
['ssrn'] = true,
 
['ssrn'] = true,
 
['SSRN'] = true,
 
['SSRN'] = true,
-- ['station'] = true, -- cite episode and cite serial only
 
 
['subject'] = true,
 
['subject'] = true,
['subjectlink'] = true,
+
['subjectlink'] = false, -- deprecated
 
['subject-link'] = true,
 
['subject-link'] = true,
 +
['subject-mask'] = true,
 
['surname'] = true,
 
['surname'] = true,
 
['s2cid'] = true,
 
['s2cid'] = true,
Line 281: Line 266:
 
['titlelink'] = true,
 
['titlelink'] = true,
 
['title-link'] = true,
 
['title-link'] = true,
['trans-map'] = true,
+
-- ['transcript'] = true, -- cite av media and cite episode only
['transcript'] = true,
+
-- ['transcript-format'] = true, -- cite av media and cite episode only
['transcript-format'] = true,
+
-- ['transcripturl'] = true, -- cite av media and cite episode only
['transcripturl'] = true,
+
-- ['transcript-url'] = true, -- cite av media and cite episode only
['transcript-url'] = true,
 
 
['translator'] = true,
 
['translator'] = true,
 
['translator-first'] = true,
 
['translator-first'] = true,
['translator-last'] = true,
 
 
['translator-given'] = true,
 
['translator-given'] = true,
 +
['translator-last'] = true,
 
['translator-surname'] = true,
 
['translator-surname'] = true,
 
['translator-link'] = true,
 
['translator-link'] = true,
Line 326: Line 310:
 
['author-first#'] = true,
 
['author-first#'] = true,
 
['author#-first'] = true,
 
['author#-first'] = true,
 +
['author-given#'] = true,
 +
['author#-given'] = true,
 
['author-last#'] = true,
 
['author-last#'] = true,
 
['author#-last'] = true,
 
['author#-last'] = true,
 +
['author-surname#'] = true,
 +
['author#-surname'] = true,
 
['author-link#'] = true,
 
['author-link#'] = true,
['author#link'] = true,
 
 
['author#-link'] = true,
 
['author#-link'] = true,
 
['authorlink#'] = true,
 
['authorlink#'] = true,
 +
['author#link'] = true,
 
['author-mask#'] = true,
 
['author-mask#'] = true,
['author#mask'] = true,
 
 
['author#-mask'] = true,
 
['author#-mask'] = true,
['authormask#'] = true,
+
['authormask#'] = false, -- deprecated
 +
['author#mask'] = false, -- deprecated
 
['contributor#'] = true,
 
['contributor#'] = true,
 
['contributor-first#'] = true,
 
['contributor-first#'] = true,
 
['contributor#-first'] = true,
 
['contributor#-first'] = true,
 +
['contributor-given#'] = true,
 +
['contributor#-given'] = true,
 
['contributor-last#'] = true,
 
['contributor-last#'] = true,
 
['contributor#-last'] = true,
 
['contributor#-last'] = true,
['contributor-given#'] = true,
 
['contributor#-given'] = true,
 
 
['contributor-surname#'] = true,
 
['contributor-surname#'] = true,
 
['contributor#-surname'] = true,
 
['contributor#-surname'] = true,
Line 352: Line 340:
 
['editor-first#'] = true,
 
['editor-first#'] = true,
 
['editor#-first'] = true,
 
['editor#-first'] = true,
 +
['editor-given#'] = true,
 
['editor#-given'] = true,
 
['editor#-given'] = true,
['editor-given#'] = true,
 
 
['editor-last#'] = true,
 
['editor-last#'] = true,
 
['editor#-last'] = true,
 
['editor#-last'] = true,
 +
['editor-surname#'] = true,
 +
['editor#-surname'] = true,
 
['editor-link#'] = true,
 
['editor-link#'] = true,
['editor#link'] = true,
 
 
['editor#-link'] = true,
 
['editor#-link'] = true,
['editorlink#'] = true,
+
['editorlink#'] = false, -- deprecated
 +
['editor#link'] = false, -- deprecated
 
['editor-mask#'] = true,
 
['editor-mask#'] = true,
['editor#mask'] = true,
 
 
['editor#-mask'] = true,
 
['editor#-mask'] = true,
['editormask#'] = true,
 
['editor#-surname'] = true,
 
['editor-surname#'] = true,
 
 
['first#'] = true,
 
['first#'] = true,
 
['given#'] = true,
 
['given#'] = true,
Line 372: Line 358:
 
['interviewer-first#'] = true,
 
['interviewer-first#'] = true,
 
['interviewer#-first'] = true,
 
['interviewer#-first'] = true,
 +
['interviewer-given#'] = true,
 +
['interviewer#-given'] = true,
 
['interviewer-last#'] = true,
 
['interviewer-last#'] = true,
 
['interviewer#-last'] = true,
 
['interviewer#-last'] = true,
 +
['interviewer-surname#'] = true,
 +
['interviewer#-surname'] = true,
 
['interviewer-link#'] = true,
 
['interviewer-link#'] = true,
 
['interviewer#-link'] = true,
 
['interviewer#-link'] = true,
Line 381: Line 371:
 
['subject#'] = true,
 
['subject#'] = true,
 
['subject-link#'] = true,
 
['subject-link#'] = true,
['subject#link'] = true,
 
 
['subject#-link'] = true,
 
['subject#-link'] = true,
['subjectlink#'] = true,
+
['subjectlink#'] = false, -- deprecated
 +
['subject#link'] = false, -- deprecated
 +
['subject-mask#'] = true,
 +
['subject#-mask'] = true,
 
['surname#'] = true,
 
['surname#'] = true,
 
['translator#'] = true,
 
['translator#'] = true,
 
['translator-first#'] = true,
 
['translator-first#'] = true,
 
['translator#-first'] = true,
 
['translator#-first'] = true,
 +
['translator-given#'] = true,
 +
['translator#-given'] = true,
 
['translator-last#'] = true,
 
['translator-last#'] = true,
 
['translator#-last'] = true,
 
['translator#-last'] = true,
['translator-given#'] = true,
 
['translator#-given'] = true,
 
 
['translator-surname#'] = true,
 
['translator-surname#'] = true,
 
['translator#-surname'] = true,
 
['translator#-surname'] = true,
Line 412: Line 404:
 
]]
 
]]
  
local preprint_specific_arguments = {
+
local preprint_arguments = {
 
arxiv = {
 
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
+
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['class'] = true, -- cite arxiv only
+
['class'] = true, -- cite arxiv only
['eprint'] = true, -- cite arxiv and arxiv identifiers
+
['eprint'] = true, -- cite arxiv and arxiv identifiers
 
},
 
},
 
biorxiv = {
 
biorxiv = {
Line 429: Line 421:
 
},
 
},
 
}
 
}
 
 
--[[--------------------------< C I T E  A R X I V >----------------------------------------------------------
 
 
]]
 
 
local arxiv_basic_arguments = {
 
['arxiv'] = true, -- cite arxiv and arxiv identifiers
 
['class'] = true, -- cite arxiv only
 
['eprint'] = true, -- cite arxiv and arxiv identifiers
 
}
 
 
 
--[[--------------------------< C I T E  B I O R X I V >------------------------------------------------------
 
 
]]
 
 
local biorxiv_basic_arguments = {
 
['biorxiv'] = true,
 
}
 
 
 
--[[--------------------------< C I T E  C I T E S E E R X >--------------------------------------------------
 
 
]]
 
 
local citeseerx_basic_arguments = {
 
['citeseerx'] = true,
 
}
 
 
 
--[[--------------------------< C I T E  S S R N >------------------------------------------------------------
 
 
]]
 
 
local ssrn_basic_arguments = {
 
['ssrn'] = true,
 
['SSRN'] = true,
 
}
 
  
  
Line 484: Line 437:
 
['author'] = true,
 
['author'] = true,
 
['author-first'] = true,
 
['author-first'] = true,
 +
['author-given'] = true,
 
['author-last'] = true,
 
['author-last'] = true,
 +
['author-surname'] = true,
 +
['author-link'] = true,
 
['authorlink'] = true,
 
['authorlink'] = true,
['author-link'] = true,
 
['authormask'] = true,
 
 
['author-mask'] = true,
 
['author-mask'] = true,
 +
['authormask'] = false, -- deprecated
 
['authors'] = true,
 
['authors'] = true,
 
['collaboration'] = true,
 
['collaboration'] = true,
 
['date'] = true,
 
['date'] = true,
 
['df'] = true,
 
['df'] = true,
['displayauthors'] = true,
 
 
['display-authors'] = true,
 
['display-authors'] = true,
 +
['displayauthors'] = false, -- deprecated
 
['first'] = true,
 
['first'] = true,
 
['given'] = true,
 
['given'] = true,
 
['language'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last'] = true,
['lastauthoramp'] = true,
+
['last-author-amp'] = false, -- deprecated
['last-author-amp'] = true,
+
['lastauthoramp'] = false, -- deprecated
 
['mode'] = true,
 
['mode'] = true,
 
['name-list-format'] = true,
 
['name-list-format'] = true,
 
['nocat'] = true,
 
['nocat'] = true,
['no-cat'] = true,
 
['notracking'] = true,
 
 
['no-tracking'] = true,
 
['no-tracking'] = true,
 
['p'] = true,
 
['p'] = true,
Line 518: Line 471:
 
['template-doc-demo'] = true,
 
['template-doc-demo'] = true,
 
['title'] = true,
 
['title'] = true,
 +
['trans-title'] = true,
 
['url'] = true,
 
['url'] = true,
 
['URL'] = true,
 
['URL'] = true,
Line 528: Line 482:
 
['author-first#'] = true,
 
['author-first#'] = true,
 
['author#-first'] = true,
 
['author#-first'] = true,
 +
['author-given#'] = true,
 +
['author#-given'] = true,
 
['author-last#'] = true,
 
['author-last#'] = true,
 
['author#-last'] = true,
 
['author#-last'] = true,
 +
['author-surname#'] = true,
 +
['author#-surname'] = true,
 
['author-link#'] = true,
 
['author-link#'] = true,
['author#link'] = true,
 
 
['author#-link'] = true,
 
['author#-link'] = true,
 
['authorlink#'] = true,
 
['authorlink#'] = true,
 +
['author#link'] = true,
 
['author-mask#'] = true,
 
['author-mask#'] = true,
['author#mask'] = true,
 
 
['author#-mask'] = true,
 
['author#-mask'] = true,
['authormask#'] = true,
+
['authormask#'] = false, -- deprecated
 +
['author#mask'] = false, -- deprecated
 
['first#'] = true,
 
['first#'] = true,
 
['given#'] = true,
 
['given#'] = true,
Line 545: Line 503:
  
  
--[[--------------------------< T E M P L A T E _ S P E C I F I C _ A R G U M E N T S >------------------------
+
--[[--------------------------< U N I Q U E _ A R G U M E N T S >----------------------------------------------
  
some templates haveunique parameters.  Those templates and their unique parameters are listed here. Keys in this
+
Some templates have unique parameters.  Those templates and their unique parameters are listed here. Keys in this
 
table are the template's CitationClass parameter value
 
table are the template's CitationClass parameter value
  
Line 554: Line 512:
 
]]
 
]]
  
local template_specific_arguments = {
+
local unique_arguments = {
 +
['audio-visual'] = {
 +
['transcript'] = true,
 +
['transcript-format'] = true,
 +
['transcripturl'] = true,
 +
['transcript-url'] = true,
 +
},
 
episode = {
 
episode = {
 
['airdate'] = true,
 
['airdate'] = true,
 
['air-date'] = true,
 
['air-date'] = true,
 
['credits'] = true,
 
['credits'] = true,
['episodelink'] = true, -- aliases of |title-link=
+
['episodelink'] = true, -- alias of |title-link=
['episode-link'] = true,
+
['episode-link'] = true, -- alias of |title-link=
 
['network'] = true,
 
['network'] = true,
 
['station'] = true,
 
['station'] = true,
 +
['transcript'] = true,
 +
['transcript-format'] = true,
 +
['transcripturl'] = true,
 +
['transcript-url'] = true,
 +
},
 +
mailinglist = {
 +
['mailinglist'] = true,
 +
['mailing-list'] = true,
 +
},
 +
map = {
 +
['inset'] = true,
 +
['map'] = true,
 +
['map-format'] = true,
 +
['mapurl'] = true,
 +
['map-url'] = true,
 +
['map-url-access'] = true,
 +
['script-map'] = true,
 +
['sections'] = true,
 +
['sheet'] = true,
 +
['sheets'] = true,
 +
['trans-map'] = true,
 
},
 
},
 
newsgroup = {
 
newsgroup = {
 
['message-id'] = true,
 
['message-id'] = true,
 +
['newsgroup'] = true,
 
},
 
},
 
serial = {
 
serial = {
Line 571: Line 557:
 
['air-date'] = true,
 
['air-date'] = true,
 
['credits'] = true,
 
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
+
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- aliases of |title-link=
+
['episodelink'] = true, -- aliases of |title-link=
 
['episode-link'] = true,
 
['episode-link'] = true,
 
['network'] = true,
 
['network'] = true,
Line 580: Line 566:
  
  
--[[--------------------------< U N I Q U E _ P A R A M _ T E M P L A T E _ L I S T _ G E T >------------------
+
--[[--------------------------< T E M P L A T E _ L I S T _ G E T >--------------------------------------------
  
gets a list of the templates that are identified as having unique parameters from template_specific_arguments{}
+
gets a list of the templates from table t
  
 
]]
 
]]
  
local function unique_param_template_list_get ()
+
local function template_list_get (t)
 
local out = {}; -- a table for output
 
local out = {}; -- a table for output
for k, _ in pairs (template_specific_arguments) do -- spin through the table and collect the keys
+
for k, _ in pairs (t) do -- spin through the table and collect the keys
 
table.insert (out, k) -- add each key to the output table
 
table.insert (out, k) -- add each key to the output table
 
end
 
end
Line 603: Line 589:
 
limited_basic_arguments = limited_basic_arguments,
 
limited_basic_arguments = limited_basic_arguments,
 
limited_numbered_arguments = limited_numbered_arguments,
 
limited_numbered_arguments = limited_numbered_arguments,
arxiv_basic_arguments = arxiv_basic_arguments, -- TODO: delete this
+
 
biorxiv_basic_arguments = biorxiv_basic_arguments, -- TODO: delete this
+
preprint_arguments = preprint_arguments,
citeseerx_basic_arguments = citeseerx_basic_arguments, -- TODO: delete this
+
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
ssrn_basic_arguments = ssrn_basic_arguments, -- TODO: delete this
+
unique_arguments = unique_arguments,
preprint_specific_arguments = preprint_specific_arguments,
+
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
specific_templates = unique_param_template_list_get (), -- TODO: this one goes away
 
template_specific_arguments = template_specific_arguments,
 
unique_param_template_list = unique_param_template_list_get(),
 
 
};
 
};

Latest revision as of 15:37, 26 September 2020

Documentation for this module may be created at Module:Citation/CS1/Whitelist/sandbox/doc

--[[
History of changes since last sync: 2020-07-11
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

]]

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

Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
	true - these parameters are valid and supported parameters
	false - these parameters are deprecated but still supported
	nil - these parameters are no longer supported. remove entirely
	
]]

local basic_arguments = {
	['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-url'] = true,
	['article-url-access'] = true,
	['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier
	['asin'] = true,
	['ASIN'] = true,
	['asin-tld'] = true,
	['at'] = true,
	['author'] = true,
	['author-first'] = true,
	['author-given'] = true,
	['author-last'] = true,
	['author-surname'] = true,
	['authorlink'] = true,
	['author-link'] = true,
	['authormask'] = false, -- deprecated
	['author-mask'] = true,
	['authors'] = true,
	['bibcode'] = true,
	['bibcode-access'] = true,
	['biorxiv'] = true,
	['booktitle'] = true,
	['book-title'] = true,
	['cartography'] = true,
	['chapter'] = true,
	['chapter-format'] = true,
	['chapterurl'] = true,
	['chapter-url'] = true,
	['chapter-url-access'] = true,
	['citeseerx'] = true,
	['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-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'] = false, -- deprecated
	['display-authors'] = true,
	['display-contributors'] = true,
	['display-editors'] = true,
	['display-interviewers'] = true,
	['display-subjects'] = true,
	['display-translators'] = true,
	['docket'] = true,
	['doi'] = true,
	['DOI'] = true,
	['doi-access'] = true,
	['doi-broken-date'] = true,
	['edition'] = true,
	['editor'] = true,
	['editor-first'] = true,
	['editor-given'] = true,
	['editor-last'] = true,
	['editor-surname'] = true,
	['editorlink'] = false, -- deprecated
	['editor-link'] = true,
	['editor-mask'] = true,
	['editors'] = false, -- deprecated
	['eissn'] = true,
	['EISSN'] = true,
	['encyclopaedia'] = true,
	['encyclopedia'] = true,
	['entry'] = true,
	['entry-format'] = true,
	['entry-url'] = true,
	['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,
	['given'] = true,
	['hdl'] = true,
	['HDL'] = true,
	['hdl-access'] = true,
	['host'] = true,
	['id'] = true,
	['ID'] = true,
	['ignore-isbn-error'] = false, -- deprecated
--	['inset'] = true,
	['institution'] = true,
	['interviewer'] = true,
	['interviewer-first'] = true,
	['interviewer-given'] = true,
	['interviewer-last'] = true,
	['interviewer-surname'] = true,
	['interviewer-link'] = true,
	['interviewer-mask'] = true,
	['isbn'] = true,
	['ISBN'] = true,
	['isbn13'] = true,
	['ISBN13'] = true,
	['ismn'] = true,
	['ISMN'] = true,
	['issn'] = true,
	['ISSN'] = true,
	['issue'] = true,
	['jfm'] = true,
	['JFM'] = true,
	['journal'] = true,
	['jstor'] = true,
	['JSTOR'] = true,
	['jstor-access'] = true,
	['lang'] = true,
	['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,
	['location'] = true,
	['magazine'] = true,
--	['mailinglist'] = true, -- cite mailing list only
--	['mailing-list'] = true, -- cite mailing list only
	['medium'] = true,
	['minutes'] = true,
	['mode'] = true,
	['mr'] = true,
	['MR'] = true,
	['name-list-format'] = true,
	['newspaper'] = true,
	['nocat'] = true,
	['nopp'] = true,
	['no-pp'] = true,
	['no-tracking'] = true,
	['number'] = true,
	['oclc'] = true,
	['OCLC'] = true,
	['ol'] = true,
	['OL'] = true,
	['ol-access'] = true,
	['orig-date'] = true,
	['origyear'] = true,
	['orig-year'] = true,
	['osti'] = true,
	['OSTI'] = true,
	['osti-access'] = true,
	['others'] = true,
	['p'] = true,
	['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,
	['ref'] = true,
	['rfc'] = true,
	['RFC'] = true,
	['sbn'] = true,
	['SBN'] = true,
	['scale'] = true,
	['script-article'] = true,
	['script-chapter'] = true,
	['script-contribution'] = true,
	['script-entry'] = true,
	['script-journal'] = true,
	['script-magazine'] = true,
	['script-newspaper'] = true,
	['script-periodical'] = 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,
	['serieslink'] = true,
	['series-link'] = true,
	['seriesno'] = true,
	['series-no'] = true,
	['seriesnumber'] = true,
	['series-number'] = true,
	['ssrn'] = true,
	['SSRN'] = true,
	['subject'] = true,
	['subjectlink'] = false, -- deprecated
	['subject-link'] = true,
	['subject-mask'] = true,
	['surname'] = true,
	['s2cid'] = true,
	['S2CID'] = true,
	['s2cid-access'] = true,
	['template-doc-demo'] = true,
	['time'] = true,
	['timecaption'] = true,
	['time-caption'] = true,
	['title'] = true,
	['titlelink'] = true,
	['title-link'] = true,
--	['transcript'] = true, -- cite av media and cite episode only
--	['transcript-format'] = true, -- cite av media and cite episode only
--	['transcripturl'] = true, -- cite av media and cite episode only
--	['transcript-url'] = true, -- cite av media and cite episode only
	['translator'] = true,
	['translator-first'] = true,
	['translator-given'] = true,
	['translator-last'] = true,	
	['translator-surname'] = true,
	['translator-link'] = true,
	['translator-mask'] = true,
	['trans-article'] = true,
	['trans-chapter'] = true,
	['trans-contribution'] = true,
	['trans-entry'] = true,
	['trans-journal'] = true,
	['trans-magazine'] = true,
	['trans-newspaper'] = true,
	['trans-periodical'] = true,
	['trans-section'] = true,
	['trans-title'] = true,
	['trans-website'] = true,
	['trans-work'] = true,
	['type'] = true,
	['url'] = true,
	['URL'] = true,
	['url-access'] = true,
	['url-status'] = true,
	['vauthors'] = true,
	['veditors'] = true,
	['version'] = true,
	['via'] = true,
	['volume'] = true,
	['website'] = true,
	['work'] = true,
	['year'] = true,
	['zbl'] = true,
	['ZBL'] = true,
}

local numbered_arguments = {
	['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,
	['authorlink#'] = true,
	['author#link'] = true,
	['author-mask#'] = true,
	['author#-mask'] = true,
	['authormask#'] = false, -- deprecated
	['author#mask'] = false, -- deprecated
	['contributor#'] = true,
	['contributor-first#'] = true,
	['contributor#-first'] = true,
	['contributor-given#'] = true,
	['contributor#-given'] = true,
	['contributor-last#'] = true,
	['contributor#-last'] = true,
	['contributor-surname#'] = true,
	['contributor#-surname'] = true,
	['contributor-link#'] = true,
	['contributor#-link'] = true,
	['contributor-mask#'] = true,
	['contributor#-mask'] = true,
	['editor#'] = true,
	['editor-first#'] = true,
	['editor#-first'] = 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,
	['editorlink#'] = false, -- deprecated
	['editor#link'] = false, -- deprecated
	['editor-mask#'] = true,
	['editor#-mask'] = true,
	['first#'] = true,
	['given#'] = true,
	['host#'] = true,
	['interviewer#'] = true,
	['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,
	['interviewer-mask#'] = true,
	['interviewer#-mask'] = true,
	['last#'] = true,
	['subject#'] = true,
	['subject-link#'] = true,
	['subject#-link'] = true,
	['subjectlink#'] = false, -- deprecated
	['subject#link'] = false, -- deprecated
	['subject-mask#'] = true,
	['subject#-mask'] = true,
	['surname#'] = true,
	['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,
}


--[[--------------------------< 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, and cite ssrn are preprint templates that use the limited set of parameters
defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are supplemented with a
template-specific list of parameters that are required by the particular template and may be 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/nil as above.

]]

local preprint_arguments = {
	arxiv = {
		['arxiv'] = true, -- cite arxiv and arxiv identifiers
		['class'] = true, -- cite arxiv only
		['eprint'] = true, -- cite arxiv and arxiv identifiers
		},
	biorxiv = {
		['biorxiv'] = true,
		},
	citeseerx = {
		['citeseerx'] = true,
		},
	ssrn = {
		['ssrn'] = true,
		['SSRN'] = true,
		},
	}


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

This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates.  These parameters are common to
all three templates

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

local limited_basic_arguments = {
	['at'] = true,
	['author'] = true,
	['author-first'] = true,
	['author-given'] = true,
	['author-last'] = true,
	['author-surname'] = true,
	['author-link'] = true,
	['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-format'] = true,
	['nocat'] = true,
	['no-tracking'] = true,
	['p'] = true,
	['page'] = true,
	['pages'] = true,
	['postscript'] = true,
	['pp'] = true,
	['quotation'] = true,
	['quote'] = true,
	['ref'] = true,
	['surname'] = true,
	['template-doc-demo'] = true,
	['title'] = true,
	['trans-title'] = true,
	['url'] = true,
	['URL'] = true,
	['vauthors'] = true,
	['year'] = true,
}

local limited_numbered_arguments = {
	['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,
	['authorlink#'] = true,
	['author#link'] = true,
	['author-mask#'] = true,
	['author#-mask'] = true,
	['authormask#'] = false, -- deprecated
	['author#mask'] = false, -- deprecated
	['first#'] = true,
	['given#'] = true,
	['last#'] = true,
	['surname#'] = true,
	}


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

Some 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/nil as above.

]]

local unique_arguments = {
	['audio-visual'] = {
		['transcript'] = true,
		['transcript-format'] = true,
		['transcripturl'] = true,
		['transcript-url'] = true,
		},
	episode = {
		['airdate'] = true,
		['air-date'] = true,
		['credits'] = true,
		['episodelink'] = true, -- alias of |title-link=
		['episode-link'] = true, -- alias of |title-link=
		['network'] = true,
		['station'] = true,
		['transcript'] = true,
		['transcript-format'] = true,
		['transcripturl'] = true,
		['transcript-url'] = true,
		},
	mailinglist = {
		['mailinglist'] = true,
		['mailing-list'] = true,
		},
	map = {
		['inset'] = true,
		['map'] = true,
		['map-format'] = true,
		['mapurl'] = true,
		['map-url'] = true,
		['map-url-access'] = true,
		['script-map'] = true,
		['sections'] = true,
		['sheet'] = true,
		['sheets'] = true,
		['trans-map'] = true,
		},
	newsgroup = {
		['message-id'] = true,
		['newsgroup'] = true,
		},
	serial = {
		['airdate'] = true,
		['air-date'] = true,
		['credits'] = true,
		['episode'] = true, -- cite serial only TODO: make available to cite episode?
		['episodelink'] = true, -- aliases of |title-link=
		['episode-link'] = true,
		['network'] = true,
		['station'] = true,
		},
	}


--[[--------------------------< T E M P L A T E _ L I S T _ G E T >--------------------------------------------

gets a list of the templates from table t

]]

local function template_list_get (t)
	local out = {};																-- a table for output
	for k, _ in pairs (t) do													-- spin through the table and collect the keys
		table.insert (out, k)													-- add each key to the output table
	end
	return out;																	-- and done
end


--[[--------------------------< E X P O R T E D   T A B L E S >------------------------------------------------
]]

return {
	basic_arguments = basic_arguments,
	numbered_arguments = numbered_arguments,
	limited_basic_arguments = limited_basic_arguments,
	limited_numbered_arguments = limited_numbered_arguments,

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