diff options
Diffstat (limited to 'org.eclipse.mylyn.help.ui/doc/faq.html')
| -rw-r--r-- | org.eclipse.mylyn.help.ui/doc/faq.html | 486 |
1 files changed, 0 insertions, 486 deletions
diff --git a/org.eclipse.mylyn.help.ui/doc/faq.html b/org.eclipse.mylyn.help.ui/doc/faq.html deleted file mode 100644 index 3538480f3..000000000 --- a/org.eclipse.mylyn.help.ui/doc/faq.html +++ /dev/null @@ -1,486 +0,0 @@ -<html> - <head> - <title> - Mylar FAQ - </title> - </head> - <body> - <div align=center><h1>Mylar Frequently Asked Questions</h1></div> - <p><b>Setup</b></p> - <ul> - <li><a href="#configuration-eclipse">Recommended configuration</a></li> - <li><a href="#install">Install troubleshooting</a></li> - <li><a href="#install-linux">Installing on Linux</a> - </li> - <li><a href="#install-macos">Installing on MacOS</a></li> - <li><a href="#uninstall">Uninstall troubleshooting</a></li> - <li><a href="#tasklist-backup">Task backup and restore</a></li> - </ul> - <p><b>Integration</b></p> -<ul> - <li><a href="#performance-summary">Performance profile</a></li> - <li><a href="#subversion-clients">Subversion limitations</a></li> -</ul> - <p><b>Working with Context</b></p> -<ul> - <li><a href="#context-ui-config">Which Focused UI features can I turn off?</a></li> -</ul> -<p><b>Tasks and Repository Connectors</b></p> - <ul> - <li><a href="#repositories-unsupported">What if Mylar doesn't support my task/bug/issue tracker?</a></li> - <li><a href="#upgrading-repositories">How do I upgrade to multiple task repository support?</a> - </li> - <li><a href="#versions-repositories">Why is only one task appearing in Bugzilla queries?</a> - </li> - <li><a href="#repositories-jira-config">Is there any configuration - needed to make Mylar work with my JIRA repository?</a></li> - <li><a href="#eclipse-views-tasks">How does the Mylar Task List relate to the Eclipse Tasks view?</a></li> - <li><a href="#repositories-connectivity">Connectivity and proxy servers</a></li> - </ul> -<p><b>Java Development</b></p> - <ul> - <li><a href="#content-assist">Content assist troubleshooting</a></li> - <li><a href="#filtering-declarations">How do I stop declarations from showing up in the Package Explorer?</a></li> - <li><a href="#active-search-empty">Why does nothing show up in the Active Search or Active Hierarchy?</a></li> - </ul> - - <p><b>Key Limitations </b></p> - <ul> - <li><a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=106678">Bug 106678</a> - The Package Explorer hierarchical layout is not supported properly yet and - will show uninteresting elements when enabled.</li> - <li><a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=102663">Bug - 102663</a> Multiple workbench windows are not supported and Mylar may - not capture context correctly if you have more than one window open.</li> - </ul> - <p> </p> - - - - <hr> -<h3><a name="configuration-eclipse">Recommended configuration</a></h3> - <p>Recommendations for Mylar 0.5.0:</p> - <ul> - <li>Package Explorer<ul> - <li>Use flat layout in the Package Explorer (local pull down -> <i>Layout</i> - -> <i>Flat</i>). Hierarchical layout is not supported.</li> - <li>Link the Package Explorer with the editor (toolbar -> <i>Link with - Editor</i>). With Mylar applied this won't cause the jumping around - problems it typically does.</li> - <li>Deselect the Referenced Libraries filter (local pull down -> <i>Filters</i> - -> <i>Referenced Libraries</i>). With Mylar applied libraries won't blow - up the tree.</li> - <li>Leave the <i>General</i> -> <i>Appearance </i>-> <i>Java Type Indicator - </i>off. - Since the type under the Java file is visible when Mylar is visible when - Mylar is applied this information is redundant.</li> - </ul> - </li> - <li>Editors<ul> - <li>Turn comment folding on to reduce clutter when using auto folding - (<i>Preferences</i> -> <i>Java </i>-> <i>Editor </i>-> <i>Folding</i>). </li> - <li>Turn off or increase the number of editors to leave open (<i>Preferences</i> -> - <i>General </i>-> <i>Editors </i>-> <i>Number of opened editors before closing</i>). Since - Mylar will manage the open editors with task activation, this number can - be set higher or automatic closing disabled entirely.</li> - <li>If auto folding is used, the Outline view can be closed or made a - fast view</li> - </ul> - </li> - <li>Views<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 (Ctrl+O) can be used - when needed.</li> - </ul> - </li> - <li>Team<ul> - <li>Set Synchronize view to Change Sets 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 Project; <i>Icon Decorations</i> -> enable - all). This helps reduce visual clutter.</li> - </ul> - </li> - </ul> - <hr> -<h3> </h3> - <h3><a name="performance-summary">Performance profile</a></h3> -<p>The goal is for Mylar to have no noticeable effect on Eclipse's speed or -memory usage, you do not need to increase the amount of memory Eclipse runs with -to use Mylar, and any performance issue should be -<a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Mylar">reported as -a bug</a>. The current performance profile is:</p> -<ol> - <li>Mylar only runs if a task is active, and has no impact on Eclipse if no - task is active.</li> - <li>Task context models have negligible memory overhead. </li> - <li>When a task is active, additional view refresh is required to update the - views based on interest model changes. This should not be noticeable - on Windows where refresh is very quick, but could be more noticeable on - other platforms.</li> - <li>The time to activate a task context is dominated by the time it takes - Eclipse to open the editors in the context. You can set the preference - for how many editors to open in the Mylar preference page (e.g. setting to 1 - will dramatically reduce activation time, but also remove the benefit of - having open editors correspond to the task context). You can also turn off - editor management entirely in the Mylar Tasks view pull-down.</li> - <li>Eclipse startup is slowed down by (4) if a task is active when Eclipse - is shut down.</li> - <li>The low priority background searches that the Active Search view runs - can be noticeable on slower machines.</li> -</ol> - <hr> - <h3> </h3> - <h3><a name="install">Install Troubleshooting</a></h3> - <p>For supported platforms and known limitations please see - <a href="http://eclipse.org/mylar/dl.php">http://eclipse.org/mylar/dl.php</a> - Install/update failures can include:</p> -<p><b>Update manager failure</b>: the update manager failed because it could not -access the update site, or because it got confused about the configuration state -of your Eclipse. In this case you may see update errors like: <tt>org.eclipse.update.internal.core.SiteFilePackedPluginContentConsumer</tt>. -First try updating again to -see if the feature is accessible. If you are trying to update the JIRA -connector you can also try de-selecting that feature in case the Tigris.org -update site is not accessible. Using use "Search new features.." when -installing can help avoid this problem. If that does not work see the -feature configuration troubleshooting below.</p><b>Incompatible VM (e.g. JDK 1.4)</b>: in this case you'll errors like the following in your log file. To -check JDK version that Eclipse was launched with to to Help -> About Eclipse SDK --> Configuration Details and verify that the java.vm.version is 1.5. Mac -users should refer to the last comment on -<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=116347#c4">bug 1163477</a> -for instructions on how to change the 1.4 default.<p> -<tt> Root exception: - java.lang.UnsupportedClassVersionError: <br> - org/eclipse/mylar/tasklist/MylarTasklistPlugin - (Unsupported major.minor version 49.0) -</tt> -</p> -<p> -If you are using JDK 1.6 on Eclipse 3.1 (<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=140955">not -recommended</a>) you must add the following line to your config.ini file: <tt> -<br> - org.osgi.framework.executionenvironment=OSGi/Minimum-1.0,OSGi/Minimum-1.1,JRE-1.1,J2SE-1.2,<br> - J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6</p><p> -</tt> -<b>Incompatible version of Eclipse</b>: separate versions and update sites exist -<a href="http://eclipse.org/mylar/dl.php">for Eclipse 3.1 and for the latest 3.2</a>), in which case you may see errors like the following in your -<workspace>/.metadata/.log file or in a Mylar view:</p> -<p> -<tt> java.lang.NoSuchMethodError: - org.eclipse.ui.internal.dialogs.FilteredTree.getFilterControl()<br> - The activator org.eclipse.mylar.java.MylarJavaPlugin for bundle org.eclipse.mylar.java is invalid -</tt> -</p> -<p><b>Mylar feature configuration problem</b>: if the above do not address the -issue, the easiest thing to do is -uninstall any old versions and update to the latest Mylar. Your tasks won't be -lost, by default they are stored in the <workspace>/.mylar/tasklist.xml file -which will be read next time Mylar starts correctly. First, uninstall the old version of Mylar using Help -> -Software Updates -> Manage Configuration. You need to first Disable on all -Mylar features by right-clicking them, allow Eclipse to restart after the last -is disabled, and after restart. Then ensure that the 3rd toolbar button is -pressed (figure below) so that you see the disabled features to uninstall, and -Uninstall them using the popup menu. If you don't uninstall the the Update -Manager will think that you have the latest and tell you that there are no -updates. Note that manually removing the plug-ins -and features can lead to Eclipse configuration errors. After uninstalling update Eclipse -by adding the correct update site specified at: - <a href="http://eclipse.org/mylar/dl.php">http://eclipse.org/mylar/dl.php</a>, -and after that automatically or manually updating will install the correct -version.</p> -<p> -<img border="0" src="images/faq/eclipse-manage-configuration.gif" width="679" height="335"></p> - <hr> - <p> - </p> - - -<h3><a name="install-linux">Installing on Linux</a></h3> - <p>Mylar Task Management features make user of Eclipse's Internal Browser - which may require additional install steps. The following have been - verified on Fedora Core.</p> - <ol> - <li>Run Mozilla (not firefox) to confirm that it works.</li> - <li>Confirm the location of your Mozilla install ( /usr/lib/mozilla-1.7.12 - on our test box)</li> - <li>Set necessary environment variables in <home_directory>/.bashrc, - adding the following 3 lines<br> - MOZILLA_FIVE_HOME=/usr/lib/mozilla-1.7.12<br> - LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$MOZILLA_FIVE_HOME<br> - export MOZILLA_FIVE_HOME LD_LIBRARY_PATH </li> - <li>Log out and log in again (or type "source .bashrc" at the prompt)</li> - <li>Start Eclipse and test the internal web browser</li> - </ol> - <p>If you are get exceptions indicating missing libraries, check that the - paths are accurate and that you in fact have the libraries requested. For - example, on our test box a library was still missing after these steps. The - libstdc++.so.5 was being reported as missing. To solve this problem, find an - rpm online that will install the missing legacy library. In our case we - found necessary rpm (compat-libstdc++-33-3.2.3-47.fc4.i386.rpm) on - <a title="http://www.rpmfind.net/" href="http://www.rpmfind.net">rpmfind.net</a> - using their search facility. References: - <a title="http://www.eclipse.org/swt/faq.php" href="http://www.eclipse.org/swt/faq.php"> - SWT FAQ</a></p> - <hr> - - -<h3> </h3> -<h3><a name="install-macos">Installing on MacOS</a></h3> - <p>If you see errors like the following it may be due to Xerces missing from - the Mac JDK so you may need to add it to your default classpath. - Please refer to and comment on - <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=144287">bug 144287</a> - if you see this problem.</p> -<blockquote> - <p>Could not create Bugzilla editor input<br> - java.io.IOException: SAX2 driver class org.apache.xerces.parsers.SAXParser - not found</p> -</blockquote> - <p>To ensure that you are using the 1.5 VM refer to the last comment on -<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=116347#c4">bug 1163477</a> -for instructions on how to change the 1.4 default.</p> - <hr> - <p> </p> - <h3><a name="uninstall">Uninstall Troubleshooting</a></h3> - <p> -On Eclipse 3.1, you may need to reset the Java editor to be default for ".java" -again via: <i>Preferences -> General -> Editors -> File Associations -</i> </p> - <p> -On Eclipse 3.2, you may need to ensure that the "Java Completions" and "Java -Types" proposal categories are included in the default proposals via: -<i>Preferences -> Java -> Editor -> Content Assist -> Advanced</i> (<a href="#content-assist-duplication">see -screenshot</a>) <i>-> Restore Defaults</i></p> - <hr> - <p> - </p> - - -<h3><a name="tasklist-backup">Task backup and restore</a> </h3> -<p>The task list is <b>backed up by default</b> in the - <workspace>/.mylar/backup directory, with rolling backups set according to - the schedule in <i>Preferences -> Mylar -> Task List -> Backup</i>. - Use <i>File -> Import -> Mylar Task Data</i> to restore from one of the - archive zips.</p> -<p>If the Task List is blank Mylar failed to <a href="#install-failure">install or update</a>, -or there was a problem reading the task list. By default Mylar -keeps your task list in <i><workspace>/.mylar/tasklist.xml</i>. If -you move workspaces, and have not changed the Mylar data directory via the Task -List preference page, the new location will be used when Eclipse restarts (hit -Restore Defaults on that page to copy tasks back to the default location). -If your tasks disappear due to to a bug you can check the .mylar folder for a <i>tasklist-backup.xml</i> -file, which will contain the previously-saved list. </p> -<p>You can also back up your task list and context data manually or periodically use - <i>File -> - Import/Export -> Mylar Task Data</i>. Note that when restoring - an previous tasklist.xml file you should first close Eclipse.</p> - <p> - <img border="0" src="images/faq/tasklist-backup.gif" width="525" height="310"></p> - - <hr> - - -<h3> </h3> -<h3><a name="context-ui-config">Which Focused UI features can I turn off?</a></h3> - <p> - All of them. When no task is active neither are any of Mylar's - features. When working with task contexts Mylar's Focused UI features - are all optional and in general configurable. The following table - summarizes how the key features can be toggled. Additional - configuration options are under the Mylar and General -> Appearance - preference pages.</p> -<table border="1" style="border-collapse: collapse" width="100%" id="table2" cellpadding="4" bordercolor="#FFFFFF"> - <tr> - <td bgcolor="#595791" width="17%" align="center"><font color="#FFFFFF"> - <b>UI Mechanism</b></font></td> - <td bgcolor="#595791" width="20%" align="center"><font color="#FFFFFF"> - <b>Example/description</b></font></td> - <td bgcolor="#595791" width="*" align="center"><font color="#FFFFFF"><b> - Toggle using</b></font></td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Interest filtering</td> - <td bgcolor="#FAF7FB" align="left"> - Package Explorer</td> - <td bgcolor="#FAF7FB">Apply Mylar button on view toolbar</td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Interest decoration</td> - <td bgcolor="#FAF7FB" align="left"> - Bolding of landmark elements</td> - <td bgcolor="#FAF7FB">Preferences -> General -> Appearance -> Label - Decoration</td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Content assist</td> - <td bgcolor="#FAF7FB" align="left"> - Ranking of interesting elements</td> - <td bgcolor="#FAF7FB">Eclipse 3.2: Java -> Editor -> Content Assist -> - Work in Progress -> turn off Mylar, turn on Java<br> - Eclipse 3.1: set the Java editor to be default for .java, not the Mylar - Java editor</td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Active change sets</td> - <td bgcolor="#FAF7FB" align="left"> - Grouping of changes by tasks</td> - <td bgcolor="#FAF7FB">Preferences -> Mylar -> Team</td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Editor management</td> - <td bgcolor="#FAF7FB" align="left"> - Auto opening/closing of editors</td> - <td bgcolor="#FAF7FB">Preferences -> Mylar -> Editor Management</td> - </tr> - <tr> - <td bgcolor="#FAF7FB">Active views</td> - <td bgcolor="#FAF7FB" align="left"> - Active Search and Hierarchy</td> - <td bgcolor="#FAF7FB">Only on if view is active</td> - </tr> -</table> - - <hr> - - <h3> </h3> -<h3><a name="repositories-unsupported">What if Mylar doesn't support my task/bug/issue tracker?</a></h3> -<p>First, do a search of the <a href="https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=anywordssubstr&short_desc=%5Bconnector%5D&product=Mylar&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=">open -repository connector requests</a> and vote for the corresponding bug if your tracker is found, or create -a new report. In the meantime, you can work with those reports (but not -with queries) via the web integration. To create a task from any web-based -repository:</p> -<ul> - <li>Drag the URL from the Address bar of the browser, or from a hyperlink in - a bug listing to the Mylar Tasks view. This will create a task for the - bug, link it to the page, and populate the description with the title of the - corresponding page. In Mozilla, simply drag - the URL. In Internet Explorer you must have Ctrl pressed in - order for Eclipse to recognize the drop.</li> - <li>Alternatively you can copy the URL, press the New Task button on the - Mylar Tasks view. This has the same effect as above but you can edit - the description after retrieving it.</li> - <li>Opening the task will now open the corresponding issue. You can - also right-click the task and select Open in External Browser.</li> -</ul> - <p> - <img border="0" src="images/0.4.1/tasklist-weblink-editor.gif" width="585" height="195"></p> - <hr> - <p> </p> - <h3><a name="repositories-connectivity">Connectivity and proxy servers</a></h3> - <p>For accessing repositories via a proxy server, Mylar uses the settings - under <i>Preferences -> Install/Update</i>. If you are seeing - errors like <span class="e" id="q_10b3e1bc7372e609_1"> - <font face="Times New Roman" size="3"><span style="FONT-SIZE: 12pt">"HTTP - Response Code 407" it is likely that you need to configure these proxy - server settings.</span></font></span></p> - <hr> - <p> </p> - <h3><a name="upgrading-repositories">How do I upgrade to multiple -task repository support?</a></h3> -<p>Bugzilla Client users follow these steps after updating in order to -migrate to multiple repository support from version 0.4.6 or older</p> -<ul> - <li>After -updating and restarting, deactivate your active task, open the Mylar -> Task -Repositories view and re-add your previous repository using the wizard.</li> -<li>Ensure that you enter the correct Server URL by pressing the “validate” button -on the corresponding dialog, since this URL will be used for the migration.</li> - <li>Exit the workbench and restart Eclipse to complete the migration.</li> -</ul> - <hr> - <p> </p> -<h3><a name="versions-repositories">Why is only one task appearing in Bugzilla -queries?</a></h3> - <p>This is a symptom of the wrong Bugzilla version selected in your Mylar - Bugzilla preferences ( Window -> Preferences -> Mylar -> Bugzilla Client ). - For example, if you are connecting to the Eclipse.org Bugzilla then the 2.20 - option must be selected.</p> - <hr> -<h3> </h3> -<h3><a name="repositories-jira-config">Is there any configuration needed to make -Mylar work with my JIRA repository?</a></h3> - <p>Yes, JIRA SOAP/RPC services have to be running on the server. For - additional details see the Requirements at: - <a href="http://jira-dashboard.tigris.org/"> - http://jira-dashboard.tigris.org/</a> </p> - <hr> -<h3> </h3> -<h3><a name="eclipse-views-tasks">How does the Mylar Task List relate to the Eclipse Tasks view?</a></h3> - <p>The SDK's Tasks view is used for showing markers such as 'todo' tags - which indicate a local problem with a resource, similar to a compiler - warning. As such, these 'tasks' are at a much lower level of - granularity than than Mylar's tasks, and one task could involve cleaning up - multiple todos. In order to make working with only the markers in a - particular task context, e.g. for clean-up before committing, the Apply - Mylar filter is available for both the Problems and the Tasks views. </p> - <hr> -<h3> </h3> - <h3><a name="subversion-clients">Subversion Limitations</a></h3> - <p>Mylar's Active Change Set integration, which allows you to work with - changes per-task, support's the Eclipse SDK's CVS integration, and should - work with any source repository client that extends Eclipse's Change Set - support. As of March 2006 no Subversion clients support change sets, - and as such this feature is not available for those clients. </p> - <p> </p> - <hr> - <h3> </h3> -<h3><a name="active-search-empty0">Why does nothing show up in the Active Search or Active Hierarchy?</a></h3> - <p> - As you work and elements become landmarks (bold decoration), and - these elements populate the Active Search and Active Hierarchy - views. To force an element to populate the views manually make - it a landmark by right-clicking or hitting Ctrl+Alt+Shift+Up Arrow. -</p> - <hr> -<p> - </p> - <h3><a name="content-assist">Content assist troubleshooting</a></h3> -<p>In Eclipse 3.2, Mylar uses extended content assist processors in order to -rank and separate the elements in the current task context. To see -proposals ranked according to interest you must have only the <i>(Mylar)</i> -proposals kinds enabled in the list below, otherwise you will see duplicates. -<b>If you do not see any proposals</b>, check this list to ensure that either -the Mylar or the plain proposals are enabled. Running <i>New -> Mylar -> Recommended -Preferences</i> will do this for you automatically, or you can set toggle them -manually in the preference page. Proposals will disappear if a -workspace into which Mylar was installed is run without Mylar installed (e.g. as -a result of uninstalling or multiple Eclipses using same workspace, see Platform -<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=140416">bug 140416</a>).</p> -<p>If after invoking content assist you see an error message dialog that states -"The extension tool too long to return from the 'computeCompletionProposals()' -operation", this is most likely due to something interrupting the proposal -operation (e.g. garbage collection). Ignore it if it does not recur, -increase Eclipse's memory if it does (e.g via -Xmx384M command line argument), -or see <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=141457">bug 141457</a> -for more details.</p> -<p> - <img border="0" src="images/faq/content-assist.gif"></p> - <hr> -<p> </p> - <h3><a name="filtering-declarations">How do I stop declarations from showing up in the Package Explorer?</a></h3> -<p>If you don't like Mylar's constant showing of Java members in the - Package Explorer, select the drop-down menu, then "Filters..." and - enable the "Mylar Java Declarations Filter". It will then - stick in the menu in case you want to toggle between modes. -Note that this will hide interest information about members that aren't in your -current file (e.g. showing you which methods are landmarks) so this mode is not -recommended, but can be useful for 1024x768 screen resolutions.</p> - <p> - <img border="0" src="images/0.3/filtering-declarations.gif" width="441" height="211"></p> - <hr> -<p> - </p> - <h3><a name="active-search-empty">Why does nothing show up in the Active Search or Active Hierarchy?</a></h3> - <p> - As you work and elements become landmarks (bold decoration), and - these elements populate the Active Search and Active Hierarchy - views. To force an element to populate the views manually make - it a landmark by right-clicking or hitting Ctrl+Alt+Shift+Up Arrow. -</p> - <hr> -<p> - </p> -<p> </p> -</body></html>
\ No newline at end of file |