Editing Module:Citation/CS1/Whitelist

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. Read the Privacy Policy to learn what information we collect about you and how we use it.

If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
--[[
--[[--------------------------< 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 now can have three values:
 
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
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 (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
nil - these parameters are no longer supported. remove entirely
]]
]]
whitelist = {


local basic_arguments = {
basic_arguments = {
['accessdate'] = 'discouraged',
['accessdate'] = true,
['access-date'] = true,
['access-date'] = true,
['agency'] = true,
['agency'] = true,
['archivedate'] = 'discouraged',
['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,
['archive-date'] = true,
['archive-format'] = true,
['archiveurl'] = true,
['archiveurl'] = 'discouraged',
['archive-url'] = true,
['archive-url'] = true,
['article'] = true,
['article'] = true,
['article-format'] = true,
['artist'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of others used by old cite AV media notes
['article-url'] = true,
['arxiv'] = true,
['article-url-access'] = true,
['ARXIV'] = true,
['arxiv'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['asin'] = true,
['asin'] = true,
['ASIN'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = true,
['at'] = true,
['at'] = true,
['author'] = true,
['author'] = true,
['Author'] = true,
['author-first'] = true,
['author-first'] = true,
['author-given'] = true,
['authorformat'] = true,
['author-format'] = true,
['author-last'] = true,
['author-last'] = true,
['author-surname'] = true,
['authorlink'] = true,
['authorlink'] = 'discouraged',
['author-link'] = true,
['author-link'] = true,
['authormask'] = true,
['author-mask'] = true,
['author-mask'] = true,
['author-name-separator'] = true,
['authors'] = true,
['authors'] = true,
['author-separator'] = true,
['bibcode'] = true,
['bibcode'] = true,
['bibcode-access'] = true,
['BIBCODE'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
['booktitle'] = false,
['book-title'] = true,
['book-title'] = true,
['callsign']=true, -- cite interview
['call-sign']=true, -- cite interview
['cartography'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapterlink'] = true,
['chapterurl'] = false,
['chapter-link'] = true,
['chapterurl'] = true,
['chapter-url'] = true,
['chapter-url'] = true,
['chapter-url-access'] = true,
['city']=true, -- cite interview
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['coauthor'] = false,
['collaboration'] = true,
['coauthors'] = false,
['cointerviewers'] = false, -- cite interview
['conference'] = true,
['conference'] = true,
['conference-format'] = true,
['conferenceurl'] = true,
['conference-url'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution'] = true,
['contribution-format'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-given'] = true,
['contributor-last'] = true,
['contributor-surname'] = true,
['contributor-link'] = true,
['contributor-mask'] = true,
['date'] = true,
['date'] = true,
['day'] = false,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['degree'] = true,
['department'] = true,
['department'] = true,
['df'] = true,
['dictionary'] = 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,
['display-authors'] = true,
['display-contributors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['docket'] = true,
['docket'] = true,
['doi'] = true,
['doi'] = true,
['DOI'] = true,
['DOI'] = true,
['doi-access'] = true,
['DoiBroken'] = true,
['doi-broken'] = true,
['doi_brokendate'] = true,
['doi-broken-date'] = true,
['doi-broken-date'] = true,
['doi_inactivedate'] = true,
['doi-inactive-date'] = true,
['edition'] = true,
['edition'] = true,
['editor'] = true,
['editor'] = true,
['Editor'] = true,
['editor-first'] = true,
['editor-first'] = true,
['editorformat'] = true,
['editor-format'] = true,
['EditorGiven'] = true,
['editor-given'] = true,
['editor-given'] = true,
['editor-last'] = true,
['editor-last'] = true,
['editor-surname'] = true,
['editorlink'] = true,
['editor-link'] = true,
['editor-link'] = true,
['editormask'] = true,
['editor-mask'] = true,
['editor-mask'] = true,
['eissn'] = true,
['editor-name-separator'] = true,
['EISSN'] = true,
['editors'] = true,
['editor-separator'] = true,
['EditorSurname'] = true,
['editor-surname'] = true,
['embargo'] = true,
['Embargo'] = true,
['encyclopaedia'] = true,
['encyclopaedia'] = true,
['encyclopedia'] = true,
['encyclopedia'] = true,
['entry'] = true,
['entry'] = true,
['entry-format'] = true,
['episodelink'] = true,
['entry-url'] = true,
['episode-link'] = true,
['entry-url-access'] = true,
['event'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['eventurl'] = true,
['event'] = true, -- synonym of conference in /Config, but used in Cite speech?
['event-url'] = true,
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
['given'] = true,
['given'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['host'] = true,
['host'] = true,
['id'] = true,
['id'] = true,
['ID'] = true,
['ID'] = true,
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['institution'] = true,
['interviewer'] = true,
['interviewer'] = true, --cite interview
['interviewer-first'] = true,
['interviewer-given'] = true,
['interviewer-last'] = true,
['interviewer-surname'] = true,
['interviewer-link'] = true,
['interviewer-mask'] = true,
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
['isbn13'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ISMN'] = true,
['issn'] = true,
['issn'] = true,
['ISSN'] = true,
['ISSN'] = true,
Line 129: Line 136:
['jstor'] = true,
['jstor'] = true,
['JSTOR'] = true,
['JSTOR'] = true,
['jstor-access'] = true,
['lang'] = true,
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['laydate'] = true,
['lay-date'] = true,
['lay-date'] = true,
['laysource'] = true,
['lay-source'] = true,
['lay-source'] = true,
['lay-format'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['layurl'] = true,
['lay-url'] = true,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
Line 143: Line 154:
['medium'] = true,
['medium'] = true,
['minutes'] = true,
['minutes'] = true,
['mode'] = true,
['month'] = false,
['mr'] = true,
['mr'] = true,
['MR'] = true,
['MR'] = true,
['name-list-style'] = true,
['name-separator'] = true,
['network'] = true,
['newsgroup'] = true,
['newspaper'] = true,
['newspaper'] = true,
['nopp'] = false,
['nocat'] = true,
['no-cat'] = true,
['nopp'] = true,
['no-pp'] = 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,
['no-tracking'] = true,
['number'] = true,
['number'] = true,
Line 156: Line 173:
['ol'] = true,
['ol'] = true,
['OL'] = true,
['OL'] = true,
['ol-access'] = true,
['origyear'] = true,
['orig-date'] = true,
['origyear'] = 'discouraged',
['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 172: Line 186:
['pmc'] = true,
['pmc'] = true,
['PMC'] = true,
['PMC'] = true,
['pmc-embargo-date'] = true,
['pmid'] = true,
['pmid'] = true,
['PMID'] = true,
['PMID'] = true,
['postscript'] = true,
['postscript'] = true,
['pp'] = true,
['pp'] = true,
['publicationdate'] = false,
['PPPrefix'] = true,
['pp-prefix'] = true,
['PPrefix'] = true,
['p-prefix'] = true,
['program']=true, -- cite interview
['publicationdate'] = true,
['publication-date'] = true,
['publication-date'] = true,
['publicationplace'] = false,
['publicationplace'] = true,
['publication-place'] = true,
['publication-place'] = true,
['publisher'] = 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,
['quotation'] = true,
['quote'] = true,
['quote'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['ref'] = true,
['ref'] = true,
['Ref'] = true,
['registration'] = true,
['rfc'] = true,
['rfc'] = true,
['RFC'] = true,
['RFC'] = true,
['sbn'] = true,
['SBN'] = true,
['scale'] = 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-quote'] = true,
['script-section'] = true,
['script-title'] = true,
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['season'] = true,
['section'] = true,
['section'] = true,
['section-format'] = true,
['sectionurl'] = true,
['section-url'] = true,
['section-url'] = true,
['section-url-access'] = true,
['separator'] = true,
['series'] = true,
['series'] = true,
['serieslink'] = false,
['serieslink'] = true,
['series-link'] = true,
['series-link'] = true,
['seriesno'] = true,
['series-no'] = true,
['series-no'] = true,
['seriesnumber'] = true,
['series-number'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['series-separator'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['station'] = true,
['subject'] = true,
['subject'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['subscription'] = true,
['surname'] = true,
['surname'] = true,
['s2cid'] = true,
['template doc demo'] = true,
['S2CID'] = true,
['s2cid-access'] = true,
['template-doc-demo'] = true,
['template-doc-demo'] = true,
['time'] = true,
['time'] = true,
['timecaption'] = true,
['time-caption'] = true,
['time-caption'] = true,
['title'] = true,
['title'] = true,
['titlelink'] = true,
['title-link'] = true,
['title-link'] = true,
['translator'] = true,
['titleyear'] = false, -- deprecated; set to nil after 1 October 2014; a unique alias of origyear used by old cite DVD-notes
['translator-first'] = true,
['trans_chapter'] = true,
['translator-given'] = true,
['translator-last'] = true,
['translator-surname'] = true,
['translator-link'] = true,
['translator-mask'] = true,
['trans-article'] = true,
['trans-chapter'] = true,
['trans-chapter'] = true,
['trans-contribution'] = true,
['transcript'] = true,
['trans-entry'] = true,
['transcripturl'] = true,
['trans-journal'] = true,
['transcript-url'] = true,
['trans-magazine'] = true,
['trans_title'] = true,
['trans-newspaper'] = true,
['trans-periodical'] = true,
['trans-quote'] = true,
['trans-section'] = true,
['trans-title'] = 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,
['veditors'] = true,
['version'] = true,
['version'] = true,
['via'] = true,
['via'] = true,
Line 264: Line 257:
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
},


local numbered_arguments = {
numbered_arguments = {
['author#'] = true,
['author#'] = true,
['Author#'] = true,
['author-first#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author#-first'] = true,
['author-given#'] = true,
['author#-given'] = true,
['author-last#'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author#-last'] = true,
['author-surname#'] = true,
['author#-surname'] = true,
['author-link#'] = true,
['author-link#'] = true,
['author#link'] = true,
['author#-link'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged',
['authorlink#'] = true,
['author#link'] = 'discouraged',
['author-mask#'] = true,
['author-mask#'] = true,
['author#mask'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
['contributor#'] = true,
['authormask#'] = true,
['contributor-first#'] = true,
['authors#'] = true,
['contributor#-first'] = true,
['contributor-given#'] = true,
['contributor#-given'] = true,
['contributor-last#'] = true,
['contributor#-last'] = true,
['contributor-surname#'] = true,
['contributor#-surname'] = true,
['contributor-link#'] = true,
['contributor#-link'] = true,
['contributor-mask#'] = true,
['contributor#-mask'] = true,
['editor#'] = true,
['editor#'] = true,
['Editor#'] = true,
['editor-first#'] = true,
['editor-first#'] = true,
['editor#-first'] = true,
['editor#-first'] = true,
['EditorGiven#'] = true,
['editor#-given'] = true,
['editor-given#'] = true,
['editor-given#'] = true,
['editor#-given'] = true,
['editor-last#'] = true,
['editor-last#'] = true,
['editor#-last'] = true,
['editor#-last'] = true,
['editor-surname#'] = true,
['editor#-surname'] = true,
['editor-link#'] = true,
['editor-link#'] = true,
['editor#link'] = true,
['editor#-link'] = true,
['editor#-link'] = true,
['editorlink#'] = true,
['editor-mask#'] = true,
['editor-mask#'] = true,
['editor#mask'] = true,
['editor#-mask'] = true,
['editor#-mask'] = true,
['editormask#'] = true,
['editors#'] = true,
['EditorSurname#'] = true,
['editor#-surname'] = true,
['editor-surname#'] = true,
['first#'] = true,
['first#'] = true,
['given#'] = true,
['given#'] = true,
['host#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
['interviewer#-first'] = true,
['interviewer-given#'] = true,
['interviewer#-given'] = true,
['interviewer-last#'] = true,
['interviewer#-last'] = true,
['interviewer-surname#'] = true,
['interviewer#-surname'] = true,
['interviewer-link#'] = true,
['interviewer#-link'] = true,
['interviewer-mask#'] = true,
['interviewer#-mask'] = true,
['last#'] = true,
['last#'] = true,
['subject#'] = true,
['subject#'] = true,
['subject-link#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subject#-link'] = true,
['subject-mask#'] = true,
['subjectlink#'] = true,
['subject#-mask'] = true,
['surname#'] = true,
['surname#'] = true,
['translator#'] = true,
},
['translator-first#'] = true,
};
['translator#-first'] = true,
['translator-given#'] = true,
['translator#-given'] = true,
['translator-last#'] = true,
['translator#-last'] = 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
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.
 
]]
 
local preprint_arguments = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
['class'] = true,
['eprint'] = true, -- cite arxiv and arxiv identifiers
},
biorxiv = {
['biorxiv'] = true,
},
citeseerx = {
['citeseerx'] = true,
},
ssrn = {
['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 >----------------------
 
cite arxiv, cite biorxiv, cite citeseerx, and cite ssrn templates are preprint templates so are allowed only a
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.
]]
 
local limited_basic_arguments = {
['at'] = true,
['author'] = true,
['author-first'] = true,
['author-given'] = true,
['author-last'] = true,
['author-surname'] = true,
['author-link'] = true,
['authorlink'] = 'discouraged',
['author-mask'] = true,
['authors'] = true,
['collaboration'] = true,
['date'] = true,
['df'] = true,
['display-authors'] = true,
['first'] = true,
['given'] = true,
['language'] = true,
['last'] = true,
['mode'] = true,
['name-list-style'] = 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,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['year'] = true,
}
 
local limited_numbered_arguments = {
['author#'] = true,
['author-first#'] = true,
['author#-first'] = true,
['author-given#'] = true,
['author#-given'] = true,
['author-last#'] = true,
['author#-last'] = true,
['author-surname#'] = true,
['author#-surname'] = true,
['author-link#'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged',
['author#link'] = 'discouraged',
['author-mask#'] = true,
['author#-mask'] = true,
['first#'] = true,
['given#'] = true,
['last#'] = true,
['surname#'] = true,
}
 
 
--[[--------------------------< U N I Q U E _ A R G U M E N T S >----------------------------------------------
 
Some templates have unique parameters.  Those templates and their unique parameters are listed here. Keys in this
table are the template's CitationClass parameter value
 
Same conventions for true/false/dicouraged/nil as above.
 
]]
 
local unique_arguments = {
['audio-visual'] = {
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
},
episode = {
['airdate'] = 'discouraged',
['air-date'] = true,
['credits'] = true,
['episodelink'] = false, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['station'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
},
mailinglist = {
['mailinglist'] = false,
['mailing-list'] = true,
},
map = {
['inset'] = true,
['map'] = true,
['map-format'] = true,
['mapurl'] = false,
['map-url'] = true,
['map-url-access'] = true,
['script-map'] = true,
['sections'] = true,
['sheet'] = true,
['sheets'] = true,
['trans-map'] = true,
},
newsgroup = {
['message-id'] = true,
['newsgroup'] = true,
},
serial = {
['airdate'] = 'discouraged',
['air-date'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = false,
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['station'] = true,
},
}
 
 
--[[--------------------------< T E M P L A T E _ L I S T _ G E T >--------------------------------------------
 
gets a list of the templates from table t
 
]]
 
local function template_list_get (t)
local out = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (out, k) -- add each key to the output table
end
return out; -- and done
end
 
 
--[[--------------------------< 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,


preprint_arguments = preprint_arguments,
return whitelist;
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
unique_arguments = unique_arguments,
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};
Please note that all contributions to Nonbinary Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see Nonbinary Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://nonbinary.wiki/wiki/Module:Citation/CS1/Whitelist"