Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.mylyn.help.ui/build-helper.xml')
-rw-r--r--org.eclipse.mylyn.help.ui/build-helper.xml140
1 files changed, 0 insertions, 140 deletions
diff --git a/org.eclipse.mylyn.help.ui/build-helper.xml b/org.eclipse.mylyn.help.ui/build-helper.xml
deleted file mode 100644
index 125b46340..000000000
--- a/org.eclipse.mylyn.help.ui/build-helper.xml
+++ /dev/null
@@ -1,140 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?><!--
- Copyright (c) 2009 Tasktop Technologies and others.
- All rights reserved. This program and the accompanying materials
- are made available under the terms of the Eclipse Public License v1.0
- which accompanies this distribution, and is available at
- http://www.eclipse.org/legal/epl-v10.html
-
- Contributors:
- Tasktop Technologies - initial API and implementation
- -->
-
-<project name="org.eclipse.mylyn.help.ui" default="all">
- <description>
- Generate Eclipse help content for the Mylyn user guide
- </description>
-
- <property name="mylyn.help.doc.url.base" value="http://wiki.eclipse.org"/>
- <property name="mylyn.wiki.url.base" value="${mylyn.help.doc.url.base}/Mylyn"/>
- <property name="imageFolder" value="images"/>
-
- <path id="tasks.classpath" path="bin"/>
- <path id="wikitext.tasks.classpath">
- <pathelement location="../org.eclipse.mylyn.wikitext.core/@dot"/>
- <pathelement location="../org.eclipse.mylyn.wikitext.core/bin"/>
- <pathelement location="../org.eclipse.mylyn.wikitext.mediawiki.core/@dot"/>
- <pathelement location="../org.eclipse.mylyn.wikitext.mediawiki.core/bin"/>
- </path>
-
- <taskdef classpathref="tasks.classpath" resource="org/eclipse/mylyn/internal/help/ui/anttask/tasks.properties"/>
- <taskdef classpathref="wikitext.tasks.classpath" resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties"/>
-
- <target name="init">
- <mkdir dir="tmp"/>
- </target>
-
- <target name="clean" depends="init">
- <delete includeemptydirs="true" failonerror="false">
- <fileset dir="tmp"/>
- </delete>
- </target>
-
- <target name="all" depends="init" description="Generate Eclipse help content for the Mylyn user guide">
- <eclipse-wiki-to-help
- help.doc.filenamenoextension="Mylyn Reference"
- help.doc.url.base="${mylyn.help.doc.url.base}"
- help.doc.url.html="${mylyn.help.doc.url.base}/Mylyn/User_Guide"
- help.doc.url.xml="${mylyn.help.doc.url.base}/Special:Export/Mylyn/User_Guide"
- help.imagefolder="${imageFolder}"
- targetfolder="userguide"
- wiki.url.base="${mylyn.help.doc.url.base}/Mylyn"/>
- </target>
-
- <macrodef name="eclipse-wiki-to-help">
- <attribute name="help.doc.url.base"/>
- <attribute name="wiki.url.base"/>
- <attribute name="help.doc.url.html"/>
- <attribute name="help.doc.url.xml"/>
- <attribute name="help.doc.filenameNoExtension"/>
- <attribute name="help.imageFolder"/>
- <attribute name="targetFolder"/>
- <sequential>
- <get dest="tmp/help.doc.xml" src="@{help.doc.url.xml}"/>
- <get dest="tmp/help.doc.html" src="@{help.doc.url.html}"/>
-
- <copy todir="tmp">
- <fileset dir="images"/>
- </copy>
- <mediawiki-fetch-images src="tmp/help.doc.html" dest="tmp" base="@{help.doc.url.base}"/>
-
- <xslt style="extract-markup.xsl" in="tmp/help.doc.xml" out="tmp/@{help.doc.filenameNoExtension}.mediawiki"/>
- <echo append="true" file="tmp/@{help.doc.filenameNoExtension}.mediawiki">
-
-= Updating This Document =
-
-This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit
-@{help.doc.url.html}
- </echo>
-
- <wikitext-to-eclipse-help markupLanguage="org.eclipse.mylyn.wikitext.mediawiki.core.MediaWikiLanguage"
- multipleOutputFiles="true"
- navigationImages="true"
- helpPrefix="@{targetFolder}"
- internallinkpattern="@{wiki.url.base}/{0}"
- validate="true"
- failonvalidationerror="true"
- prependImagePrefix="${imageFolder}"
- formatoutput="true"
- defaultAbsoluteLinkTarget="mylyn_external">
- <fileset dir="tmp" includes="**/*.mediawiki"/>
- <stylesheet url="book.css"/>
- </wikitext-to-eclipse-help>
-
- <mkdir dir="@{targetFolder}/${imageFolder}"/>
- <copy todir="@{targetFolder}/${imageFolder}" overwrite="true">
- <fileset dir="tmp">
- <include name="*.gif"/>
- <include name="*.png"/>
- </fileset>
- </copy>
- <copy todir="@{targetFolder}" overwrite="true">
- <fileset dir="tmp">
- <include name="*.html"/>
- <include name="*toc.xml"/>
- <exclude name="help.doc.html"/>
- </fileset>
- </copy>
- <antcall target="test"/>
- </sequential>
- </macrodef>
-
-
- <target name="test" depends="init" 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="userguide">
- <include name="**/*.xml"/>
- </fileset>
- <fileset dir="userguide">
- <include name="**/*.html"/>
- </fileset>
- <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd"/>
- </xmlvalidate>
- </target>
-</project>

Back to the top