Rationale

Having a common directory layout would allow for users familiar with one Maven project to immediately feel at home in another Maven project. The advantages are analogous to adopting a site-wide look-and-feel. Common Maven procedures strengthen the Maven brand.

The next two sections document the directory layout expected by Maven and the directory layout created by Maven. Please try to conform to this structure as much as possible; however, if you must these settings can be overridden via properties as documented in the Properties document.

XPI Project Directory Layout

The XPI project extends the Maven Common Directory Layout . You can browse a example Directory Structure here .

Directory or file name Content Comment
src/xpi The base directory under which Mozilla applications can be found. This directory contains the Mozilla application to be built. This directory typically contains all of the Mozilla application source code including the install.js script.
src/xpi/${pomId} The base directory under which the source or the Mozilla application can be found. This directory contains the source code of the Mozilla application used to create the application jar file. See Application Directory Layout for detailed informations about the structure.
src/xpi/install/install.js Installation Script This file contains the install routines which apply to the project.
installed-chrome.txt Entries for the chrome registry file. This file is only for development and not used in any distribution package.

Maven generated XPI Project Directory Layout

Maven creates additional directories in ${maven.xpi.build.dir} during the build process.

Directory name Content Comment
target/xpi-plugin Application source and install script directory. This directory conatins a directory with the application source code and a directory with the install script.
target/xpi-plugin-dist Generated distribution packages ready for deployment This directory typically conatins *.xpi, *-src.zip, *-src.tar, *-src.tar.gz files and have names defined in the Properties document.
target/xpi-plugin-jar Mozilla application jar package and install script. This directory contains the ${pom.artifactId} .jar and install.js file.
target/xpi-plugin-src-tar Mozilla application source packages for Unix. This directory contains *-src.tar and *-src.tar.gz packages and have names defined in the Properties document.
target/xpi-plugin-src-zip Mozilla application source packages for Windows. This directory contains a *-src.zip package and with a name defined in the Properties document.
target/xpi-plugin-xpi Mozilla application install package. This directory contains the ready to install xpi package and with a name defined in the Properties document.