Ant XInclude task

Introduction

The Ant XInclude task allows Ant build files to apply XInclude processing to XML files. It is based on the XIncluder project.

This Ant task has been developed with XIncluder 1.0d11.

XInclude 1.0 is a W3C Candidate Recommendation at the time of writing. See http://www.w3.org/TR/xinclude/.

Getting started

To get started using the XInclude task as soon as possible, take the following steps:

Make sure you have Jakarta Ant 1.5 or later installed.
Download xinclude-task-0.2.jar and place it in the lib directory of your Ant installation.
Edit your Ant build file and put a taskdef within the <project /> like this:
<taskdef name="xinclude" classname="org.znerd.xincludetask.XIncludeTask" />
Call the task as follows from one of your <target />s:
<xinclude in="in.xml" out="out.xml" />
Optional: Set the encoding for the output:
<xinclude in="in.xml" out="out.xml" encoding="ISO-8859-1" />
Optional: If you want a nice error message if Ant is run while one of the two required JARs is not in the CLASSPATH, then make your target depend on a target like the following:
<target name="-xinclude-avail">
   <available classname="com.elharo.xml.xinclude.SAXXIncluder" property="xinclude.available" />
   <fail unless="xinclude.available" message="XInclude engine not available. Please either put the xincluder.jar file in the CLASSPATH for Ant or put it in ${ant.home}/lib. This JAR file is available from http://people.FreeBSD.org/~znerd/xinclude-task/." />
   <available classname="org.znerd.xincludetask.XIncludeTask" property="xincludetask.available" />
   <fail unless="xincludetask.available" message="XInclude task not available. Please either put the xinclude-task.jar file in the CLASSPATH for Ant or put it in ${ant.home}/lib. This JAR file is available from http://people.FreeBSD.org/~znerd/xinclude-task/." />
</target>

Downloads and links

Downloads are distributed as .tar.gz files. There are 2 distributions. The first contains only the source files and everything else that is necessary for generating the rest. The second contains generated class files, a JAR file and API documentation as well.

	latest release (0.2)	most recent (0.2)
source	xinclude-task-0.2.tar.gz	xinclude-task-0.2.tar.gz
source, binaries and docs	xinclude-task-0.2-bin.tar.gz	xinclude-task-0.2-bin.tar.gz
JAR file	xinclude-task-0.2.jar	xinclude-task-0.2.jar
Browse API documentation	API docs (0.2)	API docs (0.2)

Feedback

If you would like to contact the author, feel free to send an email to:

Ernst de Haan (znerd at FreeBSD dot org)