changeset 24549:2c497be89710

doc: Create new Graphic Properties Index (bug #52812). * doc/interpreter/pr-idx.txi: New index file. * doc/interpreter/module.mk: Add pr-idx.txi to build system. * genpropdoc.m: Place graphic properties in to @prindex. * octave.texi: Use "@defindex pr" to create a new index. Add "Graphics Properties Index" to menu. "@include pr-idx.texi" as last index after Operators Index. * plot.txi: Put "ObjectXXX Properties" into prindex and use @sortas to have overall list appear first in index.
author Rik <rik@octave.org>
date Sun, 07 Jan 2018 20:02:31 -0800
parents a00033be2134
children 966c3283a164
files doc/interpreter/genpropdoc.m doc/interpreter/module.mk doc/interpreter/octave.texi doc/interpreter/plot.txi doc/interpreter/pr-idx.txi
diffstat 5 files changed, 44 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/doc/interpreter/genpropdoc.m	Sat Jan 06 17:07:37 2018 -0600
+++ b/doc/interpreter/genpropdoc.m	Sun Jan 07 20:02:31 2018 -0800
@@ -1781,7 +1781,7 @@
 
     ## @anchor: cross reference using XREFobjnamefield label
     ## Concept index: call info from octave with 'doc ("objname field")'
-    str = sprintf ("%s@anchor{XREF%s%s}\n@cindex %s %s\n",
+    str = sprintf ("%s@anchor{XREF%s%s}\n@prindex %s %s\n",
                    str, objname, field, objname, field);
 
     ## Item
--- a/doc/interpreter/module.mk	Sat Jan 06 17:07:37 2018 -0600
+++ b/doc/interpreter/module.mk	Sun Jan 07 20:02:31 2018 -0800
@@ -147,6 +147,7 @@
   %reldir%/plot.texi \
   %reldir%/poly.texi \
   %reldir%/preface.texi \
+  %reldir%/pr-idx.texi \
   %reldir%/quad.texi \
   %reldir%/set.texi \
   %reldir%/signal.texi \
--- a/doc/interpreter/octave.texi	Sat Jan 06 17:07:37 2018 -0600
+++ b/doc/interpreter/octave.texi	Sun Jan 07 20:02:31 2018 -0800
@@ -55,6 +55,7 @@
 @end ignore
 
 @defindex op
+@defindex pr
 
 @c The version.texi file doesn't include a chapter, so it must not be
 @c included if you want to run the Emacs function
@@ -196,6 +197,7 @@
 * Concept Index::               An item for each concept.
 * Function Index::              An item for each documented function.
 * Operator Index::              An item for each documented operator.
+* Graphics Properties Index::   An item for each graphics object property.
 
 @detailmenu
  --- The Detailed Node Listing ---
@@ -980,5 +982,6 @@
 @include cp-idx.texi
 @include fn-idx.texi
 @include op-idx.texi
+@include pr-idx.texi
 
 @bye
--- a/doc/interpreter/plot.txi	Sat Jan 06 17:07:37 2018 -0600
+++ b/doc/interpreter/plot.txi	Sun Jan 07 20:02:31 2018 -0800
@@ -1519,7 +1519,7 @@
 
 @node Root Figure Properties
 @subsubsection Root Figure Properties
-@cindex root figure properties
+@prindex @sortas{@ Root Figure Properties} Root Figure Properties
 
 The @code{root figure} properties are:
 
@@ -1528,7 +1528,7 @@
 
 @node Figure Properties
 @subsubsection Figure Properties
-@cindex figure properties
+@prindex @sortas{@ Figure Properties} Figure Properties
 
 The @code{figure} properties are:
 
@@ -1537,7 +1537,7 @@
 
 @node Axes Properties
 @subsubsection Axes Properties
-@cindex axes properties
+@prindex @sortas{@ Axes Properties} Axes Properties
 
 The @code{axes} properties are:
 
@@ -1546,7 +1546,7 @@
 
 @node Line Properties
 @subsubsection Line Properties
-@cindex line properties
+@prindex @sortas{@ Line Properties} Line Properties
 
 The @code{line} properties are:
 
@@ -1555,7 +1555,7 @@
 
 @node Text Properties
 @subsubsection Text Properties
-@cindex text properties
+@prindex @sortas{@ Text Properties} Text Properties
 
 The @code{text} properties are:
 
@@ -1564,7 +1564,7 @@
 
 @node Image Properties
 @subsubsection Image Properties
-@cindex image properties
+@prindex @sortas{@ Image Properties} Image Properties
 
 The @code{image} properties are:
 
@@ -1573,7 +1573,7 @@
 
 @node Patch Properties
 @subsubsection Patch Properties
-@cindex patch properties
+@prindex @sortas{@ Patch Properties} Patch Properties
 
 The @code{patch} properties are:
 
@@ -1582,7 +1582,7 @@
 
 @node Surface Properties
 @subsubsection Surface Properties
-@cindex surface properties
+@prindex @sortas{@ Surface Properties} Surface Properties
 
 The @code{surface} properties are:
 
@@ -1591,7 +1591,7 @@
 
 @node Light Properties
 @subsubsection Light Properties
-@cindex light properties
+@prindex @sortas{@ Light Properties} Light Properties
 
 The @code{light} properties are:
 
@@ -1599,7 +1599,7 @@
 
 @node Uimenu Properties
 @subsubsection Uimenu Properties
-@cindex uimenu properties
+@prindex @sortas{@ Uimenu Properties} Uimenu Properties
 
 The @code{uimenu} properties are:
 
@@ -1607,7 +1607,7 @@
 
 @node Uibuttongroup Properties
 @subsubsection Uibuttongroup Properties
-@cindex uibuttongroup properties
+@prindex @sortas{@ Uibuttongroup Properties} Uibuttongroup Properties
 
 The @code{uibuttongroup} properties are:
 
@@ -1615,7 +1615,7 @@
 
 @node Uicontextmenu Properties
 @subsubsection Uicontextmenu Properties
-@cindex uicontextmenu properties
+@prindex @sortas{@ Uicontextmenu Properties} Uicontextmenu Properties
 
 The @code{uicontextmenu} properties are:
 
@@ -1623,7 +1623,7 @@
 
 @node Uipanel Properties
 @subsubsection Uipanel Properties
-@cindex uipanel properties
+@prindex @sortas{@ Uipanel Properties} Uipanel Properties
 
 The @code{uipanel} properties are:
 
@@ -1631,7 +1631,7 @@
 
 @node Uicontrol Properties
 @subsubsection Uicontrol Properties
-@cindex uicontrol properties
+@prindex @sortas{@ Uicontrol Properties} Uicontrol Properties
 
 The @code{uicontrol} properties are:
 
@@ -1639,7 +1639,7 @@
 
 @node Uitoolbar Properties
 @subsubsection Uitoolbar Properties
-@cindex uitoolbar properties
+@prindex @sortas{@ Uitoolbar Properties} Uitoolbar Properties
 
 The @code{uitoolbar} properties are:
 
@@ -1647,7 +1647,7 @@
 
 @node Uipushtool Properties
 @subsubsection Uipushtool Properties
-@cindex uipushtool properties
+@prindex @sortas{@ Uipushtool Properties} Uipushtool Properties
 
 The @code{uipushtool} properties are:
 
@@ -1655,7 +1655,7 @@
 
 @node Uitoggletool Properties
 @subsubsection Uitoggletool Properties
-@cindex uitoggletool properties
+@prindex @sortas{@ Uitoggletool Properties} Uitoggletool Properties
 
 The @code{uitoggletool} properties are:
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/interpreter/pr-idx.txi	Sun Jan 07 20:02:31 2018 -0800
@@ -0,0 +1,22 @@
+@c Copyright (C) 2017 Rik Wehbring
+@c
+@c This file is part of Octave.
+@c
+@c Octave is free software: you can redistribute it and/or modify it
+@c under the terms of the GNU General Public License as published by
+@c the Free Software Foundation, either version 3 of the License, or
+@c (at your option) any later version.
+@c
+@c Octave is distributed in the hope that it will be useful, but
+@c WITHOUT ANY WARRANTY; without even the implied warranty of
+@c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+@c GNU General Public License for more details.
+@c
+@c You should have received a copy of the GNU General Public License
+@c along with Octave; see the file COPYING.  If not, see
+@c <https://www.gnu.org/licenses/>.
+
+@node Graphics Properties Index
+@unnumbered Graphics Properties Index
+
+@printindex pr