The escape statement is used to escape quotes in a variable value or the contents of a named buffer


escape quotes invarName|{bufferName}[usingescape_char]


If a variable value or named buffer contains quotes then it may be desirable to escape them, either for display purposes (to prevent USE from removing them before rendering the data as output) or in order to satisfy the requirements of an external API.

The escape statement will precede all occurrences of the character " with a specified escape character (backslash by default) as shown in the example below. This operation is not just temporary - it will update the actual contents of the variable or named buffer.

The escape statement does not take into account the context of existing quote characters in the data. Running it multiple times against the same data will add an additional escape character each time to each occurrence of a quote.


Given an input file called 'escapeme.txt' containing the following data:

"this "is some text" with
some "quotes" in it"

The following script:

buffer test = FILE system/extracted/escapeme.txt
escape quotes in {test}
print {test}
var testvar = "\"This is \"a test\" string\""
escape quotes in testvar using \"
print ${testvar}

will produce the following output:

\"this \"is some text\" with
some \"quotes\" in it\"
""This is ""a test"" string""