Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 7ed4d4b2ee0f03d3005aea6090685869300dbcac (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
62
63
64
<?xml version="1.0" encoding="UTF-8"?>
<!--
   Copyright (c) 2010, 2018 Chris Aniszczyk and others.
    
   This program and the accompanying materials are made
   available under the terms of the Eclipse Public License 2.0
   which is available at https://www.eclipse.org/legal/epl-2.0/
  
   SPDX-License-Identifier: EPL-2.0

   Contributors:
       Chris Aniszczyk <caniszczyk@gmail.com> - initial API and implementation
 -->

<project name="org.eclipse.mylyn.wikitext.example" default="all">
    <description>
            Generate Eclipse help content from the Eclipsepedia wiki
    </description>

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

    <target name="all" description="Generate Eclipse help content for the Linux Tools Callgraph user guide">
        <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="Callgraph User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">

            <path name="Linux_Tools_Project/Callgraph/User_Guide" title="Callgraph 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/Callgraph/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