Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormkersten2005-07-11 18:28:46 +0000
committermkersten2005-07-11 18:28:46 +0000
commit2c6a06ea049cb2fb44170446069167b8bd6c4153 (patch)
tree5a6934b66971d5f330d084f3eae36decc8dfd1fe /org.eclipse.mylyn.help.ui
parent6f511f71b8ede0d5489649355f49ecfb44ae65b8 (diff)
downloadorg.eclipse.mylyn.tasks-2c6a06ea049cb2fb44170446069167b8bd6c4153.tar.gz
org.eclipse.mylyn.tasks-2c6a06ea049cb2fb44170446069167b8bd6c4153.tar.xz
org.eclipse.mylyn.tasks-2c6a06ea049cb2fb44170446069167b8bd6c4153.zip
Updated docs
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/images/alt-click.gifbin0 -> 4851 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/user/images/highlight.gifbin0 -> 8366 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/user/images/interest-manipulate.gifbin0 -> 1438 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/user/images/overview.gifbin57279 -> 63982 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/user/images/search-context.gifbin0 -> 3458 bytes
-rw-r--r--org.eclipse.mylyn.help.ui/user/limitations.html4
-rw-r--r--org.eclipse.mylyn.help.ui/user/new.html58
-rw-r--r--org.eclipse.mylyn.help.ui/user/newnoteworthy.html103
-rw-r--r--org.eclipse.mylyn.help.ui/user/overview.html75
-rw-r--r--org.eclipse.mylyn.help.ui/user/tips.html21
11 files changed, 149 insertions, 115 deletions
diff --git a/org.eclipse.mylyn.help.ui/toc.xml b/org.eclipse.mylyn.help.ui/toc.xml
index 370655874..1d8ba194c 100644
--- a/org.eclipse.mylyn.help.ui/toc.xml
+++ b/org.eclipse.mylyn.help.ui/toc.xml
@@ -3,9 +3,8 @@
<toc label="Mylar User Guide">
<topic label="Overview" href="user/overview.html"/>
- <topic label="Tips & Tricks" href="user/tips.html"/>
+ <topic label="New &amp; Noteworthy" href="user/newnoteworthy.html"/>
<topic label="Known Limitations" href="user/limitations.html"/>
</toc>
-<!--<topic label="What's New" href="user/new.html"/>-->
diff --git a/org.eclipse.mylyn.help.ui/user/images/alt-click.gif b/org.eclipse.mylyn.help.ui/user/images/alt-click.gif
new file mode 100644
index 000000000..fc2a91bcf
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/images/alt-click.gif
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/user/images/highlight.gif b/org.eclipse.mylyn.help.ui/user/images/highlight.gif
new file mode 100644
index 000000000..7368b7f25
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/images/highlight.gif
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/user/images/interest-manipulate.gif b/org.eclipse.mylyn.help.ui/user/images/interest-manipulate.gif
new file mode 100644
index 000000000..5640c2b2a
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/images/interest-manipulate.gif
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/user/images/overview.gif b/org.eclipse.mylyn.help.ui/user/images/overview.gif
index 373552be2..968e2e4b4 100644
--- a/org.eclipse.mylyn.help.ui/user/images/overview.gif
+++ b/org.eclipse.mylyn.help.ui/user/images/overview.gif
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/user/images/search-context.gif b/org.eclipse.mylyn.help.ui/user/images/search-context.gif
new file mode 100644
index 000000000..43aed77ec
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/images/search-context.gif
Binary files differ
diff --git a/org.eclipse.mylyn.help.ui/user/limitations.html b/org.eclipse.mylyn.help.ui/user/limitations.html
index bb85e4e90..bd80d164e 100644
--- a/org.eclipse.mylyn.help.ui/user/limitations.html
+++ b/org.eclipse.mylyn.help.ui/user/limitations.html
@@ -21,7 +21,9 @@
<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>
- <p>&nbsp;</p>
+ <p><b>Bugzilla</b></p>
+ <p>You can only set one bug repository per workspace.&nbsp; Proxy servers
+ are not yet supported.</p>
</body>
</html>
diff --git a/org.eclipse.mylyn.help.ui/user/new.html b/org.eclipse.mylyn.help.ui/user/new.html
deleted file mode 100644
index 1eb8e24f0..000000000
--- a/org.eclipse.mylyn.help.ui/user/new.html
+++ /dev/null
@@ -1,58 +0,0 @@
-<!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/newnoteworthy.html b/org.eclipse.mylyn.help.ui/user/newnoteworthy.html
new file mode 100644
index 000000000..df020934c
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/user/newnoteworthy.html
@@ -0,0 +1,103 @@
+<!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 width="30%" valign="top" align="left">
+ <p align="right"><b>Show all filtered children</b></p>
+ </td>
+ <td width="70%" valign="top">
+ When you are using filtering in a Mylar view you have the option of
+ temporarily showing all children of a filtered node by &lt;alt&gt;clicking
+ a node that is not currently selected.&nbsp; For example, you can
+ &lt;alt&gt;click a source folder, keep the &lt;alt&gt; key down, and continue
+ drilling down until you find a method of interest.&nbsp;
+ <p><img src="images/alt-click.gif" alt="Alt Click"
+ 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>Highlight a task context</b></p>
+ </td>
+ <td valign="top" width="70%">You can associate a task with a
+ highlighter. This can be useful if you are using Mylar without the
+ filtering support.&nbsp; It also allows you to distinguish between
+ task contexts if you have multiple tasks active.<p><img
+ src="images/highlight.gif"></p>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+<table cellpadding="10" cellspacing="0" width="600" id="table1">
+ <tr>
+ <td align="left" valign="top" width="30%">
+ <p align="right"><b>Search within task context</b></p>
+ </td>
+ <td valign="top" width="70%">The automatically updated Mylar Task
+ Context working set can be searched as any other working set, either
+ via the popup menus or using the search dialog.&nbsp; For example,
+ to find all System.out/err calls before checking in, search for
+ &quot;System.&quot; within the task context. To quickly search all references
+ click Alt+Shift+G.<p>
+ <img border="0" src="images/search-context.gif" width="470" height="133"></p>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+</table>
+
+<table cellpadding="10" cellspacing="0" width="600" id="table2">
+ <tr>
+ <td align="left" valign="top" width="30%">
+ <p align="right"><b>Directly manipulate interest</b></p>
+ </td>
+ <td valign="top" width="70%">Directly manually manipulate the
+ interest level of elements by right clicking them and using the two
+ Mylar actions in the popup menu.&nbsp; Keyboard shortcuts for these
+ are Ctrl+Alt+Shift+Up Arrow for Make Landmark, and&nbsp;
+ Ctrl+Alt+Shift+Down Arrow for Make Less Interesting.&nbsp;
+ <p>
+ <img border="0" src="images/interest-manipulate.gif" width="262" height="65"></p>
+
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <hr>
+ </td>
+ </tr>
+</table>
+
+</body>
+</html>
diff --git a/org.eclipse.mylyn.help.ui/user/overview.html b/org.eclipse.mylyn.help.ui/user/overview.html
index c4946739d..f06dea791 100644
--- a/org.eclipse.mylyn.help.ui/user/overview.html
+++ b/org.eclipse.mylyn.help.ui/user/overview.html
@@ -12,8 +12,8 @@
<body>
<h1>
Mylar Overview</h1>
- <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;
+ <p>Note: 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 feel free to email
<a href="mailto:mylar@cs.ubc.ca">mylar@cs.ubc.ca</a> or
@@ -21,37 +21,46 @@
Report bugs to:
<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Mylar">
https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Mylar</a> </p>
- <p>To start using Mylar</p>
- <ul>
- <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>
+ <p>As you work on programming tasks, Mylar watches your activity and creates
+ a task context.&nbsp; This context is associated with the task that you have
+ activated.&nbsp; Mylar extends Eclipse structure views and editors to show
+ you only what you're working on by focusing on the task context, and to
+ highlight the degree of interest of the program structure that you are
+ working on.&nbsp; The following list and figure summarize the core Mylar
+ features.&nbsp; </p>
+ <ol>
+ <li>Use the task list to create tasks and categories.&nbsp; You can also
+ add a bugzilla report as a task, or create a bugzilla query as a
+ category.&nbsp; A task context is activated by clicking the gray
+ glasses, which causes the task and its category to become bold.&nbsp;
+ Note that tasks can show up in multiple categories (e.g. as a result of
+ a query, as in the figure below).&nbsp; To disable the context click the
+ glasses again.&nbsp; If you are using bugzilla reports you must
+ configure the Bugzilla server first (Preferences -&gt; Bugzilla).&nbsp; If
+ you double-click a Bugzilla report it will open with the internal
+ browser, or with a Bugzilla Editor if you set Preferences -&gt; Mylar -&gt;
+ Task List accordingly.</li>
+ <li>Click the Mylar glasses to filter out all uninteresting elements
+ (i.e. those not a part of the task context), shown here on the Outline
+ view.&nbsp; You will notice that views with Mylar filtering update
+ automatically as you work.&nbsp; Toggle this button to switch between
+ the standard view mode and the Mylar interest filtering.&nbsp; If you
+ have no task context active and all of the Mylar glasses are toggled off
+ all of the Mylar functionality is disabled.</li>
+ <li>The Problems list can be filtered just like the outline.</li>
+ <li>The editor provides an automatic folding feature that can be toggled
+ using the toolbar button next to &quot;Mark Occurrences&quot;.&nbsp; When enabled
+ all uninteresting elements will be folded, an interesting elements
+ unfolded.&nbsp; Note that if you use the Mylar Java editor for &quot;.java&quot;
+ files the highest interest elements will be moved to the top of the
+ content assist list.</li>
+ <li>Mylar filtering works in the Package Explorer as well.&nbsp;
+ Elements that are not a part of the task context show up in gray
+ consistently throughout the views.&nbsp; The highest interest elements,
+ called Landmarks, show up in bold.&nbsp; </li>
+ </ol>
+ <p><img border="0" src="images/overview.gif" width="1024" height="738"></p>
+ <p>Also see the <a href="newnoteworthy.html">New &amp; Noteworthy</a>.</p>
</body>
</html>
diff --git a/org.eclipse.mylyn.help.ui/user/tips.html b/org.eclipse.mylyn.help.ui/user/tips.html
deleted file mode 100644
index 7592084f2..000000000
--- a/org.eclipse.mylyn.help.ui/user/tips.html
+++ /dev/null
@@ -1,21 +0,0 @@
-<!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>
- Tips &amp; Tricks</h1>
- <p>To find all System.out/err calls before checking in, search for &quot;System.&quot;
- within the task contxt.</p>
- <p>&nbsp;</p>
-
- </body>
-</html>
-

Back to the top