Author: andreas
Date: Fri Aug 26 01:24:31 2005
New Revision: 240190
URL: http://svn.apache.org/viewcvs?rev=240190&view=rev
Log:
Renamed publets to modules
Added:
lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/
lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml
Removed:
lenya/docu/src/documentation/content/xdocs/1_4/reference/publets/
Modified:
lenya/docu/src/documentation/content/xdocs/site.xml
Added:
lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml
URL:
http://svn.apache.org/viewcvs/lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml?rev=240190&view=auto
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml
(added)
+++ lenya/docu/src/documentation/content/xdocs/1_4/reference/modules/index.xml
Fri Aug 26 01:24:31 2005
@@ -0,0 +1,104 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2002-2004 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>Modules</title>
+ </header>
+ <body>
+
+ <section>
+ <title>Introduction</title>
+ <p>
+ Modules are packages providing a certain set of resources or
functionality.
+ </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>
+ <p>
+ Some modules are included in the Lenya distribution:
+ </p>
+ <ul>
+ <li><strong>search</strong> - search functionality</li>
+ <li><strong>sitetree</strong> - manage documents in a tree-like
structure</li>
+ <li><strong>jcr</strong> - store content in a <link
href="http://www.jcp.org/en/jsr/detail?id=170";>JCR</link> 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>Implementing a module</title>
+
+ <p>
+ All resources of a module are located in a single directory.
+ The following is an example directory structure, all files are optional
+ and depend on the nature of the module.
+ </p>
+
+<source xml:space="preserve">
+mymodule/
+ config/ configuration files
+ components.xconf patch for cocoon.xconf
+ usecases/
+ mymodule.jx usecase view
+ java/
+ src/ Java source files
+ lib/ Java libraries
+ xslt/ XSLT stylesheets
+ sitemap.xmap main module sitemap
+</source>
+
+ <p>
+ When the module is deployed, the following steps are executed:
+ </p>
+ <ul>
+ <li>the module files are copied to
<code>context://lenya/modules</code></li>
+ <li>Java sources are compiled, libraries are installed</li>
+ <li><code>cocoon.xconf</code> is patched</li>
+ </ul>
+
+ </section>
+
+ <section>
+ <title>Implementing Usecases in Modules</title>
+ <p>
+ To declare usecases, add a patch file for <code>cocoon.xconf</code>,
for instance <code>module/config/usecases.xconf</code>:
+ </p>
+<source xml:space="preserve"><![CDATA[<xconf xpath="/cocoon/usecases"
+ unless="/cocoon/usecases/component-instance[@name = 'mymodule.edit']">
+ <component-instance name="mymodule.edit"
+ logger="lenya.usecases.edit
+ class="org.myproject.lenya.mymodule.usecases.Edit">
+ <view template="modules/mymodule/usecases/edit.jx" menu="false"/>
+ </component-instance>
+</xconf>]]></source>
+
+ <p>
+ As you can see in the view declaration, the JX templates are typically
stored in the <code>mymodule/usecases</code>
+ directory. The Java source files go into the
<code>mymodule/java/src</code> directory, they are compiled
+ automatically by the Lenya build process.
+ </p>
+
+ </section>
+
+ </body>
+</document>
Modified: lenya/docu/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/lenya/docu/src/documentation/content/xdocs/site.xml?rev=240190&r1=240189&r2=240190&view=diff
==============================================================================
--- lenya/docu/src/documentation/content/xdocs/site.xml (original)
+++ lenya/docu/src/documentation/content/xdocs/site.xml Fri Aug 26 01:24:31 2005
@@ -65,7 +65,7 @@
</usecase-framework>
<publication-templating href="publication-templating/index.html"
label="Publication Templating"/>
<resource-types href="resource-types.html" label="Resource Types"/>
- <publets href="publets/index.html" label="Publets"/>
+ <modules href="modules/index.html" label="Modules"/>
</reference>
<javadoc1.4 href="../../../../apidocs/1.4/index.html" label="1.4 API
(Javadoc)"/>
|
