Website

This plugin provides a single entry point to generated a project website including reports.

Declaration

  <plugin name="website">
    <attribute name="website.resources" value="etc/website/resources"/>
    <attribute name="website.templates" value="etc/website/templates"/>
  </plugin>

Usage

When the plugin is configured, other plugin generates reports in the site, generally per module set. The target website generates the site with current available reports. In order to include generated reports, other plugin targets must be called previously, like javadoc or junit.report for instance. Refer to plugins documentation to be aware of available report capabilities.

The source files to generate website may be customized for your project. Look at website.resources and website.templates values for EL4Ant project and that directories content as a example.

Target

• website generates the site pages and menu.
• website.clean cleans the complete site, pages and reports.

Attributes

Global

• website.resources is a comma separated list of directories from which resources must be copied into generated site (reports.directory). Default value is empty.
• website.templates is a comma separated list of directories containing *.html.vm Velocity templates which are processed to generate corresponding *html pages. Included section must not match the *.html.vm pattern. Default value is empty.
• reports.directory is the place where pages and other reports are generated. Default value is dist/website.
• website.donotclean controls if the site is cleaned by the distclean target (when false). Default value is false.

ToDo

• Create a single pretty stylesheet for the menu, the home page, the overview and all other reports (junit, javadoc, checkstyle, ...)
• Improve this documentation to explain which objects are available in Velocity templates.