Jump to content

Module:Citation/CS1/Whitelist: Difference between revisions

sync from sandbox;
m (41 revisions imported from templatewiki:Module:Citation/CS1/Whitelist)
(sync from sandbox;)
Line 1: 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
['doi_brokendate'] = nil,    -- alias of doi-broken-date
['doi_inactivedate'] = nil, -- alias of doi-inactive-date
['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
['in'] = nil, -- ambiguous between use for language, appearance of a lesser work in an edited work
['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=
['template doc demo'] = nil, -- alias of template doc demo
['titleyear'] = nil, -- unique alias of origyear used by old cite DVD-notes
['trans_chapter'] = nil, -- alias of trans-chapter
['trans_title'] = nil, -- alias of trans-title
['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 68: Line 5:
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
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
]]
]]
Line 93: Line 30:
['ASIN'] = true,
['ASIN'] = true,
['asin-tld'] = true,
['asin-tld'] = true,
['ASIN-TLD'] = false, -- not an identifier but an identifier-modifier
['at'] = true,
['at'] = true,
['author'] = true,
['author'] = true,
Line 115: Line 51:
['chapter-url-access'] = true,
['chapter-url-access'] = true,
['citeseerx'] = true,
['citeseerx'] = true,
['class'] = false, -- cite arxiv only; general use deprecated
['collaboration'] = true,
['collaboration'] = true,
['conference'] = true,
['conference'] = true,
Line 125: Line 60:
['contributionurl'] = true,
['contributionurl'] = true,
['contribution-url'] = true,
['contribution-url'] = true,
['contribution-url-access'] = true,
['contributor'] = true,
['contributor'] = true,
['contributor-first'] = true,
['contributor-first'] = true,
Line 134: Line 70:
['credits'] = true, -- cite episode, cite serial
['credits'] = true, -- cite episode, cite serial
['date'] = true,
['date'] = true,
['deadurl'] = true,
['dead-url'] = true,
['degree'] = true,
['degree'] = true,
['department'] = true,
['department'] = true,
Line 142: Line 76:
['displayauthors'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['display-authors'] = true,
['display-contributors'] = true,
['displayeditors'] = true,
['displayeditors'] = true,
['display-editors'] = true,
['display-editors'] = true,
['display-interviewers'] = true,
['display-translators'] = true,
['docket'] = true,
['docket'] = true,
['doi'] = true,
['doi'] = true,
Line 199: Line 136:
['interviewermask'] = true,
['interviewermask'] = true,
['interviewer-mask'] = true,
['interviewer-mask'] = true,
['interviewers'] = true,
['isbn'] = true,
['isbn'] = true,
['ISBN'] = true,
['ISBN'] = true,
Line 224: Line 160:
['laysource'] = true,
['laysource'] = true,
['lay-source'] = true,
['lay-source'] = true,
['laysummary'] = true,
['lay-summary'] = true,
['lay-format'] = true,
['lay-format'] = true,
['layurl'] = true,
['layurl'] = true,
Line 239: Line 173:
['mapurl'] = true, -- cite map only
['mapurl'] = true, -- cite map only
['map-url'] = true, -- cite map only
['map-url'] = true, -- cite map only
['map-url-access'] = true, -- cite map only
['medium'] = true,
['medium'] = true,
['message-id'] = true, -- cite newsgroup
['message-id'] = true, -- cite newsgroup
Line 287: Line 222:
['quote'] = true,
['quote'] = true,
['ref'] = true,
['ref'] = true,
['registration'] = true,
['rfc'] = true,
['rfc'] = true,
['RFC'] = true,
['RFC'] = true,
['scale'] = true,
['scale'] = true,
['script-article'] = true,
['script-chapter'] = true,
['script-chapter'] = true,
['script-contribution'] = true,
['script-entry'] = true,
['script-journal'] = true,
['script-magazine'] = true,
['script-map'] = true,
['script-newspaper'] = true,
['script-periodical'] = true,
['script-section'] = true,
['script-title'] = true,
['script-title'] = true,
['script-website'] = true,
['script-work'] = true,
['season'] = true,
['season'] = true,
['section'] = true,
['section'] = true,
Line 316: Line 261:
['subjectlink'] = true,
['subjectlink'] = true,
['subject-link'] = true,
['subject-link'] = true,
['subscription'] = true,
['surname'] = true,
['surname'] = true,
['template-doc-demo'] = true,
['template-doc-demo'] = true,
Line 325: Line 269:
['titlelink'] = true,
['titlelink'] = true,
['title-link'] = true,
['title-link'] = true,
['trans-chapter'] = true,
['trans-map'] = true,
['trans-map'] = true,
['transcript'] = true,
['transcript'] = true,
Line 331: Line 274:
['transcripturl'] = true,
['transcripturl'] = true,
['transcript-url'] = true,
['transcript-url'] = true,
['trans-title'] = true,
['translator'] = true,
['translator'] = true,
['translator-first'] = true,
['translator-first'] = true,
Line 339: Line 281:
['translator-link'] = true,
['translator-link'] = true,
['translator-mask'] = 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,
['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 401: Line 356:
['first#'] = true,
['first#'] = true,
['given#'] = true,
['given#'] = true,
['host#'] = true,
['interviewer#'] = true,
['interviewer#'] = true,
['interviewer-first#'] = true,
['interviewer-first#'] = true,
Line 432: Line 388:
}
}


