From World Afropedia
Jump to: navigation, search
m (1 revision imported)
m (1 revision imported)
 
(3 intermediate revisions by 3 users not shown)
Line 8: Line 8:
 
 
 
]]
 
]]
 
local whitelist = {}
 
  
 
local basic_arguments = {
 
local basic_arguments = {
Line 15: Line 13:
 
['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 26: Line 22:
 
['article-url'] = true,
 
['article-url'] = true,
 
['article-url-access'] = 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,
Line 33: Line 29:
 
['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'] = true,
 
 
['author-mask'] = true,
 
['author-mask'] = true,
 
['authors'] = true,
 
['authors'] = true,
 
['bibcode'] = true,
 
['bibcode'] = true,
 
['bibcode-access'] = true,
 
['bibcode-access'] = true,
['biorxiv'] = true,
+
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['booktitle'] = true,
 
['book-title'] = true,
 
['cartography'] = true,
 
 
['chapter'] = true,
 
['chapter'] = true,
 
['chapter-format'] = true,
 
['chapter-format'] = true,
['chapterurl'] = true,
 
 
['chapter-url'] = true,
 
['chapter-url'] = true,
 
['chapter-url-access'] = true,
 
['chapter-url-access'] = true,
['citeseerx'] = true,
+
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
 
['collaboration'] = true,
 
['collaboration'] = true,
['conference'] = true,
 
['conference-format'] = true,
 
['conferenceurl'] = true,
 
['conference-url'] = true,
 
 
['contribution'] = true,
 
['contribution'] = true,
 
['contribution-format'] = true,
 
['contribution-format'] = true,
['contributionurl'] = true,
 
 
['contribution-url'] = true,
 
['contribution-url'] = true,
 
['contribution-url-access'] = true,
 
['contribution-url-access'] = true,
 
['contributor'] = true,
 
['contributor'] = true,
 
['contributor-first'] = true,
 
['contributor-first'] = true,
 +
['contributor-given'] = true,
 
['contributor-last'] = true,
 
['contributor-last'] = true,
['contributor-given'] = true,
 
 
['contributor-surname'] = true,
 
['contributor-surname'] = true,
 
['contributor-link'] = true,
 
['contributor-link'] = true,
 
['contributor-mask'] = true,
 
['contributor-mask'] = true,
['credits'] = true, -- cite episode, cite serial
 
 
['date'] = true,
 
['date'] = true,
['degree'] = true,
 
 
['department'] = true,
 
['department'] = true,
 
['df'] = true,
 
['df'] = true,
 
['dictionary'] = true,
 
['dictionary'] = true,
['displayauthors'] = true,
 
 
['display-authors'] = true,
 
['display-authors'] = true,
 
['display-contributors'] = true,
 
['display-contributors'] = true,
['displayeditors'] = true,
 
 
['display-editors'] = true,
 
['display-editors'] = true,
 
['display-interviewers'] = true,
 
['display-interviewers'] = true,
 +
['display-subjects'] = true,
 
['display-translators'] = true,
 
['display-translators'] = true,
['docket'] = true,
 
 
['doi'] = true,
 
['doi'] = true,
 
['DOI'] = true,
 
['DOI'] = true,
 
['doi-access'] = true,
 
['doi-access'] = true,
['doi-broken'] = true,
 
 
['doi-broken-date'] = true,
 
['doi-broken-date'] = true,
['doi-inactive-date'] = true,
 
 
['edition'] = true,
 
['edition'] = true,
 
['editor'] = true,
 
['editor'] = true,
Line 93: Line 75:
 
['editor-given'] = true,
 
['editor-given'] = true,
 
['editor-last'] = true,
 
['editor-last'] = true,
['editorlink'] = true,
+
['editor-surname'] = true,
 
['editor-link'] = true,
 
['editor-link'] = true,
['editormask'] = true,
 
 
['editor-mask'] = true,
 
['editor-mask'] = true,
['editors'] = true,
 
['editor-surname'] = true,
 
 
['eissn'] = true,
 
['eissn'] = true,
 
['EISSN'] = true,
 
['EISSN'] = true,
['embargo'] = true,
 
 
['encyclopaedia'] = true,
 
['encyclopaedia'] = true,
 
['encyclopedia'] = true,
 
['encyclopedia'] = true,
Line 108: Line 86:
 
['entry-url'] = true,
 
['entry-url'] = true,
 
['entry-url-access'] = true,
 
['entry-url-access'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
+
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['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,
 
['first'] = true,
 
['format'] = true,
 
['format'] = true,
Line 122: Line 93:
 
['HDL'] = true,
 
['HDL'] = true,
 
['hdl-access'] = true,
 
['hdl-access'] = true,
['host'] = true,
+
['host'] = true, -- unique to certain templates?
 
['id'] = true,
 
['id'] = true,
 
['ID'] = true,
 
['ID'] = true,
['ignoreisbnerror'] = true,
+
['institution'] = true, -- constrain to cite thesis?
['ignore-isbn-error'] = true,
 
['inset'] = true,
 
['institution'] = true,
 
 
['interviewer'] = true,
 
['interviewer'] = true,
 
['interviewer-first'] = true,
 
['interviewer-first'] = true,
 +
['interviewer-given'] = true,
 
['interviewer-last'] = true,
 
['interviewer-last'] = true,
['interviewerlink'] = true,
+
['interviewer-surname'] = true,
 
['interviewer-link'] = true,
 
['interviewer-link'] = true,
['interviewermask'] = true,
 
 
['interviewer-mask'] = true,
 
['interviewer-mask'] = true,
 
['isbn'] = true,
 
['isbn'] = true,
 
['ISBN'] = true,
 
['ISBN'] = true,
['isbn13'] = true,
 
['ISBN13'] = true,
 
 
['ismn'] = true,
 
['ismn'] = true,
 
['ISMN'] = true,
 
['ISMN'] = true,
Line 154: Line 120:
 
['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-format'] = true,
 
['lay-source'] = true,
 
['lay-source'] = true,
['lay-format'] = true,
 
['layurl'] = true,
 
 
['lay-url'] = true,
 
['lay-url'] = true,
 
['lccn'] = true,
 
['lccn'] = true,
Line 167: Line 128:
 
['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
 
['map-url-access'] = true, -- cite map only
 
 
['medium'] = true,
 
['medium'] = true,
['message-id'] = true, -- cite newsgroup
+
['minutes'] = true, -- constrain to cite AV media and podcast?
['minutes'] = true,
 
 
['mode'] = true,
 
['mode'] = true,
 
['mr'] = true,
 
['mr'] = true,
 
['MR'] = true,
 
['MR'] = true,
['name-list-format'] = true,
+
['name-list-style'] = true,
['network'] = true,
 
['newsgroup'] = true,
 
 
['newspaper'] = true,
 
['newspaper'] = true,
['nocat'] = true,
 
['no-cat'] = true,
 
['nopp'] = true,
 
 
['no-pp'] = true,
 
['no-pp'] = true,
['notracking'] = true,
 
 
['no-tracking'] = true,
 
['no-tracking'] = true,
 
['number'] = true,
 
['number'] = true,
Line 196: Line 143:
 
['OL'] = true,
 
['OL'] = true,
 
['ol-access'] = true,
 
['ol-access'] = true,
 +
['orig-date'] = true,
 
['origyear'] = true,
 
['origyear'] = true,
 
['orig-year'] = true,
 
['orig-year'] = true,
Line 210: Line 158:
 
['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'] = true,
 
 
['publication-date'] = true,
 
['publication-date'] = true,
['publicationplace'] = true,
 
 
['publication-place'] = true,
 
['publication-place'] = true,
 
['publisher'] = true,
 
['publisher'] = true,
 
['quotation'] = true,
 
['quotation'] = true,
 
['quote'] = true,
 
['quote'] = true,
 +
['quote-page'] = true,
 +
['quote-pages'] = true,
 
['ref'] = true,
 
['ref'] = true,
 
['rfc'] = true,
 
['rfc'] = true,
 
['RFC'] = true,
 
['RFC'] = true,
 +
['sbn'] = true,
 +
['SBN'] = true,
 
['scale'] = true,
 
['scale'] = true,
 
['script-article'] = true,
 
['script-article'] = true,
Line 231: Line 182:
 
['script-journal'] = true,
 
['script-journal'] = true,
 
['script-magazine'] = true,
 
['script-magazine'] = true,
['script-map'] = true,
 
 
['script-newspaper'] = true,
 
['script-newspaper'] = true,
 
['script-periodical'] = true,
 
['script-periodical'] = true,
 +
['script-quote'] = true,
 
['script-section'] = true,
 
['script-section'] = true,
 
['script-title'] = true,
 
['script-title'] = true,
 
['script-website'] = true,
 
['script-website'] = true,
 
['script-work'] = true,
 
['script-work'] = true,
['season'] = true,
 
 
['section'] = true,
 
['section'] = true,
 
['section-format'] = true,
 
['section-format'] = true,
['sections'] = true, -- cite map only
 
['sectionurl'] = true,
 
 
['section-url'] = true,
 
['section-url'] = true,
 
['section-url-access'] = true,
 
['section-url-access'] = true,
 
['series'] = true,
 
['series'] = true,
['serieslink'] = true,
+
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['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,
 
['SSRN'] = true,
['station'] = true,
+
['ssrn-access'] = true,
 
['subject'] = true,
 
['subject'] = true,
['subjectlink'] = true,
 
 
['subject-link'] = true,
 
['subject-link'] = true,
 +
['subject-mask'] = true,
 
['surname'] = true,
 
['surname'] = true,
 +
['s2cid'] = true,
 +
['S2CID'] = true,
 +
['s2cid-access'] = true,
 
['template-doc-demo'] = true,
 
['template-doc-demo'] = true,
['time'] = true,
+
['time'] = true, -- constrain to cite av media and podcast?
['timecaption'] = true,
+
['time-caption'] = true, -- constrain to cite av media and podcast?
['time-caption'] = true,
 
 
['title'] = true,
 
['title'] = true,
['titlelink'] = true,
 
 
['title-link'] = true,
 
['title-link'] = true,
['trans-map'] = true,
 
['transcript'] = true,
 
['transcript-format'] = true,
 
['transcripturl'] = true,
 
['transcript-url'] = true,
 
 
['translator'] = true,
 
['translator'] = true,
 
['translator-first'] = true,
 
['translator-first'] = true,
['translator-last'] = true,
 
 
['translator-given'] = true,
 
['translator-given'] = true,
 +
['translator-last'] = true,
 
['translator-surname'] = true,
 
['translator-surname'] = true,
 
['translator-link'] = true,
 
['translator-link'] = true,
Line 289: Line 224:
 
['trans-newspaper'] = true,
 
['trans-newspaper'] = true,
 
['trans-periodical'] = true,
 
['trans-periodical'] = true,
 +
['trans-quote'] = true,
 
['trans-section'] = true,
 
['trans-section'] = true,
 
['trans-title'] = true,
 
['trans-title'] = true,
Line 314: Line 250:
 
['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#'] = true,
 
 
['contributor#'] = true,
 
['contributor#'] = true,
 
['contributor-first#'] = true,
 
['contributor-first#'] = true,
 
['contributor#-first'] = true,
 
['contributor#-first'] = true,
 +
['contributor-given#'] = true,
 +
['contributor#-given'] = true,
 
['contributor-last#'] = true,
 
['contributor-last#'] = true,
 
['contributor#-last'] = true,
 
['contributor#-last'] = true,
['contributor-given#'] = true,
 
['contributor#-given'] = true,
 
 
['contributor-surname#'] = true,
 
['contributor-surname#'] = true,
 
['contributor#-surname'] = true,
 
['contributor#-surname'] = true,
Line 340: Line 278:
 
['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#'] = true,
 
 
['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,
Line 360: Line 294:
 
['interviewer-first#'] = true,
 
['interviewer-first#'] = true,
 
['interviewer#-first'] = true,
 
['interviewer#-first'] = true,
 +
['interviewer-given#'] = true,
 +
['interviewer#-given'] = true,
 
['interviewer-last#'] = true,
 
['interviewer-last#'] = true,
 
['interviewer#-last'] = true,
 
['interviewer#-last'] = true,
 +
['interviewer-surname#'] = true,
 +
['interviewer#-surname'] = true,
 
['interviewer-link#'] = true,
 
['interviewer-link#'] = true,
 
['interviewer#-link'] = true,
 
['interviewer#-link'] = true,
Line 369: Line 307:
 
['subject#'] = true,
 
['subject#'] = true,
 
['subject-link#'] = true,
 
['subject-link#'] = true,
['subject#link'] = true,
 
 
['subject#-link'] = true,
 
['subject#-link'] = true,
['subjectlink#'] = true,
+
['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-given#'] = true,
 
['translator#-given'] = true,
 
 
['translator-surname#'] = true,
 
['translator-surname#'] = true,
 
['translator#-surname'] = true,
 
['translator#-surname'] = true,
Line 394: Line 332:
 
defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are supplemented with a
 
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
 
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.
+
preprint templates.  Some of these parameters may also be available to the general cs1|2 templates.
 
 
Same conventions for true/false/nil as above.
 
 
 
]]
 
 
 
--[[--------------------------< C I T E  A R X I V >----------------------------------------------------------
 
 
 
]]
 
 
 
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 = {
+
Same conventions for true/false/dicouraged/nil as above.
['biorxiv'] = true,
 
}
 
 
 
 
 
--[[--------------------------< C I T E  C I T E S E E R X >--------------------------------------------------
 
  
 
]]
 
]]
  
local citeseerx_basic_arguments = {
+
local preprint_arguments = {
['citeseerx'] = true,
+
arxiv = {
}
+
['arxiv'] = true, -- cite arxiv and arxiv identifiers
 
+
['class'] = true,
 
+
['eprint'] = true, -- cite arxiv and arxiv identifiers
--[[--------------------------< C I T E  S S R N >------------------------------------------------------------
+
},
 
+
biorxiv = {
]]
+
['biorxiv'] = true,
 
+
},
local ssrn_basic_arguments = {
+
citeseerx = {
['ssrn'] = true,
+
['citeseerx'] = true,
['SSRN'] = true,
+
},
}
+
ssrn = {
 +
['ssrn'] = true,
 +
['SSRN'] = true,
 +
['ssrn-access'] = 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 >----------------------
 
--[[--------------------------< 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
+
cite arxiv, cite biorxiv, cite citeseerx, and cite ssrn templates are preprint templates so are allowed only a
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates.  These parameters are common to
+
limited subset of parameters allowed to all other cs1|2 templates.  The limited subset is defined here.
all three templates
 
  
Same conventions for true/false/nil as above.
+
Same conventions for true/false/dicouraged/nil as above.
 
 
 
]]
 
]]
Line 453: Line 371:
 
['author'] = true,
 
['author'] = true,
 
['author-first'] = true,
 
['author-first'] = true,
 +
['author-given'] = true,
 
['author-last'] = true,
 
['author-last'] = true,
 +
['author-surname'] = true,
 +
['author-link'] = true,
 
['authorlink'] = true,
 
['authorlink'] = true,
['author-link'] = true,
 
['authormask'] = true,
 
 
['author-mask'] = true,
 
['author-mask'] = true,
 
['authors'] = true,
 
['authors'] = true,
Line 462: Line 381:
 
['date'] = true,
 
['date'] = true,
 
['df'] = true,
 
['df'] = true,
['displayauthors'] = true,
 
 
['display-authors'] = true,
 
['display-authors'] = true,
 
['first'] = true,
 
['first'] = true,
Line 468: Line 386:
 
['language'] = true,
 
['language'] = true,
 
['last'] = true,
 
['last'] = true,
['lastauthoramp'] = true,
 
['last-author-amp'] = true,
 
 
['mode'] = true,
 
['mode'] = true,
['name-list-format'] = true,
+
['name-list-style'] = true,
['nocat'] = true,
 
['no-cat'] = true,
 
['notracking'] = true,
 
 
['no-tracking'] = true,
 
['no-tracking'] = true,
 
['p'] = true,
 
['p'] = true,
Line 487: Line 400:
 
['template-doc-demo'] = true,
 
['template-doc-demo'] = true,
 
['title'] = true,
 
['title'] = true,
['url'] = true,
+
['trans-title'] = true,
['URL'] = true,
 
 
['vauthors'] = true,
 
['vauthors'] = true,
 
['year'] = true,
 
['year'] = true,
Line 497: Line 409:
 
['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#'] = true,
 
 
['first#'] = true,
 
['first#'] = true,
 
['given#'] = true,
 
['given#'] = true,
 
['last#'] = true,
 
['last#'] = true,
 
['surname#'] = 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,
 +
['transcript-url'] = true,
 +
},
 +
conference = {
 +
['book-title'] = true,
 +
['conference'] = true,
 +
['conference-format'] = true,
 +
['conference-url'] = true,
 +
['event'] = true,
 +
},
 +
episode = {
 +
['airdate'] = true,
 +
['air-date'] = true,
 +
['credits'] = true,
 +
['episode-link'] = true, -- alias of |title-link=
 +
['network'] = true,
 +
['season'] = true,
 +
['series-link'] = true,
 +
['series-no'] = true,
 +
['series-number'] = true,
 +
['station'] = true,
 +
['transcript'] = true,
 +
['transcript-format'] = true,
 +
['transcripturl'] = false,
 +
['transcript-url'] = true,
 +
},
 +
mailinglist = {
 +
['mailing-list'] = true,
 +
},
 +
map = {
 +
['cartography'] = true,
 +
['inset'] = true,
 +
['map'] = true,
 +
['map-format'] = 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,
 +
},
 +
report = {
 +
['docket'] = true,
 +
},
 +
serial = {
 +
['airdate'] = true,
 +
['air-date'] = true,
 +
['credits'] = true,
 +
['episode'] = true, -- cite serial only TODO: make available to cite episode?
 +
['episode-link'] = true, -- alias of |title-link=
 +
['network'] = true,
 +
['series-link'] = true,
 +
['station'] = true,
 +
},
 +
speech = {
 +
['conference'] = true,
 +
['conference-format'] = true,
 +
['conference-url'] = true,
 +
['event'] = true,
 +
},
 +
thesis = {
 +
['degree'] = true,
 +
['docket'] = 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
  
  
Line 522: Line 535:
 
limited_basic_arguments = limited_basic_arguments,
 
limited_basic_arguments = limited_basic_arguments,
 
limited_numbered_arguments = limited_numbered_arguments,
 
limited_numbered_arguments = limited_numbered_arguments,
arxiv_basic_arguments = arxiv_basic_arguments,
+
 
biorxiv_basic_arguments = biorxiv_basic_arguments,
+
preprint_arguments = preprint_arguments,
citeseerx_basic_arguments = citeseerx_basic_arguments,
+
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
ssrn_basic_arguments = ssrn_basic_arguments
+
unique_arguments = unique_arguments,
 +
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
 
};
 
};

Latest revision as of 23:55, 1 December 2021

Lua error in package.lua at line 80: module 'strict' not found. This page contains a list of all parameters considered by Module:Citation/CS1, though not all parameters would be used for all citations.

The content shown here was initially generated by Module:Citation/CS1/Arguments but is now maintained by hand to allow parameters to be assigned one of several defined states. Current states are: active (true), deprecated (false), and obsolete (nil).



--[[--------------------------< 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. remove entirely
	
]]

local basic_arguments = {
	['accessdate'] = true,
	['access-date'] = true,
	['agency'] = 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,															-- cite arxiv; here because allowed in cite ... as identifier
	['asin'] = true,
	['ASIN'] = true,
	['asin-tld'] = true,
	['at'] = true,
	['author'] = true,
	['author-first'] = true,
	['author-given'] = true,
	['author-last'] = true,
	['author-surname'] = true,
	['authorlink'] = true,
	['author-link'] = true,
	['author-mask'] = true,
	['authors'] = true,
	['bibcode'] = true,
	['bibcode-access'] = true,
	['biorxiv'] = true,															-- cite biorxiv; here because allowed in cite ... as identifier
	['chapter'] = true,
	['chapter-format'] = true,
	['chapter-url'] = true,
	['chapter-url-access'] = true,
	['citeseerx'] = true,														-- cite citeseerx; here because allowed in cite ... as identifier
	['collaboration'] = true,
	['contribution'] = true,
	['contribution-format'] = 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,
	['department'] = true,
	['df'] = true,
	['dictionary'] = true,
	['display-authors'] = true,
	['display-contributors'] = true,
	['display-editors'] = true,
	['display-interviewers'] = true,
	['display-subjects'] = true,
	['display-translators'] = true,
	['doi'] = true,
	['DOI'] = true,
	['doi-access'] = true,
	['doi-broken-date'] = true,
	['edition'] = true,
	['editor'] = true,
	['editor-first'] = true,
	['editor-given'] = true,
	['editor-last'] = true,
	['editor-surname'] = true,
	['editor-link'] = true,
	['editor-mask'] = true,
	['eissn'] = true,
	['EISSN'] = true,
	['encyclopaedia'] = true,
	['encyclopedia'] = true,
	['entry'] = true,
	['entry-format'] = true,
	['entry-url'] = true,
	['entry-url-access'] = true,
	['eprint'] = true,															-- cite arxiv; here because allowed in cite ... as identifier
	['first'] = true,
	['format'] = true,
	['given'] = true,
	['hdl'] = true,
	['HDL'] = true,
	['hdl-access'] = true,
	['host'] = true,															-- unique to certain templates?
	['id'] = true,
	['ID'] = true,
	['institution'] = true,														-- constrain to cite thesis?
	['interviewer'] = true,
	['interviewer-first'] = true,
	['interviewer-given'] = true,
	['interviewer-last'] = true,
	['interviewer-surname'] = true,
	['interviewer-link'] = true,
	['interviewer-mask'] = true,
	['isbn'] = true,
	['ISBN'] = 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,
	['lay-date'] = true,
	['lay-format'] = true,
	['lay-source'] = true,
	['lay-url'] = true,
	['lccn'] = true,
	['LCCN'] = true,
	['location'] = true,
	['magazine'] = true,
	['medium'] = true,
	['minutes'] = true,															-- constrain to cite AV media and podcast?
	['mode'] = true,
	['mr'] = true,
	['MR'] = true,
	['name-list-style'] = true,
	['newspaper'] = true,
	['no-pp'] = true,
	['no-tracking'] = true,
	['number'] = true,
	['oclc'] = true,
	['OCLC'] = true,
	['ol'] = true,
	['OL'] = true,
	['ol-access'] = true,
	['orig-date'] = 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,
	['pmc-embargo-date'] = true,
	['pmid'] = true,
	['PMID'] = true,
	['postscript'] = true,
	['pp'] = true,
	['publication-date'] = true,
	['publication-place'] = true,
	['publisher'] = true,
	['quotation'] = true,
	['quote'] = true,
	['quote-page'] = true,
	['quote-pages'] = true,
	['ref'] = true,
	['rfc'] = true,
	['RFC'] = true,
	['sbn'] = true,
	['SBN'] = 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,
	['section'] = true,
	['section-format'] = true,
	['section-url'] = true,
	['section-url-access'] = true,
	['series'] = true,
	['ssrn'] = true,															-- cite ssrn; these three here because allowed in cite ... as identifier
	['SSRN'] = true,
	['ssrn-access'] = true,
	['subject'] = true,
	['subject-link'] = true,
	['subject-mask'] = true,
	['surname'] = true,
	['s2cid'] = true,
	['S2CID'] = true,
	['s2cid-access'] = true,
	['template-doc-demo'] = true,
	['time'] = true,															-- constrain to cite av media and podcast?
	['time-caption'] = true,													-- constrain to cite av media and podcast?
	['title'] = true,
	['title-link'] = true,
	['translator'] = true,
	['translator-first'] = true,
	['translator-given'] = true,
	['translator-last'] = 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-quote'] = 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-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,
	['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-first#'] = true,
	['editor#-first'] = true,
	['editor-given#'] = true,
	['editor#-given'] = true,
	['editor-last#'] = true,
	['editor#-last'] = true,
	['editor-surname#'] = true,
	['editor#-surname'] = true,
	['editor-link#'] = true,
	['editor#-link'] = true,
	['editor-mask#'] = true,
	['editor#-mask'] = true,
	['first#'] = 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,
	['subject#'] = true,
	['subject-link#'] = true,
	['subject#-link'] = true,
	['subject-mask#'] = true,
	['subject#-mask'] = 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,
		['ssrn-access'] = 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'] = true,
	['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,
	['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,
	['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,
		['transcript-url'] = true,
		},
	conference = {
		['book-title'] = true,
		['conference'] = true,
		['conference-format'] = true,
		['conference-url'] = true,
		['event'] = true,
		},
	episode = {
		['airdate'] = true,
		['air-date'] = true,
		['credits'] = true,
		['episode-link'] = true,												-- alias of |title-link=
		['network'] = true,
		['season'] = true,
		['series-link'] = true,
		['series-no'] = true,
		['series-number'] = true,
		['station'] = true,
		['transcript'] = true,
		['transcript-format'] = true,
		['transcripturl'] = false,
		['transcript-url'] = true,
		},
	mailinglist = {
		['mailing-list'] = true,
		},
	map = {
		['cartography'] = true,
		['inset'] = true,
		['map'] = true,
		['map-format'] = 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,
		},
	report = {
		['docket'] = true,
		},
	serial = {
		['airdate'] = true,
		['air-date'] = true,
		['credits'] = true,
		['episode'] = true,														-- cite serial only TODO: make available to cite episode?
		['episode-link'] = true,												-- alias of |title-link=
		['network'] = true,
		['series-link'] = true,
		['station'] = true,
		},
	speech = {
		['conference'] = true,
		['conference-format'] = true,
		['conference-url'] = true,
		['event'] = true,
		},
	thesis = {
		['degree'] = true,
		['docket'] = 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
	};