Module:Citation/CS1/Whitelist: Difference between revisions

sync from sandbox;
(sync from sandbox;)
(sync from sandbox;)
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
Line 10: Line 11:


local basic_arguments = {
local basic_arguments = {
['accessdate'] = true,
['accessdate'] = 'discouraged',
['access-date'] = true,
['access-date'] = true,
['agency'] = true,
['agency'] = true,
['archivedate'] = true,
['archivedate'] = 'discouraged',
['archive-date'] = true,
['archive-date'] = true,
['archive-format'] = true,
['archive-format'] = true,
['archiveurl'] = true,
['archiveurl'] = 'discouraged',
['archive-url'] = true,
['archive-url'] = true,
['article'] = true,
['article'] = true,
Line 32: Line 33:
['author-last'] = true,
['author-last'] = true,
['author-surname'] = true,
['author-surname'] = true,
['authorlink'] = true,
['authorlink'] = 'discouraged',
['author-link'] = true,
['author-link'] = true,
['author-mask'] = true,
['author-mask'] = true,
Line 39: Line 40:
['bibcode-access'] = true,
['bibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['booktitle'] = false,
['book-title'] = true,
['book-title'] = true,
['cartography'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapter-format'] = true,
['chapterurl'] = true,
['chapterurl'] = false,
['chapter-url'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['chapter-url-access'] = true,
Line 51: Line 52:
['conference'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-format'] = true,
['conferenceurl'] = false,
['conference-url'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contribution-format'] = true,
['contributionurl'] = false,
['contribution-url'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contribution-url-access'] = true,
Line 98: 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, -- synonym of conference in /Config, but used in Cite speech?
['event'] = true, -- synonym of conference in /Config, but used in Cite speech?
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
Line 134: Line 133:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['laydate'] = false,
['lay-date'] = true,
['lay-date'] = true,
['laysource'] = false,
['lay-source'] = true,
['lay-source'] = true,
['lay-format'] = true,
['lay-format'] = true,
['layurl'] = false,
['lay-url'] = true,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
Line 150: Line 146:
['mr'] = true,
['mr'] = true,
['MR'] = true,
['MR'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['newspaper'] = true,
['nopp'] = true,
['nopp'] = false,
['no-pp'] = true,
['no-pp'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
Line 163: Line 158:
['ol-access'] = true,
['ol-access'] = true,
['orig-date'] = true,
['orig-date'] = true,
['origyear'] = true,
['origyear'] = 'discouraged',
['orig-year'] = true,
['orig-year'] = true,
['osti'] = true,
['osti'] = true,
Line 182: Line 177:
['postscript'] = true,
['postscript'] = true,
['pp'] = true,
['pp'] = true,
['publicationdate'] = true,
['publicationdate'] = false,
['publication-date'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publicationplace'] = false,
['publication-place'] = true,
['publication-place'] = true,
['publisher'] = true,
['publisher'] = true,
Line 213: Line 208:
['section'] = true,
['section'] = true,
['section-format'] = true,
['section-format'] = true,
['sectionurl'] = false,
['section-url'] = true,
['section-url'] = true,
['section-url-access'] = true,
['section-url-access'] = true,
['series'] = true,
['series'] = true,
['serieslink'] = true,
['serieslink'] = false,
['series-link'] = true,
['series-link'] = true,
['seriesno'] = false,
['series-no'] = false,
['series-no'] = true,
['series-number'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
Line 233: Line 226:
['template-doc-demo'] = true,
['template-doc-demo'] = true,
['time'] = true,
['time'] = true,
['timecaption'] = false,
['time-caption'] = true,
['time-caption'] = true,
['title'] = true,
['title'] = true,
['titlelink'] = false,
['title-link'] = true,
['title-link'] = true,
['translator'] = true,
['translator'] = true,
Line 287: Line 278:
['author-link#'] = true,
['author-link#'] = true,
['author#-link'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['authorlink#'] = 'discouraged',
['author#link'] = true,
['author#link'] = 'discouraged',
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
Line 363: 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 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 >----------------------


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/dicouraged/nil as above.
]]
]]
Line 404: Line 394:
['author-surname'] = true,
['author-surname'] = true,
['author-link'] = true,
['author-link'] = true,
['authorlink'] = true,
['authorlink'] = 'discouraged',
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['authors'] = true,
Line 416: Line 406:
['last'] = true,
['last'] = true,
['mode'] = true,
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
Line 449: Line 438:
['author-link#'] = true,
['author-link#'] = true,
['author#-link'] = true,
['author#-link'] = true,
['authorlink#'] = true,
['authorlink#'] = 'discouraged',
['author#link'] = true,
['author#link'] = 'discouraged',
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
Line 465: Line 454:
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.


]]
]]
Line 473: Line 462:
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
['transcript-url'] = true,
},
},
episode = {
episode = {
['airdate'] = true,
['airdate'] = 'discouraged',
['air-date'] = true,
['air-date'] = true,
['credits'] = true,
['credits'] = true,
['episodelink'] = true, -- alias of |title-link=
['episodelink'] = false, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['network'] = true,
Line 486: Line 475:
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
['transcript-url'] = true,
},
},
mailinglist = {
mailinglist = {
['mailinglist'] = true,
['mailinglist'] = false,
['mailing-list'] = true,
['mailing-list'] = true,
},
},
Line 497: Line 486:
['map'] = true,
['map'] = true,
['map-format'] = true,
['map-format'] = true,
['mapurl'] = true,
['mapurl'] = false,
['map-url'] = true,
['map-url'] = true,
['map-url-access'] = true,
['map-url-access'] = true,
Line 511: Line 500:
},
},
serial = {
serial = {
['airdate'] = true,
['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'] = true, -- aliases of |title-link=
['episodelink'] = false,
['episode-link'] = true,
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['network'] = true,
['station'] = true,
['station'] = true,