View source for Module:Cite/doc

{{Notice|This module should ''only'' be used on articles that are near the [[WP:PEIS|post-expand include size]] limit, in order to prevent them exceeding it. Unless there is a pressing technical need, use appropriate cs1 and {{tlx|citation}} templates}}
{{Lua|Module:Citation/CS1}}
{{csdoc|cs1}}

== Usage ==
This module may be used to replace any of the cs1|2 templates in articles that are nearing the [[WP:PEIS|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 only one parameter: the first positional parameter.  That parameter takes as a value, the canonical name of a cs1 template without the <code>cite</code> prefix: <code>cite book</code> → <code>book</code>, <code>cite web</code> → <code>web</code>.  To replace {{tlx|citation}} templates, use <code>citation</code>.

The structure for calls to this module:
:<code>{{<nowiki/>{{color|#00F|#invoke}}:cite |cite |&lt;{{var|template name}}>|&lt;{{var|cs1 parameters}}>}}</code>
where:
:<code>{{color|#00F|#invoke}}:cite</code> – calls this module: Module:cite
:<code>|cite</code> – is the function in Module:cite that is to be executed: <code>cite()</code>
:<code>|&lt;{{var|template name}}></code> – is the canonical name of the template without the <code>cite</code> prefix
:<code>|&lt;{{var|cs1 parameters}}></code> – are all of the parameters required by {{tld|cite &lt;template name>}}

To go from {{tlx|cite book}}:
:<syntaxhighlight lang="wikitext" inline="1">{{cite book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}</syntaxhighlight>
::{{cite book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}
write:
:<syntaxhighlight lang="wikitext" inline="1">{{#invoke:cite |cite |book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}</syntaxhighlight>
::{{#invoke:cite |cite |book |author=EB Green |date=1915 |title=Title |publisher=PseudoRandom}}


==TemplateData==
{{TemplateData header}}
<templatedata>
	{
	"description": "This module for use on articles that are approaching the post-expand include size limit. For all other usage information, see [[Module:Cite]].",
	"params": { 
		"1": {
			"label": "1",
			"description": "canonical name (without the 'cite' prefix) of the template to be replaced; to replace 'cite book', use 'book'.",
			"type": "string",
			"required": true
			}
		}
	}
</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Templates based on the Citation/CS1 Lua module]]
}}</includeonly>