Re: Documentation for the GUI

[Daniel J Sebald]

On 02/04/2015 11:44 PM, Michael Godfrey wrote:
> On 02/05/2015 12:10 AM, Daniel J Sebald wrote:
> > On 02/02/2015 09:14 AM, Jordi Gutiérrez Hermoso wrote:
> > > On Sat, 2015-01-31 at 19:17 +1100, Svetlana Tkachenko wrote:
> > > > As the intent is to release the GUI to users at a point, where is
> > > > the current documentation for it?
> > >
> > > There is none.
> > >
> > > Can you help us write it?
> >
> > Something to consider: Qt has a facility called Qt-Assistant for help.
> > It's very similar to what is called a HelpBook in Windows. (That very
> > familiar layout with the table of contents on the left side for quick
> > access, also searching. Even Acrobat Reader uses that look and feel.)
> > I just used Qt-Assistant for the gnuplot Qt terminal. The Octave help
> > code would need to be translated to the Qt-Assistant format and
> > bundled, but it doesn't prove too difficult. There are a few commands
> > for Qt code to interact with the Qt-Assistant, say, jumping to certain
> > locations in help as directed by the code in the GUI. Just letting you
> > know that's an option.
> >
> > Dan
> Since as it is now, you can bring up pages of the manual within the GUI
> why not just update
> the Manual, which has to be done anyhow?

Well, one does update the manual, and then run it through something that 
extracts and formats a table of contents.  The advantage of Qt-Assistant 
is an added left-side panel with quick access, rather than having to 
kind of retrace one's steps through the documentation.  Also, how about 
help associated with forge packages?  Is that integrated seamlessly when 
a package is installed.  I really haven't followed documentation that 
much, but given the effort that has gone into making the GUI, add some 
value I guess.

Dan