svn commit: r510993 - /lenya/trunk/src/README_MODULES.txt

Author: nettings
Date: Fri Feb 23 07:54:56 2007
New Revision: 510993

URL: http://svn.apache.org/viewvc?view=rev&rev=510993
Log:
more documentation, partly stolen from the website and extended.
andreas, can you take a look at the FIXMEs regarding the modules.xml
format?


Modified:
    lenya/trunk/src/README_MODULES.txt

Modified: lenya/trunk/src/README_MODULES.txt
URL: 
http://svn.apache.org/viewvc/lenya/trunk/src/README_MODULES.txt?view=diff&rev=510993&r1=510992&r2=510993
==============================================================================
--- lenya/trunk/src/README_MODULES.txt (original)
+++ lenya/trunk/src/README_MODULES.txt Fri Feb 23 07:54:56 2007
@@ -1,3 +1,6 @@
+Module categories:
+==================
+
 The modules in Lenya are currently split up into the following categories:
 
 * modules-core
@@ -24,13 +27,67 @@
   without using the usecase framework should go here. (FIXME: does that make
   the kupu module a candidate?)
 
+Directory Layout:
+=================
+
+Each module should adhere to the following directory layout (subdirectories
+if appropriate, take a look at the core modules if in doubt):
 
-Each module must include a modules.xml file and should adhere to the
-directory layout described in
-http://lenya.apache.org/docs/1_4/reference/modules/index.html
+mymodule/
+  config/                    configuration files
+    cocoon-xconf/            patches for cocoon.xconf:
+      component-mycomponent.xconf
+      usecase-myusecase.xconf     
+  usecases/
+    myusecase.jx             usecase view
+  java/
+    src/                     Java source files
+    lib/                     Java libraries
+  xslt/                      XSLT stylesheets
+  module.xml                 module descriptor
+  sitemap.xmap               main module sitemap
+
+
+module.xml
+==========
+
+Each module must contain a description file module.xml:
+
+<module xmlns="http://apache.org/lenya/module/1.0";>
+  <!-- the ID *must* start with the package name of 
+       your custom Java code -->
+  <id>org.myproject.lenya.modules.myeditor</id>
+  <!-- build dependencies; see note below -->
+  <depends module="org.apache.lenya.modules.usecase"/>
+  <depends module="org.apache.lenya.modules.webdav"/>
+  <!-- the Java package your module belongs to -->
+FIXME: why is this needed? afaiu it could be gleaned from the id...
+  <package>org.myproject.lenya.modules</package>
+  <!-- a version string -->
+FIXME: what does this do? just for information, or is there version
+management?
+  <version>0.1-dev</version>
+  <!-- a short name for your module -->
+  <name>My Own Editor</name>
+  <!-- the required lenya version -->
+FIXME: is this actually used?
+  <lenya-version>1.4-dev</lenya-version>
+  <!-- a detailed description of your module -->
+  <description>
+    This is my own editor.
+    For more information, visit http://myproject.org/editor.
+  </description>
+</module>
 
 NOTE: be careful to specify the depencies correctly. The <depends/> element
 is meant for java code dependencies only, i.e. issues that affect
 compilation. If a module merely links to another module's usecases in its
 views, that does not qualify as a dependency (although maybe it should at
 some point in the future).
+
+
+see also:
+=========
+
+Please refer to the online docs at
+http://lenya.apache.org/docs/1_4/reference/modules/index.html.