org.eclipse.linuxtools.lttng.help/build-helper.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <project name="org.eclipse.linuxtools.lttng.help" default="all">
   3     <description>
   4             Generate Eclipse help content for the Linux Tools LTTng user guide
   5     </description>
   6
   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" />
  11
  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" />
  15
  16     <path id="wikitext.tasks.classpath">
  17         <fileset dir="${eclipse.dir}/plugins">
  18             <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
  19         </fileset>
  20     </path>
  21
  22         <!-- Uncomment and set proxy host and port if necessary -->
  23         <!--
  24         <setproxy proxyhost="host" proxyport="port"/>
  25         -->
  26
  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" />
  29
  30     <target name="all" description="Generate Eclipse help content for the Linux Tools LTTng User Guide">
  31         <sequential>
  32
  33           <wikitext-to-eclipse-help markupLanguage="MediaWiki"
  34                 validate="true"
  35                 failonvalidationerror="true"
  36                     overwrite="true"
  37                     multipleOutputFiles="true"
  38                 navigationimages="true"
  39                 title="${ug.title}"
  40                 formatoutput="true"
  41                     helpPrefix="doc">
  42                     <fileset dir="./doc">
  43                        <include name="User-Guide.mediawiki" />
  44                     </fileset>
  45                 <stylesheet url="book.css" />
  46             </wikitext-to-eclipse-help>
  47           <antcall target="test" />
  48
  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" />
  52             <pageAppendum>
  53 = Updating This Document =
  54
  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.
  57                  </pageAppendum>
  58         </mediawiki-to-eclipse-help>
  59
  60         </sequential>
  61     </target>
  62
  63     <target name="test" description="Verify that all of the HTML files are well-formed XML">
  64         <echo level="info">
  65 Validating help content XML and HTML files: The Eclipse help system expects well-formed XML
  66
  67 If validation fails it is because either:
  68
  69 * the userguide source code is poorly formed, or
  70 * the WikiText MediaWiki parser has a bug
  71
  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)
  74         </echo>
  75
  76         <!--
  77         Don't bother with DTD validation: we only care if the files are well-formed.
  78         We therefore provide an empty DTD
  79         -->
  80         <echo file="${temp.dir}/__empty.dtd" message="" />
  81         <xmlvalidate lenient="true">
  82             <fileset dir="doc">
  83                 <include name="**/*.html" />
  84             </fileset>
  85             <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${temp.dir}/__empty.dtd" />
  86         </xmlvalidate>
  87         <delete file="${temp.dir}/__empty.dtd" />
  88     </target>
  89 </project>