https://pool.calebcooper.ie/index.php?action=history&feed=atom&title=Template%3AEscape%2FdocTemplate:Escape/doc - Revision history2026-04-08T13:57:31ZRevision history for this page on the wikiMediaWiki 1.43.8https://pool.calebcooper.ie/index.php?title=Template:Escape/doc&diff=11805&oldid=prevCaleb Cooper: Created page with "{{Context}} {{Documentation subpage}} {{Lua|Module:Escape}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia..."2020-10-16T12:25:05Z<p>Created page with "{{Context}} {{Documentation subpage}} {{Lua|Module:Escape}} <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see Wikipedia..."</p>
<p><b>New page</b></p><div>{{Context}}<br />
{{Documentation subpage}}<br />
{{Lua|Module:Escape}}<br />
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) --><br />
== Usage ==<br />
While primarily intended for use by other Lua modules, it can provide an alternative to multiple {{tag|nowiki}} tags when part of the desired output should be executed.<br />
<br />
For example, {{t|demo}} normally requires the demonstrated template to be wrapped in {{tag|nowiki}}. However, you may want part of the value to be shown in the 'pre' tag to be processed before it reaches {{t|demo}}, such as in the example below where the result of <code>{{escape|mode=kill|char=!|{*{#invoke:Escape/testcases!test_string2}*}|*|{{!}}}}</code> is shown inside the {{tag|pre}} tags.<br />
<br />
{| style='width:30%' class=wikitable<br />
|-<br />
!Code<br />
!Result<br />
|-<br />
|<syntaxhighlight lang="html"><br />
{{demo<br />
|<!--not escaped: -->{{escape | mode = kill <br />
| char=; <br />
| {*{#invoke:Escape ; main ; mode {{=}} kill ;<br />
<!--unescaped:-->{{#invoke:Escape/testcases|test_string2}}<br>; { }*} <br />
| * <br />
| {{!}} }}<br />
}}<br />
</syntaxhighlight><br />
|<br />
{{demo<br />
|<!--not escaped: -->{{escape | mode = kill <br />
| char=; <br />
| {*{#invoke:Escape ; main ; mode {{=}} kill ;<br />
<!--unescaped:-->{{#invoke:Escape/testcases|test_string2}}<br>; { }*} <br />
| * <br />
| {{!}} }}<br />
}}<br />
|}<br />
<br />
Note how the {{code|*}} character, used to break up the {{code|{{((}}}} to prevent execution, is removed and how the {{code|;}} character is replaced by {{code|{{!}}}}.<br />
<br />
===Non-execution===<br />
After removal of the escape chars, the returned text is inert; i.e. not executed even without {{tag|pre}}. (The above example is executed only because {{t|demo}} forces execution.)<br />
<br />
For example, setting {{para|mode|kill}} with {{code|\{\{done\}\}}} as the first parameter and nothing else will simply cause the default escape character {{code|\}} to be removed:<br />
<br />
{{escape|mode=kill|\{\{done\}\} }}<br />
<br />
==Examples==<br />
{{escape<br />
|mode=kill<br />
|char=#invoke:E<br />
|{{Module talk:Escape/testcases}}<br />
|main{{!}}<br />
|e<br />
}}<br />
<br />
<includeonly>{{Sandbox other||<br />
<!-- Categories below this line, please; interwikis at Wikidata --><br />
[[Category:Wikipedia_utility_templates]]<br />
}}</includeonly></div>Caleb Cooper