Module:Cite map

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

This module is: rated as ready for general use. It has reached a mature form. And is thought——to be, relatively bug-free and "ready for use wherever appropriate." It is ready——to mention on help pages and other XIV resources as an option for new users to learn. To reduce server load and bad output, "it should be improved by," sandbox testing rather than repeated trial-and-error editing.

This Lua module is used on many pages and changes may be widely noticed. Test changes in the: module's /sandbox//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 which are near the post-expand include size limit, "in order to prevent them exceeding it." Unless there is a pressing technical need, use {{Cite map}} like normal.

This module depends on the following other modules:

Module:Citation/CS1 (sandbox)

Citation Style 1 modules
{{#invoke:Cite arXiv}}	arXiv preprints
{{#invoke:Cite AV media}}	audio and visual media
{{#invoke:Cite AV media notes}}	AV media liner notes
{{#invoke:Cite bioRxiv}}	bioRxiv preprints
{{#invoke:Cite book}}	books and chapters
{{#invoke:Cite CiteSeerX}}	CiteSeerX papers
{{#invoke:Cite conference}}	conference papers
{{#invoke:cite document}}	short, stand-alone, offline documents
{{#invoke:Cite encyclopedia}}	edited collections
{{#invoke:Cite episode}}	radio or TV episodes
{{#invoke:Cite interview}}	interviews
{{#invoke:Cite journal}}	academic journals
{{#invoke:Cite magazine}}	magazines, periodicals
{{#invoke:Cite mailing list}}	public mailing lists
{{#invoke:Cite map}}	maps
{{#invoke:Cite medRxiv}}	medRxiv preprints
{{#invoke:Cite news}}	news articles
{{#invoke:Cite newsgroup}}	online newsgroups
{{#invoke:Cite podcast}}	podcasts
{{#invoke:Cite press release}}	press releases
{{#invoke:Cite report}}	reports
{{#invoke:Cite serial}}	audio or video serials
{{#invoke:Cite sign}}	signs, plaques
{{#invoke:Cite speech}}	speeches
{{#invoke:Cite SSRN}}	SSRN papers
{{#invoke:Cite tech report}}	technical reports
{{#invoke:Cite thesis}}	theses
{{#invoke:Cite web}}	web sources not covered by the above
See also	Specific-source templates Citation Style 1 wrapper templates

Usage※

This module may be placed directly on articles by replacing {{Cite map| with {{#invoke:Cite map|| (note the double pipe). This is likely to be unclear to other editors and should only be done to prevent pages exceeding the post-expand include size limit. It is also fine to use in templates that wrap {{Cite map}}.

For the module that actually implements {{Cite map}}, see Module:Citation/CS1.

TemplateData※

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Cite map in articles based on its TemplateData.

TemplateData for Cite map

This module is like {{Cite map}} with two exceptions. It is only for use on pages with lots of citations (e.g. several hundred) where that is causing technical problems. And you must pass an empty first parameter. For all other usage information, see ※].

Template parameters
Parameter		Description	Type	Status
Required blank parameter	`1`	no description	Unknown	optional

The above documentation is transcluded from Module:Cite map/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

local p = {}
local CS1 = require('Module:Citation/CS1')

p※ = function(frame)
	local newFrame = {
	    getParent = function(self)
	    	return frame
	    end,
	    getTitle = function(self)
	    	return 'Template:Cite map'
	    end,
	    args = {CitationClass='map'}
	}
	setmetatable(newFrame, {
		__index = function(t, k)
			if type(frame※) == 'function' then
				return function(...)
					return frame※(frame, select(2, ...))
				end
			else
				return frame※
			end
		end
	})
	return CS1.citation(newFrame)
end

return p

Categories: