From 31965c34f38b9b70686dd2c82b63abe1b1738953 Mon Sep 17 00:00:00 2001 From: relves Date: Sat, 14 Mar 2009 23:56:07 +0000 Subject: RESOLVED - bug 246387: restructure the User Guide and FAQ https://bugs.eclipse.org/bugs/show_bug.cgi?id=246387 --- .../userguide/Configuring-Task-Repositories.html | 4 +- .../userguide/Mylyn Reference-toc.xml | 47 +-- .../userguide/Mylyn Reference.html | 404 ++++++++++++++++++--- .../userguide/Preferences.html | 40 +- org.eclipse.mylyn.help.ui/userguide/Shortcuts.html | 95 +++++ .../userguide/Task-Editor.html | 8 +- org.eclipse.mylyn.help.ui/userguide/Task-List.html | 8 +- .../userguide/Task-Repositories.html | 76 ++++ .../userguide/Task-Repository-Connectors.html | 16 +- .../userguide/Team-Support.html | 8 +- .../userguide/Updating-This-Document.html | 8 +- 11 files changed, 608 insertions(+), 106 deletions(-) create mode 100644 org.eclipse.mylyn.help.ui/userguide/Shortcuts.html create mode 100644 org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html (limited to 'org.eclipse.mylyn.help.ui') diff --git a/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html b/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html index af1eb2033..897fc4ea9 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html +++ b/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html @@ -12,7 +12,7 @@
- + | diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml b/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml index bc3025fc0..76b577def 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml +++ b/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml @@ -1,29 +1,21 @@- + | @@ -22,59 +22,379 @@||
- | Installation | +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.
- Category:Mylyn +
-For - tutorials and articles on using Mylyn refer to the - - Get Started - page. The role of this document is to document the key Mylyn features and is not intended as a tutorial. +
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.
++
-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). +
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.
++
-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.
-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 interesting+ +
+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.
+Alt+Shift+Q, K
: show
- Task List viewCtrl+F10
: invoke view menu or ruler menu in editorTwo 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
+
- + | @@ -82,7 +402,7 @@|||
- | Installation | +Task Repositories |