[Octave-bug-tracker] [bug #52812] Graphic object properties should appear in their own index in manual

[Dan Sebald]

Follow-up Comment #1, bug #52812 (project octave):

Good point about the properties not really being concepts.

Pre-defined indices are here:

https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html#Predefined-Indices

The manner to define new indices is here:

https://www.gnu.org/software/texinfo/manual/texinfo/html_node/New-Indices.html#New-Indices

It's pretty simple to define new indices, so my preference would be to do
that, simply as a memory aid.  That is, "@prindex" is easy to associate with
"properties", where "@tindex" isn't as easy.

There are two instances where @defindex already appears:

linux@ ~/octave/octave/octave $ grep defindex doc/*/* -s
doc/interpreter/octave.texi:@defindex op
doc/liboctave/liboctave.texi:@defindex op

Why twice?  I don't know.  Placing a "@defindex pr" near there would be good.

One thing I'm wondering about is further use of the property help within
Octave itself, either from the command line or from the GUI.  Now, I just
looked at the GUI and the documentation window is actually kind of nice for
navigating the manual.  Certainly a Property Index link would be an organized
and quick reference, but we should think of a layout that is rather efficient
in terms of getting to the right graphics object (e.g., image) and then the
property very quickly.  And down the road, could there be a way in which the
individual help blocks are made available to the GUI so that it might have a
property editor and tooltips with the doc for that property.

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?52812>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/