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 12:25:06 UTC

svn commit: r527873 - in /lenya/docu/src/documentation/content/xdocs: docs/modules/collection.xml docs/modules/index.xml docs/modules/news.xml site.xml

Author: andreas
Date: Thu Apr 12 03:24:56 2007
New Revision: 527873

URL: http://svn.apache.org/viewvc?view=rev&rev=527873
Log:
Added more module docs

Modified:
    lenya/docu/src/documentation/content/xdocs/docs/modules/collection.xml
    lenya/docu/src/documentation/content/xdocs/docs/modules/index.xml
    lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml
    lenya/docu/src/documentation/content/xdocs/site.xml

Modified: lenya/docu/src/documentation/content/xdocs/docs/modules/collection.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/collection.xml?view=diff&rev=527873&r1=527872&r2=527873
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/collection.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/collection.xml Thu Apr 12 03:24:56 2007
@@ -17,7 +17,7 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>Collection Module</title>
+    <title>The Collection Module</title>
   </header>
   <body>
     

Modified: lenya/docu/src/documentation/content/xdocs/docs/modules/index.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/index.xml?view=diff&rev=527873&r1=527872&r2=527873
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/index.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/index.xml Thu Apr 12 03:24:56 2007
@@ -29,26 +29,89 @@
       development. </warning>
        <section>
       <title>Introduction</title>
-      <p> Modules are packages providing a certain set of resources or 
+      <p>
+        Modules are packages providing a certain set of resources or 
         functionality. The aim of this section in the documentation is to group 
-        the information needed to work with a certain module into one entry point. </p>
-      <p>Examples:</p>
-      <ul>
-        <li>a resource type (e.g., docbook module)</li>
-        <li>a repository implementation (e.g., jdbc module)</li>
-        <li>a collection of XSLTs (e.g., content2svg module)</li>
-      </ul>
+        the information needed to work with a certain module into one entry point.
+      </p>
       <p>
-        Some modules are included in the Lenya distribution:
+        To learn how modules are implemented, refer to the <a href="site:modules">general modules documentation</a>.
       </p>
