Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkersten2005-07-03 23:46:32 +0000
committermkersten2005-07-03 23:46:32 +0000
commitee6ac73ab30f180f3c8d322376fd4465e4959db6 (patch)
tree53ef7be28b7be15ffb0b645e64fdd18e2b9f32d6
parentfae4c621558630827c5e3cf2aabcd5093e3d806e (diff)
downloadorg.eclipse.mylyn.tasks-ee6ac73ab30f180f3c8d322376fd4465e4959db6.tar.gz
org.eclipse.mylyn.tasks-ee6ac73ab30f180f3c8d322376fd4465e4959db6.tar.xz
org.eclipse.mylyn.tasks-ee6ac73ab30f180f3c8d322376fd4465e4959db6.zip
Documentation improvements
-rw-r--r--org.eclipse.mylyn.bugzilla.core/toc.xml2
-rw-r--r--org.eclipse.mylyn.help.ui/.classpath1
-rw-r--r--org.eclipse.mylyn.help.ui/META-INF/MANIFEST.MF2
-rw-r--r--org.eclipse.mylyn.help.ui/book.css1
-rw-r--r--org.eclipse.mylyn.help.ui/developer/dependencies.vsdbin0 -> 42496 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/developer/model.vsdbin0 -> 144384 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/plugin.xml1
-rw-r--r--org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/doc/MylarDocPlugin.java66
-rw-r--r--org.eclipse.mylyn.help.ui/toc.xml5
-rw-r--r--org.eclipse.mylyn.help.ui/user/limitations.html21
-rw-r--r--org.eclipse.mylyn.help.ui/user/new.html58
-rw-r--r--org.eclipse.mylyn.help.ui/user/overview.html19
12 files changed, 104 insertions, 72 deletions
diff --git a/org.eclipse.mylyn.bugzilla.core/toc.xml b/org.eclipse.mylyn.bugzilla.core/toc.xml
index a9f4ee29b..0e7d5de97 100644
--- a/org.eclipse.mylyn.bugzilla.core/toc.xml
+++ b/org.eclipse.mylyn.bugzilla.core/toc.xml
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
-<toc label="Bugzilla: Bugzilla Database Server Querying" topic="docs/html/book.html">
+<toc label="Bugzilla Client User Guide" topic="docs/html/book.html">
<topic label="Getting Started" href="docs/html/start.html">
<topic label="Bugzilla Setup" href="docs/html/start/setup.html"/>
<topic label="Using Bugzilla" href="docs/html/start/use.html">
diff --git a/org.eclipse.mylyn.help.ui/.classpath b/org.eclipse.mylyn.help.ui/.classpath
index 9a0869b45..ddf0f401d 100644
--- a/org.eclipse.mylyn.help.ui/.classpath
+++ b/org.eclipse.mylyn.help.ui/.classpath
@@ -3,5 +3,4 @@
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
<classpathentry kind="output" path="bin"/>
- <classpathentry kind="src" path="src"/>
</classpath>
diff --git a/org.eclipse.mylyn.help.ui/META-INF/MANIFEST.MF b/org.eclipse.mylyn.help.ui/META-INF/MANIFEST.MF
index b9015e068..0af9b6d29 100644
--- a/org.eclipse.mylyn.help.ui/META-INF/MANIFEST.MF
+++ b/org.eclipse.mylyn.help.ui/META-INF/MANIFEST.MF
@@ -3,12 +3,10 @@ Bundle-ManifestVersion: 2
Bundle-Name: Mylar Documentation Plugin
Bundle-SymbolicName: org.eclipse.mylar.doc; singleton:=true
Bundle-Version: 0.2.5
-Bundle-Activator: org.eclipse.mylar.doc.MylarDocPlugin
Bundle-Localization: plugin
Require-Bundle: org.eclipse.ui,
org.eclipse.core.runtime,
org.eclipse.core.resources
Eclipse-AutoStart: true
Bundle-Vendor: University of British Columbia
-Export-Package: org.eclipse.mylar.doc
Bundle-ClassPath: mylar-doc.jar
diff --git a/org.eclipse.mylyn.help.ui/book.css b/org.eclipse.mylyn.help.ui/book.css
new file mode 100644
index 000000000..84d8880f2
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/book.css
@@ -0,0 +1 @@
+@import "../PRODUCT_PLUGIN/book.css";
diff --git a/org.eclipse.mylyn.help.ui/developer/dependencies.vsd b/org.eclipse.mylyn.help.ui/developer/dependencies.vsd
new file mode 100644
index 000000000..1ece91b2c
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/developer/dependencies.vsd
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/developer/model.vsd b/org.eclipse.mylyn.help.ui/developer/model.vsd
new file mode 100644
index 000000000..168c5f186
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/developer/model.vsd
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/plugin.xml b/org.eclipse.mylyn.help.ui/plugin.xml
index 6bc9f066d..3d6a70d67 100644
--- a/org.eclipse.mylyn.help.ui/plugin.xml
+++ b/org.eclipse.mylyn.help.ui/plugin.xml
@@ -2,7 +2,6 @@
<?eclipse version="3.0"?>
<?eclipse version="3.0"?>
<plugin>
-
<extension
id="org.eclipse.mylar.helpDocs"
name="Mylar Help"
diff --git a/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/doc/MylarDocPlugin.java b/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/doc/MylarDocPlugin.java
deleted file mode 100644
index 9b47f20d3..000000000
--- a/org.eclipse.mylyn.help.ui/src/org/eclipse/mylyn/doc/MylarDocPlugin.java
+++ /dev/null
@@ -1,66 +0,0 @@
-/*******************************************************************************
- * Copyright (c) 2004 - 2005 University Of British Columbia 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:
- * University Of British Columbia - initial API and implementation
- *******************************************************************************/
-package org.eclipse.mylar.doc;
-
-import org.eclipse.ui.plugin.*;
-import org.eclipse.jface.resource.ImageDescriptor;
-import org.osgi.framework.BundleContext;
-
-/**
- * The main plugin class to be used in the desktop.
- */
-public class MylarDocPlugin extends AbstractUIPlugin {
- //The shared instance.
- private static MylarDocPlugin plugin;
-
- /**
- * The constructor.
- */
- public MylarDocPlugin() {
- super();
- plugin = this;
- }
-
- /**
- * This method is called upon plug-in activation
- */
- @Override
- public void start(BundleContext context) throws Exception {
- super.start(context);
- }
-
- /**
- * This method is called when the plug-in is stopped
- */
- @Override
- public void stop(BundleContext context) throws Exception {
- super.stop(context);
- plugin = null;
- }
-
- /**
- * Returns the shared instance.
- */
- public static MylarDocPlugin getDefault() {
- return plugin;
- }
-
- /**
- * Returns an image descriptor for the image file at the given
- * plug-in relative path.
- *
- * @param path the path
- * @return the image descriptor
- */
- public static ImageDescriptor getImageDescriptor(String path) {
- return AbstractUIPlugin.imageDescriptorFromPlugin("org.eclipse.mylar.doc", path);
- }
-}
diff --git a/org.eclipse.mylyn.help.ui/toc.xml b/org.eclipse.mylyn.help.ui/toc.xml
index 7f0d028c1..a6d0284bf 100644
--- a/org.eclipse.mylyn.help.ui/toc.xml
+++ b/org.eclipse.mylyn.help.ui/toc.xml
@@ -1,5 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
-<toc label="Mylar" topic="docs/html/book.html">
+<toc label="Mylar User Guide">
+ <topic label="Overview" href="user/overview.html"/>
+ <topic label="What's New" href="user/new.html"/>
+ <topic label="Known Limitations" href="user/limitations.html"/>
</toc>
diff --git a/org.eclipse.mylyn.help.ui/user/limitations.html b/org.eclipse.mylyn.help.ui/user/limitations.html
new file mode 100644
index 000000000..0d63137be
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/limitations.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <meta http-equiv="Content-Style-Type" content="text/css">
+ <title>
+ Preparing Eclipse
+ </title>
+ </head>
+ <body>
+ <h1>
+ Known Limitations</h1>
+ <p>Folding must be toggled off in order to view all the matches for &quot;mark
+ occurrences&quot;.&nbsp; This is not a Mylar-specific limitation but is more
+ noticeable when Automatic Folding is enabled.</p>
+
+ </body>
+</html>
+
diff --git a/org.eclipse.mylyn.help.ui/user/new.html b/org.eclipse.mylyn.help.ui/user/new.html
new file mode 100644
index 000000000..1eb8e24f0
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/new.html
@@ -0,0 +1,58 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+<meta http-equiv="Content-Language" content="en-us">
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1"
+ type="text/css">
+<title>What's New in 3.1</title>
+</head>
+<body>
+<h2>What's New in 0.3</h2>
+<table cellpadding="10" cellspacing="0" width="600">
+ <colgroup>
+ <col width="20%" valign="top" align="right">
+ <col width="80%" valign="top" align="left">
+ </colgroup>
+ <tbody>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+ <tr>
+ <td width="30%" valign="top" align="left">
+ <p align="right"><b>new 1</b></p>
+ </td>
+ <td width="70%" valign="top">
+ ...
+ <p><img src="images/FirstContact.png" alt="New Java Project wizard"
+ title="New Java Project Wizard"></p>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+ <tr>
+ <td align="left" valign="top" width="30%">
+ <p align="right"><b>new 2</b></p>
+ </td>
+ <td valign="top" width="70%">...
+ <p><img alt="Change compliance quick fix"
+ src="images/change-compliance-quickfix.png"></p>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+</body>
+</html>
diff --git a/org.eclipse.mylyn.help.ui/user/overview.html b/org.eclipse.mylyn.help.ui/user/overview.html
new file mode 100644
index 000000000..a15b6d298
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/overview.html
@@ -0,0 +1,19 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+ <link rel="stylesheet" href="../book.css" charset="ISO-8859-1" type="text/css">
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+ <meta http-equiv="Content-Style-Type" content="text/css">
+ <title>
+ Preparing Eclipse
+ </title>
+ </head>
+ <body>
+ <h1>
+ Mylar Overview</h1>
+ <p>...</p>
+
+ </body>
+</html>
+

Back to the top