Module:Citation/CS1/Whitelist and Module:Citation/CS1/Whitelist/sandbox: Difference between pages

(Difference between pages)
Jump to: navigation, search
Page 1
Page 2
m 1 revision imported: Updating the citation templates
 
m 1 revision imported
 
Line 1: Line 1:
--[[
History of changes since last sync: 2016-10-29
2016-11-21: removed cite interview parameters, 'unrestrict' interviewer(s)
2017-03-26: support for cite biorxiv and cite citeseerx; see Help_talk:Citation_Style_1#.7B.7Bcite_bioRxiv.7D.7D
]]
--[[--------------------------< 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
['callsign'] = nil, -- cite interview removed
['call-sign'] = nil, -- cite interview removed
['chapterlink'] = nil, -- if ever necessary to link to a chapter article, |chapter= can be wikilinked
['chapter-link'] = nil, --
['city'] = nil, -- cite interview removed
['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
['pp-prefix'] = nil, -- not used, not documented
['p-prefix'] = nil, -- not used, not documented
['program'] = nil, -- cite interview removed
['publisherid'] = nil, -- unique alias of id used by old cite AV media notes and old cite DVD-notes
['Ref'] = nil, -- non-standard capitalization
['separator'] = nil, -- this functionality now provided by |mode=
['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 4: Line 64:
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
tracked - these parameters are valid and supported parameters tracked in an eponymous properties category
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
]]
]]


