Docs packaging

[Thomas Jones]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On Wednesday 24 August 2005 19:29, Mark Johnson wrote:
> I'd also like to second Dave Malcolm's suggestion about packaging the
> xml sources so they register in both gnome & kde help systems. (Caveat,
> I know how the yelp system works in this regard, but am completely
> ignorant of the kde doc/help registration.) I do know that it's not at
> all difficult to package xml source files so that they show up in yelp.
>

Introduction of content into the kde help center application is awkward at 
best.

The entire kde docbook sources are all located in ${kdedir}/share/doc/HTML/en. 
Within the root folder of each application are the docbook source, a cache of 
the generated presentation files and a symbolic link to the global files for 
all kde documentation --- aptly named "common". This is the default location 
for the content presented by the khelpcenter application.

The only difficulty I had in the whole process is generating the cache file. 
Admittedly, I had a heck of a time figuring this one out --- even with the 
help of google. HINT-HINT: Utilize the meinproc binary with the --cache 
<file> option.
;)

Introduction of the content(naming scheme, icon, etc..) into the tree view of 
the khelpcenter application is performed via a .desktop file located in the 
proper directory.  If you do not choose to place the documentation in the 
${kdedir}/share/doc/HTML/en; then a .desktop configuration file must be used 
to tell the application where the actual content is housed 
- --- /usr/share/doc/packages maybe.

Then at any time a user can access the new content from the khelpcenter 
application, through either the konqueror web browser, or via the konqueror 
file management interface. All three avenues can be quickly navigated via the 
"help" kioslave.

That's kde --- gnome --- you got me! ;)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (GNU/Linux)

iD8DBQFDDR4UoR5cE1e/kEIRAsGFAJ4xYelK7I39LYWJ1Zys81FlgWH3CgCeKUqA
g3DtPBa0UJ+ibzAyVF40wfs=
=vxSx
-----END PGP SIGNATURE-----