Re: GNOME Help Method

[infirit <infirit gmail com>]

Op 02/14/2017 om 11:29 PM schreef Sascha Manns:
> actually i'm working on a new GNOME-App.
> The codebase is already done. Now i would like to implement a small
> method, which launches yelp with the installed apps helpfiles.
> The app is prepared in Mono with Gtk-Sharp. 
> Maybe anyone can help me with a C# method for the help system?

Short answer, you launch a help:// uri and have it handled by whatever
provides a desktop file for the uri, typically this is yelp.

Longer answer, The docs are either in docbook (not recommended these
days) or mallard format installed in <distro docdir>/yourappname [1].
Then have your app launch the uri relative to the docdir [2]. If you
want to integrate this with your autotools build system see [3]. Several
tools are available to help you create and edit the pages [4].

~infirit


[1] this is typically /usr/share/doc
[2] example uri help://yourappname
[3] https://wiki.gnome.org/Apps/Yelp/Tools/yelp.m4
[4] https://wiki.gnome.org/Apps/Yelp/Tools