Re: How to integrate local help topics in system wide help?

[Jiro Matsuzawa <jmatsuzawa gnome org>]

Hmm... it seems that you cannot insert your own help into Tomboy's helps,
but I'm not sure about that. On the other hand, Tomboy's help can be referred
to from your help. In the following case,
On Sat, May 11, 2013 at 7:46 PM, Luc Pionchon <pionchon luc gmail com> wrote:
> For a new help document:
>
> $HOME/.local/share/help/C/my-own-guide/index.page
>                           ^^^^^^^^^^^^
> ------------------------------------------------------------------------
> <page xmlns="..."
>       type="guide"
>       id="index">
> (...)
>   <p><link xref="help:gnote"/> </p>
>   <p><link xref="help:gnome-help"/></p>
>   <p><link xref="help:tomboy"/> fails </p>
> ------------------------------------------------------------------------
>
> ==> will appear in the "All Help Documents" page
>
> - we can link to other documents.
>   (Some failed, I am not sure which xref should be used)
Tomboy's helps are located in /usr/share/gnome/help/tomboy. The path is not
/usr/share/help but /usr/share/gnome/help. In this case, the "help:" URI scheme
won't work well. You need to refere to them with the "ghelp:" scheme.
Try the following URIs:
* For tomboy help, <link xref="ghelp:tomboy"/>
* For my-own-guide, <link xref="help:my-own-guide"/>


> > Help tools including yelp respect the XDG Help Specification [1] and XDG
> > Base Directory Specification [2]. See the documents for details.
> >
> > [1] http://www.freedesktop.org/wiki/Specifications/help-spec
>
> (it is a docbook XML document, not very friendly to read)

Yes, it's a docbook. I read it with yelp :)


--
Jiro Matsuzawa
E-mail:
 jmatsuzawa gnome org
 matsuzawa jr gmail com
GPG Key ID: 0xECC442E9
GPG Key Fingerprint: E086 C14A 869F BB0E 3541 19EB E370 B08B ECC4 42E9