From b7aaff6eadc50903a7d761a6b4771ac475132fda Mon Sep 17 00:00:00 2001
From: dgreen
Date: Mon, 8 Feb 2010 00:40:32 +0000
Subject: ASSIGNED - bug 300134: consider adding FAQ to o.e.m.help.ui
https://bugs.eclipse.org/bugs/show_bug.cgi?id=300134 NEW - bug 299838:
Generation of Eclipse Help content from a MediaWiki
https://bugs.eclipse.org/bugs/show_bug.cgi?id=299838
---
org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml | 189 ++++++
org.eclipse.mylyn.help.ui/Mylyn-User-Guide-toc.xml | 56 ++
.../Mylyn/FAQ/Bugzilla-Connector.html | 217 ++++++
.../Mylyn/FAQ/Context-and-Timing-data.html | 72 ++
org.eclipse.mylyn.help.ui/Mylyn/FAQ/FAQ.html | 71 ++
.../Mylyn/FAQ/Installation.html | 725 +++++++++++++++++++++
.../Mylyn/FAQ/Integration-with-other-tools.html | 93 +++
.../Mylyn/FAQ/JIRA-Connector.html | 219 +++++++
.../Mylyn/FAQ/Java-Development.html | 120 ++++
org.eclipse.mylyn.help.ui/Mylyn/FAQ/Misc.html | 176 +++++
.../Mylyn/FAQ/Task-Editor.html | 67 ++
.../Mylyn/FAQ/Task-Focused-UI.html | 183 ++++++
org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-List.html | 176 +++++
.../Mylyn/FAQ/Task-Repositories.html | 221 +++++++
.../Mylyn/FAQ/Team-Support.html | 113 ++++
.../Mylyn/FAQ/Trac-Connector.html | 155 +++++
.../Mylyn/FAQ/Updating-This-Document.html | 54 ++
.../Mylyn/FAQ/Web-Templates-Connector.html | 103 +++
org.eclipse.mylyn.help.ui/Mylyn/FAQ/WikiText.html | 133 ++++
.../FAQ/images/AuthenticationTroubleshooting2.png | Bin 0 -> 70722 bytes
.../FAQ/images/Jira-advanced-configuration.png | Bin 0 -> 10501 bytes
.../FAQ/images/Mylar-content-assist-prefs.gif | Bin 0 -> 23060 bytes
.../images/Mylar-eclipse-manage-configuration.gif | Bin 0 -> 23781 bytes
.../images/Mylar-java-filtering-declarations.gif | Bin 0 -> 8520 bytes
.../Mylyn/FAQ/images/Mylar-resource-exclusion.gif | Bin 0 -> 12997 bytes
.../FAQ/images/Mylar-spell-checking-preference.gif | Bin 0 -> 16195 bytes
.../FAQ/images/Mylar-tasklist-weblink-editor.gif | Bin 0 -> 20089 bytes
.../FAQ/images/Mylyn-content-assist-timeout.gif | Bin 0 -> 22202 bytes
.../Mylyn-project-repository-association.gif | Bin 0 -> 12132 bytes
.../Mylyn/FAQ/images/Tasklist-filter.png | Bin 0 -> 4482 bytes
.../Mylyn/FAQ/images/Time-tracking-jira-admin.png | Bin 0 -> 12514 bytes
.../Mylyn/FAQ/images/Time-tracking-jira-mylyn.png | Bin 0 -> 12009 bytes
.../Mylyn/User_Guide/Preferences.html | 143 ++++
.../Mylyn/User_Guide/Shortcuts.html | 107 +++
.../Mylyn/User_Guide/Task-Editor.html | 217 ++++++
.../Mylyn/User_Guide/Task-Focused-Interface.html | 107 +++
.../Mylyn/User_Guide/Task-Repositories.html | 76 +++
.../User_Guide/Task-Repository-Connectors.html | 203 ++++++
.../Mylyn/User_Guide/Team-Support.html | 106 +++
.../Mylyn/User_Guide/Updating-This-Document.html | 54 ++
.../Mylyn/User_Guide/User-Guide.html | 409 ++++++++++++
.../images/Feature-Guide-3.0-Focused-Editor.png | Bin 0 -> 25330 bytes
.../images/Feature-Guide-3.0-Local-Task.png | Bin 0 -> 24367 bytes
.../Feature-Guide-3.0-Package-Explorer-Focused.png | Bin 0 -> 14930 bytes
.../Feature-Reference-3.0-Add-Task-Repository.png | Bin 0 -> 63168 bytes
.../Feature-Reference-3.0-Add-To-Context.png | Bin 0 -> 17025 bytes
.../Feature-Reference-3.0-Category-Progress.png | Bin 0 -> 23926 bytes
.../images/Feature-Reference-3.0-Change-Sets.png | Bin 0 -> 26006 bytes
.../images/Feature-Reference-3.0-Context-Tab.png | Bin 0 -> 44388 bytes
.../images/Feature-Reference-3.0-Error-Log.png | Bin 0 -> 38789 bytes
.../Feature-Reference-3.0-New-Query-Combined.png | Bin 0 -> 60615 bytes
.../images/Feature-Reference-3.0-New-Task.png | Bin 0 -> 7873 bytes
.../images/Feature-Reference-3.0-Open-Task.png | Bin 0 -> 45630 bytes
.../images/Feature-Reference-3.0-Planning-Tab.png | Bin 0 -> 21151 bytes
.../Feature-Reference-3.0-Task-Editor-Bottom.png | Bin 0 -> 50812 bytes
.../Feature-Reference-3.0-Task-Editor-Top.png | Bin 0 -> 50018 bytes
...Feature-Reference-3.0-Task-List-Categorized.png | Bin 0 -> 36082 bytes
...Reference-3.0-Task-List-Presentation-Select.png | Bin 0 -> 13294 bytes
.../Feature-Reference-3.0-Task-List-Tooltip.png | Bin 0 -> 31517 bytes
.../images/Feature-Reference-3.0-UI-Legend.png | Bin 0 -> 32583 bytes
.../Feature-Reference-3.0-Weekly-Progress.png | Bin 0 -> 20747 bytes
.../images/Generic-web-repository-settings.gif | Bin 0 -> 20696 bytes
.../Mylyn/User_Guide/images/XPlannerQuery.jpg | Bin 0 -> 35955 bytes
.../Mylyn/User_Guide/images/XPlannerTaskEditor.gif | Bin 0 -> 44656 bytes
.../User_Guide/images/XPlannerUserStoryEditor.gif | Bin 0 -> 34610 bytes
org.eclipse.mylyn.help.ui/book.css | 1 +
org.eclipse.mylyn.help.ui/build-helper.xml | 92 +--
org.eclipse.mylyn.help.ui/build.properties | 6 +-
org.eclipse.mylyn.help.ui/images/home.gif | Bin 0 -> 582 bytes
org.eclipse.mylyn.help.ui/images/next.gif | Bin 0 -> 327 bytes
org.eclipse.mylyn.help.ui/images/prev.gif | Bin 0 -> 327 bytes
org.eclipse.mylyn.help.ui/plugin.xml | 8 +-
org.eclipse.mylyn.help.ui/toc.xml | 8 +-
.../userguide/Configuring-Task-Repositories.html | 76 ---
.../userguide/Creating-new-Queries.html | 131 ----
.../userguide/Creating-new-Tasks.html | 131 ----
.../userguide/Installation.html | 140 ----
.../userguide/Integration-with-other-tools.html | 93 ---
.../userguide/Mylyn Reference-toc.xml | 56 --
.../userguide/Mylyn Reference.html | 409 ------------
.../userguide/Preferences.html | 143 ----
org.eclipse.mylyn.help.ui/userguide/Shortcuts.html | 107 ---
.../userguide/Task-Editor.html | 217 ------
.../userguide/Task-Focused-Interface.html | 107 ---
org.eclipse.mylyn.help.ui/userguide/Task-List.html | 325 ---------
.../userguide/Task-Repositories.html | 76 ---
.../userguide/Task-Repository-Connectors.html | 203 ------
.../userguide/Team-Support.html | 106 ---
.../userguide/Updating-This-Document.html | 54 --
org.eclipse.mylyn.help.ui/userguide/book.css | 1 -
.../images/Feature-Guide-3.0-Focused-Editor.png | Bin 25330 -> 0 bytes
.../images/Feature-Guide-3.0-Local-Task.png | Bin 24367 -> 0 bytes
.../Feature-Guide-3.0-Package-Explorer-Focused.png | Bin 14930 -> 0 bytes
.../Feature-Reference-3.0-Add-Task-Repository.png | Bin 63168 -> 0 bytes
.../Feature-Reference-3.0-Add-To-Context.png | Bin 17025 -> 0 bytes
.../Feature-Reference-3.0-Category-Progress.png | Bin 23926 -> 0 bytes
.../images/Feature-Reference-3.0-Change-Sets.png | Bin 26006 -> 0 bytes
.../images/Feature-Reference-3.0-Context-Tab.png | Bin 44388 -> 0 bytes
.../images/Feature-Reference-3.0-Error-Log.png | Bin 38789 -> 0 bytes
.../Feature-Reference-3.0-New-Query-Combined.png | Bin 60615 -> 0 bytes
.../images/Feature-Reference-3.0-New-Task.png | Bin 7873 -> 0 bytes
.../images/Feature-Reference-3.0-Open-Task.png | Bin 45630 -> 0 bytes
.../images/Feature-Reference-3.0-Planning-Tab.png | Bin 21151 -> 0 bytes
.../Feature-Reference-3.0-Task-Editor-Bottom.png | Bin 50812 -> 0 bytes
.../Feature-Reference-3.0-Task-Editor-Top.png | Bin 50018 -> 0 bytes
...Feature-Reference-3.0-Task-List-Categorized.png | Bin 36082 -> 0 bytes
...Reference-3.0-Task-List-Presentation-Select.png | Bin 13294 -> 0 bytes
.../Feature-Reference-3.0-Task-List-Tooltip.png | Bin 31517 -> 0 bytes
.../images/Feature-Reference-3.0-UI-Legend.png | Bin 32583 -> 0 bytes
.../Feature-Reference-3.0-Weekly-Progress.png | Bin 20747 -> 0 bytes
.../images/Generic-web-repository-settings.gif | Bin 20696 -> 0 bytes
.../userguide/images/XPlannerTaskEditor.gif | Bin 44656 -> 0 bytes
.../userguide/images/XPlannerUserStoryEditor.gif | Bin 34610 -> 0 bytes
.../userguide/images/images/home.gif | Bin 582 -> 0 bytes
.../userguide/images/images/next.gif | Bin 327 -> 0 bytes
.../userguide/images/images/prev.gif | Bin 327 -> 0 bytes
.../userguide/images/mylar-resource-exclusion.gif | Bin 12997 -> 0 bytes
.../userguide/images/mylyn-overview-small.gif | Bin 84098 -> 0 bytes
.../userguide/images/mylyn-overview.gif | Bin 60126 -> 0 bytes
119 files changed, 4611 insertions(+), 2444 deletions(-)
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn-User-Guide-toc.xml
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Bugzilla-Connector.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Context-and-Timing-data.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/FAQ.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Integration-with-other-tools.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/JIRA-Connector.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Java-Development.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Misc.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Editor.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Focused-UI.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-List.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Repositories.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Team-Support.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Trac-Connector.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Updating-This-Document.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/Web-Templates-Connector.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/WikiText.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/AuthenticationTroubleshooting2.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Jira-advanced-configuration.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-content-assist-prefs.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-eclipse-manage-configuration.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-java-filtering-declarations.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-resource-exclusion.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-spell-checking-preference.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-tasklist-weblink-editor.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-content-assist-timeout.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-project-repository-association.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Tasklist-filter.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-admin.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-mylyn.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repositories.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Updating-This-Document.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Focused-Editor.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Local-Task.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Package-Explorer-Focused.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-Task-Repository.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-To-Context.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Category-Progress.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Change-Sets.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Context-Tab.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Error-Log.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Query-Combined.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Task.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Open-Task.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Planning-Tab.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Bottom.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Top.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Categorized.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Tooltip.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Weekly-Progress.png
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Generic-web-repository-settings.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerQuery.jpg
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerTaskEditor.gif
create mode 100644 org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerUserStoryEditor.gif
create mode 100644 org.eclipse.mylyn.help.ui/book.css
create mode 100644 org.eclipse.mylyn.help.ui/images/home.gif
create mode 100644 org.eclipse.mylyn.help.ui/images/next.gif
create mode 100644 org.eclipse.mylyn.help.ui/images/prev.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Creating-new-Queries.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Creating-new-Tasks.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Installation.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Integration-with-other-tools.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Preferences.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Shortcuts.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-Editor.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-Focused-Interface.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-List.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Team-Support.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/book.css
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Focused-Editor.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Local-Task.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Package-Explorer-Focused.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-Task-Repository.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-To-Context.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Category-Progress.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Change-Sets.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Context-Tab.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Error-Log.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Query-Combined.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Task.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Open-Task.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Planning-Tab.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Bottom.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Top.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Categorized.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Tooltip.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-UI-Legend.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Weekly-Progress.png
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/Generic-web-repository-settings.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/XPlannerTaskEditor.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/XPlannerUserStoryEditor.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/images/home.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/images/next.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/images/prev.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview-small.gif
delete mode 100644 org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview.gif
(limited to 'org.eclipse.mylyn.help.ui')
diff --git a/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml b/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml
new file mode 100644
index 000000000..529b07b78
--- /dev/null
+++ b/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml
@@ -0,0 +1,189 @@
+
+
Bugzilla Connector | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task Repositories | ++ | JIRA Connector | +
Mylyn periodically checks config.cgi to retrieve the repository configuration. + On Eclipse.org this resulted in heavy CPU Load for the regeneration and a big surge in band width use.
+Mylyn has been modified to accept gzip encoding on all requests, and will do content negotiation. See + bug 205708. +
++ To add caching for your Bugzilla repository: +
+via CVS: :pserver:anonymous@dev.eclipse.org:/cvsroot/technology/org.eclipse.phoenix/infra-scripts/bugzilla/ + or: http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.phoenix/infra-scripts/bugzilla/?root=Technology_Project ++
If you change the username/email address on your Bugzilla account you may notice that some tasks still have the old username/email. Explicitly synchronize the task via the + Task List popup menu or + Task Editor toobar in order to update your username. +
+<your-repository-url>/show_bug.cgi?id=1&ctype=xml
to show the contents of bug 1 in XML form. The Bugzilla client requires that bugs be accessible in XML form. If the repository doesn’t support xml then it is likely that the repository is too old (Mylyn currently supports Bugzilla 2.18 and later).
+ bugzilla.dtd
or a “'
+ Failed to retrieve products from server'” error message, these can result when
+ urlbase
parameter is not set on the bugzilla serverurlbase
parameter is incorrect, e.g. it contains index.cgi
bugzilla.dtd
file. See:
+ bug#161759
+ DBD::mysql::st execute
failed: Got a packet bigger than 'max_allowed_packet' bytes
+ Statement “INSERT INTO attach_data (id, thedata) VALUES (38, ?)” at /path/to/bugzilla/attachment.cgi
line 993. Also,
+ check the maximum attachment size in
+ Bugzilla Parameters → Attachments.
+ usermatchmode
is not currently supported (
+ bug 168204) and as such full email addresses need to be used.
+ usevisibilitygroups
parameter is not supported (
+ bug#180876). Group assignment will currently be lost if updated using the Bugzilla rich task editor.
+ + + + + | ++ + + + | ++ + + + | +
Task Repositories | ++ | JIRA Connector | +
Context and Timing data | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task-Focused UI | ++ | Java Development | +
When checking out a new project, you must first deactivate the active task. Otherwise all newly created files will become interesting.
+Some platform/jvm combinations can fill with invalid timestamps. This is known to have happened on Mac OSX 10.4 with Java 1.5. See + bug 207419. + To resolve you can try and manually edit <workspace>/.metadata/.mylyn/contexts/activity.xml.zip. +
++ + + + | ++ + + + | ++ + + + | +
Task-Focused UI | ++ | Java Development | +
Mylyn FAQ | +||
---|---|---|
+ | + | + + + + | +
+ | + | Installation | +
+ Mylyn/User Guide, + + Mylyn Home, + + Log in to edit +
+For instructions on + downloading + installing and + configuring + Mylyn, see the + Mylyn/User Guide. For instructions on developing and contributing to Mylyn, see the + Mylyn Contributor Reference. +
+For + tutorials and articles on using Mylyn refer to the + + Get Started + page. +
+Mylyn is a task-focused interface for Eclipse that makes working with very large workspaces as easy as working with small ones. Mylyn extends Eclipse with mechanisms for keeping track of the tasks that you work on. A task is defined as any unit of work that you want to recall or share with others, such as a bug reported by a user or a note to yourself about improving a feature. You can store tasks locally in your workspace, or they can come from one or more task repositories. To connect to a task repository, you must have a connector that supports that repository. (A task repository is a bug/ticket/issue tracker such as Bugzilla, Trac, JIRA, and + others). +
+Once your tasks are integrated, Mylyn monitors your work activity on those tasks to identify information relevant to the task-at-hand. Mylyn monitors Eclipse and captures your interaction in a task context. System artifacts such as files, types, methods, and fields get assigned a degree-of-interest based on how recently and frequently you interact with them. This results in uninteresting elements being filtered from view within Eclipse, allowing you to focus in on what is important. From this, Mylyn creates a task context, which is the set of all artifacts related to your task. These can include methods you have edited, APIs you have referred to, and documents you have browsed. Mylyn uses this task context to focus the Eclipse UI on interesting information, hide what's uninteresting, and automatically find what's related. Having the information you need to get your work done at your fingertips improves your productivity by reducing the time you spend searching, scrolling, and navigating. By making task context explicit, Mylyn also facilitates multitasking, planning, reusing past efforts, and sharing expertise.
+ | + | + + + + | +
+ | + | Installation | +
Installation | +||
---|---|---|
+ + + + | ++ | + + + + | +
Mylyn FAQ | ++ | Task List | +
As of writing, Mylyn comes bundled with the main EPP distributions ( + jee, java, cpp). If you wish to manually install Mylyn there are to methods depending on the version of Eclipse. Method 1 outlines how to install using the Eclipse 3.4 update manager. Method 2 below describes how to install Mylyn into Eclipse 3.3 and below using the Update Manager. +
+
+ http://download.eclipse.org/tools/mylyn/update/e3.4
+
+ http://download.eclipse.org/tools/mylyn/update/e3.3
+ See the + download page. +
+Mylyn also relies on a web browser that works with the Standard Widget Toolkit; Windows and MacOS users are fine, but Linux users might have to download another browser. See + the SWT Browser guide for which browsers will work. See + installing browser on Linux for installation instructions. +
+Mylyn needs the + Java 5 virtual machine. +
+To check the version of the Java virtual machine that Eclipse was launched with to to + Help → About Eclipse SDK → Configuration Details and verify that the java.vm.version is 1.5. +
+Mac users should refer to the last comment on + bug 1163477 for instructions on how to change the 1.4 default. +
+In Unix, set the environment variable JAVA_HOME
to the root of the JDK1.5 installation and/or set the PATH
variable to put the JDK1.5 executable directory before any other VM executable directories. For example, under bash
in Unix:
export JAVA_HOME="''(location of JDK1.5 root)''" +export PATH=$JAVA_HOME/bin:$PATH ++
We do
+ not recommend using JDK 1.6 on Eclipse 3.1. (It works fine with Eclipse 3.2 or 3.3.) To use JDK 1.6 on Eclipse 3.1, you must add the following line to your config.ini
file:
+
org.osgi.framework.executionenvironment=OSGi/Minimum-1.0,OSGi/Minimum-1.1,JRE-1.1,J2SE-1.2, +J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6 ++
The + default Eclipse downloads contain the following Mylyn redistributions. Since the redistributed versions can be missing important bug fixes or feature additions, we recommend using the + latest version of Mylyn. +
+This happens if Mylyn failed to install. First ensure that you have a correct install by following the instructions in the next section. After that, if you still do not see your tasks use the + Task List view menu → + Restore Tasks From History… command (also available via + File → Import → Task List. +
++ I’m being asked to restart Eclipse, should I? + Upon installing you will get a dialog box asking if you would like to restart Eclipse. We recommend that you select + Yes. +
++ I’ve installed Mylyn ; why can’t I see anything different? +
+The two most likely possibilities are:
+
+ What does “Root exception: java.lang.UnsupportedClassVersionError: org/eclipse/mylar/tasklist/MylarTasklistPlugin (Unsupported major.minor version 49.0)
” mean?
+
It probably means that the virtual machine is JDK1.4 or lower. See + download and configure Java. +
+
+ What does “Could not create Browser page: No more handles (java.lang.UnsatisfiedLinkError: …
)” mean?
+
It probably means that you are running Linux and don’t have Eclipse and a Web browser configured to work together. See + installing a browser on Linux. +
+
+ What does “Could not create Bugzilla editor input” and “java.io.IOException
: SAX2 driver class org.apache.xerces.parsers.SAXParser
not found” mean?
+
It probably means that you are on MacOS, and for some reason are missing Xerces from the Mac JDK1.5. You will probably need to add it to your default classpath. Please refer to and comment on + bug 144287 if you see this problem. +
+To ensure that you are using the 1.5 VM refer to the last comment on + bug 1163477 for instructions on how to change the 1.4 default. +
++ ' Startup warnings' +
+If you see startup errors or warnings such as BundleException
or timeout messages restart Eclipse with the -clean
flag either on the command line, in your shortcut link, or by temporarily it into the eclipse/eclipse.ini
file. These warnings do not cause any bad behavior, but this bug has been fixed in all Mylyn builds after 2.1. The warnings have this form:
!MESSAGE While loading class "org.eclipse.mylar.tasks.ui.TasksUiPlugin", thread "Thread + [main,6,main]" timed out waiting (5000ms) for thread "Thread[Worker-3,5,main]" to finish + starting bundle "update@plugins/org.eclipse.mylar.tasks.ui_2.0.0.v20070514-1800.jar [809]". + To avoid deadlock, thread "Thread[main,6,main]" is proceeding but + "org.eclipse.mylar.tasks.ui.TasksUiPlugin" may not be fully initialized. ++
Ensure that all required update sites are enabled under Help > Software Updates > Available Software > Manage Sites:
+Then follow these steps:
+The message indicates that the Eclipse provisioning system P2 has found meta data to install a plug-in but can not locate an artifact repository that provides the required downloads. To recover please remove the Mylyn update sites under + Help → Software Updates… → Available Software → Manage Sites. Then re-add the sites which will refresh the meta data and artifacts available on the update sites. +
+Also see steps under + Installation Troubleshooting on Eclipse 3.4 and later. +
+If any of the installed features have unsatisfied dependencies or if features where previously installed from the extras or incubator update site P2 may fail with an error similar to the ones below. Try these steps to recover:
++ Cannot complete the request. See the details. + Mylyn Focused UI (Recommended) is already installed, so an update will be performed instead. + Mylyn Task List (Required) is already installed, so an update will be performed instead. + Mylyn Bridge: Eclipse IDE is already installed, so an update will be performed instead. + Mylyn Bridge: Java Development is already installed, so an update will be performed instead. + Mylyn Bridge: Plug-in Development is already installed, so an update will be performed instead. + Mylyn Bridge: Team Support is already installed, so an update will be performed instead. + Mylyn Connector: Bugzilla is already installed, so an update will be performed instead. + Cannot find a solution where both Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.mylyn.monitor.ui/[3.0.3.v20081015-1500 -e3x,3.0.3.v20081015-1500-e3x]] and Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.mylyn.monitor.ui/[3.0.1.v20080721-2100-e3x,3.0.1.v20080721-2100-e3x]]can be satisfied. + […] ++
Cannot find a solution satisfying the following requirements org.eclipse.ui [3.4.2.M20090204-0800]. ++
Also see steps under + Installation Troubleshooting on Eclipse 3.4 and later. +
++ ' Update failures ' +
+First, try running the update again via + Help → Software Updates → Search for new features… and ensure that all of the Mylyn features have been updated. +
+On Eclipse versions earlier than 3.3 (final) use + only the “Search for new features…” option when updating Mylyn. If you use “Search for updates…” the Update Manager will allow a partial install that can cause Mylyn to fail to start, and you will need to run update again. See the + feature configuration problem section below for details. If you encounter this problemm consider voting for Platform + bug 132450. +
+If you have + updated your Eclipse 3.3 to an Eclipse 3.4 milestone, you will not be able to update the 3.3 copy, because Mylyn has two separate downloads for Eclipse 3.3 and 3.4. Also, not all of the 3.3 version of Mylyn will work in Eclipse 3.4. Install the latest 3.4 version from: + http://www.eclipse.org/mylyn/downloads/ +
++ ' Java Persistence API Tools error when updating the JEE Eclipse Package ' +
+If you are trying to install additional features and get this error you have hit + bug 194959 which should be resolved soon. The work-around is to check off the + Europa Discovery Site and install the first two components of the + Data Tools Platform. +
++ Subclipse related problems +
+If you see the following message:
+Subclipse Mylyar Integration (1.0.1) requires plug-in "org.eclipse.mylar.tasks.core (0.9.2)", + or later version ++
You need to uninstall the old (pre 2.0) version of Subclipse and Mylar integration. Most users should not need to do this since the old Mylar 1.x version disabled itself after the update to 2.0. But if you see this error uninstall via:
++ ' Incompatible VM (e.g. JDK 1.4) ' +
+If you are using the wrong VM, you’ll see errors like the following in your log file.
+Root exception: java.lang.UnsupportedClassVersionError: +org/eclipse/mylar/tasklist/MylarTasklistPlugin (Unsupported major.minor version 49.0) ++
See + Configure Java to fix this problem. +
++ ' Incompatible version of Eclipse ' +
+Separate versions and update sites exist
+ for Eclipse 3.1 and 3.2), in which case you may see errors like the following in your <workspace>/.metadata/.log
file or in a Mylyn view:
+
java.lang.NoSuchMethodError: org.eclipse.ui.internal.dialogs.FilteredTree.getFilterControl() +The activator org.eclipse.mylar.java.MylarJavaPlugin for bundle org.eclipse.mylar.java is invalid ++
+ ' Mylyn feature configuration problem ' +
+If the above do not address the issue, the easiest thing to do is uninstall any old versions and update to the latest Mylyn. Your tasks won’t be lost, because by default they are stored in the <workspace>/.metadata/.mylyn
folder which will be read next time Mylyn starts correctly.
If you don’t uninstall, the the Update Manager will think that you have the latest and tell you that there are no updates.
+Note: manually removing the plug-ins and features can lead to configuration errors.
+After uninstalling, update Eclipse by adding the correct update site specified at on the + download page, and after that automatically or manually updating will install the correct version. +
++ +
++ What do I need to do in installation to be able to use Mylyn task management features with bug/task/issue trackers? +
+When you install, make sure that you select a connector for your bug/task/issue tracking software. For example, to use Bugzilla, you have to install the Bugzilla connector component.
++ What does the error “Network connection problems encountered during search” mean? +
+If you get that message while trying to download Mylyn, it means that Eclipse couldn’t find the location you entered. This might be because you copied something incorrectly (watch for extra characters -- even extra spaces can cause errors), or because the site went down. You may be able to see if the site is up or down by copying the URL into your Web browser.
++ 'What does the “Update manager failure” message mean? ' +
+It means that Eclipse could not access the update site, or that it got confused about the configuration state of your Eclipse. First try updating again to see if the update site is accessible.
+If you are trying to update the JIRA connector you can also try de-selecting that feature in case the Tigris.org
update site is not accessible. Using
+ Search for new features to install… when installing can help to avoid this problem. If that does not work see the feature configuration troubleshooting below.
+
+ Why am I getting messages in my <workspace>/.metadata/.log
or my Mylyn view that say things like “java.lang.NoSuchMethodError: org.eclipse.ui.internal.dialogs.FilteredTree.getFilterControl()
” and “The activator org.eclipse.mylar.java.MylarJavaPlugin
for bundle org.eclipse.mylar.java
is invalid”?
+
This probably means that your Mylyn download version didn’t match your Eclipse download version. Note that + the download site has different downloads for Eclipse 3.1 and Eclipse 3.2. +
+To fix this problem, see the + uninstallation guide, then re-install from + the correct download site. +
+
+ Why am I getting messages in my <workspace>/.metadata/.log
or my Mylyn view that say things like “java.lang.NoSuchMethodError: org.eclipse.mylyn.internal.context.core.InteractionContextManager.getScalingFactors()
”?
+
This could mean that some of your Mylyn plugins are on different versions. Use the update manager (“''Search for new features to install…''”) to obtain the latest versions of the Mylyn features.
++ Why doesn’t the Eclipse Update Manager display the latest versions of the Mylyn features? +
+It does. Note, however, that if you select both the Mylyn site and the Weekly Builds site, using “''Search for new features to install…''”, you must uncheck the “''Show the latest version of a feature only''” checkbox in order to see the updates available on both sites.
++ I’ve just updated to Mylyn 2.0 and I don’t see any tasks in my Task List +
+As part of the update to Mylyn 2.0 the old data folder has been migrated to <workspace folder>/.metadata/.mylyn from the old location <workspace folder>/.mylar. IF for some reason migration failed (.mylar folder still exists), simply shut down Eclipse and manually move your old <workspace folder>/.mylar folder to <workspace folder>/.metadata/.mylyn (note the name change to .mylyn)
++ Error: Network connection problems encountered during search + Eclipse couldn’t find the location you entered. This might be because you copied something incorrectly (watch for extra characters -- even extra spaces can cause errors), or because the site went down. You might be able to see if the site is down by copying the URL into your Web browser. +
++ Error: Update manager failure + Eclipse could not access the update site, or that it got confused about the configuration state of your Eclipse. First try updating again to see if the update site is accessible. If you are trying to update the JIRA connector you can also try de-selecting that feature in case the Tigris.org update site is not accessible. Using use + Search for new features… when installing can help to avoid this problem. You will probably get a warning that + the feature is unsigned. If you trust that hackers have not befouled the Mylyn plug-in, select + Install All. +
+The update site link in the 3.0 and 3.0.1 features for Eclipse 3.3 points to the Mylyn for Eclipse 3.4 update site ({{bug|244618}}). An attempt to update will result in an error: “Mylyn Task List (Required) (3.0.1.v20080721-2100-e3x) requires plug-in "org.eclipse.ui (3.4.0.I20070918)", or later version.”
+To resolve the error follow these steps:
+Make sure the new site is selected and select Finish to proceed with the update.
+Mylyn uses the Standard Widget Toolkit Browser, and users have experienced problems with the SWT Browser on Linux. This is not a Mylyn specific problem and also occurs if you try to use Eclipse’s Browser view. To test to see if your browser is properly configured, select + Window → Show View → Other → General → Internal Web Browser, then try to load a web page. If the internal browser is problematic, consider enabling the external default browser (i.e. Firefox) via + Window → Preferences → General → Web Browser and select the + Use external Web browser option. +
+When the Browser is not properly configured exceptions such such as “Could not create Browser page: No more handles (java.lang.UnsatisfiedLinkError: …
)” will appear when attempting to open tasks. See
+ the SWT Browser guide for which browsers will work.
+
For those experiencing unstable performance with Linux using the Sun JVM, try the + IBM JVM, which will require you to register with IBM prior to download. We’ve also had good reports from those using JRockit JVM. +
+If you are experiencing abnormal memory consumption upon launching the internal browser (or opening repository tasks), try shutting down eclipse, renaming/moving your ~/.mozilla/eclipse
folder and relaunching eclipse. (see
+ bug#172782)
+
(java.lang.UnsatisfiedLinkError: no swt-mozilla-gtk-3449 or swt-mozilla-gtk in swt.library.path, java.library.path or the jar file) ++
To resolve this error install a package that provides the Gecko engine library. On Ubuntu and Debian the package is called libxul0d.
++ This article describes how to improve the visual appearance of Eclipse on GTK. +
+The recommended GTK theme to use for KDE (and KDE based distributions like Kubuntu) is the + “Human” theme. (Possibly, this is also a good recommendation for GNOME. GNOME users, please comment.)
+With Debian based distributions (e.g. Ubuntu), this theme can be installed with
+aptitude install human-theme ++
The appearance of GTK applications is controlled by the KDE System Settings / Control Center + in the section “Appearance”.
+These changes are applied to these two GTK configuration files, respectively:
+Most of the + known UI issues below are due to a broken environment variable setting. The environment variable GTK2_RC_FILES contains a search path to find the GTK configuration files to be used by the GTK application and can be checked with +
+env | grep GTK2_RC_FILES ++
The correct setting is obtained by
+export GTK2_RC_FILES=$HOME/.gtkrc-2.0-kde:$HOME/.kde/share/config/gtkrc-2.0 ''# Bourne shell'' + setenv GTK2_RC_FILES $HOME/.gtkrc-2.0-kde:$HOME/.kde/share/config/gtkrc-2.0 ''# C shell'' ++
+ Important note: The used environment setting seems to differ depending on the way KDE starts + the application: from Konsole, using “Run Command…”, using a desktop icon etc. Please use this simple script to check the different ways: +
+#!/bin/bash + env | grep GTK2_RC_FILES >/tmp/GTK2_RC_FILES.env ++
and look at the resulting output in /tmp.
+Consider filing a bug against the distribution showing this inconsistent behaviour.
+There a couple of bugs related to UI features not working in specific Linux distributions:
+Debian 3.1 (sarge) with KDE and standard X11 installation (XFree86) works fine for all three issues.
+Debian testing (etch) with KDE and new X11 installation (X.Org) has issues with the color display (bug 176716 and 135928), but the Task Activate button works.
+Kubuntu Dapper 6.06 with KDE and X.Org triggers all above issues. An upgrade to Edgy enables Task Color display and the date picker selection. To get the Task Activation button working you have to use Edgy and Eclipse 3.3M5eh (or newer).
+Kubuntu Gutsy 7.10 has issues with the color display (bug 176716). A workaround is to change the GTK-Style to “Human”. + More details and another solution in the comments of bug 176716.
+If you see errors like the following it may be due to Xerces missing from the Mac JDK so you may need to add it to your default classpath. Please refer to and comment on + bug 144287 if you see this problem. +
+Could not create Bugzilla editor input + java.io.IOException: SAX2 driver class org.apache.xerces.parsers.SAXParser not found ++
To ensure that you are using the 1.5 VM refer to the last comment on + bug 1163477 for instructions on how to change the 1.4 default. +
+If default key mappings aren’t working, try doing the following to reset them:
+If you are running Mylyn on X-Windows, for example on Linux, FreeBSD, AIX and HP-UX, some keyboard bindings may not work by default.
+If the Ctrl+Alt+Shift+Arrow Up
shortcut for
+ Mark as Landmark does not work do the following:
+
If Alt+Click
quick unfiltering does not work try one of the following:
Windows
key while holding Alt
, if available (ironic, but unsurprisingly this key is not usually mapped on Linux).Alt+drag to move
functionality:GNOME Desktop
+gconf-editor
/apps/metacity/general
mouse_button_modifier
field. Setting it to nothing disables it. You can use <Super> to set it to the windows key.gconf-editor
.KDE Desktop
+Alt
to Meta
.
+ On Eclipse versions earlier than 3.3, the spell checking must be set up manually. Spell checking is supported in the task editor for local tasks and for connectors that support rich editing (e.g. Bugzilla, Trac).
++ +
+Turn off or increase the number of editors to leave open using + Preferences → General → Editors → Number of opened editors before closing. Since Mylyn will manage the open editors with task activation, this number can be set higher or you can disable automatic closing entirely. +
+No, not really. The Package Explorer and folded signatures should provide enough context for you. If, at some point, you really need to see an Outline View, you can always enter (Ctrl+O) to show the in-place Outline View.
+This usually happens when uninstalling when using Eclipse 3.2. Make sure that the “Java Completions” and “Java Types” proposal categories are included in the default proposals via: + Preferences → Java → Editor → Content Assist → Advanced → Restore Defaults. Also see: + content assist troubleshooting. This + bug has been fixed in Eclipse 3.2.1. +
+It is likely that you need to configure these proxy server settings. Select + Window → Preferences → General → Network Connections, and update the section in the “Proxy settings” section of the form. +
+This is usually a Linux/GNOME problem, where the Gnome keyboard shortcuts are interfering with the Eclipse shortcuts. Go to the Keyboard shortcuts (which might be something like + Desktop → Control Center → Keyboard Shortcuts or + System → Preferences → Keyboard Shortcuts) and disable both of these shortcuts: +
+See also: + keyboard mappings on Linux. +
+See + spell checking. +
+The internal browser may display an error if the web site certificate is not trusted and block access to the site:
+(Error code: sec_error_unknown_issuer) ++
On Linux start firefox -profile ~/.mozilla/eclipse -no-remote
from the command line and open the web site in Mozilla Firefox. Add an exception for the web site and restart Eclipse. The site should now be accessible from Eclipse.
+ Notes +
+-no-remote
is added because it would otherwise open a new window in the running process. You’re probably viewing this page in firefox, so the command above will not work without -no-remote
.firefox
by the exact command that you use to start your Mozilla browser.We recommend + uninstalling in Eclipse via the + Help → Software Updates → Manage Configuration dialog. If you get an error message when trying to uninstall, you will need to first uninstall dependencies that use Mylyn. These include things like the Subclipse Mylyn integration and the Bugzilla Connector. +
+You can also
+ uninstall manually by deleting all of the Mylyn plug-ins and features from the eclipse/plugins
and eclipse/features
directory make sure to delete all of the plug-ins and then restart Eclipse with the -clean option (e.g. by inserting it into a shortcut or the eclipse.ini
file.
+
On + Eclipse 3.2: if after uninstalling + content assist proposals no longer appear you need to ensure that the + Java Completions and + Java Types proposal categories are included in the default proposals via: + Preferences → Java → Editor → Content Assist → Advanced → Restore Defaults. Also see: + content assist troubleshooting. This + bug has been fixed in Eclipse 3.2.1. +
+On
+ Eclipse 3.1: you may need to reset the Java editor to be default for .java
again via:
+ Preferences → General → Editors → File Associations
+
If your Eclipse crashes, or you see the above error after installing Mylyn or other plug-ins, you have most likely hit the infamous MaxPermSize bug. This is not a Mylyn specific problem, but a general problem with the Sun Java VM that is often triggered on Eclipse 3.2 and later, if you have many plug-ins installed.
+To fix it simply add the following to your launch arguments. This is usually to your shortcut:
+-vmargs -XX:MaxPermSize=128m ++
Or to the eclipse/configuration/config.ini file:
+-XX:MaxPermSize=128m ++
Note: For Eclipse 3.4 with the Equinox P2 profile-based provisioning support, this setting can also be modified in the current P2 profile. With a default installation of the SDK, see:
+@config.dir/../p2/org.eclipse.equinox.p2.engine/profileRegistry/<name>.profile/<timestamp>.profile
+For more information, see: + http://wiki.eclipse.org/Equinox_p2_Admin_UI_Users_Guide +
+If you are using a very large number of plug-ins (e.g. WTP) and still get this error you may need to increase the number to 256M. Note that on some VMs the size may need to be a power of 2 and may drop down to the default (e.g. 32M) if it is not accepted.
+Eclipse 3.3.1 users: note note that due to Platform {{bug|203325}} you need to use the instructions above and cannot set the size using -launcher.XXMaxPermSizeL
, which will be ignored.
For more information see the + Eclispe FAQ entry. Details of the problem are on + Platform bug 92250. +
+Mylyn should have + no noticeable effect on Eclipse’s speed or memory usage, no matter how large your workspace is. You do not need to increase the amount of memory Eclipse runs with to use Mylyn. Any performance issue should be + reported as a bug. +
+The current + performance profile is: +
++ If you are seeing performance problems, this is either a bug, or caused by other performance problems in other Eclipse plug-ins'. If you are performance problems we suggest increasing the amount of memory available to Eclipse. This is especially useful for very large Java project workspaces, on which the size of JDT’s element cache will grow proportionally to the amount of available memory. The setting we recommend for launching workspaces with a couple hundred large projects is: +
+-Xmx768M -XX:MaxPermSize=128M ++
+ If you are seeing content assist timeouts that indicate the Mylyn proposal computer did not complete quickly enough, note that the problem is not with Mylyn, but with the standard content assist mechanism timing out due to an intensive computation (eg, a large number of matches). In this scenario switching or + disabling the Mylyn proposal computers does not help improve performance, although it will get rid of those messages. +
+ + + + | ++ + + + | ++ + + + | +
Mylyn FAQ | ++ | Task List | +
Integration with other tools | +||
---|---|---|
+ + + + | ++ | + + + + | +
WikiText | ++ | Misc | +
See the + + Mylyn Extensions + page for a listing of integration downloads. +
+Mylyn relies on + Bridges to integrate the context model with the structure and UI features of domain-specific tools. To create a Bridge, see + Creating Bridges. +
+The core set of Bridges supports the Eclipse SDK (i.e. has bridges for Java, JUnit, PDE, Ant and Resources). The Resources Bridge enables a basic level of interoperability with other tools that use files (e.g. .php, .cpp
), and enables Mylyn filtering to work for generic views that show those files (i.e. the
+ Project Explorer,
+ Navigator) and any corresponding markers (i.e. the
+ Problems and
+ Tasks views). This is only the most basic context model integration, and does not offer the benefits of a specialized structure bridge, such as making declarations part of the context and providing
+ Active Search facilities. Without a Bridge Mylyn cannot be applied to tool-specific views.
+
+ If you would like to see support for a particular tool, first do a search of the open bridge requests and + vote for the corresponding bug if your tool is there, or + create a new bug. Also consider adding your experiences to the + "Integration..." section of the Mylyn FAQ. +
+Context modeling works at the file level, noting the limitation of + bug 144882: interest filter fails on WTP Dynamic Web Project +
+If an external builder (e.g. Maven, pydev, or other Ant-based builders) is producing output files that are being automatically added to your context because they are not being marked "derived" as with Eclipse-based builders. You may note that such files are always show as interesting when they are generated or updated and can not be filtered away, since Mylyn expects all files that have changed as part of the task context to have interest.
+In this case you can explicitly exclude these files from being added to the task context the + Preferences -> Mylyn -> Resources page. For example, if the output folder of the builder is "target", you could set this the following way. Similarly, you could add a filter for "*.pyc" to exclude all files generated with that extension. +
+Source code generators can be considered analogous since they produce intermediate files. However, if you want to inspect the results of the source code generation after it is done you can avoid setting the exclusion. Note that if a large number of files was generated not all generated files may be unfiltered.
++ +
+ + + + | ++ + + + | ++ + + + | +
WikiText | ++ | Misc | +
JIRA Connector | +||
---|---|---|
+ + + + | ++ | + + + + | +
Bugzilla Connector | ++ | Trac Connector | +
If you see errors like the following, work around this by opening repository + Properties Page and clicking OK (bug + 169102). +
+org.tigris.jira.core.service.exceptions.AuthenticationException + at org.tigris.jira.internal.core.service.soap.SoapJiraService.getProjectsNoSchemes(SoapJiraService.java:204) ++
If the error message indicates unsatisfied dependencies on Mylyn plug-ins, make sure that you have the main Mylyn update site enabled as well as the extras update site for the JIRA connector. The error message would look similar to this:
++ … + Cannot find a solution where both Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.swt/[3.4.1.v3449c,3.4.1.v3449c]] and Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.swt/[3.4.0.v3448f,3.4.0.v3448f]] can be satisfied. + Unsatisfied dependency: [org.eclipse.mylyn.commons.soap 3.1.0.I20090109-0100-e3x] requiredCapability: osgi.bundle/org.eclipse.mylyn.commons.net/[3.1.0,4.0.0) ++
The update sites are listed on the + download page. +
+The + JIRA SOAP/RPC services have to be running on the JIRA server (set Administration → General Configuration → Accept remote API calls to ON in the JIRA web interface). +
+Related Resources:
+org.tigris.jira.core.service.exceptions.ServiceUnavailableException
you need to turn on the JIRA SOAP/RPC services on the server.AuthenticationException
and a query won’t synchronize, use Task Repositories (view) → Properties (on the repository) → Validate Settings. This will clear the connection if it died.Version 2.0 of the JIRA connector misinterprets version 3.10 as being lower than version 3.3.3. This is fixed in version 2.1 of the connector (see below for installation instructions on Eclipse 3.2).
+The most recent version that works on Eclipse 3.2 is Mylyn 2.0.0 and version + 2.1.0 of the JIRA connector. See + this page for instructions. +
+Attachment retrieval including retrieval of task contexts and attachment lists in the task editor requires JIRA 3.7 or above.
+Custom fields are supported with the following limitations, see {{bug|249057}} and its subtasks for additional details:
++
++
+If your repository has lots of projects and components you can speed up the download of the repository configuration by enabling compression.
+Since JIRA can be heavily customized there is a chance that some particular customizations may not work, so if you can’t connect to your proprietary repository it is a good idea to try the following public repositories to make sure you have working configuration:
+If you can’t get query results, you could try to call “Open with Browser” on query node in the Task List view and then save link “Current view: XML” and attach it to the bug report.
+Even if query don’t work you could try “Open Repository Task” from your JIRA repository node on the Task Repositories view and check if you can open JIRA task editor for that issue. Same for the Task search (Ctrl-H, Task Search)
+To investigate various error you may need to enable debug tracing. To do that you need to create the .options
file with the following content:
+ org.eclipse.mylyn.jira.ui/connector=true + org.eclipse.mylyn.jira.ui/dataHandler=true ++
and then add the following options to the Eclipse command line (or eclipse.ini file):
++ -debug <path to the .options file>/.options ++
The additional logging will go into the regular Eclipse log and the Error Log view
+Please go to the repository properties and validate the repository. If errors about circular redirects are logged in your Eclipse error log your JIRA server or proxy might be misconfigured.
+In some cases unexpected redirects can be caused by a JIRA server accessed via Apache and mod_jk (using the AJP/1.3 Tomcat connector). Some server configurations may benefit from the ‘proxyHost’, ‘proxyPort’, ‘scheme’ and ‘secure’ settings on the AJP Connector in the Tomcat server configuration.
+Please see {{bug|202834}} for a more details.
+This error is caused by Mylyn not having an up-to-date copy of the repository configuration for that repository. The corresponding report to automate updating of the repository configuration is {{bug|189689}}.
+As a work-around right-click on the query and select + Repository → Update Attributes. That will download and store a fresh copy of the repository configuration. +
+Mylyn defaults to a day having 24 working hours and a week having 7 work days. If your JIRA repository uses different settings time tracking information will not show correctly when converted between Mylyn and JIRA. In order to fix this change the time tracking settings in Mylyn in the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to match the server configuration. Your JIRA administrator will be able to tell you the correct settings which can be located under Administration → Time Tracking in the JIRA web interface.
+
+
+
+
+ JIRA Web Interface
+
+
+
+
+ Mylyn Task Repository Settings
+
Your server may be configured to use a custom date format or a non English locale. You can change the date format settings in the Advanced Configuration section under the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to match the server configuration.
++ +
+By default only subtask relationships are displayed in the Task List. You can enable + Show linked tasks in the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to also show issue links in the Task List. After enabling the setting + Synchronize All Tasks from the popup menu of the task repository in the Task Repositories view needs to be selected to update all tasks. More discussion is on {{bug|255680}}. +
+ + + + | ++ + + + | ++ + + + | +
Bugzilla Connector | ++ | Trac Connector | +
Java Development | +||
---|---|---|
+ + + + | ++ | + + + + | +
Context and Timing data | ++ | Team Support | +
Mylyn uses custom Content Assist processors in order to rank and separate the elements in the current task context. To see proposals ranked according to interest you must have only the + Type Proposals (Mylyn) kinds checkbox enabled in the list below, otherwise you will see duplicates. + If you do not see any proposals, check this list to ensure that either the Mylyn or the plain proposals are enabled. + To do this automatically, run + New → Mylyn → Recommended Preferences. Or you can select them manually as in the preference page below. +
++ +
++ Why do I see duplicate proposals? +
+Ensure that you have only the + (Mylyn) proposals kinds enabled in + Window → Preferences → Java → Editor → Content Assist → Advanced, otherwise you will see duplicates. +
+If you use proposals via Ctrl+Shift+Space instead of the typical Ctrl+Space you will see duplicates. Vote for JDT/Text + bug 147781 if you use this mechanism. Also see: + bug 129080 +
++ Why do I get an error message when using content assist? +
+If after invoking Content Assist you see an error message dialog that states:
+The extension took too long to return from the 'computeCompletionProposals()' operation ++
this is most likely due to something interrupting the proposal operation (e.g. garbage collection). Ignore it if it does not recur, increase Eclipse’s memory if it does (e.g via -Xmx384M
command line argument). See
+ bug 141457 for more details.
+
Note that Mylyn should only add a trivial amount of overhead to content assist computation, however, the standard content assist mechanism will not report timeouts of this sort (i.e. taking longer than 5s to compute proposals). If the system that you are working on is so large that increasing memeory does not reduce the timings to avoid the message, you could also consider disabling the Mylyn-specific content assist, as described above, but if doing so please comment on {{bug|141457}}.
++ +
+The + Package Presentation → Hierarchical mode is not supported on the + Project Explorer view in Eclipse 3.2 through 3.3M3 and possibly later versions + bug 161362. Use the view menu to set + Package Presentation → Flat as a work-around. +
+If you don’t like Mylyn’s constant showing of Java members in the + Package Explorer, select the drop-down menu, then + Filters… and enable the + Mylyn Java Declarations Filter. It will then stick in the menu in case you want to toggle between modes. +
+Note that this will hide interest information about members that aren’t in your current file (e.g. showing you which methods are landmarks). This means that you will need to commit those methods to memeory, and the next time that you start working on the task you will have the burden of figuring out what they are. On smaller screen resolutions this mode can be useful, but also consider turning the Package Explorer into a fast view.
++ +
+As you work, elements become Landmarks (bold decoration), and these elements populate the
+ Active Search and
+ Active Hierarchy views. To force an element to populate the views manually, make it a Landmark by right+clicking
or hitting Ctrl+Alt+Shift+UpArrow
.
+
+ + + + | ++ + + + | ++ + + + | +
Context and Timing data | ++ | Team Support | +
Misc | +||
---|---|---|
+ + + + | ++ | + + + + | +
Integration with other tools | ++ | Updating This Document | +
In order to present the valid options for attributes in the Task Editor, the repository 'configuration' must be retrieved from the repository. The default connector implementation requests a new configuration every 24hrs. In the case of Bugzilla, this is further refined by first performing a head request on the configuration to see if the Last-Modified header has changed. If so, the repository configuration is retrieved. Additionally, Eclipse.org's webmaster has redirected the config.cgi request to a static page, eliminating the processing overhead server side. For details on server side optimization of Bugzilla see + Mylyn_FAQ#Tips_for_server_administrators. +
+The system properties below can used to change the behavior of Mylyn. To set a property pass it on the command line when starting Eclipse:
+ eclipse -argument
.
Argument | +Mylyn Version | +Description | +
-no-activate-task |
+ Disables task activation on startup. The last active task is not re-activated on startup if a workspace crash is detected. | +
The system properties below can used to change the behavior of Mylyn. To set a property pass it on the command line when starting Eclipse:
+ eclipse -vmargs -Dorg.eclipse.mylyn.property=value
.
System Property | +Mylyn Version | +Default | +Description | +
org.eclipse.mylyn.linkProviderTimeout |
+ 5000 | +Number of milli-seconds before link providers are timed out. Set to -1 to disable link providers timing out. | +|
mylyn.discovery.directory |
+ + http://www.eclipse.org/mylyn/discovery/directory.xml + | +URL for the discovery directory. | +
Add the following lines to the eclipse.ini
file in your eclipse directory to enable tracing of header information for HTTP requests. Log output is written to the console eclipse was started from. Make sure to add these after the line that says
+ -vmargs
. Add a -vmwargs
line if there is none in the file.
+
-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog +-Dorg.apache.commons.logging.simplelog.showlogname=true +-Dorg.apache.commons.logging.simplelog.defaultlog=off +-Dorg.apache.commons.logging.simplelog.log.httpclient.wire.header=debug +-Dorg.apache.commons.logging.simplelog.log.org.apache.commons.httpclient=off +-Dorg.apache.commons.logging.simplelog.log.org.apache.axis.message=debug ++
To also enable logging of message content, also add this lines:
+-Dorg.apache.commons.logging.simplelog.log.httpclient.wire.content=debug ++
Create a
+ .options
file in your eclipse directory and enable tracing by including the corresponding lines which set the tracing setting for a particular concern to true:
+
+ JIRA +
+org.eclipse.mylyn.jira.core/debug/connector=true +org.eclipse.mylyn.jira.core/debug/dataHandler=true +org.eclipse.mylyn.jira.core/debug/repository=true ++
+ Trac +
+# trace authentication requests +org.eclipse.mylyn.trac.core/debug/authentication=true +# trace XML-RPC calls +org.eclipse.mylyn.trac.core/debug/xmlrpc=true ++
Then start eclipse with
+ -debug
. You can also optionally pass a filename to -debug
if your .options
file is not located in the eclipse directory.
+
See also + FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F. +
+Three usage data collection frameworks have been created for Eclipse:
+While (1) and (3) are work in a similar way, there is a significant difference between the approach used by the Mylyn Monitor and the other usage data collectors. Instead of gathering statistics, the Mylyn UI Usage Reporting component uses the interaction history that is captured by the Mylyn Monitor. This is the same interaction history stream that is used to determine the interest level of elements in Mylyn’s Task-Focused UI and has been refined by long-term use of Mylyn’s Task-Focused UI. The UI Usage Monitor is extensible, de-coupled from the other parts of Mylyn and can be used independently.
+There are several main benefits to the approach of capturing a full interaction history stream instead of reporting on particular statistics.
+For an example study see: + http://kerstens.org/mik/publications/mylar-ieee2006.pdf +
+At the EclipseCon and JavaONE 2006 conferences IBM demonstrated previews of Jazz, a collaborative team server and Eclipse-based client. Articles have remarked on the similarities between Mylyn and Jazz because both integrate tasks into Eclipse (Jazz’s “work items” and Mylyn’s “tasks”), and both provide change sets grouped by task. But there are both significant differences and complementary aspects to the two approaches. A key goal of Mylyn is to provide an open source framework to support integration of task management with + existing issue trackers and source repositories. According to the presentations, components that come with Jazz include include a + next-generation issue tracker and source repository and related lifecycle management tools such as project health. In addition, a driving and unique goal of Mylyn is to focus the UI around a usage-based and degree-of-interested weighted task context, which is complementary to the Jazz platform. Just as it integrates with Mylyn’s Task List, Mylyn’s Task Focused UI and task context model components are possible to integrate with other kinds of task management systems, such as the one provided by Jazz. +
+Update: at EclipseCon 2007 the IBM Jazz team showed a Mylyn connector for Jazz.
++ Category:FAQ + + Category:Mylyn +
+ + + + | ++ + + + | ++ + + + | +
Integration with other tools | ++ | Updating This Document | +
Task Editor | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task List | ++ | Task Repositories | +
Eclipse.org’s Bugzilla repository forces all new bug reports to priority 3 (P3) regardless of what is selected in Mylyn. Eventually we will disable this field in the new bug editor for bugs.eclipse.org and provide a tooltip with explanation ( {{bug|204630}} ).
+If for example you aren’t seeing the proper single quote chacters in the summary of + https://bugs.eclipse.org/bugs/show_bug.cgi?id=197644 bug#197644, check that the encoding is set correctly for the repository in the asociated Task Repositories view (Properties → Additional Settings → Character Encoding). For bugs.eclipse.org/bugs set your charcter encoding to + ISO-8859-1. +
+By default Eclipse does not provide a built-in image viewer so images can either be opened with a browser or saved to disk and opened in a native image viewer. Alternatively Eclipse extension such as QuickImage can be installed which support opening images within Eclipse.
+ + + + | ++ + + + | ++ + + + | +
Task List | ++ | Task Repositories | +
Task-Focused UI | +||
---|---|---|
+ + + + | ++ | + + + + | +
Web Templates Connector | ++ | Context and Timing data | +
When you activate a task, Mylyn automatically maintains a task context by monitoring your interaction. The task context provides a predictable degree-of-interest weighting of the relevance of the elements and relations that you work with to the task-at-hand (as described in the + Foundations of Software Engineering conference paper). The Task-Focused UI is the mechanism by which Mylyn presents Mylyn the task-context model in order to reduce information overload and to automate the manual management of UI elements like editors and change sets. Examples: +
+By default Mylyn automatically manages the set of open files to match the task context, so that you don’t have to. This ensures that the editor list (viewable via mechanisms like Ctrl+E) corresponds to what you in views like the + Package Explorer when they are in Focused mode. When you close a file manually, you express that it is uninteresting, and as such it will be removed from the task context. It will also disappear from the corresponding automatically managed change sets for the same reason. This behavior can be turned off via + Preferences → Mylyn → Context → Manage open editors to match task context. However, it is highly recommended since Mylyn will prevent the number of editors from bloating by automatically closing editors for elements that have decayed in interest, and always keep the editors for interesting elements open. +
+When you deactivate a task, all editors will be closed, and then when you reactivate the task all the windows will be open again. Try it, it’s fun.
+Mylyn actively manages your open editors with task context. It takes some getting used to, but enables switching between tasks when you are multitasking without cluttering your editor tabs. This editor management can be disabled via + Window → Preferences → Mylyn → Context. However, before disabling it consider reading the + “Managing open editors…” section of + Task-focused programming with Mylar. +
+When a view is focused elements will disappear on their own if they are not repeatedly selected via a mechanism called interest decay. Note that decay does not use the wall clock, but instead relies on the number of selections that you have made when working on that task to determine which elements disappear. This helps make it feel very predictable.
+If you want want to force one or more elements to disappear from the context use the + Remove from Focus action on the context menu. Note that the element will still be part of the task context since it was previously part of the interaction. +
+If you want to permanently delete the element from the interaction history use the + Remove from Context action on the + Context tab of the + Task Editor. For example, if a company private element was part of a task context that is to be shared with a public repository, this action can be used to clean it up before sharing. Note that elements will be removed from the task context recursively. +
++ All of them. When no task is active neither are any of Mylyn’s features. When working with task contexts Mylyn’s Focused UI features are all optional and in general configurable. While many find it the key benefit of Mylyn, the entire Focused UI is optional and can be uninstalled via + Help → Software Updates → Manage Configuration. +
+The following table summarizes how the key features can be toggled:
++ UI Mechanism + | ++ Example/description + | ++ Toggle using + | +
---|---|---|
Interest filtering | +Package Explorer | ++ Focus on Active Task button on view toolbar + | +
Automatic toggling of filtering | +Package Explorer | +''Preferences → Mylar → Context → Toggle focused mode.. | +
Interest decoration | +Bolding of landmark elements | ++ Preferences -> General -> Appearance -> Label Decoration + | +
Content assist | +Ranking of interesting elements | +Eclipse 3.2: + Java -> Editor -> Content Assist -> Work in Progress -> turn off Mylyn, turn on Java + | +
Active change sets | +Grouping of changes by tasks | ++ Preferences -> Mylyn -> Team + | +
Editor management | +Auto opening/closing of editors | ++ Preferences -> Mylyn -> Editor Management + | +
Active views | +Active Search and Hierarchy | +Only on if view is active | +
For additional configuration options see the + Mylyn and + General → Appearance preference pages. +
++ Note: if you have turned off automatic focusing of views consider using the + Navigate → Quick Context View facility. +
+Due to {{bug|200832}}, if you have the “Show ‘Referenced Libraries’ Node” option enabled in the view menu of the + Package Explorer you will not be able to Alt+click to library nodes if there isn’t a library visible already. Disable this option to make Alt+Click work. +
+Mylyn automatically turns on editor linking when the view is focused, since the main use case for turning it off (having the view jump around) is remedied by focusing the view. In other words, the button is pressed for you automatically and we need to ensure that it cannot be manually unchecked, which is why it appears disabled.
+These views were not included in the Mylyn 1.0 release because they never made it beyond the experimental phase.
+These features still show promise in displaying task context and saving repetitive searches, so we have not removed them. They have instead moved to the Mylyn Sandbox, and can be used and experimented with by following the + instructions on the Contributors page. For feedback on these views please use the corresponding bug reports or newsgroup. +
+ + + + | ++ + + + | ++ + + + | +
Web Templates Connector | ++ | Context and Timing data | +
Task List | +||
---|---|---|
+ + + + | ++ | + + + + | +
Installation | ++ | Task Editor | +
The task list can be restored from automated backup via the Task List view’s drop down view menu and selecting Restore Tasks from History…
+If a task has outgoing changes you wish to discard, right click on the task and select Mark as → Clear Outgoing. If a mid-air collision occurs, press the Synchronize button in the Task editor toolbar to bring in the incoming changes. Your outgoing changes will remain.
+The task list has filtering mechanisms that can limit the items visible in the task list. If a task is missing from the task list, use the following steps to remove all filters:
++ +
+The + Unmatched containers will automatically appear if a task needs to be shown but is not matched by any query. This is needed to ensure that the corresponding tasks do not disappear, for example, if the query is set up to only match resolved/completed tasks (a usage anti-pattern, since Mylyn has other mechanisms for preventing completed tasks from showing in the Task List). +
+In order to ensure that you do not miss reminders or notifications the following tasks will always be shown in the Task List, even if they have been removed from a category or a query:
+To + get rid of tasks in the + Unmatched container + you can: +
+Recommended Mylyn usage is to keep the + Unmatched container empty. For query setup recommendations see the sidebar at: + http://www.ibm.com/developerworks/java/library/j-mylyn1/?ca=dgr-eclipse-1 +
+Use + Window → Preferences → General → Appearance → Colors and Fonts. +
+If you created very broad queries you could end up with thousands of tasks in your Unmatched containers. Other than clearing the workspace/.metadata/.mylyn/tasklist.xml.zip and workspace/.metadata/.mylyn/offline
folder (note that this will entirely reset your Task List) the easiest option is to:
Whenever you work on a task, Mylyn accumulates the time you spend actively working on a task. This time can be viewed in the + Personal Planning section of the + Task Editor. When you are not interacting with Eclipse, the timing automatically times out after 3 minutes by default. This means that activity outside of Eclipse will not be captured when you work on the task and that the timings in Mylyn are a lower bound of the total time spent on the task (capturing timings for work done outside of Eclipse involves OS specific extensions). +
+If you have many long-running or recurring tasks scheduled for this week, they can affect the + Task List weekly progress bar. This can be misleading as they may never be completed. The current work-around to prevent long-running tasks from being included in the weekly progress bar is to schedule their estimated time to be 0 (zero). Alternatively, you can schedule only the amount of time you plan on spending on that task this week. +
+The SDK’s + Tasks view is used for showing markers such as ‘todo’ tags which indicate a local problem with a resource, similar to a compiler warning. As such, these ‘tasks’ are at a much finer granularity than Mylyn’s tasks, and one task could involve cleaning up multiple todos. In order to make working with only the markers in a particular task context, e.g. for clean-up before committing, the + Apply Mylyn filter is available for both the + Problems and the + Tasks views. +
+Mylyn’s support for multiple workspaces is currently limited (see + bug 130658 for a discussion) because the Task List is considered to be specific to the person, and not to the workspace. In addition, Eclipse’s support for multiple workspaces is limited to import/export based usage, and Mylyn inherits this limitation. We highly recommend configuring your Eclipse workspace to use working sets instead of relying on multiple workspaces. +
+If using a single workspace is not possible you can do the following, Mylyn does provide an advanced facility for using the same data directory that’s outside of the workspace. However, this is not generally recommended because it can cause you to overwrite an existing Task List if both workspaces are launched at the same time.
+Note that using + File → Import → Task Data is another way to get an existing + Task List into your workspace. If you use this mechanism for sharing the + Task List between workspaces you should export the + Task List when switching, because in this mode you are working with two separate + Task List''s. While much of the task state that yo uwork on is stored in shared task repositories, all read state, activity history, planning information and local tasks are maintained in the ''Task List and as such it can become cumbersome to end up with two different lists to manage. +
+See also:
+Export via File → Export → Mylyn → Task Data
+There are many work items that make up the developer’s workday. Many issue trackers and project management tools refer to these as: bugs, defects, actions, tickets, stories, enhancements, and the list goes on. We refer to all such work items as “tasks” because the word tasks is short and commonly used in time management tools. Task Repository connectors can customize the presentation of tasks, for example, indicating which is a defect and which is an action item.
+If you are running Eclipse from KDE go to KControl → GTK Styles and Fonts and select “Use another style” in the GTK Styles section ({{bug|206399}}).
+See the + Recommended GTK Setup for KDE if the style selection does not work. +
+The current mechanism for starring tasks is to schedule them for + Today, which has a very similar effect to starring in other UIs. If you schedule a task for today, the task will stand out as blue and always show (i.e., have guaranteed visibility when the Task List is focused). If that’s too visible, you can schedule it for + This Week, in which case the task will always show but not turn blue. +
+The alternative to mark a shared task as outgoing by adding text into it and (e.g. “ + review”). The ougtoing change will also give the task guaranteed visibility. This is currently the only work-around for ‘starring’ completed tasks. +
+The task-focused interface consider tasks orthogonal to resources (e.g., files and web pages). Resources make sense to star/bookmark, since their primary residence is in some structural hierarchy (e.g. folders or a type hierarchy). Starring provides a mechanism for locating the most relevant parts of a large hierarchy (at the cost of having our starred/bookmark lists bloat and become yet another thing to manage). Tasks are inherently different than resources because their primary residence is in time (e.g. due dates, milestones, things completed in the past). As such, the equivalent of starring for tasks is to schedule them to be viewed in the “current” time window (e.g. today or this week). For a discussion on this refer to {{bug|168363}}.
+ + + + | ++ + + + | ++ + + + | +
Installation | ++ | Task Editor | +
Task Repositories | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task Editor | ++ | Bugzilla Connector | +
Mylyn does not require the use a of a task repository and can be used entirely with the + Local Tasks repository that it comes bundled with. However, if working with a team, a shared + Task Repository provides the key infrastructure needed to let your team work in a Task-Focused way via Mylyn’s collaborative facilities. +
+Those not currently using another supported + Task Repository should consider the repositories currently + supported by Mylyn as well as those supported by the + third party Mylyn extensions. +
+To see support for your repository faster, do a search of the open repository connector requests and + vote for the corresponding bug if your tracker is there, or + create a new bug. +
++ Generic Repository Connector, allows creating Queries to the web-based issue tracking repositories and get list of issues from the web UI into the Task List. +
+It is also possible to link a + local task with the web page in web-based repository via the Mylyn Web integration. +
++ To create a task from any web-based repository: +
+Ctrl
pressed in order for Eclipse to recognize the drop.
+ right+click
the task and select
+ Open in External Browser.
+ + +
+If you upgrade Eclipse or your Java VM, you will need to reset your credentials in the + Task Repositories view because these are stored in the secure Eclipse workbench keyring. Also see + bug 149607. If you are migrating + from Eclipse 3.2 to 3.3 note that you will need to use a different update site, which is listed here: + http://eclipse.org/mylyn/dl.php +
+Your server’s repository attributes can change frequently, for example, there can be a new "milestone" or "version" added to the Bugzilla repository with each release. When the + Preferences → Mylyn → Task List → Synchronization setting is enabled, every 10th synchronization will update the attributes from the repository. If you do not have this setting enabled, your can force the update via the + Update Attributes action on the task repositories’ context menu in the + Task Repositories view. Note that you will need to reopen a task editor to see the updated attributes. If you instead update via the button on the + Attributes section of the + Task Editor the attribute settings will be reloaded without needing to reopen. +
++ bugs.eclipse.org users: Note that the attributes listing on eclipse.org is mirrored, and the mirrors are only updated 24 hours. As such, you may need to wait up to 24 hours for the new attributes to show up. +
+You must ensure repository credentials are filled out correctly. Refer to the diagram below:
++ right +
+dev.eclipse.org
, use anonymous logon with password left blank.Mylyn supports authentication with certificates from a Java keystore. The path and password to the keystore need to be specified in system properties. These can be set in the eclipse.ini in your eclipse install directory:
+-vmargs +… +-Djavax.net.ssl.keyStore=/path/to/.eclipsekeystore +-Djavax.net.ssl.keyStorePassword=123456 ++
If your keystore does not have the default type (JKS) you can specify a different type:
+-Djavax.net.ssl.keyStoreType=PKCS12 ++
If you do not have a client certificate you can create one and have it signed by a CA:
+keytool -genkey -keyalg DSA -keysize 1024 ++
Use this command to create a new certificate signing request:
+keytool -certreq > client.csr ++
Submit the client.csr file to your CA for signing. The CA’s certificate as well as your signed certificate that is returned by the CA need to be imported into the keystore:
+keytool -importcert -alias ca -file ca.crt +keytool -importcert -file client.crt ++
See + this page for links to the keytool documentation. +
+For NTLM authentication to work a special format for the username needs to be used where + DOMAIN needs to be replaced by the Windows login domain: +
+DOMAIN\username ++
The built-in NTLM support of the JDK which is used by Eclipse does + not work with Mylyn since it uses the HttpClient library to access repositories. Limitations in regard to NTLM authentication are documented in the + NTLM FAQ and also discussion on {{bug|201911}}. +
+If NTLM authentication fails the + + NTLM Authorization Proxy Server + has been reported to + work with Mylyn. +
+The built-in SSL support of the JDK will to a name lookup for each new connection. In case your network setup cannot resolve the host name (e.g. no proper name server), this lookup will time out, delaying the whole job. + If setting up a name server is not an option, a work around would be to edit your local hosts file, and add the server IP there (and, if possible, add your computer's IP to the server's hosts file).
+For task hyperlinks in textual editors (e.g. Java editor) and other text viewers (e.g. History view comments) you must associate the project that contains the resource to the task repository.
+Note that to view a hyperlink you must hold down the Ctrl
key when hovering over the reference to the task. References to tasks are connector specific and the common reference is found on the top left of the task editor and other conventions tend to follow those used in the web UI (e.g. “bug 123” for Bugzilla, “ABC-123” for JIRA).
+ +
+ + + + | ++ + + + | ++ + + + | +
Task Editor | ++ | Bugzilla Connector | +
Team Support | +||
---|---|---|
+ + + + | ++ | + + + + | +
Java Development | ++ | WikiText | +
If a task change set disappears or is missing items, toggle the Incoming/Outgoing mode of the Synchronize view via its toolbar button.
+A task change set should appear if you activate a task and modify a file connected to a compatible source repository (e.g. CVS, SVN). If it does not try the following:
+If the above are working but the change set appears to be missing relevant files:
+If you have the + Preferences → Mylyn → Context → Manage open editors to match task context option enabled, Mylyn will perform editor management so that you don’t have to. Closing a file makes it less interesting, and causes it to disappear from the active task context, and hence from the change set. This option prevents you from having to manage the set of open files, will automatically close editors for files that become uninteresting, and will ensure that the open editors match the task context. +
+To identify elements within a project, Mylyn relies on the name of the project being consistent across workspaces. If the project name in the workspace that the context was created with is different than its name in your workspace, the task context will not show elements within that project ( + bug 164058). The other case where context can be lost is if the elements change names outside of the workspace ( + bug 164243). +
+The work-around is to use the same project names across your team’s workspaces. We recommend the following two approaches for standardizing on project names:
++ + + + | ++ + + + | ++ + + + | +
Java Development | ++ | WikiText | +
Trac Connector | +||
---|---|---|
+ + + + | ++ | + + + + | +
JIRA Connector | ++ | Web Templates Connector | +
The Trac connector supports two different access methods: The recommended XML-RPC mode offers complete integration with Mylyn but requires additional setup and privileges which may not be available to all users. Web mode offers less functionality but will work with any public Trac repository.
+Requirements:
+This access method offers editing of tasks in a rich editor, attachment support and offline editing. It requires the + XmlRpcPlugin for Trac to be enabled for the accessed repository. The XmlRpcPlugin provides a remote interface to the Trac repository and is distributed separately from Trac (see + #217). See these + install instructions for requirements and documentation. +
+In order to access the repository through XML_RPC each user needs to have the corresponding permission which can be configured through Trac's admin tool:
+trac-admin </path/to/projenv> permission add <user> XML_RPC ++
Requirements:
+In this mode the standard Trac web interface is used for repository access. Tickets may be created and edited through a web browser. Offline editing and attachments are not supported.
+Mylyn works with any stable Trac release that is version 0.9 or later (see below for known limitations). Mylyn works best when used with Trac’s XML-RPC Plugin (see above) but we do not recommend a particular Trac version.
+The Trac connector tests are run against these Trac versions:
+When Mylyn 3.2.1 or later is used with the latest version of the + Trac XmlRpcPlugin from + SVN trunk the Mylyn Trac connector is fully functional ({{bug|175211}}. +
+Problems related to character encodings have been reported when Trac is run with Python 2.3. Upgrading to Python 2.4 may help to resolve this. Please comment on + bug #188363 if you encounter an internal server error when creating a ticket that contains non-ASCII characters. +
+Please make sure that the access type in the repository properties is set to XML-RPC. This requires Trac 0.10 and XML-RPC (see above).
+XML-RPC:
+Web:
+The web mode relies on screen scraping and is likely to fail if the design + (i.e. HTML output) of the Trac repository is heavily customized.
+If you’re having problems opening the web task editor on Linux and the message + Could not create Browser page: XPCOM error -2147221164 appears in the error log, try installing the packages + xulrunner and + xulrunner-gnome-support on your Linux distribution. +
++ + + + | ++ + + + | ++ + + + | +
JIRA Connector | ++ | Web Templates Connector | +
Updating This Document | +||
---|---|---|
+ + + + | ++ | + |
Misc | ++ | + |
This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit + + http://wiki.eclipse.org/Mylyn/FAQ +
+ + + + | ++ + + + | ++ |
Misc | ++ | + |
Web Templates Connector | +||
---|---|---|
+ + + + | ++ | + + + + | +
Trac Connector | ++ | Task-Focused UI | +
It is available from the incubator update site. Please see + http://www.eclipse.org/mylyn/downloads/ . +
+The Web Connector have a “Preview” button in “Advanced Configuration” section in the “Query” preferences dialog. If you get an error or preview table does not show the expected list, you can use “Open” button to verify if web page downloaded by the Web Connector is correct.
+Alternatively, you can use Query Pattern like + ({Description}.+?)({Id}\n) to see content of the retrieved page in preview table and compare it with the source of the web page for the same url loaded into the web browser.
+If retrieved web page is correct, but “Preview” don’t show expected results you need to check the “Query Pattern”. A popular mistake is an unmasked ‘?’ that separates request parameters in the url). For example:
+<a href="show_bug.cgi\?id\=(.+?)">.+?<span class="summary">(.+?)</span> ++
If you don’t see the correct web page, check the following:
+To debug web application auth further, you could use the wget tool (on Windows it available as a standalone command line tool and also included with Cygwin) and run the following command:
+wget -v -d -o query.log -O query.html "http://your.query.url" ++
If repository require basic http auth, you’ll need to use ''--http-user=USER'' and ''--http-password=PASS'' options.
+Then open file + query.html in the web browser and check if it show list of issues you need to fetch from the web server. If it does have correct list, then there could be a problem with query pattern used for parsing. +
+If + query.html does not show expected list of issues you can check + query.log for server responses and try to identify if server require authentication, redirecting your requests somewhere or issue any other errors. +
++ + + + | ++ + + + | ++ + + + | +
Trac Connector | ++ | Task-Focused UI | +
WikiText | +||
---|---|---|
+ + + + | ++ | + + + + | +
Team Support | ++ | Integration with other tools | +
WikiText is a set of plug-ins for Eclipse that provide lightweight markup (wiki) parsing, editing and display capabilities to the Eclipse platform and Mylyn. WikiText provides a parser for wiki markup and converts the markup to HTML, Docbook, DITA, or Eclipse Help format, either via the API or by using Ant tasks. WikiText also provides UI components (such as an editor) integrating with Eclipse and the Mylyn task editor.
+WikiText is available on the Mylyn update site. Unreleased weekly builds are also available via the Mylyn Weekly Builds update site. See the + Mylyn Downloads for details. +
+A stand-alone WikiText package is also available for download from the + Mylyn Downloads page. +
+WikiText extends the Mylyn task editor to be markup-aware. Comments and description text is formatted according to the configured markup language. The description and comment editors are aware of markup and provide content assist, markup help and preview.
+More details can be found here: + Rich Editing for Tasks via Mylyn WikiText (Mik Kersten) +
+This is done on a per-repository basis. When WikiText is installed it is automatically enabled for all configured task repositories for which there is a default markup language setting.
+To change the default settings open the Mylyn Task Repositories view, right-click your task repository and select Properties from the context menu. In the properties dialog choose the Editor settings (you may need to click on it to expand the section).
+To disable WikiText for your repository, select Plain Text.
+To enable WikiText for your repository, select the desired markup language. The default markup language if available for your repository is labeled (default)
+WikiText documentation is installed into the Eclipse help system when WikiText is installed. To see the WikiText documentation open Eclipse, from the Help menu open Help Contents. You will find the WikiText User Guide under Tasks in the table of contents. If you're interested in integrating with WikiText then take a look at the WikiText Developer Guide.
+The same WikiText documentation is also available in the stand-alone distribution and online:
+The WikiText documentation provides detailed information on how this is done in the WikiText User Guide.
+Yes, the WikiText markup parser and Ant tasks may be used outside of Eclipse without reference to any Eclipse classes.
+Detailed information about using WikiText APIs is available within the WikiText Developer Guide. Information about using WikiText Ant tasks is available within the WikiText User Guide.
+WikiText can create HTML, Eclipse Help, DITA, DocBook and FOP from wiki markup. Using the WikiText APIs you can also extend WikiText to create other output formats. + DITA, DocBook and FOP can all be used to create PDF. More information is available in the WikiText User Guide.
+WikiText can parse the following markup languages:
+WikiText is also designed to make it easy to add support for new markup languages.
++ + + + | ++ + + + | ++ + + + | +
Team Support | ++ | Integration with other tools | +
Preferences | +||
---|---|---|
+ + + + | ++ | + + + + | +
Shortcuts | ++ | Task Repository Connectors | +
You can access the following Mylyn preference pages by navigating to Window -> Preferences -> Tasks.
+
+
+ Click "Advanced" to reveal the following additional settings.
+
Use the following checkboxes to set your preferences for the task-focused interface.
+Use this preference page to add or remove resources that should not be included in the context of a task. Typically, excluded files are hidden backup or lock files that are not intented to be opened directly by the user of an application.
+Task List view +
Ctrl+C
: copy taks/query URL and descriptionCtrl+F
: findInsert
: new personal taskF5
: synchronize selectedCtrl+drag
Alt+click
or Alt+RightArrow
: show all children of an element in a focused view, then click to select. Hold down alt to keep drilling in, click on whitespace in view to show all root elements.Ctrl+Shift+Alt+RightArrow
Quick Context ViewCtrl+F9
: activate task dialogCtrl+Shift+F9
: deactivate taskCtrl+F12
: open task dialogCtrl+Shift+F12
: open repository task dialogCtrl+Shift+Up
: mark as landmarkCtrl+Shift+Down
: mark less interestingAlt+Shift+Q, K
: show
+ Task List viewCtrl+F10
: invoke view menu or ruler menu in editor+ + + + | ++ + + + | ++ + + + | +
Shortcuts | ++ | Task Repository Connectors | +
Shortcuts | +||
---|---|---|
+ + + + | ++ | + + + + | +
Team Support | ++ | Preferences | +
Task List view +
Ctrl+drag
Task Editor
+General +
Alt+click
or Alt+RightArrow
: show all children of an element in a focused view, then click to select. Hold down alt to keep drilling in, click on whitespace in view to show all root elements. Ctrl+Shift+Alt+RightArrow
Quick Context View Ctrl+F9
: activate task dialog Ctrl+Shift+F9
: deactivate task Ctrl+F12
: open task dialog Ctrl+Shift+F12
: open repository task dialogInterest manipulation +
Ctrl+Shift+Up
: mark as landmark Ctrl+Shift+Down
: mark less interestingUseful Eclipse shortcuts +
Alt+Shift+Q, K
: show
+ Task List view Ctrl+F10
: invoke view menu or ruler menu in editor+ + + + | ++ + + + | ++ + + + | +
Team Support | ++ | Preferences | +
Task Editor | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task Repositories | ++ | Task-Focused Interface | +
The task editor allows you to view and edit the tasks in your task list. Double-click on a task in your task list to open the editor. The features of the task editor will vary depending on whether it is a local task or a shared repository task. For shared repository tasks, there are some differences depending on the type of repository (and corresponding connector) that you are using (link: connectors).
+In this section, we describe the task editor for shared bugs in a Bugzilla repository. Task editors for other repository types such as JIRA offer similar functionality.
++ +
++ Editor toolbar buttons +
++ Attributes + Use the Attributes section to add or update structured information about the task. +
++ Team Planning + The Team Planning section contains time-related information about the task that will be shared with your team. You can use the + Due field to set a due date for your task. On the due date, the task will appear in red in your task list. +
++ Attachments + You can attach a file to this task so that a copy will be uploaded to your task repository and become available to anyone who can access the task. +
+To attach a file
++ Duplicate Detection + When submitting bug reports, you can avoid duplicates by clicking the "Search" button. This will search the repository for a stack trace that matches a stack trace in the task's Description field. The results of the duplicate detection show up in the Search view. If a match is found, you can open it and comment instead of creating a new bug report. +
++ Comments + Use this section to add new comments about the task and view all previous comments. Comments you have read previously are folded. You can expand and re-read individual comments or click the "+" at the top right to expand all comments. +
++ +
++ Actions + Use this section to change the task's status or reassign the task to another person. +
++ People + This section shows the people who are collaborating on the task. +
+The context tab allows you to manage the context of resources associated with the task. You can view the context tab by selecting it in the lower left of the editor window.
+
+ Elements
+
+ This section lists the resources that are part of the task's context. Because the number of elements may be large, you can adjust the level of detail using the slider at the top of the
+ Actions section. Sliding the control all the way to the left will show you all elements in your task context. As you slide to the right, only the elements with a high level of interest will be displayed. You can manually remove elements from your task context by right-clicking and selecting "Remove From Context". You may choose to view all elements and prune irrelevant items in this way before attaching the context to the task so that others can download it.
+
+ Actions
+
+
+ +
+Use the planning tab to access local information about the task that is private to your workspace. You can view the planning tab by selecting it in the lower left of the editor window. This tab contains a large area where you can enter personal notes about the task. See the local task section for more information about fields in the Personal Planning section.
++ +
+ + + + | ++ + + + | ++ + + + | +
Task Repositories | ++ | Task-Focused Interface | +
Task-Focused Interface | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task Editor | ++ | Team Support | +
The task-focused interface is oriented around tasks and offers several ways to focus the interface on only what is relevant for the currently active task.
+You can focus navigator views (e.g. Package Explorer, Project Explorer, Navigator) by toggling the "Focus on Active Task" button in the toolbar. When focused, the view will show only the resources that are "interesting" for the currently active task.
++ +
+To navigate to a new resource that is not a part of the active task's context, you can toggle "Focus on Active Task" off, browse to the resource, and then click "Focus on Active Task" again to see only relevant resources. A more efficient way to add new resources is to use Alt+Click navigation (Clicking the mouse while holding the Alt key).
+When a view is in Focused mode, you can Alt+Click a node to temporarily show all of its children.
+Some editors such as the Java editor support focusing. Clicking the Focus button in the toolbar will fold all declarations that are not part of the active task context.
++ +
+When a task is active, elements that are interesting are displayed more prominently. For example, when you open the Java Open Type dialog (Ctrl+Shift+T), types that are interesting for the active task are shown first. Similarly, when you use ctrl+space to autocomplete a method name in a Java source file, methods that are in the task context are displayed at the top.
+When Focus is applied to a navigator view, the working sets filter for that navigator view will be disabled. This ensures that you see all interesting elements when working on a task that spans working sets. To enforce visibility of only elements within one working set, do the following:
+An
+ Open Type style dialog is available for opening tasks (Ctrl+F12
) and for activating tasks (Ctrl+F9
). The list is initially populated by recently active tasks. The active task can also be deactivated via Ctrl+Shift+F9
. This can be used as a keyboard-only alternative for multi-tasking without the
+ Task List view visible. These actions appear in the
+ Navigate menu.
+
+ +
+In the task editor, comments that include text of the form bug#123 or task#123 or bug 123 will be hyperlinked. Ctrl+clicking on this text will open the task or bug in the rich task editor.
+To support hyperlinks within other text editors such as code or .txt files, the project that contains the file must be associated with a particular task repository. This is configured by right-clicking on the project and navigating to "Properties" > "Task Repository" and selecting the task repository used when working with this project.
+Bugs can created directly from events in the + Error Log view. This will create a new repository task editor with the summary and description populated with the error event's details. If the Connector you are using does not have a rich editor, the event details will be placed into the clipboard so that you can paste them into the web-based editor that will be opened automatically. +
++ +
+ + + + | ++ + + + | ++ + + + | +
Task Editor | ++ | Team Support | +
Task Repositories | +||
---|---|---|
+ + + + | ++ | + + + + | +
Mylyn User Guide | ++ | Task Editor | +
+ +
+Use the Task Repositories view to configure Mylyn to connect to your team's shared task repository (bug or issue tracker):
++ + + + | ++ + + + | ++ + + + | +
Mylyn User Guide | ++ | Task Editor | +
Task Repository Connectors | +||
---|---|---|
+ + + + | ++ | + + + + | +
Preferences | ++ | Updating This Document | +
Mylyn allows you to collaborate on tasks via a shared task repository, also known as bug tracking systems. In order to collaborate, you need to have a + Connector to your particular repository. +
+See + Mylyn Extensions for a list of available connectors. +
+See + Bugzilla Connector Troubleshooting. +
+See + Trac Connector Troubleshooting. +
+See + this page for install instructions and additional screen shots. Note that the Mylyn JIRA connector requires at least JIRA version 3.3.3 and SOAP/RPC services have to be enabled on the server. +
+See also + JIRA Connector Troubleshooting. +
+The generic web repository connector is NOT part of the default Mylyn install. You can install it from the incubator update site. See + Mylyn download page for more details. +
+The web connector allow to retrieve tasks from repositories that don't have rich connectors, but can show list of tasks on the web UI. Out of the box connector provides configuration templates for the following issue tracking systems:
+code.google.com
)java.net, dev2dev, tigris.org
)objectweb.org
)sf.net
), see
+ Using Sourceforge with Mylyn
+ www.futureware.biz/mantis
)changelogic.araneaframework.org
)otrs.org
)Lists of issues can be extracted from existing web pages using simple parsing configuration. Configuration can be also parametrized to make it easier to customize it for a specific project.
+The parameters used for configuring project properties are typically substituted into the URLs used to access the repository. Substitution and matching rules can be edited under the + Advanced Configuration section on both the + Repository Settings page and the + Edit Query page. +
+See + FAQ for the troubleshooting tips. +
+
+ For example, consider the configuration steps for GlassFish project at java.net
:
+
+ 1. Create new Generic web-based repository (in the Task Repository view). GlassFish is using IssueZilla and has a preconfigured template that can be selected by server url + + https://glassfish.dev.java.net/issues + . You can also specify all fields manually in the + Advanced Configuration section. For GlassFish the following settings are required: +
+${serverUrl}/show_bug.cgi?id=
${serverUrl}/enter_bug.cgi?issue_type=DEFECT
${serverUrl}/buglist.cgi?component=glassfish&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&order=Issue+Number
<a href="show_bug.cgi\?id\=(.+?)">.+?<span class="summary">(.+?)</span>
regexp
with 1st matching group on
+ Issue ID and 2nd on
+ Issue Description. Alternatively, you could use named matching groups: ({Id}.+?), ({Description}.+?), ({Status}.+?), ({Owner}.+?) and ({Type}.+?), then they can appear in query regexp
in an arbitrary order. The second option requires build 2.0.0v20070717 or later.
+ ${..}
. Variables serverUrl, userId
and password
are substituted from the values of corresponding fields of the repository preference page. In addition you can specify any arbitrary parameters and their values that will be also substituted into the template fields.
+ + + For the web repository that require user to login, use advanced configuration in following way. + This configuration is for GForge, you might need to change it for other repositories: +
+${serverUrl}/account/login.php?return_to=&form_loginname=${userId}&form_pw=${password}&login=Login
+ (POST)
+ ${serverUrl}/account/login.php
+ loginToken
parameter from the form page
+ (only needed if server need a login token in the parameters of the Login Request URL and Login Form URL is specified): session_ser=(.+?)
+ + 2. Create a new query for the GlassFish task repository created above (either from popup context menu in the Task List view or using a "New..." wizard from File -> New... -> Other... menu). +
++ +
+The XPlanner connector is currently in the Experimental state. It supports XPlanner version .7.
++ Query +
+XPlanner Connector supports creating queries from your XPlanner repository. You can select to create a query for your own in progress tasks (the default), or select projects or iterations or user stories from a list. You can also select ones assigned to you, or all. Currently you can choose to group the results by tasks or user stories. If you group the results by tasks, this will result in a single query with the applicable tasks underneath it. If you choose to group the results by user stories, this will result in multiple queries added to the task list, each one corresponding to a user story, with the applicable tasks underneath it:
++ +
++ Task Editor +
+A rich editor for editing XPlanner tasks is available. It currently doesn't support all of the attributes you can change in XPlanner itself, but allows you to modify the basic ones necessary for XP development -- e.g. summary, description, estimated time. The attributes section of the editor displays an XPlanner-like view of the meaningful attributes, some of which are not editable.
++ +
++ User Story Editor +
+If you open an XPlanner element by id, using the "Open Repository Task by Key/ID" dialog, and that id is a user story id, you will see the read-only user story editor. This editor is just useful for seeing the major details of a user story -- no items in it can be changed, since there is no really good mapping between a user story and a Mylyn task.
++ +
++ Category:Draft Documentation +
+ + + + | ++ + + + | ++ + + + | +
Preferences | ++ | Updating This Document | +
Team Support | +||
---|---|---|
+ + + + | ++ | + + + + | +
Task-Focused Interface | ++ | Shortcuts | +
The task-focused interface provides several ways to improve your work flow when working with a source code repository such as CVS or Subversion. CVS support is available out-of-the-box and task-focused interface integration for Subversion is available via the Subclipse or Subversive plugins.
+When working with a source code repository, you can commit or update only the resources that are in the context of a particular task. This helps you work on several tasks concurrently and avoid polluting your workspace with changes that are not relevant to the current task.
+To enable this functionality, locate the "Synchronize" view. If the view is not visible, you can open it by navigating to Window -> Show View -> Other... -> Team -> Synchronize. Next, click the small black arrow next to "Show File System Resources" in the Synchronize view toolbar and select "Change Sets".
+You can now synchronize resources in your workspace as usual (e.g. by right-clicking on a resource in the navigator and selecting "Team" -> "Synchronize with Repository". Your resources will now be grouped by change sets corresponding to tasks. Expanding the task shows individual resources. Changed resources that are not a part of any task context will appear under the root of the Synchronize view. If needed missing resources can be added to the task context Change Set via the Synchronize View by right+clicking the resource and selecting "Add to" and then selecting the corresponding task. Select "no set" to remove a resource from a change set.
++ +
+You can use buttons in the toolbar of the Synchronize view to change modes as follows:
+Right-clicking a Change Set provides access to the following operations:
+When using task-focused change sets as described above, commit messages are automatically be generated based on the task whose resources are being commited. By default, the commit message includes information such as the task ID, description, and URL. To change the template for these commit messages, navigate to Window -> Preferences -> Tasks -> Team.
+When applying patches, the preferred scenario is to have a task context attached to the task along with the patch. Since this is not always feasible, Mylyn provides an action in the popup menu of the + Synchronize view that supports adding changed elements to the task context. +
++ +
+ + + + | ++ + + + | ++ + + + | +
Task-Focused Interface | ++ | Shortcuts | +
Updating This Document | +||
---|---|---|
+ + + + | ++ | + |
Task Repository Connectors | ++ | + |
This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit + + http://wiki.eclipse.org/Mylyn/User_Guide +
+ + + + | ++ + + + | ++ |
Task Repository Connectors | ++ | + |
Mylyn User Guide | +||
---|---|---|
+ | + | + + + + | +
+ | + | Task Repositories | +
Use the Task List to view and manage your tasks. If the task list view is not visible, you can open it by navigating to Window -> Show View -> Other... -> Mylyn -> Task List. The Task List contains both "Local Tasks" and shared "repository tasks" that are stored in a task repository such as Bugzilla or Jira. See how to create new tasks. Local tasks are typically contained in categories, which you can create by right-clicking on the task list and selecting new -> category. Repository tasks are contained in special categories that represent queries.
++ +
+At the top of the Task List, you will find the following buttons and features:
+The task list supports several ways to present tasks. You can toggle between the following modes by using the "Task Presentation" button in the toolbar.
++ +
+In either presentation, you can toggle the "Focus on Workweek" button. In this mode, only the following tasks will be visible:
+See the legend below to interpret the icons and color coding in the task list. You can view this legend by selecting "Show UI Legend" from the menu that appears when you click the white down arrow next to the minimize button in the top right corner of the Task List view.
++ +
++ +
+You can create new tasks by clicking on the "New Task" button in the Task List's toolbar. This will open the "New Task" dialog and prompt you to select a repository. There are two main types of tasks, local tasks and repository tasks.
+Use local tasks if you do not have a shared task repository or if you would like to create a private, personal task that is local to your workspace. To create a local task, select + Local Task and "Finish" from the New Task dialog. +
+You can then provide the following details about the task.
++ +
+Create a new repository task when you would like to share information about the task with your team using a task repository such as Bugzilla or JIRA. To create a new repository task, click on the "New Task" button in the Task List's toolbar. You can then select the repository where you would like to create a task. If you don't see your team's task repository, you will need to configure it in the task repositories view. Once you have selected a repository, click "Next". If you are connecting to a Bugzilla repository, select a "Product" as a top-level category for your task and click "Finish".
+A new task editor will appear. If you are using Bugzilla, you can enter the following information:
+Required
+Optional
+When finished, click "Submit" to add your new task to your team's shared task repository.
++ +
+Once you have configured your team's task repository, you can use Queries to add tasks to your task list.
+If you are using the Bugzilla connector, you can specify the following parameters by default. The parameters for most other connectors will be similar.
+Two kinds of dates for scheduling are provided.
++ Scheduled Date +
++ Due Date +
+Repository tasks and queries are synchronized to reflect the latest changes on the server. + Tasks are synchronized the following ways:
+
+
+
+ Disconnected Mode
+
+ A task repository can be put into Disconnected mode via the right-click menu in the
+ Task Repositories view. This can be useful if the task repository is not currently in use (e.g. you are no longer engaged with the project, or the repository is no longer available). The offline support will ensure that you can still access tasks that you have worked with via their offline copies, and the Disconnected mode will ensure that synchronization warnings do not appear. Note that it is not necessary to turn off synchronization or work in Disconnected Mode when working offline.
+
A blue arrow to the left of a task indicates that the task has changed in the shared repository. Double-click the task to view it in the task editor. Changes to the task will be highlighted in blue.
+To quickly review the differences since the task was last read, hover over the task in the Task List to view a summary in a tooltip. You can also press F4 to display a tooltip. You may also wish to view the task list in "Focus on Workweek" mode, which will filter out tasks without incoming changes that are not scheduled or due this week. You can toggle "Focus on Workweek" using a button in the Task List's toolbar.
+The task list has been carefully designed to support quickly reviewing tasks. Task reviewing is best done by configuring a query to show the tasks that you want to review. Once the tasks are displayed in the Task List they can be reviewed one at a time by scrolling through them using the keyboard up/down arrows. The task tooltip should provide enough detail to do a review and will display information relevant to the currently selected task.
+To edit the selected task press the enter key, use Ctrl+Enter to open the task in the background. To quickly jump to the next unread task hold down the Alt-key when pressing up or down. To mark a task as read while navigating use Alt+shift+up/down. When reviewing tasks in this way, it is best to avoid mouse-based and gesture-based scrolling.
++ +
+
+ Weekly progress
+
+ When in
+ Focus on Workweek mode (right-most toolbar button), the Task List will show a progress bar that indicates progress on the tasks scheduled for the current week. Each task that is scheduled for the week but not yet completed adds to the bar. A task completed by you adds to the green progress in the bar. Deferring a task to a future week will also add to the apparent progress because it will remove the task from the current week. Mousing over the bar will indicate details about your progress, such as the number of tasks and hours completed. To avoid the need for manual estimation by default every task is estimated for 1 hour, but if you have longer or shorter running tasks that week you can adjust the estimate in the task editor's
+ Planning page to ensure that the progress bar is accurate.
+
Note that when in + Focus on Workweek mode the + Task List will show each of the tasks scheduled for this week. However, overdue tasks and those with incoming changes will also show, making the number of tasks visible not be a reliable indicator of progress on the tasks planned for the week. +
++ +
+
+
+
+ Category Progress
+
+ You can hover over categories in the task list to display a tooltip that displays a summary of complete and incomplete tasks.
+
+ +
+Click the small white arrow in the top left of the task list to access the following settings:
+
+
+ Right-clicking in the task list provides access to the following operations
+
+ | + | + + + + | +
+ | + | Task Repositories | +
Configuring Task Repositories | -||
---|---|---|
- - - - | -- | - - - - | -
Task List | -- | Creating new Queries | -
- -
-Use the Task Repositories view to configure Mylyn to connect to your team's shared task repository (bug or issue tracker):
-- - - - | -- - - - | -- - - - | -
Task List | -- | Creating new Queries | -
Creating new Queries | -||
---|---|---|
- - - - | -- | - - - - | -
Configuring Task Repositories | -- | Creating new Tasks | -
- -
-Once you have configured your team's task repository, you can use Queries to add tasks to your task list.
-If you are using the Bugzilla connector, you can specify the following parameters by default. The parameters for most other connectors will be similar.
-- - - - | -- - - - | -- - - - | -
Configuring Task Repositories | -- | Creating new Tasks | -
Creating new Tasks | -||
---|---|---|
- - - - | -- | - - - - | -
Creating new Queries | -- | Task Editor | -
- -
-You can create new tasks by clicking on the "New Task" button in the Task List's toolbar. This will open the "New Task" dialog and prompt you to select a repository. There are two main types of tasks, local tasks and repository tasks.
-Use local tasks if you do not have a shared task repository or if you would like to create a private, personal task that is local to your workspace. To create a local task, select - Local Task and "Finish" from the New Task dialog. -
-You can then provide the following details about the task.
-- -
-Create a new repository task when you would like to share information about the task with your team using a task repository such as Bugzilla or JIRA. To create a new repository task, click on the "New Task" button in the Task List's toolbar. You can then select the repository where you would like to create a task. If you don't see your team's task repository, you will need to configure it in the task repositories view. Once you have selected a repository, click "Next". If you are connecting to a Bugzilla repository, select a "Product" as a top-level category for your task and click "Finish".
-A new task editor will appear. If you are using Bugzilla, you can enter the following information:
-Required
-Optional
-When finished, click "Submit" to add your new task to your team's shared task repository.
- - - - | -- - - - | -- - - - | -
Creating new Queries | -- | Task Editor | -
Installation | -||
---|---|---|
- - - - | -- | - - - - | -
Introduction | -- | Task List | -
As of writing, Mylyn comes bundled with the main EPP distributions ( - jee, java, cpp). If you wish to manually install Mylyn there are to methods depending on the version of Eclipse. Method 1 outlines how to install using the Eclipse 3.4 update manager. Method 2 below describes how to install Mylyn into Eclipse 3.3 and below using the Update Manager. -
-
- http://download.eclipse.org/tools/mylyn/update/e3.4
-
- http://download.eclipse.org/tools/mylyn/update/e3.3
- - - - - | -- - - - | -- - - - | -
Introduction | -- | Task List | -
Integration with other tools | -||
---|---|---|
- - - - | -- | - - - - | -
Task Repository Connectors | -- | Updating This Document | -
See the - - Mylyn Extensions - page for a listing of integration downloads. -
-Mylyn relies on - Bridges to integrate the context model with the structure and UI features of domain-specific tools. To create a Bridge, see - Creating Bridges. -
-The core set of Bridges supports the Eclipse SDK (i.e. has bridges for Java, JUnit, PDE, Ant and Resources). The Resources Bridge enables a basic level of interoperability with other tools that use files (e.g. .php, .cpp
), and enables Mylyn filtering to work for generic views that show those files (i.e. the
- Project Explorer,
- Navigator) and any corresponding markers (i.e. the
- Problems and
- Tasks views). This is only the most basic context model integration, and does not offer the benefits of a specialized structure bridge, such as making declarations part of the context and providing
- Active Search facilities. Without a Bridge Mylyn cannot be applied to tool-specific views.
-
- If you would like to see support for a particular tool, first do a search of the open bridge requests and - vote for the corresponding bug if your tool is there, or - create a new bug. Also consider adding your experiences to the - "Integration..." section of the Mylyn FAQ. -
-Context modeling works at the file level, noting the limitation of - bug 144882: interest filter fails on WTP Dynamic Web Project -
-If an external builder (e.g. Maven, pydev, or other Ant-based builders) is producing output files that are being automatically added to your context because they are not being marked "derived" as with Eclipse-based builders. You may note that such files are always show as interesting when they are generated or updated and can not be filtered away, since Mylyn expects all files that have changed as part of the task context to have interest.
-In this case you can explicitly exclude these files from being added to the task context the - Preferences -> Mylyn -> Resources page. For example, if the output folder of the builder is "target", you could set this the following way. Similarly, you could add a filter for "*.pyc" to exclude all files generated with that extension. -
-Source code generators can be considered analogous since they produce intermediate files. However, if you want to inspect the results of the source code generation after it is done you can avoid setting the exclusion. Note that if a large number of files was generated not all generated files may be unfiltered.
-- -
- - - - | -- - - - | -- - - - | -
Task Repository Connectors | -- | Updating This Document | -
Mylyn Reference | -||
---|---|---|
- | - | - - - - | -
- | - | Task Repositories | -
Use the Task List to view and manage your tasks. If the task list view is not visible, you can open it by navigating to Window -> Show View -> Other... -> Mylyn -> Task List. The Task List contains both "Local Tasks" and shared "repository tasks" that are stored in a task repository such as Bugzilla or Jira. See how to create new tasks. Local tasks are typically contained in categories, which you can create by right-clicking on the task list and selecting new -> category. Repository tasks are contained in special categories that represent queries.
-- -
-At the top of the Task List, you will find the following buttons and features:
-The task list supports several ways to present tasks. You can toggle between the following modes by using the "Task Presentation" button in the toolbar.
-- -
-In either presentation, you can toggle the "Focus on Workweek" button. In this mode, only the following tasks will be visible:
-See the legend below to interpret the icons and color coding in the task list. You can view this legend by selecting "Show UI Legend" from the menu that appears when you click the white down arrow next to the minimize button in the top right corner of the Task List view.
-- -
-- -
-You can create new tasks by clicking on the "New Task" button in the Task List's toolbar. This will open the "New Task" dialog and prompt you to select a repository. There are two main types of tasks, local tasks and repository tasks.
-Use local tasks if you do not have a shared task repository or if you would like to create a private, personal task that is local to your workspace. To create a local task, select - Local Task and "Finish" from the New Task dialog. -
-You can then provide the following details about the task.
-- -
-Create a new repository task when you would like to share information about the task with your team using a task repository such as Bugzilla or JIRA. To create a new repository task, click on the "New Task" button in the Task List's toolbar. You can then select the repository where you would like to create a task. If you don't see your team's task repository, you will need to configure it in the task repositories view. Once you have selected a repository, click "Next". If you are connecting to a Bugzilla repository, select a "Product" as a top-level category for your task and click "Finish".
-A new task editor will appear. If you are using Bugzilla, you can enter the following information:
-Required
-Optional
-When finished, click "Submit" to add your new task to your team's shared task repository.
-- -
-Once you have configured your team's task repository, you can use Queries to add tasks to your task list.
-If you are using the Bugzilla connector, you can specify the following parameters by default. The parameters for most other connectors will be similar.
-Two kinds of dates for scheduling are provided.
-- Scheduled Date -
-- Due Date -
-Repository tasks and queries are synchronized to reflect the latest changes on the server. - Tasks are synchronized the following ways:
-
-
-
- Disconnected Mode
-
- A task repository can be put into Disconnected mode via the right-click menu in the
- Task Repositories view. This can be useful if the task repository is not currently in use (e.g. you are no longer engaged with the project, or the repository is no longer available). The offline support will ensure that you can still access tasks that you have worked with via their offline copies, and the Disconnected mode will ensure that synchronization warnings do not appear. Note that it is not necessary to turn off synchronization or work in Disconnected Mode when working offline.
-
A blue arrow to the left of a task indicates that the task has changed in the shared repository. Double-click the task to view it in the task editor. Changes to the task will be highlighted in blue.
-To quickly review the differences since the task was last read, hover over the task in the Task List to view a summary in a tooltip. You can also press F4 to display a tooltip. You may also wish to view the task list in "Focus on Workweek" mode, which will filter out tasks without incoming changes that are not scheduled or due this week. You can toggle "Focus on Workweek" using a button in the Task List's toolbar.
-The task list has been carefully designed to support quickly reviewing tasks. Task reviewing is best done by configuring a query to show the tasks that you want to review. Once the tasks are displayed in the Task List they can be reviewed one at a time by scrolling through them using the keyboard up/down arrows. The task tooltip should provide enough detail to do a review and will display information relevant to the currently selected task.
-To edit the selected task press the enter key, use Ctrl+Enter to open the task in the background. To quickly jump to the next unread task hold down the Alt-key when pressing up or down. To mark a task as read while navigating use Alt+shift+up/down. When reviewing tasks in this way, it is best to avoid mouse-based and gesture-based scrolling.
-- -
-
- Weekly progress
-
- When in
- Focus on Workweek mode (right-most toolbar button), the Task List will show a progress bar that indicates progress on the tasks scheduled for the current week. Each task that is scheduled for the week but not yet completed adds to the bar. A task completed by you adds to the green progress in the bar. Deferring a task to a future week will also add to the apparent progress because it will remove the task from the current week. Mousing over the bar will indicate details about your progress, such as the number of tasks and hours completed. To avoid the need for manual estimation by default every task is estimated for 1 hour, but if you have longer or shorter running tasks that week you can adjust the estimate in the task editor's
- Planning page to ensure that the progress bar is accurate.
-
Note that when in - Focus on Workweek mode the - Task List will show each of the tasks scheduled for this week. However, overdue tasks and those with incoming changes will also show, making the number of tasks visible not be a reliable indicator of progress on the tasks planned for the week. -
-- -
-
-
-
- Category Progress
-
- You can hover over categories in the task list to display a tooltip that displays a summary of complete and incomplete tasks.
-
- -
-Click the small white arrow in the top left of the task list to access the following settings:
-
-
- Right-clicking in the task list provides access to the following operations
-
- | - | - - - - | -
- | - | Task Repositories | -
Preferences | -||
---|---|---|
- - - - | -- | - - - - | -
Shortcuts | -- | Task Repository Connectors | -
You can access the following Mylyn preference pages by navigating to Window -> Preferences -> Tasks.
-
-
- Click "Advanced" to reveal the following additional settings.
-
Use the following checkboxes to set your preferences for the task-focused interface.
-Use this preference page to add or remove resources that should not be included in the context of a task. Typically, excluded files are hidden backup or lock files that are not intented to be opened directly by the user of an application.
-Task List view -
Ctrl+C
: copy taks/query URL and descriptionCtrl+F
: findInsert
: new personal taskF5
: synchronize selectedCtrl+drag
Alt+click
or Alt+RightArrow
: show all children of an element in a focused view, then click to select. Hold down alt to keep drilling in, click on whitespace in view to show all root elements.Ctrl+Shift+Alt+RightArrow
Quick Context ViewCtrl+F9
: activate task dialogCtrl+Shift+F9
: deactivate taskCtrl+F12
: open task dialogCtrl+Shift+F12
: open repository task dialogCtrl+Shift+Up
: mark as landmarkCtrl+Shift+Down
: mark less interestingAlt+Shift+Q, K
: show
- Task List viewCtrl+F10
: invoke view menu or ruler menu in editor- - - - | -- - - - | -- - - - | -
Shortcuts | -- | Task Repository Connectors | -
Shortcuts | -||
---|---|---|
- - - - | -- | - - - - | -
Team Support | -- | Preferences | -
Task List view -
Ctrl+drag
Task Editor
-General -
Alt+click
or Alt+RightArrow
: show all children of an element in a focused view, then click to select. Hold down alt to keep drilling in, click on whitespace in view to show all root elements. Ctrl+Shift+Alt+RightArrow
Quick Context View Ctrl+F9
: activate task dialog Ctrl+Shift+F9
: deactivate task Ctrl+F12
: open task dialog Ctrl+Shift+F12
: open repository task dialogInterest manipulation -
Ctrl+Shift+Up
: mark as landmark Ctrl+Shift+Down
: mark less interestingUseful Eclipse shortcuts -
Alt+Shift+Q, K
: show
- Task List view Ctrl+F10
: invoke view menu or ruler menu in editor- - - - | -- - - - | -- - - - | -
Team Support | -- | Preferences | -
Task Editor | -||
---|---|---|
- - - - | -- | - - - - | -
Task Repositories | -- | Task-Focused Interface | -
The task editor allows you to view and edit the tasks in your task list. Double-click on a task in your task list to open the editor. The features of the task editor will vary depending on whether it is a local task or a shared repository task. For shared repository tasks, there are some differences depending on the type of repository (and corresponding connector) that you are using (link: connectors).
-In this section, we describe the task editor for shared bugs in a Bugzilla repository. Task editors for other repository types such as JIRA offer similar functionality.
-- -
-- Editor toolbar buttons -
-- Attributes - Use the Attributes section to add or update structured information about the task. -
-- Team Planning - The Team Planning section contains time-related information about the task that will be shared with your team. You can use the - Due field to set a due date for your task. On the due date, the task will appear in red in your task list. -
-- Attachments - You can attach a file to this task so that a copy will be uploaded to your task repository and become available to anyone who can access the task. -
-To attach a file
-- Duplicate Detection - When submitting bug reports, you can avoid duplicates by clicking the "Search" button. This will search the repository for a stack trace that matches a stack trace in the task's Description field. The results of the duplicate detection show up in the Search view. If a match is found, you can open it and comment instead of creating a new bug report. -
-- Comments - Use this section to add new comments about the task and view all previous comments. Comments you have read previously are folded. You can expand and re-read individual comments or click the "+" at the top right to expand all comments. -
-- -
-- Actions - Use this section to change the task's status or reassign the task to another person. -
-- People - This section shows the people who are collaborating on the task. -
-The context tab allows you to manage the context of resources associated with the task. You can view the context tab by selecting it in the lower left of the editor window.
-
- Elements
-
- This section lists the resources that are part of the task's context. Because the number of elements may be large, you can adjust the level of detail using the slider at the top of the
- Actions section. Sliding the control all the way to the left will show you all elements in your task context. As you slide to the right, only the elements with a high level of interest will be displayed. You can manually remove elements from your task context by right-clicking and selecting "Remove From Context". You may choose to view all elements and prune irrelevant items in this way before attaching the context to the task so that others can download it.
-
- Actions
-
-
- -
-Use the planning tab to access local information about the task that is private to your workspace. You can view the planning tab by selecting it in the lower left of the editor window. This tab contains a large area where you can enter personal notes about the task. See the local task section for more information about fields in the Personal Planning section.
-- -
- - - - | -- - - - | -- - - - | -
Task Repositories | -- | Task-Focused Interface | -
Task-Focused Interface | -||
---|---|---|
- - - - | -- | - - - - | -
Task Editor | -- | Team Support | -
The task-focused interface is oriented around tasks and offers several ways to focus the interface on only what is relevant for the currently active task.
-You can focus navigator views (e.g. Package Explorer, Project Explorer, Navigator) by toggling the "Focus on Active Task" button in the toolbar. When focused, the view will show only the resources that are "interesting" for the currently active task.
-- -
-To navigate to a new resource that is not a part of the active task's context, you can toggle "Focus on Active Task" off, browse to the resource, and then click "Focus on Active Task" again to see only relevant resources. A more efficient way to add new resources is to use Alt+Click navigation (Clicking the mouse while holding the Alt key).
-When a view is in Focused mode, you can Alt+Click a node to temporarily show all of its children.
-Some editors such as the Java editor support focusing. Clicking the Focus button in the toolbar will fold all declarations that are not part of the active task context.
-- -
-When a task is active, elements that are interesting are displayed more prominently. For example, when you open the Java Open Type dialog (Ctrl+Shift+T), types that are interesting for the active task are shown first. Similarly, when you use ctrl+space to autocomplete a method name in a Java source file, methods that are in the task context are displayed at the top.
-When Focus is applied to a navigator view, the working sets filter for that navigator view will be disabled. This ensures that you see all interesting elements when working on a task that spans working sets. To enforce visibility of only elements within one working set, do the following:
-An
- Open Type style dialog is available for opening tasks (Ctrl+F12
) and for activating tasks (Ctrl+F9
). The list is initially populated by recently active tasks. The active task can also be deactivated via Ctrl+Shift+F9
. This can be used as a keyboard-only alternative for multi-tasking without the
- Task List view visible. These actions appear in the
- Navigate menu.
-
- -
-In the task editor, comments that include text of the form bug#123 or task#123 or bug 123 will be hyperlinked. Ctrl+clicking on this text will open the task or bug in the rich task editor.
-To support hyperlinks within other text editors such as code or .txt files, the project that contains the file must be associated with a particular task repository. This is configured by right-clicking on the project and navigating to "Properties" > "Task Repository" and selecting the task repository used when working with this project.
-Bugs can created directly from events in the - Error Log view. This will create a new repository task editor with the summary and description populated with the error event's details. If the Connector you are using does not have a rich editor, the event details will be placed into the clipboard so that you can paste them into the web-based editor that will be opened automatically. -
-- -
- - - - | -- - - - | -- - - - | -
Task Editor | -- | Team Support | -
Task List | -||
---|---|---|
- - - - | -- | - - - - | -
Installation | -- | Configuring Task Repositories | -
Use the Task List to view and manage your tasks. If the task list view is not visible, you can open it by navigating to Window -> Show View -> Other... -> Mylyn -> Task List. The Task List contains both "Local Tasks" and shared "repository tasks" that are stored in a task repository such as Bugzilla or Jira. See how to create new tasks. Local tasks are typically contained in categories, which you can create by right-clicking on the task list and selecting new -> category. Repository tasks are contained in special categories that represent queries.
-- -
-At the top of the Task List, you will find the following buttons and features:
-The task list supports several ways to present tasks. You can toggle between the following modes by using the "Task Presentation" button in the toolbar.
-- -
-In either presentation, you can toggle the "Focus on Workweek" button. In this mode, only the following tasks will be visible:
-See the legend below to interpret the icons and color coding in the task list. You can view this legend by selecting "Show UI Legend" from the menu that appears when you click the white down arrow next to the minimize button in the top right corner of the Task List view.
-- -
-Two kinds of dates for scheduling are provided.
-- Scheduled Date -
-- Due Date -
-Repository tasks and queries are synchronized to reflect the latest changes on the server. - Tasks are synchronized the following ways:
-
-
-
- Disconnected Mode
-
- A task repository can be put into Disconnected mode via the right-click menu in the
- Task Repositories view. This can be useful if the task repository is not currently in use (e.g. you are no longer engaged with the project, or the repository is no longer available). The offline support will ensure that you can still access tasks that you have worked with via their offline copies, and the Disconnected mode will ensure that synchronization warnings do not appear. Note that it is not necessary to turn off synchronization or work in Disconnected Mode when working offline.
-
A blue arrow to the left of a task indicates that the task has changed in the shared repository. Double-click the task to view it in the task editor. Changes to the task will be highlighted in blue.
-To quickly review the differences since the task was last read, hover over the task in the Task List to view a summary in a tooltip. You can also press F4 to display a tooltip. You may also wish to view the task list in "Focus on Workweek" mode, which will filter out tasks without incoming changes that are not scheduled or due this week. You can toggle "Focus on Workweek" using a button in the Task List's toolbar.
-You can use the following hot keys to quickly access frequently used functionality.
-F2 | -rename | -
F4 | -show tooltip | -
F5 | -synchronize | -
Alt + Down | -go to next unread | -
Alt + Up | -go to previous unread | -
Alt + Shift + R | -mark as read | -
Alt + Shift + U | -mark as unread | -
Esc | -hide tooltip | -
Enter | -open task | -
Insert | -new local task | -
Ctrl+C | -Copy details | -
Ctrl+F | -Find | -
The task list has been carefully designed to support quickly reviewing tasks. Task reviewing is best done by configuring a query to show the tasks that you want to review. Once the tasks are displayed in the Task List they can be reviewed one at a time by scrolling through them using the keyboard up/down arrows. The task tooltip should provide enough detail to do a review and will display information relevant to the currently selected task.
-To edit the selected task press the enter key, use Ctrl+Enter to open the task in the background. To quickly jump to the next unread task hold down the Alt-key when pressing up or down. To mark a task as read while navigating use Alt+shift+up/down. When reviewing tasks in this way, it is best to avoid mouse-based and gesture-based scrolling.
-- -
-
- Weekly progress
-
- When in
- Focus on Workweek mode (right-most toolbar button), the Task List will show a progress bar that indicates progress on the tasks scheduled for the current week. Each task that is scheduled for the week but not yet completed adds to the bar. A task completed by you adds to the green progress in the bar. Deferring a task to a future week will also add to the apparent progress because it will remove the task from the current week. Mousing over the bar will indicate details about your progress, such as the number of tasks and hours completed. To avoid the need for manual estimation by default every task is estimated for 1 hour, but if you have longer or shorter running tasks that week you can adjust the estimate in the task editor's
- Planning page to ensure that the progress bar is accurate.
-
Note that when in - Focus on Workweek mode the - Task List will show each of the tasks scheduled for this week. However, overdue tasks and those with incoming changes will also show, making the number of tasks visible not be a reliable indicator of progress on the tasks planned for the week. -
-- -
-
-
-
- Category Progress
-
- You can hover over categories in the task list to display a tooltip that displays a summary of complete and incomplete tasks.
-
- -
-Click the small white arrow in the top left of the task list to access the following settings:
-
-
- Right-clicking in the task list provides access to the following operations
-
- - - - | -- - - - | -- - - - | -
Installation | -- | Configuring Task Repositories | -
Task Repositories | -||
---|---|---|
- - - - | -- | - - - - | -
Task List | -- | Task Editor | -
- -
-Use the Task Repositories view to configure Mylyn to connect to your team's shared task repository (bug or issue tracker):
-- - - - | -- - - - | -- - - - | -
Task List | -- | Task Editor | -
Task Repository Connectors | -||
---|---|---|
- - - - | -- | - - - - | -
Preferences | -- | Updating This Document | -
Mylyn allows you to collaborate on tasks via a shared task repository, also known as bug tracking systems. In order to collaborate, you need to have a - Connector to your particular repository. -
-See - Mylyn Extensions for a list of available connectors. -
-See - Bugzilla Connector Troubleshooting. -
-See - Trac Connector Troubleshooting. -
-See - this page for install instructions and additional screen shots. Note that the Mylyn JIRA connector requires at least JIRA version 3.3.3 and SOAP/RPC services have to be enabled on the server. -
-See also - JIRA Connector Troubleshooting. -
-The generic web repository connector is NOT part of the default Mylyn install. You can install it from the incubator update site. See - Mylyn download page for more details. -
-The web connector allow to retrieve tasks from repositories that don't have rich connectors, but can show list of tasks on the web UI. Out of the box connector provides configuration templates for the following issue tracking systems:
-code.google.com
)java.net, dev2dev, tigris.org
)objectweb.org
)sf.net
), see
- Using Sourceforge with Mylyn
- www.futureware.biz/mantis
)changelogic.araneaframework.org
)otrs.org
)Lists of issues can be extracted from existing web pages using simple parsing configuration. Configuration can be also parametrized to make it easier to customize it for a specific project.
-The parameters used for configuring project properties are typically substituted into the URLs used to access the repository. Substitution and matching rules can be edited under the - Advanced Configuration section on both the - Repository Settings page and the - Edit Query page. -
-See - FAQ for the troubleshooting tips. -
-
- For example, consider the configuration steps for GlassFish project at java.net
:
-
- 1. Create new Generic web-based repository (in the Task Repository view). GlassFish is using IssueZilla and has a preconfigured template that can be selected by server url - - https://glassfish.dev.java.net/issues - . You can also specify all fields manually in the - Advanced Configuration section. For GlassFish the following settings are required: -
-${serverUrl}/show_bug.cgi?id=
${serverUrl}/enter_bug.cgi?issue_type=DEFECT
${serverUrl}/buglist.cgi?component=glassfish&issue_status=NEW&issue_status=STARTED&issue_status=REOPENED&order=Issue+Number
<a href="show_bug.cgi\?id\=(.+?)">.+?<span class="summary">(.+?)</span>
regexp
with 1st matching group on
- Issue ID and 2nd on
- Issue Description. Alternatively, you could use named matching groups: ({Id}.+?), ({Description}.+?), ({Status}.+?), ({Owner}.+?) and ({Type}.+?), then they can appear in query regexp
in an arbitrary order. The second option requires build 2.0.0v20070717 or later.
- ${..}
. Variables serverUrl, userId
and password
are substituted from the values of corresponding fields of the repository preference page. In addition you can specify any arbitrary parameters and their values that will be also substituted into the template fields.
- - - For the web repository that require user to login, use advanced configuration in following way. - This configuration is for GForge, you might need to change it for other repositories: -
-${serverUrl}/account/login.php?return_to=&form_loginname=${userId}&form_pw=${password}&login=Login
- (POST)
- ${serverUrl}/account/login.php
- loginToken
parameter from the form page
- (only needed if server need a login token in the parameters of the Login Request URL and Login Form URL is specified): session_ser=(.+?)
- - 2. Create a new query for the GlassFish task repository created above (either from popup context menu in the Task List view or using a "New..." wizard from File -> New... -> Other... menu). -
-- -
-The XPlanner connector is currently in the Experimental state. It supports XPlanner version .7.
-- Query -
-XPlanner Connector supports creating queries from your XPlanner repository. You can select to create a query for your own in progress tasks (the default), or select projects or iterations or user stories from a list. You can also select ones assigned to you, or all. Currently you can choose to group the results by tasks or user stories. If you group the results by tasks, this will result in a single query with the applicable tasks underneath it. If you choose to group the results by user stories, this will result in multiple queries added to the task list, each one corresponding to a user story, with the applicable tasks underneath it:
-- -
-- Task Editor -
-A rich editor for editing XPlanner tasks is available. It currently doesn't support all of the attributes you can change in XPlanner itself, but allows you to modify the basic ones necessary for XP development -- e.g. summary, description, estimated time. The attributes section of the editor displays an XPlanner-like view of the meaningful attributes, some of which are not editable.
-- -
-- User Story Editor -
-If you open an XPlanner element by id, using the "Open Repository Task by Key/ID" dialog, and that id is a user story id, you will see the read-only user story editor. This editor is just useful for seeing the major details of a user story -- no items in it can be changed, since there is no really good mapping between a user story and a Mylyn task.
-- -
-- Category:Draft Documentation -
- - - - | -- - - - | -- - - - | -
Preferences | -- | Updating This Document | -
Team Support | -||
---|---|---|
- - - - | -- | - - - - | -
Task-Focused Interface | -- | Shortcuts | -
The task-focused interface provides several ways to improve your work flow when working with a source code repository such as CVS or Subversion. CVS support is available out-of-the-box and task-focused interface integration for Subversion is available via the Subclipse or Subversive plugins.
-When working with a source code repository, you can commit or update only the resources that are in the context of a particular task. This helps you work on several tasks concurrently and avoid polluting your workspace with changes that are not relevant to the current task.
-To enable this functionality, locate the "Synchronize" view. If the view is not visible, you can open it by navigating to Window -> Show View -> Other... -> Team -> Synchronize. Next, click the small black arrow next to "Show File System Resources" in the Synchronize view toolbar and select "Change Sets".
-You can now synchronize resources in your workspace as usual (e.g. by right-clicking on a resource in the navigator and selecting "Team" -> "Synchronize with Repository". Your resources will now be grouped by change sets corresponding to tasks. Expanding the task shows individual resources. Changed resources that are not a part of any task context will appear under the root of the Synchronize view. If needed missing resources can be added to the task context Change Set via the Synchronize View by right+clicking the resource and selecting "Add to" and then selecting the corresponding task. Select "no set" to remove a resource from a change set.
-- -
-You can use buttons in the toolbar of the Synchronize view to change modes as follows:
-Right-clicking a Change Set provides access to the following operations:
-When using task-focused change sets as described above, commit messages are automatically be generated based on the task whose resources are being commited. By default, the commit message includes information such as the task ID, description, and URL. To change the template for these commit messages, navigate to Window -> Preferences -> Tasks -> Team.
-When applying patches, the preferred scenario is to have a task context attached to the task along with the patch. Since this is not always feasible, Mylyn provides an action in the popup menu of the - Synchronize view that supports adding changed elements to the task context. -
-- -
- - - - | -- - - - | -- - - - | -
Task-Focused Interface | -- | Shortcuts | -
Updating This Document | -||
---|---|---|
- - - - | -- | - |
Task Repository Connectors | -- | - |
This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit - - http://wiki.eclipse.org/Mylyn/User_Guide -
- - - - | -- - - - | -- |
Task Repository Connectors | -- | - |