[kde-doc-english] kde-docbook conventions

tic tic at tictric.net
Mon Dec 8 12:37:28 CET 2008


I just started breeding over the kmail handbook and got stuck almost 
immediately when I compared the template docbook with my index.docbook.

1) The kmail handbook is split into multiple files by chapter at the moment. 
From the comments in the template I gather that the entire documentation 
should be in one single file. I reckon I should merge those files together in 
the end?

2) I got this list of ENTITY declarations which also doesn't seem to be 
encouraged in the policies. What is the suggested method to clean all that up?

<-- snip

  <!ENTITY kappname "&kmail;">
  <!ENTITY package "kdepim">
  <!ENTITY kmail-intro SYSTEM "intro.docbook">
  <!ENTITY kmail-getting-started SYSTEM "getting-started.docbook">
  <!ENTITY kmail-using-kmail SYSTEM "using-kmail.docbook">
  <!ENTITY kmail-configure SYSTEM "configure.docbook">
  <!ENTITY kmail-menus SYSTEM "menus.docbook">
  <!ENTITY kmail-faq SYSTEM "faq.docbook">
  <!ENTITY kmail-importing SYSTEM "importing.docbook">
  <!ENTITY kmail-credits-and-licenses SYSTEM "credits-and-licenses.docbook">
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY html "<acronym>HTML</acronym>">
  <!ENTITY gpg "<application>GPG</application>">
  <!ENTITY gpgsm "<application>GpgSM</application>">
  <!ENTITY mdn "<acronym>MDN</acronym>">
  <!ENTITY acl "<acronym>ACL</acronym>">
  <!ENTITY imap "<acronym>IMAP</acronym>">
  <!ENTITY nntp "<acronym>NNTP</acronym>">
  <!ENTITY openpgp "<acronym>OpenPGP</acronym>">
  <!ENTITY smime "<acronym>S/MIME</acronym>">
  <!ENTITY kolab "<acronym>Kolab</acronym>">

<-- snap

Thanks for the help
Manfred

--
tictric at jabber.ccc.de



More information about the kde-doc-english mailing list