diff options
11 files changed, 608 insertions, 106 deletions
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 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Task-List.html" title="Task List"> + <a href="Mylyn Reference.html" title="Task List"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -51,7 +51,7 @@ <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Task-List.html" title="Task List"> + <a href="Mylyn Reference.html" title="Task List"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> 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 @@ <?xml version='1.0' encoding='utf-8' ?> <toc topic="userguide/Mylyn Reference.html" label="Mylyn Reference"> - <topic href="userguide/Mylyn Reference.html" label="Introduction"> - <topic href="userguide/Mylyn Reference.html#Shortcuts" label="Shortcuts"></topic> - </topic> - <topic href="userguide/Installation.html" label="Installation"> - <topic href="userguide/Installation.html#Install_Method_1_-_Eclipse_3.4" label="Install Method 1 - Eclipse 3.4"></topic> - <topic href="userguide/Installation.html#Install_Method_2_-_Eclipse_3.3_and_older" label="Install Method 2 - Eclipse 3.3 and older"></topic> - </topic> - <topic href="userguide/Task-List.html" label="Task List"> - <topic href="userguide/Task-List.html#Task_List_Presentation" label="Task List Presentation"></topic> - <topic href="userguide/Task-List.html#Icon_Legend_and_Color_Coding" label="Icon Legend and Color Coding"></topic> - <topic href="userguide/Task-List.html#Scheduling" label="Scheduling"></topic> - <topic href="userguide/Task-List.html#Synchronization" label="Synchronization"></topic> - <topic href="userguide/Task-List.html#Incoming_Changes" label="Incoming Changes"></topic> - <topic href="userguide/Task-List.html#Keyboard_Shortcuts" label="Keyboard Shortcuts"></topic> - <topic href="userguide/Task-List.html#Reviewing_Tasks" label="Reviewing Tasks"></topic> - <topic href="userguide/Task-List.html#Task_Progress_Indicators" label="Task Progress Indicators"></topic> - <topic href="userguide/Task-List.html#Task_List_Settings_and_Operations" label="Task List Settings and Operations"></topic> - </topic> - <topic href="userguide/Configuring-Task-Repositories.html" label="Configuring Task Repositories"></topic> - <topic href="userguide/Creating-new-Queries.html" label="Creating new Queries"></topic> - <topic href="userguide/Creating-new-Tasks.html" label="Creating new Tasks"> - <topic href="userguide/Creating-new-Tasks.html#Local_Tasks" label="Local Tasks"></topic> - <topic href="userguide/Creating-new-Tasks.html#Repository_Tasks" label="Repository Tasks"></topic> - </topic> + <topic href="userguide/Mylyn Reference.html" label="Task List"> + <topic href="userguide/Mylyn Reference.html#Task_List_Presentation" label="Task List Presentation"></topic> + <topic href="userguide/Mylyn Reference.html#Icon_Legend_and_Color_Coding" label="Icon Legend and Color Coding"></topic> + <topic href="userguide/Mylyn Reference.html#Creating_new_Tasks" label="Creating new Tasks"> + <topic href="userguide/Mylyn Reference.html#Local_Tasks" label="Local Tasks"></topic> + <topic href="userguide/Mylyn Reference.html#Repository_Tasks" label="Repository Tasks"></topic> + </topic> + <topic href="userguide/Mylyn Reference.html#Creating_new_Queries" label="Creating new Queries"></topic> + <topic href="userguide/Mylyn Reference.html#Scheduling" label="Scheduling"></topic> + <topic href="userguide/Mylyn Reference.html#Synchronization" label="Synchronization"></topic> + <topic href="userguide/Mylyn Reference.html#Incoming_Changes" label="Incoming Changes"></topic> + <topic href="userguide/Mylyn Reference.html#Reviewing_Tasks" label="Reviewing Tasks"></topic> + <topic href="userguide/Mylyn Reference.html#Task_Progress_Indicators" label="Task Progress Indicators"></topic> + <topic href="userguide/Mylyn Reference.html#Task_List_Settings_and_Operations" label="Task List Settings and Operations"></topic> + </topic> + <topic href="userguide/Task-Repositories.html" label="Task Repositories"></topic> <topic href="userguide/Task-Editor.html" label="Task Editor"> <topic href="userguide/Task-Editor.html#Repository_Task_Details" label="Repository Task Details"></topic> <topic href="userguide/Task-Editor.html#Context" label="Context"></topic> @@ -44,11 +36,13 @@ <topic href="userguide/Team-Support.html#Automatic_Commit_Messages" label="Automatic Commit Messages"></topic> <topic href="userguide/Team-Support.html#Working_with_Patches" label="Working with Patches"></topic> </topic> + <topic href="userguide/Shortcuts.html" label="Shortcuts"></topic> <topic href="userguide/Preferences.html" label="Preferences"> <topic href="userguide/Preferences.html#Tasks" label="Tasks"></topic> <topic href="userguide/Preferences.html#Context_2" label="Context"></topic> <topic href="userguide/Preferences.html#Resources" label="Resources"></topic> <topic href="userguide/Preferences.html#Team" label="Team"></topic> + <topic href="userguide/Preferences.html#Shortcuts_2" label="Shortcuts"></topic> </topic> <topic href="userguide/Task-Repository-Connectors.html" label="Task Repository Connectors"> <topic href="userguide/Task-Repository-Connectors.html#Bugzilla_Connector" label="Bugzilla Connector"></topic> @@ -57,9 +51,4 @@ <topic href="userguide/Task-Repository-Connectors.html#Generic_Web_Templates_Connector" label="Generic Web Templates Connector"></topic> <topic href="userguide/Task-Repository-Connectors.html#XPlanner_Connector" label="XPlanner Connector"></topic> </topic> - <topic href="userguide/Integration-with-other-tools.html" label="Integration with other tools"> - <topic href="userguide/Integration-with-other-tools.html#Using_Mylyn_with_WTP" label="Using Mylyn with WTP"></topic> - <topic href="userguide/Integration-with-other-tools.html#External_builders" label="External builders"></topic> - </topic> - <topic href="userguide/Updating-This-Document.html" label="Updating This Document"></topic> </toc>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html b/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html index f9a2561a0..8836e9187 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html +++ b/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html @@ -14,7 +14,7 @@ <td style="width: 20%" align="left"></td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> - <a href="Installation.html" title="Installation"> + <a href="Task-Repositories.html" title="Task Repositories"> <img alt="Next" border="0" src="images/images/next.gif"/> </a> </td> @@ -22,59 +22,379 @@ <tr> <td style="width: 20%" align="left" valign="top"></td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Installation</td> + <td style="width: 20%" align="right" valign="top">Task Repositories</td> </tr> </table><hr/> + <h1 id="Task_List">Task List</h1> + <p>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.</p> <p> - <a href="http://wiki.eclipse.org/Mylyn/Category:Mylyn" title="Category:Mylyn">Category:Mylyn</a> + <img border="0" src="images/Feature-Reference-3.0-Task-List-Categorized.png"/> </p> - <h1 id="Introduction">Introduction</h1> - <p>For - <b>tutorials and articles on using Mylyn</b> refer to the - <b> - <a href="http://www.eclipse.org/mylyn/start/">Get Started</a> - </b> page. The role of this document is to document the key Mylyn features and is not intended as a tutorial. + <p>At the top of the Task List, you will find the following buttons and features:</p> + <ul> + <li> + <b>New Task</b> - Create a new local or repository task. + </li> + <li> + <b>Synchronize</b> - Update repository tasks with changes from the server. + </li> + <li> + <b>Task Presentation</b> - Toggle between Scheduled and Categorized presentations. + </li> + <li> + <b>Focus on Workweek</b> - See only tasks scheduled for this week. + </li> + <li> + <b>Find</b> - search for a task by typing in words from the task summary + </li> + <li> + <b>Working set indicator</b> - Indicates the currently active working set. Use the black arrow on the left to change the working set. + </li> + <li> + <b>Current task indicator</b> - Indicates the currently active task. Use the black arrow on the left to re-activate a recently active task. + </li> + </ul> + <h2 id="Task_List_Presentation">Task List Presentation</h2> + <p>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.</p> + <ul> + <li> + <b>Categorized</b> - View tasks grouped by their category + </li> + <li> + <b>Scheduled</b> - View tasks grouped by the " + <i>scheduled</i> date" + </li> + </ul> + <p> + <img border="0" src="images/Feature-Reference-3.0-Task-List-Presentation-Select.png"/> </p> - <p>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 - <a href="http://wiki.eclipse.org/index.php/Mylyn/Extensions">others</a>). + <p>In either presentation, you can toggle the "Focus on Workweek" button. In this mode, only the following tasks will be visible:</p> + <ul> + <li>Tasks scheduled for this week.</li> + <li>Overdue tasks.</li> + <li>Tasks with unread changes from your task repository.</li> + </ul> + <h2 id="Icon_Legend_and_Color_Coding">Icon Legend and Color Coding</h2> + <p>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. </p> + <p> + <img border="0" src="images/Feature-Reference-3.0-UI-Legend.png"/> </p> - <p>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.</p> - <h2 id="Shortcuts">Shortcuts</h2> - <p> <b> Task List view</b> - <ul> - <li><code>Ctrl+C</code>: copy taks/query URL and description</li> - <li><code>Ctrl+F</code>: find</li> - <li><code>Insert</code>: new personal task</li> - <li><code>F5</code>: synchronize selected</li> - <li>When dragging URLs to the Task List: in Mozilla/Firefox just drag, in Internet Explorer <code>Ctrl+drag</code></li> - </ul> - <b> General</b> - <ul> - <li><code>Alt+click</code> or <code>Alt+RightArrow</code>: 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.</li> - <li><code>Ctrl+Shift+Alt+RightArrow</code> Quick Context View</li> - <li><code>Ctrl+F9</code>: activate task dialog</li> - <li><code>Ctrl+Shift+F9</code>: deactivate task</li> - <li><code>Ctrl+F12</code>: open task dialog</li> - <li><code>Ctrl+Shift+F12</code>: open repository task dialog</li> - </ul> - <b> Interest manipulation</b> - <ul> - <li><code>Ctrl+Shift+Up</code>: mark as landmark</li> - <li><code>Ctrl+Shift+Down</code>: mark less interesting</li> - </ul> - <b> Useful Eclipse shortcuts</b> + <h2 id="Creating_new_Tasks">Creating new Tasks</h2> + <p> + <img border="0" src="images/Feature-Reference-3.0-New-Task.png"/> + </p> + <p>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.</p> + <h3 id="Local_Tasks">Local Tasks</h3> + <p>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 + <b>Local Task</b> and "Finish" from the New Task dialog. + </p> + <p>You can then provide the following details about the task.</p> + <ul> + <li>'''Task Description - Your task is called "New Task" by default. Replace this with a brief task description.</li> + <li> + <b>Priority</b> - Set the priority of your task. This will affect the task's icon and order in the task list. + </li> + <li> + <b>Status</b> - Set your task to "complete" or "incomplete". In your task list, completed tasks have a strikethrough font and will appear lower in the list. + </li> + <li> + <b>URL</b> - You can associate a URL with this task. + <ul> + <li>"Retrieve Task Description from URL" button - Set the task description to the title of the associated URL (page)</li> + <li>"Open with Web Browser" button - Open the URL in the integrated web browser</li> + </ul> + </li> + <li> + <b>Scheduled For</b> - Set the date when you will work on this task. Tasks scheduled for today or a date in the past will appear in blue in your task list. Tasks scheduled for future days will appear in black. If your task list is in focused mode, only tasks for the current week will be visible (unless they have unread changes). + </li> + <li> + <b>Due</b> - Set the date when your task must be completed. Overdue tasks and tasks due today will appear in red in your task list. + </li> + <li> + <b>Estimated Hours</b> - Estimate the number of hours it will take to complete this task. + </li> + <li> + <b>Active</b> - Displays the total time that you have worked on this task. Time is only recorded when this task is active and you are actively interacting with the system. + </li> + <li> + <b>Notes</b> - Record your personal notes about this task. + </li> + </ul> + <p> + <img border="0" src="images/Feature-Guide-3.0-Local-Task.png"/> + </p> + <h3 id="Repository_Tasks">Repository Tasks</h3> + <p>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".</p> + <p>A new task editor will appear. If you are using Bugzilla, you can enter the following information:</p> + <p>Required</p> + <ul> + <li> + <b>Description</b> - Enter a brief task description in the text box at the top (this box does not have a label). + </li> + <li> + <b>Component</b> - Specify a "Component" to further categorize this task within the previously selected "Product". + </li> + <li> + <b>Description</b> - Describe the task in detail. + </li> + </ul> + <p>Optional</p> + <ul> + <li>You can specify additional information about your tasks in the "Attributes" section.</li> + <li> + <b>Personal Planning</b> - You can enter information in this section that will be local to your workspace and + <b>not</b> available on your team's task repository. See "Local Tasks" for more information about the personal planning fields. + </li> + <li> + <b>Assigned to</b> - Specify who should work on the task. Type the first several characters of the person's email address, and then press ctrl+space to select the address from a list. A task can be assigned to only one person at a time. + </li> + <li> + <b>Add CC</b> - Add the addresses of people who should be notified of changes to this task. You can add multiple addresses, separated by a comma, e.g. (mik.kersten@tasktop.com, steffen.pingel@tasktop.com). + </li> + </ul> + <p>When finished, click "Submit" to add your new task to your team's shared task repository.</p> + <h2 id="Creating_new_Queries">Creating new Queries</h2> + <p> + <img border="0" src="images/Feature-Reference-3.0-New-Query-Combined.png"/> + </p> + <p>Once you have configured your team's task repository, you can use Queries to add tasks to your task list.</p> + <ul> + <li>If the Task List is not visible, navigate to + <i>Window -> Show View -> Other -> Mylyn -> Task List</i> + </li> + <li>Right-click on the Task List and select "New -> Query..."</li> + <li>Select the repository whose tasks you would like to download and click "Next".</li> + <li>If you are prompted to select a query type, select "Create query using form" and click "Next".</li> + <li>Complete the form to define which tasks will be downloaded as part of this query, and then click "Finish". You can provide values for only as many parameters as necessary to filter the query results.</li> + </ul> + <p>If you are using the Bugzilla connector, you can specify the following parameters by default. The parameters for most other connectors will be similar.</p> + <ul> + <li> + <b>Query Title</b> - Label that appears in your task list. + </li> + <li> + <b>Summary</b> - Specify words that must appear in the summary of tasks matched by this query. + </li> + <li> + <b>Comment</b> - Words that must appear in the comments of matching tasks. + </li> + <li> + <b>Email</b> - Specify all or part of an email address. This address is used together with the following options: + <ul> + <li> + <b>Owner</b> - The specified email must match the person who the task is assigned to + </li> + <li> + <b>Reporter</b> - The specified email must match the person who created the task + </li> + <li> + <b>CC</b> - The person with the specified email address must be CC'd on the task + </li> + <li> + <b>Commenter</b> - The person with the specified email address must have commented on the task + </li> + <li>You can choose from the following options to specify how the email address will be matched: <ul> - <li><code>Alt+Shift+Q, K</code>: show - <i>Task List</i> view</li> - <li><code>Ctrl+F10</code>: invoke view menu or ruler menu in editor</li> + <li> + <b>substring</b> - Only a part of the specified address must match + </li> + <li> + <b>exact</b> - The specified email address must match exactly + </li> + <li> + <b>regexp</b> - The email address must match the specified regular expression + </li> + <li> + <b>notregexp</b> - The email address must NOT match the specified regular expression + </li> </ul> - </p><hr/> + </li> + </ul> + </li> + <li> + <b>Email 2</b> - You can use this parameter to specify another email address to further restrict the results + </li> + <li> + <b>Keywords</b> - Click the "Select..." button to specify a keyword that must be associated with matching tasks + </li> + <li> + <b>Product, Component, Version, ...</b> - Optionally select parameters to restrict the results to a particular product, version, etc. + </li> + <li> + <b>Update Attributes from Repository</b> - Click this to refresh the available parameters if the project structure on the task respository has changed recently. + </li> + <li> + <b>Changed in:</b> - Only tasks modified within the specified number of days will appear in the query results + </li> + </ul> + <h2 id="Scheduling">Scheduling</h2> + <p>Two kinds of dates for scheduling are provided.</p> + <p> + <b>Scheduled Date</b> + </p> + <ul> + <li>A soft date used for personal scheduling that can be easily deferred as priorities change. The scheduled date is the date you plan to start working on the task.</li> + <li>When a task reaches its scheduled date it will turn blue, indicating that the task should be activated and worked on today.</li> + <li>Scheduled dates are private to your local workspace</li> + </ul> + <p> + <b>Due Date</b> + </p> + <ul> + <li>A hard date when the task must be completed. This is often related to external constraints such as deadlines.</li> + <li>If you are using a shared task repository, due dates become an attribute of the shared task and will be visible to other team members.</li> + <li>A task with a due date has a small clock overlay that is blue before the due date and red after.</li> + </ul> + <h2 id="Synchronization">Synchronization</h2> + <p>Repository tasks and queries are synchronized to reflect the latest changes on the server. + Tasks are synchronized the following ways:</p> + <ul> + <li> + <b>Automatic Synchronization.</b> By default, tasks will be synchronized with the repository every 20 minutes. Automatic synchronization can be disabled via the + <i>Synchronize Automatically</i> option in the view menu (e.g. when working with intermittently available connectivity). The synchronization interval can be changed via + <i>Preferences -> Mylyn -> Task List</i>. + </li> + </ul> + <ul> + <li> + <b>On Task Open.</b> Tasks are synchronized automatically in the background when a task editor is opened. + </li> + </ul> + <ul> + <li> + <b>Manually.</b> Individual tasks and queries can be synchronized manually by right-clicking on them in the Task List and selecting "Synchronize", or via the toolbar button. Clicking the toolbar button will synchronize all queries in your task list. + </li> + </ul> + <p> + <br/> + + <b>Disconnected Mode</b> + <br/> + A task repository can be put into Disconnected mode via the right-click menu in the + <i>Task Repositories</i> 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. + </p> + <h2 id="Incoming_Changes">Incoming Changes</h2> + <p>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.</p> + <p>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.</p> + <h2 id="Reviewing_Tasks">Reviewing Tasks</h2> + <p>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. </p> + <p>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.</p> + <p> + <img border="0" src="images/Feature-Reference-3.0-Task-List-Tooltip.png"/> + </p> + <h2 id="Task_Progress_Indicators">Task Progress Indicators</h2> + <p> + <b>Weekly progress</b> + <br/> + When in + <i>Focus on Workweek</i> 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 + <i>Planning</i> page to ensure that the progress bar is accurate. + </p> + <p>Note that when in + <i>Focus on Workweek</i> mode the + <i>Task List</i> 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. + </p> + <p> + <img border="0" src="images/Feature-Reference-3.0-Weekly-Progress.png"/> + </p> + <p> + <br/> + + <b>Category Progress</b> + <br/> + You can hover over categories in the task list to display a tooltip that displays a summary of complete and incomplete tasks. + </p> + <p> + <img border="0" src="images/Feature-Reference-3.0-Category-Progress.png"/> + </p> + <h2 id="Task_List_Settings_and_Operations">Task List Settings and Operations</h2> + <p>Click the small white arrow in the top left of the task list to access the following settings:</p> + <ul> + <li> + <b>Go Up to Root</b> - Return to the normal presentation after previously selecting "Go Into" to see only the tasks in a particular category. + </li> + <li> + <b>Sort</b> - Open a dialog to set the sort order for the task list. This option is only availabe when the task list is not in "Focus on Workweek" mode. + </li> + <li> + <b>Filter priority lower than</b> - Hide tasks with a priority less than the priority you select. This option is only availabe when the task list is not in "Focus on Workweek" mode. + </li> + <li> + <b>Filter completed tasks</b> - Hide local and repository tasks that are in a completed state. + </li> + <li> + <b>Search Repository</b> - Opens a dialog to search for repository tasks. Search results will appear in a separate search results view. + </li> + <li> + <b>Restore Tasks from History</b> - Opens a dialog for restoring lost tasks. + </li> + <li> + <b>Synchronize Changed</b> - Updates the task list with any changes on the task repository. + </li> + <li> + <b>Synchronize Automatically</b> - When checked, the task list will update from the task repository on an interval specified in Window -> Preferences -> Tasks -> Synchronization + </li> + <li> + <b>Show UI Legend</b> - Displays a legend explaining icons and color-coding. + </li> + <li> + <b>Focus on Workweek</b> - Displays only tasks that are scheduled for this week, overdue, or have unread changes. + </li> + <li> + <b>Link with Editor</b> - Automatically selects the task corresponding to the active task editor. + </li> + <li> + <b>Preferences</b> - Access additional Task List preferences. + </li> + </ul> + <p> + <br/> + Right-clicking in the task list provides access to the following operations + </p> + <ul> + <li> + <b>New...</b> - Create new categories, queries, and tasks. + </li> + <li> + <b>Open with Browser</b> - Open the task in a web browser tab rather than the rich editor. + </li> + <li> + <b>Schedule for</b> - Set the soft date when you intend to work on the task. + </li> + <li> + <b>Mark as</b> - Mark a task as read or unread as you would an email message. + </li> + <li> + <b>Copy Details</b> - Places the task summary and html link in the clipboard so you can paste it into an email, document, etc. + </li> + <li> + <b>Delete</b> - Deletes local tasks. For repository tasks, the all downloaded data and local task information will be cleared but the task will re-appear if it still matches a query. + </li> + <li> + <b>Rename</b> - Rename a task. + </li> + <li> + <b>Go into</b> (queries only) - Show only the tasks in the selected category. + </li> + <li> + <b>Import and Export</b> - Access functionality for importing and exporting task data. + </li> + <li> + <b>Repository</b> (queries only) - Update repository settings + </li> + <li> + <b>Synchronize</b> - Update the selected tasks or queries from the shared task repository + </li> + <li> + <b>Properties</b> - Edit the settings for a repository query + </li> + </ul><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"></td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> - <a href="Installation.html" title="Installation"> + <a href="Task-Repositories.html" title="Task Repositories"> <img alt="Next" border="0" src="images/images/next.gif"/> </a> </td> @@ -82,7 +402,7 @@ <tr> <td style="width: 20%" align="left" valign="top"></td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Installation</td> + <td style="width: 20%" align="right" valign="top">Task Repositories</td> </tr> </table> </body> diff --git a/org.eclipse.mylyn.help.ui/userguide/Preferences.html b/org.eclipse.mylyn.help.ui/userguide/Preferences.html index 21f488a84..f71953d51 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Preferences.html +++ b/org.eclipse.mylyn.help.ui/userguide/Preferences.html @@ -12,7 +12,7 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Team-Support.html" title="Team Support"> + <a href="Shortcuts.html" title="Shortcuts"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -24,7 +24,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 20%" align="left" valign="top">Shortcuts</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task Repository Connectors</td> </tr> @@ -84,11 +84,41 @@ <li> <b>Commit Message Template</b> - Set the values that will appear in commit messages that are automatically generated when committing resources associated with a task. </li> - </ul><hr/> + </ul> + <h2 id="Shortcuts_2">Shortcuts</h2> + <p> <b> Task List view</b> + <ul> + <li><code>Ctrl+C</code>: copy taks/query URL and description</li> + <li><code>Ctrl+F</code>: find</li> + <li><code>Insert</code>: new personal task</li> + <li><code>F5</code>: synchronize selected</li> + <li>When dragging URLs to the Task List: in Mozilla/Firefox just drag, in Internet Explorer <code>Ctrl+drag</code></li> + </ul> + <b> General</b> + <ul> + <li><code>Alt+click</code> or <code>Alt+RightArrow</code>: 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.</li> + <li><code>Ctrl+Shift+Alt+RightArrow</code> Quick Context View</li> + <li><code>Ctrl+F9</code>: activate task dialog</li> + <li><code>Ctrl+Shift+F9</code>: deactivate task</li> + <li><code>Ctrl+F12</code>: open task dialog</li> + <li><code>Ctrl+Shift+F12</code>: open repository task dialog</li> + </ul> + <b> Interest manipulation</b> + <ul> + <li><code>Ctrl+Shift+Up</code>: mark as landmark</li> + <li><code>Ctrl+Shift+Down</code>: mark less interesting</li> + </ul> + <b> Useful Eclipse shortcuts</b> + <ul> + <li><code>Alt+Shift+Q, K</code>: show + <i>Task List</i> view</li> + <li><code>Ctrl+F10</code>: invoke view menu or ruler menu in editor</li> + </ul> + </p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Team-Support.html" title="Team Support"> + <a href="Shortcuts.html" title="Shortcuts"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -104,7 +134,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 20%" align="left" valign="top">Shortcuts</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task Repository Connectors</td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html b/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html new file mode 100644 index 000000000..ef3a6abc7 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html @@ -0,0 +1,95 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Mylyn Reference - Shortcuts</title> + <link type="text/css" rel="stylesheet" href="book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Shortcuts</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Previous" border="0" src="images/images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Preferences.html" title="Preferences"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Preferences</td> + </tr> + </table><hr/> + <h1 id="Shortcuts">Shortcuts</h1> + <p><b> Task List view</b> +<ul> +<li> F2: rename</li> +<li> F4: show tooltip</li> +<li> F5: synchronize</li> +<li> Alt + Down: go to next unread</li> +<li> Alt + Up: go to previous unread</li> +<li> Alt + Shift + R: mark as read</li> +<li> Alt + Shift + U: mark as unread</li> +<li> Esc: hide tooltip</li> +<li> Enter: open task</li> +<li> Insert: new local task</li> +<li> Ctrl+C: Copy details</li> +<li> Ctrl+F: Find</li> +<li> When dragging URLs to the Task List: in Mozilla/Firefox just drag, in Internet Explorer <code>Ctrl+drag</code></li> +</ul> + <b> General</b> + <ul> + <li><code>Alt+click</code> or <code>Alt+RightArrow</code>: 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.</li> + <li><code>Ctrl+Shift+Alt+RightArrow</code> Quick Context View</li> + <li><code>Ctrl+F9</code>: activate task dialog</li> + <li><code>Ctrl+Shift+F9</code>: deactivate task</li> + <li><code>Ctrl+F12</code>: open task dialog</li> + <li><code>Ctrl+Shift+F12</code>: open repository task dialog</li> + </ul> + <b> Interest manipulation</b> + <ul> + <li><code>Ctrl+Shift+Up</code>: mark as landmark</li> + <li><code>Ctrl+Shift+Down</code>: mark less interesting</li> + </ul> + <b> Useful Eclipse shortcuts</b> + <ul> + <li><code>Alt+Shift+Q, K</code>: show + <i>Task List</i> view</li> + <li><code>Ctrl+F10</code>: invoke view menu or ruler menu in editor</li> + </ul> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Previous" border="0" src="images/images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Mylyn Reference.html" title="Mylyn Reference"> + <img alt="Mylyn Reference" border="0" src="images/images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Preferences.html" title="Preferences"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Preferences</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html b/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html index e01d7882a..294c56537 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html @@ -12,7 +12,7 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Creating-new-Tasks.html" title="Creating new Tasks"> + <a href="Task-Repositories.html" title="Task Repositories"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -24,7 +24,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Creating new Tasks</td> + <td style="width: 20%" align="left" valign="top">Task Repositories</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task-Focused Interface</td> </tr> @@ -192,7 +192,7 @@ <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Creating-new-Tasks.html" title="Creating new Tasks"> + <a href="Task-Repositories.html" title="Task Repositories"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -208,7 +208,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Creating new Tasks</td> + <td style="width: 20%" align="left" valign="top">Task Repositories</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task-Focused Interface</td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-List.html b/org.eclipse.mylyn.help.ui/userguide/Task-List.html index 54a939265..3165cbcf8 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-List.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-List.html @@ -12,7 +12,7 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Installation.html" title="Installation"> + <a href="Mylyn Reference.html" title="Introduction"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -24,7 +24,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Installation</td> + <td style="width: 20%" align="left" valign="top">Introduction</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Configuring Task Repositories</td> </tr> @@ -300,7 +300,7 @@ <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Installation.html" title="Installation"> + <a href="Mylyn Reference.html" title="Introduction"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -316,7 +316,7 @@ </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Installation</td> + <td style="width: 20%" align="left" valign="top">Introduction</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Configuring Task Repositories</td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html b/org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html new file mode 100644 index 000000000..71cb2a98e --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html @@ -0,0 +1,76 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + <title>Mylyn Reference - Task Repositories</title> + <link type="text/css" rel="stylesheet" href="book.css"/> + </head> + <body> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <th style="width: 100%" align="center" colspan="3">Task Repositories</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Mylyn Reference.html" title="Task List"> + <img alt="Previous" border="0" src="images/images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Task-Editor.html" title="Task Editor"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task List</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Task Editor</td> + </tr> + </table><hr/> + <h1 id="Task_Repositories">Task Repositories</h1> + <p> + <img border="0" src="images/Feature-Reference-3.0-Add-Task-Repository.png"/> + </p> + <p>Use the Task Repositories view to configure Mylyn to connect to your team's shared task repository (bug or issue tracker):</p> + <ul> + <li>Open the task repositories view by navigating to + <i>Window -> Show View -> Other -> Mylyn -> Task Repositories</i> + </li> + <li>Click the "Add Task Repository" button located in the view's toolbar.</li> + <li>Select the type of repository you wish to connect to and click "Next". If you don't see your repository type, you will need to install the appropriate connector.</li> + <li>Enter the repository's address and your login credentials. After filling in these details, press the + <i>Validate</i> button to ensure the repository exists and your login credentials are valid. Once the settings validate, Click Finish. Note that the settings will vary somewhat depending on the type of repository that you are connecting to. The screenshot shows the settings fore connecting to a Bugzilla repository. + </li> + <li>You should now see the new repository in the + <i>Task Repositories</i> view. + </li> + <li>Now that you have created a repository, you may add queries to the Task List.</li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Mylyn Reference.html" title="Task List"> + <img alt="Previous" border="0" src="images/images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="Mylyn Reference.html" title="Mylyn Reference"> + <img alt="Mylyn Reference" border="0" src="images/images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Task-Editor.html" title="Task Editor"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task List</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Task Editor</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file 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 5f6744377..5af00ef69 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html @@ -17,16 +17,12 @@ </a> </td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right"> - <a href="Integration-with-other-tools.html" title="Integration with other tools"> - <img alt="Next" border="0" src="images/images/next.gif"/> - </a> - </td> + <td style="width: 20%" align="right"></td> </tr> <tr> <td style="width: 20%" align="left" valign="top">Preferences</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Integration with other tools</td> + <td style="width: 20%" align="right" valign="top"></td> </tr> </table><hr/> <h1 id="Task_Repository_Connectors">Task Repository Connectors</h1> @@ -184,16 +180,12 @@ <img alt="Mylyn Reference" border="0" src="images/images/home.gif"/> </a> </td> - <td style="width: 20%" align="right"> - <a href="Integration-with-other-tools.html" title="Integration with other tools"> - <img alt="Next" border="0" src="images/images/next.gif"/> - </a> - </td> + <td style="width: 20%" align="right"></td> </tr> <tr> <td style="width: 20%" align="left" valign="top">Preferences</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Integration with other tools</td> + <td style="width: 20%" align="right" valign="top"></td> </tr> </table> </body> diff --git a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html b/org.eclipse.mylyn.help.ui/userguide/Team-Support.html index 096692895..60e34832c 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html +++ b/org.eclipse.mylyn.help.ui/userguide/Team-Support.html @@ -18,7 +18,7 @@ </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> - <a href="Preferences.html" title="Preferences"> + <a href="Shortcuts.html" title="Shortcuts"> <img alt="Next" border="0" src="images/images/next.gif"/> </a> </td> @@ -26,7 +26,7 @@ <tr> <td style="width: 20%" align="left" valign="top">Task-Focused Interface</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Preferences</td> + <td style="width: 20%" align="right" valign="top">Shortcuts</td> </tr> </table><hr/> <h1 id="Team_Support">Team Support</h1> @@ -91,7 +91,7 @@ </a> </td> <td style="width: 20%" align="right"> - <a href="Preferences.html" title="Preferences"> + <a href="Shortcuts.html" title="Shortcuts"> <img alt="Next" border="0" src="images/images/next.gif"/> </a> </td> @@ -99,7 +99,7 @@ <tr> <td style="width: 20%" align="left" valign="top">Task-Focused Interface</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Preferences</td> + <td style="width: 20%" align="right" valign="top">Shortcuts</td> </tr> </table> </body> 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 e517596b7..dc34237a5 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html +++ b/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html @@ -12,7 +12,7 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -20,7 +20,7 @@ <td style="width: 20%" align="right"></td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Integration with other tools</td> + <td style="width: 20%" align="left" valign="top">Task Repository Connectors</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top"></td> </tr> @@ -33,7 +33,7 @@ <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> <img alt="Previous" border="0" src="images/images/prev.gif"/> </a> </td> @@ -45,7 +45,7 @@ <td style="width: 20%" align="right"></td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Integration with other tools</td> + <td style="width: 20%" align="left" valign="top">Task Repository Connectors</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top"></td> </tr> |