svn commit: r425078 - /lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml

[an...@apache.org]

Author: andreas
Date: Mon Jul 24 07:51:45 2006
New Revision: 425078

URL: http://svn.apache.org/viewvc?rev=425078&view=rev
Log:
Added information about the module descriptor

Modified:
    lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml

Modified: lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml?rev=425078&r1=425077&r2=425078&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml Mon Jul 24 07:51:45 2006
@@ -65,6 +65,7 @@
     src/                     Java source files
     lib/                     Java libraries
   xslt/                      XSLT stylesheets
+  module.xml                 module descriptor
   sitemap.xmap               main module sitemap
 </source>
 
@@ -82,6 +83,37 @@
         <li><code>cocoon.xconf</code> is patched</li>
       </ul>
 
+    </section>
+    
+    <section>
+      <title>The Module Descriptor File</title>
+      <p>
+        Each module must be described using a <em>module descriptor</em> XML file
+        <code>module.xml</code>, located in the root directory of the module.
+        The descriptor is validated when the module is deployed, so be careful! :)
+      </p>
+      <p>
+        A typical module descriptor looks like this:
+      </p>
+      <source xml:space="preserve"><![CDATA[<module xmlns="http://apache.org/lenya/module/1.0">
+  <id>org.myproject.lenya.modules.myeditor</id>
+  <depends module="org.apache.lenya.modules.usecase"/>
+  <depends module="org.apache.lenya.modules.webdav"/>
+  <package>org.myproject.lenya.modules</package>
+  <version>0.1-dev</version>
+  <name>My Own Editor</name>
+  <lenya-version>1.4-dev</lenya-version>
+  <description>
+    This is my own editor.
+    For more information, visit http://myproject.org/editor.
+  </description>
+</module>]]></source>
+      <p>
+        The <code>id</code> must start with the <code>package</code> of the module.
+        It is not allowed to deploy two modules with the same ID.
+      </p>
+      <p>If your module uses code from other modules, you have to add 
+       a <code><![CDATA[<depends>]]></code> for each of these modules.</p>
     </section>
     
     <section>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org