User help
From Buzztard
Buzz machines have usually help as html or plain-text files. Buzztard comes with a docbook manual. Under gnome we could invoke yelp directly (libgnome). On the other hand we'd like to embedd yelp in our tabs/view.
Contents |
[edit] concept
[edit] get help uri
- elements should implement the help interface to return the user docs URI
- yelp:///path/to/helpfile.xml
- file:///path/to/helpfile.html, file:///path/to/helpfile.pdf, ...
We can use gnome_url_show() from libgnome.
[edit] buzz
Buzz just tries to load <dllname>.{html,htm,txt}.
[edit] ladspa
README files can be found under
/usr/share/doc/packages/ladspa/ /usr/share/doc/swh-plugins/html/ladspa-swh.html
if at all. Unfortunately
/usr/share/ladspa/rdf/*.rdf
don't reference the help :(
[edit] Future ideas
[edit] embedd yelp/html viewer/evince
- we need to map the file-extension to a viewer
- we then need to embed the viewer into a tab/view
In the past embedding was done using bonobo (gnome & corba). Is this still the case?
links about embedding:
