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

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

[Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Ind


From: Dan Sebald
Subject: [Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Index chapters of manual poorly
Date: Thu, 22 Mar 2018 12:51:13 -0400 (EDT)
User-agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:55.0) Gecko/20100101 Firefox/55.0

Follow-up Comment #45, bug #53006 (project octave):

@Torsten Comment #42:  I see the Qt help-engine tools:

http://doc.qt.io/qt-5/qhelpengine.html
http://doc.qt.io/qt-5/qhelpsearchengine.html

They're nice (without the search engine object, it would be a no-go). 
However, there's still some work in figuring out what to do with those
search-results as far as placing them somewhere within the GUI.

QVector<QHelpSearchResult> searchResults(int start, int end)

Put them in a combo-box?  On their own new octave_dock_widget?  Provide quick
links to those items one puts in a combo box so that it jumps to the proper
location in the QTextBrowser one creates to display the QHC?  There are some
tools there to aid in this, in particular a widget to help prep for the
search:

QHelpSearchQueryWidget *queryWidget()

and a widget to display the search results:

QHelpSearchResultWidget *resultWidget()

I suspect they are the exact same widget's that QtAssistant uses.

My thought was that we could just leave the current Help->Documentation as is
and add another line

On Disk
Online
Assistant

for which the Assistant selection just launches QtAssistant, a few hours
work.

I'd say evaluate your effort and the benefit the end result provides before
diving in too deep.  For me, "help spiffyfunction" along with the "See alsos"
has always been pretty good.

    _______________________________________________________

Reply to this item at:

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

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




reply via email to

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