Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorspingel2008-08-13 16:42:48 -0400
committerspingel2008-08-13 16:42:48 -0400
commitd264d08ca41c65c1d23afacfd3dbadcb04d54f4f (patch)
tree0edd3bf94d5456b521bea0386e157e88e574e287 /org.eclipse.mylyn.help.ui
parent4228ed7698dc130a3f33e439fae1a37d2ec6206f (diff)
downloadorg.eclipse.mylyn.tasks-d264d08ca41c65c1d23afacfd3dbadcb04d54f4f.tar.gz
org.eclipse.mylyn.tasks-d264d08ca41c65c1d23afacfd3dbadcb04d54f4f.tar.xz
org.eclipse.mylyn.tasks-d264d08ca41c65c1d23afacfd3dbadcb04d54f4f.zip
ASSIGNED - bug 242979: [patch] generate Eclipse help from wiki user guide
https://bugs.eclipse.org/bugs/show_bug.cgi?id=242979
Diffstat (limited to 'org.eclipse.mylyn.help.ui')
-rw-r--r--org.eclipse.mylyn.help.ui/build-helper.xml (renamed from org.eclipse.mylyn.help.ui/build.xml)2
-rw-r--r--org.eclipse.mylyn.help.ui/build.properties1
-rw-r--r--org.eclipse.mylyn.help.ui/customBuildCallbacks.xml161
-rw-r--r--org.eclipse.mylyn.help.ui/plugin.xml4
-rw-r--r--org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/internal/help/ui/anttask/MediaWikiImageFetcher.java2
-rw-r--r--org.eclipse.mylyn.help.ui/toc.xml4
-rw-r--r--org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml3
-rw-r--r--org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide.html5
8 files changed, 181 insertions, 1 deletions
diff --git a/org.eclipse.mylyn.help.ui/build.xml b/org.eclipse.mylyn.help.ui/build-helper.xml
index 8875fe829..c705bd88d 100644
--- a/org.eclipse.mylyn.help.ui/build.xml
+++ b/org.eclipse.mylyn.help.ui/build-helper.xml
@@ -53,7 +53,9 @@
<taskdef resource="org/eclipse/mylyn/wikitext/core/util/anttask/tasks.properties">
<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"/>
</classpath>
</taskdef>
diff --git a/org.eclipse.mylyn.help.ui/build.properties b/org.eclipse.mylyn.help.ui/build.properties
index a23a4f9a2..159b1cbb8 100644
--- a/org.eclipse.mylyn.help.ui/build.properties
+++ b/org.eclipse.mylyn.help.ui/build.properties
@@ -20,3 +20,4 @@ source.. = src/
jars.compile.order = .
source.. = src/
+customBuildCallbacks=customBuildCallbacks.xml \ No newline at end of file
diff --git a/org.eclipse.mylyn.help.ui/customBuildCallbacks.xml b/org.eclipse.mylyn.help.ui/customBuildCallbacks.xml
new file mode 100644
index 000000000..53cc6beb0
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/customBuildCallbacks.xml
@@ -0,0 +1,161 @@
+<!-- ===================================================================== -->
+<!-- Custom targets called from a project's generated build.xml -->
+<!-- Set customBuildCallbacks=<path/to/this/file> in your build.properties.-->
+<!-- ===================================================================== -->
+<project name="Build specific targets and properties" default="noDefault">
+
+ <!-- ===================================================================== -->
+ <!-- Default target -->
+ <!-- ===================================================================== -->
+ <target name="noDefault">
+ <echo message="This file must be called with explicit targets" />
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target build.jars -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="pre.build.jars">
+ <!-- automatic generation of the user guide is disabled, see bug 242979
+ <ant antfile="build-helper.xml" target="all"/>
+ -->
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target build.jars -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="post.build.jars">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target build.sources -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="pre.build.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target build.sources -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder to contain the build results -->
+ <!-- ===================================================================== -->
+ <target name="post.build.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the compilation target <name> -->
+ <!-- Substitute "name" with the name of the compilation target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- source.foldern : n = 1 ... N, the source folders -->
+ <!-- target.folder : where the results of the compilation go -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="pre.name">
+ </target>
+
+ <target name="pre.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do during the compilation target <name>, after the compile -->
+ <!-- but before jaring. Substitute "name" with the name of the compilation-->
+ <!-- target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- source.foldern : n = 1 ... N, the source folders -->
+ <!-- target.folder : where the results of the compilation go -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="post.compile.name">
+ </target>
+
+ <target name="post.compile.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the compilation target <name> -->
+ <!-- Substitute "name" with the name of the compilation target, eg @dot -->
+ <!-- Available parameters : -->
+ <!-- jar.location - the location of the compilation results -->
+ <!-- <name>.classpath : name = name of the compilation target. A -->
+ <!-- reference to the classpath structure. -->
+ <!-- ===================================================================== -->
+ <target name="post.name">
+ </target>
+
+ <target name="post.@dot">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.bin.parts -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder containing the build results -->
+ <!-- target.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.bin.parts">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.bin.parts -->
+ <!-- Available parameters : -->
+ <!-- build.result.folder - folder containing the build results -->
+ <!-- target.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.bin.parts">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.sources -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.sources -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.sources">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target gather.logs -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.gather.logs">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target gather.logs -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="post.gather.logs">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do before the target clean -->
+ <!-- Available parameters : -->
+ <!-- destination.temp.folder - destination folder -->
+ <!-- ===================================================================== -->
+ <target name="pre.clean">
+ </target>
+
+ <!-- ===================================================================== -->
+ <!-- Steps to do after the target clean -->
+ <!-- Available parameters : -->
+ <!-- plugin.destination - final destination of the build -->
+ <!-- build.result.folder - results of the compilation -->
+ <!-- temp.folder - temporary folder -->
+ <!-- ===================================================================== -->
+ <target name="post.clean">
+ </target>
+</project>
diff --git a/org.eclipse.mylyn.help.ui/plugin.xml b/org.eclipse.mylyn.help.ui/plugin.xml
index 42c9ad877..76e798e41 100644
--- a/org.eclipse.mylyn.help.ui/plugin.xml
+++ b/org.eclipse.mylyn.help.ui/plugin.xml
@@ -10,6 +10,10 @@
file="toc.xml"
primary="true">
</toc>
+ <toc
+ file="userguide/Mylyn User Guide-toc.xml"
+ primary="false">
+ </toc>
</extension>
<extension
diff --git a/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/internal/help/ui/anttask/MediaWikiImageFetcher.java b/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/internal/help/ui/anttask/MediaWikiImageFetcher.java
index 8f226bd50..2ec97b83a 100644
--- a/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/internal/help/ui/anttask/MediaWikiImageFetcher.java
+++ b/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/internal/help/ui/anttask/MediaWikiImageFetcher.java
@@ -24,6 +24,8 @@ import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Get;
/**
+ * Fetch images from a MediaWiki-generated HTML page source
+ *
* @author David Green
*/
public class MediaWikiImageFetcher extends Task {
diff --git a/org.eclipse.mylyn.help.ui/toc.xml b/org.eclipse.mylyn.help.ui/toc.xml
index 1042cce00..d8b4b9e98 100644
--- a/org.eclipse.mylyn.help.ui/toc.xml
+++ b/org.eclipse.mylyn.help.ui/toc.xml
@@ -4,7 +4,9 @@
<toc label="Mylyn" topic="doc/overview.html">
<topic href="doc/overview.html" label="Overview">
</topic>
- <link toc="userguide/Mylyn User Guide-toc.xml"/>
+ <topic href="userguide/Mylyn User Guide.html" label="User Guide">
+ <link toc="userguide/Mylyn User Guide-toc.xml"/>
+ </topic>
<!--
<topic label="What's new" href="doc/new.html" />
<topic label="Tips and tricks" href="doc/tips.html"/>
diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml
new file mode 100644
index 000000000..41e201f3d
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml
@@ -0,0 +1,3 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="userguide/Mylyn User Guide.html" label="Mylyn User Guide">
+</toc> \ No newline at end of file
diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide.html b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide.html
new file mode 100644
index 000000000..cef7ed810
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide.html
@@ -0,0 +1,5 @@
+<html>
+<body>
+Coming soon.
+</body>
+</html> \ No newline at end of file

Back to the top