Directory Structure and Configuration Files

The recommended directory structure used to organize the FirstSpirit Module "example_webedit"

The recommended directory structure enables organization of class, resource and configuration files as well as a separation of module code, test cases and additional data.

At the top level, the structure consists of three directories:

• src
  contains all source code that implements plug-in components as well as test cases and can include the web application configuration and other resource files.
• lib
  contains Java Archives (JAR files) that provide classes imported in this module's Java files. The directory lib itself will be added to the classpath during both compile and test runs; the subdirectory compile will be added to the classpath during compilation runs, while the subdirectory test will be present in the classpath only during test runs.
• target
  will be created by targets in the Ant build file and contains processed output assembled during compilation and FSM assembly. The final product of this module--the FSM file, generated by running the Ant target "fsm"--will be placed in the directory target/fsm.

The src directory itself contains several subdirectories where files may be placed for various purposes:

• impl
  contains all Java files organized by package namespace. Resources that are accessed by package name (e.g. resource bundles) should be placed here as well.
• web
  contains configuration files and resources for the web-app component of this module. Subdirectories and their contents will be rolled out to the root directory of each project-specific ContentCreator web application that is configured to include this module.
  web-app components are required for proper roll-out of custom functionality to ContentCreator project web applications.

The ContentCreator Example module Zip file's src directory also contains another sub-directory, files. This directory is not used during module development but contains supporting files, such as Content Transport feature Zip files with workflow and script configurations that are required to use some of the example plug-ins the module provides. The files directory is not necessary and may be omitted in custom module directory structures.