String x

From Eigenvector Research Documentation Wiki
Revision as of 12:56, 10 October 2008 by imported>Jeremy (New page: ===Purpose=== Add backslash before troublesome TeX characters. ===Synopsis=== :safestring = string_x(string); ===Description=== The TeX interpreter is used on various text objects in fi...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Purpose

Add backslash before troublesome TeX characters.

Synopsis

safestring = string_x(string);

Description

The TeX interpreter is used on various text objects in figures to add subscripts, superscripts and other special effects to text. These effects are triggered by special characters in strings. string_x "escapes" these special characters to keep them from being handled by the TeX interpreter. An escaping backslash is added before each of these characters: _ ^ { }

Inputs

  • string = a string to clean

Outputs

  • safestring = the backslashed string

See Also