octave-bug-tracker
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Octave-bug-tracker] [bug #46076] Documentation needed for ui* family of


From: Rik
Subject: [Octave-bug-tracker] [bug #46076] Documentation needed for ui* family of GUI building functions
Date: Thu, 08 Oct 2015 15:13:28 +0000
User-agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:41.0) Gecko/20100101 Firefox/41.0

Follow-up Comment #6, bug #46076 (project octave):

@John: To make a hyperclick link that points off to another portion of the
manual you can use @ref, @xref, or @pxref.  The @xref variants automatically
add "See " to the front of the reference and are used most often in Octave.

For an example, look at plot.txi.


The documentation about a specific graphics object can be displayed
using @code{doc} function, e.g., @code{doc ("axes properties")} will show
@ref{Axes Properties}.


which in the pdf is translated to 


The documentation about a specific graphics object can be displayed using doc
function, e.g., doc ("axes properties") will show Section 15.3.3.3 [Axes
Properties], page 371.


The reference needs to point to an @node entry.  For the Axes Properties
example, the reference points to


@node Axes Properties
@subsubsection Axes Properties
@cindex axes properties




    _______________________________________________________

Reply to this item at:

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

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




reply via email to

[Prev in Thread] Current Thread [Next in Thread]