Mercurial > octave

changeset 31574:05a1b9a60efa stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros. * genpropdoc.m: Change @xref instances that pointed to XREFinterpreterusage to point to new node name. * octave.texi: Rename menu item "Use of the @code{interpreter} Property" to "Use of the "interpreter" Property". * plot.txi: Replace uses of @code macro within @node, @subsections by surrounding text with double quotes ("..."). Remove special @anchor macros that had been created to work around pointing directly to nodes with @code macro in them.
author Rik <rik@octave.org>
date Mon, 28 Nov 2022 10:49:35 -0800
parents cdcc687c2669
children f3e3a310aceb b870a8c28aaa
files doc/interpreter/genpropdoc.m doc/interpreter/octave.texi doc/interpreter/plot.txi
diffstat 3 files changed, 25 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m	Mon Nov 28 10:39:51 2022 -0800
+++ b/doc/interpreter/genpropdoc.m	Mon Nov 28 10:49:35 2022 -0800
@@ -865,7 +865,7 @@
 
       case "ticklabelinterpreter"
         s.doc = "Control the way x/y/zticklabel properties are interpreted.\n\
-@xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
+@xref{Use of the \"interpreter\" Property, , @w{Use of the \"interpreter\" Property}}.";
 
       case "ticklength"
         s.doc = "Two-element vector @code{[2Dlen 3Dlen]} specifying the \
@@ -1089,7 +1089,7 @@
       case "interpreter"
         s.doc = "Control if and eventually how labels strings are interpreted \
 before rendering.\n\
-@xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
+@xref{Use of the \"interpreter\" Property, , @w{Use of the \"interpreter\" Property}}.";
 
       case "itemhitfcn"
         s.doc = "Callback function which is executed when a legend item \
@@ -1294,7 +1294,7 @@
       case "interpreter"
         s.doc = "Control the way the @qcode{\"string\"} property is \
 interpreted.\n\
-@xref{XREFinterpreterusage, , @w{Use of the interpreter property}}.";
+@xref{Use of the \"interpreter\" Property, , @w{Use of the \"interpreter\" Property}}.";
 
       case "linestyle"
         s.doc = "Style of the outline.  @xref{Line Styles}.";
--- a/doc/interpreter/octave.texi	Mon Nov 28 10:39:51 2022 -0800
+++ b/doc/interpreter/octave.texi	Mon Nov 28 10:49:35 2022 -0800
@@ -553,7 +553,7 @@
 * Multiple Plot Windows::
 * Manipulation of Plot Objects::
 * Manipulation of Plot Windows::
-* Use of the @code{interpreter} Property::
+* Use of the "interpreter" Property::
 * Printing and Saving Plots::
 * Interacting with Plots::
 * Test Plotting Functions::
--- a/doc/interpreter/plot.txi	Mon Nov 28 10:39:51 2022 -0800
+++ b/doc/interpreter/plot.txi	Mon Nov 28 10:49:35 2022 -0800
@@ -81,7 +81,7 @@
 * Multiple Plot Windows::
 * Manipulation of Plot Objects::
 * Manipulation of Plot Windows::
-* Use of the @code{interpreter} Property::
+* Use of the "interpreter" Property::
 * Printing and Saving Plots::
 * Interacting with Plots::
 * Test Plotting Functions::
@@ -745,34 +745,33 @@
 
 @DOCSTRING(closereq)
 
-@node Use of the @code{interpreter} Property
-@subsection Use of the @code{interpreter} Property
-@anchor{XREFinterpreterusage}
+@node Use of the "interpreter" Property
+@subsection Use of the "interpreter" Property
 
 @code{text} (such as titles, labels, legend item) and @code{axes} objects
-feature a @ref{XREFtextinterpreter,,interpreter} and
-@ref{XREFaxesticklabelinterpreter,,ticklabelinterpreter} property respectively.
-It determines the manner in which special control sequences in the text are
-rendered.
+feature an @ref{XREFtextinterpreter,,@qcode{"interpreter}} and a
+@ref{XREFaxesticklabelinterpreter,,@qcode{"ticklabelinterpreter"}} property
+respectively.  It determines the manner in which special control sequences in
+the text are rendered.
 
 The interpreter property can take three values: @qcode{"none"}, @qcode{"tex"},
 @qcode{"latex"}.
 
 @menu
-* @code{none} interpreter::
-* @code{tex} interpreter::
-* @code{latex} interpreter::
+* "none" interpreter::
+* "tex" interpreter::
+* "latex" interpreter::
 @end menu
 
-@node @code{none} interpreter
-@subsubsection @code{none} interpreter
-@anchor{XREFnoneinterpreter}
+@node "none" interpreter
+@subsubsection "none" interpreter
+
 If the interpreter is set to @qcode{"none"} then no special
 rendering occurs---the displayed text is a verbatim copy of the specified text.
 
-@node @code{tex} interpreter
-@subsubsection @code{tex} interpreter
-@anchor{XREFtexinterpreter}
+@node "tex" interpreter
+@subsubsection "tex" interpreter
+
 The @qcode{"tex"} interpreter implements a subset of @TeX{} functionality when
 rendering text.  This allows the insertion of special glyphs such as Greek
 characters or mathematical symbols.  Special characters are inserted by using
@@ -1073,9 +1072,9 @@
 has chosen to follow the @TeX{} specification, but has added the additional
 symbol @code{\deg} which maps to the degree symbol (U+00B0).
 
-@node @code{latex} interpreter
-@subsubsection @code{latex} interpreter
-@anchor{XREFlatexinterpreter}
+@node "latex" interpreter
+@subsubsection "latex" interpreter
+
 The @qcode{"latex"} interpreter only works if an external @LaTeX{} tool chain
 is present.  Three binaries are needed: @code{latex}, @code{dvipng}, and
 @code{dvisvgm}.  If those binaries are installed but not on the path, one can
@@ -1267,7 +1266,6 @@
 @node Introduction to Graphics Structures
 @subsection Introduction to Graphics Structures
 @cindex introduction to graphics structures
-@anchor{XREFgraphics structures}
 
 The graphics functions use pointers, which are of class graphics_handle, in
 order to address the data structures which control visual display.  A
@@ -1296,7 +1294,7 @@
 @code{contourf}, @code{contour3}, @code{surfc}, @code{meshc}, @code{errorbar},
 @code{quiver}, @code{quiver3}, @code{stair}, @code{stem}, @code{stem3} each
 return a handle to a complex data structure as documented in
-@ref{XREFdatasources,,Data Sources}.
+@ref{Data Sources in Object Groups,,Data Sources}.
 
 The graphics objects are arranged in a hierarchy:
 
@@ -2301,7 +2299,7 @@
 @node Data Sources in Object Groups
 @subsubsection Data Sources in Object Groups
 @cindex data sources in object groups
-@anchor{XREFdatasources}
+
 All of the group objects contain data source parameters.  There are
 string parameters that contain an expression that is evaluated to update
 the relevant data property of the group when the @code{refreshdata}