[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-devel
Subject:    Re: KIO: Redirection, docs
From:       Lauri Watts <lauri () kde ! org>
Date:       2002-12-14 21:18:12
[Download RAW message or body]

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

On Saturday 14 December 2002 02:37, Michael Schuerig wrote:

> What's the right way to install docs for "3rd-party" KIO-slaves? All the
> docs for the KDE slaves are kept in
>
> $(kde_libs_htmldir)/$(KDE_LANG)/kioslave/
> /usr/local/kde/doc/HTML/en/kioslave/ (vanilla KDE ???)
> /usr/share/doc/HTML/en/kioslave/ (debian)
>
> The docs are not complete docbook books, but articles that are included
> in index.docbook in the same directory. Is there a way to cleanly hook
> into this?
>

At present there isn't, but you just reminded me to fix this before KDE 3.2, 
to work the same way the 

I would for the present write a normal standalone document, which installs to 
$KDEDIR/share/doc/HTML/en/locate/index.docbook, that would make it available 
with "help:/locate" at least.  

I will look at breaking them up into proper standalone documents the way we 
did with KControl - the rationale behind that move was precisely to allow 
third party kcontrol modules to hook directly into the help system, and to be 
able to mix and match the other modules outside of kdebase and still get the 
documentation installed correctly.

We could probably even make them (kioslave docs) more visible, with the new 
plugin architecture in KHelpCenter, hiding away in Kinfocenter isn't the most 
obvious place for most users to find the help at all, I fear.

Regards,
- -- 
Lauri Watts
KDE Documentation: http://i18n.kde.org/doc/
KDE on FreeBSD: http://freebsd.kde.org/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (FreeBSD)

iD8DBQE9+6AU/gUyA7PWnacRAimZAJ43rV0VSDMfJ+xuv+uFB9q0N3hZFwCcDnsH
aI14mlE+tY3vXKzSzyYXmr4=
=zGKt
-----END PGP SIGNATURE-----

 
>> Visit http://mail.kde.org/mailman/listinfo/kde-devel#unsub to unsubscribe <<
[prev in list] [next in list] [prev in thread] [next in thread]