Module:Escape/doc: Difference between revisions

Revision as of 13:31, 28 April 2022

Revision as of 22:16, 19 February 2023

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.

====Shortcut (not fully implemented)====

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:undochar()'\\', will{text cause{{=}} the escaescape:text('string'})}} andis equivalent to {{code|escape:killchar('\\'):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:

{{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.)

|}