Module:Cite
From Wikipedia, the free encyclopedia
(Redirected from Module:Citation)
Warning This Lua module is used on approximately 49,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.
This module should only be used on articles that are near the post-expand include size limit, in order to prevent them exceeding it. Unless there is a pressing technical need, use appropriate cs1 and
{{citation}} templates This module depends on the following other modules:
| {{Cite arXiv }} | arXiv preprints |
|---|---|
| {{Cite AV media }} | audio and visual media |
| {{Cite AV media notes }} | AV media liner notes |
| {{Cite bioRxiv }} | bioRxiv preprints |
| {{Cite book }} | books and chapters |
| {{Cite CiteSeerX }} | CiteSeerX papers |
| {{Cite conference }} | conference papers |
| {{Cite document }} | short, stand-alone, offline documents |
| {{Cite encyclopedia }} | edited collections |
| {{Cite episode }} | radio or TV episodes |
| {{Cite interview }} | interviews |
| {{Cite journal }} | academic journals |
| {{Cite magazine }} | magazines, periodicals |
| {{Cite mailing list }} | public mailing lists |
| {{Cite map }} | maps |
| {{Cite medRxiv }} | medRxiv preprints |
| {{Cite news }} | news articles |
| {{Cite newsgroup }} | online newsgroups |
| {{Cite podcast }} | podcasts |
| {{Cite press release }} | press releases |
| {{Cite report }} | reports |
| {{Cite serial }} | audio or video serials |
| {{Cite sign }} | signs, plaques |
| {{Cite speech }} | speeches |
| {{Cite SSRN }} | SSRN papers |
| {{Cite tech report }} | technical reports |
| {{Cite thesis }} | theses |
| {{Cite web }} | web sources not covered by the above |
| See also | Specific-source templates Citation Style 1 wrapper templates |
Usage
This module may be used to replace any of the cs1|2 templates in articles that are nearing the post-expand include size limit. Such use should only be done to prevent an article from exceeding the PEIS limit. If necessary, this module may be used in templates that wrap a cs1|2 template.
Examples
This module requires no parameters but does require the canonical name of a cs1 template without the cite prefix: cite book → book, cite web → web. To replace {{citation}} templates, use citation.
The structure for calls to this module:
{{#invoke:cite |<template name>|<cs1 parameters>}}
where:
#invoke:cite– calls this module: Module:cite|<template name>– is the canonical name of the template without theciteprefix; this is the#invoke:function call; case insensitive|<cs1 parameters>– are all of the parameters required by{{cite <template name>}}
To go from {{cite book}}:
{{cite book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}- EB Green (1915). Title. PseudoRandom.
write:
{{#invoke:cite |book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}- EB Green (1915). Title. PseudoRandom.
The above documentation is transcluded from Module:Cite/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.
require('strict'); localcfg=mw.loadData('Module:Cite/config'); --[[--------------------------< S U B S T I T U T E >---------------------------------------------------------- Substitutes 1,ドル 2,ドル etc in <message> with data from <data_t>. Returns plain-text substituted string when <data_t> not nil; returns <message> else. ]] localfunctionsubstitute(message,data_t) returndata_tandmw.message.newRawMessage(message,data_t):plain()ormessage; end --[[--------------------------< M A K E _ E R R O R _ M S G >-------------------------------------------------- Assembles an error message from module name, message text, help link, and error category. ]] localfunctionmake_error_msg(frame,msg) localmodule_name=frame:getTitle();-- get the module name for prefix and help-link label localnamespace=mw.title.getCurrentTitle().namespace;-- used for categorization localcategory_link=(0==namespace)andsubstitute('[[Category:1ドル]]',{cfg.settings_t.err_category})or''; returnsubstitute('<span style="color:#d33">Error: {{[[1ドル|#invoke:2ドル]]}}: 3ドル ([[:4ドル|5ドル]])</span>6ドル', { module_name,-- the module name with namespace module_name:gsub('Module:',''),-- the module name without namespace msg,-- the error message cfg.settings_t.help_text_link,-- help wikilink to text at help page cfg.settings_t.help,-- help wikilink display text category_link-- link to error category (for main namespace errors only) }) end --[[--------------------------< C I T E >--------------------------------------------------------------------- Function to call Module:Citation/CS1/sandbox with appropriate parameters. For use when an article exceeds the post-expand include size limit. {{#invoke:cite|book|title=Title}} ]] localfunctioncite(frame,template) localargs_t=require('Module:Arguments').getArgs(frame,{frameOnly=true}); template=template:lower();-- lowercase for table indexes ifnotcfg.known_templates_t[template]then-- do we recognize this template name? returnmake_error_msg(frame,substitute(cfg.settings_t.unknown_name,{template}));-- nope; abandon with error message end localconfig_t={['CitationClass']=cfg.citation_classes_t[template]ortemplate};-- set CitationClass value returnrequire('Module:Citation/CS1')._citation(nil,args_t,config_t);-- go render the citation end --[[--------------------------< E X P O R T S >--------------------------------------------------------------- ]] returnsetmetatable({},{__index=-- returns an empty TABLE whose metatable has the __index set so that, for any given KEY, it returns function(_,template)-- this anonymous function called as function(TABLE, KEY) returnfunction(frame)returncite(frame,template)end;-- which in turn returns a function that calls cite() with the KEY name end })