Module:Escape/doc - Revision history

Grufo: +Cat

2025-04-22T08:11:03Z

+Cat

← Previous revision		Revision as of 08:11, 22 April 2025
Line 223:		Line 223:
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
	[[Category:Modules that manipulate strings\|Escape]]		[[Category:Modules that manipulate strings\|Escape]]
			[[Category:Template metamodules\|Escape]]
	}}</includeonly><noinclude>		}}</includeonly><noinclude>
	[[Category:Module documentation pages]]		[[Category:Module documentation pages]]

Cedar101: /* Usage */ {{mlx}} {{code}}

2024-08-30T04:54:52Z

Usage: {{mlx}} {{code}}

← Previous revision		Revision as of 04:54, 30 August 2024
Line 6:		Line 6:

	From another module:		From another module:
	local esc = require('Module:Escape')		{{codett\|2=lua\|1=local esc = require('Module:Escape')}}
	esc:char({{green\|''escape char (or sequence)''}})		esc:char({{green\|''escape char (or sequence)''}})
	local to_escape = esc:text({{green\|''string''}})		{{codett\|2=lua\|1=local to_escape = esc:text}}({{green\|''string''}})
	{{green\|''code that replaces or removes unescaped chars''}}		{{green\|''code that replaces or removes unescaped chars''}}
	local result = esc:undo(to_escape)		{{codett\|2=lua\|1=local result = esc:undo(to_escape)}}

	From a template:		From a template:
	~~<nowiki>~~{{~~invoke:~~Escape\|main\|mode=~~</nowiki>~~{{green\|''function''}}\|char={{green\|''escape char (or sequence)''}}\|{{green\|''text''}}}}		{{mlx\|Escape\|main\|mode{{=}}{{green\|''function''}}\|char{{=}}{{green\|''escape char (or sequence)''}}\|{{green\|''text''}}}}

	In a template, the most useful function is {{code\|kill}}.		In a template, the most useful function is {{code\|kill}}.


	This module is primarily intended to be used by other modules. However all functions can be called in template space using {{para\|mode\|the function you want to call}} followed by arguments.		This module is primarily intended to be used by other modules. However all functions can be called in template space using {{para\|mode\|the function you want to call}} followed by arguments.

	All module functions (i.e. any func. other than main()) should be called using a colon (:), e.g. {{code\|esc:char('%')}} or <code><nowiki>esc:kill{'{{example\|\\}}}', '}'} == '{{example\|}'</nowiki>~~</code>~~		All module functions (i.e. any func. other than {{code\|main()}}) should be called using a colon ({{char\|:}}), e.g. {{code\|esc:char('%')\|lua}} or {{code\|<nowiki>esc:kill{'{{example\|\\}}}', '}'} == '{{example\|}'</nowiki>\|lua}}


	{\|class='wikitable' style='background:#fff'		{\|class="wikitable" style="background:#fff"
	\|-		\|-
	!style='vertical-align:top;width:7em'\|{{TOC tab\|escape:text()}}		!style="vertical-align:top;width:7em;font-family:monospace;"\|{{TOC tab\|escape:text()}}
	\|This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by escape:char() will be replaced with placeholders that can be converted back into that char by escape:undo()		\|This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by {{code\|escape:char()}} will be replaced with placeholders that can be converted back into that char by escape:undo()
	\|-		\|-
	!style='vertical-align:top;width:5em'\|{{TOC tab\|escape:undo()}}		!style="vertical-align:top;width:5em;font-family:monospace;"\|{{TOC tab\|escape:undo()}}
	\|Takes two arguments:		\|Takes two arguments:
	# The string that may contain placeholders set by escape:text()		# The string that may contain placeholders set by {{code\|escape:text()}}
	# Optional, a char to be placed in front of any characters that have been de-escaped. (i.e. if you need to re-escape those string with a different char)		# Optional, a char to be placed in front of any characters that have been de-escaped. (i.e. if you need to re-escape those string with a different char)
	\|-		\|-
	!style='vertical-align:top;width:5em'\|{{TOC tab\|escape:kill()}}		!style="vertical-align:top;width:5em;font-family:monospace;"\|{{TOC tab\|escape:kill()}}
	\|This is basically equivalent to calling string.gsub() on the string returned by escape:text() and feeding that result into escape:undo() in a single step. Takes three arguments:		\|This is basically equivalent to calling {{code\|string.gsub()}} on the string returned by {{code\|escape:text()}} and feeding that result into {{code\|escape:undo()}} in a single step. Takes three arguments:
	# A string		# A string
	# A sequence of characters to be removed from that string. (May use a string.gsub pattern)		# A sequence of characters to be removed from that string. (May use a {{code\|string.gsub()}} pattern)
	# Optional, a char to be placed in front of any characters that have been de-escaped.		# Optional, a char to be placed in front of any characters that have been de-escaped.
	\|-		\|-
	!style='vertical-align:top'\|{{TOC tab\|escape:char()}}		!style="vertical-align:top;font-family:monospace;"\|{{TOC tab\|escape:char()}}
	\|This function's primary use is to initialize the patterns to scan a string for an escape/escaped sequence. It takes two arguments, the first being the escape character and the second being a table of arguments (optional). By default, this module will escape the {{code\|\}} char. To escape the {{code\|{}} char instead, you can do {{code\|require('Module:Escape'):char('{')}} (or {{code\|esc:char('{')}} (presuming you stored the table returned by this module in the local variable {{code\|esc}}).		\|This function's primary use is to initialize the patterns to scan a string for an escape/escaped sequence. It takes two arguments, the first being the escape character and the second being a table of arguments (optional). By default, this module will escape the {{code\|\}} char. To escape the {{code\|{}} char instead, you can do {{code\|require('Module:Escape'):char('{')\|lua}} (or {{code\|esc:char('{')\|lua}} (presuming you stored the table returned by this module in the local variable {{code\|esc}}).

	When called without the second argument, char() will return a table containing the functions. This allows, for example, <code>escape:char(''):kill('123', '%d')~~</code>~~ which would return '2'		When called without the second argument, char() will return a table containing the functions. This allows, for example, {{code\|escape:char(''):kill('123', '%d')\|lua}} which would return '{{samp\|2}}'.

	For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.		For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.

	====Shortcut====		====Shortcut====
	If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.		If provided a second argument that is a table containing a <code>{key = value}</code> pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})\|lua}} is equivalent to {{code\|escape:char('\\'):text('string')\|lua}}.

	Note that if multiple key-value pairs are provided, only one may execute. {{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.		Note that if multiple key-value pairs are provided, only one may execute. {{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.
Line 54:		Line 52:

	===Caveats===		===Caveats===
	* When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus, escape:undo() will unescape, for example, all characters escaped with 'e' and 'esc' if both were used. In practice however this shouldn't be a problem as multiple escape sequences are pretty rare unless you're transitioning between multiple code languages. (Multiple multi-char escape sequences beginning with the same character are simply bad practice anyhow.)		* When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus, {{code\|2=lua\|escape:undo()}} will unescape, for example, all characters escaped with {{code\|'e'}} and {{code\|'esc'}} if both were used. In practice however this shouldn't be a problem as multiple escape sequences are pretty rare unless you're transitioning between multiple code languages. (Multiple multi-char escape sequences beginning with the same character are simply bad practice anyhow.)
	* Since byte values are stored as numbers, it is not recommended for you to use a number as an escape sequence (though it may work just fine).		* Since byte values are stored as numbers, it is not recommended for you to use a number as an escape sequence (though it may work just fine).
	* Placeholder byte values separated with return ('\r') characters--chosen because they are seldom used at all, and virtually never used unpaired with '\n'; moreover, it is distinct from the markers generated by {{tag\|nowiki}} or {{code\|mw.text.nowiki()}} (which use the delete char). To set a different separator char, include the key-value pair <code>{safeChr = {{green\|alternate character}}}</code> in the table that you pass to escape:char().		* Placeholder byte values separated with return ({{code\|'\r'}}) characters--chosen because they are seldom used at all, and virtually never used unpaired with {{code\|'\n'}}; moreover, it is distinct from the markers generated by {{tag\|nowiki}} or {{code\|mw.text.nowiki()}} (which use the delete char). To set a different separator char, include the key-value pair <code>{safeChr = {{green\|alternate character}}}</code> in the table that you pass to escape:char().

	==Speed==		==Speed==

Cedar101: /* Speed */ wikitext

2024-08-30T04:36:42Z

Speed: wikitext

← Previous revision		Revision as of 04:36, 30 August 2024
Line 72:		Line 72:
	</syntaxhighlight>		</syntaxhighlight>
	'''{{#invoke:Escape/testcases\|test_kill500}}'''		'''{{#invoke:Escape/testcases\|test_kill500}}'''


	when repeating the following line 500 times in a template:		when repeating the following line 500 times in a template:

	{{code\|<nowiki>{{#invoke:Escape\|main\|mode=kill\|{{#invoke:Escape/testcases\|test_string2}}\|test}}</nowiki>}}		{{code\|<nowiki>{{#invoke:Escape\|main\|mode=kill\|{{#invoke:Escape/testcases\|test_string2}}\|test}}</nowiki>\|wikitext}}

	'''0.767'''<!--		'''0.767'''<!--

Cedar101: /* Module */ {{pre}}

2024-08-30T04:35:43Z

Module: {{pre}}

← Previous revision		Revision as of 04:35, 30 August 2024
Line 100:		Line 100:
	===Module===		===Module===
	Here's some sample output from the debug console below the module editor:		Here's some sample output from the debug console below the module editor:
			{{pre\|
	{\|- class='wikitable'
	\|
	{{blue\|'''local escape {{=}} require('Module:Escape')<br>test {{=}} '{{#invoke:Escape/testcases\|test_string_module}}'<br><br>test2 {{=}} escape:char('{'):text(test)<br>{{=}}test2'''}}<br>		{{blue\|'''local escape {{=}} require('Module:Escape')<br>test {{=}} '{{#invoke:Escape/testcases\|test_string_module}}'<br><br>test2 {{=}} escape:char('{'):text(test)<br>{{=}}test2'''}}<br>
	{{#invoke:Escape\|main		{{#invoke:Escape\|main
Line 223:		Line 222:
	'''{{blue\|local tk0 {{=}} escape:kill(t, '{')<br>{{=}}tk0 {{=}}{{=}} t4}}<br>'''		'''{{blue\|local tk0 {{=}} escape:kill(t, '{')<br>{{=}}tk0 {{=}}{{=}} t4}}<br>'''
	true		true
		⚫	}}

⚫	\|}
	<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|		<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox \| \|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

Warudo: Added the page to :Category:Module documentation pages

2024-08-29T21:15:43Z

Added the page to Category:Module documentation pages

← Previous revision		Revision as of 21:15, 29 August 2024
Line 228:		Line 228:
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
	[[Category:Modules that manipulate strings\|Escape]]		[[Category:Modules that manipulate strings\|Escape]]
	}}</includeonly>		}}</includeonly><noinclude>
			[[Category:Module documentation pages]]
			</noinclude>

Awesome Aasim at 00:19, 29 March 2024

2024-03-29T00:19:41Z

← Previous revision		Revision as of 00:19, 29 March 2024
Line 1:		Line 1:
	{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
			{{High use}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
	== Usage ==		== Usage ==

Codehydro: /* Shortcut (not fully implemented) */

2023-05-10T16:59:34Z

Shortcut (not fully implemented)

← Previous revision		Revision as of 16:59, 10 May 2023
Line 45:		Line 45:
	For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.		For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.

	====Shortcut ~~(not fully implemented)~~====		====Shortcut====
	If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.		If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.

Codehydro: /* Shortcut (not fully implemented) */

2023-05-10T16:59:15Z

Shortcut (not fully implemented)

← Previous revision		Revision as of 16:59, 10 May 2023
Line 48:		Line 48:
	If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.		If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.

	Note that if multiple key-value pairs are provided, only one may execute. ({{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.		Note that if multiple key-value pairs are provided, only one may execute. {{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.
	\|}		\|}
	<span id='functions doc'></span>		<span id='functions doc'></span>

Codehydro: /* Shortcut (not fully implemented) */ drop planned

2023-05-10T16:58:47Z

Shortcut (not fully implemented): drop planned

← Previous revision		Revision as of 16:58, 10 May 2023
Line 48:		Line 48:
	If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.		If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.

	~~Currently,~~ if multiple key-value pairs are provided, only one may execute. It ~~was~~ ~~planned~~ so ~~that~~ {{code\|~~escape:char('\\',~~ ~~{text~~ {{=}} ~~'string',~~ ~~undo~~ {{=}} '{{~~=}}'})~~}} ~~would~~ ~~be a shorthand for:~~		Note that if multiple key-value pairs are provided, only one may execute. ({{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.
	{{pre\|
	temp{{=}}escape:char('\\'):text('string')
	escape:undo(temp, '{{=}}')
	}}

	In the planned implementation, the ''text'' function would be called first, followed by ''undo'' or ''kill''. (If both ''undo'' and ''kill'' are included as keys in the table, ''kill'' would be ignored.)

	\|}		\|}
	<span id='functions doc'></span>		<span id='functions doc'></span>

Aidan9382: /* Module */ ce

2023-02-19T22:39:07Z

Module: ce

← Previous revision		Revision as of 22:39, 19 February 2023
Line 105:		Line 105:
	{{Module talk:Escape/testcases}}		{{Module talk:Escape/testcases}}
	===Module===		===Module===
	Here's some sample output from the debug ~~consol~~ below the module editor:		Here's some sample output from the debug console below the module editor:
	{\|- class='wikitable'		{\|- class='wikitable'
	\|		\|

← Previous revision		Revision as of 04:54, 30 August 2024
Line 6:		Line 6:

	From another module:		From another module:
	local esc = require('Module:Escape')		{{codett\|2=lua\|1=local esc = require('Module:Escape')}}
	esc:char({{green\|''escape char (or sequence)''}})		esc:char({{green\|''escape char (or sequence)''}})
	local to_escape = esc:text({{green\|''string''}})		{{codett\|2=lua\|1=local to_escape = esc:text}}({{green\|''string''}})
	{{green\|''code that replaces or removes unescaped chars''}}		{{green\|''code that replaces or removes unescaped chars''}}
	local result = esc:undo(to_escape)		{{codett\|2=lua\|1=local result = esc:undo(to_escape)}}

	From a template:		From a template:
	~~<nowiki>~~{{~~invoke:~~Escape\|main\|mode=~~</nowiki>~~{{green\|''function''}}\|char={{green\|''escape char (or sequence)''}}\|{{green\|''text''}}}}		{{mlx\|Escape\|main\|mode{{=}}{{green\|''function''}}\|char{{=}}{{green\|''escape char (or sequence)''}}\|{{green\|''text''}}}}

	In a template, the most useful function is {{code\|kill}}.		In a template, the most useful function is {{code\|kill}}.


	This module is primarily intended to be used by other modules. However all functions can be called in template space using {{para\|mode\|the function you want to call}} followed by arguments.		This module is primarily intended to be used by other modules. However all functions can be called in template space using {{para\|mode\|the function you want to call}} followed by arguments.

	All module functions (i.e. any func. other than main()) should be called using a colon (:), e.g. {{code\|esc:char('%')}} or <code><nowiki>esc:kill{'{{example\|\\}}}', '}'} == '{{example\|}'</nowiki>~~</code>~~		All module functions (i.e. any func. other than {{code\|main()}}) should be called using a colon ({{char\|:}}), e.g. {{code\|esc:char('%')\|lua}} or {{code\|<nowiki>esc:kill{'{{example\|\\}}}', '}'} == '{{example\|}'</nowiki>\|lua}}


	{\|class='wikitable' style='background:#fff'		{\|class="wikitable" style="background:#fff"
	\|-		\|-
	!style='vertical-align:top;width:7em'\|{{TOC tab\|escape:text()}}		!style="vertical-align:top;width:7em;font-family:monospace;"\|{{TOC tab\|escape:text()}}
	\|This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by escape:char() will be replaced with placeholders that can be converted back into that char by escape:undo()		\|This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by {{code\|escape:char()}} will be replaced with placeholders that can be converted back into that char by escape:undo()
	\|-		\|-
	!style='vertical-align:top;width:5em'\|{{TOC tab\|escape:undo()}}		!style="vertical-align:top;width:5em;font-family:monospace;"\|{{TOC tab\|escape:undo()}}
	\|Takes two arguments:		\|Takes two arguments:
	# The string that may contain placeholders set by escape:text()		# The string that may contain placeholders set by {{code\|escape:text()}}
	# Optional, a char to be placed in front of any characters that have been de-escaped. (i.e. if you need to re-escape those string with a different char)		# Optional, a char to be placed in front of any characters that have been de-escaped. (i.e. if you need to re-escape those string with a different char)
	\|-		\|-
	!style='vertical-align:top;width:5em'\|{{TOC tab\|escape:kill()}}		!style="vertical-align:top;width:5em;font-family:monospace;"\|{{TOC tab\|escape:kill()}}
	\|This is basically equivalent to calling string.gsub() on the string returned by escape:text() and feeding that result into escape:undo() in a single step. Takes three arguments:		\|This is basically equivalent to calling {{code\|string.gsub()}} on the string returned by {{code\|escape:text()}} and feeding that result into {{code\|escape:undo()}} in a single step. Takes three arguments:
	# A string		# A string
	# A sequence of characters to be removed from that string. (May use a string.gsub pattern)		# A sequence of characters to be removed from that string. (May use a {{code\|string.gsub()}} pattern)
	# Optional, a char to be placed in front of any characters that have been de-escaped.		# Optional, a char to be placed in front of any characters that have been de-escaped.
	\|-		\|-
	!style='vertical-align:top'\|{{TOC tab\|escape:char()}}		!style="vertical-align:top;font-family:monospace;"\|{{TOC tab\|escape:char()}}
	\|This function's primary use is to initialize the patterns to scan a string for an escape/escaped sequence. It takes two arguments, the first being the escape character and the second being a table of arguments (optional). By default, this module will escape the {{code\|\}} char. To escape the {{code\|{}} char instead, you can do {{code\|require('Module:Escape'):char('{')}} (or {{code\|esc:char('{')}} (presuming you stored the table returned by this module in the local variable {{code\|esc}}).		\|This function's primary use is to initialize the patterns to scan a string for an escape/escaped sequence. It takes two arguments, the first being the escape character and the second being a table of arguments (optional). By default, this module will escape the {{code\|\}} char. To escape the {{code\|{}} char instead, you can do {{code\|require('Module:Escape'):char('{')\|lua}} (or {{code\|esc:char('{')\|lua}} (presuming you stored the table returned by this module in the local variable {{code\|esc}}).

	When called without the second argument, char() will return a table containing the functions. This allows, for example, <code>escape:char(''):kill('123', '%d')~~</code>~~ which would return '2'		When called without the second argument, char() will return a table containing the functions. This allows, for example, {{code\|escape:char(''):kill('123', '%d')\|lua}} which would return '{{samp\|2}}'.

	For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.		For the most part, there is very little reason to set {{para\|mode}} in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the {{para\|char}} if a new escape sequence is desired.

	====Shortcut====		====Shortcut====
	If provided a second argument that is a table containing a {key = value} pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})}} is equivalent to {{code\|escape:char('\\'):text('string')}}.		If provided a second argument that is a table containing a <code>{key = value}</code> pair, such that the key is {{code\|text}}, {{code\|undo}}, or {{code\|kill}} and the value is a table containing the arguments that would have been passed to those functions. For example, {{code\|escape:char('\\', {text {{=}} 'string'})\|lua}} is equivalent to {{code\|escape:char('\\'):text('string')\|lua}}.

	Note that if multiple key-value pairs are provided, only one may execute. {{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.		Note that if multiple key-value pairs are provided, only one may execute. {{code\|kill}} is ignored if either {{code\|text}} or {{code\|undo}} are present. {{code\|undo}} is ignored if {{code\|text}} is present.
Line 54:		Line 52:

	===Caveats===		===Caveats===
	* When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus, escape:undo() will unescape, for example, all characters escaped with 'e' and 'esc' if both were used. In practice however this shouldn't be a problem as multiple escape sequences are pretty rare unless you're transitioning between multiple code languages. (Multiple multi-char escape sequences beginning with the same character are simply bad practice anyhow.)		* When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus, {{code\|2=lua\|escape:undo()}} will unescape, for example, all characters escaped with {{code\|'e'}} and {{code\|'esc'}} if both were used. In practice however this shouldn't be a problem as multiple escape sequences are pretty rare unless you're transitioning between multiple code languages. (Multiple multi-char escape sequences beginning with the same character are simply bad practice anyhow.)
	* Since byte values are stored as numbers, it is not recommended for you to use a number as an escape sequence (though it may work just fine).		* Since byte values are stored as numbers, it is not recommended for you to use a number as an escape sequence (though it may work just fine).
	* Placeholder byte values separated with return ('\r') characters--chosen because they are seldom used at all, and virtually never used unpaired with '\n'; moreover, it is distinct from the markers generated by {{tag\|nowiki}} or {{code\|mw.text.nowiki()}} (which use the delete char). To set a different separator char, include the key-value pair <code>{safeChr = {{green\|alternate character}}}</code> in the table that you pass to escape:char().		* Placeholder byte values separated with return ({{code\|'\r'}}) characters--chosen because they are seldom used at all, and virtually never used unpaired with {{code\|'\n'}}; moreover, it is distinct from the markers generated by {{tag\|nowiki}} or {{code\|mw.text.nowiki()}} (which use the delete char). To set a different separator char, include the key-value pair <code>{safeChr = {{green\|alternate character}}}</code> in the table that you pass to escape:char().

	==Speed==		==Speed==