Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkersten2005-07-11 05:47:13 +0000
committermkersten2005-07-11 05:47:13 +0000
commit30de60f4ad29eefd2d9c0b75b956af406d227681 (patch)
treec74fd29c103a8e43598075c17c74a8d67e3ffa07 /org.eclipse.mylyn.help.ui
parent5846b4309526d5701e421a0ee51ed9f564633b79 (diff)
downloadorg.eclipse.mylyn.tasks-30de60f4ad29eefd2d9c0b75b956af406d227681.tar.gz
org.eclipse.mylyn.tasks-30de60f4ad29eefd2d9c0b75b956af406d227681.tar.xz
org.eclipse.mylyn.tasks-30de60f4ad29eefd2d9c0b75b956af406d227681.zip
Doc updates
Diffstat (limited to 'org.eclipse.mylyn.help.ui')
-rw-r--r--org.eclipse.mylyn.help.ui/toc.xml3
-rw-r--r--org.eclipse.mylyn.help.ui/user/limitations.html8
-rw-r--r--org.eclipse.mylyn.help.ui/user/overview.html38
3 files changed, 41 insertions, 8 deletions
diff --git a/org.eclipse.mylyn.help.ui/toc.xml b/org.eclipse.mylyn.help.ui/toc.xml
index a6d0284bf..2ae474f3f 100644
--- a/org.eclipse.mylyn.help.ui/toc.xml
+++ b/org.eclipse.mylyn.help.ui/toc.xml
@@ -3,6 +3,7 @@
<toc label="Mylar User Guide">
<topic label="Overview" href="user/overview.html"/>
- <topic label="What's New" href="user/new.html"/>
+ <!--<topic label="What's New" href="user/new.html"/>-->
+ <topic label="Tips & Tricks" href="user/tips.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
index 737e64df5..bb85e4e90 100644
--- a/org.eclipse.mylyn.help.ui/user/limitations.html
+++ b/org.eclipse.mylyn.help.ui/user/limitations.html
@@ -12,12 +12,12 @@
<body>
<h1>
Known Limitations</h1>
- <p>Supported platforms</p>
+ <p><b>Supported platforms</b></p>
<ul>
- <li>Must be using an Eclipse 3.1 final based IDE (e.g. the 3.1m5a based
- JBossIDE is not supported)</li>
- <li>Must be running on a Java 5 VM</li>
+ <li>Eclipse 3.1 final or later (e.g. the 3.1m5a based JBossIDE is not supported)</li>
+ <li>Java 5 VM or later</li>
</ul>
+ <p><b>Java editing</b></p>
<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>
diff --git a/org.eclipse.mylyn.help.ui/user/overview.html b/org.eclipse.mylyn.help.ui/user/overview.html
index 00a2c1e5e..bb9e091bd 100644
--- a/org.eclipse.mylyn.help.ui/user/overview.html
+++ b/org.eclipse.mylyn.help.ui/user/overview.html
@@ -12,10 +12,42 @@
<body>
<h1>
Mylar Overview</h1>
- <p>Task list</p>
+ <p>This initial release of Mylar is not well documented.&nbsp; More complete
+ documentation in the 0.3.2 release, scheduled for July 18, 2005.&nbsp;
+ Please check the update site again on Tuesday July 12 for a an interim
+ update.&nbsp; For questions about usage please email
+ <a href="mailto:mylar-users@eclipse.org">mylar-users@eclipse.org</a> or
+ <a href="mailto:mylar@cs.ubc.ca">mylar@cs.ubc.ca</a> </p>
+ <p>To start using Mylar</p>
<ul>
- <li>To select an item you have to click the space before the glasses or
- the icon.</li>
+ <li>Open the Mylar / Task List view</li>
+ <li>Create a new task<ul>
+ <li>Tasks can also be bug reports, but you must configure the
+ Bugzilla server first (Preferences -&gt; Bugzilla)</li>
+ </ul>
+ </li>
+ <li>Activate a task by clicking the gray outline of the glasses to the
+ left of the task icon.&nbsp; Deactivate by clicking again.</li>
+ <li>Start working on the task, Mylar will be monitoring the task context<ul>
+ <li>After you deactivate the task the context will be saved for
+ re-activating at a later time</li>
+ </ul>
+ </li>
+ <li>Whenever the Mylar glasses appear on the toolbar of a view (e.g.
+ Outline, Package Explorer, Problems List) you can click these in order
+ to enable Mylar degree-of-interest filtering.&nbsp; Toggle this button
+ to return the view to its original state.<ul>
+ <li>To temporarily show all of the children for a node, &lt;alt&gt;click
+ the node.&nbsp; Note that this won't work for the currently-selected
+ view.</li>
+ </ul>
+ </li>
+ <li>In addition to filtering, the Task Context can also be highlighted.&nbsp;
+ Right click a task to select a highlighter.<ul>
+ <li>Note that to select an item you have to click the space before
+ the glasses or the icon.</li>
+ </ul>
+ </li>
</ul>
</body>

Back to the top