octave-maintainers
[Top][All Lists]
Advanced

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

Re: Help strings in the text body of the manual


From: Daniel J Sebald
Subject: Re: Help strings in the text body of the manual
Date: Mon, 25 Apr 2016 01:11:47 -0500
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.2.24) Gecko/20111108 Fedora/3.1.16-1.fc14 Thunderbird/3.1.16

On 04/24/2016 10:29 PM, LachlanA wrote:

Having said that, I have almost never looked at the manual.  Finding what I
want in a 1000 page document is too hard.  Perhaps Pantxo's suggestion could
reduce the manual to a 200 page document, with 800 pages of appendix -- or
perhaps each chapter could have a short "synthesis" section with this sort
of discussion, followed by (and hyperlinked to) its own function list.

Qt has a feature similar to Windows HelpBook, called Qt Assistant:

http://doc.qt.io/qt-5/assistant-custom-help-viewer.html#using-qt-assistant-remotely

It requires HTML code and then a few simple steps to compress the set of files into the proper file format. Once loaded Qt Assistant will allow searching, which is nice because it is a fast way to jump to the documentation of interest.

Dan



reply via email to

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