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

[Andrew Janke]

Follow-up Comment #2, bug #55509 (project octave):

Yeah, we could do this in the metadata. Perhaps add new lines for
"QHelpFiles:", "InfoFiles:", "PdfDocFiles:", each taking a comma-separated
list of files with no spaces in their names?

It's less clear to me what the structure for PDF, HTML, and other files should
be, since there's not an existing interaction mode for them in doc() or other
functions, as far as I know. Handling QHelp is pretty straightforward since
there's only one thing to do with it: register it with the QHelp browser. And
the QHelp file contains enough internal metadata for that to work smoothly.

Is DESCRIPTION the right place for this? That file seems to contain more
externally visible info about the package and its relationship to other
packages. Internal package structure info seems to live in INDEX and other
metadata files. Maybe a new FILES or METADATA file would be more appropriate?

Might also need to consider how the signature for "doc" interacts with this:
it looks like, in non-Qt Octave, doing "doc foo" searches the main Octave info
manual index for foo, if foo is not a function or class.

I couldn't find the other bug report.

    _______________________________________________________

Reply to this item at:

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

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