View source for Template:Escape/doc

{{Context}}
{{Documentation subpage}}
{{Lua|Module:Escape}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==
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.

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.

{| style='width:30%' class=wikitable
|-
!Code
!Result
|-
|<syntaxhighlight lang="html">
{{demo
|<!--not escaped: -->{{escape | mode = kill 
  | char=; 
  | {*{#invoke:Escape ; main ; mode {{=}} kill ;
<!--unescaped:-->{{#invoke:Escape/testcases|test_string2}}<br>; { }*} 
  | * 
  | {{!}} }}
}}
</syntaxhighlight>
|
{{demo
|<!--not escaped: -->{{escape | mode = kill 
  | char=; 
  | {*{#invoke:Escape ; main ; mode {{=}} kill ;
<!--unescaped:-->{{#invoke:Escape/testcases|test_string2}}<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|{{!}}}}.

===Non-execution===
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.)

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:

{{escape|mode=kill|\{\{done\}\} }}

==Examples==
{{escape
|mode=kill
|char=#invoke:E
|{{Module talk:Escape/testcases}}
|main{{!}}
|e
}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia_utility_templates]]
}}</includeonly>