TestWiki

Module:Citation/CS1/Whitelist: Difference between revisions

← Older edit
Content deleted Content added
m 1 revision imported
m 1 revision imported
 
(3 intermediate revisions by 3 users not shown)
Line 1:
 
--[[--------------------------< 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
['ARXIV'] = nil, -- not an initialization
['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
['BIBCODE'] = nil, -- not an initialization
['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
['coauthor'] = nil, -- redundant to |authorn=; not made part of metadata
['coauthors'] = nil, -- redundant to |authorn=; not made part of metadata
['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 >--------------------------------------
Line 62 ⟶ 5:
true - these parameters are valid and supported parameters
false - these parameters are deprecated but still supported
nil - these parameters are no longer supported. (whenremove setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)entirely
]]
Line 72 ⟶ 15:
['access-date'] = true,
['agency'] = true,
['airdate'] = true,
['air-date'] = true,
['archivedate'] = true,
['archive-date'] = true,
Line 80 ⟶ 21:
['archive-url'] = true,
['article'] = true,
['arxivarticle-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,
['ASIN-TLD'] = true,
['at'] = true,
['author'] = true,
Line 106 ⟶ 49:
['chapter-url-access'] = true,
['citeseerx'] = true,
['class'] = true, -- cite arxiv and arxiv identifiers
['collaboration'] = true,
['conference'] = true,
Line 116 ⟶ 58:
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contributor'] = true,
['contributor-first'] = true,
Line 123 ⟶ 66:
['contributor-link'] = true,
['contributor-mask'] = true,
['credits'] = true, -- cite episode, cite serial
['date'] = true,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['department'] = true,
Line 133 ⟶ 73:
['displayauthors'] = true,
['display-authors'] = true,
['display-contributors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['display-translators'] = true,
['docket'] = true,
['doi'] = true,
Line 140 ⟶ 83:
['doi-access'] = true,
['doi-broken'] = true,
['doi_brokendate'] = false,
['doi-broken-date'] = true,
['doi_inactivedate'] = false,
['doi-inactive-date'] = true,
['edition'] = true,
Line 161 ⟶ 102:
['encyclopedia'] = 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; andhere arxivbecause identifiersallowed in cite ... as identifier
['event'] = true,
['event-format'] = true,
Line 180 ⟶ 121:
['ignoreisbnerror'] = true,
['ignore-isbn-error'] = true,
['in'] = true,
['inset'] = true,
['institution'] = true,
Line 190 ⟶ 130:
['interviewermask'] = true,
['interviewer-mask'] = true,
['interviewers'] = true,
['isbn'] = true,
['ISBN'] = true,
Line 206 ⟶ 145:
['JSTOR'] = true,
['jstor-access'] = true,
['lang'] = true,
['language'] = true,
['last'] = true,
Line 214 ⟶ 154:
['laysource'] = true,
['lay-source'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['lay-format'] = true,
['layurl'] = true,
Line 223 ⟶ 161:
['location'] = 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,
['message-id'] = true, -- cite newsgroup
['minutes'] = true,
['mode'] = true,
Line 236 ⟶ 169:
['MR'] = true,
['name-list-format'] = true,
['network'] = true,
['newsgroup'] = true,
['newspaper'] = true,
['nocat'] = true,
Line 277 ⟶ 208:
['quote'] = true,
['ref'] = true,
['registration'] = 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-section'] = true,
['script-title'] = true,
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['section'] = true,
['section-format'] = true,
['sections'] = true, -- cite map only
['sectionurl'] = true,
['section-url'] = true,
['section-url-access'] = true,
['series'] = true,
['serieslink'] = true,
Line 297 ⟶ 239:
['series-number'] = true,
['series-separator'] = true,
['sheet'] = true, -- cite map only
['sheets'] = true, -- cite map only
['ssrn'] = true,
['SSRN'] = true,
['station'] = true,
['subject'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subscription'] = true,
['surname'] = true,
['template doc demos2cid'] = falsetrue,
['S2CID'] = true,
['s2cid-access'] = true,
['template-doc-demo'] = true,
['time'] = true,
Line 315 ⟶ 255:
['titlelink'] = true,
['title-link'] = true,
['trans_chapter'] = false,
['trans-chapter'] = true,
['trans-map'] = true,
['transcript'] = true,
['transcript-format'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['trans_title'] = false,
['trans-title'] = true,
['translator'] = true,
['translator-first'] = true,
Line 331 ⟶ 266:
['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-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,
Line 393 ⟶ 341:
['first#'] = true,
['given#'] = true,
['host#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
Line 424 ⟶ 373:
}
 
--[[--------------------------< 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, and cite ssrn are preprint templates that use the limited set of parameters
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
defined in the limited_basic_arguments and limited_numbered_arguments tables. Those lists are supplemented with a
true - these parameters are valid and supported parameters
template-specific list of parameters that are required by the particular template and may be exclusive to one of the
false - these parameters are deprecated but still supported
preprint templates. Some of these parameters may also be available to the general cs1|2 templates.
nil - these parameters are no longer supported (when setting a parameter to nil, leave a comment stating the reasons for invalidating the parameter)
]]
 
Same conventions for true/false/nil as above.
--[[
This is a list of parameters that once were but now are no longer supported:
['ARXIV'] = nil, -- not an initialization
['version'] = nil, -- this is the cite arxiv parameter; |version= still supported by other cs1|2 templates
 
]]
 
local arxiv_basic_argumentspreprint_arguments = {
['arxiv'] = true,{
['classarxiv'] = true, -- cite arxiv and arxiv identifiers
['eprintclass'] = true, -- cite arxiv and arxiv identifiersonly
['eprint'] = true, -- cite arxiv and arxiv identifiers
}
},
 
biorxiv = {
 
['biorxiv'] = true,
--[[--------------------------< 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 >------------
},
 
citeseerx = {
This is an experiment that attempts to use validate() and a limited list of valid parameters to validate the
['citeseerx'] = true,
parameters provided in a cite biorxiv template. This method might be expanded to other templates being considered.
},
 
ssrn = {
Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
['ssrn'] = true,
true - these parameters are valid and supported parameters
['SSRN'] = true,
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 biorxiv_basic_arguments = {
['biorxiv'] = true,
}
 
 
--[[--------------------------< 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 >--------
 
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.
 
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 citeseerx_basic_arguments = {
['citeseerx'] = true,
}
 
 
Line 490 ⟶ 410:
all three templates
 
Same conventions for true/false/nil as above.
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)
]]
Line 510 ⟶ 427:
['date'] = true,
['df'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['first'] = true,
Line 532 ⟶ 450:
['ref'] = true,
['surname'] = true,
['template doc demo'] = true,
['template-doc-demo'] = true,
['title'] = true,
['trans-title'] = true,
['url'] = true,
['URL'] = true,
Line 540 ⟶ 458:
['year'] = true,
}
 
local limited_numbered_arguments = {
['author#'] = true,
Line 558 ⟶ 477:
['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/nil as above.
 
]]
 
local unique_arguments = {
episode = {
['airdate'] = true,
['air-date'] = true,
['credits'] = true,
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true,
['network'] = true,
['station'] = true,
},
map = {
['map'] = true,
['map-format'] = true,
['mapurl'] = 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,
},
serial = {
['airdate'] = true,
['air-date'] = true,
['credits'] = true,
['episode'] = true, -- cite serial only TODO: make available to cite episode?
['episodelink'] = true, -- aliases of |title-link=
['episode-link'] = true,
['network'] = true,
['station'] = 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 {
Line 565 ⟶ 551:
limited_basic_arguments = limited_basic_arguments,
limited_numbered_arguments = limited_numbered_arguments,
 
arxiv_basic_arguments = arxiv_basic_arguments,
preprint_arguments = preprint_arguments,
biorxiv_basic_arguments = biorxiv_basic_arguments,
preprint_template_list = template_list_get (preprint_arguments), -- make a template list from preprint_arguments{} table
citeseerx_basic_arguments = citeseerx_basic_arguments
unique_arguments = unique_arguments,
};
unique_param_template_list = template_list_get (unique_arguments), -- make a template list from unique_arguments{} table
};
Retrieved from "https://publictestwiki.com/wiki/Module:Citation/CS1/Whitelist"