Re: Yelp Help Browser

["Karl H. Beckers" <karl h beckers gmx net>]

> Date: Wed, 21 Nov 2007 22:25:29 +0100
> From: "Renata Mota" <reatamota gmail com>
> Subject: Yelp Help Browser
> To: gnome-doc-devel-list gnome org
> Message-ID:
> 	<2ca2aafb0711211325g6876302bod5fd35bd6036d679 mail gmail com>
> Content-Type: text/plain; charset="iso-8859-1"
> 
> Hi, I am new in linux and not understand much, if you can help me, thank
> you.
> I am using a version of debian and need to make a work that generate the
> file in the center of online help.
> Debian uses the YELP which is a standard browser, the Yelp uses SCROLLKEEPER
> that generates content for the documentation.
> I do not know how to create a file that appears when click F1 him, or that
> already open in the center for help.
> 
> Thanks in advanced, Renata!

Renata,

that's not smth. to answer in one sentence.
First you need to create your document in the docbook format. Once you
have that, you can test it by running "yelp
file://<path-to-your-xml-file".

If that works, you need to write your OMF files to provide scrollkeeper
with some metadata about your document. With my installation of
scrollkeeper (on ubuntu) there is some documentation about how to do
that. Read it with "yelp
file:///usr/share/scrollkeeper/doc/writing_scrollkeeper_omf_files/C/writing_scrollkeeper_omf_files.xml".

Then you may want to look at scrollkeeper_example2 for an example of
where to put those files and how to register them with scrollkeeper.

HTH,

Karl.