Difference between revisions of "Module:Citation/CS1/Whitelist"

From Wikispooks
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
 
(9 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
This is a list of parameters that once were but now are no longer supported:
 
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
+
['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
+
['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
+
['artist'] = nil, -- unique alias of others used by old cite AV media notes
−
['Author'] = nil, -- non-standard capitalization
+
['ARXIV'] = nil, -- not an initialization
−
['authorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['Author'] = nil, -- non-standard capitalization
−
['author-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['authorformat'] = 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-format'] = 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
+
['author-name-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
+
['author-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
−
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked  
+
['began'] = nil, -- module handles date ranges; cite episode and cite series
−
['chapter-link'] = nil, --  
+
['BIBCODE'] = nil, -- not an initialization
−
['cointerviewers'] = nil, -- unique alias of others used by old cite interview
+
['callsign'] = nil, -- cite interview removed
−
['day'] = nil, -- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed
+
['call-sign'] = nil, -- cite interview removed
−
['director'] = nil, -- unique alias of author used by old cite DVD-notes
+
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked  
−
['DoiBroken'] = nil, -- not used, non-standard captialization
+
['chapter-link'] = nil, --  
−
['Editor'] = nil, -- non-standard capitalization
+
['city'] = nil, -- cite interview removed
−
['editorformat'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['coauthor'] = nil, -- redundant to |authorn=; not made part of metadata
−
['EditorSurname'] = nil, -- non-standard capitalization
+
['coauthors'] = nil, -- redundant to |authorn=; not made part of metadata
−
['editor-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['cointerviewers'] = nil, -- unique alias of others used by old cite interview
−
['EditorGiven'] = nil, -- non-standard capitalization
+
['day'] = nil, -- deprecated in {{citation/core}} and somehow undeprecated in Module:Citation/CS1 and now finally removed
−
['editor-name-separator'] = nil,-- primarily used to support Vancouver format which functionality now part of name-list-format
+
['director'] = nil, -- unique alias of author used by old cite DVD-notes
−
['editor-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['doi_brokendate'] = nil,    -- alias of doi-broken-date
−
['Embargo'] = nil, -- not used, non-standard capitalization
+
['doi_inactivedate'] = nil, -- alias of doi-inactive-date
−
['ended'] = nil, -- module handles date ranges; cite episode and cite series
+
['DoiBroken'] = nil, -- not used, non-standard captialization
−
['month'] = nil, -- functionality supported by |date=
+
['Editor'] = nil, -- non-standard capitalization
−
['name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
+
['editorformat'] = 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
+
['EditorSurname'] = nil, -- non-standard capitalization
−
['PPrefix'] = nil, -- non-standard capitalization
+
['editor-format'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
−
['PPPrefix'] = nil, -- not used, non-standard capitalization
+
['EditorGiven'] = nil, -- non-standard capitalization
−
['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes
+
['editor-name-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
−
['separator'] = nil, -- this functionality now provided by |mode=
+
['editor-separator'] = nil, -- primarily used to support Vancouver format which functionality now part of name-list-format
−
['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes
+
['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
+
['Author#'] = nil, -- non-standard capitalization
−
['authors#'] = nil, -- no need for multiple lists of author names
+
['authors#'] = nil, -- no need for multiple lists of author names
−
['Editor#'] = nil, -- non-standard capitalization
+
['Editor#'] = nil, -- non-standard capitalization
−
['editors#'] = nil, -- no need for multiple lists of editor names
+
['editors#'] = nil, -- no need for multiple lists of editor names
−
['EditorGiven#'] = nil, -- non-standard capitalization
+
['EditorGiven#'] = nil, -- non-standard capitalization
−
['EditorSurname#'] = 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 >--------------------------------------
 
--[[--------------------------< S U P P O R T E D  P A R A M E T E R S >--------------------------------------
Line 69: Line 88:
 
['archive-url'] = true,
 
['archive-url'] = true,
 
['article'] = true,
 
['article'] = true,
 +
['article-format'] = true,
 +
['article-url'] = true,
 +
['article-url-access'] = true,
 
['arxiv'] = true,
 
['arxiv'] = true,
−
['ARXIV'] = true,
 
 
['asin'] = true,
 
['asin'] = true,
 
['ASIN'] = true,
 
['ASIN'] = true,
 
['asin-tld'] = true,
 
['asin-tld'] = true,
−
['ASIN-TLD'] = true,
+
['ASIN-TLD'] = false, -- not an identifier but an identifier-modifier
 
['at'] = true,
 
['at'] = true,
 
['author'] = true,
 
['author'] = true,
Line 85: Line 106:
 
['authors'] = true,
 
['authors'] = true,
 
['bibcode'] = true,
 
['bibcode'] = true,
−
['BIBCODE'] = true,
+
['bibcode-access'] = true,
 +
['biorxiv'] = true,
 
['booktitle'] = true,
 
['booktitle'] = true,
 
['book-title'] = true,
 
['book-title'] = true,
−
['callsign'] = true, -- cite interview
 
−
['call-sign'] = true, -- cite interview
 
 
['cartography'] = true,
 
['cartography'] = true,
 
['chapter'] = true,
 
['chapter'] = true,
Line 95: Line 115:
 
['chapterurl'] = true,
 
['chapterurl'] = true,
 
['chapter-url'] = true,
 
['chapter-url'] = true,
−
['city'] = true, -- cite interview, cite episode, cite serial
+
['chapter-url-access'] = true,
−
['class'] = true, -- cite arxiv and arxiv identifiers
+
['citeseerx'] = true,
−
['coauthor'] = false, -- deprecated
+
['class'] = false, -- cite arxiv only; general use deprecated
−
['coauthors'] = false, -- deprecated
+
['collaboration'] = true,
 
['conference'] = true,
 
['conference'] = true,
 
['conference-format'] = true,
 
['conference-format'] = true,
Line 107: Line 127:
 
['contributionurl'] = true,
 
['contributionurl'] = true,
 
['contribution-url'] = true,
 
['contribution-url'] = true,
−
['credits'] = true, -- cite episode, cite serial
+
['contribution-url-access'] = true,
 +
['contributor'] = true,
 +
['contributor-first'] = true,
 +
['contributor-last'] = true,
 +
['contributor-given'] = true,
 +
['contributor-surname'] = true,
 +
['contributor-link'] = true,
 +
['contributor-mask'] = true,
 +
['credits'] = true, -- cite episode, cite serial
 
['date'] = true,
 
['date'] = true,
−
['deadurl'] = true,
+
['deadurl'] = false,
−
['dead-url'] = true,
+
['dead-url'] = false,
 
['degree'] = true,
 
['degree'] = true,
 
['department'] = true,
 
['department'] = true,
 +
['df'] = true,
 
['dictionary'] = true,
 
['dictionary'] = true,
 
['displayauthors'] = true,
 
['displayauthors'] = true,
 
['display-authors'] = true,
 
['display-authors'] = true,
 +
['display-contributors'] = true,
 
['displayeditors'] = true,
 
['displayeditors'] = true,
 
['display-editors'] = true,
 
['display-editors'] = true,
 +
['display-interviewers'] = true,
 +
['display-translators'] = true,
 
['docket'] = true,
 
['docket'] = true,
 
['doi'] = true,
 
['doi'] = true,
 
['DOI'] = true,
 
['DOI'] = true,
 +
['doi-access'] = true,
 
['doi-broken'] = true,
 
['doi-broken'] = true,
−
['doi_brokendate'] = true,
 
 
['doi-broken-date'] = true,
 
['doi-broken-date'] = true,
−
['doi_inactivedate'] = true,
 
 
['doi-inactive-date'] = true,
 
['doi-inactive-date'] = true,
 
['edition'] = true,
 
['edition'] = true,
Line 137: Line 168:
 
['editors'] = true,
 
['editors'] = true,
 
['editor-surname'] = true,
 
['editor-surname'] = true,
 +
['eissn'] = true,
 +
['EISSN'] = true,
 
['embargo'] = true,
 
['embargo'] = true,
 
['encyclopaedia'] = true,
 
['encyclopaedia'] = true,
 
['encyclopedia'] = true,
 
['encyclopedia'] = true,
 
['entry'] = true,
 
['entry'] = true,
 +
['entry-format'] = true,
 +
['entry-url'] = true,
 +
['entry-url-access'] = 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, -- cite episode and cite serial
 
['episodelink'] = true, -- cite episode and cite serial
Line 152: Line 188:
 
['format'] = true,
 
['format'] = true,
 
['given'] = true,
 
['given'] = true,
 +
['hdl'] = true,
 +
['HDL'] = true,
 +
['hdl-access'] = true,
 
['host'] = true,
 
['host'] = true,
 
['id'] = true,
 
['id'] = true,
Line 157: Line 196:
 
['ignoreisbnerror'] = true,
 
['ignoreisbnerror'] = true,
 
['ignore-isbn-error'] = true,
 
['ignore-isbn-error'] = true,
−
['in'] = true,
 
 
['inset'] = true,
 
['inset'] = true,
 
['institution'] = true,
 
['institution'] = true,
−
['interviewer'] = true, --cite interview
+
['interviewer'] = true,
−
['interviewers'] = true, --cite interview
+
['interviewer-first'] = true,
 +
['interviewer-last'] = true,
 +
['interviewerlink'] = true,
 +
['interviewer-link'] = true,
 +
['interviewermask'] = true,
 +
['interviewer-mask'] = true,
 
['isbn'] = true,
 
['isbn'] = true,
 
['ISBN'] = true,
 
['ISBN'] = true,
Line 176: Line 219:
 
['jstor'] = true,
 
['jstor'] = true,
 
['JSTOR'] = true,
 
['JSTOR'] = true,
 +
['jstor-access'] = true,
 +
['lang'] = true,
 
['language'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last'] = true,
Line 184: Line 229:
 
['laysource'] = true,
 
['laysource'] = true,
 
['lay-source'] = true,
 
['lay-source'] = true,
−
['laysummary'] = true,
+
['laysummary'] = false,
−
['lay-summary'] = true,
+
['lay-summary'] = false,
 
['lay-format'] = true,
 
['lay-format'] = true,
 
['layurl'] = true,
 
['layurl'] = true,
Line 193: Line 238:
 
['location'] = true,
 
['location'] = true,
 
['magazine'] = true,
 
['magazine'] = true,
−
['mailinglist'] = true, -- cite mailing list only
+
['mailinglist'] = true, -- cite mailing list only
−
['mailing-list'] = true, -- cite mailing list only
+
['mailing-list'] = true, -- cite mailing list only
−
['map'] = true, -- cite map only
+
['map'] = true, -- cite map only
−
['map-format'] = true, -- cite map only
+
['map-format'] = true, -- cite map only
−
['mapurl'] = true, -- cite map only
+
['mapurl'] = true, -- cite map only
−
['map-url'] = true, -- cite map only
+
['map-url'] = true, -- cite map only
 +
['map-url-access'] = true, -- cite map only
 
['medium'] = true,
 
['medium'] = true,
−
['message-id'] = true, -- cite newsgroup
+
['message-id'] = true, -- cite newsgroup
 
['minutes'] = true,
 
['minutes'] = true,
 
['mode'] = true,
 
['mode'] = true,
Line 220: Line 266:
 
['ol'] = true,
 
['ol'] = true,
 
['OL'] = true,
 
['OL'] = true,
 +
['ol-access'] = 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 237: Line 285:
 
['postscript'] = true,
 
['postscript'] = true,
 
['pp'] = true,
 
['pp'] = true,
−
['pp-prefix'] = true,
 
−
['p-prefix'] = true,
 
−
['program'] = true, -- cite interview
 
 
['publicationdate'] = true,
 
['publicationdate'] = true,
 
['publication-date'] = true,
 
['publication-date'] = true,
Line 248: Line 293:
 
['quote'] = true,
 
['quote'] = true,
 
['ref'] = true,
 
['ref'] = true,
−
['Ref'] = false, -- deprecated, non-statndard capitalization
+
['registration'] = false,
−
['registration'] = true,
 
 
['rfc'] = true,
 
['rfc'] = true,
 
['RFC'] = true,
 
['RFC'] = 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-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,
−
['sections'] = true, -- cite map only
+
['sections'] = true, -- cite map only
 
['sectionurl'] = true,
 
['sectionurl'] = true,
 
['section-url'] = true,
 
['section-url'] = true,
 +
['section-url-access'] = true,
 
['series'] = true,
 
['series'] = true,
 
['serieslink'] = true,
 
['serieslink'] = true,
Line 277: Line 332:
 
['subjectlink'] = true,
 
['subjectlink'] = true,
 
['subject-link'] = true,
 
['subject-link'] = true,
−
['subscription'] = true,
+
['subscription'] = false,
 
['surname'] = true,
 
['surname'] = true,
−
['template doc demo'] = true,
 
 
['template-doc-demo'] = true,
 
['template-doc-demo'] = true,
 
['time'] = true,
 
['time'] = true,
Line 287: Line 341:
 
['titlelink'] = true,
 
['titlelink'] = true,
 
['title-link'] = true,
 
['title-link'] = true,
−
['trans_chapter'] = true,
 
−
['trans-chapter'] = true,
 
 
['trans-map'] = true,
 
['trans-map'] = true,
 
['transcript'] = true,
 
['transcript'] = true,
Line 294: Line 346:
 
['transcripturl'] = true,
 
['transcripturl'] = true,
 
['transcript-url'] = true,
 
['transcript-url'] = true,
−
['trans_title'] = true,
 
−
['trans-title'] = true,
 
 
['translator'] = true,
 
['translator'] = true,
 
['translator-first'] = true,
 
['translator-first'] = true,
 
['translator-last'] = true,
 
['translator-last'] = true,
 +
['translator-given'] = 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-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 330: Line 396:
 
['author#-mask'] = true,
 
['author#-mask'] = true,
 
['authormask#'] = true,
 
['authormask#'] = true,
 +
['contributor#'] = true,
 +
['contributor-first#'] = true,
 +
['contributor#-first'] = true,
 +
['contributor-last#'] = true,
 +
['contributor#-last'] = true,
 +
['contributor-given#'] = true,
 +
['contributor#-given'] = 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,
Line 349: Line 428:
 
['first#'] = true,
 
['first#'] = true,
 
['given#'] = true,
 
['given#'] = true,
 +
['host#'] = true,
 +
['interviewer#'] = true,
 +
['interviewer-first#'] = true,
 +
['interviewer#-first'] = true,
 +
['interviewer-last#'] = true,
 +
['interviewer#-last'] = true,
 +
['interviewer-link#'] = true,
 +
['interviewer#-link'] = true,
 +
['interviewer-mask#'] = true,
 +
['interviewer#-mask'] = true,
 
['last#'] = true,
 
['last#'] = true,
 
['subject#'] = true,
 
['subject#'] = true,
Line 361: Line 450:
 
['translator-last#'] = true,
 
['translator-last#'] = true,
 
['translator#-last'] = true,
 
['translator#-last'] = true,
 +
['translator-given#'] = true,
 +
['translator#-given'] = true,
 +
['translator-surname#'] = true,
 +
['translator#-surname'] = true,
 
['translator-link#'] = true,
 
['translator-link#'] = true,
 
['translator#-link'] = true,
 
['translator#-link'] = true,
Line 367: Line 460:
 
}
 
}
  
−
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
 +
proeprint templates.  Some of these parameters may also be available to the general cs1|2 templates.
 +
 
 +
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  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 only
 +
['eprint'] = true, -- cite arxiv and arxiv identifiers
 +
}
 +
 
 +
 
 +
--[[--------------------------< C I T E  B I O R X I V >------------------------------------------------------
 +
 
 +
]]
 +
 
 +
local biorxiv_basic_arguments = {
 +
['biorxiv'] = true,
 +
}
 +
 
 +
 
 +
--[[--------------------------< C I T E  C I T E S E E R X >--------------------------------------------------
 +
 
 +
]]
 +
 
 +
local citeseerx_basic_arguments = {
 +
['citeseerx'] = true,
 +
}
 +
 
 +
 
 +
--[[--------------------------< C I T E  S S R N >------------------------------------------------------------
 +
 
 +
]]
 +
 
 +
local ssrn_basic_arguments = {
 +
['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
 +
 
 +
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 limited_basic_arguments = {
 +
['at'] = true,
 +
['author'] = true,
 +
['author-first'] = true,
 +
['author-last'] = true,
 +
['authorlink'] = true,
 +
['author-link'] = true,
 +
['authormask'] = true,
 +
['author-mask'] = true,
 +
['authors'] = true,
 +
['collaboration'] = true,
 +
['date'] = true,
 +
['df'] = true,
 +
['displayauthors'] = true,
 +
['display-authors'] = true,
 +
['first'] = true,
 +
['given'] = true,
 +
['language'] = true,
 +
['last'] = true,
 +
['lastauthoramp'] = true,
 +
['last-author-amp'] = true,
 +
['mode'] = true,
 +
['name-list-format'] = true,
 +
['nocat'] = true,
 +
['no-cat'] = true,
 +
['notracking'] = 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,
 +
['url'] = true,
 +
['URL'] = true,
 +
['vauthors'] = true,
 +
['year'] = true,
 +
}
 +
 
 +
local limited_numbered_arguments = {
 +
['author#'] = true,
 +
['author-first#'] = true,
 +
['author#-first'] = true,
 +
['author-last#'] = true,
 +
['author#-last'] = true,
 +
['author-link#'] = true,
 +
['author#link'] = true,
 +
['author#-link'] = true,
 +
['authorlink#'] = true,
 +
['author-mask#'] = true,
 +
['author#mask'] = true,
 +
['author#-mask'] = true,
 +
['authormask#'] = true,
 +
['first#'] = true,
 +
['given#'] = true,
 +
['last#'] = true,
 +
['surname#'] = true,
 +
}
 +
 
 +
 
 +
--[[--------------------------< 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,
 +
arxiv_basic_arguments = arxiv_basic_arguments,
 +
biorxiv_basic_arguments = biorxiv_basic_arguments,
 +
citeseerx_basic_arguments = citeseerx_basic_arguments,
 +
ssrn_basic_arguments = ssrn_basic_arguments
 +
};

Latest revision as of 05:28, 24 September 2019

Documentation for this module may be created at Module:Citation/CS1/Whitelist/doc 


--[[--------------------------< P A R A M E T E R S   N O T   S U P P O R T E D >------------------------------

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 >--------------------------------------

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 whitelist = {}

local basic_arguments = {
	['accessdate'] = true,
	['access-date'] = true,
	['agency'] = true,
	['airdate'] = true,
	['air-date'] = 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,
	['asin'] = true,
	['ASIN'] = true,
	['asin-tld'] = true,
	['ASIN-TLD'] = false,														-- not an identifier but an identifier-modifier
	['at'] = true,
	['author'] = true,
	['author-first'] = true,
	['author-last'] = true,
	['authorlink'] = true,
	['author-link'] = true,
	['authormask'] = true,
	['author-mask'] = true,
	['authors'] = true,
	['bibcode'] = true,
	['bibcode-access'] = true,
	['biorxiv'] = true,
	['booktitle'] = true,
	['book-title'] = true,
	['cartography'] = true,
	['chapter'] = true,
	['chapter-format'] = true,
	['chapterurl'] = true,
	['chapter-url'] = true,
	['chapter-url-access'] = true,
	['citeseerx'] = true,
	['class'] = false,															-- cite arxiv only; general use deprecated
	['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-last'] = true,
	['contributor-given'] = true,
	['contributor-surname'] = true,
	['contributor-link'] = true,
	['contributor-mask'] = true,
	['credits'] = true,															-- cite episode, cite serial
	['date'] = true,
	['deadurl'] = false,
	['dead-url'] = false,
	['degree'] = true,
	['department'] = true,
	['df'] = true,
	['dictionary'] = true,
	['displayauthors'] = true,
	['display-authors'] = true,
	['display-contributors'] = true,
	['displayeditors'] = true,
	['display-editors'] = true,
	['display-interviewers'] = true,
	['display-translators'] = true,
	['docket'] = true,
	['doi'] = true,
	['DOI'] = true,
	['doi-access'] = true,
	['doi-broken'] = true,
	['doi-broken-date'] = true,
	['doi-inactive-date'] = true,
	['edition'] = true,
	['editor'] = true,
	['editor-first'] = true,
	['editor-given'] = true,
	['editor-last'] = true,
	['editorlink'] = true,
	['editor-link'] = true,
	['editormask'] = true,
	['editor-mask'] = true,
	['editors'] = true,
	['editor-surname'] = true,
	['eissn'] = true,
	['EISSN'] = true,
	['embargo'] = true,
	['encyclopaedia'] = 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
	['episode-link'] = true,													-- cite episode and cite serial
	['eprint'] = true,															-- cite arxiv and arxiv identifiers
	['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,
	['ignoreisbnerror'] = true,
	['ignore-isbn-error'] = true,
	['inset'] = true,
	['institution'] = true,
	['interviewer'] = true,
	['interviewer-first'] = true,
	['interviewer-last'] = true,
	['interviewerlink'] = true,
	['interviewer-link'] = true,
	['interviewermask'] = 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'] = true,
	['last-author-amp'] = true,
	['laydate'] = true,
	['lay-date'] = true,
	['laysource'] = true,
	['lay-source'] = true,
	['laysummary'] = false,
	['lay-summary'] = false,
	['lay-format'] = true,
	['layurl'] = true,
	['lay-url'] = true,
	['lccn'] = true,
	['LCCN'] = 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,
	['mr'] = true,
	['MR'] = true,
	['name-list-format'] = true,
	['network'] = true,
	['newsgroup'] = true,
	['newspaper'] = true,
	['nocat'] = true,
	['no-cat'] = true,
	['nopp'] = true,
	['no-pp'] = true,
	['notracking'] = true,
	['no-tracking'] = true,
	['number'] = true,
	['oclc'] = true,
	['OCLC'] = true,
	['ol'] = true,
	['OL'] = true,
	['ol-access'] = 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,
	['pmid'] = true,
	['PMID'] = true,
	['postscript'] = true,
	['pp'] = true,
	['publicationdate'] = true,
	['publication-date'] = true,
	['publicationplace'] = true,
	['publication-place'] = true,
	['publisher'] = true,
	['quotation'] = true,
	['quote'] = true,
	['ref'] = true,
	['registration'] = false,
	['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,
	['series-link'] = true,
	['seriesno'] = true,
	['series-no'] = true,
	['seriesnumber'] = true,
	['series-number'] = true,
	['series-separator'] = true,
	['sheet'] = true,															-- cite map only
	['sheets'] = true,															-- cite map only
	['ssrn'] = true,
	['SSRN'] = true,
	['station'] = true,
	['subject'] = true,
	['subjectlink'] = true,
	['subject-link'] = true,
	['subscription'] = false,
	['surname'] = true,
	['template-doc-demo'] = true,
	['time'] = true,
	['timecaption'] = true,
	['time-caption'] = true,
	['title'] = true,
	['titlelink'] = true,
	['title-link'] = true,
	['trans-map'] = true,
	['transcript'] = true,
	['transcript-format'] = true,
	['transcripturl'] = true,
	['transcript-url'] = true,
	['translator'] = true,
	['translator-first'] = true,
	['translator-last'] = true,
	['translator-given'] = 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-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-last#'] = true,
	['author#-last'] = true,
	['author-link#'] = true,
	['author#link'] = true,
	['author#-link'] = true,
	['authorlink#'] = true,
	['author-mask#'] = true,
	['author#mask'] = true,
	['author#-mask'] = true,
	['authormask#'] = true,
	['contributor#'] = true,
	['contributor-first#'] = true,
	['contributor#-first'] = true,
	['contributor-last#'] = true,
	['contributor#-last'] = true,
	['contributor-given#'] = true,
	['contributor#-given'] = 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-link#'] = true,
	['editor#link'] = true,
	['editor#-link'] = true,
	['editorlink#'] = true,
	['editor-mask#'] = true,
	['editor#mask'] = true,
	['editor#-mask'] = true,
	['editormask#'] = true,
	['editor#-surname'] = true,
	['editor-surname#'] = true,
	['first#'] = true,
	['given#'] = true,
	['host#'] = true,
	['interviewer#'] = true,
	['interviewer-first#'] = true,
	['interviewer#-first'] = true,
	['interviewer-last#'] = true,
	['interviewer#-last'] = true,
	['interviewer-link#'] = true,
	['interviewer#-link'] = true,
	['interviewer-mask#'] = true,
	['interviewer#-mask'] = true,
	['last#'] = true,
	['subject#'] = true,
	['subject-link#'] = true,
	['subject#link'] = true,
	['subject#-link'] = true,
	['subjectlink#'] = true,
	['surname#'] = true,
	['translator#'] = true,
	['translator-first#'] = true,
	['translator#-first'] = true,
	['translator-last#'] = true,
	['translator#-last'] = true,
	['translator-given#'] = true,
	['translator#-given'] = 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
proeprint templates.  Some of these parameters may also be available to the general cs1|2 templates.

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   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 only
	['eprint'] = true,															-- cite arxiv and arxiv identifiers
}


--[[--------------------------< C I T E   B I O R X I V >------------------------------------------------------

]]

local biorxiv_basic_arguments = {
	['biorxiv'] = true,
}


--[[--------------------------< C I T E   C I T E S E E R X >--------------------------------------------------

]]

local citeseerx_basic_arguments = {
	['citeseerx'] = true,
}


--[[--------------------------< C I T E   S S R N >------------------------------------------------------------

]]

local ssrn_basic_arguments = {
	['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

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 limited_basic_arguments = {
	['at'] = true,
	['author'] = true,
	['author-first'] = true,
	['author-last'] = true,
	['authorlink'] = true,
	['author-link'] = true,
	['authormask'] = true,
	['author-mask'] = true,
	['authors'] = true,
	['collaboration'] = true,
	['date'] = true,
	['df'] = true,
	['displayauthors'] = true,
	['display-authors'] = true,
	['first'] = true,
	['given'] = true,
	['language'] = true,
	['last'] = true,
	['lastauthoramp'] = true,
	['last-author-amp'] = true,
	['mode'] = true,
	['name-list-format'] = true,
	['nocat'] = true,
	['no-cat'] = true,
	['notracking'] = 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,
	['url'] = true,
	['URL'] = true,
	['vauthors'] = true,
	['year'] = true,
}

local limited_numbered_arguments = {
	['author#'] = true,
	['author-first#'] = true,
	['author#-first'] = true,
	['author-last#'] = true,
	['author#-last'] = true,
	['author-link#'] = true,
	['author#link'] = true,
	['author#-link'] = true,
	['authorlink#'] = true,
	['author-mask#'] = true,
	['author#mask'] = true,
	['author#-mask'] = true,
	['authormask#'] = true,
	['first#'] = true,
	['given#'] = true,
	['last#'] = true,
	['surname#'] = true,
}


--[[--------------------------< 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,
	arxiv_basic_arguments = arxiv_basic_arguments,
	biorxiv_basic_arguments = biorxiv_basic_arguments,
	citeseerx_basic_arguments = citeseerx_basic_arguments,
	ssrn_basic_arguments = ssrn_basic_arguments
	};
Retrieved from "https://wikispooks.com/w/index.php?title=Module:Citation/CS1/Whitelist&oldid=168465"