Module:Citation/CS1/Whitelist: Difference between revisions
(sync from sandbox;) |
m (10 revisions imported from wikipedia:Module:Citation/CS1/Whitelist: see Topic:Vtixlm0q28eo6jtf) |
||
(4 intermediate revisions by one other user not shown) | |||
Line 5: | 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 | ||
discouraged - pre-deprecation purgatory; may someday be deprecated; or not | |||
nil - these parameters are no longer supported. remove entirely | nil - these parameters are no longer supported. remove entirely | ||
]] | ]] | ||
local basic_arguments = { | local basic_arguments = { | ||
['accessdate'] = | ['accessdate'] = 'discouraged', | ||
['access-date'] = true, | ['access-date'] = true, | ||
['agency'] = true, | ['agency'] = true, | ||
['archivedate'] = | ['archivedate'] = 'discouraged', | ||
['archive-date'] = true, | ['archive-date'] = true, | ||
['archive-format'] = true, | ['archive-format'] = true, | ||
['archiveurl'] = | ['archiveurl'] = 'discouraged', | ||
['archive-url'] = true, | ['archive-url'] = true, | ||
['article'] = true, | ['article'] = true, | ||
Line 31: | Line 30: | ||
['author'] = true, | ['author'] = true, | ||
['author-first'] = true, | ['author-first'] = true, | ||
['author-given'] = true, | |||
['author-last'] = true, | ['author-last'] = true, | ||
['authorlink'] = | ['author-surname'] = true, | ||
['authorlink'] = 'discouraged', | |||
['author-link'] = true, | ['author-link'] = 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'] = | ['booktitle'] = false, | ||
['book-title'] = true, | ['book-title'] = true, | ||
['cartography'] = true, | ['cartography'] = true, | ||
['chapter'] = true, | ['chapter'] = true, | ||
['chapter-format'] = true, | ['chapter-format'] = true, | ||
['chapterurl'] = | ['chapterurl'] = false, | ||
['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'] = true, | ||
['conference-format'] = true, | ['conference-format'] = true, | ||
['conference-url'] = true, | ['conference-url'] = true, | ||
['contribution'] = true, | ['contribution'] = true, | ||
['contribution-format'] = true, | ['contribution-format'] = 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-surname'] = true, | ['contributor-surname'] = true, | ||
['contributor-link'] = true, | ['contributor-link'] = true, | ||
Line 71: | Line 69: | ||
['df'] = true, | ['df'] = true, | ||
['dictionary'] = true, | ['dictionary'] = true, | ||
['display-authors'] = true, | ['display-authors'] = true, | ||
['display-contributors'] = true, | ['display-contributors'] = 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 82: | Line 79: | ||
['DOI'] = true, | ['DOI'] = true, | ||
['doi-access'] = true, | ['doi-access'] = true, | ||
['doi-broken-date'] = true, | ['doi-broken-date'] = true, | ||
['edition'] = true, | ['edition'] = true, | ||
['editor'] = true, | ['editor'] = true, | ||
Line 90: | Line 85: | ||
['editor-given'] = true, | ['editor-given'] = true, | ||
['editor-last'] = true, | ['editor-last'] = true, | ||
[' | ['editor-surname'] = true, | ||
['editor-link'] = true, | ['editor-link'] = true, | ||
['editor-mask'] = true, | ['editor-mask'] = true, | ||
['eissn'] = true, | ['eissn'] = true, | ||
['EISSN'] = true, | ['EISSN'] = true, | ||
['encyclopaedia'] = true, | ['encyclopaedia'] = true, | ||
['encyclopedia'] = true, | ['encyclopedia'] = true, | ||
Line 106: | Line 97: | ||
['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'] = true, -- synonym of conference in /Config, but used in Cite speech? | ||
['first'] = true, | ['first'] = true, | ||
['format'] = true, | ['format'] = true, | ||
Line 119: | Line 107: | ||
['id'] = true, | ['id'] = true, | ||
['ID'] = true, | ['ID'] = true, | ||
['institution'] = true, | ['institution'] = true, | ||
['interviewer'] = true, | ['interviewer'] = true, | ||
['interviewer-first'] = true, | ['interviewer-first'] = true, | ||
['interviewer-given'] = true, | |||
['interviewer-last'] = true, | ['interviewer-last'] = true, | ||
[' | ['interviewer-surname'] = true, | ||
['interviewer-link'] = true, | ['interviewer-link'] = true, | ||
['interviewer-mask'] = true, | ['interviewer-mask'] = true, | ||
['isbn'] = true, | ['isbn'] = true, | ||
Line 148: | Line 133: | ||
['language'] = true, | ['language'] = true, | ||
['last'] = true, | ['last'] = true, | ||
['lay-date'] = true, | ['lay-date'] = true, | ||
['lay-source'] = true, | ['lay-source'] = true, | ||
['lay-format'] = true, | ['lay-format'] = true, | ||
['lay-url'] = true, | ['lay-url'] = true, | ||
['lccn'] = true, | ['lccn'] = true, | ||
Line 161: | Line 141: | ||
['location'] = true, | ['location'] = true, | ||
['magazine'] = true, | ['magazine'] = true, | ||
['medium'] = true, | ['medium'] = true, | ||
['minutes'] = true, | ['minutes'] = true, | ||
Line 168: | Line 146: | ||
['mr'] = true, | ['mr'] = true, | ||
['MR'] = true, | ['MR'] = true, | ||
['name-list- | ['name-list-style'] = true, | ||
['newspaper'] = true, | ['newspaper'] = true, | ||
['nopp'] = false, | |||
['nopp'] = | |||
['no-pp'] = true, | ['no-pp'] = true, | ||
['no-tracking'] = true, | ['no-tracking'] = true, | ||
['number'] = true, | ['number'] = true, | ||
Line 182: | Line 157: | ||
['OL'] = true, | ['OL'] = true, | ||
['ol-access'] = true, | ['ol-access'] = true, | ||
['origyear'] = | ['orig-date'] = true, | ||
['origyear'] = 'discouraged', | |||
['orig-year'] = true, | ['orig-year'] = true, | ||
['osti'] = true, | ['osti'] = true, | ||
Line 196: | Line 172: | ||
['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'] = | ['publicationdate'] = false, | ||
['publication-date'] = true, | ['publication-date'] = true, | ||
['publicationplace'] = | ['publicationplace'] = false, | ||
['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 200: | ||
['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, | ||
Line 228: | Line 208: | ||
['section'] = true, | ['section'] = true, | ||
['section-format'] = true, | ['section-format'] = true, | ||
['section-url'] = true, | ['section-url'] = true, | ||
['section-url-access'] = true, | ['section-url-access'] = true, | ||
['series'] = true, | ['series'] = true, | ||
['serieslink'] = | ['serieslink'] = false, | ||
['series-link'] = true, | ['series-link'] = true, | ||
['series-no'] = true, | ['series-no'] = 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, | ||
['subject-link'] = true, | ['subject-link'] = true, | ||
['subject-mask'] = true, | |||
['surname'] = true, | ['surname'] = true, | ||
['s2cid'] = true, | ['s2cid'] = true, | ||
Line 250: | Line 226: | ||
['template-doc-demo'] = true, | ['template-doc-demo'] = true, | ||
['time'] = true, | ['time'] = true, | ||
['time-caption'] = true, | ['time-caption'] = true, | ||
['title'] = true, | ['title'] = true, | ||
['title-link'] = true, | ['title-link'] = true, | ||
['translator'] = true, | ['translator'] = true, | ||
['translator-first'] = true, | ['translator-first'] = 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 244: | ||
['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 299: | Line 270: | ||
['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#'] = | ['authorlink#'] = 'discouraged', | ||
['author#link'] = 'discouraged', | |||
['author-mask#'] = true, | ['author-mask#'] = true, | ||
['author#-mask'] = true, | ['author#-mask'] = 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-surname#'] = true, | ['contributor-surname#'] = true, | ||
['contributor#-surname'] = true, | ['contributor#-surname'] = true, | ||
Line 325: | Line 298: | ||
['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, | ||
['editor-mask#'] = true, | ['editor-mask#'] = true, | ||
['editor#-mask'] = true, | ['editor#-mask'] = true, | ||
['first#'] = true, | ['first#'] = true, | ||
['given#'] = true, | ['given#'] = true, | ||
Line 345: | Line 314: | ||
['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 327: | ||
['subject#'] = true, | ['subject#'] = true, | ||
['subject-link#'] = true, | ['subject-link#'] = true, | ||
['subject#-link'] = true, | ['subject#-link'] = 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-surname#'] = true, | ['translator-surname#'] = true, | ||
['translator#-surname'] = true, | ['translator#-surname'] = true, | ||
Line 381: | Line 354: | ||
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/dicouraged/nil as above. | ||
]] | ]] | ||
Line 388: | Line 361: | ||
arxiv = { | arxiv = { | ||
['arxiv'] = true, -- cite arxiv and arxiv identifiers | ['arxiv'] = true, -- cite arxiv and arxiv identifiers | ||
['class'] = true, | ['class'] = true, | ||
['eprint'] = true, -- cite arxiv and arxiv identifiers | ['eprint'] = true, -- cite arxiv and arxiv identifiers | ||
}, | }, | ||
Line 406: | Line 379: | ||
--[[--------------------------< 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 >---------------------- | ||
cite arxiv, cite biorxiv, cite citeseerx, and cite ssrn templates are preprint templates so are allowed only a | |||
limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined here. | |||
all | |||
Same conventions for true/false/nil as above. | Same conventions for true/false/dicouraged/nil as above. | ||
]] | ]] | ||
Line 418: | Line 390: | ||
['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, | ['author-link'] = true, | ||
[' | ['authorlink'] = 'discouraged', | ||
['author-mask'] = true, | ['author-mask'] = true, | ||
['authors'] = true, | ['authors'] = true, | ||
Line 427: | Line 400: | ||
['date'] = true, | ['date'] = true, | ||
['df'] = true, | ['df'] = true, | ||
['display-authors'] = true, | ['display-authors'] = true, | ||
['first'] = true, | ['first'] = true, | ||
Line 433: | Line 405: | ||
['language'] = true, | ['language'] = true, | ||
['last'] = true, | ['last'] = true, | ||
['mode'] = true, | ['mode'] = true, | ||
['name-list- | ['name-list-style'] = true, | ||
['no-tracking'] = true, | ['no-tracking'] = true, | ||
['p'] = true, | ['p'] = true, | ||
Line 463: | Line 430: | ||
['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#'] = | ['authorlink#'] = 'discouraged', | ||
['author#link'] = 'discouraged', | |||
['author-mask#'] = true, | ['author-mask#'] = true, | ||
['author#-mask'] = true, | ['author#-mask'] = true, | ||
['first#'] = true, | ['first#'] = true, | ||
['given#'] = true, | ['given#'] = true, | ||
Line 482: | Line 451: | ||
--[[--------------------------< 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 | |||
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/dicouraged/nil as above. | ||
]] | ]] | ||
local unique_arguments = { | local unique_arguments = { | ||
['audio-visual'] = { | |||
['transcript'] = true, | |||
['transcript-format'] = true, | |||
['transcripturl'] = false, | |||
['transcript-url'] = true, | |||
}, | |||
episode = { | episode = { | ||
['airdate'] = | ['airdate'] = 'discouraged', | ||
['air-date'] = true, | ['air-date'] = true, | ||
['credits'] = true, | ['credits'] = true, | ||
['episodelink'] = | ['episodelink'] = false, -- 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'] = false, | |||
['transcript-url'] = true, | |||
}, | |||
mailinglist = { | |||
['mailinglist'] = false, | |||
['mailing-list'] = true, | |||
}, | }, | ||
map = { | map = { | ||
['inset'] = true, | |||
['map'] = true, | ['map'] = true, | ||
['map-format'] = true, | ['map-format'] = true, | ||
['mapurl'] = | ['mapurl'] = false, | ||
['map-url'] = true, | ['map-url'] = true, | ||
['map-url-access'] = true, | ['map-url-access'] = true, | ||
Line 516: | Line 500: | ||
}, | }, | ||
serial = { | serial = { | ||
['airdate'] = | ['airdate'] = 'discouraged', | ||
['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'] = | ['episodelink'] = false, | ||
['episode-link'] = true, | ['episode-link'] = true, -- alias of |title-link= | ||
['network'] = true, | ['network'] = true, | ||
['station'] = true, | ['station'] = true, |
Latest revision as of 11:41, 21 May 2021
Documentation for this module may be created at Module:Citation/CS1/Whitelist/doc
--[[--------------------------< 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 discouraged - pre-deprecation purgatory; may someday be deprecated; or not nil - these parameters are no longer supported. remove entirely ]] local basic_arguments = { ['accessdate'] = 'discouraged', ['access-date'] = true, ['agency'] = true, ['archivedate'] = 'discouraged', ['archive-date'] = true, ['archive-format'] = true, ['archiveurl'] = 'discouraged', ['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'] = 'discouraged', ['author-link'] = true, ['author-mask'] = true, ['authors'] = true, ['bibcode'] = true, ['bibcode-access'] = true, ['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier ['booktitle'] = false, ['book-title'] = true, ['cartography'] = true, ['chapter'] = true, ['chapter-format'] = true, ['chapterurl'] = false, ['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, ['conference-url'] = true, ['contribution'] = true, ['contribution-format'] = 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, ['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, ['editor-link'] = true, ['editor-mask'] = true, ['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, -- synonym of conference in /Config, but used in Cite speech? ['first'] = true, ['format'] = true, ['given'] = true, ['hdl'] = true, ['HDL'] = true, ['hdl-access'] = true, ['host'] = true, ['id'] = true, ['ID'] = 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, ['lay-date'] = true, ['lay-source'] = true, ['lay-format'] = true, ['lay-url'] = true, ['lccn'] = true, ['LCCN'] = true, ['location'] = true, ['magazine'] = true, ['medium'] = true, ['minutes'] = true, ['mode'] = true, ['mr'] = true, ['MR'] = true, ['name-list-style'] = true, ['newspaper'] = true, ['nopp'] = false, ['no-pp'] = true, ['no-tracking'] = true, ['number'] = true, ['oclc'] = true, ['OCLC'] = true, ['ol'] = true, ['OL'] = true, ['ol-access'] = true, ['orig-date'] = true, ['origyear'] = 'discouraged', ['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'] = false, ['publication-date'] = true, ['publicationplace'] = false, ['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, ['section-url'] = true, ['section-url-access'] = true, ['series'] = true, ['serieslink'] = false, ['series-link'] = true, ['series-no'] = true, ['series-number'] = true, ['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier ['SSRN'] = true, ['subject'] = true, ['subject-link'] = true, ['subject-mask'] = true, ['surname'] = true, ['s2cid'] = true, ['S2CID'] = true, ['s2cid-access'] = true, ['template-doc-demo'] = true, ['time'] = true, ['time-caption'] = true, ['title'] = true, ['title-link'] = true, ['translator'] = true, ['translator-first'] = true, ['translator-given'] = true, ['translator-last'] = true, ['translator-surname'] = true, ['translator-link'] = true, ['translator-mask'] = true, ['trans-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#'] = 'discouraged', ['author#link'] = 'discouraged', ['author-mask#'] = true, ['author#-mask'] = true, ['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, ['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, ['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/dicouraged/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 >---------------------- cite arxiv, cite biorxiv, cite citeseerx, and cite ssrn templates are preprint templates so are allowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined here. Same conventions for true/false/dicouraged/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'] = 'discouraged', ['author-mask'] = true, ['authors'] = true, ['collaboration'] = true, ['date'] = true, ['df'] = true, ['display-authors'] = true, ['first'] = true, ['given'] = true, ['language'] = true, ['last'] = true, ['mode'] = true, ['name-list-style'] = 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#'] = 'discouraged', ['author#link'] = 'discouraged', ['author-mask#'] = true, ['author#-mask'] = true, ['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/dicouraged/nil as above. ]] local unique_arguments = { ['audio-visual'] = { ['transcript'] = true, ['transcript-format'] = true, ['transcripturl'] = false, ['transcript-url'] = true, }, episode = { ['airdate'] = 'discouraged', ['air-date'] = true, ['credits'] = true, ['episodelink'] = false, -- alias of |title-link= ['episode-link'] = true, -- alias of |title-link= ['network'] = true, ['station'] = true, ['transcript'] = true, ['transcript-format'] = true, ['transcripturl'] = false, ['transcript-url'] = true, }, mailinglist = { ['mailinglist'] = false, ['mailing-list'] = true, }, map = { ['inset'] = true, ['map'] = true, ['map-format'] = true, ['mapurl'] = false, ['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'] = 'discouraged', ['air-date'] = true, ['credits'] = true, ['episode'] = true, -- cite serial only TODO: make available to cite episode? ['episodelink'] = false, ['episode-link'] = true, -- alias of |title-link= ['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 };