Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDaniel Henrique Barboza2012-02-17 19:10:01 +0000
committerDaniel Henrique Barboza2012-03-02 12:00:05 +0000
commitc819606d66b6a0d1185176cf70bce2ac44937cfc (patch)
treed3e16d4fcab0418c20fc8bdea3d3ecbdfacd27f5 /perf/org.eclipse.linuxtools.perf.doc/build-helper.xml
parent664669d5da4f2d743e6f7b6fc533a28390b8de1e (diff)
downloadorg.eclipse.linuxtools-c819606d66b6a0d1185176cf70bce2ac44937cfc.tar.gz
org.eclipse.linuxtools-c819606d66b6a0d1185176cf70bce2ac44937cfc.tar.xz
org.eclipse.linuxtools-c819606d66b6a0d1185176cf70bce2ac44937cfc.zip
Initial version of the Perf documentation plug-in
Diffstat (limited to 'perf/org.eclipse.linuxtools.perf.doc/build-helper.xml')
-rw-r--r--perf/org.eclipse.linuxtools.perf.doc/build-helper.xml60
1 files changed, 60 insertions, 0 deletions
diff --git a/perf/org.eclipse.linuxtools.perf.doc/build-helper.xml b/perf/org.eclipse.linuxtools.perf.doc/build-helper.xml
new file mode 100644
index 0000000000..51cb952a15
--- /dev/null
+++ b/perf/org.eclipse.linuxtools.perf.doc/build-helper.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project name="org.eclipse.linuxtools.perf.doc" default="all">
+ <description>
+ Generate Eclipse help content for the Linux Tools Perf user guide
+ </description>
+
+ <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
+
+ <path id="wikitext.tasks.classpath">
+ <!-- Replace dir with the dir you have wikitext installed into.-->
+ <fileset dir="/home/daniels/PowerIDE/devel/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 Perf user guide">
+ <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="Perf User Guide" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
+
+ <path name="Linux_Tools_Project/PERF/User_Guide" title="Perf 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/PERF/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