Difference between revisions of "Module:Citation/CS1/Whitelist"
m (1 revision) |
en>Trappist the monk (sync from sandbox;) |
||
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 51: | Line 5: | ||
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 | ||
− | nil - these parameters are no longer supported | + | nil - these parameters are no longer supported. remove entirely |
]] | ]] | ||
− | |||
− | |||
local basic_arguments = { | local basic_arguments = { | ||
Line 61: | Line 13: | ||
['access-date'] = true, | ['access-date'] = true, | ||
['agency'] = true, | ['agency'] = true, | ||
− | |||
− | |||
['archivedate'] = true, | ['archivedate'] = true, | ||
['archive-date'] = true, | ['archive-date'] = true, | ||
Line 69: | Line 19: | ||
['archive-url'] = true, | ['archive-url'] = true, | ||
['article'] = 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'] = true, | ['ASIN'] = true, | ||
['asin-tld'] = true, | ['asin-tld'] = true, | ||
− | |||
['at'] = true, | ['at'] = true, | ||
['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'] = | + | ['authormask'] = false, -- deprecated |
['author-mask'] = true, | ['author-mask'] = true, | ||
['authors'] = true, | ['authors'] = true, | ||
['bibcode'] = true, | ['bibcode'] = true, | ||
− | [' | + | ['bibcode-access'] = true, |
+ | ['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier | ||
['booktitle'] = true, | ['booktitle'] = true, | ||
['book-title'] = true, | ['book-title'] = true, | ||
− | |||
− | |||
['cartography'] = true, | ['cartography'] = true, | ||
['chapter'] = true, | ['chapter'] = true, | ||
Line 95: | Line 47: | ||
['chapterurl'] = true, | ['chapterurl'] = true, | ||
['chapter-url'] = true, | ['chapter-url'] = true, | ||
− | [' | + | ['chapter-url-access'] = true, |
− | [' | + | ['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier |
− | [' | + | ['collaboration'] = true, |
− | |||
['conference'] = true, | ['conference'] = true, | ||
['conference-format'] = true, | ['conference-format'] = true, | ||
Line 107: | Line 58: | ||
['contributionurl'] = true, | ['contributionurl'] = true, | ||
['contribution-url'] = 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, | ['date'] = true, | ||
− | |||
− | |||
['degree'] = true, | ['degree'] = true, | ||
['department'] = true, | ['department'] = true, | ||
+ | ['df'] = true, | ||
['dictionary'] = true, | ['dictionary'] = true, | ||
− | ['displayauthors'] = | + | ['displayauthors'] = false, -- deprecated |
['display-authors'] = true, | ['display-authors'] = true, | ||
− | [' | + | ['display-contributors'] = true, |
['display-editors'] = true, | ['display-editors'] = true, | ||
+ | ['display-interviewers'] = true, | ||
+ | ['display-subjects'] = true, | ||
+ | ['display-translators'] = true, | ||
['docket'] = true, | ['docket'] = true, | ||
['doi'] = true, | ['doi'] = true, | ||
['DOI'] = true, | ['DOI'] = true, | ||
− | ['doi- | + | ['doi-access'] = true, |
− | |||
['doi-broken-date'] = true, | ['doi-broken-date'] = true, | ||
− | |||
− | |||
['edition'] = true, | ['edition'] = true, | ||
['editor'] = true, | ['editor'] = true, | ||
Line 131: | Line 88: | ||
['editor-given'] = true, | ['editor-given'] = true, | ||
['editor-last'] = true, | ['editor-last'] = true, | ||
− | ['editorlink'] = | + | ['editor-surname'] = true, |
+ | ['editorlink'] = false, -- deprecated | ||
['editor-link'] = true, | ['editor-link'] = true, | ||
− | |||
['editor-mask'] = true, | ['editor-mask'] = true, | ||
− | ['editors'] = | + | ['editors'] = false, -- deprecated |
− | [' | + | ['eissn'] = true, |
− | [' | + | ['EISSN'] = true, |
['encyclopaedia'] = true, | ['encyclopaedia'] = true, | ||
['encyclopedia'] = true, | ['encyclopedia'] = true, | ||
['entry'] = true, | ['entry'] = true, | ||
− | [' | + | ['entry-format'] = true, |
− | [' | + | ['entry-url'] = true, |
− | [' | + | ['entry-url-access'] = true, |
− | ['eprint'] = true, -- cite arxiv | + | ['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier |
['event'] = true, | ['event'] = true, | ||
['event-format'] = true, | ['event-format'] = true, | ||
Line 152: | Line 109: | ||
['format'] = true, | ['format'] = true, | ||
['given'] = true, | ['given'] = true, | ||
+ | ['hdl'] = true, | ||
+ | ['HDL'] = true, | ||
+ | ['hdl-access'] = true, | ||
['host'] = true, | ['host'] = true, | ||
['id'] = true, | ['id'] = true, | ||
['ID'] = true, | ['ID'] = true, | ||
− | + | ['ignore-isbn-error'] = false, -- deprecated | |
− | ['ignore-isbn-error'] = | ||
− | |||
− | |||
['institution'] = true, | ['institution'] = true, | ||
− | ['interviewer'] = 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, | ||
['ISBN'] = true, | ['ISBN'] = true, | ||
Line 176: | Line 138: | ||
['jstor'] = true, | ['jstor'] = true, | ||
['JSTOR'] = true, | ['JSTOR'] = true, | ||
+ | ['jstor-access'] = true, | ||
+ | ['lang'] = true, | ||
['language'] = true, | ['language'] = true, | ||
['last'] = true, | ['last'] = true, | ||
− | ['lastauthoramp'] = | + | ['lastauthoramp'] = false, -- deprecated |
− | ['last-author-amp'] = | + | ['last-author-amp'] = false, -- deprecated |
['laydate'] = true, | ['laydate'] = true, | ||
['lay-date'] = true, | ['lay-date'] = true, | ||
['laysource'] = true, | ['laysource'] = true, | ||
['lay-source'] = true, | ['lay-source'] = true, | ||
− | |||
− | |||
['lay-format'] = true, | ['lay-format'] = true, | ||
['layurl'] = true, | ['layurl'] = true, | ||
Line 193: | Line 155: | ||
['location'] = true, | ['location'] = true, | ||
['magazine'] = true, | ['magazine'] = true, | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
['medium'] = true, | ['medium'] = true, | ||
− | |||
['minutes'] = true, | ['minutes'] = true, | ||
['mode'] = true, | ['mode'] = true, | ||
Line 206: | Line 161: | ||
['MR'] = true, | ['MR'] = true, | ||
['name-list-format'] = true, | ['name-list-format'] = true, | ||
− | [' | + | ['name-list-style'] = true, |
− | |||
['newspaper'] = true, | ['newspaper'] = true, | ||
['nocat'] = true, | ['nocat'] = true, | ||
− | |||
['nopp'] = true, | ['nopp'] = true, | ||
['no-pp'] = true, | ['no-pp'] = true, | ||
− | |||
['no-tracking'] = true, | ['no-tracking'] = true, | ||
['number'] = true, | ['number'] = true, | ||
Line 220: | Line 172: | ||
['ol'] = true, | ['ol'] = true, | ||
['OL'] = true, | ['OL'] = true, | ||
+ | ['ol-access'] = true, | ||
+ | ['orig-date'] = true, | ||
['origyear'] = true, | ['origyear'] = true, | ||
['orig-year'] = true, | ['orig-year'] = true, | ||
['osti'] = true, | ['osti'] = true, | ||
['OSTI'] = true, | ['OSTI'] = true, | ||
+ | ['osti-access'] = true, | ||
['others'] = true, | ['others'] = true, | ||
['p'] = true, | ['p'] = true, | ||
Line 233: | Line 188: | ||
['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, | ['publicationdate'] = true, | ||
['publication-date'] = true, | ['publication-date'] = true, | ||
Line 247: | Line 200: | ||
['quotation'] = true, | ['quotation'] = true, | ||
['quote'] = true, | ['quote'] = true, | ||
+ | ['quote-page'] = true, | ||
+ | ['quote-pages'] = true, | ||
['ref'] = true, | ['ref'] = true, | ||
− | |||
− | |||
['rfc'] = true, | ['rfc'] = true, | ||
['RFC'] = true, | ['RFC'] = true, | ||
+ | ['sbn'] = true, | ||
+ | ['SBN'] = true, | ||
['scale'] = true, | ['scale'] = true, | ||
+ | ['script-article'] = true, | ||
['script-chapter'] = true, | ['script-chapter'] = true, | ||
+ | ['script-contribution'] = true, | ||
+ | ['script-entry'] = true, | ||
+ | ['script-journal'] = true, | ||
+ | ['script-magazine'] = true, | ||
+ | ['script-newspaper'] = true, | ||
+ | ['script-periodical'] = true, | ||
+ | ['script-quote'] = true, | ||
+ | ['script-section'] = true, | ||
['script-title'] = true, | ['script-title'] = true, | ||
+ | ['script-website'] = true, | ||
+ | ['script-work'] = true, | ||
['season'] = true, | ['season'] = true, | ||
['section'] = true, | ['section'] = true, | ||
['section-format'] = true, | ['section-format'] = true, | ||
− | |||
['sectionurl'] = true, | ['sectionurl'] = true, | ||
['section-url'] = true, | ['section-url'] = true, | ||
+ | ['section-url-access'] = true, | ||
['series'] = true, | ['series'] = true, | ||
['serieslink'] = true, | ['serieslink'] = true, | ||
Line 268: | Line 234: | ||
['seriesnumber'] = true, | ['seriesnumber'] = true, | ||
['series-number'] = true, | ['series-number'] = true, | ||
− | [' | + | ['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier |
− | |||
− | |||
− | |||
['SSRN'] = true, | ['SSRN'] = true, | ||
− | |||
['subject'] = true, | ['subject'] = true, | ||
− | ['subjectlink'] = | + | ['subjectlink'] = false, -- deprecated |
['subject-link'] = true, | ['subject-link'] = true, | ||
− | [' | + | ['subject-mask'] = true, |
['surname'] = true, | ['surname'] = true, | ||
− | [' | + | ['s2cid'] = true, |
+ | ['S2CID'] = true, | ||
+ | ['s2cid-access'] = true, | ||
['template-doc-demo'] = true, | ['template-doc-demo'] = true, | ||
['time'] = true, | ['time'] = true, | ||
Line 287: | Line 251: | ||
['titlelink'] = true, | ['titlelink'] = true, | ||
['title-link'] = true, | ['title-link'] = true, | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
['translator'] = true, | ['translator'] = true, | ||
['translator-first'] = true, | ['translator-first'] = true, | ||
− | ['translator-last'] = true, | + | ['translator-given'] = true, |
+ | ['translator-last'] = true, | ||
+ | ['translator-surname'] = true, | ||
['translator-link'] = true, | ['translator-link'] = true, | ||
['translator-mask'] = 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-quote'] = true, | ||
+ | ['trans-section'] = true, | ||
+ | ['trans-title'] = true, | ||
+ | ['trans-website'] = true, | ||
+ | ['trans-work'] = true, | ||
['type'] = true, | ['type'] = true, | ||
['url'] = true, | ['url'] = true, | ||
['URL'] = true, | ['URL'] = true, | ||
+ | ['url-access'] = true, | ||
+ | ['url-status'] = true, | ||
['vauthors'] = true, | ['vauthors'] = true, | ||
['veditors'] = true, | ['veditors'] = true, | ||
Line 320: | Line 292: | ||
['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, | ||
['authorlink#'] = true, | ['authorlink#'] = true, | ||
+ | ['author#link'] = 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-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#'] = true, | ||
['editor-first#'] = true, | ['editor-first#'] = true, | ||
['editor#-first'] = true, | ['editor#-first'] = 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, | ||
− | ['editorlink#'] = | + | ['editorlink#'] = false, -- deprecated |
+ | ['editor#link'] = false, -- deprecated | ||
['editor-mask#'] = true, | ['editor-mask#'] = true, | ||
− | |||
['editor#-mask'] = true, | ['editor#-mask'] = true, | ||
− | |||
− | |||
− | |||
['first#'] = true, | ['first#'] = true, | ||
['given#'] = 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, | ['last#'] = true, | ||
['subject#'] = true, | ['subject#'] = 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-surname#'] = true, | ||
+ | ['translator#-surname'] = true, | ||
['translator-link#'] = true, | ['translator-link#'] = true, | ||
['translator#-link'] = true, | ['translator#-link'] = true, | ||
Line 367: | Line 374: | ||
} | } | ||
− | return {basic_arguments = basic_arguments, numbered_arguments = numbered_arguments}; | + | |
+ | --[[--------------------------< 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, | ||
+ | ['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, | ||
+ | ['name-list-style'] = 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 | ||
+ | }; |
Revision as of 15:23, 10 October 2020
{{#lst:Module:Citation/CS1/doc|header}}
This page contains a list of all parameters considered by Module:Citation/CS1, though not all parameters would be used for all citations.
The content shown here was initially generated by Module:Citation/CS1/Arguments but is now maintained by hand to allow parameters to be assigned one of several defined states. Current states are: active (true
), deprecated (false
), and obsolete (nil
).
{{#lst:Module:Citation/CS1/doc|module_components_table}}
--[[--------------------------< 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, -- 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, ['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 ['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, ['medium'] = true, ['minutes'] = true, ['mode'] = true, ['mr'] = true, ['MR'] = true, ['name-list-format'] = true, ['name-list-style'] = 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, ['quote-page'] = true, ['quote-pages'] = 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-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, ['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, ['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, ['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-quote'] = 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, ['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, ['name-list-style'] = 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 };