Editing Module:Citation/CS1/Whitelist

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. 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 save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 +
 +
--[[--------------------------< 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
 +
['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
 +
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked
 +
['chapter-link'] = nil, --
 +
['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
 +
['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
 +
['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
 +
['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes
 +
['separator'] = nil, -- this functionality now provided by |mode=
 +
['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes
 +
 +
['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 >--------------------------------------
 
--[[--------------------------< S U P P O R T E D  P A R A M E T E R S >--------------------------------------
Line 5: Line 51:
 
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
nil - these parameters are no longer supported. remove entirely
+
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 = {
 
local basic_arguments = {
Line 13: Line 61:
 
['access-date'] = true,
 
['access-date'] = true,
 
['agency'] = true,
 
['agency'] = true,
 +
['airdate'] = true,
 +
['air-date'] = true,
 
['archivedate'] = true,
 
['archivedate'] = true,
 
['archive-date'] = true,
 
['archive-date'] = true,
Line 19: Line 69:
 
['archive-url'] = true,
 
['archive-url'] = true,
 
['article'] = true,
 
['article'] = true,
['article-format'] = true,
+
['arxiv'] = true,
['article-url'] = true,
+
['ARXIV'] = true,
['article-url-access'] = 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-first'] = true,
 
['author-first'] = true,
['author-given'] = true,
 
 
['author-last'] = true,
 
['author-last'] = true,
['author-surname'] = true,
 
 
['authorlink'] = true,
 
['authorlink'] = true,
 
['author-link'] = true,
 
['author-link'] = true,
['authormask'] = false, -- deprecated
+
['authormask'] = true,
 
['author-mask'] = true,
 
['author-mask'] = true,
 
['authors'] = true,
 
['authors'] = true,
 
['bibcode'] = true,
 
['bibcode'] = true,
['bibcode-access'] = true,
+
['BIBCODE'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
 
 
['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 47: Line 95:
 
['chapterurl'] = true,
 
['chapterurl'] = true,
 
['chapter-url'] = true,
 
['chapter-url'] = true,
['chapter-url-access'] = true,
+
['city'] = true, -- cite interview, cite episode, cite serial
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
+
['class'] = true, -- cite arxiv and arxiv identifiers
['collaboration'] = true,
+
['coauthor'] = false, -- deprecated
 +
['coauthors'] = false, -- deprecated
 
['conference'] = true,
 
['conference'] = true,
 
['conference-format'] = true,
 
['conference-format'] = true,
Line 58: Line 107:
 
['contributionurl'] = true,
 
['contributionurl'] = true,
 
['contribution-url'] = true,
 
['contribution-url'] = true,
['contribution-url-access'] = true,
+
['credits'] = true, -- cite episode, cite serial
['contributor'] = true,
 
['contributor-first'] = true,
 
['contributor-given'] = true,
 
['contributor-last'] = true,
 
['contributor-surname'] = true,
 
['contributor-link'] = true,
 
['contributor-mask'] = true,
 
 
['date'] = true,
 
['date'] = true,
 +
['deadurl'] = true,
 +
['dead-url'] = true,
 
['degree'] = true,
 
['degree'] = true,
 
['department'] = true,
 
['department'] = true,
['df'] = true,
 
 
['dictionary'] = true,
 
['dictionary'] = true,
['displayauthors'] = false, -- deprecated
+
['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,
+
['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,
Line 88: Line 131:
 
['editor-given'] = true,
 
['editor-given'] = true,
 
['editor-last'] = true,
 
['editor-last'] = true,
['editor-surname'] = true,
+
['editorlink'] = true,
['editorlink'] = false, -- deprecated
 
 
['editor-link'] = true,
 
['editor-link'] = true,
 +
['editormask'] = true,
 
['editor-mask'] = true,
 
['editor-mask'] = true,
['editors'] = false, -- deprecated
+
['editors'] = true,
['eissn'] = true,
+
['editor-surname'] = true,
['EISSN'] = true,
+
['embargo'] = true,
 
['encyclopaedia'] = true,
 
['encyclopaedia'] = true,
 
['encyclopedia'] = true,
 
['encyclopedia'] = true,
 
['entry'] = true,
 
['entry'] = true,
['entry-format'] = true,
+
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['entry-url'] = true,
+
['episodelink'] = true, -- cite episode and cite serial
['entry-url-access'] = true,
+
['episode-link'] = true, -- cite episode and cite serial
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
+
['eprint'] = true, -- cite arxiv and arxiv identifiers
 
['event'] = true,
 
['event'] = true,
 
['event-format'] = true,
 
['event-format'] = true,
Line 109: Line 152:
 
['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,
['ignore-isbn-error'] = false, -- deprecated
+
['ignoreisbnerror'] = true,
 +
['ignore-isbn-error'] = true,
 +
['in'] = true,
 +
['inset'] = true,
 
['institution'] = true,
 
['institution'] = true,
['interviewer'] = true,
+
['interviewer'] = true, --cite interview
['interviewer-first'] = true,
+
['interviewers'] = true, --cite interview
['interviewer-given'] = true,
 
['interviewer-last'] = true,
 
['interviewer-surname'] = true,
 
['interviewer-link'] = true,
 
['interviewer-mask'] = true,
 
 
['isbn'] = true,
 
['isbn'] = true,
 
['ISBN'] = true,
 
['ISBN'] = true,
Line 138: Line 176:
 
['jstor'] = true,
 
['jstor'] = true,
 
['JSTOR'] = true,
 
['JSTOR'] = true,
['jstor-access'] = true,
 
['lang'] = true,
 
 
['language'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last'] = true,
['lastauthoramp'] = false, -- deprecated
+
['lastauthoramp'] = true,
['last-author-amp'] = false, -- deprecated
+
['last-author-amp'] = true,
 
['laydate'] = true,
 
['laydate'] = true,
 
['lay-date'] = true,
 
['lay-date'] = true,
 
['laysource'] = true,
 
['laysource'] = true,
 
['lay-source'] = true,
 
['lay-source'] = true,
 +
['laysummary'] = true,
 +
['lay-summary'] = true,
 
['lay-format'] = true,
 
['lay-format'] = true,
 
['layurl'] = true,
 
['layurl'] = true,
Line 155: Line 193:
 
['location'] = true,
 
['location'] = true,
 
['magazine'] = 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
 
['medium'] = true,
 
['medium'] = true,
 +
['message-id'] = true, -- cite newsgroup
 
['minutes'] = true,
 
['minutes'] = true,
 
['mode'] = true,
 
['mode'] = true,
Line 161: Line 206:
 
['MR'] = true,
 
['MR'] = true,
 
['name-list-format'] = true,
 
['name-list-format'] = true,
['name-list-style'] = true,
+
['network'] = true,
 +
['newsgroup'] = true,
 
['newspaper'] = true,
 
['newspaper'] = true,
 
['nocat'] = true,
 
['nocat'] = true,
 +
['no-cat'] = true,
 
['nopp'] = true,
 
['nopp'] = true,
 
['no-pp'] = true,
 
['no-pp'] = true,
 +
['notracking'] = true,
 
['no-tracking'] = true,
 
['no-tracking'] = true,
 
['number'] = true,
 
['number'] = true,
Line 172: Line 220:
 
['ol'] = true,
 
['ol'] = true,
 
['OL'] = true,
 
['OL'] = true,
['ol-access'] = true,
 
['orig-date'] = 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 188: Line 233:
 
['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,
 +
['pp-prefix'] = true,
 +
['p-prefix'] = true,
 +
['program'] = true, -- cite interview
 
['publicationdate'] = true,
 
['publicationdate'] = true,
 
['publication-date'] = true,
 
['publication-date'] = true,
Line 200: Line 247:
 
['quotation'] = true,
 
['quotation'] = true,
 
['quote'] = true,
 
['quote'] = true,
['quote-page'] = true,
 
['quote-pages'] = true,
 
 
['ref'] = true,
 
['ref'] = true,
 +
['Ref'] = false, -- deprecated, non-statndard capitalization
 +
['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-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-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
 
['sectionurl'] = true,
 
['sectionurl'] = true,
 
['section-url'] = true,
 
['section-url'] = true,
['section-url-access'] = true,
 
 
['series'] = true,
 
['series'] = true,
 
['serieslink'] = true,
 
['serieslink'] = true,
Line 234: Line 268:
 
['seriesnumber'] = 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,
 +
['sheet'] = true, -- cite map only
 +
['sheets'] = true, -- cite map only
 +
['ssrn'] = true,
 
['SSRN'] = true,
 
['SSRN'] = true,
 +
['station'] = true,
 
['subject'] = true,
 
['subject'] = true,
['subjectlink'] = false, -- deprecated
+
['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,
Line 251: Line 287:
 
['titlelink'] = true,
 
['titlelink'] = true,
 
['title-link'] = true,
 
['title-link'] = true,
 +
['trans_chapter'] = true,
 +
['trans-chapter'] = true,
 +
['trans-map'] = true,
 +
['transcript'] = true,
 +
['transcript-format'] = true,
 +
['transcripturl'] = true,
 +
['transcript-url'] = true,
 +
['trans_title'] = true,
 +
['trans-title'] = true,
 
['translator'] = true,
 
['translator'] = true,
 
['translator-first'] = true,
 
['translator-first'] = true,
['translator-given'] = true,
+
['translator-last'] = true,
['translator-last'] = 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-quote'] = 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 292: Line 320:
 
['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#'] = true,
 
['authorlink#'] = true,
['author#link'] = true,
 
 
['author-mask#'] = true,
 
['author-mask#'] = true,
 +
['author#mask'] = true,
 
['author#-mask'] = true,
 
['author#-mask'] = true,
['authormask#'] = false, -- deprecated
+
['authormask#'] = true,
['author#mask'] = false, -- deprecated
 
['contributor#'] = true,
 
['contributor-first#'] = 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-first#'] = true,
 
['editor-first#'] = true,
 
['editor#-first'] = true,
 
['editor#-first'] = 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#'] = false, -- deprecated
+
['editorlink#'] = true,
['editor#link'] = false, -- deprecated
 
 
['editor-mask#'] = true,
 
['editor-mask#'] = true,
 +
['editor#mask'] = true,
 
['editor#-mask'] = true,
 
['editor#-mask'] = true,
 +
['editormask#'] = 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,
['subjectlink#'] = false, -- deprecated
+
['subjectlink#'] = true,
['subject#link'] = false, -- deprecated
 
['subject-mask#'] = true,
 
['subject#-mask'] = true,
 
 
['surname#'] = true,
 
['surname#'] = true,
 
['translator#'] = true,
 
['translator#'] = true,
 
['translator-first#'] = true,
 
['translator-first#'] = true,
 
['translator#-first'] = true,
 
['translator#-first'] = true,
['translator-given#'] = true,
 
['translator#-given'] = true,
 
 
['translator-last#'] = true,
 
['translator-last#'] = true,
 
['translator#-last'] = true,
 
['translator#-last'] = true,
['translator-surname#'] = true,
 
['translator#-surname'] = true,
 
 
['translator-link#'] = true,
 
['translator-link#'] = true,
 
['translator#-link'] = true,
 
['translator#-link'] = true,
Line 374: Line 367:
 
}
 
}
  
 
+
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
 
preprint templates.  Some of these parameters may also be available to the general cs1|2 templates.
 
 
 
Same conventions for true/false/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 >----------------------
 
 
 
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
 
 
 
Same conventions for true/false/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'] = true,
 
['author-mask'] = true,
 
['authormask'] = false, -- deprecated
 
['authors'] = true,
 
['collaboration'] = true,
 
['date'] = true,
 
['df'] = true,
 
['display-authors'] = true,
 
['displayauthors'] = false, -- deprecated
 
['first'] = true,
 
['given'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last-author-amp'] = false, -- deprecated
 
['lastauthoramp'] = false, -- deprecated
 
['mode'] = true,
 
['name-list-format'] = true,
 
['name-list-style'] = true,
 
['nocat'] = 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#'] = true,
 
['author#link'] = true,
 
['author-mask#'] = true,
 
['author#-mask'] = true,
 
['authormask#'] = false, -- deprecated
 
['author#mask'] = false, -- deprecated
 
['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/nil as above.
 
 
 
]]
 
 
 
local unique_arguments = {
 
['audio-visual'] = {
 
['transcript'] = true,
 
['transcript-format'] = true,
 
['transcripturl'] = true,
 
['transcript-url'] = true,
 
},
 
episode = {
 
['airdate'] = true,
 
['air-date'] = true,
 
['credits'] = true,
 
['episodelink'] = true, -- alias of |title-link=
 
['episode-link'] = true, -- alias of |title-link=
 
['network'] = true,
 
['station'] = true,
 
['transcript'] = true,
 
['transcript-format'] = true,
 
['transcripturl'] = true,
 
['transcript-url'] = true,
 
},
 
mailinglist = {
 
['mailinglist'] = true,
 
['mailing-list'] = true,
 
},
 
map = {
 
['inset'] = true,
 
['map'] = true,
 
['map-format'] = true,
 
['mapurl'] = true,
 
['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'] = true,
 
['air-date'] = true,
 
['credits'] = true,
 
['episode'] = true, -- cite serial only TODO: make available to cite episode?
 
['episodelink'] = true, -- aliases of |title-link=
 
['episode-link'] = true,
 
['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,
 
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 All About Ayrshire may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, 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 (see All About Ayrshire:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Template used on this page: