You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2007/04/12 11:05:42 UTC

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

Author: andreas
Date: Thu Apr 12 02:05:40 2007
New Revision: 527847

URL: http://svn.apache.org/viewvc?view=rev&rev=527847
Log:
Extended module docs

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

Modified: lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/modules/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/modules/index.xml?view=diff&rev=527847&r1=527846&r2=527847
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/modules/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/1_4/reference/modules/index.xml Thu Apr 12 02:05:40 2007
@@ -61,8 +61,14 @@
       components.xconf     
   usecases/
     mymodule.jx              usecase view
+  resources/
+    images/                  image files
+    css/                     CSS files
+    schemas/                 XML schemas (RNG, XSD, ...)
+    samples/                 Samples (in case of resource type modules)
   java/
     src/                     Java source files
+    test/                    Java test classes
     lib/                     Java libraries
   xslt/                      XSLT stylesheets
   module.xml                 module descriptor
@@ -99,6 +105,7 @@
   <id>org.myproject.lenya.modules.myeditor</id>
   <depends module="org.apache.lenya.modules.usecase"/>
   <depends module="org.apache.lenya.modules.webdav"/>
+  <export package="org.myproject.lenya.modules.myeditor.api"/>
   <package>org.myproject.lenya.modules</package>
   <version>0.1-dev</version>
   <name>My Own Editor</name>
@@ -114,6 +121,12 @@
       </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>
+      <p>
+        The <code><![CDATA[<export package="..."/>]]></code> statement(s) declare
+        public packages, which means that these packages are accessible from other
+        modules. You should aim for long-term stability of all interfaces and classes
+        in exported packages, since they represent the Java API of your module.
+      </p>
     </section>
     
     <section>



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