This forum has been archived. All content is frozen. Please use KDE Discuss instead.

[SOLVED] HowTo write KDE application manual (Handbook) for custom application??

Is the KDE Documentation Primer outdated?

Yes
100%
No
No votes

Total votes : 1


Tags: None
(comma "," separated)
twoflower
Registered Member
Posts
4
Karma
0
:lightbulb::lightbulb:

Hi,

-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.

>>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 installation, from cmake?


Thanx,:-[
User avatar
bcooksley
Administrator
Posts
19765
Karma
87
OS
@twoflower: When posting to KDE mailing lists, please include the entire text of your problem with that mail, not just a link to the forum thread.


KDE Sysadmin
[img]content/bcooksley_sig.png[/img]
twoflower
Registered Member
Posts
4
Karma
0
Does anyone have any answers to any my questions?

Last edited by twoflower on Mon May 18, 2009 12:37 pm, edited 1 time in total.
User avatar
bcooksley
Administrator
Posts
19765
Karma
87
OS
Unfortunately, it is not easy to write Handbooks. KDE Handbooks are stored in the DocBook format, so you may be able to find some documentation online.


KDE Sysadmin
[img]content/bcooksley_sig.png[/img]
twoflower
Registered Member
Posts
4
Karma
0
Thanks, as you know online is like the big black hole - too much noise - no real info.
twoflower
Registered Member
Posts
4
Karma
0
> -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?
>
in documentation dir add a CMakeLists.txt with:
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?
Add these entries to appname.desktop:
X-DocPath=appname/index.html
Categories=Qt;KDE;category_of_your_app;


Bookmarks



Who is online

Registered users: Bing [Bot], Google [Bot], Sogou [Bot]