Module:Citation/CS1/Whitelist: Difference between revisions

m
1 revision imported
m (1 revision imported)
m (1 revision imported)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
--[[--------------------------< 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 4:
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. remove entirely
nil - these parameters are no longer supported. remove entirely
Line 20: Line 20:
['article'] = true,
['article'] = true,
['article-format'] = true,
['article-format'] = true,
['article-number'] = true, -- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value
['article-url'] = true,
['article-url'] = true,
['article-url-access'] = true,
['article-url-access'] = true,
Line 34: Line 35:
['authorlink'] = true,
['authorlink'] = true,
['author-link'] = true,
['author-link'] = true,
['authormask'] = false, -- deprecated
['author-mask'] = true,
['author-mask'] = true,
['authors'] = true,
['authors'] = true,
Line 40: Line 40:
['bibcode-access'] = true,
['bibcode-access'] = true,
['biorxiv'] = true, -- cite biorxiv; here because allowed in cite ... as identifier
['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, -- cite citeseerx; here because allowed in cite ... as identifier
['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,
Line 67: Line 58:
['contributor-mask'] = true,
['contributor-mask'] = true,
['date'] = true,
['date'] = true,
['degree'] = true,
['department'] = true,
['department'] = true,
['df'] = true,
['df'] = true,
['dictionary'] = true,
['dictionary'] = true,
['displayauthors'] = false, -- deprecated
['display-authors'] = true,
['display-authors'] = true,
['display-contributors'] = true,
['display-contributors'] = true,
Line 78: Line 67:
['display-subjects'] = true,
['display-subjects'] = true,
['display-translators'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['doi'] = true,
['DOI'] = true,
['DOI'] = true,
Line 89: Line 77:
['editor-last'] = true,
['editor-last'] = true,
['editor-surname'] = true,
['editor-surname'] = true,
['editorlink'] = false, -- deprecated
['editor-link'] = true,
['editor-link'] = true,
['editor-mask'] = true,
['editor-mask'] = true,
['editors'] = false, -- deprecated
['eissn'] = true,
['eissn'] = true,
['EISSN'] = true,
['EISSN'] = true,
Line 102: Line 88:
['entry-url-access'] = true,
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['event'] = true,
['event-format'] = true,
['eventurl'] = true,
['event-url'] = true,
['first'] = true,
['first'] = true,
['format'] = true,
['format'] = true,
Line 112: Line 94:
['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,
['ignore-isbn-error'] = false, -- deprecated
['institution'] = true, -- constrain to cite thesis?
['institution'] = true,
['interviewer'] = true,
['interviewer'] = true,
['interviewer-first'] = true,
['interviewer-first'] = true,
Line 126: Line 107:
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ismn'] = true,
['ISMN'] = true,
['ISMN'] = true,
Line 142: Line 121:
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['lastauthoramp'] = false, -- deprecated
['lay-date'] = false,
['last-author-amp'] = false, -- deprecated
['lay-format'] = false,
['laydate'] = true,
['lay-source'] = false,
['lay-date'] = true,
['lay-url'] = false,
['laysource'] = true,
['lay-source'] = true,
['lay-format'] = true,
['layurl'] = true,
['lay-url'] = true,
['lccn'] = true,
['lccn'] = true,
['LCCN'] = true,
['LCCN'] = true,
Line 156: Line 130:
['magazine'] = true,
['magazine'] = true,
['medium'] = true,
['medium'] = true,
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mode'] = true,
['mr'] = true,
['mr'] = true,
['MR'] = true,
['MR'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['newspaper'] = true,
['newspaper'] = true,
['nocat'] = true,
['nopp'] = true,
['no-pp'] = true,
['no-pp'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
Line 193: Line 164:
['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,
Line 221: Line 190:
['script-website'] = true,
['script-website'] = true,
['script-work'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section'] = true,
['section-format'] = true,
['section-format'] = true,
['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,
['ssrn'] = true, -- cite ssrn; these two here because allowed in cite ... as identifier
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
['subject'] = true,
['subject'] = true,
['subjectlink'] = false, -- deprecated
['subject-link'] = true,
['subject-link'] = true,
['subject-mask'] = true,
['subject-mask'] = true,
Line 245: Line 206:
['s2cid-access'] = 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,
['translator'] = true,
['translator'] = true,
Line 286: Line 245:
['zbl'] = true,
['zbl'] = true,
['ZBL'] = true,
['ZBL'] = true,
}
}


local numbered_arguments = {
local numbered_arguments = {
Line 304: Line 263:
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
['authormask#'] = false, -- deprecated
['author#mask'] = false, -- deprecated
['contributor#'] = true,
['contributor#'] = true,
['contributor-first#'] = true,
['contributor-first#'] = true,
Line 330: Line 287:
['editor-link#'] = true,
['editor-link#'] = true,
['editor#-link'] = true,
['editor#-link'] = true,
['editorlink#'] = false, -- deprecated
['editor#link'] = false, -- deprecated
['editor-mask#'] = true,
['editor-mask#'] = true,
['editor#-mask'] = true,
['editor#-mask'] = true,
Line 354: Line 309:
['subject-link#'] = true,
['subject-link#'] = true,
['subject#-link'] = true,
['subject#-link'] = true,
['subjectlink#'] = false, -- deprecated
['subject#link'] = false, -- deprecated
['subject-mask#'] = true,
['subject-mask#'] = true,
['subject#-mask'] = true,
['subject#-mask'] = true,
Line 372: Line 325:
['translator-mask#'] = true,
['translator-mask#'] = true,
['translator#-mask'] = true,
['translator#-mask'] = true,
}
}




Line 382: Line 335:
preprint 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.
Same conventions for true/false/tracked/nil as above.


]]
]]
Line 401: Line 354:
['ssrn'] = true,
['ssrn'] = true,
['SSRN'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
},
}
}
Line 407: Line 361:
--[[--------------------------< 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/tracked/nil as above.
]]
]]
Line 425: Line 378:
['authorlink'] = true,
['authorlink'] = true,
['author-mask'] = true,
['author-mask'] = true,
['authormask'] = false, -- deprecated
['authors'] = true,
['authors'] = true,
['collaboration'] = true,
['collaboration'] = true,
Line 431: Line 383:
['df'] = true,
['df'] = true,
['display-authors'] = true,
['display-authors'] = true,
['displayauthors'] = false, -- deprecated
['first'] = true,
['first'] = true,
['given'] = true,
['given'] = true,
['language'] = true,
['language'] = true,
['last'] = true,
['last'] = true,
['last-author-amp'] = false, -- deprecated
['lastauthoramp'] = false, -- deprecated
['mode'] = true,
['mode'] = true,
['name-list-format'] = true,
['name-list-style'] = true,
['name-list-style'] = true,
['nocat'] = true,
['no-tracking'] = true,
['no-tracking'] = true,
['p'] = true,
['p'] = true,
Line 455: Line 402:
['title'] = true,
['title'] = true,
['trans-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 = {
Line 477: Line 422:
['author-mask#'] = true,
['author-mask#'] = true,
['author#-mask'] = true,
['author#-mask'] = true,
['authormask#'] = false, -- deprecated
['author#mask'] = false, -- deprecated
['first#'] = true,
['first#'] = true,
['given#'] = true,
['given#'] = true,
Line 491: Line 434:
table are the template's CitationClass parameter value
table are the template's CitationClass parameter value


Same conventions for true/false/nil as above.
Same conventions for true/false/tracked/nil as above.


]]
]]
Line 499: Line 442:
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
},
episode = {
episode = {
Line 506: Line 455:
['air-date'] = true,
['air-date'] = true,
['credits'] = true,
['credits'] = true,
['episodelink'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true, -- alias of |title-link=
['network'] = true,
['network'] = true,
['season'] = true,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['station'] = true,
['station'] = true,
['transcript'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
['transcript-url'] = true,
},
},
mailinglist = {
mailinglist = {
['mailinglist'] = true,
['mailing-list'] = true,
['mailing-list'] = true,
},
},
map = {
map = {
['cartography'] = true,
['inset'] = true,
['inset'] = true,
['map'] = true,
['map'] = true,
['map-format'] = true,
['map-format'] = true,
['mapurl'] = true,
['map-url'] = true,
['map-url'] = true,
['map-url-access'] = true,
['map-url-access'] = true,
Line 535: Line 486:
['message-id'] = true,
['message-id'] = true,
['newsgroup'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
},
serial = {
serial = {
Line 541: Line 495:
['credits'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true, -- alias of |title-link=
['episode-link'] = true,
['network'] = true,
['network'] = true,
['series-link'] = true,
['station'] = true,
['station'] = true,
},
speech = {
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
thesis = {
['degree'] = true,
['docket'] = true,
},
},
}
}