My lazy header ...

AntDocGUI
Target antdoc.example.template

antdoc.example.template

A template that should be used as a reference for beginners

This target is full-featured template on how to use the AntDoc Ant task. You may copy and paste this template in order to discover most of the AntDoc options. However, the AntDoc options used here are not exhaustive. See the AntDoc manual for a complete explanation.

Detail:
<target
	description="A template that should be used as a reference for beginners"
	name="antdoc.example.template"
>
	<property
		name="ANTDOC_DESTINATION"
		value="../../antdoc"
	/>

	<mkdir dir="${ANTDOC_DESTINATION}"/>

	<get
		dest="${ANTDOC_DESTINATION}/welcome.html"
		src="http://jakarta.apache.org"
	/>

	<get
		dest="${ANTDOC_DESTINATION}/AntDoc_forAntDoc.html"
		src="http://antdoc.free.fr/example/AntDoc_forAntDoc.css"
	/>

	<tstamp>
		<format
			pattern="yyyy.MM.dd HH:mm:ss"
			property="TIME_STAMP"
		/>
	</tstamp>

	<echo>AntDoc documentation will be generated in the '${ANTDOC_DESTINATION}' directory</echo>

	<echo>This directory contains the index.html file that should be opened in order to view the documentation</echo>

	<echo>The "destination" is where the generated files are yielded</echo>

	<echo>The "runtime" tells to generate the applet that will enable to connect to AntDocGUI and execute targets directly from the
                        HTML</echo>

	<echo>The "hide" tells AntDoc not to generate documentation for a target with no explicit description (target "description" attribute
                        missing or empty)</echo>

	<echo>...</echo>

	<taskdef
		classname="org.ed.pack.ant.AntDoc"
		name="AntDoc"
	/>

	<AntDoc
		css="${ANTDOC_DESTINATION}/AntDoc_forAntDoc.html"
		destination="${ANTDOC_DESTINATION}"
		hide="true"
		processor="org.apache.xalan.processor.TransformerFactoryImpl"
		runtime="yes"
		welcome="${ANTDOC_DESTINATION}/welcome.html"
	>
		<title>The title of the documentation of your Ant build files<br/>Generation timestamp: ${TIME_STAMP}</title>

		<header>You may put some <b>header</b> here ...</header>

		<footer>... and even more some <font size="+2">footer</font> here</footer>

		<fileset dir=".">
			<include name="AntDocGUI_build.xml"/>
		</fileset>

		<fileset dir="../..">
			<include name="build.xml"/>
		</fileset>
	</AntDoc>
</target>

... is just like my footer!

Edouard Mercier 2003.12.08 20:31:08 - AntDoc V0.8h - XSL Transformer Factory: com.icl.saxon.TransformerFactoryImpl