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

List:       kde-commits
Subject:    www/areas/extragear/home
From:       Gaƫl de Chalendar <kleag () free ! fr>
Date:       2006-09-02 9:55:42
Message-ID: 1157190942.893952.23470.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 579983 by kleag:

Updated the extragear documentation

 M  +46 -18    docs.php  


--- trunk/www/areas/extragear/home/docs.php #579982:579983
@@ -19,8 +19,8 @@
 Please also note that
 <ul>
 <li>Unmaintained apps will be removed eventually.</li>
-<li>If you want regular releases, you need release your program yourself, there
-will be an extragear package per module on each kde release, including only
+<li>If you want regular releases, you need release your program yourself</li>
+<li>There will be an extragear package per module on each kde release, including \
only  applications that have stable tag and compiles against KDE release. The
 extragear maintainer will do this part.</li>
 </ul>
@@ -35,7 +35,7 @@
 <li>Subscribe yourself to the <a
   href="http://mail.kde.org/mailman/listinfo/kde-extra-gear">mailing
   list</a>.</li>
-<li>Add your application to the website.</li>
+<li>Add your application to the website (see below).</li>
 </ul>
 <br>
 
@@ -43,18 +43,52 @@
 <ul>
 <li><b>BEFORE FIRST IMPORT:</b> Verify that your code is usable and compiles against \
the latest stable KDE release, otherwise the addition will be rejected. </li>  \
<li>Authors are expected to keep their release info up to date and to define freeze \
                periods and release dates. </li>
-<li>Authors must provide a TAG called stable ( lower case ) on
+<li>For your application to be included in the next extragear realease, you must 
+provide a TAG called stable ( lower case ) on
 tags/stable/extragear/&lt;KEG-MODULE&gt;/&lt;yourapp&gt;, which will be pointing to
-the latest stable code on repository. If you prefer have a stable BRANCH, please \
                remember to always update tags pointing to this branch.</li>
-<li>Translations will be available on i10n/&lt;LANG&gt;/&lt;KEG-MODULE&gt;</li>
-<li>Authors must provide a text file called APPINFO providing the current version, \
                small description and full description in english using this format: \
                </li>
-<br><br>
-Version: 0.x.x.x<br>
-SmallDescription: small one line description talking about apps<br>
-Description: Full description about your apps<br>
-<br><br>
+the latest stable code on repository. If you prefer have a stable BRANCH, please 
+remember to always update tags pointing to this branch.</li>
+<li>Translators will be able to work on your program strings after the execution 
+of the daily script <i>skripty</i>, but only if you provide the adequate 'messages' 
+target in your Makefile.am (see another KEG application for an example). 
+Translations will then be available in i10n/&lt;LANG&gt;/&lt;KEG-MODULE&gt;.</li>
+<li>If you wrote one, put the handbook of your application in 
+trunk/extragear/&lt;KEG-MODULE&gt;/doc/&lt;yourapp&gt;/</li>
+<li>To allow the translation of the handbook, you can put manualy the handbook 
+strings in trunk/l10n/templates/docmessages/&lt;KEG-MODULE&gt;/. To extract the
+strings, use the tool <i>xml2pot</i> from the kdesdk module (probably already \
installed +on your system).</li>
 </ul>
 
+<h2>Add your app to the website</h2>
+Now, this one is really easy. Ask access for the www/areas/extragear, create a \
&lt;yourapp&gt;.xml file and a &lt;yourapp&gt; subdirectory in the directory apps (it \
is easiest to copy one of the existing +files and modify it accordingly) and then add \
your application to the file +inc/appinfo.inc :
+<ul>
+<li>&lt;yourapp&gt;.xml should provide the current version, small description, etc. \
using this format:  +<pre>
+&lt;?xml version='1.0' ?&gt;
+&lt;kegapp&gt;
+        &lt;app&gt;
+                &lt;title&gt;YourApp&lt;/title&gt;
+                &lt;type&gt;KegModule&lt;/type&gt;
+
+                &lt;stable&gt;x.y.z&lt;/stable&gt;
+                &lt;smalldescription&gt;
+                  YourApp is an app doing what you can except from such an app.
+                &lt;/smalldescription&gt;
+        &lt;/app&gt;
+&lt;/kegapp&gt;
+</pre>
+This file should be placed in trunk/www/areas/extragear/apps or submitted to the 
+extragear maintainer for addition. 
+</li>
+<li>the &lt;yourapp&gt; directory will contain a long description, or even a 
+full web site about your application. It should also be placed in 
+trunk/www/areas/extragear/apps. See another extragear application for an example.
+</li>
+</ul>
+
 <h2>Do Release Preparations</h2>
 What to do when you plan to do a release.
 <ul>
@@ -63,12 +97,6 @@
 about i10n freeze. </li>
 </ul>
 
-<h2>Add your app to the website</h2>
-Now, this one is really easy. Ask access for the www/areas/extragear, create a xml \
                file and subdirectory 
-for your app in the directory apps (it is easiest to copy one of the existing
-files and modify it accordingly) and then add your application to the file
-inc/appinfo.inc .
-
 <?php
   include 'footer.inc';
 ?>


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

Configure | About | News | Add a list | Sponsored by KoreLogic