Maven unterstützt die Projektentwicklung mit unterschiedlichen Plugins, die es
erlauben, das Projekt schnell und einfach umfangreich zu dokumentieren. Durch den
Aufruf von mvn site[-deploy] wird eine Projektseite erstellt und bei Bedarf auf
den Maven-Repositories zusätzlich veröffentlicht. Die Seite enthält neben den
Projektinformationen aus dem POM auch Reports, Abhängigkeitsbäume, Issue Trackings,
Testergebnisse und viele weitere Informationen. Mit mvn site:run wird mittels des
einfachen Webservers Jetty, der ebenfalls über das zentrale Maven Repository bezogen wird,
die Seite lokal gehostet. Die Seite kann dann unter http://localhost:8080 erreicht werden.
Soll auf die Verwendung von Jetty verzichtet werden, kann die Seite auch innerhalb des
Filesystems angezeigt werden. Nach der Erstellung der Seite befinden sich die erstellten
Seiten und Reports im Unterordner ”site” im Target-Verzeichnis. Dort liegt die
HTML-Datei ”index.html” durch deren Aufruf die Seite in jedem Browser angezeigt werden
kann. Ein Beispiel für das Aussehen einer leicht angepassten Seite ist im folgenden zu
sehen.
Um die Seite anzupassen bestehen verschiedene Möglichkeiten. In jedem Fall werden alle
zusätzlichen Informationen im Ordner ”./src/site” abgelegt. In diesem Order kann die Datei
”site.xml” angelegt werden, die zur Beschreibung der benutzerdefinierten Seite dient. Der
Auszug einer einfachen Variante ist im Folgenden zu sehen.
<project name="Sample Jar Project">
<bannerLeft> <name>FH Wedel (JAR Example)</name> <src>images/logo.png</src> <href>http://www.fh-wedel.de</href> </bannerLeft> <body> <menu name="FH Wedel (JAR Example)"> <item name="Overview" href="index.html"/> </menu> <menu ref="reports"/> </body> </project> |
Durch diese Seitenbeschreibung wird das Logo angepasst und eine weitere Naviagtionsebene
eingefügt. Das Logo sollte dann unter src\site\resources\images\logo.png abgelegt
sein. Das zusätzliche Menü verweisst auf die Seite index.html. Diese Seite kann als Almost
Plain Text-Datei im Ordner src\site\apt\index.apt abgelegt werden. Der Inhalt dieser
Seite wird beim Aufruf von mvn site in die Datei index.html umgewandelt. Die hier
erwähnten Beispiele sind nur ein kleiner Auszug aus den Möglichkeiten, mit der
Projektseiten erweitert werden können. Es ist weiterhin möglich, zusätzliche Informationen
in folgenden Formaten bereitzustellen:
Erlaubt das erstellen von XML-Files die via Anttask’s in HTML-Files übersetzt
werden.
Erstellung im Ordner ./src/site/xdoc/index.xml (default)
XDoc Reference
Erlaubt das Erstellen einer FAQ in FML
Erstellung im Ordner ./src/site/fml/faq.fml (default)
FML Reference