Skip to main content
summaryrefslogtreecommitdiffstats
blob: 11aa1305a726132a0a28f8997eb8ee01a3c58ef3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?xml version='1.0' ?><!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>
		<title>Mylyn User Guide</title>
	</head>
	<body>
		<table class="navigation" style="width: 100%;" border="0" summary="navigation">
			<tr>
				<th style="width: 100%" align="center" colspan="3">Mylyn User Guide</th>
			</tr>
			<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">
						<img alt="Next" border="0" src="images/images/next.gif"/>
					</a>
				</td>
			</tr>
			<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>
			</tr>
		</table><hr/>
		<p>
			<a href="http://wiki.eclipse.org/Mylyn/Category:Mylyn" title="Category:Mylyn">Category:Mylyn</a>
		</p>
		<h1 id="Introduction">Introduction</h1>
		<p>For 
			<b>tutorials and articles on using Mylyn</b> refer to the 
			<a href="http://www.eclipse.org/mylyn/publications/index.php">Publications page</a>.  The role of this document is to provide up-to-date documentation on a listing of the key Mylyn features and is not intended as a tutorial, and to allow users to contribute additional documentation.
		</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, or JIRA).</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 on 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="Tips">Tips</h2>
		<ul>
			<li>If a task is stuck with outgoing changes or a mid-air collision occurrs use the Synchronize action or 
				<i>Mark -> Clear Outgoing</i>. 
			</li>
			<li>The 
				<i>Task List</i> can be restored via its view menu -> 
				<i>Restore Tasks from History...</i> 
			</li>
			<li>If a task change set disappears or is missing items, toggle the 
				<i>Incoming/Outgoing</i> mode of the 
				<i>Syncrhonize</i> view. 
			</li>
			<li>When checking out a new project, deactivate the active task. Otherwise all newly created files will become interesting. </li>
		</ul>
		<h2 id="Shortcuts">Shortcuts</h2>
		<p>			<b>&nbsp;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>&nbsp;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>&nbsp;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>&nbsp;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>
		<h2 id="UILegend">UI Legend</h2>
		<p>Open the live 
			<i>UI Legend</i> via 
			<i>Task List -> view menu -> Show UI Legend</i>
		</p>
		<p>
			<img border="0" src="images/mylyn-ui-legend.gif"/>
		</p>
		<h2 id="ExternalResources">External Resources</h2>
		<p>Getting Started</p>
		<ul>
			<li>
				<a href="http://eclipse.org/mylyn/start">http://eclipse.org/mylyn/start</a>
			</li>
			<li>
				<a href="http://eclipse.org/mylyn/presentations">http://eclipse.org/mylyn/presentations</a>
			</li>
			<li>
				<a href="http://wiki.eclipse.org/Mylyn/FAQ">http://wiki.eclipse.org/Mylyn/FAQ</a>
			</li>
		</ul>
		<p>Instructional blog posts (feel free to add your own)</p>
		<ul>
			<li>
				<a href="http://acer-rubrum.blogspot.com/2008/05/using-redmine-with-mylyn-eclipse-plugin.html">Using Mylyn with Redmine</a> (2008-05-10)
			</li>
			<li>
				<a href="http://blog.vazexqi.com/articles/2008/02/02/session-restore-sort-of-in-eclipse-with-mylyn">http://blog.vazexqi.com/articles/2008/02/02/session-restore-sort-of-in-eclipse-with-mylyn</a> (2008-02)
			</li>
			<li>Using Mylyn with Google Code: 
				<a href="http://www.jroller.com/alexRuiz/entry/using_mylyn_with_google_code">http://www.jroller.com/alexRuiz/entry/using_mylyn_with_google_code</a> (2007-08)
			</li>
			<li>XPlanner Connector overview: 
				<a href="http://www.jroller.com/robwilliams/entry/first_look_xplanner_connector_for">http://www.jroller.com/robwilliams/entry/first_look_xplanner_connector_for</a> (2007-07)
			</li>
			<li>Filing bugs with the Bugzilla connector: 
				<a href="http://www.peterfriese.de/index.php/2007/07/02/reporting-bugs-has-never-been-easier/">http://www.peterfriese.de/index.php/2007/07/02/reporting-bugs-has-never-been-easier/</a> (2007-07)
			</li>
			<li>Overview: 
				<a href="http://rbtech.blogspot.com/2007/05/eclipse-mylar-wow.html">http://rbtech.blogspot.com/2007/05/eclipse-mylar-wow.html</a> (2007-05)
			</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">
						<img alt="Next" border="0" src="images/images/next.gif"/>
					</a>
				</td>
			</tr>
			<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>
			</tr>
		</table>
	</body>
</html>

Back to the top