this documentation has never been completed and is now largely obsolete. thankfully, we now use fallback in a consistent and self-explanatory manner, which removes much cause for confusion. in addition, documentation about modules and their directory structure has been added to the lenya website.
This is a first attempt to document all the files and directories of a Lenya 2.0 system, their meanings, their hierarchy and their history.
BobHarner suggests to eventually create README files in each and every directory that will explain what the directory contains and how the files are used. JörnNettingsmeier eventually wants to add comment headers to all xml files that give similar information. For now, we are using this wiki page to collect the necessary information.
In order to make the documentation easy to read and keep it concise, JörnNettingsmeier suggests CategoriesForFileDocumentation and a Glossary to define and explain terms so that they can be used consistently. Please comment and improve.
For simplicity, this page assumes you are using the Jetty servlet container and are running Lenya from the standard build directory.
This is the directory where you unpacked Lenya and hopefully Cocoon. Thus, it probably contains two directories:
- cocoon_2_1_X (the cocoon sources and build files)
- lenya_2_0_X (the lenya sources and build files)
These names can be different on your system depending on whether you used tarballs or SVN.||
This is the unpacked lenya sourcecode, either from tarball or our of SVN. Among others, it contains two important scripts and one important settings file:
lenya.sh (or lenya.bat for Windows users) is the script that will run your lenya servlet (in case you are using the built-in Jetty engine - Tomcat users can ignore this).
build.sh (or build.bat for Windows users) is the build script that will take care of compiling Lenya and writing the finished product to build/.
build.properties is an example config file that governs the build process. You need to copy it to local.build.properties and edit it according to your needs.
Last but not least there are (and it would be horribly bad form to disregard them)
*.txt, a bunch of important notes that you should read.
This is where your finished Lenya system ends up after you have successfully built it. It also houses the content of your publication(s). Generated during build, used by the servlet engine to serve your site and store the content. For details concerning this part of the tree, go to DirectoryStructureLenya2.0-HEAD-build.
An exciting collection of legalese, containing the licenses for all third-party components that Lenya uses.
This directory contains jar packages of third-party software used by Lenya. They all will be copied to ./lenya_2.0.x/build/lenya/webapp/WEB-INF/lib after build. You wont need that directory until you rebuild your Lenya2.0-HEAD.
This directory contains the example publications, currently default and blog
Here you find the sources of Lenya. Used during build only. For details concerning this part of the tree, go to DirectoryStructureLenya2.0-HEAD-src.
This one contains useful tools which are needed to build and/or run Lenya, for instance the ant program (a "make" for Java), and the Jetty servlet container.