<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd"><html><head><meta name="qrichtext" content="1" /><style type="text/css">p, li { white-space: pre-wrap; }</style></head><body style=" font-family:'Sans Serif'; font-size:10pt; font-weight:400; font-style:normal;">On lundi 08 décembre 2008 12:37:28 tic wrote:<br>
> I just started breeding over the kmail handbook and got stuck almost<br>
> immediately when I compared the template docbook with my index.docbook.<br>
><br>
> 1) The kmail handbook is split into multiple files by chapter at the<br>
> moment. From the comments in the template I gather that the entire<br>
> documentation should be in one single file. I reckon I should merge those<br>
> files together in the end?<br>
you can have several .docbook files for clarity.<br>
In your index.docbook simply add<br>
<!ENTITY foo SYSTEM "foo.docbook"><br>
in the header<br>
and then <br>
&foo; into the doc body<br>
where this foo.docbook will be a chapter for ex<br>
<p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; -qt-user-state:0;"><br></p>When you call &foo; the whole foo.docbook will be included magically by the script.<br>
<p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; -qt-user-state:0;"><br></p>> 2) I got this list of ENTITY declarations which also doesn't seem to be<br>
> encouraged in the policies. What is the suggested method to clean all that<br>
> up?<br>
><br>
> <-- snip<br>
><br>
> <!ENTITY kappname "&kmail;"><br>
> <!ENTITY package "kdepim"><br>
> <!ENTITY kmail-intro SYSTEM "intro.docbook"><br>
> <!ENTITY kmail-getting-started SYSTEM "getting-started.docbook"><br>
> <!ENTITY kmail-using-kmail SYSTEM "using-kmail.docbook"><br>
> <!ENTITY kmail-configure SYSTEM "configure.docbook"><br>
> <!ENTITY kmail-menus SYSTEM "menus.docbook"><br>
> <!ENTITY kmail-faq SYSTEM "faq.docbook"><br>
> <!ENTITY kmail-importing SYSTEM "importing.docbook"><br>
> <!ENTITY kmail-credits-and-licenses SYSTEM<br>
> "credits-and-licenses.docbook"> <!ENTITY % addindex "IGNORE"><br>
> <!ENTITY % English "INCLUDE" > <!-- change language only here --><br>
> <!ENTITY html "<acronym>HTML</acronym>"><br>
> <!ENTITY gpg "<application>GPG</application>"><br>
> <!ENTITY gpgsm "<application>GpgSM</application>"><br>
> <!ENTITY mdn "<acronym>MDN</acronym>"><br>
> <!ENTITY acl "<acronym>ACL</acronym>"><br>
> <!ENTITY imap "<acronym>IMAP</acronym>"><br>
> <!ENTITY nntp "<acronym>NNTP</acronym>"><br>
> <!ENTITY openpgp "<acronym>OpenPGP</acronym>"><br>
> <!ENTITY smime "<acronym>S/MIME</acronym>"><br>
> <!ENTITY kolab "<acronym>Kolab</acronym>"><br>
><br>
> <-- snap<br>
the first are the .docbook as I tried to explain above, this is encouraged as when the doc is big, it adds clarity.<br>
Acronyms are only OK in a doc if they are not translatable.<br>
<p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; -qt-user-state:0;"><br></p>It's prefered that they are in kdelibs and used globally in all apps. <br>
> Thanks for the help<br>
> Manfred<br>
Thanks for getting into this!<br>
<p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; -qt-user-state:0;"><br></p>Anne-Marie<br>
aka annma :)<br>
> --<br>
> tictric@jabber.ccc.de<br>
> _______________________________________________<br>
> kde-doc-english mailing list<br>
> kde-doc-english@kde.org<br>
> https://mail.kde.org/mailman/listinfo/kde-doc-english<br>
<p style="-qt-paragraph-type:empty; margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px; -qt-user-state:0;"><br></p></body></html>