Module:Citation/CS1/Whitelist
< Module:Citation | CS1
 | This Lua module is used on approximately 6,120,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This module can only be edited by administrators because it is transcluded onto one or more cascade-protected pages. |
This module contains a list of all parameters that Module:Citation/CS1 knows about. Each parameter is assigned a state.
- true: These parameters are valid and supported parameters
- false: These parameters are deprecated but still supported
- 'tracked': These parameters are valid and supported parameters tracked in an eponymous properties category.
- nil: Parameters not present are not supported, or no longer supported.
The basic_arguments table is supported by all templates.
These files comprise the module support for CS1|2 citation templates:
--[[
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items now 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)
]]
whitelist = {
basic_arguments = {
['accessdate'] = true,
['access-date'] = true,
['agency'] = true,
['airdate'] = true,
['air-date'] = true,
['albumlink'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of titlelink used by old cite AV media notes
['albumtype'] = nil, -- controled inappropriate functionality in the old cite AV media notes
['archivedate'] = true,
['archive-date'] = true,
['archiveurl'] = true,
['archive-url'] = true,
['article'] = true,
['artist'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of others used by old cite AV media notes
['arxiv'] = true,
['ARXIV'] = true,
['asin'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = true,
['at'] = true,
['author'] = true,
['Author'] = true,
['author-first'] = true,
['authorformat'] = true,
['author-format'] = true,
['author-last'] = true,
['authorlink'] = true,
['author-link'] = true,
['authormask'] = true,
['author-mask'] = true,
['author-name-separator'] = true,
['authors'] = true,
['author-separator'] = true,
['bibcode'] = true,
['BIBCODE'] = true,
['booktitle'] = true,
['book-title'] = true,
['callsign']=true, -- cite interview
['call-sign']=true, -- cite interview
['cartography'] = true,
['chapter'] = true,
['chapterlink'] = true,
['chapter-link'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['city']=true, -- cite interview
['coauthor'] = false,
['coauthors'] = false,
['cointerviewers'] = false, -- cite interview
['conference'] = true,
['conferenceurl'] = true,
['conference-url'] = true,
['contribution'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['date'] = true,
['day'] = false,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['department'] = true,
['dictionary'] = true,
['director'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of author used by old cite DVD-notes
['displayauthors'] = true,
['display-authors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['docket'] = true,
['doi'] = true,
['DOI'] = true,
['DoiBroken'] = true,
['doi-broken'] = true,
['doi_brokendate'] = true,
['doi-broken-date'] = true,
['doi_inactivedate'] = true,
['doi-inactive-date'] = true,
['edition'] = true,
['editor'] = true,
['Editor'] = true,
['editor-first'] = true,
['editorformat'] = true,
['editor-format'] = true,
['EditorGiven'] = true,
['editor-given'] = true,
['editor-last'] = true,
['editorlink'] = true,
['editor-link'] = true,
['editormask'] = true,
['editor-mask'] = true,
['editor-name-separator'] = true,
['editors'] = true,
['editor-separator'] = true,
['EditorSurname'] = true,
['editor-surname'] = true,
['embargo'] = true,
['Embargo'] = true,
['encyclopaedia'] = true,
['encyclopedia'] = true,
['entry'] = true,
['episodelink'] = true,
['episode-link'] = true,
['event'] = true,
['eventurl'] = true,
['event-url'] = true,
['first'] = true,
['format'] = true,
['given'] = true,
['host'] = true,
['id'] = true,
['ID'] = true,
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['interviewer'] = true, --cite interview
['isbn'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['issn'] = true,
['ISSN'] = true,
['issue'] = true,
['jfm'] = true,
['JFM'] = true,
['journal'] = true,
['jstor'] = true,
['JSTOR'] = true,
['language'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['laydate'] = true,
['lay-date'] = true,
['laysource'] = true,
['lay-source'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['layurl'] = true,
['lay-url'] = true,
['lccn'] = true,
['LCCN'] = true,
['location'] = true,
['magazine'] = true,
['medium'] = true,
['minutes'] = true,
['month'] = false,
['mr'] = true,
['MR'] = true,
['name-separator'] = true,
['network'] = true,
['newsgroup'] = true,
['newspaper'] = true,
['nocat'] = true,
['no-cat'] = true,
['nopp'] = true,
['no-pp'] = true,
['notestitle'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of chapter used by old cite AV media notes
['notracking'] = true,
['no-tracking'] = true,
['number'] = true,
['oclc'] = true,
['OCLC'] = true,
['ol'] = true,
['OL'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = 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,
['PPPrefix'] = true,
['pp-prefix'] = true,
['PPrefix'] = true,
['p-prefix'] = true,
['program']=true, -- cite interview
['publicationdate'] = true,
['publication-date'] = true,
['publicationplace'] = true,
['publication-place'] = true,
['publisher'] = true,
['publisherid'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of others used by old cite AV media notes and old cite DVD-notes
['quotation'] = true,
['quote'] = true,
['ref'] = true,
['Ref'] = true,
['registration'] = true,
['rfc'] = true,
['RFC'] = true,
['scale'] = true,
['season'] = true,
['section'] = true,
['sectionurl'] = true,
['section-url'] = true,
['separator'] = true,
['series'] = true,
['serieslink'] = true,
['series-link'] = true,
['seriesno'] = true,
['series-no'] = true,
['seriesnumber'] = true,
['series-number'] = true,
['series-separator'] = true,
['ssrn'] = true,
['SSRN'] = true,
['station'] = true,
['subject'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subscription'] = true,
['surname'] = true,
['template doc demo'] = true,
['template-doc-demo'] = true,
['time'] = true,
['timecaption'] = true,
['time-caption'] = true,
['title'] = true,
['titlelink'] = true,
['title-link'] = true,
['titleyear'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of origyear used by old cite DVD-notes
['trans_chapter'] = true,
['trans-chapter'] = true,
['transcript'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['trans_title'] = true,
['trans-title'] = true,
['type'] = true,
['url'] = true,
['URL'] = true,
['version'] = true,
['via'] = true,
['volume'] = true,
['website'] = true,
['work'] = true,
['year'] = true,
['zbl'] = true,
['ZBL'] = true,
},
numbered_arguments = {
['author#'] = true,
['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,
['authors#'] = true,
['editor#'] = true,
['Editor#'] = true,
['editor-first#'] = true,
['editor#-first'] = true,
['EditorGiven#'] = 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,
['editors#'] = true,
['EditorSurname#'] = true,
['editor#-surname'] = true,
['editor-surname#'] = true,
['first#'] = true,
['given#'] = true,
['last#'] = true,
['subject#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subjectlink#'] = true,
['surname#'] = true,
},
};
return whitelist;