Customizing Reporting Docs

The jMetra Documentation for a project is generated using using a set of template files. The default set of jMetra templates are contained within the jmetra.jar. An alternative or modified set of templates may be specified on the command line or ant task. When the documentation is generated from using the template HTML files, jMetra uses the FreeMarker template engine - an open source project. Simple customization of the templates can be done without a knowledge of FreeMarker syntax, but any advanced changes should only be attempted after briefly becoming familiar with the FreeMarker engine.

Any modifications or customizations should start by making a copy of the default templates that are contained within the jmetra.jar.The variables used within the templates can use reorganized or used within the pages to suite the customizer's needs. For purposes of brevity, the templates themselves should be inspected to see what variables may be manipulates.

The potential to customize the templates may allow users to not only customize the appearance of the jMetraDoc, but also to integrate or add hyperlinks to HTML produced by other code analysis packages which compliment jMetra.