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

List:       kde-commits
Subject:    www/areas/edu/doc
From:       Anne-Marie Mahfouf <annma () kde ! org>
Date:       2004-08-24 13:19:13
Message-ID: 20040824131913.4CA0226E8 () office ! kde ! org
[Download RAW message or body]

CVS commit by annma: 

update


  A            edu-template.docbook   1.1
  M +12 -5     index.php   1.2


--- www/areas/edu/doc/index.php  #1.1:1.2
@@ -9,7 +9,10 @@
 
  <ul>
-  <li>use the template (see below)</li>
+  <li>use the special edu template (see below)</li>
  <li>split your index.docbook file into different entities (example)</li>
- <li>make screenshots in the Keramik style, keramic color</li>
+ <li>make screenshots in the Keramik style, Keramic color</li>
+ <li>try to find a English native that will proof-read your doc and adjust the \
terms. You an ask the Quality Team for + that. If your application is related to a \
specialized field such as Chemistry or Mathematics, try to find someone with the + \
required knowledge.</li>  </ul>
 
@@ -19,9 +22,13 @@
  <h2>Template</h2>
 
- <p></p>
+ <ul>
+ <li>The edu template is based on the usual KDE Handbook template. Some sections had \
been added to suit our needs.</li>  
-<p></p>
+<li>Download the <a href="edu-template.docbook">template</a>. Put it in your local \
folder and rename it <tt>index.docbook</tt></li>  
- <p></p>
+ <li>Fill the relevant chapters and remove all unneeded ones.</li>
+ <li>Run the English spell-checker</li>
+ <li>Run <tt>meinproc index.docbook</tt> from the console using the latest kdelibs \
to check if your doc is correctly parsed.</li> +</ul>
 
  <h2>Links</h2>


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