From kde-doc-english  Mon Apr 12 22:42:22 2004
From: Lauri Watts <lauri () kde ! org>
Date: Mon, 12 Apr 2004 22:42:22 +0000
To: kde-doc-english
Subject: Re: [kde-doc-english] khelpcenter inclusion procedure?
Message-Id: <200404130042.28132.lauri () kde ! org>
X-MARC-Message: https://marc.info/?l=kde-doc-english&m=108180976206982
MIME-Version: 1
Content-Type: multipart/mixed; boundary="--===============0678814576=="


--===============0678814576==
Content-Type: multipart/signed; protocol="application/pgp-signature";
	micalg=pgp-sha1; boundary="Boundary-02=_TtxeA/nqPiMPEtm";
	charset="iso-8859-1"
Content-Transfer-Encoding: 7bit


--Boundary-02=_TtxeA/nqPiMPEtm
Content-Type: text/plain;
  charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline

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 a=
t=20
all if they're not, no matter what you do :)  Start there, while you're=20
answering my other questions.  You can use our app 'checkXML' to do this, a=
nd=20
don't panic if you have a million errors on the first run, that's the natur=
e=20
of the beast, each initial syntax error cascades to produce hundreds more. =
=20
Just fix the first one, run 'checkXML index.docbook' again, and repeat unti=
l=20
there are no more.

1: Are you writing a KDE based application, which you will be distributing,=
=20
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=
=20
admin/ dir, our normal autoconf and automake setup, etc)

Or,
2: Are you writing a non-KDE based application which you will be distributi=
ng=20
and wish the help manual for it to be available in KHelpcenter? (In which=20
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=20
display in KHelpCenter, and don't care about distribution issues?

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

KDE_LANG =3D en
KDE_DOCS =3D AUTO

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

Everything will be taken care of for you.

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

if 3: is true, then you need to do the following:
figure out where the rest of KDE documentation is (check if $KDEDIR or=20
$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=3Dosiris/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=20
the tree, not in the applications manual.

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

Regards,
=2D-=20
Lauri Watts
KDE Documentation: http://i18n.kde.org/doc/
KDE on FreeBSD: http://freebsd.kde.org/

--Boundary-02=_TtxeA/nqPiMPEtm
Content-Type: application/pgp-signature
Content-Description: signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (FreeBSD)

iD8DBQBAextT/gUyA7PWnacRArDRAJ0bR8ofBaJeer/YSRLvsPd6qbNXJwCggj99
gJzs1DE0bW3FtVKZg70/gZI=
=XBnl
-----END PGP SIGNATURE-----

--Boundary-02=_TtxeA/nqPiMPEtm--

--===============0678814576==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
kde-doc-english mailing list
kde-doc-english@kde.org
https://mail.kde.org/mailman/listinfo/kde-doc-english

--===============0678814576==--