Writing a Help File?

Amichai Rotman amichai at iglu.org.il
Sun May 10 16:38:19 UTC 2015


Thanks a bunch!

2015-05-08 22:29 GMT+03:00 sktsee <sktseer at gmail.com>:

> On Fri, 08 May 2015 15:11:06 +0300, Amichai Rotman wrote:
>
> > Hi All,
> >
> > I'd like to create a manual in the form of a Help file (like the one
> > that opens when I press F1 in Ubuntu).
> >
> > I could't find any documentation for it - there's no 'About' item in the
> > menu....
> >
> > Can someone point me to a guide for creating Help files?
> >
> > Thanks!
> >
>
> http://www.freedesktop.org/wiki/Specifications/help-spec/help-system-
> spec.xml
>
> Load the above file in yelp, or whatever your favorite xml viewer is.
>
> Yelp (the help viewer) can view Docbook, (X)HTML, Mallard, or manpage
> documentation. Supposedly it can also view GNU info pages, but on my
> system it simply hangs when trying to load an info page. You'll probably
> want to install the packages "gnome-doc-utils" and "yelp-tools" and read
> the documentation that comes with them.
>
> Also, you can go to projectmallard.org to familiarize yourself with the
> Mallard markup language since it looks like it is the default for writing
> Ubuntu and GNOME help files.
>
> --
> sktsee
>
>
> --
> ubuntu-users mailing list
> ubuntu-users at lists.ubuntu.com
> Modify settings or unsubscribe at:
> https://lists.ubuntu.com/mailman/listinfo/ubuntu-users
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/ubuntu-users/attachments/20150510/c4c15f3f/attachment.html>


More information about the ubuntu-users mailing list