From: grok <grok>
Date: Sat, 13 Aug 2005 15:21:36 +0000 (+0000)
Subject: working on doc
X-Git-Tag: LATEST_MERGED_1_1~113
X-Git-Url: http://erislabs.net/gitweb/?p=mir.git;a=commitdiff_plain;h=0a6cf77e25b805a67151fc8708c0e9421b03d347

working on doc
---

diff --git a/doc/developers-guide/introduction.xml b/doc/developers-guide/introduction.xml
index d3d2a618..9fcab14e 100755
--- a/doc/developers-guide/introduction.xml
+++ b/doc/developers-guide/introduction.xml
@@ -85,8 +85,7 @@ feeds  for the  global wire.
 <para>In the  admin web interface,  producers appear, for  example, on
 the admin->"Generate manually"->"advanced page": (they are called Tasks)</para>
 <para>
-Further information on producers may be found at XXX and in the javadoc 
-(classes Producer, NodedProducer, roducerNode...).
+More information on producers is available in  <xref linkend="producer_framework" />. 
 </para>
 	</glossdef>
 </glossentry>
@@ -169,7 +168,10 @@ Filters may be organized into groups for easier management.
   <glossterm>generator</glossterm>
     <glossdef>
 	  <para>
-A generator is an abstraction for a template engine. 
+A generator is an abstraction for a template (html template). 
+Calling the generator's <function>generate(outputFileWriter,keyValuePairs)</function> method
+will run the template engine on the template file
+and write an output html file.
 Different template engines are
 supported right now: 
 <ulink href="http://freemarker.sourceforge.net">freemarker</ulink> 
@@ -205,14 +207,15 @@ and these packages will probably be reorganized in future releases.
 	</glossdef>
 </glossentry>
 
-<glossentry id="bundle">
+<glossentry id="bundles">
   <glossterm>bundles</glossterm>
     <glossdef>
 	  <para>
-Bundles are key/value pairs in a text file, used for configuration
-and internationalization.
-Bundles  may be used to create a template for multiple languages. The
-language dependent aspects are stored in a properties file.
+A Bundle represents a set  key/value pairs stored in a ".properties"
+text  file.  Bundles  are used  for  internationalization (language
+translations)  and for  <glossterm linkend="configuration">configuration</glossterm>  files (config.properties and
+source/default.properties). 
+Bundles  may be used to create a template for multiple languages.
 </para>
 	</glossdef>
 </glossentry>
@@ -264,8 +267,6 @@ The <code>do</code> argument determines the method's name.
 So 
 <uri>http://somehost.org/mir/servlet/Mir?module=Comment&amp;do=list</uri>
 will call <function>ServletModuleComment.list()</function>.
-
-
       </para>
 	</glossdef>
 </glossentry>
@@ -277,7 +278,22 @@ will call <function>ServletModuleComment.list()</function>.
 	  <para>
 The media framework is quite old and will be thoroughly changed 
 in a future release.
-</para>
+      </para>
+	</glossdef>
+</glossentry>
+
+<glossentry id="configuration">
+  <glossterm>configuration</glossterm>
+    <glossdef>
+	  <para>
+Mir is configured through the 
+<filename>etc/config.properties</filename> file, which 
+overrides default values in 
+the 
+<filename>source/default.properties</filename> file.
+The key/value pairs are handled by 
+<glossterm linkend="bundles">bundles</glossterm>.
+      </para>
 	</glossdef>
 </glossentry>
 
diff --git a/doc/developers-guide/producers.xml b/doc/developers-guide/producers.xml
index d3b15a31..61d5ecde 100755
--- a/doc/developers-guide/producers.xml
+++ b/doc/developers-guide/producers.xml
@@ -1,4 +1,4 @@
-<chapter id="introduction">
+<chapter id="producer_framework">
 <title>The producer framework</title>
 Please read the presentation of the <glossterm linkend="producers">producers</glossterm> concept
 for an introduction.
@@ -142,6 +142,8 @@ and the <code>&lt;producer name="articles"&gt;</code> node.
 
   <para>
   <table border="1">
+    <title>Expressions</title>
+
     <tr><td>a string literal</td>       <td><code>'hello'</code></td></tr>
     <tr><td>a numeric literal</td>      <td><code>2138</code></td></tr>
 
@@ -166,6 +168,7 @@ is declared outside producer definitions.
   
     </para>
     <table border="1">
+    <title>Reference for producer node types and statements</title>
 
       <tr><td>Name</td>                       <td bgcolor="#eea8a8"><code>Set</code></td></tr>
       <tr><td>Purpose</td>                    <td>Alter a variable's using a free expression</td></tr>