Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Platform Plug-in Development Environment Guide
Previous Page Home Next Page

API Use Report Conversion Ant Task

Purpose

This task converts the XML report created by the apitooling.apiuse ant task into HTML files.

Usage

Description

The name of the ant task is: apitooling.apiuse_reportconversion. To be used, the jar file apitooling-ant.jar has to be on the ant classpath.

	
<apitooling.apiuse_reportconversion
		xmlfiles="..."
		htmlfiles="..."
		xsltfile="..."
		debug="..."
	/>

Parameters

Attribute Description Required
xmlfiles This attribute specifies the location of the xml files to convert.

The location is specified using an absolute path.
Yes
htmlfiles This attribute specifies the location of the html files to generate.

The location is specified using an absolute path.
Yes
xsltfile This attribute specifies the location of an XSLT file to be used to generate the reference details pages in a desired ordering.

A default XSLT file is available in the apitooling-ant.jar JAR file.

The location is specified using an absolute path.
No
debug Set the debug value.

The possible values are: true, false
Default is false.
No

Examples

	
<apitooling.apiuse_reportconversion
		xmlfiles="/eclipse/apiuse-both/XML"
		htmlfiles="/eclipse/apiuse-both/HTML"
		xsltfile="/eclipse/references.xsl"
		debug="true"
	/>

This will run the task creating *.html files inside the folder /eclipse/apiuse-both/HTML corresponding to the folder structure of the XML file location

If debug is enabled, some debug tracing will show up in the ant console.

Related reference

API Tools Analysis Ant Task
API Tools File Generation Ant Task
API Tools API Use Ant Task
API Tools Pluggable API Use Ant Task
API Tools API Freeze Ant Task
API Tools Analysis Report Conversion Ant Task


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire