bugGNU Octave - Bugs: bug #54938, [GUI] Documentation pane could...

 
 

bug #54938: [GUI] Documentation pane could provide bookmarks

Submitted by:  Philip Nienhuis <philipnienhuis>
Submitted on:  Fri 02 Nov 2018 08:20:06 AM UTC  
 
Category:  GUI Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Feature Request
Status:  In Progress Assigned to:  Torsten Lilge <ttl>
Originator Name:  Philip Nienhuis Open/Closed:  Open
Release:  dev Operating System:  Any

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)

Sat 15 Dec 2018 07:37:30 AM UTC, comment #16: 

@Philip: You are right. Clicking on a link in the search widget should automatically start a text search in the target page. At least, this seems to be the behavior of Qt5 Assistant.

I have submitted a new bug report for this (bug #55228).

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Fri 14 Dec 2018 09:59:40 PM UTC, comment #15: 

@Torsten comment #14:
What I mean was that I do get the "strread" mentioned in plain text  in the search results, but I'd at least expect to get a clickable "strread" link that takes me directly to the strread paragraph rather than the encompassing "Simple file I/O" chapter ...
I'd imagine that such links should be possible, but I don't know how that can be done. Maybe the search should extend to the function and keyword index as well.

Philip Nienhuis <philipnienhuis>
Project Member
Fri 14 Dec 2018 08:27:42 PM UTC, comment #14: 

I will have a look at the searching issue.

Searching for "strread" gives me the following results

  • Manipulating Strings
  • Simple File I/O (with mentioning "strread")
  • Function Index

If you really only get "Simple File I/O" as result (and without mentioning "strread"), then please open a new bug report. However, the help search engine is not able to provide direct links to a function documentation like the function index does.

About closing this report: I still plan to implement bookmarks.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Thu 13 Dec 2018 05:48:21 PM UTC, comment #13: 

That works all right now, thanks very much Torsten.

What I see when searching e.g., 'strread" is that I only get pointers to the chapter "Simple file I/O" and there's no mention of the string "strread" in the search results.
However, if I enter "strread" in the function index I'm directly taken to the strread function's paragraph.
==> Apparently the search function could be improved.

Should I open a new bug report for this?

If yes, can we close this bug report?

Philip Nienhuis <philipnienhuis>
Project Member
Tue 27 Nov 2018 09:17:38 PM UTC, comment #12: 

I have pushed changesets

http://hg.savannah.gnu.org/hgweb/octave/rev/494452db0477
http://hg.savannah.gnu.org/hgweb/octave/rev/c7f845bf4fec
http://hg.savannah.gnu.org/hgweb/octave/rev/198902f24ef6

for appending the anchor for more meaningful titles in the history menus, for improved filtering of the "GNU Octave version" string, and for the missing icons in the toolbar for systems without icon theme.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Tue 27 Nov 2018 07:06:14 PM UTC, comment #11: 

Pantxo, thanks for clarification.

I still suggest to remove the version info from the title of octave's main help file in the history. When additional help files from packages are registered, these are distinguished by their name in the title.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Tue 27 Nov 2018 08:17:51 AM UTC, comment #10: 

@Torsten: I think the order depends on the version of Qt more than the platform. What version of Qt are you using?

@Philip: The Qt Help system can display help content from multiple  sources, e.g. the Octave manual and the documentation for an Octave Forge package. I think the prefix is here to distinguish the sources. It is indeed pointless when there is only one source, but one could register another Qt help file, e.g. from the IO package, and then the prefix would make sense. 

Pantxo Diribarne <pantxo>
Project Member
Mon 26 Nov 2018 08:27:52 PM UTC, comment #9: 

I'm more curious as to where the "GNU Octave (version 5.0.0)" text comes from in the first place. It is a (IMO) completely unnecessary if not pointless piece of text.

Philip Nienhuis <philipnienhuis>
Project Member
Mon 26 Nov 2018 06:58:42 PM UTC, comment #8: 

Philip, thank you very much. I am afraid I was a bit unclear, an exact text copy of a title would have been sufficient for extending the regular expression, sorry.

Btw: Does anyone know why the titles of the help sections are differently formatted (on different platforms?)?

Philips system (Windows)

GNU Octave (version 5.0.0): Here is the title

My system (Ubuntu/Gnome)

Here is the title (GNU Octave (version 5.0.0))

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Mon 26 Nov 2018 06:09:36 PM UTC, comment #7: 

Torsten

Pic attached. Made with a digicam as screenshots from volatile popups that disappear when they loose focus is impossible; sorry for the somewhat poor quality.


Philip Nienhuis <philipnienhuis>
Project Member
Sun 25 Nov 2018 09:47:14 PM UTC, comment #6: 

@Philip, thanks for the feedback.

Toolbar Buttons
Then there are no fallback icons for the new buttons, should be no problem.

Text in popups and drop-down lists
The title is directly taken from the history that the QTextBrowser provides. These are only the section names. Maybe I can at least take anchor names as additive information to display alongside the title taken from the history. At least, the entries are still linked to the real target and not the beginning of the section.

Version Info (GNU Octave (X.X.X))
This string is filtered by a regular expression and is not showing up on my Ubuntu system. But wait, you say it is a prefix? Can you please send me a copy of a page title as displayed in your menus?. For me, this version string shows up at the end of the page title.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Sun 25 Nov 2018 07:42:57 PM UTC, comment #5: 

@Torsten:
First of all:
Thank you for your fixes and code improvements, very much appreciated!

Then:
Sorry, more minor details :-)

