Open main menu

Changes

Module:Citation/CS1/Whitelist

1,393 bytes added, 11:05, 3 September 2019
sync from sandbox;
This is a list of parameters that once were but now are no longer supported:
['albumlink'] = nil, -- unique alias of titlelink used by old cite AV media notes ['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes ['artist'] = nil, -- unique alias of others used by old cite AV media notes ['ARXIV'] = nil, -- not an initialization ['Author'] = nil, -- non-standard capitalization ['authorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['author-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['author-name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['author-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['began'] = nil, -- module handles date ranges; cite episode and cite series ['BIBCODE'] = nil, -- not an initialization ['callsign'] = nil, -- cite interview removed ['call-sign'] = nil, -- cite interview removed ['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked ['chapter-link'] = nil, -- ['city'] = nil, -- cite interview removed ['coauthor'] = nil, -- redundant to |authorn=; not made part of metadata ['coauthors'] = nil, -- redundant to |authorn=; not made part of metadata ['cointerviewers'] = nil, -- unique alias of others used by old cite interview ['day'] = nil, -- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed ['director'] = nil, -- unique alias of author used by old cite DVD-notes ['doi_brokendate'] = nil, -- alias of doi-broken-date ['doi_inactivedate'] = nil, -- alias of doi-inactive-date ['DoiBroken'] = nil, -- not used, non-standard captialization ['Editor'] = nil, -- non-standard capitalization ['editorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['EditorSurname'] = nil, -- non-standard capitalization ['editor-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['EditorGiven'] = nil, -- non-standard capitalization ['editor-name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['editor-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['Embargo'] = nil, -- not used, non-standard capitalization ['ended'] = nil, -- module handles date ranges; cite episode and cite series ['in'] = nil, -- ambiguous between use for language, appearance of a lesser work in an edited work ['interviewers'] = nil, -- only need InterviewerList support ['month'] = nil, -- functionality supported by |date= ['name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format ['notestitle'] = nil, -- unique alias of chapter used by old cite AV media notes ['PPrefix'] = nil, -- non-standard capitalization ['PPPrefix'] = nil, -- not used, non-standard capitalization ['pp-prefix'] = nil, -- not used, not documented ['p-prefix'] = nil, -- not used, not documented ['program'] = nil, -- cite interview removed ['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes ['Ref'] = nil, -- non-standard capitalization ['separator'] = nil, -- this functionality now provided by |mode= ['template doc demo'] = nil, -- alias of template doc demo ['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes ['trans_chapter'] = nil, -- alias of trans-chapter ['trans_title'] = nil, -- alias of trans-title
['Author#'] = nil, -- non-standard capitalization ['authors#'] = nil, -- no need for multiple lists of author names ['Editor#'] = nil, -- non-standard capitalization ['editors#'] = nil, -- no need for multiple lists of editor names ['EditorGiven#'] = nil, -- non-standard capitalization ['EditorSurname#'] = nil, -- non-standard capitalization
]]
 
--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------
['archive-url'] = true,
['article'] = true,
['article-format'] = true,
['article-url'] = true,
['article-url-access'] = true,
['arxiv'] = true,
['asin'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = truefalse, -- not an identifier but an identifier-modifier
['at'] = true,
['author'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true,
['class'] = truefalse, -- cite arxiv and arxiv identifiersonly; general use deprecated
['collaboration'] = true,
['conference'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-link'] = true,
['contributor-mask'] = true,
['credits'] = true, -- cite episode, cite serial
['date'] = true,
['deadurl'] = truefalse, ['dead-url'] = truefalse,
['degree'] = true,
['department'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['display-contributors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['encyclopedia'] = true,
['entry'] = true,
['entry-format'] = true,
['entry-url'] = true,
['entry-url-access'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- cite episode and cite serial
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['interviewermask'] = true,
['interviewer-mask'] = true,
['interviewers'] = true,
['isbn'] = true,
['ISBN'] = true,
['JSTOR'] = true,
['jstor-access'] = true,
['lang'] = true,
['language'] = true,
['last'] = true,
['laysource'] = true,
['lay-source'] = true,
['laysummary'] = truefalse, ['lay-summary'] = truefalse,
['lay-format'] = true,
['layurl'] = true,
['location'] = true,
['magazine'] = true,
['mailinglist'] = true, -- cite mailing list only ['mailing-list'] = true, -- cite mailing list only ['map'] = true, -- cite map only ['map-format'] = true, -- cite map only ['mapurl'] = true, -- cite map only ['map-url'] = true, -- cite map only ['map-url-access'] = true, -- cite map only
['medium'] = true,
['message-id'] = true, -- cite newsgroup
['minutes'] = true,
['mode'] = true,
['quote'] = true,
['ref'] = true,
['registration'] = truefalse,
['rfc'] = true,
['RFC'] = 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-section'] = true,
['script-title'] = true,
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
['sections'] = true, -- cite map only
['sectionurl'] = true,
['section-url'] = true,
['section-url-access'] = true,
['series'] = true,
['serieslink'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subscription'] = truefalse,
['surname'] = true,
['template-doc-demo'] = true,
['titlelink'] = true,
['title-link'] = true,
['trans-chapter'] = true,
['trans-map'] = true,
['transcript'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['trans-title'] = true,
['translator'] = true,
['translator-first'] = 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-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,
['first#'] = true,
['given#'] = true,
['host#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
}
--[[--------------------------< C I T E A R X I V S U P P O R T E D P A R A M E T E R S >----------------
This is an experiment --[[--------------------------< 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 attempts to use validate() the limited set of parametersdefined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a limited template-specific list of valid parameters that are required by the particular template and may be exclusive to validate one of theparameters provided in a cite arxiv templateproeprint templates. This method might Some of these parameters may also be expanded available to other the general cs1|2 templates being considered.
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
]]
--[[--------------------------< C I T E A R X I V >---------------------------------------------------------- 
This is a list of parameters that once were but now are no longer supported:
['ARXIV'] = nil, -- not an initialization ['version'] = nil, -- this is the cite arxiv parameter; |version= still supported by other cs1|2 templates
]]
local arxiv_basic_arguments = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers ['class'] = true, -- cite arxiv and arxiv identifiersonly
['eprint'] = true, -- cite arxiv and arxiv identifiers
}
--[[--------------------------< C I T E B I O R X I V 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 theparameters provided in a cite biorxiv template. This method might be expanded to other templates being considered.------------------------------------------
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 (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
]]
--[[--------------------------< C I T E C I T E S E E R X 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 theparameters provided in a cite citeseerx template. This method might be expanded to other templates being considered.------------------------------------------
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 (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
]]
local citeseerx_basic_arguments = {
['citeseerx'] = true,
}
 
 
--[[--------------------------< C I T E S S R N >------------------------------------------------------------
 
]]
 
local ssrn_basic_arguments = {
['ssrn'] = true,
['SSRN'] = true,
}
['date'] = true,
['df'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['first'] = true,
['year'] = true,
}
 
local limited_numbered_arguments = {
['author#'] = true,
['surname#'] = true,
}
 
 
--[[--------------------------< E X P O R T E D T A B L E S >------------------------------------------------
]]
return {
arxiv_basic_arguments = arxiv_basic_arguments,
biorxiv_basic_arguments = biorxiv_basic_arguments,
citeseerx_basic_arguments = citeseerx_basic_arguments, ssrn_basic_arguments = ssrn_basic_arguments };