From kde-devel  Sat May 23 16:15:32 2009
From: David Jarvie <djarvie () kde ! org>
Date: Sat, 23 May 2009 16:15:32 +0000
To: kde-devel
Subject: Re: HowTo write KDE application manual (Handbook) for custom
Message-Id: <200905231715.33255.djarvie () kde ! org>
X-MARC-Message: https://marc.info/?l=kde-devel&m=124309536510233

On Wednesday 20 May 2009 10:00:17 L Pierre wrote:
> Hi,
>
> -Our application is developed outside of KDE's subversion repository.
>
> -We have a custom/home written KDE4 application. I'm trying to add our
> application manual/hanbook using the KDE suggestions to do this.
>
> -Following http://l10n.kde.org/docs/ which is very KDE-bundled-applications
> only centric, I used the dockbook template, edited it adding our
> application specifics and created html using meinproc4 as suggested. All
> works fine.
>
> -I drawn up the index.docbook handbook for our application.
>
> >>Now, how do I add this under the KDE Help Centre so that our
> >> application's handbook gets displayed and made accessible from here?
> >>
> >>Is there any tools to do this or is this a tedious manual process?
> >>
> >>How do KDE do it from all their bundled applications?
> >>
> >>Can this be specified, to be added during the application
> >> build/installation, from cmake?

The following cmake command will install the English version of the handbook. 
Substitute other language codes for 'en' to install other languages.

kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en 
SUBDIR appname)

> >>How do I get our handbook catalogued under application manuals into the
> >> KHelpCenter?

I suspect this is specified in the .desktop file for the application, but I 
may be wrong.
-- 
David Jarvie.
KAlarm author and maintainer.
http://www.astrojar.org.uk/kalarm
 
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<