[Octave-bug-tracker] [bug #53006] GUI Documentation Browser displays Index chapters of manual poorly

[Dan Sebald]

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

No, I don't have Qt 5.9 (5.5.1 on this machine).  I'm surprised Qt would make
such a drastic change.  I just looked at the header file

-I/usr/include/x86_64-linux-gnu/qt5/QtHelp

and see


qhelpsearchengine.h:    void search(const QList<QHelpSearchQuery>
&queryList);


so it must be something else.  I'll look around.

I just noticed this superfluous check on m_help_engine:


    if (! m_help_engine->setupData())
      {
        QMessageBox::warning (this, tr ("Octave Documentation"),
                              tr ("Could not setup the data required for
the\n"
                                  "documentation viewer. Only help texts
in\n"
                                  "the Console Widget will be available."));
        if (m_help_engine)
          {
            delete m_help_engine;
            m_help_engine = 0;
          }
      }


m_help_engine was used to find m_help_engine->setupData(), so it must be valid
by the time of the second test.

Regarding Rik's observation about search results, the results are the same as
what "assistant -collectionFile octave_interpreter.qhc" generates.  I don't
know who's controlling that info (Qt search engine innards, or something
else), but a more useful display of info would be maybe five words on either
side of the found word, with the found word in bold...but don't spend too much
effort on that.  What is important though is the search results are missing
the main entries that one would like to be at the top of the list, i.e., jump
to first, and I don't understand why.  In your example there are two items
listed, but I'm attaching a plot showing the occurrence of "acoth" that is
*not* found and that is the one we want to jump to first, I believe.  This
isn't something that Torsten's changeset addresses, but probably something to
do with the way information is formatted in the QHC file, e.g.,
section-markers or highlight-markers around the word "acoth" or maybe a format
that breaks the word "acoth" up internally (something that HTML often does).

Thoughts on the cream colored highlighting of code lines with the grey
background?  Is it possible to make the code inside an in-paragraph box rather
than have the cream lines extend all the way to the right border?  The long
line has a sort of disruptive flow as though it is a new section or header.



(file #43714)
    _______________________________________________________

Additional Item Attachment:

File name: missing_from_acoth_search_Screenshot_from_2018-03-29_00-37-41.png
Size:118 KB


    _______________________________________________________

Reply to this item at:

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

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