local basic_arguments_t = {
local whitelist = {}
 
local basic_arguments = {
['accessdate'] = true,
['accessdate'] = true,
['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 82:
['archive-url'] = true,
['archive-url'] = true,
['article'] = true,
['article'] = true,
['article-format'] = true,
['arxiv'] = true,
['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value
['ARXIV'] = false,
['article-url'] = 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'] = true,
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['bibcode'] = true,
['bibcode'] = true,
['BIBCODE'] = false,
['bibcode-access'] = true,
['bibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['biorxiv'] = true,
['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,
['citeseerx'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['class'] = true, -- cite arxiv and arxiv identifiers
['coauthor'] = false, -- deprecated
['coauthors'] = false, -- deprecated
['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,
['contributor'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-first'] = true,
['contributor-last'] = true,
['contributor-given'] = true,
['contributor-given'] = true,
['contributor-last'] = 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,
['deadurl'] = true,
['dead-url'] = 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,
['displayeditors'] = true,
['display-editors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['docket'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['doi'] = true,
['doi'] = true,
['DOI'] = true,
['DOI'] = true,
['doi-access'] = true,
['doi-access'] = true,
['doi-broken'] = true,
['doi_brokendate'] = true, -- @TODO deprecate underscore version?
['doi-broken-date'] = true,
['doi-broken-date'] = true,
['doi_inactivedate'] = true, -- @TODO deprecate underscore version?
['doi-inactive-date'] = true,
['edition'] = true,
['edition'] = true,
['editor'] = true,
['editor'] = true,
Line 75: Line 154:
['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,
['editors'] = true,
['editor-surname'] = true,
['eissn'] = true,
['eissn'] = true,
['EISSN'] = 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-format'] = true,
['eventurl'] = true,
['event-url'] = true,
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
Line 93: Line 180:
['HDL'] = true,
['HDL'] = true,
['hdl-access'] = true,
['hdl-access'] = true,
['host'] = true, -- unique to certain templates?
['host'] = true,
['id'] = true,
['id'] = true,
['ID'] = true,
['ID'] = true,
['institution'] = true, -- constrain to cite thesis?
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
['interviewer'] = true,
['interviewer'] = true,
['interviewer-first'] = true,
['interviewer-first'] = true,
['interviewer-given'] = true,
['interviewer-last'] = true,
['interviewer-last'] = true,
['interviewer-surname'] = true,
['interviewerlink'] = true,
['interviewer-link'] = true,
['interviewer-link'] = true,
['interviewermask'] = true,
['interviewer-mask'] = true,
['interviewer-mask'] = true,
['interviewers'] = true,
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ismn'] = true,
['ISMN'] = true,
['ISMN'] = true,
Line 117: Line 211:
['JSTOR'] = true,
['JSTOR'] = true,
['jstor-access'] = 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,
['laysource'] = true,
['lay-source'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['lay-format'] = true,
['layurl'] = true,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
['LCCN'] = true,
['LCCN'] = true,
['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,
['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier
['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-style'] = true,
['name-list-format'] = 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 140: Line 256:
['OL'] = true,
['OL'] = true,
['ol-access'] = true,
['ol-access'] = true,
['orig-date'] = true,
['origyear'] = true,
['origyear'] = true,
['orig-year'] = true,
['orig-year'] = true,
Line 150: Line 265:
['page'] = true,
['page'] = true,
['pages'] = true,
['pages'] = true,
['people'] = true,
['periodical'] = true,
['periodical'] = true,
['place'] = true,
['place'] = true,
['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,
['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-encyclopaedia'] = true,
['script-encyclopedia'] = 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,
['season'] = true,
['script-work'] = 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,
['series'] = true,
['series'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['serieslink'] = true,
['series-link'] = true,
['seriesno'] = true,
['series-no'] = true,
['seriesnumber'] = true,
['series-number'] = true,
['series-separator'] = true,
['sheet'] = true, -- cite map only
['sheets'] = true, -- cite map only
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
['station'] = true,
['subject'] = true,
['subject'] = true,
['subject-first'] = true,
['subjectlink'] = true,
['subject-given'] = true,
['subject-last'] = true,
['subject-link'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['subscription'] = true,
['subject-surname'] = 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, -- constrain to cite av media and podcast?
['time'] = true,
['time-caption'] = true, -- constrain to cite av media and podcast?
['timecaption'] = true,
['time-caption'] = true,
['title'] = true,
['title'] = true,
['titlelink'] = true,
['title-link'] = true,
['title-link'] = true,
['title-note'] = 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-last'] = true,
['translator-given'] = true,
['translator-given'] = true,
['translator-last'] = true,
['translator-surname'] = 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-encyclopaedia'] = true,
['trans-encyclopedia'] = 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-access'] = true,
['url-status'] = true,
['vauthors'] = true,
['vauthors'] = true,
['veditors'] = true,
['veditors'] = true,
Line 249: Line 350:
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
}


local numbered_arguments_t = {
local numbered_arguments = {
['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#'] = 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-last#'] = true,
['contributor#-last'] = true,
['contributor-given#'] = true,
['contributor-given#'] = true,
['contributor#-given'] = true,
['contributor#-given'] = true,
['contributor-last#'] = true,
['contributor#-last'] = true,
['contributor-surname#'] = true,
['contributor-surname#'] = true,
['contributor#-surname'] = true,
['contributor#-surname'] = true,
Line 283: Line 382:
['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,
['host#'] = true,
['interviewer#'] = true,
['interviewer#'] = true,
['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 311: Line 409:
['last#'] = true,
['last#'] = true,
['subject#'] = true,
['subject#'] = true,
['subject-first#'] = true,
['subject#-first'] = true,
['subject-given#'] = true,
['subject#-given'] = true,
['subject-last#'] = true,
['subject#-last'] = true,
['subject-link#'] = true,
['subject-link#'] = true,
['subject#link'] = true,
['subject#-link'] = true,
['subject#-link'] = true,
['subject-mask#'] = true,
['subjectlink#'] = true,
['subject#-mask'] = true,
['subject-surname#'] = true,
['subject#-surname'] = true,
['surname#'] = true,
['surname#'] = true,
['translator#'] = true,
['translator#'] = true,
['translator-first#'] = true,
['translator-first#'] = true,
['translator#-first'] = true,
['translator#-first'] = true,
['translator-last#'] = true,
['translator#-last'] = true,
['translator-given#'] = true,
['translator-given#'] = true,
['translator#-given'] = true,
['translator#-given'] = true,
['translator-last#'] = true,
['translator#-last'] = true,
['translator-surname#'] = true,
['translator-surname#'] = true,
['translator#-surname'] = true,
['translator#-surname'] = true,
Line 337: Line 427:
['translator-mask#'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
['translator#-mask'] = true,
}
}


--[[--------------------------< C I T E  A R X I V  S U P P O R T E D  P A R A M E T E R S >----------------


--[[--------------------------< 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 >--------------------
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 template.  This method might be expanded to other templates being considered.


Cite arXiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn are preprint templates that use the limited
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
set of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are
true - these parameters are valid and supported parameters
supplemented with a template-specific list of parameters that are required by the particular template and may be
false - these parameters are deprecated but still supported
exclusive to one of the preprint templates.  Some of these parameters may also be available to the general cs1|2
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
templates.
]]
 
local arxiv_basic_arguments = {
['arxiv'] = true,
['ARXIV'] = false,
['class'] = true, -- cite arxiv and arxiv identifiers
['eprint'] = true, -- cite arxiv and arxiv identifiers
['version'] = false,
}
 
 
--[[--------------------------< C I T E  B I O R X I V  S U P P O R T E D  P A R A M E T E R S >------------


Same conventions for true/false/tracked/nil as above.
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
parameters provided in a cite biorxiv template.  This method might be expanded to other templates being considered.


Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
]]
]]


local preprint_arguments_t = {
local biorxiv_basic_arguments = {
arxiv = {
['biorxiv'] = true,
['arxiv'] = true, -- cite arxiv and arxiv identifiers
}
['class'] = true,
 
['eprint'] = true, -- cite arxiv and arxiv identifiers
 
},
--[[--------------------------< C I T E  C I T E S E E R X  S U P P O R T E D  P A R A M E T E R S >--------
biorxiv = {
 
['biorxiv'] = true,
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
},
parameters provided in a cite citeseerx template.  This method might be expanded to other templates being considered.
citeseerx = {
 
['citeseerx'] = true,
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
medrxiv = {
false - these parameters are deprecated but still supported
['medrxiv'] = true,
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
},
ssrn = {
]]
['ssrn'] = true,
 
['SSRN'] = true,
local citeseerx_basic_arguments = {
['ssrn-access'] = true,
['citeseerx'] = 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 >----------------------


cite arxiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn templates are preprint templates so are
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
allowed only a limited subset of parameters allowed to all other cs1|2 templates.  The limited subset is defined
parameters provided in a cite arxiv, cite biorxiv, or cite citeseerx templates.  These parameters are common to
here.
all three templates


This list of parameters also used by {{cite document}}
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
Same conventions for true/false/tracked/nil as above.
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
]]
]]


local limited_basic_arguments_t = {
local limited_basic_arguments = {
['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,
['author-link'] = true,
['author-link'] = true,
['authorlink'] = true,
['authormask'] = true,
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['collaboration'] = true,
['collaboration'] = true,
['date'] = true,
['date'] = true,
Line 405: Line 515:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lastauthoramp'] = true,
['last-author-amp'] = true,
['mode'] = true,
['mode'] = true,
['name-list-style'] = true,
['name-list-format'] = true,
['nocat'] = true,
['no-cat'] = true,
['notracking'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
['p'] = true,
['p'] = true,
Line 417: Line 532:
['ref'] = true,
['ref'] = true,
['surname'] = true,
['surname'] = true,
['template doc demo'] = true,
['template-doc-demo'] = true,
['template-doc-demo'] = true,
['title'] = true,
['title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['vauthors'] = true,
['year'] = true,
['year'] = true,
}
}
 
local limited_numbered_arguments = {
local limited_numbered_arguments_t = {
['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#'] = 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/tracked/nil as above.
 
]]
 
local unique_arguments_t = {
['audio-visual'] = {
['people'] = true,
['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,
['people'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['transcript'] = true,
['transcript-format'] = true,
['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,
['people'] = true,
['series-link'] = true,
['station'] = true,
},
speech = {
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
thesis = {
['degree'] = true,
['docket'] = true,
},
}
 
 
--[[--------------------------< C I T E _ D O C U M E N T >----------------------------------------------------
 
Special case for cite document.  This template takes the limited basic and limited enumerated parameters plus
others that are apply only to standalone published sources that cannot be cited any other way; no url, book,
periodical, etc parameters; limited support for name lists and named identifiers.
 
when validating parameters in {{cite document}} templates, the basic and
 
]]
 
local document_arguments_t = {
['bibcode'] = true,
['bibcode-access'] = true,
['doi'] = true,
['DOI'] = true,
['doi-access'] = true,
['doi-broken-date'] = true,
['hdl'] = true,
['HDL'] = true,
['hdl-access'] = true,
['id'] = true,
['ID'] = true,
['jfm'] = true,
['JFM'] = true,
['lang'] = true,
['location'] = true,
['mr'] = true,
['MR'] = true,
['no-pp'] = true,
['orig-date'] = true,
['origyear'] = true,
['orig-year'] = true,
['osti'] = true,
['OSTI'] = true,
['osti-access'] = true,
['place'] = true,
['publisher'] = true,
['quote-page'] = true,
['quote-pages'] = true,
['script-quote'] = true,
['script-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-quote'] = true,
['type'] = true,
['zbl'] = true,
['ZBL'] = true,
}
 
local document_numbered_arguments_t = {
['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,
}
 
 
--[[--------------------------< L I S T _ C O M B I N E >------------------------------------------------------
 
makes one table from a list of tables.  <lists_t> is a sequence of tables to be combined
 
]]
 
local function list_combine (lists_t)
local out_t = {};
 
for _, list_t in ipairs (lists_t) do -- for each list in <lists_t>
for k, v in pairs (list_t) do -- extract each k/v pair
out_t[k] = v; -- add to <out_t>
end
end
return out_t; -- and done
end
 
 
--[[--------------------------< 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_t = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (out_t, k) -- add each key to the output table
end
return out_t; -- and done
end
 
 
--[[--------------------------< E X P O R T E D  T A B L E S >------------------------------------------------
]]


return {
return {
preprint_arguments_t = preprint_arguments_t,
basic_arguments = basic_arguments,
preprint_template_list_t = template_list_get (preprint_arguments_t), -- make a template list from preprint_arguments{} table
numbered_arguments = numbered_arguments,
unique_arguments_t = unique_arguments_t,
limited_basic_arguments = limited_basic_arguments,
unique_param_template_list_t = template_list_get (unique_arguments_t), -- make a template list from unique_arguments{} table
limited_numbered_arguments = limited_numbered_arguments,
arxiv_basic_arguments = arxiv_basic_arguments,
document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});
biorxiv_basic_arguments = biorxiv_basic_arguments,
common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});
citeseerx_basic_arguments = citeseerx_basic_arguments
limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});
};
};
Retrieved from "https://breakintochat.com/wiki/Special:ComparePages"