From d1f361d6c26218b768d3d3eec9c380d54fcb2957 Mon Sep 17 00:00:00 2001 From: dgreen Date: Wed, 7 Jan 2009 06:16:00 +0000 Subject: NEW - bug 260191: Id generation strategy should be language-dependent https://bugs.eclipse.org/bugs/show_bug.cgi?id=260191 Fix generated ids in the documentation so that internal links work --- .../userguide/Configuration.html | 14 ++-- .../userguide/Installation.html | 16 ++-- .../userguide/Integration-with-other-tools.html | 6 +- .../userguide/Mylyn User Guide-toc.xml | 98 +++++++++++----------- .../userguide/Mylyn User Guide.html | 4 +- .../userguide/Task-Focused-UI.html | 10 +-- org.eclipse.mylyn.help.ui/userguide/Task-List.html | 32 +++---- .../userguide/Task-Repositories.html | 6 +- .../userguide/Task-Repository-Connectors.html | 24 +++--- .../userguide/Team-Support.html | 10 +-- .../userguide/Updating-This-Document.html | 2 +- 11 files changed, 111 insertions(+), 111 deletions(-) (limited to 'org.eclipse.mylyn.help.ui') diff --git a/org.eclipse.mylyn.help.ui/userguide/Configuration.html b/org.eclipse.mylyn.help.ui/userguide/Configuration.html index 2c39fb06c..b4fdda330 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Configuration.html +++ b/org.eclipse.mylyn.help.ui/userguide/Configuration.html @@ -31,7 +31,7 @@
After you have installed Mylyn, there are a number of things that you can configure to make your experience even richer.
-Recommendations for workspace configuration when using Mylyn:
While there are many ways to set up queries (e.g. by component, by milestone) we recommend the following as a starting point. For each repository, create:
Depending on how you set up (1) and (2), you may want to limit (3) to certain components in order to avoid tasks showing up in multiple containers.
-The Mylyn task list does not span workspaces, if multiple workspaces are in use this results in a unique task list per workspace. Multiple task lists is considered a performance antipattern and we recommended making use of the native Eclipse mechanism for managing large volumes of projects - working sets. Instead of creating multiple workspaces, simply create working sets that aggregate the projects all within a single workspace. Activate the working set and only those projects are visible within Eclipse. This has the added benefit of making Eclipse feel faster (i.e searching is improved) due to the scoping effect of the working set. Mylyn has added functionality to make switching working sets easier from the Task List view.
@@ -111,7 +111,7 @@When using working sets, the second drop down arrow in the Task List toolbar area (Task Activation History) will reveal task activation history for the currently selected working set. Choosing a different working set will then only reveal tasks previously activated while the that working set was active. To see the aggregate of all previously active tasks in the task activation history drop down you need to select "Show All" from the work set selection drop down.
-This section is evolving, please consider adding your own UI settings.
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).
-
If default key mappings aren't working, try doing the following to reset them:
Also, see keyboard shortcuts.
-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
.
Updating This Document |
See the Mylyn Extensions @@ -52,11 +52,11 @@ 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.
diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml
index 0c919e67f..e12d3d0e1 100644
--- a/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml
+++ b/org.eclipse.mylyn.help.ui/userguide/Mylyn User Guide-toc.xml
@@ -3,84 +3,84 @@
Ctrl+F10
: invoke view menu or ruler menu in editor
Open the live UI Legend via Task List -> view menu -> Show UI Legend @@ -88,7 +88,7 @@
-
Getting Started
When a view is in Focused mode, you can Alt+Click a node in order to temporarily show all of it's children.
For navigator views ( Package Explorer, Project Explorer and @@ -50,7 +50,7 @@
-
When Focus is applied to a navigator view the working sets filter for that navigator view will be disabled, ensuring that you see elements when working on elements that span working sets. In order to force only elements within one working set to show do the following:
The leftmost toolbar button visible in the image below will toggle focus on the Packages, Types and diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-List.html b/org.eclipse.mylyn.help.ui/userguide/Task-List.html index 1b0127947..7f0887ba3 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-List.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-List.html @@ -29,13 +29,13 @@
Please see the Tips & Tricks page.
Open the UI Legend via the Task List view menu button located next to minimize button in top right corner of Task List view)
-There are several ways to create new tasks:
A blue arrow indicates that a task has changed in the repository. To quickly review the differences since the task was last read hover over the task or press F4 to display a tooltip.
To filter the task list to incoming changes and tasks scheduled for this week use the Focus on Workweek button in the toolbar. Another way to quickly find tasks with incoming changes is to use Alt+down in the Task List which jumps to the next task with an incoming change.
In addition the UI Experiments feature that is part of the Mylyn incubator contributes a task list presentation that only shows tasks with incoming changes.
@@ -77,7 +77,7 @@When in Focus on Workweek mode (right-most toolbar button), the Task List will show a JUnit-style progress bar which indicates progress on the tasks scheduled for that 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. @@ -89,17 +89,17 @@
-
Categories show progress for the number of completed tasks.
-
All comments added since your last reading of a repository task will be automatically expanded when a task with incoming changes is opened. Incoming changes are retrieved with the background synchronization to avoid waiting for the server when opening. Note that a background synchronization is still kicked off upon opening in case changes came in since the last scheduled synchronization. Repository tasks can be explicitly marked as read or unread.
-
Task repositories are easy to add, and can be named via the Task Repositories view. An icon decoration indicates the repository type. A task repository can be associated with a project, enabling it to be used for actions such as resolving bug hyperlinks. Note: you do not need to associate all of your projects with repositories after updating, since you will be prompted to do this when the associate is needed. @@ -111,7 +111,7 @@
See Task-focused programming with Mylyn, Part 1, Querying a repository.
-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
@@ -120,7 +120,7 @@
-
For tasks not available on
Task List view, there is a
Open Repository Task dialog (Ctrl+Shift+F12
). On this case, the task can be opened by informing its ID and repository. This way the task will be retrieved from repository without being added to task list.
@@ -129,14 +129,14 @@
Add to Task List category option and informing the category where it will be inserted.
Multiple tasks can be added simultaneously by informing a sequence of IDs, separated by commas, e.g. "1,2,3".
-Repository task attachments (supported by the Bugzilla and Trac connectors) can be attached via drag-and-drop from both within the Eclipse workspace and from outside, and from text selections, which will invoke the attachment wizard. Attachments can be opened with a browser or corresponding editor.
In the task editor, comments that include text of the form bug#123 or task#123 or bug 123 will be hyperlinked. In order 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. To do this, right click on the project > Properties > Task Repository and select the task repository used when working with this project. Then in the editors such as the java source editor or the default text editor, enter a reference such as bug#123. Ctrl+clicking on this text will open the bug in the rich editor.
-Where does Mylyn keep the task list?
@@ -177,14 +177,14 @@ Task List preference page, the new location will be used when Eclipse restarts (hit Restore Defaults on that page to copy tasks back to the default location). If your tasks disappear due to to a bug you can check the.mylyn
folder for a tasklist-backup.xml
file, which will contain the previously-saved list.
- 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.
-
The Search for Duplicates button on the New Repository Task editor encourages and facilitates finding similar bug reports before creating a new one. Potential duplicates are displayed in the Search view which can be used to open a bug and comment or vote if a duplicate is found. The current duplicate detection mechanism uses stack traces, either automatically inserted by the @@ -194,7 +194,7 @@
-
When submitting comments, contexts can be attached by selecting the corresponding check-box in the Actions section.
@@ -252,7 +252,7 @@The task list has been carefully designed to support 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 the task list avoid mouse-based and gesture-based scrolling if possible as the result will be sub-optimal.
The recommended way to access repository tasks is with Queries. For example, you can add a query for every task assigned to you and every task that you are CC'd on. However, sometimes you may know a particular task key or ID, and want to access it without creating or modifying a query.
@@ -79,7 +79,7 @@A task repository can be put into Disconnected mode via the popup menu in the Task Repositories view. This can be useful if the task repository is not being used any more (e.g. no longer engaged with the project), or is no longer available (e.g. no longer available online). Mylyn's 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.
-If properties of a repository change that are not picked up by automatic synchronization, e.g. the user get assigned additional privileges in the repository, it can be desirable to do a manual synchronization. Since Mylyn 2.2 the popup menu in the Task Repositories view has an entry Synchronize All Tasks to refresh cached information for all tasks in the task list for that repository. diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html b/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html index 0ef67deb0..3712ce28a 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html @@ -29,20 +29,20 @@
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.
Presently - Bugzilla, - JIRA, and - Trac are supported. To connect to unsupported repositories, see - Generic Web Repository Connectors. + Bugzilla, + JIRA, and + Trac are supported. To connect to unsupported repositories, see + Generic Web Repository Connectors. Also, be sure to vote for your favourite Connector to see it supported earlier, or create a new bug if your issue tracker is not listed.
-Once Mylyn is installed there are a few steps involved to get up and running.
See also Bugzilla Connector Troubleshooting.
-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.
The Trac connector offers two access methods:
-
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.
@@ -184,7 +184,7 @@See also JIRA Connector Troubleshooting.
-The generic web repository connector is NOT part of the default Mylyn install. You can install it from a separate extras update site. See Mylyn download page for more details.
@@ -282,7 +282,7 @@-
The XPlanner connector is currently in the Experimental state. It supports XPlanner version .7.
Query diff --git a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html b/org.eclipse.mylyn.help.ui/userguide/Team-Support.html index 5d53c5013..71bd556da 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html +++ b/org.eclipse.mylyn.help.ui/userguide/Team-Support.html @@ -29,8 +29,8 @@
There are two modes for Eclipse's Change Sets support: the models mode (Eclipse 3.2 and later) and the standard mode. These modes are unrelated to Mylyn and apply to both Mylyn's automated Change Sets and the ones you can created manually in Eclipse. Note that not all tools may support both modes. The instructions below are for the CVS support included with Mylyn. Refer to the Mylyn integration documentation for your source control plug-in for additional instructions for Mylyn change set integration, if available. @@ -74,7 +74,7 @@
-
Operations such as
committing,
updating, and
@@ -86,14 +86,14 @@
Synchronize View by right+clicking
the resource and selecting
Add to and then selecting the corresponding task.
Mylyn will automatically generate commit messages for you when you use its Change Set support. To modify the template go to Window -> Preferences -> Mylyn -> Team -> Commit Comment Templates.
-
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.
diff --git a/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html b/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html index af58b6498..74334b738 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html +++ b/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html @@ -25,7 +25,7 @@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 -- cgit v1.2.3