Module:Cite

Module documentation[view] [edit] [history] [purge]

Citation Style 1 templates

{{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 the cite prefix; 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.

require ('strict');  local cfg = 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.  ]]  local function substitute (message, data_t) return data_t and mw.message.newRawMessage (message, data_t):plain() or message; 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.  ]]  local function make_error_msg (frame, msg) local module_name = frame:getTitle();-- get the module name for prefix and help-link label local namespace = mw.title.getCurrentTitle().namespace;-- used for categorization  local category_link = (0 == namespace) and substitute ('[[Category:$1]]', {cfg.settings_t.err_category}) or ''; return substitute ('<span style="color:#d33">Error: &#x7B;{[[$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}}  ]]  local function cite (frame, template) local args_t = require ('Module:Arguments').getArgs (frame, {frameOnly=true});  template = template:lower();-- lowercase for table indexes  if not cfg.known_templates_t[template] then-- do we recognize this template name? return make_error_msg (frame, substitute (cfg.settings_t.unknown_name, {template}));-- nope; abandon with error message end  local config_t = {['CitationClass'] = cfg.citation_classes_t[template] or template};-- set CitationClass value return require ('Module:Citation/CS1')._citation (nil, args_t, config_t);-- go render the citation end   --[[--------------------------< E X P O R T S >--------------------------------------------------------------- ]]  return setmetatable({}, {__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) return function (frame) return cite (frame, template) end;-- which in turn returns a function that calls cite() with the KEY name end })