adding simple doc to producers.xml

diff --git a/etc/producer/producers.xml b/etc/producer/producers.xml
index 9b0bbd6..40ac5a8 100755 (executable)
--- a/etc/producer/producers.xml
+++ b/etc/producer/producers.xml
@@ -8,9 +8,16 @@
     - a feature archive
     - articles
     - media
+
+  please check the mir user's guide and developer's guide
+  for syntax
 -->  
 
 <producers>
+  <!-- this first section contains nodedefinitions -->
+  <!-- a nodedefinition is a sort of "function" that can be "called" later -->
+
+  <!-- FIXME: doc for the Language "function" ? -->
   <nodedefinition name="Language">
     <parameters>
       <string name="languagecondition" defaultvalue="code != 'ot'"/>
@@ -122,6 +129,11 @@
   </nodedefinition>
 
  
+  <!-- This second section contains actual producers that will appear  -->
+  <!-- on the admin->"Generate manually"->"advanced page"              -->
+
+  <!-- This producer generates html  pages, as well as media and video   -->
+  <!-- files for articles stored in the database.  -->
   <producer name="articles">
     <verbs>
       <verb name="changed" default="1">
@@ -198,6 +210,7 @@
     </body>
   </producer>  
 
+  <!-- generates the left column FIXME more doc?  -->
   <producer name="navigation">
     <verbs>
       <verb name="generate" default="1" description="generates the left column"/>
@@ -362,6 +375,7 @@
     </body>
   </producer>
   
+  <!-- generates the main html page (startpage) of an indymedia site  -->
   <producer name="startpage">
     <verbs>
       <verb name="generate" default="1" description="Generates the startpage"/>
@@ -391,6 +405,8 @@
     </body>
   </producer>  
   
+  <!-- Use rsync to copy static site to mirrors (only if requested   -->
+  <!-- in config file)  -->
   <producer name="synchronization">
     <verbs>
       <verb name="run" default="1" description="Synchronizes the publication site with the production site"/>