[Maven 2] The Standard Directory Layout

$Revision: 1.12 $	$Name: $	$Date: 2006/04/13 13:54:09 $	Working with maven 2
$Source: /ppw/training/maven/repository/maven2/src/html/standardDirLayout.html,v $

The Standard Directory Layout

maven can be used with any directory layout you wish
Using a standard directory layout has big advantages
- No more discussions
- New developers for a project find their way around instantly
- Plugins are set by default to work with the standard directory layout: less work
- Standard directory layout has grown out of experience
  - Compatibility troubles with different tools are ironed out
    - CVS, SVN, eclipse, netbeans, checkstyle, HTML, jar, …
Still, a lot is left open
- Different plugins add more structure

artifactId/	project directory
\|-- .cvsignore	contains `target`, `profiles.xml`
\|-- pom.xml	POM
\|-- profiles.xml	local, user and project dependent profile definitions; this should not be version controlled
\|-- LICENSE.txt	license of the project
\|-- README.txt	welcome to the reader
\|-- src/	original material; this should be version controlled
\| \|-- main/	the original material for the artifact
\| \| \|-- java/	root of main Java source; wil be compiled into `target/classes`
\| \| \|-- resources/	main Java resources; will be copied into `target/classes`
\| \| \|-- webapp/ \| \| \|-- WEB-INF/ \| \| \| `-- web.xml \| \| `-- index.jsp	web application with standard web application structure
\| \| \|-- assembly/ \| \| `-- dep.xml	assembly descriptor for `maven-assembly-plugin`
\| \| \|-- filters/	resource filter properties files for main Java resources
\| \| \|-- config/	configuration files for the artifact
\| \| \|-- bash/ \| \| \|-- groovy/ \| \| \|-- prolog/ \| \| `-- sql/	sources in other technologies for the artifact
\| \|-- site/	project documentation in different formates; `mvn site` will produce a project website in `target/site` based on this material and structure (Doxia)
\| \| \|-- apt/ \| \| \| \|-- format.apt \| \| \| `-- index.apt	documentation in APT format (wiki-like HTML generation)
\| \| \|-- fml/ \| \| \| `-- faq.fml	documentation in FML format (XML based FAQ format)
\| \| \|-- resources/ \| \| \| \|-- css/ \| \| \| \|-- img/ \| \| \| `-- js/	site resources; will be copied into `target/site` as-is
\| \| \|-- site.xml	site descriptor: description of site structure; this will generate menus
\| \| `-- xdoc/ \| \| `-- xdoc.xml	documentation in Xdoc format (XML based HTML generation; maven 1 legacy)
\| `-- test/	original material to test the artifact
\| \|-- java/	root of Java source for testing the artifact; usually JUnit test classes; will be compiled into `target/test-classes`
\| \|-- resources/	resources for testing the artifact; will be copied into `target/test-classes`
\| \|-- filters/	resource filter properties files for resources for testing the artifact
\| \|-- perl/ \| \|-- haskell/ \| `-- python/	sources in other technologies for testing the artifact
`-- target/	generated material; this should not be under version control
\|-- artifactId-version.jar	generated artifact
\|-- classes/	result of compilation of `src/main/java` and copy of `src/main/resources`
\|-- exported-pom.xml	consolidated POM
\|-- javadoc/	javadoc of `src/main/java`
\|-- site/	project site generated by `mvn site`
\|-- surefire-reports/	test reports
\|-- test-classes/	result of compilation of `src/test/java` and copy of `src/test/resources`
`-- announcement/ `-- announcement.vm	org.codehaus.mojo:changelog-maven-plugin generates announcement mail here

Create an archetype for the standard directory layout
Deploy the archtetype in the private release repository