User help

From Buzztard

Jump to: navigation, search

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

concept

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.

buzz

Buzz just tries to load <dllname>.{html,htm,txt}.

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 :(

Future ideas

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:

Support Us

Collaboration

SourceForge Logo
GStreamer Logo
Become a Friend of GNOME
Linux Sound Logo
MediaWiki
Valgrind
GNU Library Public Licence
GNU Free Documentation License 1.2