Seeds of the Word

Module:Citation/CS1/Whitelist: Difference between revisions

Module Discussion

Module:Citation/CS1/Whitelist (view source)

Revision as of 16:23, May 4, 2023

246 bytes added ,  1 year ago
m
1 revision imported
m (1 revision imported)
m (1 revision imported)
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
--[[--------------------------< S U P P O R T E D  P A R A M E T E R S >--------------------------------------
--[[--------------------------< S U P P O R T E D  P A R A M E T E R S >--------------------------------------


Line 5: Line 4:
true - these parameters are valid and supported parameters
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
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
nil - these parameters are no longer supported. remove entirely
]]
]]
local whitelist = {}


local basic_arguments = {
local basic_arguments = {
Line 22: Line 20:
['article'] = true,
['article'] = true,
['article-format'] = true,
['article-format'] = true,
['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value
['article-url'] = true,
['article-url'] = true,
['article-url-access'] = true,
['article-url-access'] = true,
Line 31: Line 30:
['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,
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['authors'] = true,
['bibcode'] = true,
['bibcode'] = true,
['bibcode-access'] = true,
['bibcode-access'] = true,
['biorxiv'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['book-title'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapter-format'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['collaboration'] = true,
['collaboration'] = true,
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contribution-format'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contribution-url-access'] = true,
['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,
['date'] = true,
['date'] = true,
['degree'] = true,
['department'] = true,
['department'] = true,
['df'] = true,
['df'] = true,
['dictionary'] = true,
['dictionary'] = true,
['displayauthors'] = true,
['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,
['doi'] = true,
['doi'] = true,
['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 90: Line 76:
['editor-given'] = true,
['editor-given'] = true,
['editor-last'] = true,
['editor-last'] = true,
['editorlink'] = true,
['editor-surname'] = true,
['editor-link'] = true,
['editor-link'] = true,
['editormask'] = true,
['editor-mask'] = true,
['editor-mask'] = true,
['editors'] = true,
['editor-surname'] = true,
['eissn'] = true,
['eissn'] = true,
['EISSN'] = true,
['EISSN'] = true,
['embargo'] = true,
['encyclopaedia'] = true,
['encyclopaedia'] = true,
['encyclopedia'] = true,
['encyclopedia'] = true,
Line 106: Line 88:
['entry-url-access'] = true,
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['event'] = true,
['event-format'] = true,
['eventurl'] = true,
['event-url'] = true,
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
Line 116: Line 94:
['HDL'] = true,
['HDL'] = true,
['hdl-access'] = true,
['hdl-access'] = true,
['host'] = true,
['host'] = true, -- unique to certain templates?
['id'] = true,
['id'] = true,
['ID'] = true,
['ID'] = true,
['ignoreisbnerror'] = true,
['institution'] = true, -- constrain to cite thesis?
['ignore-isbn-error'] = true,
['inset'] = 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,
['ISBN'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ismn'] = true,
['ISMN'] = true,
['ISMN'] = true,
Line 148: Line 121:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lastauthoramp'] = true,
['lay-date'] = false,
['last-author-amp'] = true,
['lay-format'] = false,
['laydate'] = true,
['lay-source'] = false,
['lay-date'] = true,
['lay-url'] = false,
['laysource'] = true,
['lay-source'] = true,
['lay-format'] = true,
['layurl'] = true,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
['LCCN'] = true,
['LCCN'] = true,
['location'] = true,
['location'] = true,
['magazine'] = true,
['magazine'] = true,
['mailinglist'] = true, -- cite mailing list only
['mailing-list'] = true, -- cite mailing list only
['medium'] = true,
['medium'] = true,
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mode'] = true,
['mr'] = true,
['mr'] = true,
['MR'] = true,
['MR'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['newspaper'] = true,
['nocat'] = true,
['no-cat'] = true,
['nopp'] = true,
['no-pp'] = true,
['no-pp'] = true,
['notracking'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
['number'] = true,
['number'] = true,
Line 182: Line 144:
['OL'] = true,
['OL'] = true,
['ol-access'] = true,
['ol-access'] = true,
['orig-date'] = true,
['origyear'] = true,
['origyear'] = true,
['orig-year'] = true,
['orig-year'] = true,
Line 196: Line 159:
['pmc'] = true,
['pmc'] = true,
['PMC'] = true,
['PMC'] = true,
['pmc-embargo-date'] = true,
['pmid'] = true,
['pmid'] = true,
['PMID'] = true,
['PMID'] = true,
['postscript'] = true,
['postscript'] = true,
['pp'] = true,
['pp'] = true,
['publicationdate'] = true,
['publication-date'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publication-place'] = true,
['publication-place'] = true,
['publisher'] = true,
['publisher'] = true,
['quotation'] = true,
['quotation'] = true,
['quote'] = true,
['quote'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['ref'] = true,
['ref'] = true,
['rfc'] = true,
['rfc'] = true,
Line 221: Line 185:
['script-newspaper'] = true,
['script-newspaper'] = true,
['script-periodical'] = true,
['script-periodical'] = true,
['script-quote'] = true,
['script-section'] = true,
['script-section'] = true,
['script-title'] = true,
['script-title'] = true,
['script-website'] = true,
['script-website'] = true,
['script-work'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section'] = true,
['section-format'] = true,
['section-format'] = true,
['sectionurl'] = true,
['section-url'] = true,
['section-url'] = true,
['section-url-access'] = true,
['section-url-access'] = true,
['series'] = true,
['series'] = true,
['serieslink'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['series-link'] = true,
['seriesno'] = true,
['series-no'] = true,
['seriesnumber'] = true,
['series-number'] = true,
['series-separator'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
['subject'] = true,
['subject'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['surname'] = true,
['surname'] = true,
['s2cid'] = true,
['s2cid'] = true,
Line 249: Line 206:
['s2cid-access'] = true,
['s2cid-access'] = true,
['template-doc-demo'] = true,
['template-doc-demo'] = true,
['time'] = true,
['time'] = true, -- constrain to cite av media and podcast?
['timecaption'] = true,
['time-caption'] = true, -- constrain to cite av media and podcast?
['time-caption'] = true,
['title'] = true,
['title'] = true,
['titlelink'] = true,
['title-link'] = true,
['title-link'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['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 274: Line 225:
['trans-newspaper'] = true,
['trans-newspaper'] = true,
['trans-periodical'] = true,
['trans-periodical'] = true,
['trans-quote'] = true,
['trans-section'] = true,
['trans-section'] = true,
['trans-title'] = true,
['trans-title'] = true,
Line 293: Line 245:
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
}


local numbered_arguments = {
local numbered_arguments = {
Line 299: Line 251:
['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,
['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 325: Line 279:
['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,
['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 345: Line 295:
['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 354: Line 308:
['subject#'] = true,
['subject#'] = true,
['subject-link#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subject#-link'] = true,
['subjectlink#'] = true,
['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 371: Line 325:
['translator-mask#'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
['translator#-mask'] = true,
}
}




Line 381: Line 335:
preprint templates.  Some of these parameters may also be available to the general cs1|2 templates.
preprint templates.  Some of these parameters may also be available to the general cs1|2 templates.


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


]]
]]
Line 388: Line 342:
arxiv = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['class'] = true, -- cite arxiv only
['class'] = true,
['eprint'] = true, -- cite arxiv and arxiv identifiers
['eprint'] = true, -- cite arxiv and arxiv identifiers
},
},
Line 400: Line 354:
['ssrn'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
},
}
}
Line 406: Line 361:
--[[--------------------------< 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 >----------------------
--[[--------------------------< 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
cite arxiv, cite biorxiv, cite citeseerx, and cite ssrn templates are preprint templates so are allowed only a
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates.  These parameters are common to
limited subset of parameters allowed to all other cs1|2 templates.  The limited subset is defined here.
all three templates


Same conventions for true/false/nil as above.
Same conventions for true/false/tracked/nil as above.
]]
]]
Line 418: Line 372:
['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,
['authors'] = true,
['authors'] = true,
Line 427: Line 382:
['date'] = true,
['date'] = true,
['df'] = true,
['df'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['display-authors'] = true,
['first'] = true,
['first'] = true,
Line 433: Line 387:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['mode'] = true,
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['nocat'] = true,
['no-cat'] = true,
['notracking'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
['p'] = true,
['p'] = true,
Line 453: Line 402:
['title'] = true,
['title'] = true,
['trans-title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['vauthors'] = true,
['year'] = true,
['year'] = true,
}
}


local limited_numbered_arguments = {
local limited_numbered_arguments = {
Line 463: Line 410:
['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,
['first#'] = true,
['first#'] = true,
['given#'] = true,
['given#'] = true,
Line 482: Line 431:
--[[--------------------------< U N I Q U E _ 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 have unique 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


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


]]
]]


local unique_arguments = {
local unique_arguments = {
['audio-visual'] = {
['transcript'] = true,
['transcript-format'] = true,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
episode = {
episode = {
['airdate'] = true,
['airdate'] = true,
['air-date'] = true,
['air-date'] = true,
['credits'] = true,
['credits'] = true,
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true,
['network'] = true,
['network'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['station'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
},
mailinglist = {
['mailing-list'] = true,
},
},
map = {
map = {
['cartography'] = true,
['inset'] = true,
['map'] = true,
['map'] = true,
['map-format'] = true,
['map-format'] = true,
['mapurl'] = true,
['map-url'] = true,
['map-url'] = true,
['map-url-access'] = true,
['map-url-access'] = true,
Line 514: Line 486:
['message-id'] = true,
['message-id'] = true,
['newsgroup'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
},
serial = {
serial = {
Line 520: Line 495:
['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=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true,
['network'] = true,
['network'] = true,
['series-link'] = true,
['station'] = true,
['station'] = true,
},
speech = {
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
thesis = {
['degree'] = true,
['docket'] = true,
},
},
}
}
Retrieved from "https://en.seminaverbi.bibleget.io/wiki/Special:MobileDiff/406...27094"