diff options
Diffstat (limited to 'org.eclipse.mylyn.help.ui/Mylyn/User_Guide')
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html | 44 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html | 65 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html | 3 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html | 19 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html | 2 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html | 4 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html | 75 | ||||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Show_filtered_children.png | bin | 0 -> 12144 bytes | |||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-content-assist.png | bin | 0 -> 17305 bytes | |||
| -rw-r--r-- | org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-reporter.png | bin | 0 -> 13734 bytes |
10 files changed, 139 insertions, 73 deletions
diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html index 823761408..cf0db199b 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html @@ -76,6 +76,18 @@ </ul> <h2 id="Resources">Resources</h2> <p>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.</p> + <h2 id="Breakpoints">Breakpoints</h2> + <p>Use this preference page to enable breakpoints in context.</p> + <ul> + <li> + <b>Include breakpoints in task context (Experimental)</b> - When this option is checked, each task will have its own set of breakpoints which will be shared when you attach context to the task. Breakpoints created while a task is active will be removed from the workspace on task deactivation and restored the next time the task is activated. This feature has the following limitations (tracked on + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=428378" target="mylyn_external">bug 428378</a>): + <ul> + <li>Breakpoints in closed projects are deleted from the context on task activation and cannot be recovered. </li> + <li>Breakpoints stored in context will not have their locations updated as the code changes, so they may be restored at the wrong location.</li> + </ul> + </li> + </ul> <h2 id="Team">Team</h2> <ul> <li> @@ -84,37 +96,7 @@ <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> - <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/> + </ul><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html index cdacb379a..796eacf1f 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html @@ -32,51 +32,52 @@ <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 + C: mark complete (local tasks only)</li> -<li> Alt + Shift + I: mark incomplete (local tasks only)</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> Shift + Insert: new sub task</li> -<li> Alt + N (Mac only): new local task</li> -<li> Alt + Shift + N (Mac only): new sub 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> +<li>F2: rename</li> +<li>F4: show tooltip</li> +<li>F5: synchronize selected</li> +<li>Alt + Down: go to next unread</li> +<li>Alt + Up: go to previous unread</li> +<li>Alt + Shift + C: mark complete (local tasks only)</li> +<li>Alt + Shift + I: mark incomplete (local tasks only)</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>Shift + Insert: new sub task</li> +<li>Alt + N (Mac only): new local task</li> +<li>Alt + Shift + N (Mac only): new sub 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></p> <p><b> Task Editor</b></p> <p><ul> -<li> Alt + Shift + C: mark complete (local tasks only)</li> -<li> Alt + Shift + I: mark incomplete (local tasks only)</li> -<li> Alt + Shift + R: mark as read</li> -<li> Alt + Shift + U: mark as unread</li> +<li>Ctrl+F: Find text in comments, description, summary and private notes</li> +<li>Alt + Shift + C: mark complete (local tasks only)</li> +<li>Alt + Shift + I: mark incomplete (local tasks only)</li> +<li>Alt + Shift + R: mark as read</li> +<li>Alt + Shift + U: mark as unread</li> </ul></p> <p><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> +<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></p> <p><b> Interest manipulation</b> <ul> -<li><code> Ctrl+Shift+Alt+Up</code>: mark as landmark</li> -<li><code> Ctrl+Shift+Alt+Down</code>: mark less interesting</li> +<li><code>Ctrl+Shift+Alt+Up</code>: mark as landmark</li> +<li><code>Ctrl+Shift+Alt+Down</code>: mark less interesting</li> </ul></p> <p><b> Useful Eclipse shortcuts</b> <ul> -<li><code> Alt+Shift+Q, K</code>: show +<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><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"> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html index 4045f842b..523edf745 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html @@ -53,6 +53,9 @@ <b>Open with Web Browser</b> - Displays the web interface for the task in an internal web browser. </li> <li> + <b>Find</b> - Find text in comments, description, summary and private notes. + </li> + <li> <b>Activate</b> - Toggles the activation and deactivation of the task. </li> </ul> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html index 4b32c09f8..be4d2bd72 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html @@ -36,15 +36,26 @@ <p> <img border="0" src="images/Feature-Guide-3.0-Package-Explorer-Focused.png"/> </p> - <h2 id="Alt.2BClick_Navigation">Alt+Click Navigation</h2> - <p>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).</p> - <p>When a view is in Focused mode, you can Alt+Click a node to temporarily show all of its children. </p> + <h2 id="Alt.2BClick_Navigation_.2F_Show_Filtered_Children">Alt+Click Navigation / Show Filtered Children</h2> + <p>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) or click the + <a href="+">+</a> icon that appears to the right of a tree node when the mouse hovers over it. + </p> + <p>When a view is in Focused mode, you can click the + <a href="+">+</a> icon to the right of a node, or Alt+Click the node, to temporarily show all of its children. + </p> <ul> - <li>Once an element that was previously not interesting is selected with the mouse, it becomes interesting the other child elements will disappear. The clicked element is now a part of the task's context.</li> + <li>Once an element that was previously not interesting is selected with the mouse, it becomes interesting and the other child elements will disappear. The clicked element is now a part of the task's context.</li> + <li>You can drill down multiple levels of filtered nodes by clicking the + <a href="+">+</a> icon to the right of each node you want to unfilter. Note that trying to expand the node in other ways (e.g. clicking the triangle to the left of the node) will not show its filtered children - clicking anywhere in the view (other than a + <a href="+">+</a> icon) will hide all filtered children again. + </li> <li>Alt can be held down while clicking to drill down from a top-level element to a deeply nested element that is to be added to the task context.</li> <li>Multiple Alt+Clicks are supported so that you can add several elements to the task context. As soon as a normal click is made, uninteresting elements will disappear.</li> <li>Ctrl+Clicks (i.e. disjoint selections, use Command key on Mac) are also supported and will cause each element clicked to become interesting. The first normal click will cause uninteresting elements to disappear. Note that Ctrl+clicked elements will become interesting (turn from gray to black) but only the most recently-clicked one will be selected while Alt is held down.</li> </ul> + <p> + <img border="0" src="images/Show_filtered_children.png"/> + </p> <h2 id="Focusing_Editors">Focusing Editors</h2> <p>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.</p> <p> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html index 9a0ac2766..e2a4cd5aa 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html @@ -113,7 +113,7 @@ </dl> <p> <b>For the web repository that require user to login, use advanced configuration in following way.</b> -<i> This configuration is for GForge, you might need to change it for other repositories</i>: +<i>This configuration is for GForge, you might need to change it for other repositories</i>: </p> <ul> <li>Login Request URL - an address that form is using to submit login request: <code>${serverUrl}/account/login.php?return_to=&form_loginname=${userId}&form_pw=${password}&login=Login diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html index 4913dfe4f..a2fbcfa32 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html @@ -33,7 +33,7 @@ <p>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.</p> <h2 id="Task-focused_Change_Sets">Task-focused Change Sets</h2> <p>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.</p> - <p>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".</p> + <p>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". Note that change sets are not currently supported in the EGit connector.</p> <p>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.</p> <p> <img border="0" src="images/Feature-Reference-3.0-Change-Sets.png"/> @@ -54,7 +54,7 @@ <ul> <li> <b>Add to Task Context</b> - Adds all changed files to the active task context, see - <a href="Team-Support.html#Working_with_Patches">Working with Patches</a> for more information + <a href="#Working_with_Patches">Working with Patches</a> for more information </li> <li> <b>Open Corresponding Task</b> - Opens the task associated with the Change Set in the Task Editor diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html index df8e43419..f8b171f2e 100644 --- a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html @@ -45,7 +45,8 @@ <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 + <b>Find</b> - search for a task by typing in words from the task summary, or specify specific fields to query. See + <a href="#Finding_Tasks">Finding Tasks</a> for details. </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. @@ -54,6 +55,74 @@ <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="Finding_Tasks">Finding Tasks</h2> + <p>The task list can be filtered by providing a phrase to match against the task summary. The phrase must appear in the summary of a task for the task to be visible when a filter is applied. The task list filter operates by searching on a locally-maintained index of the tasks in your task list. (In rare cases, it may be necessary to manually refresh the search index by selecting "Refresh Search Index" from the task list menu.)</p> + <ul> + <li>Search for task summary or task id by entering the value. For example, <tt>NullPointerException</tt> or <tt>12345</tt>.</li> + <li>Search for other task fields such as description or assignee by prefixing them with the field name. For example <tt>description:NullPointerException</tt> will search in the task description rather than the summary. Content assist can be used to provide a list of common field names, and will provide a list of known user names when searching on user fields. </li> + </ul> + <p> + <img border="0" src="images/Task-list-index-reporter.png"/> + </p> + <ul> + <li>Search for date ranges by qualifying the range. For example, show tasks that were created in the <tt>(past week)</tt>.</li> + </ul> + <p> + <img border="0" src="images/Task-list-index-content-assist.png"/> + </p> + <ul> + <li>Search for an exact phrase by enclosing it in double-quotes. For example, <tt>description:"user experience"</tt>.</li> + <li>Search for partial words by using the "*" wildcard. For example, <tt>exc*tion</tt> matches both "exclamation" and "exception".</li> + </ul> + <h3 id="Available_Fields">Available Fields</h3> + <p>Available fields can be found by using content assist in the search field. The following fields are available for search with most repositories:</p> + <dl> + <dt>content</dt> + <dd>match against any of summary, description, comments and other long text fields</dd> + <dt>summary</dt> + <dd>the task summary</dd> + <dt>description</dt> + <dd>match against the task description</dd> + <dt>person</dt> + <dd>match against any person field, such as reporter, assignee, watcher, etc.</dd> + <dt>task_key</dt> + <dd>match against the task or bug id</dd> + <dt>attachment</dt> + <dd>match against attachment names</dd> + <dt>assignee</dt> + <dd>match against the assignee of the task</dd> + <dt>reporter</dt> + <dd>match against the reporter of the task</dd> + <dt>product</dt> + <dd>match against the product of the task</dd> + <dt>component</dt> + <dd>match against the component of the task</dd> + <dt>creation_date</dt> + <dd>match against the date when the task was created</dd> + <dt>completion_date</dt> + <dd>match against the date when the task was completed</dd> + <dt>due_date</dt> + <dd>match against the date when the task is due</dd> + <dt>modification_date</dt> + <dd>match against the date when the task was last modified</dd> + <dt>status</dt> + <dd>match against the status</dd> + <dt>resolution</dt> + <dd>match against the resolution</dd> + <dt>severity</dt> + <dd>match against the severity</dd> + </dl> + <p>Some fields listed above may not be available depending on the repository and connector.</p> + <h3 id="Search_Operators">Search Operators</h3> + <p>The Task List provides logical operators. For example, <tt>NPE AND Display</tt>. Note that unlike other search phrases, + <b>search operators are case-sensitive</b>; otherwise, the words are treated as part of the search phrase. + </p> + <dl> + <dt>AND</dt> + <dd>Searches for tasks that contain both words.</dd> + <dt>OR</dt> + <dd>Searches for tasks that contain at least one word.</dd> + </dl> <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> @@ -316,13 +385,13 @@ <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> + <p>Click the small white arrow in the top right of the Task List view 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. + <b>Sort</b> - Open a dialog to set the sort order for the task list. This option is only available 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. diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Show_filtered_children.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Show_filtered_children.png Binary files differnew file mode 100644 index 000000000..f4433f7ec --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Show_filtered_children.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-content-assist.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-content-assist.png Binary files differnew file mode 100644 index 000000000..f04c2bfa0 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-content-assist.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-reporter.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-reporter.png Binary files differnew file mode 100644 index 000000000..0feb8c550 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Task-list-index-reporter.png |