-      <ul>
-        <li><strong>lucene</strong> - search functionality</li>
-        <li><strong>sitetree</strong> - manage documents in a tree-like structure</li>
-        <li><strong>jcr</strong> - store content in a <a href="http://www.jcp.org/en/jsr/detail?id=170">JCR</a> repository</li>
-        <li><strong>xhtml</strong> - XHTML-based resource type</li>
-        <li><strong>links</strong> - resource type to manage link lists</li>
-        <li><strong>lenyadoc</strong> - adds the <code>lenyadoc://</code> protocol</li>
-      </ul>
+    </section>
+    <section>
+      <title>Modules</title>
+      <dl>
+        <dt>blog</dt>
+        <dd>
+          Resource types and Java classes used by the blog publication. They are not yet ready
+          to be used separately.
+        </dd>
+        <dt>bxe</dt>
+        <dd>
+          Integration of the Bitflux WYSIWYG editor.
+        </dd>
+        <dt>cforms</dt>
+        <dd>
+          A resource type which can be edited using Cocoon Forms.
+        </dd>
+        <dt><a href="site:collection_module">collection</a></dt>
+        <dd>A resource type to store collections of documents.</dd>
+        <dt>contactform</dt>
+        <dd>A simple contact form. This is a usage example for the usecasedocument module.</dd>
+        <dt>development</dt>
+        <dd>Rresources to simplify development of Lenya applications.</dd>
+        <dt>editors</dt>
+        <dd>Form-based editors.</dd>
+        <dt>fckeditor</dt>
+        <dd>Integration of the FCK WYSIWYG editor.</dd>
+        <dt>kupu</dt>
+        <dd>Integration of the Kupu WYSIWYG editor.</dd>
+        <dt>languageselector</dt>
+        <dd>XHTML widget to switch languages on a website.</dd>
+        <dt>lenyadoc</dt>
+        <dd>Support for the <code>lenyadoc:/</code> protocol.</dd>
+        <dt>linkcheck</dt>
+        <dd>Link checking functionality.</dd>
+        <dt>links</dt>
+        <dd>A resource type to maintain lists of links.</dd>
+        <dt>lucene</dt>
+        <dd>Integration of the Lucene search engine.</dd>
+        <dt>migration</dt>
+        <dd>Resources to simplify the migration between different Lenya versions.</dd>
+        <dt>neutron</dt>
+        <dd>
+          Server-side implementation of the <a href="http://neutron.wyona.org/">Neutron</a>
+          protocol to support browser-based editors.
+        </dd>
+        <dt><a href="site:news_module">news</a></dt>
+        <dd>A resource type to display lists of news messages, can be used as a simple weblog.</dd>
+        <dt><a href="site:notification">notification</a></dt>
+        <dd>Support for user notification and inboxes.</dd>
+        <dt>opendocument</dt>
+        <dd>OpenDocument (ODF) resource type.</dd>
+        <dt>profiling</dt>
+        <dd>Resources to simplify profiling (performance optimization).</dd>
+        <dt>resource</dt>
+        <dd>The "resource" resource type, it allows to store arbitrary media documents.</dd>
+        <dt>simplesite</dt>
+        <dd>A simple site manager based on collections.</dd>
+        <dt>sitetree</dt>
+        <dd>Tree-based site manager.</dd>
+        <dt>sourcerepository</dt>
+        <dd>Repository implementation based on Avalon sources.</dd>
+        <dt>svg</dt>
+        <dd>Resources to support the rendering of SVG-based images, e.g. for boxes with rounded corners.</dd>
+        <dt>tinymce</dt>
+        <dd>Integration of the TinyMCE WYSIWYG editor.</dd>
+        <dt>usecasedocument</dt>
+        <dd>Resource type which allows to include a usecase as a document in the site structure.</dd>
+        <dt><a href="site:webdav_index">webdav</a></dt>
+        <dd>WebDAV support.</dd>
+        <dt>xhtml</dt>
+        <dd>Resource type which allows to store XHTML documents.</dd>
+        <dt>xopus</dt>
+        <dd>Integration of the Xopus WYSIWYG editor.</dd>
+      </dl>
     </section>
   </body>
 </document>

Modified: lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml?view=diff&rev=527873&r1=527872&r2=527873
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/docs/modules/news.xml Thu Apr 12 03:24:56 2007
@@ -17,7 +17,7 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
   <header>
-    <title>News Feed Module</title>
+    <title>The News Feed Module</title>
   </header>
   <body>
     

Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/lenya/docu/src/documentation/content/xdocs/site.xml?view=diff&rev=527873&r1=527872&r2=527873
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Thu Apr 12 03:24:56 2007
@@ -205,20 +205,26 @@
     </javadoc1.4overview>    
     
   </docu1.4>
-  <modules href="modules/" label="Modules" tab="modules">
-    <index href="index.html" label="Index"/>
+  <module_list href="modules/" label="Modules" tab="modules">
+    <index href="index.html" label="Overview"/>
     <webdav href="webdav/" label="WebDAV">
-      <index href="index.html" label="Getting started"/>
+      <webdav_index href="index.html" label="Getting started"/>
       <monitoring href="monitoring.html" label="Monitoring"/>
       <server href="webdav.html" label="WebDAV Servers"/>
     </webdav>
-    <collection_module href="collection.html" label="Collection"/>
-    <news_module href="news.html" label="News"/>
-    <notification href="notification.html" label="Notification"/>
+    <collection_module_section label="Collection">
+      <collection_module href="collection.html" label="Overview"/>
+    </collection_module_section>
+    <news_module_section label="News">
+      <news_module href="news.html" label="Overview"/>
+    </news_module_section>
+    <notification_module_section label="Notification">
+      <notification href="notification.html" label="Overview"/>
+    </notification_module_section>
     <svg_module href="svg/" label="SVG">
       <svg_roundedcorners href="roundedcorners.html" label="Rounded Corners"/>
     </svg_module>
-  </modules>
+  </module_list>
   <!--+
     | Version 1.2 tab
     +-->



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