Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 672ce0ccf3713127352c865f67804cc1b9c9157c (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?xml version="1.0" encoding="UTF-8"?>
<project name="org.eclipse.linuxtools.docker.docs" default="all">
    <description>
            Generate Eclipse help content for the Linux Tools Docker Tooling user guide
    </description>

    <property name="help.doc.url.base" value="http://wiki.eclipse.org" />

    <path id="tasks.classpath" path="bin" />
    <path id="wikitext.classpath">
        <!-- Replace dir with the dir you have wikitext installed into.-->
        <fileset dir="/usr/share/eclipse/droplets/mylyn-docs/eclipse/plugins">
            <include name="*.jar" />
        </fileset>
    </path>

    <taskdef classpathref="wikitext.classpath" resource="org/eclipse/mylyn/wikitext/mediawiki/core/ant/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 Docker Tooling user guide">
        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="Docker Tooling User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*,Linux_Tools">

            <path name="Linux_Tools_Project/Docker_Tooling/User_Guide" title="Docker Tooling User Guide" 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/Docker_Tooling/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="tmp/__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="${basedir}/tmp/__empty.dtd" />
        </xmlvalidate>
        <delete dir="tmp" />
    </target>
</project>

Back to the top