Difference between revisions of "Maven project site guide"

From MPDLMediaWiki
Jump to navigation Jump to search
Line 23: Line 23:


The source code of the html files are kept in the svn repository together with the other resources (java src.) of the project.  
The source code of the html files are kept in the svn repository together with the other resources (java src.) of the project.  
So if you want add a page you have to checkout the source files of the project. An explanation can be found
So if you want add a page you have to checkout the source files of the project. An explanation to get the sources and to get maven can be found in [[Installation of maven]].

Revision as of 09:42, 19 March 2008

Maven creates most of its site content on it's own. This behavior is controlled by reporting plugins.

Reporting plugins

These reporting plugins are defined in the parent pom of each project.

Here you can see a sample report entry for the javadoc documentation:

<reporting>
        <plugins>
		<plugin>
			<artifactId>maven-javadoc-plugin</artifactId>
		</plugin>
	...

This simple entry in the pom creates the whole documentation page and automatically links it in the root project page. If you want to have a new reporting feature, just add the module in the parent pom and every submodule will derive from it.

If you want to add a custom page to the generated ones, this can easily be done.

Create a custom page

The source code of the html files are kept in the svn repository together with the other resources (java src.) of the project. So if you want add a page you have to checkout the source files of the project. An explanation to get the sources and to get maven can be found in Installation of maven.