bugGNU Octave - Bugs: bug #54880, Search in Documentation pane...


bug #54880: Search in Documentation pane doesn't really work

Submitted by:  Philip Nienhuis <philipnienhuis>
Submitted on:  Mon 22 Oct 2018 08:11:09 PM UTC  
Category:  GUI Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Incorrect Result
Status:  Fixed Assigned to:  None
Originator Name:  Philip Nienhuis Open/Closed:  Closed
Release:  dev Operating System:  Microsoft Windows

Add a New Comment (Rich Markup)

You are not logged in

Please log in, so followups can be emailed to you.


( Jump to the original submission)

Wed 31 Oct 2018 05:31:30 PM UTC, comment #11:

Well it works now on my home box as well.

It's beyond me why it does work now and didn't before, I didn't note csets that could explain it.

Anyway, closing report then.

Philip Nienhuis <philipnienhuis>
Project Member
Wed 31 Oct 2018 10:35:44 AM UTC, comment #10:

Yep, I see that at work, with a cross-build I made on Oct 25, the search works in Windows.
Let me check on my home boxes tonight before closing this report.

Philip Nienhuis <philipnienhuis>
Project Member
Tue 30 Oct 2018 11:14:23 PM UTC, comment #9:

I noticed this bug in the past, but it works with the version I built today.

Marshall <marsian>
Sun 28 Oct 2018 09:31:21 PM UTC, comment #8:

No sorry.
The picture of comment #6 is the same then except for the underscore :-)

Philip Nienhuis <philipnienhuis>
Project Member
Sun 28 Oct 2018 08:47:09 PM UTC, comment #7:

@Philip: The correct syntax is

doc "figure properties"

without underscore. Does this work on your system?

Torsten Lilge <ttl>
Project Member
Tue 23 Oct 2018 05:46:58 PM UTC, comment #6:

@Panxto, comment #3:
See attached pic.

doc "figure_properties" brings up the doc pane & filled-in search tab but no search results.

Philip Nienhuis <philipnienhuis>
Project Member
Tue 23 Oct 2018 04:49:50 PM UTC, comment #5:

@jwe: maybe "QT_DEBUG_PLUGINS=1" if sqlite is considered a pluggin (http://doc.qt.io/qt-5/debug.html#environment-variables-recognized-by-qt).

Pantxo Diribarne <pantxo>
Project Member
Tue 23 Oct 2018 04:13:04 PM UTC, comment #4:

I built a copy of the qt assistant.exe program.  I can run it from inside Octave using

system ("assistant.exe -collectionFile /path/to/octave_interpreter.qhc")

(it apparently needs some environment variables defined to find plugins and this seemed the easiest way to do it).  It displays the manual and search within a page works, but opening the search dialog and trying to find "svd" (for example) doesn't return any results.

Looking in the index for "svd" and then clicking on "svd" in the list does bring up the documentation for the svd function.

Do we have all the necessary libraries/tools installed to search?  This page https://stackoverflow.com/questions/32748558/using-a-qt-help-file-in-an-installed-app says we may need the sqlite sql driver (do we build and install that?  I'm not sure exactly what file(s) that would be).  We do seem to be copying the qhc file to a temporary writable directory, so it doesn't seem like taht would be the problem.  Is there some Qt setting that we can enable to view any messages that might be displayed about missing files or tools or other things that could be going wrong?

John W. Eaton <jwe>
Project Administrator
Tue 23 Oct 2018 08:15:36 AM UTC, comment #3:

@Philip: That's strange. In linux typing e.g. "doc "figure properties"" (with quotes) opens the doc browser, displays the search pane with "figure properties" added to the search area, and automatically opens the first search result. I guess this doesn't work either in Windows. Could you test this example and report back?
Another useful test would be to install Qt's "assistant" application and see how it handles octave_interpreter.qhc (distributed with Octave).

Pantxo Diribarne <pantxo>
Project Member
Mon 22 Oct 2018 09:09:41 PM UTC, comment #2:

Thanks for confirming Linux is OK, in Mageia 6 it works as well.
So it's a Windows-only bug AFAICS.

Philip Nienhuis <philipnienhuis>
Project Member
Mon 22 Oct 2018 08:23:01 PM UTC, comment #1:

It works ok in ubuntu.

Doug Stewart <dastew>
Mon 22 Oct 2018 08:11:09 PM UTC, original submission:

Searching anything using the search tab in the documentation pane doesn't yield any result, not even the word "Octave". See attached pic.
IMO this is an "incorrect result", as the word "Octave" is mentioned several times in the subpane to the right.

I hit this before but could work around it by using the index tab. But now I wanted to search for the keyword (statement) "for" and the the search gets a bit harder.

For Octave newbies a better search capability would be a big benefit, I think.
The best would be a full text search capability but maybe that is asking too much; but at least function names, keywords and reserved words should be searchable in the built-in docs.

Philip Nienhuis <philipnienhuis>
Project Member


(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:

Attached Files


Depends on the following items: None found

Items that depend on this one: None found


Carbon-Copy List
  • -email is unavailable- added by marsian (Posted a comment)
  • -email is unavailable- added by ttl (Posted a comment)
  • -email is unavailable- added by jwe (Posted a comment)
  • -email is unavailable- added by pantxo (Posted a comment)
  • -email is unavailable- added by dastew (Posted a comment)
  • -email is unavailable- added by philipnienhuis (Submitted the item)

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.




    Follow 4 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-10-31 philipnienhuis StatusNone => Fixed
        Open/ClosedOpen => Closed
    2018-10-23 philipnienhuis Attached File- => Added Doc_pane_search#2.PNG, #45270
    2018-10-22 philipnienhuis Attached File- => Added Doc_pane_search.PNG, #45259

    Back to the top

    Powered by Savane 3.4