diff options
| author | dgreen | 2009-11-26 17:31:54 +0000 |
|---|---|---|
| committer | dgreen | 2009-11-26 17:31:54 +0000 |
| commit | 17adee84319360dacebbb0a3138e510603ed56fa (patch) | |
| tree | 3c983f5d939b0b446a7447d2fc638ff92f043134 /org.eclipse.mylyn.help.ui | |
| parent | 6b5a16fccc59a78e45d55a61503130878934272d (diff) | |
| download | org.eclipse.mylyn.tasks-17adee84319360dacebbb0a3138e510603ed56fa.tar.gz org.eclipse.mylyn.tasks-17adee84319360dacebbb0a3138e510603ed56fa.tar.xz org.eclipse.mylyn.tasks-17adee84319360dacebbb0a3138e510603ed56fa.zip | |
NEW - bug 296199: Update Mylyn user guide in o.e.m.help.ui
https://bugs.eclipse.org/bugs/show_bug.cgi?id=296199
Diffstat (limited to 'org.eclipse.mylyn.help.ui')
9 files changed, 931 insertions, 20 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 new file mode 100644 index 000000000..af1eb2033 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Configuring-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 - Configuring 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">Configuring Task Repositories</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-List.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="Creating-new-Queries.html" title="Creating new Queries"> + <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">Creating new Queries</td> + </tr> + </table><hr/> + <h1 id="Configuring_Task_Repositories">Configuring 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="Task-List.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="Creating-new-Queries.html" title="Creating new Queries"> + <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">Creating new Queries</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Creating-new-Queries.html b/org.eclipse.mylyn.help.ui/userguide/Creating-new-Queries.html new file mode 100644 index 000000000..ec67866a8 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Creating-new-Queries.html @@ -0,0 +1,131 @@ +<?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 - Creating new Queries</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">Creating new Queries</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Configuring-Task-Repositories.html" title="Configuring Task Repositories"> + <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="Creating-new-Tasks.html" title="Creating new Tasks"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Configuring Task Repositories</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Creating new Tasks</td> + </tr> + </table><hr/> + <h1 id="Creating_new_Queries">Creating new Queries</h1> + <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> + <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> + </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><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Configuring-Task-Repositories.html" title="Configuring Task Repositories"> + <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="Creating-new-Tasks.html" title="Creating new Tasks"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Configuring Task Repositories</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Creating new Tasks</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Creating-new-Tasks.html b/org.eclipse.mylyn.help.ui/userguide/Creating-new-Tasks.html new file mode 100644 index 000000000..ac55b8a3b --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Creating-new-Tasks.html @@ -0,0 +1,131 @@ +<?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 - Creating new Tasks</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">Creating new Tasks</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Creating-new-Queries.html" title="Creating new Queries"> + <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">Creating new Queries</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Task Editor</td> + </tr> + </table><hr/> + <h1 id="Creating_new_Tasks">Creating new Tasks</h1> + <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> + <h2 id="Local_Tasks">Local Tasks</h2> + <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> + <h2 id="Repository_Tasks">Repository Tasks</h2> + <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><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Creating-new-Queries.html" title="Creating new Queries"> + <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">Creating new Queries</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/Installation.html b/org.eclipse.mylyn.help.ui/userguide/Installation.html new file mode 100644 index 000000000..20dd20691 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Installation.html @@ -0,0 +1,140 @@ +<?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 - Installation</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">Installation</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Mylyn Reference.html" title="Introduction"> + <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-List.html" title="Task List"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <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">Task List</td> + </tr> + </table><hr/> + <h1 id="Installation">Installation</h1> + <ul> + <li> + <a href="http://eclipse.org/mylyn/dl.php" target="mylyn_external">Mylyn download page</a> + </li> + <li> + <a href="http://wiki.eclipse.org/Mylyn/FAQ#Installation" title="Mylyn/FAQ#Installation" target="mylyn_external">Installation FAQ</a> + </li> + </ul> + <p>As of writing, Mylyn comes bundled with the main EPP distributions ( + <a href="http://www.eclipse.org/downloads/" target="mylyn_external">jee, java, cpp</a>). If you wish to manually install Mylyn there are to methods depending on the version of Eclipse. Method 1 outlines how to install using the Eclipse 3.4 update manager. Method 2 below describes how to install Mylyn into Eclipse 3.3 and below using the Update Manager. + </p> + <h3 id="Install_Method_1_-_Eclipse_3.4">Install Method 1 - Eclipse 3.4</h3> + <ol> + <li>Select ''Help > Software Updates...</li> + <li>Select + <i>Available Software</i> tab + </li> + <li>Press the + <i>Add Site...</i> button + </li> + <li>Enter the Mylyn update site url: + <ol> + <li><code> + <a href="http://download.eclipse.org/tools/mylyn/update/e3.4" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/e3.4</a></code> + </li> + <li>Additional extension update sites are from + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">the download page</a> + </li> + </ol> + </li> + <li>After pressing + <i>OK</i> the update site will be available in the sites list + </li> + <li>Expand the Mylyn update site node and select all components desired</li> + <li>Press the + <i>Install...</i> button to install Mylyn + </li> + </ol> + <h3 id="Install_Method_2_-_Eclipse_3.3_and_older">Install Method 2 - Eclipse 3.3 and older</h3> + <ol> + <li>Select + <i>Help->Software Updates->Find and Install</i>. + </li> + <li>Select + <i>Search for new features to install</i> and select + <i>Next</i>. + </li> + <li>Select + <i>New Remote Site</i>. + </li> + <li>Enter "Mylyn" for the name and insert the update site url: + <ol> + <li><code> + <a href="http://download.eclipse.org/tools/mylyn/update/e3.3" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/e3.3</a></code> + </li> + <li>Additional extension update sites are from + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">the download page</a> + </li> + </ol> + </li> + <li>Select + <i>OK</i>. + </li> + <li>Make sure there is a check in the + <i>Mylyn</i> box, and select + <i>Finish</i>. + </li> + <li>Put a check in the box next to + <i>Mylyn</i>. If you don't mind downloading some stuff you don't need, go ahead and select + <i>Next</i>. Otherwise, expand the + <i>Mylyn</i> line (by clicking on the disclosure triangle) and select what you want. We recommend downloading the + <i>Task List</i>, the + <i>Focused UI</i>, and connectors appropriate to the bug repository that you use -- Bugzilla, Trac, or Jira. (Note that to download Jira, you need both the core and the connector.) You can download Mylyn without a bug repository, but it won't be as interesting an experience. If you download the Focused UI you will want to also choose the Bridge appropraite to the content you work with. Most developers will want to include all bridges provided. + </li> + <li>Read the license agreements, accept or decline as appropriate, and either select + <i>Next</i> (if you accept) or + <i>Cancel</i> (if you do not accept). + </li> + <li>You will see a list of features and where to install them. If the default installation directory is fine, select + <i>Finish</i>. + </li> + </ol><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Mylyn Reference.html" title="Introduction"> + <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-List.html" title="Task List"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <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">Task List</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Integration-with-other-tools.html b/org.eclipse.mylyn.help.ui/userguide/Integration-with-other-tools.html new file mode 100644 index 000000000..713a9ef0b --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Integration-with-other-tools.html @@ -0,0 +1,93 @@ +<?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 - Integration with other tools</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">Integration with other tools</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> + <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="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <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">Updating This Document</td> + </tr> + </table><hr/> + <h1 id="Integration_with_other_tools">Integration with other tools</h1> + <p>See the + <b> + <a href="http://wiki.eclipse.org/Mylyn/Extensions" title="Mylyn/Extensions" target="mylyn_external">Mylyn Extensions</a> + </b> page for a listing of integration downloads. + </p> + <p>Mylyn relies on + <a href="http://wiki.eclipse.org/Mylyn/Architecture" title="Mylyn/Architecture" target="mylyn_external">Bridges</a> to integrate the context model with the structure and UI features of domain-specific tools. To create a Bridge, see + <a href="http://wiki.eclipse.org/Mylyn/Integrator_Reference#Creating_Bridges" title="Mylyn/Integrator_Reference#Creating_Bridges" target="mylyn_external">Creating Bridges</a>. + </p> + <p>The core set of Bridges supports the Eclipse SDK (i.e. has bridges for Java, JUnit, PDE, Ant and Resources). The Resources Bridge enables a basic level of interoperability with other tools that use files (e.g. <code>.php, .cpp</code>), and enables Mylyn filtering to work for generic views that show those files (i.e. the + <i>Project Explorer</i>, + <i>Navigator</i>) and any corresponding markers (i.e. the + <i>Problems</i> and + <i>Tasks</i> views). This is only the most basic context model integration, and does not offer the benefits of a specialized structure bridge, such as making declarations part of the context and providing + <i>Active Search</i> facilities. Without a Bridge Mylyn cannot be applied to tool-specific views. + </p> + <p> + <b>If you would like to see support for a particular tool</b>, first do a search of the open bridge requests and + <a href="https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=anywordssubstr&short_desc=%5Bbridge%5D&product=Mylyn&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailtype1=substring&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse+same+sort+as+last+time&field0-0-0=noop&type0-0-0=noop&value0-0-0=" target="mylyn_external">vote for the corresponding bug</a> if your tool is there, or + <a href="http://www.eclipse.org/mylyn/bugs.php" target="mylyn_external">create a new bug</a>. Also consider adding your experiences to the + <a href="http://wiki.eclipse.org/Mylyn/FAQ#Integration_with_other_tools" title="Mylyn/FAQ#Integration_with_other_tools" target="mylyn_external">"Integration..."</a> section of the Mylyn FAQ. + </p> + <h2 id="Using_Mylyn_with_WTP">Using Mylyn with WTP</h2> + <p>Context modeling works at the file level, noting the limitation of + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=144882" target="mylyn_external">bug 144882: interest filter fails on WTP Dynamic Web Project</a> + </p> + <h2 id="External_builders">External builders</h2> + <p>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.</p> + <p>In this case you can explicitly exclude these files from being added to the task context the + <i>Preferences -> Mylyn -> Resources</i> 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. + </p> + <p>Source code generators can be considered analogous since they produce intermediate files. However, if you want to inspect the results of the source code generation after it is done you can avoid setting the exclusion. Note that if a large number of files was generated not all generated files may be unfiltered.</p> + <p> + <img border="0" src="images/mylar-resource-exclusion.gif"/> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> + <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="Updating-This-Document.html" title="Updating This Document"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <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">Updating This Document</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html b/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html index ef3a6abc7..23e5f2102 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html +++ b/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html @@ -37,35 +37,47 @@ <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> -</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 +</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> +</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> +</ul></p> + <p><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></p> + <p><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> +<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> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-List.html b/org.eclipse.mylyn.help.ui/userguide/Task-List.html new file mode 100644 index 000000000..54a939265 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/Task-List.html @@ -0,0 +1,325 @@ +<?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 List</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 List</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Installation.html" title="Installation"> + <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="Configuring-Task-Repositories.html" title="Configuring Task Repositories"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Configuring 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> + <img border="0" src="images/Feature-Reference-3.0-Task-List-Categorized.png"/> + </p> + <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>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> + <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="Keyboard_Shortcuts">Keyboard Shortcuts</h2> + <p>You can use the following hot keys to quickly access frequently used functionality.</p> + <table> + <tr> + <td>F2</td> + <td>rename</td> + </tr> + <tr> + <td>F4</td> + <td>show tooltip</td> + </tr> + <tr> + <td>F5</td> + <td>synchronize</td> + </tr> + <tr> + <td>Alt + Down</td> + <td>go to next unread</td> + </tr> + <tr> + <td>Alt + Up</td> + <td>go to previous unread</td> + </tr> + <tr> + <td>Alt + Shift + R</td> + <td>mark as read</td> + </tr> + <tr> + <td>Alt + Shift + U</td> + <td>mark as unread</td> + </tr> + <tr> + <td>Esc</td> + <td>hide tooltip</td> + </tr> + <tr> + <td>Enter</td> + <td>open task</td> + </tr> + <tr> + <td>Insert</td> + <td>new local task</td> + </tr> + <tr> + <td>Ctrl+C</td> + <td>Copy details</td> + </tr> + <tr> + <td>Ctrl+F</td> + <td>Find</td> + </tr> + </table> + <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"> + <a href="Installation.html" title="Installation"> + <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="Configuring-Task-Repositories.html" title="Configuring Task Repositories"> + <img alt="Next" border="0" src="images/images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Installation</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Configuring Task Repositories</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 032fd3ce7..46d5a9b85 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html +++ b/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html @@ -171,6 +171,9 @@ <p>If you open an XPlanner element by id, using the "Open Repository Task by Key/ID" dialog, and that id is a user story id, you will see the read-only user story editor. This editor is just useful for seeing the major details of a user story -- no items in it can be changed, since there is no really good mapping between a user story and a Mylyn task.</p> <p> <img border="0" src="images/XPlannerUserStoryEditor.gif"/> + </p> + <p> + <a href="http://wiki.eclipse.org/Mylyn/Category:Draft_Documentation" title="Category:Draft Documentation" target="mylyn_external">Category:Draft Documentation</a> </p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif b/org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif Binary files differnew file mode 100644 index 000000000..833f71685 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif |
