changeset 23906:3b81ef7b562c

doc: Explain how to form correct strings for "latex" interpreter mode. * plot.txi: Explain how to form correct strings for "latex" interpreter mode. Remove typo of extra period. Use @w{} to prevent word breaks around pairs of braces.
author Rik <rik@octave.org>
date Sat, 12 Aug 2017 15:55:11 -0700
parents b41792547237
children 8fa415ff2cb3 b080ee04f6bf
files doc/interpreter/plot.txi
diffstat 1 files changed, 7 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/plot.txi	Sun Aug 13 00:33:25 2017 +0200
+++ b/doc/interpreter/plot.txi	Sat Aug 12 15:55:11 2017 -0700
@@ -667,7 +667,10 @@
 @qcode{"latex"}.  If the interpreter is set to @qcode{"none"} then no special
 rendering occurs---the displayed text is a verbatim copy of the specified text.
 Currently, the @qcode{"latex"} interpreter is not implemented for on-screen
-display and is equivalent to @qcode{"none"}.
+display and is equivalent to @qcode{"none"}.  Note that Octave does not parse
+or validate the text strings when in @qcode{"latex"} mode---it is the
+responsibility of the programmer to generate valid strings which may include
+wrapping sections that should appear in Math mode with '$' characters.
 
 The @qcode{"tex"} option implements a subset of @TeX{} functionality when
 rendering text.  This allows the insertion of special glyphs such as Greek
@@ -705,7 +708,7 @@
 @end multitable
 
 The color of the text may also be changed inline using either a string (e.g.,
-"red") or numerically with a Red-Green-Blue (RGB) specification (.e.g.,
+"red") or numerically with a Red-Green-Blue (RGB) specification (e.g.,
 [1 0 0], also red).
 
 @multitable @columnfractions .1 .4 .6 .1
@@ -716,8 +719,8 @@
 
 Finally, superscripting and subscripting can be controlled with the @qcode{'^'}
 and @qcode{'_'} characters.  If the @qcode{'^'} or @qcode{'_'} is followed by a
-@{ character, then all of the block surrounded by the @{ @} pair is
-superscripted or subscripted.  Without the @{ @} pair, only the character
+@{ character, then all of the block surrounded by the @w{@{ @}} pair is
+superscripted or subscripted.  Without the @w{@{ @}} pair, only the character
 immediately following the @qcode{'^'} or @qcode{'_'} is changed.
 
 @float Table,tab:extended