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

List:       kde-devel
Subject:    Re: new KDE Development book
From:       Brad Hards <bhards () bigpond ! net ! au>
Date:       2003-07-21 12:06:08
[Download RAW message or body]

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

On Mon, 21 Jul 2003 20:29 pm, Ralf Nolden wrote:
> I've been talking with clee on IRC this morning and I think actually we'll
> have more than one "book". We need one for C++, one for Qt and one for each
> library, starting with turning a Qt example program from the Qt book into a
> KDE program with QApplication -> KApplication and QSettings -> KConfig,
> tr() -> i18n(), all in the KDE Core book. Then comes DCOP, KDE UI, etc.
In DocBook, Books are collected into a Set. Why do it this way? So the id / 
idref links will work across Books. That is obviously very useful when you 
have links from KDE classes to Qt classes.

> The reason for this is also that this needs to be maintainable alongside
> any API changes and conceptual changes so a book per library seems to be
> the best solution.

OK. Here is a rough framework (which certainly doesn't work with DocBook - 
some content needed :)

Where does (for example) libkdepim API docs fit in here? What else is out 
there, and needs to be integrated into the KDE manual set?

<!DOCTYPE Set PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
]>

<Set>

<Book id="Cplusplus">

 <BookInfo>
  <Title>Programming with C++</>
 </BookInfo>

</Book>

<Book id="Qt">

 <BookInfo>
  <Title>Programming with Qt 3.2</>
 </BookInfo>

 <part><title>Qt Tutorial</title>
 </part>

 <part><title>The Qt API Reference</title>
 </part>

</Book>

<Book id="KDE">

 <BookInfo>
  <Title>Programming with KDE 3.2</>
 </BookInfo>

 <part><title>KDE Tutorial</title>
   <chapter><title>Learning KDE</title></chapter>

   <chapter><title>Internationalisation and Localisation</title></chapter>
 </part>

 <part><title>The KDE Cookbook</title>

 </part>

 <part><title>KDE Visual Dictionary</title>

 </part>

 <part><title>Specialised KDE Topics</title>
   <chapter><title>Extending the KDE Panel</title></chapter>

   <chapter><title>Programming KIO</title></chapter>

   <chapter><title>Creating a DCOP Interface</title></chapter>

   <chapter><title>Programming KParts</title></chapter>

   <chapter><title>Kiosk Mode support</title></chapter>
 </part>

 <part><title>KDE in other languages</title>
   <chapter><title>PyKDE - Python with KDE</title></chapter>
 </part>

 <part><title>The KDE Library API Reference</title>
 </part>

</Book>

<Book id="translating">

 <BookInfo>
  <Title>Translating documents with KDE Tools</>
 </BookInfo>

</Book>

<Book id="writingdocs">

 <BookInfo>
  <Title>Writing manuals, KDE Style</>
 </BookInfo>

 <part><title>KDE DocBook Author's Guide</title></part>

 <part><title>KDE Style Guide</title></part>

</Book>
</Set>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.0.7 (GNU/Linux)

iD8DBQE/G9cwW6pHgIdAuOMRArVbAJwIVg4I87vtrWBaaeA0EGDKKme1kwCdHY8L
rXtxJ8DIRDuFYgiYc32nU5Q=
=rZV4
-----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]