Text-to-speech control tags follow these general rules of syntax:
All tags begin and end with a backslash character (\).
The backslash character is not allowed within a tag.
An odd number of backslash characters in tagged text produce undefined behavior in the engine.
Tags are case-insensitive. For example, \vce\ is the same as \VCE\.
Tags are white-space -- dependent. For example, \Rst\ is not the same as \ Rst \.
To include a backslash character in tagged text, but outside a tag, use a double backslash (\\).
If the application has the tagged text bit on and wishes to speak a filename, such as "c:\windows\system\test.txt", then it should double up the backslashes (e.g., "c:\\windows\\system\\test.txt").
Samples:
|
\ ctx="e-mail" \ |
Should be parsed as an "e-mail" tag. |
|
\ctx="e-mail" |
Should be ignored since it's an unclosed tag at the end of a document. |
|
\\ctx="e-mail"\\ |
Speaks "back-slash c t x equals e-mail back-slash" |
|
\\\\\\\\ctx="e-mail"\\\\\\\\ |
Speaks "backslash backslash backslash backslash c t x equals e-mail backslash backslash backslash backslash" |
|
\ctm="e-mail"\ |
Ignored because it's an unknown tag. |
When the text-to-speech engine encounters a tag it does not understand, the tag is ignored.