Module:Citation/CS1/Whitelist/sandbox
Appearance
![]() | This is the module sandbox page for Module:Citation/CS1/Whitelist (diff). |
This module contains a list of all parameters that Module:Citation/CS1 knows about. Each parameter is assigned a state.
- true: These parameters are valid and supported parameters
- false: These parameters are deprecated but still supported
- 'tracked': These parameters are valid and supported parameters tracked in an eponymous properties category.
- nil: Parameters not present are not supported, or no longer supported.
The basic_arguments
table is supported by all templates.
These files comprise the module support for CS1|2 citation templates:
--[[History of changes since last sync: 2024-08-17]]--[[--------------------------< 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 tracked - these parameters are valid and supported parameters tracked in an eponymous properties category nil - these parameters are no longer supported. remove entirely]]localbasic_arguments_t={['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-number']=true,-- {{cite journal}}, {{cite conference}}; {{citation}} when |journal= has a value['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,['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,['lccn']=true,['LCCN']=true,['location']=true,['magazine']=true,['medium']=true,['medrxiv']=true,-- cite medrxiv; here because allowed in cite ... as identifier['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,['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-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-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-first']=true,['subject-given']=true,['subject-last']=true,['subject-link']=true,['subject-mask']=true,['subject-surname']=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,['title-note']=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-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,['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,}localnumbered_arguments_t={['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-first#']=true,['subject#-first']=true,['subject-given#']=true,['subject#-given']=true,['subject-last#']=true,['subject#-last']=true,['subject-link#']=true,['subject#-link']=true,['subject-mask#']=true,['subject#-mask']=true,['subject-surname#']=true,['subject#-surname']=true,['surname#']=true,['translator#']=true,['translator-first#']=true,['translator#-first']=true,['translator-given#']=true,['translator#-given']=true,['translator-last#']=true,['translator#-last']=true,['translator-surname#']=true,['translator#-surname']=true,['translator-link#']=true,['translator#-link']=true,['translator-mask#']=true,['translator#-mask']=true,}--[[--------------------------< P R E P R I N T S U P P O R T E D P A R A M E T E R S >--------------------Cite arXiv, cite biorxiv, cite citeseerx, cite medrxiv, and cite ssrn are preprint templates that use the limitedset of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists aresupplemented with a template-specific list of parameters that are required by the particular template and may beexclusive to one of the preprint templates. Some of these parameters may also be available to the general cs1|2templates.Same conventions for true/false/tracked/nil as above.]]localpreprint_arguments_t={arxiv={['arxiv']=true,-- cite arxiv and arxiv identifiers['class']=true,['eprint']=true,-- cite arxiv and arxiv identifiers},biorxiv={['biorxiv']=true,},citeseerx={['citeseerx']=true,},medrxiv={['medrxiv']=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, cite medrxiv, and cite ssrn templates are preprint templates so areallowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is definedhere.This list of parameters also used by {{cite document}}Same conventions for true/false/tracked/nil as above.]]locallimited_basic_arguments_t={['at']=true,['author']=true,['author-first']=true,['author-given']=true,['author-last']=true,['author-surname']=true,['author-link']=true,['authorlink']=true,['author-mask']=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,}locallimited_numbered_arguments_t={['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 thistable are the template's CitationClass parameter valueSame conventions for true/false/tracked/nil as above.]]localunique_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 plusothers 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 ]]localdocument_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,}localdocument_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]]localfunctionlist_combine(lists_t)localout_t={};for_,list_tinipairs(lists_t)do-- for each list in <lists_t>fork,vinpairs(list_t)do-- extract each k/v pairout_t[k]=v;-- add to <out_t>endendreturnout_t;-- and doneend--[[--------------------------< T E M P L A T E _ L I S T _ G E T >--------------------------------------------gets a list of the templates from table t]]localfunctiontemplate_list_get(t)localout_t={};-- a table for outputfork,_inpairs(t)do-- spin through the table and collect the keystable.insert(out_t,k)-- add each key to the output tableendreturnout_t;-- and doneend--[[--------------------------< E X P O R T E D T A B L E S >------------------------------------------------]]return{preprint_arguments_t=preprint_arguments_t,preprint_template_list_t=template_list_get(preprint_arguments_t),-- make a template list from preprint_arguments{} tableunique_arguments_t=unique_arguments_t,unique_param_template_list_t=template_list_get(unique_arguments_t),-- make a template list from unique_arguments{} tabledocument_parameters_t=list_combine({limited_basic_arguments_t,limited_numbered_arguments_t,document_arguments_t,document_numbered_arguments_t});common_parameters_t=list_combine({basic_arguments_t,numbered_arguments_t});limited_parameters_t=list_combine({limited_basic_arguments_t,limited_numbered_arguments_t});};