[Octave-bug-tracker] [bug #55509] pkg load: automatically register QHelp files with doc browser

[Andrew Janke]

URL:
  <https://savannah.gnu.org/bugs/?55509>

                 Summary: pkg load: automatically register QHelp files with
doc browser
                 Project: GNU Octave
            Submitted by: apjanke
            Submitted on: Fri 18 Jan 2019 05:11:30 PM UTC
                Category: GUI
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Feature Request
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: Any

    _______________________________________________________

Details:

Hi, Octave folks,

What do you think about having "pkg load" automatically detect and register
QHelp collection files for the packages with the doc browser? This would allow
Octave to automatically display manuals for the packages in the doc browser
along with the main Octave manual. I think this would be convenient.

Patch to do so attached.

This approach assumes that each package defines a single QHelp collection
named <package>.qch in its doc/ directory. For an example of a package that
does this, along with scripts to generate the .qch file, see my in-progress
Chrono package:
https://github.com/apjanke/octave-addons-chrono/tree/0ba2e3f860882752931ebfda85daeb965655d74e/doc.



    _______________________________________________________

File Attachments:


-------------------------------------------------------
Date: Fri 18 Jan 2019 05:11:30 PM UTC  Name:
pkg-auto-register-qhelp-files.patch  Size: 4KiB   By: apjanke

<http://savannah.gnu.org/bugs/download.php?file_id=46012>
-------------------------------------------------------
Date: Fri 18 Jan 2019 05:11:30 PM UTC  Name: octave-pkg-load-with-qhelp.gif 
Size: 901KiB   By: apjanke

<http://savannah.gnu.org/bugs/download.php?file_id=46013>

    _______________________________________________________

Reply to this item at:

  <https://savannah.gnu.org/bugs/?55509>

_______________________________________________
  Message sent via Savannah
  https://savannah.gnu.org/