Skip to main content
summaryrefslogblamecommitdiffstats
blob: a2e612f634e84afbcee703977209c5dc1fcd9c47 (plain) (tree)















































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
<?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 - Configuration</title>
	</head>
	<body>
		<table class="navigation" style="width: 100%;" border="0" summary="navigation">
			<tr>
				<th style="width: 100%" align="center" colspan="3">Configuration</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="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">Installation</td>
				<td style="width: 60%" align="center"></td>
				<td style="width: 20%" align="right" valign="top">Task List</td>
			</tr>
		</table><hr/>
		<h1 id="Configuration">Configuration</h1>
		<p>After you have installed Mylyn, there are a number of things that you can configure to make your experience even richer.</p>
		<h2 id="Eclipsesettings">Eclipse settings</h2>
		<p>Recommendations for workspace configuration when using Mylyn:</p>
		<ul>
			<li>
				<b>Package Explorer</b>
				<ul>
					<li>Use flat layout in the Package Explorer (local pull down -> 
						<i>Layout -> Flat</i> or 
						<i>Package Presentation -> Flat</i>).
					</li>
					<li>Leave the 
						<i>General -> Appearance -> Label Decorations -> Java Type Indicator</i> off.  The type is visible under the Java file when Mylyn is applied making such additional information redundant.
					</li>
				</ul>
			</li>
			<li>
				<b>Editors</b>
				<ul>
					<li>Turn comment folding on to reduce clutter when using auto folding (
						<i>Preferences -> Java -> Editor -> Folding</i>).
					</li>
				</ul>
			</li>
			<li>
				<b>Views</b>
				<ul>
					<li>Outline: can keep closed for Java development, since the Package Explorer and folded signatures should provide enough context, and the in-place Outline <code>Ctrl+O</code> can be used when needed.</li>
				</ul>
			</li>
			<li>
				<b>Team</b>
				<ul>
					<li>Set 
						<i>Synchronize</i> view to 
						<i>Change Sets</i> mode (on 3.2: third toolbar button: select 
						<i>Change Sets</i>;  on 3.1: toggle toolbar button: 
						<i>Show Change Sets</i>)
					</li>
					<li>Use graphical CVS decorators only (
						<i>Preferences -> Team -> CVS -> Label Decorations -> Text Decorations</i> -> clear all but 
						<i>Project</i>; 
						<i>Icon Decorations</i> -> enable all).  This helps reduce visual clutter.
					</li>
				</ul>
			</li>
		</ul>
		<h2 id="Querysetup">Query setup</h2>
		<p>While there are many ways to set up queries (e.g. by component, by milestone) we recommend the following as a starting point.  For each repository, create:</p>
		<ol>
			<li>One query for all tasks assigned to you.  This should include all closed/resolved tasks in order to prevent resolved tasks from dropping into the "Archive" container.  There is no performance problem with having thousands of resolved tasks in your Task List.</li>
			<li>All tasks assigned to each person that you work with closely.  This can include peers or people you manage and makes it easier to collaborate.</li>
			<li>All tasks that you are CC'd on.  To this you can additionally add tasks that you have commented on and created/reported.  This will prevent you from needing to rely on email notifications, since it captures all tasks of interest.  For example, with this this configruation you can turn off Bugzilla email notifications or have them automatically categorized/filed out of yor email inbox.  </li>
		</ol>
		<p>Depending on how you set up (1) and (2), you may want to limit (3) to certain components in order to avoid tasks showing up in multiple containers.</p>
		<h2 id="Workspacesetup">Workspace setup</h2>
		<p>The following is an example of how to set up your Eclipse to work with a single workspace in a way where you can use Mylyn to focus you on your task while using 
			<i>Working Sets</i> to maintain only a single workspace while keeping project/product boundaries clear.
		</p>
		<ul>
			<li>Create a 
				<i>Working Set</i> for each project/product that you have checked out.
				<ul>
					<li>NOTE: we recommend not overlapping your working sets, e.g. having ProjectFoo in both WorkingSetA and WorkingSetB.  Doing so will cause the project to show twice when the Focus filter is on.</li>
				</ul>
			</li>
			<li>Set the 
				<i>Package Explorer</i> to show 
				<i>Working Sets</i> as the top-level elements.
			</li>
			<li>Set the 
				<i>Problems</i> view to filter out warnings from any 
				<i>Working Sets</i> that you do not contribute to.
			</li>
			<li>Set the 
				<i>File Search</i> scope to only include 
				<i>Working Sets</i> that you contribute to.
			</li>
		</ul>
		<p>When using working sets, the second drop down arrow (Task Activation History) will reveal task activation history for the currenlty selected working set. Choosing a different working set will then only reveal tasks previously activated while the that working set was active. To see the aggregate of all previously active tasks in the task activation history drop down you need to select "Show All" from the work set selection drop down.</p>
		<h2 id="UISettings">UI Settings</h2>
		<p>This section is evolving, please consider adding your own UI settings.</p>
		<ul>
			<li>Landmark background color: 
				<i>Window -> Preferences -> General -> Editors -> Text Editors -> Annotations</i>, then select 
				<i>Landmark</i> and use the 
				<i>Color</i> chooser.
			</li>
			<li>Text colors and fonts: 
				<i>Window -> Preferences -> General -> Appearance -> Colors and Fonts</i>, then select the corresponding category and kind.
			</li>
		</ul>
		<h2 id="Spellchecking">Spell checking</h2>
		<p>On Eclipse versions earlier than 3.3, the spell checking must be set up manually.  Spell checking is supported in the task editor for local tasks and for connectors that support rich editing (e.g. Bugzilla, Trac).</p>
		<ul>
			<li>To install spell checking for editors that support it you need to enable the preference in 
				<i>General -> Editors -> Text Editors -> Spelling</i>.
			</li>
			<li>You also need to install a dictionary, some instructions are 
				<a href="http://www.javalobby.org/java/forums/t17453.html">here</a>. A word list is available 
				<a href="http://wiki.eclipse.org/http://wordlist.sourceforge.net/_here" title="http://wordlist.sourceforge.net/ here">http://wordlist.sourceforge.net/ here</a> as well.
			</li>
		</ul>
		<p>
			<img border="0" src="images/mylar-spell-checking-preference.gif"/>
		</p>
		<h2 id="KeyMappings">Key Mappings</h2>
		<p>If default key mappings aren't working, try doing the following to reset them:</p>
		<ul>
			<li>
				<i>Window -> Reset Perspective</i>
			</li>
			<li>
				<i>Then: Window -> Preferences -> Keys -> Restore Defaults</i>
			</li>
		</ul>
		<p>
			<b>Linux</b>
		</p>
		<p>If you are running Mylyn on X-Windows, for example on Linux, FreeBSD, AIX and HP-UX, some keyboard bindings may not work by default.</p>
		<p>If the <code>Ctrl+Alt+Shift+Arrow Up</code> shortcut for 
			<i>Mark as Landmark</i> does not work do the following:
		</p>
		<ul>
			<li>
				<i>Menu Bar -> Desktop -> Control Centre -> Keyboard Shortcuts -> Move one workspace up, Move one workspace down</i>: disable both.
			</li>
		</ul>
		<p>If <code>Alt+Click</code> quick unfiltering does not work try one of the following:</p>
		<ul>
			<li>Hold down the <code>Windows</code> key while holding <code>Alt</code>, if available (ironic, but unsurprisingly this key is not usually mapped on Linux).</li>
			<li>Disable the <code>Alt+drag to move</code> functionality:</li>
		</ul>
		<p>GNOME Desktop</p>
		<ol>
			<li>Open a terminal and run <code>gconf-editor</code></li>
			<li>Go into: <code>/apps/metacity/general</code></li>
			<li>Edit the <code>mouse_button_modifier</code> field. Setting it to nothing disables it. You can use &lt;Super> to set it to the windows key.</li>
			<li>Exit <code>gconf-editor</code>.</li>
		</ol>
		<p>KDE Desktop</p>
		<ol>
			<li>Run the 
				<i>KDE Control Center</i>.
			</li>
			<li>Go to the 
				<i>Desktop/Window Behavior</i> panel and select the 
				<i>Window Actions</i> tab.
			</li>
			<li>Down in the 
				<i>Inner Window, Titlebar &amp; Frame</i> area, change the 
				<i>Modifier Key</i> option from <code>Alt</code> to <code>Meta</code>.
			</li>
		</ol>
		<p>Reconfiguring Eclipse to use the <code>Meta</code> or <code>Win</code> key instead is not possible due to the Eclipse bug

			<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=55236">55236: Please support SWT.MOD4 on platforms other than the Mac</a>. Consider voting on that bug if you feel that should be possible.
		</p>
		<p>Also, see 
			<a href="http://wiki.eclipse.org/Mylyn/Mylyn_Tips_and_Tricks#Keyboard_Shortcuts" title="Mylyn_Tips_and_Tricks#Keyboard_Shortcuts">keyboard shortcuts</a>.
		</p>
		<h2 id="SystemProperties">System Properties</h2>
		<p>The system properties below can used to change the behavior of Mylyn. To set a property pass it on the command line when starting Eclipse:
<code>			eclipse -vmargs -Dorg.eclipse.mylyn.property=value</code>.</p>
		<table>
			<tr>
				<td>System Property</td>
				<td>Mylyn Version</td>
				<td>Default</td>
				<td>Description</td>
			</tr>
			<tr>
				<td><code>org.eclipse.mylyn.activateTask</code></td>
				<td>3.1</td>
				<td><code>true</code></td>
				<td><code>false</code> Disable task activation on startup.</td>
			</tr>
			<tr>
				<td><code>org.eclipse.mylyn.linkProviderTimeout</code></td>
				<td>3.1</td>
				<td>5000</td>
				<td>Number of milli-seconds before link providers are timed out. Set to -1 to disable link providers timing out.</td>
			</tr>
		</table><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 User Guide.html" title="Mylyn User Guide">
						<img alt="Mylyn User Guide" 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">Installation</td>
				<td style="width: 60%" align="center"></td>
				<td style="width: 20%" align="right" valign="top">Task List</td>
			</tr>
		</table>
	</body>
</html>

Back to the top