More java-doc updates

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.help / build-helper.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="org.eclipse.linuxtools.lttng.help" default="all">
    <description>
            Generate Eclipse help content for the Linux Tools LTTng user guide
    </description>

	<!-- Set correct values -->
    <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
    <property name="ug.path"  value="Linux_Tools_Project/LTTng/User_Guide" />
    <property name="ug.title" value="LTTng Plug-in User Guide" />

	<!-- Replace dir with the dir you have eclipse installed into.-->
	<property name="eclipse.dir" value="/home/francois/Eclipse/Indigo" />
	<property name="temp.dir" value="/home/francois/tmp" />

    <path id="wikitext.tasks.classpath">
        <fileset dir="${eclipse.dir}/plugins">
            <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
        </fileset>
    </path>

    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />

    <target name="all" description="Generate Eclipse help content for the Linux Tools LTTng User Guide">
        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
            <path name="${ug.path}" title="${ug.title}" generateToc="false" />
            <stylesheet url="book.css" />
            <pageAppendum>
= Updating This Document =

This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit 
http://wiki.eclipse.org/Linux_Tools_Project/LTTng/User_Guide .
                 </pageAppendum>
        </mediawiki-to-eclipse-help>
        <antcall target="test" />
    </target>

    <target name="test" description="Verify that all of the HTML files are well-formed XML">
        <echo level="info">
Validating help content XML and HTML files: The Eclipse help system expects well-formed XML
            
If validation fails it is because either:
            
* the userguide source code is poorly formed, or
* the WikiText MediaWiki parser has a bug
            
Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source,
or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block)
        </echo>

        <!-- 
        Don't bother with DTD validation: we only care if the files are well-formed.
        We therefore provide an empty DTD 
        -->
        <echo file="${temp.dir}/__empty.dtd" message="" />
        <xmlvalidate lenient="true">
            <fileset dir="Linux_Tools_Project">
                <include name="**/*.html" />
            </fileset>
            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${temp.dir}/__empty.dtd" />
        </xmlvalidate>
        <delete file="${temp.dir}/__empty.dtd" />
    </target>
</project>