doc/use/report.html - ant-ivy - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
 -->
 <html>
 <head>
 	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
 	<script type="text/javascript">var xookiConfig = {level: 1};</script>
 	<script type="text/javascript" src="../xooki/xooki.js"></script>
 </head>
 <body>
 	<textarea id="xooki-source">
 Generates reports of dependency resolving. One report per configuration is generated, but all reports generated together are hyperlinked one to each other.

 This task should be used only after a call to resolve, even if the call was not done during the same ant build.
 In fact, this task uses xml report generated by resolve in cache. So if you call resolve on a module for a given configuration, you can call report safely on this module and this configuration as long as you do not clean your ivy cache.

 If you want to have an idea of what reports look like, check this very simple <a href="../samples/jayasoft-ivyrep-example-default.html">example</a>.
 The task also generates a graphml file which can be loaded with the free <a href="http://www.yworks.com/en/products_yed_about.htm">yEd</a> graph editor.
 Then following a few <a href="../yed.html">simple steps</a> you can obtain a graph like this <a href="../samples/jayasoft-ivyrep-example-default.jpg">one</a>.

 <div class="since">since 1.4</div> If a custom XSL is specified, it's possible to specify additional parameters to the stylesheet.

 <table class="ant">
 <thead>
     <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
 </thead>
 <tbody>
     <tr><td>todir</td><td>the directory to which reports should be generated</td>
         <td>No, defaults to ${ivy.report.todir}, or execution directory if not defined</td></tr>
     <tr><td>outputpattern</td><td>the generated report names pattern</td>
         <td>No, defaults to ${ivy.report.output.pattern}, or [organisation]-[module]-[conf].[ext] if not defined</td></tr>
     <tr><td>xsl</td><td>true to generate a report (by default html report) using xslt, false otherwise <span class="since">since 1.3</span></td>
         <td>No, defaults to true</td></tr>
     <tr><td>xml</td><td>true to generate a xml report, false otherwise <span class="since">since 1.3</span></td>
         <td>No, defaults to false</td></tr>
     <tr><td>graph</td><td>true to generate graphml files, false otherwise</td>
         <td>No, defaults to true</td></tr>
     <tr><td>dot</td><td>true to generate <a href="http://www.graphviz.org/">graphviz dot</a> files, false otherwise <span class="since">since 1.4</span></td>
         <td>No, defaults to false</td></tr>
     <tr><td>conf</td><td>a comma separated list of the configurations for which a report should be generated</td>
         <td>No. Defaults to the configurations resolved by the last resolve call (during same ant build), or ${ivy.resolved.configurations} if no resolve was called</td></tr>
     <tr><td>organisation</td><td>the name of the organisation of the module for which report should be generated</td>
         <td>No, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module organisation.</td></tr>
     <tr><td>module</td><td>the name of the module for which report should be generated</td>
         <td>No, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module.</td></tr>
     <tr><td>validate</td><td>true to force ivy files validation against ivy.xsd, false to force no validation</td>
         <td>No. Defaults to default ivy value (as configured in configuration file)</td></tr>
     <tr><td>xslfile</td><td>indicates which xsl file should be used to generate the report</td>
         <td>No, defaults to ivy provided xsl which generates html report</td></tr>
     <tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <span class="since">(since 2.0)</span></td><td>No, 'ivy.instance' is taken by default.</td></tr>
     <tr><td>resolveId</td><td>The id which was used for a previous resolve <span class="since">(since 2.0)</span></td><td>No, defaults to '[org]-[module]'.</td></tr>
 </tbody>
 </table>

 <h1>Examples</h1>
 To generate a HTML and graphml report:
 <code type="xml">
 <report conf="compile" />
 </code>

 <hr/>
 To generate a HTML report only:
 <code type="xml">
 <report conf="compile" graph="false" />
 </code>

 <hr/>
 To generate an XML report using a custom stylesheet:
 <code type="xml">
 <report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
 </code>

 To generate an XML report using a custom stylesheet which needs some parameters:
 <code type="xml">
 <report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
     <param name="param1" expression="value1" />
     <param name="param2" expression="value2" />
 </report>
 </code>

 	</textarea>
 <script type="text/javascript">xooki.postProcess();</script>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
	<!--
	Licensed to the Apache Software Foundation (ASF) under one
	or more contributor license agreements. See the NOTICE file
	distributed with this work for additional information
	regarding copyright ownership. The ASF licenses this file
	to you under the Apache License, Version 2.0 (the
	"License"); you may not use this file except in compliance
	with the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing,
	software distributed under the License is distributed on an
	"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	KIND, either express or implied. See the License for the
	specific language governing permissions and limitations
	under the License.
	-->
	<html>
	<head>
	<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
	<script type="text/javascript">var xookiConfig = {level: 1};</script>
	<script type="text/javascript" src="../xooki/xooki.js"></script>
	</head>
	<body>
	<textarea id="xooki-source">
	Generates reports of dependency resolving. One report per configuration is generated, but all reports generated together are hyperlinked one to each other.

	This task should be used only after a call to resolve, even if the call was not done during the same ant build.
	In fact, this task uses xml report generated by resolve in cache. So if you call resolve on a module for a given configuration, you can call report safely on this module and this configuration as long as you do not clean your ivy cache.

	If you want to have an idea of what reports look like, check this very simple <a href="../samples/jayasoft-ivyrep-example-default.html">example</a>.
	The task also generates a graphml file which can be loaded with the free <a href="http://www.yworks.com/en/products_yed_about.htm">yEd</a> graph editor.
	Then following a few <a href="../yed.html">simple steps</a> you can obtain a graph like this <a href="../samples/jayasoft-ivyrep-example-default.jpg">one</a>.

	<div class="since">since 1.4</div> If a custom XSL is specified, it's possible to specify additional parameters to the stylesheet.

	<table class="ant">
	<thead>
	<tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr>
	</thead>
	<tbody>
	<tr><td>todir</td><td>the directory to which reports should be generated</td>
	<td>No, defaults to ${ivy.report.todir}, or execution directory if not defined</td></tr>
	<tr><td>outputpattern</td><td>the generated report names pattern</td>
	<td>No, defaults to ${ivy.report.output.pattern}, or [organisation]-[module]-[conf].[ext] if not defined</td></tr>
	<tr><td>xsl</td><td>true to generate a report (by default html report) using xslt, false otherwise <span class="since">since 1.3</span></td>
	<td>No, defaults to true</td></tr>
	<tr><td>xml</td><td>true to generate a xml report, false otherwise <span class="since">since 1.3</span></td>
	<td>No, defaults to false</td></tr>
	<tr><td>graph</td><td>true to generate graphml files, false otherwise</td>
	<td>No, defaults to true</td></tr>
	<tr><td>dot</td><td>true to generate <a href="http://www.graphviz.org/">graphviz dot</a> files, false otherwise <span class="since">since 1.4</span></td>
	<td>No, defaults to false</td></tr>
	<tr><td>conf</td><td>a comma separated list of the configurations for which a report should be generated</td>
	<td>No. Defaults to the configurations resolved by the last resolve call (during same ant build), or ${ivy.resolved.configurations} if no resolve was called</td></tr>
	<tr><td>organisation</td><td>the name of the organisation of the module for which report should be generated</td>
	<td>No, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module organisation.</td></tr>
	<tr><td>module</td><td>the name of the module for which report should be generated</td>
	<td>No, unless resolveId has not been specified and no resolve was called during the build. Defaults to last resolved module.</td></tr>
	<tr><td>validate</td><td>true to force ivy files validation against ivy.xsd, false to force no validation</td>
	<td>No. Defaults to default ivy value (as configured in configuration file)</td></tr>
	<tr><td>xslfile</td><td>indicates which xsl file should be used to generate the report</td>
	<td>No, defaults to ivy provided xsl which generates html report</td></tr>
	<tr><td>settingsRef</td><td>A reference to the ivy settings that must be used by this task <span class="since">(since 2.0)</span></td><td>No, 'ivy.instance' is taken by default.</td></tr>
	<tr><td>resolveId</td><td>The id which was used for a previous resolve <span class="since">(since 2.0)</span></td><td>No, defaults to '[org]-[module]'.</td></tr>
	</tbody>
	</table>

	<h1>Examples</h1>
	To generate a HTML and graphml report:
	<code type="xml">
	<report conf="compile" />
	</code>

	<hr/>
	To generate a HTML report only:
	<code type="xml">
	<report conf="compile" graph="false" />
	</code>

	<hr/>
	To generate an XML report using a custom stylesheet:
	<code type="xml">
	<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml" />
	</code>

	To generate an XML report using a custom stylesheet which needs some parameters:
	<code type="xml">
	<report conf="compile" xslfile="my-custom-stylesheet.xsl" xslext="xml">
	<param name="param1" expression="value1" />
	<param name="param2" expression="value2" />
	</report>
	</code>

	</textarea>
	<script type="text/javascript">xooki.postProcess();</script>
	</body>
	</html>