Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 73561c4eaf282be1adcfdae85f5b4aa3b297f5cb (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
65
66
67
68
69
70
71
<?xml version="1.0" encoding="UTF-8"?>
<!--
    Copyright (c) 2011 Red Hat, Inc.
    All rights reserved. This program and the accompanying materials
    are made available under the terms of the Eclipse Public License v1.0
    which accompanies this distribution, and is available at
    http://www.eclipse.org/legal/epl-v10.html

    Contributors:
        Red Hat - initial API and implementation
 -->
<project name="org.eclipse.linuxtools.gcov.docs" default="all">
    <description>
            Generate Eclipse help content for the Linux Tools gcov user guide
    </description>

    <property name="gcov.help.doc.url.base" value="http://wiki.eclipse.org"/>
    <property name="gcov.wiki.url.base" value="${gcov.help.doc.url.base}/Linux_Tools_Project/GCov"/>
    <property name="imageFolder" value="images"/>

    <path id="wikitext.tasks.classpath">
        <!-- Replace dir with the dir you have wikitext installed into.-->
        <fileset dir="/usr/share/eclipse/dropins/mylyn/eclipse/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 gcov user guide">
        <mediawiki-to-eclipse-help wikiBaseUrl="${gcov.help.doc.url.base}" title="GCov User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">

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