Wikipedia

Module:Citation/CS1/Whitelist: Difference between revisions

Browse history interactively
← Previous edit
Content deleted Content added
m restore |series-no=;
sync from sandbox;
 
(6 intermediate revisions by 2 users not shown)
Line 1:
 
--[[--------------------------< S U P P O R T E D P A R A M E T E R S >--------------------------------------
 
Line 5 ⟶ 4:
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
discouraged - pre-deprecation purgatory; may someday be deprecated; or not
nil - these parameters are no longer supported. remove entirely
]]
 
local basic_argumentsbasic_arguments_t = {
['accessdate'] = 'discouraged'true,
['access-date'] = true,
['agency'] = true,
['archivedate'] = 'discouraged'true,
['archive-date'] = true,
['archive-format'] = true,
['archiveurl'] = 'discouraged'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,
Line 33:
['author-last'] = true,
['author-surname'] = true,
['authorlink'] = 'discouraged'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
['booktitle'] = false,
['book-title'] = true,
['cartography'] = true,
['chapter'] = true,
['chapter-format'] = true,
['chapterurl'] = false,
['chapter-url'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true, -- cite citeseerx; here because allowed in cite ... as identifier
['collaboration'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['contribution'] = true,
['contribution-format'] = true,
Line 65 ⟶ 57:
['contributor-mask'] = true,
['date'] = true,
['degree'] = true,
['department'] = true,
['df'] = true,
Line 75 ⟶ 66:
['display-subjects'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
['DOI'] = true,
Line 97 ⟶ 87:
['entry-url-access'] = true,
['eprint'] = true, -- cite arxiv; here because allowed in cite ... as identifier
['event'] = true, -- synonym of conference in /Config, but used in Cite speech?
['first'] = true,
['format'] = true,
Line 104 ⟶ 93:
['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,
Line 117 ⟶ 106:
['isbn'] = true,
['ISBN'] = true,
['isbn13'] = true,
['ISBN13'] = true,
['ismn'] = true,
['ISMN'] = true,
Line 133 ⟶ 120:
['language'] = true,
['last'] = true,
['lay-date'] = true,
['lay-source'] = true,
['lay-format'] = true,
['lay-url'] = true,
['lccn'] = true,
['LCCN'] = true,
Line 142 ⟶ 125:
['magazine'] = true,
['medium'] = true,
['medrxiv'] = true, -- cite medrxiv; here because allowed in cite ... as identifier
['minutes'] = true,
['minutes'] = true, -- constrain to cite AV media and podcast?
['mode'] = true,
['mr'] = true,
Line 148 ⟶ 132:
['name-list-style'] = true,
['newspaper'] = true,
['nopp'] = false,
['no-pp'] = true,
['no-tracking'] = true,
Line 158 ⟶ 141:
['ol-access'] = true,
['orig-date'] = true,
['origyear'] = 'discouraged'true,
['orig-year'] = true,
['osti'] = true,
Line 167 ⟶ 150:
['page'] = true,
['pages'] = true,
['people'] = true,
['periodical'] = true,
['place'] = true,
Line 177 ⟶ 159:
['postscript'] = true,
['pp'] = true,
['publicationdate'] = false,
['publication-date'] = true,
['publicationplace'] = false,
['publication-place'] = true,
['publisher'] = true,
Line 195 ⟶ 175:
['script-chapter'] = true,
['script-contribution'] = true,
['script-encyclopaedia'] = true,
['script-encyclopedia'] = true,
['script-entry'] = true,
['script-journal'] = true,
Line 205 ⟶ 187:
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
Line 211 ⟶ 192:
['section-url-access'] = true,
['series'] = true,
['ssrn'] = true, -- cite ssrn; these three here because allowed in cite ... as identifier
['serieslink'] = false,
['series-link'] = true,
['series-no'] = true,
['series-number'] = true,
['ssrn'] = true, -- cite ssrn; these two 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,
Line 225 ⟶ 207:
['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,
Line 239 ⟶ 222:
['trans-chapter'] = true,
['trans-contribution'] = true,
['trans-encyclopaedia'] = true,
['trans-encyclopedia'] = true,
['trans-entry'] = true,
['trans-journal'] = true,
Line 264 ⟶ 249:
['zbl'] = true,
['ZBL'] = true,
}
 
local numbered_argumentsnumbered_arguments_t = {
['author#'] = true,
['author-first#'] = true,
Line 278 ⟶ 263:
['author-link#'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged'true,
['author#link'] = 'discouraged'true,
['author-mask#'] = true,
['author#-mask'] = true,
Line 326 ⟶ 311:
['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,
Line 344 ⟶ 337:
['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 limited set of parameters
set of parameters defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a
supplemented with a template-specific list of parameters that are required by the particular template and may be exclusive to one of the
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/dicouragedtracked/nil as above.
 
]]
 
local preprint_argumentspreprint_arguments_t = {
arxiv = {
['arxiv'] = true, -- cite arxiv and arxiv identifiers
Line 369 ⟶ 363:
citeseerx = {
['citeseerx'] = true,
},
medrxiv = {
['medrxiv'] = true,
},
ssrn = {
['ssrn'] = true,
['SSRN'] = true,
['ssrn-access'] = true,
},
}
Line 379 ⟶ 377:
--[[--------------------------< 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 allowed only a
allowed only a limited subset of parameters allowed to all other cs1|2 templates. The limited subset is defined
here.
 
This list of parameters also used by {{cite document}}
 
Same conventions for true/false/dicouragedtracked/nil as above.
]]
 
local limited_basic_argumentslimited_basic_arguments_t = {
['at'] = true,
['author'] = true,
Line 394 ⟶ 395:
['author-surname'] = true,
['author-link'] = true,
['authorlink'] = 'discouraged'true,
['author-mask'] = true,
['authors'] = true,
['collaboration'] = true,
['date'] = true,
Line 420:
['title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
['vauthors'] = true,
['year'] = true,
}
 
local limited_numbered_argumentslimited_numbered_arguments_t = {
['author#'] = true,
['author-first#'] = true,
Line 438 ⟶ 436:
['author-link#'] = true,
['author#-link'] = true,
['authorlink#'] = 'discouraged'true,
['author#link'] = 'discouraged'true,
['author-mask#'] = true,
['author#-mask'] = true,
Line 454 ⟶ 452:
table are the template's CitationClass parameter value
 
Same conventions for true/false/dicouragedtracked/nil as above.
 
]]
 
local unique_argumentsunique_arguments_t = {
['audio-visual'] = {
['people'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = false,
['transcript-url'] = true,
},
conference = {
['book-title'] = true,
['conference'] = true,
['conference-format'] = true,
['conference-url'] = true,
['event'] = true,
},
episode = {
['airdate'] = 'discouraged'true,
['air-date'] = true,
['credits'] = true,
['episodelink'] = false, -- alias of |title-link=
['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,
['transcripturl'] = false,
['transcript-url'] = true,
},
mailinglist = {
['mailinglist'] = false,
['mailing-list'] = true,
},
map = {
['cartography'] = true,
['inset'] = true,
['map'] = true,
['map-format'] = true,
['mapurl'] = false,
['map-url'] = true,
['map-url-access'] = true,
Line 498 ⟶ 505:
['message-id'] = true,
['newsgroup'] = true,
},
report = {
['docket'] = true,
},
serial = {
['airdate'] = 'discouraged'true,
['air-date'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = false,
['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
 
 
Line 519 ⟶ 630:
 
local function template_list_get (t)
local outout_t = {}; -- a table for output
for k, _ in pairs (t) do -- spin through the table and collect the keys
table.insert (outout_t, k) -- add each key to the output table
end
return outout_t; -- and done
end
 
Line 531 ⟶ 642:
 
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,
 
document_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t, document_arguments_t, document_numbered_arguments_t});
preprint_arguments = preprint_arguments,
common_parameters_t = list_combine ({basic_arguments_t, numbered_arguments_t});
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
limited_parameters_t = list_combine ({limited_basic_arguments_t, limited_numbered_arguments_t});
unique_arguments = unique_arguments,
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};
Retrieved from "https://en.wikipedia.org/wiki/Module:Citation/CS1/Whitelist"