|
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 |
checkValidity | Indicates whether the XML input release notes should be tested against its XML schema. This enables to check that you provide an XRN release notes that is compliant with the current framework (and all the more that the file is well formed). | No | defaults to false . When set to true , the release notes file is being checked |
composition | Deprecated: since V0.15.0: use the SectionFilterModel XSLT model plugin instead |
No | when not provided, the composition information 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 |
cumulative | Deprecated: since V0.13.0: use the CumulativeModel XSLT model plugin instead |
No | defaults to false . When set to true , then a single version release notes
is being generated, from the first version until the last version |
debug | For internal purpose only. Triggers the debug behaviour. | Yes | |
delivery | Tells whether the generated HTML page should contain the 'Delivery' information. Usefull when you just want to output functionnal release notes. | No | when not provided, the delivery information is displayed |
dependency | Deprecated: since V0.15.0: use the SectionFilterModel XSLT model plugin instead |
No | when not provided, the dependencies information 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) |
downloadPage | Deprecated: since V0.15.0: use the SectionFilterModel XSLT model plugin instead |
No | defaults to false . When set to true , then only the deliveries hyperlinks
should be output |
firstVersion | Deprecated: since V0.12.0 | 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 |
implicitlyMigrate | Indicates that implicit XRN migration should be applied if necessary. This does not stop the process once the implict migration has been applied. | No | when not provided, no implicit migration is performed (considered as no ) |
importanceThreshold | Deprecated: since V0.12.0 | No | when not provided, no filtering on that criteria is performed |
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 | Deprecated: since V0.12.0 | No | the version 'Releases/Release' XML element at the bottom of the XMLReleaseNotes XML file |
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.
When used, no release notes generation is performed. |
No | when not provided, no migration is performed (considered as no ); otherwise, when set to
yes , if a migration is necessary, it is performed |
processor | Defines the FQN of the XLST {@link TransformerFactory} class.
This will set the Java system property |
No | the default implementation found in the classpath |
requirement | Deprecated: since V0.15.0: use the SectionFilterModel XSLT model plugin instead |
No | when not provided, the requirements information is displayed |
singlePage | Tells whether a single HTML page should be generated (false ) or multiple HTML pages should be generated
(true ), a bit like javadoc does. |
No | defaults to true ; when set to true , only one HTML page is being generated |
typeFilter | Deprecated: since V0.12.0 | No | when not provided, no filtering on that criteria is performed |
useIcons | Indicates whether the generated HTML pages should contains icons. | No | when not set, it is considered as yes , which means that a single HTML page is output |
xML | Defines the XMLReleaseNotes compliant XML file that decribes the component relese notes. | No | XMLReleaseNotes.xml |
Element | Description | Required |
fileSet | Enables to define multiple XRN release notes files at the same time.
When defined, the |
No |
footer | This footer will be placed on multi-components HTML release notes. | No |
header | This header will be placed on multi-components HTML release notes. | No |
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.
If not defined, no e-mail will be sent. Otherwise, use this usual |
No | |
model | Defines the XSL transformations to use for the processing of the XML input. The result of the transformation should
be XML.
This enables to provide multiple XSLT that collapses for instance information coming from another XML file. |
No |
title | This title will be used on multi-components HTML release notes on the first page displayed (the one that sums up all components). | 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).
<taskdef classname="org.ed.pack.xmlreleasenotes.XMLReleaseNotes" name="XMLReleaseNotes" /> <XMLReleaseNotes xml="ReleaseNotes.xml" firstVersion="1.0.0" />will generate the HTML release notes for the XML release notes file
ReleaseNotes.xml
, from version
1.0.0.