[kde-doc-english] khelpcenter inclusion procedure?

[Lauri Watts]

On Sunday 11 April 2004 09.59, Thomas Jones wrote:
> Hello all,
>
> I have scoured the archives; but am unable to find the answer to a problem
> that i have. I ahve been learning Docbook/XML/XSL etc... and have
> constructed a "Handbook" based on the KDE specifications. Which BTW ...
> looks very good!!!!
>
> Now that i have a good --- probably invalid --- document; i wanted to
> include them in the KDE Help Center docs. But everything is not working
> correctly/as expected. I am using SuSE 9.0 Professional so my paths my
> differ from default.

The first thing is, make them valid.  They almost certainly won't display at 
all if they're not, no matter what you do :)  Start there, while you're 
answering my other questions.  You can use our app 'checkXML' to do this, and 
don't panic if you have a million errors on the first run, that's the nature 
of the beast, each initial syntax error cascades to produce hundreds more.  
Just fix the first one, run 'checkXML index.docbook' again, and repeat until 
there are no more.

1: Are you writing a KDE based application, which you will be distributing, 
and wish to install a handbook, just like any other KDE application?

1a: If yes to this, are you using the standard KDE based build system (the 
admin/ dir, our normal autoconf and automake setup, etc)

Or,
2: Are you writing a non-KDE based application which you will be distributing 
and wish the help manual for it to be available in KHelpcenter? (In which 
case, I will assume you are not using the usual KDE build system)

Or,
3: Are you just trying to get some local documentation on your own computer to 
display in KHelpCenter, and don't care about distribution issues?

If 1 and 1a are true, then, 
assuming the top level of your application sources are in a folder 'osiris', 
put your (valid) docbook file in osiris/doc with a Makefile.am containing: 

KDE_LANG = en
KDE_DOCS = AUTO

and a line in the osiris.desktop file (ie, the one that runs the app)
DocPath=osiris/index.html

Everything will be taken care of for you.

if 2: is true, then there's a whole lot more work to do, 

if 3: is true, then you need to do the following:
figure out where the rest of KDE documentation is (check if $KDEDIR or 
$KDEDIRS is set, find the share/HTML/<lang>/<appname>/ directories)

Run 'meinproc --check --cache index.cache.bz2 ./index.docbook'

make a directory: $KDEDIR(S)/share/doc/HTML/en/osiris/
copy the index.cache.bz2 file and the index.docbook file there

Make a line in your .desktop file, saying
DocPath=osiris/index.html

Drop this .desktop file in $KDEDIR/share/apps/khelpcenter/plugins
and rerun khelpcenter, your manual will be available, but in the top level of 
the tree, not in the applications manual.

To get it into the applications manual, you'll need to add it to the K menu 
(using kmenuedit), then find the relevant .desktop file (in 
~/.kde/share/applnk I guess) and edit it in an editor to add the DocPath 
line)

Regards,
-- 
Lauri Watts
KDE Documentation: http://i18n.kde.org/doc/
KDE on FreeBSD: http://freebsd.kde.org/
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: signature
Url : http://mail.kde.org/pipermail/kde-doc-english/attachments/20040413/002c61dd/attachment.sig