--[[--------------------------< 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 >----------------


Cite arXiv uses the limited set of parameters defined in the limited_basic_arguments and limited_numbered_arguments
--[[--------------------------< 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 >--------------------
tables.  Those lists are supplemented with this list of parameters that are exclusive to cite arXiv but not supported
 
by other cs1 templates that use the limited parameter set.
Cite arXiv, cite biorxiv, cite citeseerx, and cite ssrn are preprint templates that use the limited set of parameters
defined in the limited_basic_arguments and limited_numbered_arguments tables.  Those lists are supplemented with a
template-specific list of parameters that are required by the particular template and may be exclusive to one of the
proeprint templates.  Some of these parameters may also be available to the general cs1|2 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)
]]
]]


--[[
--[[--------------------------< C I T E  A R X I V >----------------------------------------------------------
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


]]
]]
Line 459: Line 411:




--[[--------------------------< 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 >------------
--[[--------------------------< C I T E  B I O R X I V >------------------------------------------------------
 
Cite biorxiv uses the limited set of parameters defined in the limited_basic_arguments and limited_numbered_arguments
tables.  Those lists are supplemented with this list of parameters that are exclusive to cite biorxiv but not supported
by other cs1 templates that use the limited parameter set.


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 477: Line 420:




--[[--------------------------< 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 >--------
--[[--------------------------< C I T E  C I T E S E E R X >--------------------------------------------------
 
Cite citeseerx uses the limited set of parameters defined in the limited_basic_arguments and limited_numbered_arguments
tables.  Those lists are supplemented with this list of parameters that are exclusive to cite citeseerx but not supported
by other cs1 templates that use the limited parameter set.


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 = {
local citeseerx_basic_arguments = {
['citeseerx'] = true,
['citeseerx'] = true,
}
--[[--------------------------< C I T E  S S R N >------------------------------------------------------------
]]
local ssrn_basic_arguments = {
['ssrn'] = true,
['SSRN'] = true,
}
}


Line 501: Line 445:
all three templates
all three templates


Because a steady-state signal conveys no useful information, whitelist.basic_arguments[] list items can have three values:
Same conventions for true/false/nil as above.
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 521: Line 462:
['date'] = true,
['date'] = true,
['df'] = true,
['df'] = true,
['displayauthors'] = true,
['display-authors'] = true,
['display-authors'] = true,
['first'] = true,
['first'] = true,
Line 550: Line 492:
['year'] = true,
['year'] = true,
}
}
local limited_numbered_arguments = {
local limited_numbered_arguments = {
['author#'] = true,
['author#'] = true,
Line 569: Line 512:
['surname#'] = true,
['surname#'] = true,
}
}
--[[--------------------------< E X P O R T E D  T A B L E S >------------------------------------------------
]]


return {
return {
Line 577: Line 524:
arxiv_basic_arguments = arxiv_basic_arguments,
arxiv_basic_arguments = arxiv_basic_arguments,
biorxiv_basic_arguments = biorxiv_basic_arguments,
biorxiv_basic_arguments = biorxiv_basic_arguments,
citeseerx_basic_arguments = citeseerx_basic_arguments
citeseerx_basic_arguments = citeseerx_basic_arguments,
};
ssrn_basic_arguments = ssrn_basic_arguments
};
Cookies help us deliver our services. By using our services, you agree to our use of cookies.