SockyPaws: Create module documentation subpage

2025-12-22T15:39:11Z

Create module documentation subpage

New page

{{High-risk|article-space=yes|no-percent=yes}}
{{Notice|This module should ''only'' be used on articles that are near the [[wikipedia:Help:Template limits#Post-expand include size|post-expand include size]] limit, in order to prevent them from exceeding it. Unless there is a pressing technical need, use the appropriate CS1 and {{Template link general|Citation}} templates.}}
{{Lua|Module:Arguments|Module:Citation/CS1|Module:Cite/config}}
{{Citation Style documentation|cs1}}

== Usage ==
This module may be used to replace any of the CS1/CS2 templates in articles that are nearing the [[wikipedia:Help:Template limits#Post-expand include size|post-expand include size]] limit. Such use should only be done to prevent an article from exceeding the limit. If necessary, this module may be used in templates that wrap a CS1/CS2 template.

=== Examples ===
This module requires no parameters, but does require the canonical name of a CS1 template, without the <code>Cite</code> prefix, a la <code>Cite book</code> → <code>Book</code> and <code>Cite web</code> → <code>Web</code>. To replace {{Template link general|Citation}} templates, use <code>Citation</code>.

The structure for calls to this module is…
: <code>{{{{Color|#00f|#invoke}}:Cite|<{{Var|template name}}>|<{{Var|CS1 parameters…}}>}}</code>
…where:
: <code>{{Color|#00f|#invoke}}:Cite</code> – calls this module, [[Module:Cite|Cite]].
: <code>|<{{Var|template name}}></code> – is the canonical name of the template, without the <code>Cite</code> prefix; this is the <code>#invoke:</code> function call; it is case-insensitive.
: <code>|<{{Var|CS1 parameters…}}></code> – are all of the parameters required by {{Template link general|nolink=on|Cite <template name>}}

To go from {{Template link general|Cite book}}:
: <code>{{'''{{Color|#008000|Cite book}}'''|{{Color|#767600|last}}{{Color|#666|=}}Green|{{Color|#767600|first}}{{Color|#666|=}}E.B.|{{Color|#767600|year}}{{Color|#666|=}}1915|{{Color|#767600|title}}{{Color|#666|=}}Title|{{Color|#767600|publisher}}{{Color|#666|=}}PseudoRandom}}</code>
:: {{Cite book|last=Green|first=E.B.|year=1915|title=Title|publisher=PseudoRandom}}
…use wiki markup that follows this rubric:
: <code>{{{{Color|#00f|#invoke}}:'''{{Color|#008000|Cite}}'''|book|{{Color|#767600|last}}{{Color|#666|=}}Green|{{Color|#767600|first}}{{Color|#666|=}}E.B.|{{Color|#767600|year}}{{Color|#666|=}}1915|{{Color|#767600|title}}{{Color|#666|=}}Title|{{Color|#767600|publisher}}{{Color|#666|=}}PseudoRandom}}</code>
:: {{#invoke:Cite|book|last=Green|first=E.B.|year=1915|title=Title|publisher=PseudoRandom}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[Category:Templates based on the Citation/CS1 Lua module]]
}}</includeonly>

Module:Cite/doc - Revision history

SockyPaws: Create module documentation subpage