org.eclipse.linuxtools.tracing.rcp.help/build.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <project name="org.eclipse.linuxtools.tracing.rcp.help" default="build">
   3     <description>
   4             Generate Eclipse help content for the Linux Tools Trace Viewer 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/Trace_Viewer/User_Guide" />
  10     <property name="ug.title" value="Trace Viewer User Guide" />
  11
  12     <path id="wikitext.tasks.classpath">
  13         <!-- Search in the local Eclipse installation directory for the Wikitext plugin -->
  14         <fileset dir="${eclipse.home}/plugins" erroronmissingdir="false">
  15             <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
  16         </fileset>
  17
  18         <!-- Search in the system-wide installation directory (Debian) -->
  19         <fileset dir="/usr/share/eclipse/dropins/mylyn-wikitext/eclipse/plugins" erroronmissingdir="false">
  20             <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
  21         </fileset>
  22
  23         <!-- For Maven builds: use the compile_classpath -->
  24         <pathelement path="${compile_classpath}" />
  25     </path>
  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     <!-- Different location in more recent versions of Mylyn (Luna ?) -->
  30     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
  31
  32     <target name="build" description="Generate Eclipse help content for the Linux Tools Trace Viewer User Guide">
  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     </target>
  49
  50     <target name="test" description="Verify that all of the HTML files are well-formed XML">
  51         <!--
  52         Don't bother with DTD validation: we only care if the files are well-formed.
  53         We therefore provide an empty DTD
  54         -->
  55         <xmlvalidate lenient="true">
  56             <fileset dir="doc">
  57                 <include name="**/*.html" />
  58             </fileset>
  59             <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
  60         </xmlvalidate>
  61     </target>
  62
  63
  64     <!-- If you need a proxy for the "download" target, set it here -->
  65     <!--
  66     <setproxy proxyhost="host" proxyport="port"/>
  67     -->
  68
  69     <target name="download" description="Download the current contents of the LTTng User Guide from the Eclipse wiki">
  70         <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
  71             <path name="${ug.path}" title="${ug.title}" generateToc="false" />
  72             <stylesheet url="book.css" />
  73             <pageAppendum>
  74 = Updating This Document =
  75
  76 This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit
  77 http://wiki.eclipse.org/Linux_Tools_Project/LTTng2/User_Guide.
  78             </pageAppendum>
  79         </mediawiki-to-eclipse-help>
  80     </target>
  81
  82     <target name ="clean" description="Delete all generated files">
  83       <delete failonerror="false" includeemptydirs="true">
  84         <!-- Files under doc/ (generated locally) -->
  85         <fileset dir="doc" includes="**/*.html" />
  86         <fileset dir="doc" includes="**/*.xml" />
  87
  88         <!-- Files downloaded from the Eclipse wiki -->
  89         <fileset dir="Linux_Tools_Project" />
  90         <fileset file="toc.xml" />
  91       </delete>
  92     </target>
  93
  94 </project>