Overview  Package   Task  Deprecated 

Task XMLReleaseNotes

The task that enables to use the XMLReleaseNotes framework via Ant...[Description]

Definition

<taskdef name="XMLReleaseNotes" classname="org.ed.pack.xmlreleasenotes.XMLReleaseNotes" />

Parameters

Attribute Description Required Default
abstract Enables to define an abstract for the generated main HTML page, that will be displayed at the top of the release notes.

You can provide an HTML snippet if you want to.

No empty
banner Tells whether the generated HTML page should present an advertizing footer banner No when not provided, the banner is displayed
cSS Defines the CSS file to be used within the generated HTML pages. This CSS must conform to the default CSS stylesheet format. No the default XMLReleaseNotes CSS stylesheet
delivery Tells whether the generated HTML page should contain the 'Delivery' column. Usefull when you just want to output functionnal release notes. No when not provided, the column is displayed
deploy Tells the task just to deploy the encapsulated XSD and CSS into the directory defined by the {@link #setDestination} parameter. No not taken into account, unless set to true
destination Defines the directory where the generated HTML stuff will be generated into. No . (the current Ant buildfile basedir directory)
firstVersion Defines the version the documentation should be generated from. No the version 'Releases/Release' XML element at the top of the XMLReleaseNotes XML file
hTML Defines the name of the entry point for starting browsing the genrated HTML pages. No XMLReleaseNotes.html
lastVersion Defines the version the documentation should be generated until. No the version 'Releases/Release' XML element at the bottom of the XMLReleaseNotes XML file
typeFilter Enables to restrict the 'Items/Item' to be documented, depending on the type attribute. Possible values are tech and func. No when not provided, no filtering on that criteria is performed
visibilityThreshold Enables to restrict the 'Items/Item' to be documented, depending on the visibility attribute. Possible values should range from 0 (least visible) to 4 (most visible). No when not provided, no filtering on that criteria is performed
xML Defines the XMLReleaseNotes compliant XML file that decribes the component relese notes. No XMLReleaseNotes.xml

Parameters specified as nested elements

Element Description Required


Description

The task that enables to use the XMLReleaseNotes framework via Ant.

The XMLReleaseNotes framework can also be used from the Ant world, thanks to this tiny wrapper task.

Requirements

It is required that the Ant lib directory contains an XSLT implementation library (like Xalan or Saxon, for instance).



Author

Edouard Mercier

Version

1.0 : 2004.04.01