|
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 |
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 |
Deprecated: 0.6.1: the mail feature is now present through the {@link #createMail} method. | No | when not provided, no mail is sent; otherwise, do not forget to fulfil the Ant Mail
traditional attributes |
|
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 |
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 This XSL will be given the same parameters as the default one. |
No |
Enables to send an e-mail at the end of the XSL layout final transformation. | 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 |
The XMLReleaseNotes framework can also be used from the Ant world, thanks to this tiny wrapper task.
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.
It is required that the Ant lib
directory contains an XSLT implementation library
(like Xalan or Saxon, for instance).