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

List:       kde-commits
Subject:    www/areas/koffice/getinvolved
From:       Raphael Langerhorst <raphael.langerhorst () kdemail ! net>
Date:       2005-11-11 15:44:02
Message-ID: 1131723842.477305.14677.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 479738 by raphael:

Update website sections regarding documentation writing (including an additional doc \
JJ)

CCMAIL: annma@kde.org


 M  +8 -0      doc-writers.php  
 M  +25 -2     howto-write-doc.php  


--- trunk/www/areas/koffice/getinvolved/doc-writers.php #479737:479738
@@ -8,6 +8,7 @@
     <p>January 2006 targets</p>
 <p>It is prefered to use KOffice svn trunk code to work on JJ, which is the next \
coming 1.5 release. You can find some information on how to build it on the <a \
href="../download/unstable.php">Install KOffice unstable from svn page</a>.</p>  \
<p><a href="mailto:raphael.langerhorst@kdemail.net">Raphael Langerhorst</a> is the \
documentation coordinator for KOffice documentation.</p> +<p>Information on how to \
write KOffice documentation can be found <a href="howto-write-doc.php">here</a>.</p>  \
  <p>
 <table cellspacing="0" cellpadding="3" border="1">
@@ -17,6 +18,13 @@
     <th>Date Target</th>
     <th>Name of Applicant</th>
   </tr>
+  <tr>
+    <th>Update application startup instructions in all handbooks with
+        respect to the new KOffice startup dialog. Especially screenshots!</th>
+    <th><a href="mailto:raphael.langerhorst@kdemail.net">Raphael \
Langerhorst</a></th> +    <th>20th December 2005</th>
+    <th>-</th>
+  </tr>
 </table>
 
 <p>If you want to take a JJ, please email your name to the contact and CC to <a \
href="mailto:annemarie.mahfouf@free.fr">Anne-Marie</a> so the task can be assigned to \
                you.<br />
--- trunk/www/areas/koffice/getinvolved/howto-write-doc.php #479737:479738
@@ -5,16 +5,39 @@
   include("header.inc");
 ?>
 
-<p>Here are some tips about your editor.
+<h2>Here you find Information on how to write KOffice documentation</h2>
 
+<p><a href="mailto:raphael.langerhorst@kdemail.net">Raphael Langerhorst</a>
+coordinates KOffice documentation work, please contact him for any
+questions or feedback.</p>
+
+<h3>KOffice Documentation Cookbook</h3>
+
+<p>A cookbook for writing KOffice documentation including long term plans
+is currently being prepared and will be available here when it is ready,
+contact Raphael if you want a preliminary version.</p>
+
+<h3>Tips and Tricks</h3>
+
+<p>Here are some tips about your editor:
+
 <ul>
     <li>set your editor to wrap lines at 80 characters</li>
     <li>open and save as utf8 in your editor</li>
     <li>choose the docbook syntax highlighting</li>
 </p>
 
-<p>Screenshots: theme, style and color in KControl</p>
+<p>Screenshots: theme, style and color can be set in KControl.
+Please use KDE defaults as much as possible for consistent screenshots.</p>
 
+<h3>Information on KDE Documentation</h3>
+
+<p>You can find a lot of information on how to write KDE documentation at
+<a href="http://i18n.kde.org/sitedoc.html">http://i18n.kde.org/sitedoc.html</a>
+<br />All KDE documentation guidelines found there also apply for
+KOffice documentation unless stated otherwise here or in the KOffice
+Documentation Cookbook (soon to be available).</p>
+
 <br />
  <br />
  <hr width="30%" align="center" />


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