doc: Bug 495211. Add flat/hierarchical threads presentation user guide

[deliverable/tracecompass.git] / doc / org.eclipse.tracecompass.rcp.doc.user / build.xml

<?xml version="1.0" encoding="UTF-8"?>
<project name="org.eclipse.tracecompass.rcp.doc.user" default="build">
    <description>
            Generate Eclipse help content for the Trace Compass RCP user guide
    </description>

    <property name="document.title" value="Trace Compass RCP User Guide" />

    <path id="wikitext.tasks.classpath">
        <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
        <fileset dir="${osgi.syspath}" erroronmissingdir="false">
            <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
            <include name="com.google.guava_*.jar" />
        </fileset>

        <!-- For Maven builds: use the compile_classpath -->
        <pathelement path="${compile_classpath}" />
    </path>

    <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />

    <target name="build" description="Generate Eclipse help content for the Trace Compass RCP User Guide">
        <wikitext-to-eclipse-help markupLanguage="MediaWiki"
                validate="true"
                failonvalidationerror="true"
                overwrite="true"
                multipleOutputFiles="true"
                navigationimages="true"
                title="${document.title}"
                formatoutput="true"
                helpPrefix="doc">
                <fileset dir="./doc">
                   <include name="User-Guide.mediawiki" />
                </fileset>
                <stylesheet url="book.css" />
            </wikitext-to-eclipse-help>
          <antcall target="test" />
    </target>

    <target name="test" description="Verify that all of the HTML files are well-formed XML">
        <!--
        Don't bother with DTD validation: we only care if the files are well-formed.
        We therefore provide an empty DTD
        -->
        <xmlvalidate lenient="true">
            <fileset dir="doc">
                <include name="**/*.html" />
            </fileset>
            <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="../.empty.dtd" />
        </xmlvalidate>
    </target>

    <target name ="clean" description="Delete all generated files">
      <delete failonerror="false" includeemptydirs="true">
        <fileset dir="doc" includes="**/*.html" />
        <fileset dir="doc" includes="**/*.xml" />
      </delete>
    </target>
    <target name="build.index" description="Builds search index for the plug-in" if="eclipse.running">
      <help.buildHelpIndex manifest="${basedir}/plugin.xml" destination="${basedir}" />
    </target>
</project>