StringTools - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Names and Strings : StringTools Package : Encodings : StringTools/Escape

StringTools

  

Escape

  

escape special characters in a string by using a specified escape schema

 

Calling Sequence

Parameters

Description

Examples

Calling Sequence

Escape( s, form )

Parameters

s

-

string; Maple string

form

-

(optional) symbol or string; keyword describing how to escape characters in the input s

Description

• 

The Escape(s, form) command escapes special characters in the input string s, according to rules specified by the optional second argument form.

• 

The form argument defaults to xml, which specifies that rules appropriate for including the text of the string s in an XML document are to be used.

• 

Alternatively, the form argument can be the symbol html. Escaping rules suitable for HTML text are then used.

• 

If the form argument is regexp, then the input is taken to be a regular expression, and is escaped in such a way that RegMatch( Escape( rx, 'regexp' ), rx ) returns true, for any regular expression rx.

Examples

withStringTools:

EscapeSome text with <b>'embedded' HTML</b>.

Some text with <b>'embedded' HTML</b>.

(1)

EscapeSome text with <b>'embedded' HTML</b>.&comma;&apos;xml&apos;

Some text with <b>'embedded' HTML</b>.

(2)

EscapeSome text with <b>'embedded' HTML</b>.&comma;&apos;html&apos;

Some text with <b>'embedded' HTML</b>.

(3)

rx0x([0-9a-f]+|[0-9A-F]+)$&colon;

sEscaperx&comma;&apos;regexp&apos;

s0x\(\[0-9a-f\]\+\|\[0-9A-F\]\+\)\$

(4)

RegMatchs&comma;rx

true

(5)

See Also

StringTools

StringTools[RegMatch]