doc/org.eclipse.tracecompass.gdbtrace.doc.user/build.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3    Copyright (c) 2013 Ericsson
   4
   5    All rights reserved. This program and the accompanying materials
   6    are made available under the terms of the Eclipse Public License v1.0
   7    which accompanies this distribution, and is available at
   8    http://www.eclipse.org/legal/epl-v10.html
   9 -->
  10 <project name="org.eclipse.tracecompass.gdbtrace.doc.user" default="build">
  11     <description>
  12             Generate Eclipse help content for the Trace Compass GDB Tracepoint Analysis user guide
  13     </description>
  14
  15     <!-- Set correct values -->
  16     <property name="help.doc.url.base" value="http://wiki.eclipse.org" />
  17     <property name="ug.path"  value="Linux_Tools_Project/GDB_Tracepoint_Analysis/User_Guide" />
  18     <property name="ug.title" value="GDB Tracepoint Analysis User Guide" />
  19
  20     <path id="wikitext.tasks.classpath">
  21         <!-- Search in the local Eclipse plugins directory for the Wikitext plugin -->
  22         <fileset dir="${osgi.syspath}" erroronmissingdir="false">
  23             <include name="org.eclipse.mylyn.wikitext.*core*.jar" />
  24             <include name="com.google.guava_*.jar" />
  25         </fileset>
  26
  27         <!-- For Maven builds: use the compile_classpath -->
  28         <pathelement path="${compile_classpath}" />
  29     </path>
  30
  31     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/internal/wikitext/mediawiki/core/tasks/tasks.properties" />
  32     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties" />
  33     <!-- Different location in more recent versions of Mylyn (Luna ?) -->
  34     <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/ant/tasks.properties" />
  35
  36     <target name="build" description="Generate Eclipse help content for the Linux Tools GDB Tracepoint Analysis User Guide">
  37         <wikitext-to-eclipse-help markupLanguage="MediaWiki"
  38                 validate="true"
  39                 failonvalidationerror="true"
  40                 overwrite="true"
  41                 multipleOutputFiles="true"
  42                 navigationimages="true"
  43                 title="${ug.title}"
  44                 formatoutput="true"
  45                 helpPrefix="doc">
  46                 <fileset dir="./doc">
  47                    <include name="User-Guide.mediawiki" />
  48                 </fileset>
  49                 <stylesheet url="book.css" />
  50             </wikitext-to-eclipse-help>
  51           <antcall target="test" />
  52     </target>
  53
  54     <target name="test" description="Verify that all of the HTML files are well-formed XML">
  55         <!--
  56         Don't bother with DTD validation: we only care if the files are well-formed.
  57         We therefore provide an empty DTD
  58         -->
  59         <xmlvalidate lenient="true">
  60             <fileset dir="doc">
  61                 <include name="**/*.html" />
  62             </fileset>
  63             <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location=".empty.dtd" />
  64         </xmlvalidate>
  65     </target>
  66
  67     <!-- If you need a proxy for the "download" target, set it here -->
  68     <!--
  69     <setproxy proxyhost="host" proxyport="port"/>
  70     -->
  71
  72     <target name="download" description="Download the current contents of the GDB Tracepoint Analysis User Guide from the Eclipse wiki">
  73         <mediawiki-to-eclipse-help wikiBaseUrl="${help.doc.url.base}" title="${ug.title}" formatoutput="true" dest="." templateExcludes="*eclipseproject*">
  74             <path name="${ug.path}" title="${ug.title}" generateToc="false" />
  75             <stylesheet url="book.css" />
  76             <pageAppendum>
  77 = Updating This Document =
  78
  79 This document is maintained in a collaborative wiki.  If you wish to update or modify this document please visit
  80 http://wiki.eclipse.org/Linux_Tools_Project/GDB_Tracepoint_Analysis/User_Guide.
  81             </pageAppendum>
  82         </mediawiki-to-eclipse-help>
  83     </target>
  84
  85     <target name ="clean" description="Delete all generated files">
  86       <delete failonerror="false" includeemptydirs="true">
  87         <!-- Files under doc/ (generated locally) -->
  88         <fileset dir="doc" includes="**/*.html" />
  89         <fileset dir="doc" includes="**/*.xml" />
  90
  91         <!-- Files downloaded from the Eclipse wiki -->
  92         <fileset dir="Linux_Tools_Project" />
  93         <fileset file="toc.xml" />
  94       </delete>
  95     </target>
  96
  97 </project>