octave-maintainers
[Top][All Lists]
Advanced

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

Re: Documentation for the GUI


From: Michael Godfrey
Subject: Re: Documentation for the GUI
Date: Thu, 05 Feb 2015 00:44:21 -0500
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.4.0


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?

Michael




reply via email to

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