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 destination 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
inlineCSS Tells whether the generated HTML page should inline the CSS or not.

If set to yes, the CSS will be embeded in the generated HTML, so that HTML the release notes is stand-alone (the CSS stylesheet will not be copied in the destination directory).

No no; if set to yes, the generated page will embed the CSS content.
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
mail Deprecated: since 0.6.1: the mail feature is now present through the inner mail XML element No when not provided, no mail is sent; otherwise, do not forget to fulfil the Ant Mail traditional attributes
migrate Indicates that you want to perform a migration of the XMLReleaseNotes file from its XRN framework version to the current XRN version. In that case, the file must be writable, since it may be overwritten. No when not provided, no migration is performed (considered as no); otherwise, when set to yes, if a migration is necessary, it is performed
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
layout Defines the XSL transformation to use for the post-processing of the XML input.

The idea is to provide an XSLT that extends the XMLReleaseNotes2HTML.xsl default rendering so as to take into account the new model information present in the input XML.

This XSL will be given the same parameters as the default one.

No
mail Enables to send an e-mail at the end of the XSL layout final transformation.

If not defined, no e-mail will be sent. Otherwise, use this usual mail built-in Ant task in order to define the e-mail inputs. See the explaining at the top

No
model Defines the XSL transformation to use for the processing of the XML input. The result of the transformation should be XML.

This enables to provide an XSLT that collapses for instance information coming from another XML file.

No


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.

Mail feature

This task is also the official Ant Mail task, so that you can send eventually the release notes by mail. If the mail parameter is set to true, then the generated release notes will be sent as text/html: define the traditional Ant Mail parameters, except the message, messagefile, messagemimetype, files and includefilenames.

The mail sent will contain the abstract as subject, and the content of the mail will be the generated release notes.

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