Template:Substcheck/doc

This is a documentation subpage for Template:Substcheck.
It may contain usage information, categories and other content that is not part of the original template page.

This template may have no transclusions, because it is used when templates are substituted, often inside <includeonly>...</includeonly> tags..

This template can be used in conditional processing in other templates to detect substitutions.

If you use Module:Unsubst, you need not use this template.

Usage

If you put <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly> into a template, it will expand into one of the following, depending how the template is being viewed.

SUBST if the template is being substituted
{{subst:substcheck}} if the template is being transcluded
Empty string if you are viewing the template page.

Using this template differently may yield different results; the above is the most universal way.

Lua replacement

if mw.isSubsting() then
	-- substituting: "SUBST"
elseif mw.getCurrentFrame():getParent():getTitle() == mw.title.getCurrentTitle().fullText then
	-- viewed directly: ""
else
	-- transclusion: "{{subst:substcheck}}"
end

Usage

Lua replacement

See also