Changes
Module:Citation/CS1/Whitelist (view source)
Revision as of 14:11, 22 January 2022
, 14:11, 22 January 2022update per RfC;
--[[--------------------------< 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 >--------------------------------------
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 basic_arguments = {
local basic_arguments = {
['accessdate'] = 'discouraged',
['accessdate'] = true,
['access-date'] = true,
['access-date'] = true,
['agency'] = true,
['agency'] = true,
['archivedate'] = 'discouraged',
['archivedate'] = true,
['archive-date'] = true,
['archive-date'] = true,
['archive-format'] = true,
['archive-format'] = true,
['archiveurl'] = 'discouraged',
['archiveurl'] = true,
['archive-url'] = true,
['archive-url'] = true,
['article'] = true,
['article'] = true,
['author-last'] = true,
['author-last'] = true,
['author-surname'] = true,
['author-surname'] = true,
['authorlink'] = 'discouraged',
['authorlink'] = true,
['author-link'] = true,
['author-link'] = true,
['author-mask'] = true,
['author-mask'] = true,
['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
['chapter'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapter-format'] = true,
['chapter-url'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['collaboration'] = true,
['collaboration'] = true,
['contribution'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contribution-format'] = true,
['contributor-mask'] = true,
['contributor-mask'] = true,
['date'] = true,
['date'] = true,
['department'] = true,
['department'] = true,
['df'] = true,
['df'] = true,
['display-subjects'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['display-translators'] = true,
['doi'] = true,
['doi'] = true,
['DOI'] = true,
['DOI'] = true,
['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
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
['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,
['institution'] = true,
['institution'] = true, -- constrain to cite thesis?
['interviewer'] = true,
['interviewer'] = true,
['interviewer-first'] = true,
['interviewer-first'] = true,
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
['ismn'] = true,
['ismn'] = true,
['ISMN'] = true,
['ISMN'] = true,
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lay-date'] = true,
['lay-date'] = false,
['lay-source'] = true,
['lay-format'] = false,
['lay-format'] = true,
['lay-source'] = false,
['lay-url'] = true,
['lay-url'] = false,
['lccn'] = true,
['lccn'] = true,
['LCCN'] = true,
['LCCN'] = true,
['magazine'] = true,
['magazine'] = true,
['medium'] = true,
['medium'] = true,
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mode'] = true,
['mr'] = true,
['mr'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['newspaper'] = true,
['no-pp'] = true,
['no-pp'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
['ol-access'] = true,
['ol-access'] = true,
['orig-date'] = true,
['orig-date'] = true,
['origyear'] = 'discouraged',
['origyear'] = true,
['orig-year'] = true,
['orig-year'] = true,
['osti'] = true,
['osti'] = true,
['postscript'] = true,
['postscript'] = true,
['pp'] = true,
['pp'] = true,
['publication-date'] = true,
['publication-date'] = true,
['publication-place'] = true,
['publication-place'] = true,
['publisher'] = true,
['publisher'] = true,
['script-website'] = true,
['script-website'] = true,
['script-work'] = true,
['script-work'] = true,
['section'] = true,
['section'] = true,
['section-format'] = true,
['section-format'] = true,
['section-url-access'] = true,
['section-url-access'] = true,
['series'] = true,
['series'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
['subject'] = true,
['subject'] = true,
['subject-link'] = true,
['subject-link'] = true,
['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?
['time-caption'] = true,
['time-caption'] = true, -- constrain to cite av media and podcast?
['title'] = true,
['title'] = true,
['title-link'] = true,
['title-link'] = true,
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
}
local numbered_arguments = {
local numbered_arguments = {
['author-link#'] = true,
['author-link#'] = true,
['author#-link'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged',
['authorlink#'] = true,
['author#link'] = 'discouraged',
['author#link'] = true,
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
['translator-mask#'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
['translator#-mask'] = true,
}
}
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/dicouraged/nil as above.
Same conventions for true/false/tracked/nil as above.
]]
]]
['ssrn'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
},
}
}
limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined here.
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.
Same conventions for true/false/tracked/nil as above.
]]
]]
['author-surname'] = true,
['author-surname'] = true,
['author-link'] = true,
['author-link'] = true,
['authorlink'] = 'discouraged',
['authorlink'] = true,
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['authors'] = true,
['title'] = true,
['title'] = true,
['trans-title'] = true,
['trans-title'] = true,
['vauthors'] = true,
['vauthors'] = true,
['year'] = true,
['year'] = true,
}
}
local limited_numbered_arguments = {
local limited_numbered_arguments = {
['author-link#'] = true,
['author-link#'] = true,
['author#-link'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged',
['authorlink#'] = true,
['author#link'] = 'discouraged',
['author#link'] = true,
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
table are the template's CitationClass parameter value
table are the template's CitationClass parameter value
Same conventions for true/false/dicouraged/nil as above.
Same conventions for true/false/tracked/nil as above.
]]
]]
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcript-url'] = true,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
},
episode = {
episode = {
['airdate'] = 'discouraged',
['airdate'] = true,
['air-date'] = true,
['air-date'] = true,
['credits'] = true,
['credits'] = true,
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['network'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['station'] = true,
['transcript'] = true,
['transcript'] = true,
},
},
mailinglist = {
mailinglist = {
['mailing-list'] = true,
['mailing-list'] = true,
},
},
map = {
map = {
['cartography'] = true,
['inset'] = true,
['inset'] = true,
['map'] = true,
['map'] = true,
['map-format'] = true,
['map-format'] = true,
['map-url'] = true,
['map-url'] = true,
['map-url-access'] = true,
['map-url-access'] = true,
['message-id'] = true,
['message-id'] = true,
['newsgroup'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
},
serial = {
serial = {
['airdate'] = 'discouraged',
['airdate'] = true,
['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?
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['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,
},
},
}
}