1 <?xml version=
"1.0" encoding=
"UTF-8"?>
2 <project name=
"org.eclipse.linuxtools.lttng.help" default=
"all">
4 Generate Eclipse help content for the Linux Tools LTTng user guide
7 <!-- Set correct values -->
8 <property name=
"help.doc.url.base" value=
"http://wiki.eclipse.org" />
9 <property name=
"ug.path" value=
"Linux_Tools_Project/LTTng2/User_Guide" />
10 <property name=
"ug.title" value=
"LTTng Plug-in User Guide" />
12 <!-- Replace dir with the dir you have eclipse installed into.-->
13 <property name=
"eclipse.dir" value=
"/home/francois/Eclipse/Indigo" />
14 <property name=
"temp.dir" value=
"/home/francois/tmp" />
16 <path id=
"wikitext.tasks.classpath">
17 <fileset dir=
"${eclipse.dir}/plugins">
18 <include name=
"org.eclipse.mylyn.wikitext.*core*.jar" />
22 <!-- Uncomment and set proxy host and port if necessary -->
24 <setproxy proxyhost="host" proxyport="port"/>
27 <taskdef classpathref=
"wikitext.tasks.classpath" resource=
"org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
28 <taskdef classpathref=
"wikitext.tasks.classpath" resource=
"org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
30 <target name=
"all" description=
"Generate Eclipse help content for the Linux Tools LTTng User Guide">
33 <wikitext-to-eclipse-help markupLanguage=
"MediaWiki"
35 failonvalidationerror=
"true"
37 multipleOutputFiles=
"true"
38 navigationimages=
"true"
43 <include name=
"User-Guide.mediawiki" />
45 <stylesheet url=
"book.css" />
46 </wikitext-to-eclipse-help>
47 <antcall target=
"test" />
49 <mediawiki-to-eclipse-help wikiBaseUrl=
"${help.doc.url.base}" title=
"${ug.title}" formatoutput=
"true" dest=
"." templateExcludes=
"*eclipseproject*">
50 <path name=
"${ug.path}" title=
"${ug.title}" generateToc=
"false" />
51 <stylesheet url=
"book.css" />
53 = Updating This Document =
55 This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
56 http://wiki.eclipse.org/Linux_Tools_Project/LTTng2/User_Guide.
58 </mediawiki-to-eclipse-help>
63 <target name=
"test" description=
"Verify that all of the HTML files are well-formed XML">
65 Validating help content XML and HTML files: The Eclipse help system expects well-formed XML
67 If validation fails it is because either:
69 * the userguide source code is poorly formed, or
70 * the WikiText MediaWiki parser has a bug
72 Problems with userguide source are usually caused by improper use of HTML markup in the MediaWiki source,
73 or inadvertently starting a line with a space character (in MediaWiki this starts a preformatted block)
77 Don't bother with DTD validation: we only care if the files are well-formed.
78 We therefore provide an empty DTD
80 <echo file=
"${temp.dir}/__empty.dtd" message=
"" />
81 <xmlvalidate lenient=
"true">
83 <include name=
"**/*.html" />
85 <dtd publicid=
"-//W3C//DTD XHTML 1.0 Transitional//EN" location=
"${temp.dir}/__empty.dtd" />
87 <delete file=
"${temp.dir}/__empty.dtd" />