[kde-doc-english] khelpcenter inclusion procedure?

Thomas Jones thomas.jones at linux-howtos.com
Sun Apr 11 09:59:23 CEST 2004


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.

Here is what i have done:

1) Placed my converted docs under the "/usr/share/doc/packages/osirismd/
userhandbook" directory.

2) Created a userhandbook.en.desktop file under the "/opt/kde3/share/apps/
khelpcenter/plugins/" directory. It contains the following data:

<snip>
[KDE Desktop Entry]
DocPath=/usr/share/doc/packages/osirismd/userhandbook/index.html
Name=Osiris User's Handbook
X-DOC-Weight=-2000
</snip>

3) Created the "/usr/share/susehelp/meta/Osiris/Handbooks/" directory; and a 
userhandbook.en.desktop file again. I'm not sure why this is so ----- but i 
followed another userguide for guidance. it contains:

<snip>
[Desktop Entry]
Name=Osiris User's Handbook
Comment[en]=Introduction, Installation, and Configuration. Host Integrity - 
for the Newbie.
DocPath=help:/khelpcenter/userhandbook/index.html
X-DOC-SearchMethod=htdig
X-DOC-SearchEnabledDefault=true
X-DOC-Weight=-2000
</snip>

If I change the above DocPath to the actual html path "/usr/share/doc/
packages/osirismd/userhandbook/index.html" it shows the documentation; but 
without the KDE style being applied. Not really what I wanted .... I chose 
KDE because it looks good.

4) I noticed that there were docbook files located in the "/opt/kde3/share/
doc/HTML/en/khelpcenter" directory. So i went ahead and made a "userhandbook" 
directory here. And placed all my Docbook sources within it. Not sure why 
either ---- just following along with what was there.

So what IS the proper way to include documentation???? Thanks so much for your 
help. Hopefully I can get better at this, so as to provide some help to KDE 
in the future. Thanks again.

Just a beginner trying to scrap by on limited experience!!!!!
;)
Thomas




More information about the kde-doc-english mailing list