Module categories:
==================
The modules in Lenya are currently split up into the following categories:
* modules-core
This set of modules implements the core functionality of Lenya.
Modules in the core will not have any dependencies outside of the core.
* modules
This is where most of the add-on functionality goes: support for specific
editors, document types, the nifty new feature of the day, etc.
Directory Layout:
=================
Each module should adhere to the following directory layout (subdirectories
if appropriate, take a look at the core modules if in doubt):
mymodule/
config/ configuration files
module.xml module descriptor
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
sitemap.xmap main module sitemap
module.xml
==========
Each module must contain a description file config/module.xml:
org.myproject.lenya.modules.myeditor
FIXME: why is this needed? afaiu it could be gleaned from the id...
org.myproject.lenya.modules
FIXME: what does this do? just for information, or is there version
management?
0.1-dev
My Own Editor
FIXME: is this actually used?
2.0-dev
This is my own editor.
For more information, visit http://myproject.org/editor.
NOTE: be careful to specify the depencies correctly. The 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.