Toolbar buttons
On Windows there are no buttons visible for forward and backward (see attached pic). Hovering with the mouse cursor raises just empty light gray rectangles.

Text in popups and drop-down lists
Forward & backward work OK but the text doesn't match the expected actual position.
E.g., a clear example is as follows:
1. In the search tab type "textscan", hit Enter key
2. Then, doubleclick textscan in the search results ==> the doc entry for textscan shows up, fine. So far, so good.
3. Scroll down to the "See also" section, doubleclick "strread" ==> strread section shows up.
4. Hover with mouse cursor over Backward button: it says "simple file I/O" where I would expect "textscan"

Ssme goes for the entries in the drop-down list. They refer to the encompassing section, not the the actual location in the section.

IMO the "GNU Octave (5.0.0): " prefix for the names in the popups and the drop-down lists is superfluous, it just takes undue space.


Philip Nienhuis <philipnienhuis>
Project Member
Sat 24 Nov 2018 07:55:37 PM UTC, comment #4: 
Torsten Lilge <ttl>
Project MemberIn charge of this item.
Sat 24 Nov 2018 06:24:08 PM UTC, comment #3: 

@Torsten;
Minor detail: the popup text when hovering the mouse cursor over the Zoom in and Zoom out buttons both read "Zoom in".

Philip Nienhuis <philipnienhuis>
Project Member
Fri 23 Nov 2018 07:50:06 PM UTC, comment #2: 

Changeset http://hg.savannah.gnu.org/hgweb/octave/rev/20b87596b99a provides menus for back and forward history entries.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Sun 04 Nov 2018 12:45:56 PM UTC, comment #1: 

For the beginning, I have pushed changeset
http://hg.savannah.gnu.org/hgweb/octave/rev/390d59717711
which provides a toolbar with home/back/forward, zoom in/out/original and find actions. Bookmark management/pane and a history pane will be added later.

Torsten Lilge <ttl>
Project MemberIn charge of this item.
Fri 02 Nov 2018 08:20:06 AM UTC, original submission:  

(A follow-up from bug #54877)

To make the most of the Documentation pane, a toolbar with some often-used commands (in other browsers) would help to access the now hidden capabilities that the doc browser engine can offer.
I'd suggest Bookmark/Favorites, Back/Forward, maybe zoom buttons, History etc.

Philip Nienhuis <philipnienhuis>
Project Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #45530:  P1000779.JPG added by philipnienhuis (1MiB - image/jpeg)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by pantxo (Posted a comment)
  • -email is unavailable- added by ttl (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 7 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2018-12-16 ttl Severity3 - Normal => 2 - Minor
        Summary[GUI] Documentation pane could have a toolbar with Back, Forward, Bookmark and Zoom buttons => [GUI] Documentation pane could provide bookmarks
    2018-11-26 philipnienhuis Attached File- => Added P1000779.JPG, #45530
    2018-11-25 philipnienhuis Attached File- => Added Doc_pane_buttons.PNG, #45525
    2018-11-04 ttl StatusNone => In Progress
        Assigned toNone => ttl
    2018-11-02 philipnienhuis Summary[GUI] Documentation pane couldhave a toolbar with Back, Forward, Bookmark and Zoom buttons => [GUI] Documentation pane could have a toolbar with Back, Forward, Bookmark and Zoom buttons

    Back to the top


    Powered by Savane 3.5