diff options
Diffstat (limited to 'org.eclipse.mylyn.help.ui')
82 files changed, 3194 insertions, 1027 deletions
diff --git a/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml b/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml new file mode 100644 index 000000000..529b07b78 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn-FAQ-toc.xml @@ -0,0 +1,189 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="Mylyn/FAQ/FAQ.html" label="Mylyn FAQ"> + <topic href="Mylyn/FAQ/FAQ.html" label="What is Mylyn?"></topic> + <topic href="Mylyn/FAQ/Installation.html" label="Installation"> + <topic href="Mylyn/FAQ/Installation.html#Install_Method_1_-_Eclipse_3.4" label="Install Method 1 - Eclipse 3.4"></topic> + <topic href="Mylyn/FAQ/Installation.html#Install_Method_2_-_Eclipse_3.3_and_older" label="Install Method 2 - Eclipse 3.3 and older"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_is_the_release_schedule.3F" label="What is the release schedule?"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_versions_of_Eclipse_are_supported.3F" label="What versions of Eclipse are supported?"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_version_of_Java_is_required.3F" label="What version of Java is required?"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_version_of_Mylyn_is_distributed_with_the_Eclipse_downloads.3F" label="What version of Mylyn is distributed with the Eclipse downloads?"></topic> + <topic href="Mylyn/FAQ/Installation.html#My_tasks_or_queries_disappeared.2C_what_do_I_do.3F" label="My tasks or queries disappeared, what do I do?"></topic> + <topic href="Mylyn/FAQ/Installation.html#General_Installation_Troubleshooting" label="General Installation Troubleshooting"></topic> + <topic href="Mylyn/FAQ/Installation.html#Installation_Troubleshooting_on_Eclipse_3.4_and_later" label="Installation Troubleshooting on Eclipse 3.4 and later"> + <topic href="Mylyn/FAQ/Installation.html#Why_does_the_installation_fail_with_.27.27No_repository_found.27.27.3F" label="Why does the installation fail with ''No repository found''?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Why_does_update_fail_with_.27.27Cannot_complete_the_request.27.27.3F" label="Why does update fail with ''Cannot complete the request''?"></topic> + </topic> + <topic href="Mylyn/FAQ/Installation.html#Installation_Troubleshooting_on_Eclipse_3.3_and_earlier" label="Installation Troubleshooting on Eclipse 3.3 and earlier"></topic> + <topic href="Mylyn/FAQ/Installation.html#Why_can.27t_I_update_Mylyn_3.0_to_a_newer_release.3F" label="Why can't I update Mylyn 3.0 to a newer release?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Installing_on_Linux" label="Installing on Linux"> + <topic href="Mylyn/FAQ/Installation.html#How_can_I_get_the_SWT_internal_browser_to_work_under_Linux.3F" label="How can I get the SWT internal browser to work under Linux?"></topic> + <topic href="Mylyn/FAQ/Installation.html#I.E2.80.99m_getting_a_.E2.80.9CCould_not_create_Browser_page:_No_more_handles.E2.80.9D_error" label="I’m getting a “Could not create Browser page: No more handles” error"></topic> + <topic href="Mylyn/FAQ/Installation.html#I.E2.80.99m_having_unstable_performance_on_Linux_with_a_Sun_JVM_are_there_options.3F" label="I’m having unstable performance on Linux with a Sun JVM are there options?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Memory_consumption_problem_with_internal_browser_on_Linux-GTK" label="Memory consumption problem with internal browser on Linux-GTK"></topic> + <topic href="Mylyn/FAQ/Installation.html#Error:_No_more_handles_error" label="Error: No more handles error"></topic> + <topic href="Mylyn/FAQ/Installation.html#Recommended_Settings_for_GTK" label="Recommended Settings for GTK"></topic> + <topic href="Mylyn/FAQ/Installation.html#Recommended_GTK_Setup_for_KDE" label="Recommended GTK Setup for KDE"></topic> + <topic href="Mylyn/FAQ/Installation.html#Solving_issues_with_KDE_environment_variable_settings" label="Solving issues with KDE environment variable settings"></topic> + <topic href="Mylyn/FAQ/Installation.html#Known_UI_issues_with_KDE" label="Known UI issues with KDE"></topic> + </topic> + <topic href="Mylyn/FAQ/Installation.html#Installing_on_MacOS" label="Installing on MacOS"></topic> + <topic href="Mylyn/FAQ/Installation.html#Configuration_Troubleshooting" label="Configuration Troubleshooting"> + <topic href="Mylyn/FAQ/Installation.html#The_default_Key_Mappings_aren.E2.80.99t_working_correctly.2C_what_can_I_do.3F" label="The default Key Mappings aren’t working correctly, what can I do?"> + <topic href="Mylyn/FAQ/Installation.html#Linux_key_mappings_a_problem.3F" label="Linux key mappings a problem?"></topic> + </topic> + <topic href="Mylyn/FAQ/Installation.html#How_do_I_enable_spell_checking_in_Eclipse_3.2_and_older.3F" label="How do I enable spell checking in Eclipse 3.2 and older?"></topic> + <topic href="Mylyn/FAQ/Installation.html#How_can_I_change_the_number_of_editors_left_open_before_Mylyn_starts_closing_editors.3F" label="How can I change the number of editors left open before Mylyn starts closing editors?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Do_I_need_the_Outline_View_when_running_Mylyn.3F" label="Do I need the Outline View when running Mylyn?"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_does_the_message_.E2.80.9Ccontent_assist_proposals_no_longer_appear.E2.80.9D_mean.3F" label="What does the message “content assist proposals no longer appear” mean?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Why_do_I_get_errors_like_.E2.80.9CHTTP_Response_Code_407.E2.80.9D_or_.E2.80.9CProxy_Authentication_Error.E2.80.9D_when_accessing_repositories_through_a_proxy_server.3F" label="Why do I get errors like “HTTP Response Code 407” or “Proxy Authentication Error” when accessing repositories through a proxy server?"></topic> + <topic href="Mylyn/FAQ/Installation.html#I_can.E2.80.99t_use_.3Ccode.3ECtrl.2BAlt.2BShift.2BArrow_Up.3C.2Fcode.3E_for.27.27_Mark_as_Landmark.27.27.__What_do_I_do.3F" label="I can’t use <code>Ctrl+Alt+Shift+Arrow Up</code> for'' Mark as Landmark''. What do I do?"></topic> + <topic href="Mylyn/FAQ/Installation.html#How_do_I_turn_on_spell_checking.3F" label="How do I turn on spell checking?"></topic> + <topic href="Mylyn/FAQ/Installation.html#Why_do_I_get_an_error_when_accessing_secured_web_sites.3F" label="Why do I get an error when accessing secured web sites?"></topic> + </topic> + <topic href="Mylyn/FAQ/Installation.html#Uninstall_troubleshooting" label="Uninstall troubleshooting"></topic> + <topic href="Mylyn/FAQ/Installation.html#Why_am_seeing_.3Ccode.3Ejava.lang.OutOfMemoryError:_PermGen_space.3C.2Fcode.3E_errors.3F" label="Why am seeing <code>java.lang.OutOfMemoryError: PermGen space</code> errors?"></topic> + <topic href="Mylyn/FAQ/Installation.html#What_is_Mylyn.E2.80.99s_performance_profile.3F" label="What is Mylyn’s performance profile?"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-List.html" label="Task List"> + <topic href="Mylyn/FAQ/Task-List.html#How_do_I_restore_my_tasks_from_backup.3F" label="How do I restore my tasks from backup?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#How_do_I_clear_outgoing_changes_on_a_task.3F" label="How do I clear outgoing changes on a task?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Why_do_my_tasks_not_appear_in_the_Task_List.3F" label="Why do my tasks not appear in the Task List?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Why_do_tasks_appear_in_the_.27.27Unmatched.27.27_container.3F" label="Why do tasks appear in the ''Unmatched'' container?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#How_do_I_change_the_Task_List_colors.3F" label="How do I change the Task List colors?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#The_Unmatched_category_contains_many_irrelevant_tasks.2C_how_do_I_clean_it_up.3F" label="The Unmatched category contains many irrelevant tasks, how do I clean it up?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#How_does_Mylyn_count_the_active_time_for_a_task.3F" label="How does Mylyn count the active time for a task?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#How_do_I_prevent_long-running_tasks_from_adding_to_the_progress_bar.3F" label="How do I prevent long-running tasks from adding to the progress bar?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Does_the_Task_List_replace_the_Eclipse_Tasks_view.3F" label="Does the Task List replace the Eclipse Tasks view?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#What_if_I_use_multiple_workspaces.3F" label="What if I use multiple workspaces?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#How_do_I_export_my_task_and_repository_data.3F" label="How do I export my task and repository data?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Why_does_Mylyn_use_the_term_.E2.80.9Ctask.E2.80.9D.3F" label="Why does Mylyn use the term “task”?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Why_are_closed_tasks_not_greyed_out_on_Linux.3F" label="Why are closed tasks not greyed out on Linux?"></topic> + <topic href="Mylyn/FAQ/Task-List.html#Why_is_starring_tasks_not_supported.3F" label="Why is starring tasks not supported?"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Editor.html" label="Task Editor"> + <topic href="Mylyn/FAQ/Task-Editor.html#When_I_submit_a_new_bug_to_eclipse.org_the_priority_isn.E2.80.99t_updated.3F" label="When I submit a new bug to eclipse.org the priority isn’t updated?"></topic> + <topic href="Mylyn/FAQ/Task-Editor.html#Why_am_I_seeing_strange_boxes_where_I_expect_to_see_proper_characters.3F" label="Why am I seeing strange boxes where I expect to see proper characters?"></topic> + <topic href="Mylyn/FAQ/Task-Editor.html#How_can_I_view_images_or_screenshots_that_are_attached_to_an_image.3F" label="How can I view images or screenshots that are attached to an image?"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Repositories.html" label="Task Repositories"> + <topic href="Mylyn/FAQ/Task-Repositories.html#What_if_I.E2.80.99m_not_using_a_Task_Repository.3F" label="What if I’m not using a Task Repository?"></topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#What_if_Mylyn_doesn.E2.80.99t_support_my_task.2Fbug.2Fissue.2Fticket_repository.3F" label="What if Mylyn doesn’t support my task/bug/issue/ticket repository?"></topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#Why_were_my_repository_credentials_reset.3F" label="Why were my repository credentials reset?"></topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#Why_are_my_updated_repository_attributes_not_showing_up.3F" label="Why are my updated repository attributes not showing up?"></topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#Authentication_Troubleshooting" label="Authentication Troubleshooting"> + <topic href="Mylyn/FAQ/Task-Repositories.html#Certificate_authentication" label="Certificate authentication"> + <topic href="Mylyn/FAQ/Task-Repositories.html#Creating_a_keystore" label="Creating a keystore"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#NTLM_authentication" label="NTLM authentication"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#Network_Troubleshooting" label="Network Troubleshooting"> + <topic href="Mylyn/FAQ/Task-Repositories.html#Performance_Problems_with_HTTPS" label="Performance Problems with HTTPS"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Repositories.html#Why_are_task_hyperlinks_not_working.3F" label="Why are task hyperlinks not working?"></topic> + </topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html" label="Bugzilla Connector"> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#What_versions_are_supported.3F" label="What versions are supported?"> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Tips_for_server_administrators" label="Tips for server administrators"></topic> + </topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Why_are_queries_failing.3F" label="Why are queries failing?"></topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Why_do_I_see_my_old_username.3F" label="Why do I see my old username?"></topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Why_do_tasks_fail_to_open.3F" label="Why do tasks fail to open?"></topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Why_do_tasks_fail_to_submit.3F" label="Why do tasks fail to submit?"></topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#What_time_zone_is_used_in_the_task_editor.3F" label="What time zone is used in the task editor?"></topic> + <topic href="Mylyn/FAQ/Bugzilla-Connector.html#Known_limitations" label="Known limitations"></topic> + </topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html" label="JIRA Connector"> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_does_the_installation_fail_with_a_long_error_message.3F" label="Why does the installation fail with a long error message?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#What_are_the_server_requirements.3F" label="What are the server requirements?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_can.E2.80.99t_I_connect.3F" label="Why can’t I connect?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_do_I_get_a_.E2.80.9CJIRA_connector_requires_server_3.3.3_or_later.E2.80.9D_message.3F" label="Why do I get a “JIRA connector requires server 3.3.3 or later” message?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#What_is_the_latest_version_of_the_JIRA_connector_that_supports_Eclipse_3.2_.28IBM_Rational_Application_Developer_7.29.3F" label="What is the latest version of the JIRA connector that supports Eclipse 3.2 (IBM Rational Application Developer 7)?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_are_attachments_missing_in_the_task_editor_although_they_are_displayed_in_the_web_interface.3F" label="Why are attachments missing in the task editor although they are displayed in the web interface?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Are_custom_fields_supported_by_the_JIRA_connector.3F" label="Are custom fields supported by the JIRA connector?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Known_limitations_2" label="Known limitations"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#How_can_I_enable_compression_for_SOAP_messages.3F" label="How can I enable compression for SOAP messages?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Reporting_issues" label="Reporting issues"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_do_I_get_errors_about_an_unexpected_redirect_when_submitting_an_issue.3F" label="Why do I get errors about an unexpected redirect when submitting an issue?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#What_does_.3Ccode.3EError_parsing_server_response:_No_project_with_key_.E2.80.98xyz.E2.80.99_found.3C.2Fcode.3E.3F" label="What does <code>Error parsing server response: No project with key ‘xyz’ found</code>?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_does_the_estimated_time_displayed_in_the_task_editor_differ_from_the_web_interface.3F" label="Why does the estimated time displayed in the task editor differ from the web interface?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#Why_am_I_getting_the_message_.E2.80.9CYou_did_not_enter_a_valid_date.E2.80.9D_when_I_try_to_submit_a_JIRA_issue.3F" label="Why am I getting the message “You did not enter a valid date” when I try to submit a JIRA issue?"></topic> + <topic href="Mylyn/FAQ/JIRA-Connector.html#How_can_I_make_issue_dependencies_visible_in_the_Task_List.3F" label="How can I make issue dependencies visible in the Task List?"></topic> + </topic> + <topic href="Mylyn/FAQ/Trac-Connector.html" label="Trac Connector"> + <topic href="Mylyn/FAQ/Trac-Connector.html#What_are_the_server_requirements.3F_2" label="What are the server requirements?"> + <topic href="Mylyn/FAQ/Trac-Connector.html#XML-RPC_.28recommended.29" label="XML-RPC (recommended)"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Web" label="Web"></topic> + </topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Recommended_Trac_version" label="Recommended Trac version"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Does_Mylyn_support_Trac_0.11.3F" label="Does Mylyn support Trac 0.11?"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Why_do_I_get_an_HTTP_Error_500_Internal_server_error_when_creating_a_ticket_that_contains_non-ASCII_characters.3F" label="Why do I get an HTTP Error 500 Internal server error when creating a ticket that contains non-ASCII characters?"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Known_limitations_3" label="Known limitations"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Why_are_tasks_opened_in_a_web_browser_and_not_in_the_rich_editor.3F" label="Why are tasks opened in a web browser and not in the rich editor?"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Which_URLs_does_Mylyn_access_in_a_Trac_repository.3F" label="Which URLs does Mylyn access in a Trac repository?"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Problems_opening_the_web_editor_on_Linux" label="Problems opening the web editor on Linux"></topic> + <topic href="Mylyn/FAQ/Trac-Connector.html#Which_Trac_Plugins_are_supported_by_Mylyn.3F" label="Which Trac Plugins are supported by Mylyn?"></topic> + </topic> + <topic href="Mylyn/FAQ/Web-Templates-Connector.html" label="Web Templates Connector"> + <topic href="Mylyn/FAQ/Web-Templates-Connector.html#Where_can_I_find_the_Web_Templates_connector.3F" label="Where can I find the Web Templates connector?"></topic> + <topic href="Mylyn/FAQ/Web-Templates-Connector.html#Why_can.E2.80.99t_I_connect_using_one_of_the_existing_templates.3F" label="Why can’t I connect using one of the existing templates?"></topic> + <topic href="Mylyn/FAQ/Web-Templates-Connector.html#Known_limitations_4" label="Known limitations"></topic> + <topic href="Mylyn/FAQ/Web-Templates-Connector.html#Where_can_I_find_additional_templates.3F" label="Where can I find additional templates?"></topic> + </topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html" label="Task-Focused UI"> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#What_is_the_Task-Focused_UI.3F" label="What is the Task-Focused UI?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#Why_do_files_disappear_from_Focused_views_when_I_close_them.3F" label="Why do files disappear from Focused views when I close them?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#Why_did_all_my_editor_tabs_disappear.3F" label="Why did all my editor tabs disappear?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#How_do_I_get_rid_of_an_element_if_it_is_not_interesting.3F" label="How do I get rid of an element if it is not interesting?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#Which_Focused_UI_features_can_I_turn_off.3F" label="Which Focused UI features can I turn off?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#Why_can.E2.80.99t_I_Alt.2BClick_to_references_libraries.3F" label="Why can’t I Alt+Click to references libraries?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#Why_is_the_.27.27Link_with_Editor.27.27_button_disabled.3F" label="Why is the ''Link with Editor'' button disabled?"></topic> + <topic href="Mylyn/FAQ/Task-Focused-UI.html#What_happened_to_the_Active_Search_and_Active_Hierarchy_views.3F" label="What happened to the Active Search and Active Hierarchy views?"></topic> + </topic> + <topic href="Mylyn/FAQ/Context-and-Timing-data.html" label="Context and Timing data"> + <topic href="Mylyn/FAQ/Context-and-Timing-data.html#How_do_I_prevent_code_checked_out_from_polluting_my_task_context.3F" label="How do I prevent code checked out from polluting my task context?"></topic> + <topic href="Mylyn/FAQ/Context-and-Timing-data.html#Why_do_I_see_strange_elapsed_times_on_my_Planning_tab.3F" label="Why do I see strange elapsed times on my Planning tab?"></topic> + <topic href="Mylyn/FAQ/Context-and-Timing-data.html#Is_the_backwards_compatibility_and_refactoring_of_task_context_handled.3F" label="Is the backwards compatibility and refactoring of task context handled?"></topic> + </topic> + <topic href="Mylyn/FAQ/Java-Development.html" label="Java Development"> + <topic href="Mylyn/FAQ/Java-Development.html#Content_assist_troubleshooting" label="Content assist troubleshooting"></topic> + <topic href="Mylyn/FAQ/Java-Development.html#Why_do_interesting_elements_not_show_in_the_Project_Explorer.3F" label="Why do interesting elements not show in the Project Explorer?"></topic> + <topic href="Mylyn/FAQ/Java-Development.html#How_do_I_stop_declarations_from_showing_in_the_Package_Explorer.3F" label="How do I stop declarations from showing in the Package Explorer?"></topic> + <topic href="Mylyn/FAQ/Java-Development.html#Why_does_nothing_show_up_in_the_Active_Search_or_Active_Hierarchy.3F" label="Why does nothing show up in the Active Search or Active Hierarchy?"></topic> + <topic href="Mylyn/FAQ/Java-Development.html#Known_limitations_5" label="Known limitations"></topic> + </topic> + <topic href="Mylyn/FAQ/Team-Support.html" label="Team Support"> + <topic href="Mylyn/FAQ/Team-Support.html#My_change_set_is_missing_or_doesn.E2.80.99t_contain_elements_it_should._Help.21" label="My change set is missing or doesn’t contain elements it should. Help!"></topic> + <topic href="Mylyn/FAQ/Team-Support.html#Why_does_task_change_set_not_appear_when_I_modify_files.3F" label="Why does task change set not appear when I modify files?"></topic> + <topic href="Mylyn/FAQ/Team-Support.html#Why_do_files_disappear_from_the_change_set_when_I_close_them.3F" label="Why do files disappear from the change set when I close them?"></topic> + <topic href="Mylyn/FAQ/Team-Support.html#Why_am_I_missing_elements_when_I_retrieve_someone_else.E2.80.99s_context.3F" label="Why am I missing elements when I retrieve someone else’s context?"></topic> + </topic> + <topic href="Mylyn/FAQ/WikiText.html" label="WikiText"> + <topic href="Mylyn/FAQ/WikiText.html#What_is_WikiText.3F" label="What is WikiText?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#Where_can_I_get_WikiText.3F" label="Where can I get WikiText?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#How_does_WikiText_integrate_with_Mylyn.3F" label="How does WikiText integrate with Mylyn?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#How_do_I_enable.2Fdisable_WikiText_extensions_to_Mylyn.3F" label="How do I enable/disable WikiText extensions to Mylyn?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#Where_can_I_find_WikiText_documentation.3F" label="Where can I find WikiText documentation?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#How_do_I_run_the_WikiText_Ant_tasks.3F" label="How do I run the WikiText Ant tasks?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#Can_I_use_WikiText_without_Eclipse.3F" label="Can I use WikiText without Eclipse?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#What_output_can_WikiText_create.3F" label="What output can WikiText create?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#What_wiki_markup_languages_does_WikiText_support.3F" label="What wiki markup languages does WikiText support?"></topic> + <topic href="Mylyn/FAQ/WikiText.html#Where_can_I_find_out_more_about_WikiText.3F" label="Where can I find out more about WikiText?"></topic> + </topic> + <topic href="Mylyn/FAQ/Integration-with-other-tools.html" label="Integration with other tools"> + <topic href="Mylyn/FAQ/Integration-with-other-tools.html#Using_Mylyn_with_WTP" label="Using Mylyn with WTP"></topic> + <topic href="Mylyn/FAQ/Integration-with-other-tools.html#External_builders" label="External builders"></topic> + </topic> + <topic href="Mylyn/FAQ/Misc.html" label="Misc"> + <topic href="Mylyn/FAQ/Misc.html#Performance" label="Performance"> + <topic href="Mylyn/FAQ/Misc.html#Retrieval_of_repository_configuration" label="Retrieval of repository configuration"></topic> + </topic> + <topic href="Mylyn/FAQ/Misc.html#Command_Line" label="Command Line"></topic> + <topic href="Mylyn/FAQ/Misc.html#System_Properties" label="System Properties"></topic> + <topic href="Mylyn/FAQ/Misc.html#How_do_I_enable_debugging_output_for_network_communications.3F" label="How do I enable debugging output for network communications?"></topic> + <topic href="Mylyn/FAQ/Misc.html#How_do_I_enable_debugging_output_for_plug-ins.3F" label="How do I enable debugging output for plug-ins?"></topic> + <topic href="Mylyn/FAQ/Misc.html#Which_usage_monitoring_framework_should_I_use.3F" label="Which usage monitoring framework should I use?"></topic> + <topic href="Mylyn/FAQ/Misc.html#How_does_Mylyn_relate_to_IBM.E2.80.99s_Jazz.3F" label="How does Mylyn relate to IBM’s Jazz?"></topic> + </topic> + <topic href="Mylyn/FAQ/Updating-This-Document.html" label="Updating This Document"></topic> +</toc>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn-User-Guide-toc.xml b/org.eclipse.mylyn.help.ui/Mylyn-User-Guide-toc.xml new file mode 100644 index 000000000..9cfe1e2eb --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn-User-Guide-toc.xml @@ -0,0 +1,56 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="Mylyn/User_Guide/User-Guide.html" label="Mylyn User Guide"> + <topic href="Mylyn/User_Guide/User-Guide.html" label="Task List"> + <topic href="Mylyn/User_Guide/User-Guide.html#Task_List_Presentation" label="Task List Presentation"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Icon_Legend_and_Color_Coding" label="Icon Legend and Color Coding"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Creating_new_Tasks" label="Creating new Tasks"> + <topic href="Mylyn/User_Guide/User-Guide.html#Local_Tasks" label="Local Tasks"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Repository_Tasks" label="Repository Tasks"></topic> + </topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Creating_new_Queries" label="Creating new Queries"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Scheduling" label="Scheduling"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Synchronization" label="Synchronization"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Incoming_Changes" label="Incoming Changes"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Reviewing_Tasks" label="Reviewing Tasks"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Task_Progress_Indicators" label="Task Progress Indicators"></topic> + <topic href="Mylyn/User_Guide/User-Guide.html#Task_List_Settings_and_Operations" label="Task List Settings and Operations"></topic> + </topic> + <topic href="Mylyn/User_Guide/Task-Repositories.html" label="Task Repositories"></topic> + <topic href="Mylyn/User_Guide/Task-Editor.html" label="Task Editor"> + <topic href="Mylyn/User_Guide/Task-Editor.html#Repository_Task_Details" label="Repository Task Details"></topic> + <topic href="Mylyn/User_Guide/Task-Editor.html#Context" label="Context"></topic> + <topic href="Mylyn/User_Guide/Task-Editor.html#Planning" label="Planning"></topic> + </topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html" label="Task-Focused Interface"> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Focusing_Navigator_Views" label="Focusing Navigator Views"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Alt.2BClick_Navigation" label="Alt+Click Navigation"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Focusing_Editors" label="Focusing Editors"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Task-focused_Ordering" label="Task-focused Ordering"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Working_Set_Integration" label="Working Set Integration"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Open_Task_dialog" label="Open Task dialog"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Task_Hyperlinking" label="Task Hyperlinking"></topic> + <topic href="Mylyn/User_Guide/Task-Focused-Interface.html#Reporting_Bugs_from_the_Error_Log" label="Reporting Bugs from the Error Log"></topic> + </topic> + <topic href="Mylyn/User_Guide/Team-Support.html" label="Team Support"> + <topic href="Mylyn/User_Guide/Team-Support.html#Task-focused_Change_Sets" label="Task-focused Change Sets"></topic> + <topic href="Mylyn/User_Guide/Team-Support.html#Automatic_Commit_Messages" label="Automatic Commit Messages"></topic> + <topic href="Mylyn/User_Guide/Team-Support.html#Working_with_Patches" label="Working with Patches"></topic> + </topic> + <topic href="Mylyn/User_Guide/Shortcuts.html" label="Shortcuts"></topic> + <topic href="Mylyn/User_Guide/Preferences.html" label="Preferences"> + <topic href="Mylyn/User_Guide/Preferences.html#Tasks" label="Tasks"></topic> + <topic href="Mylyn/User_Guide/Preferences.html#Context_2" label="Context"></topic> + <topic href="Mylyn/User_Guide/Preferences.html#Resources" label="Resources"></topic> + <topic href="Mylyn/User_Guide/Preferences.html#Team" label="Team"></topic> + <topic href="Mylyn/User_Guide/Preferences.html#Shortcuts_2" label="Shortcuts"></topic> + </topic> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html" label="Task Repository Connectors"> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html#Bugzilla_Connector" label="Bugzilla Connector"></topic> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html#Trac_Connector" label="Trac Connector"></topic> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html#JIRA_Connector" label="JIRA Connector"></topic> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html#Generic_Web_Templates_Connector" label="Generic Web Templates Connector"></topic> + <topic href="Mylyn/User_Guide/Task-Repository-Connectors.html#XPlanner_Connector" label="XPlanner Connector"></topic> + <anchor id="additions-repository-connectors"/> + </topic> + <topic href="Mylyn/User_Guide/Updating-This-Document.html" label="Updating This Document"></topic> +</toc>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Bugzilla-Connector.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Bugzilla-Connector.html new file mode 100644 index 000000000..c1059f320 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Bugzilla-Connector.html @@ -0,0 +1,217 @@ +<?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 FAQ - Bugzilla Connector</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">Bugzilla Connector</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Repositories.html" title="Task Repositories"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="JIRA-Connector.html" title="JIRA Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task Repositories</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">JIRA Connector</td> + </tr> + </table><hr/> + <h1 id="Bugzilla_Connector">Bugzilla Connector</h1> + <h2 id="What_versions_are_supported.3F">What versions are supported?</h2> + <ul> + <li>We + <b>recommend</b> using the latest + <a href="http://www.bugzilla.org/download/" target="mylyn_external">release</a> of Bugzilla (3.4.x). + </li> + </ul> + <ul> + <li>Bugzilla 3.0.9 and higher is + <b>officially supported</b>. + </li> + </ul> + <ul> + <li>Bugzilla 2.18.6 is the lowest version of Bugzilla the connector is + <b>known to work with</b>. If you are getting errors that indicate failure to update attributes this may be due to use of an older Bugzilla. + </li> + </ul> + <ul> + <li>If you are using + <b>Bugzilla 2.18</b> and are getting + <b>mid-air collisions</b> this is likely due to incorrectly formatted timestamp field in the underlying bugs database table ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=149513" target="mylyn_external">bug 149513</a>). This can be resolved by upgrading to a more recent release of Bugzilla server. + </li> + </ul> + <h3 id="Tips_for_server_administrators">Tips for server administrators</h3> + <p>Mylyn periodically checks config.cgi to retrieve the repository configuration. + On Eclipse.org this resulted in heavy CPU Load for the regeneration and a big surge in band width use.</p> + <ul> + <li>This configuration seldom changes so can be cached and served from a file instead of being regenerated every time. While the size of this file tends to be small when hosting less than a dozen projects, it can be large on repositories holding large numbers of projects, e.g. 900K on bugs.eclipse.org.</li> + <li>Generated bugzilla output contains a lot of unnecessary whitespace which can be trimmed before caching. For bugs.eclipse.org this reduces the file to about <em>660K</em>.</li> + <li>The remaining file contains a lot of redundancy so can be gzipped for further reduction. On bugs.eclipse.org this leaves about + <i>28K</i>, a considerable saving. + </li> + </ul> + <p>Mylyn has been modified to accept gzip encoding on all requests, and will do content negotiation. See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=205708" target="mylyn_external">bug 205708</a>. + </p> + <p> + <b>To add caching for your Bugzilla repository:</b> + </p> + <ul> + <li>Change the name of config.cgi to config-stock.cgi and get the caching code in a new config.cgi.</li> + <li>The current version of this caching config.cgi script is hosted at:</li> + </ul> + <pre> via CVS: :pserver:anonymous@dev.eclipse.org:/cvsroot/technology/org.eclipse.phoenix/infra-scripts/bugzilla/ + or: http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.phoenix/infra-scripts/bugzilla/?root=Technology_Project +</pre> + <ul> + <li>Modifications on this script are followed on + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=205416" target="mylyn_external">bug 205416</a> + </li> + </ul> + <h2 id="Why_are_queries_failing.3F">Why are queries failing?</h2> + <ul> + <li>If + <b>queries are not working</b> correctly ensure that you have the right Bugzilla server version selected for the corresponding repository: + <i>Task Repositories (View) →</i> right+click the repository + <i>→ Properties</i>. For supported versions see the + <a href="http://www.eclipse.org/mylar/dl.php" target="mylyn_external">download page</a>. If the repository is still not functioning it may be due to authentication or connectivity problems. If that does not resolve the problem please post a message to the newsgroup or + <a href="http://www.eclipse.org/mylar/bugs.php" target="mylyn_external">submit a bug</a>. + </li> + </ul> + <h2 id="Why_do_I_see_my_old_username.3F">Why do I see my old username?</h2> + <p>If you change the username/email address on your Bugzilla account you may notice that some tasks still have the old username/email. Explicitly synchronize the task via the + <i>Task List</i> popup menu or + <i>Task Editor</i> toobar in order to update your username. + </p> + <h2 id="Why_do_tasks_fail_to_open.3F">Why do tasks fail to open?</h2> + <ul> + <li>If upon opening a bug, the Bugzilla tab only displays a warning “' + <i>Could not download task data, possibly due to timeout or connectivity problem. Please check connection and try again.</i>'”, ensure that your repository is returning XML data by pointing your browser to <code><your-repository-url>/show_bug.cgi?id=1&ctype=xml</code> to show the contents of bug 1 in XML form. The Bugzilla client requires that bugs be accessible in XML form. If the repository doesn’t support xml then it is likely that the repository is too old (Mylyn currently supports Bugzilla 2.18 and later). + </li> + </ul> + <ul> + <li>If + <b>reports fail to load</b> or + <b>reports fail to synchronize</b> (task description remains + <i>italic</i>), check the error log for a “' + <i>File not found</i>'” error pointing to <code>bugzilla.dtd</code> or a “' + <i>Failed to retrieve products from server</i>'” error message, these can result when + <ul> + <li>the <code>urlbase</code> parameter is not set on the bugzilla server</li> + <li>your <code>urlbase</code> parameter is incorrect, e.g. it contains <code>index.cgi</code></li> + <li>your bugzilla installation is missing the <code>bugzilla.dtd</code> file. See: + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=161759" target="mylyn_external">bug#161759</a> + </li> + </ul> + </li> + </ul> + <ul> + <li>If + <b>attributes are missing options</b> in the bug editor (ie. missing a recently added milestone, + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=155431" target="mylyn_external">bug# 155431</a>): + <ul> + <li>Update attributes by choosing + <i>Update Attributes</i> from the context menu in the + <i>Task Repositories</i> view + </li> + <li>Synchronize the task in the Task List</li> + <li>Reopen the task - new options should be available.</li> + </ul> + </li> + </ul> + <h2 id="Why_do_tasks_fail_to_submit.3F">Why do tasks fail to submit?</h2> + <ul> + <li> + <b>Error upon submit: unable to make any match for name/email entered.</b> If your bugzilla is configured for user names rather than full email address the QA Contact field will cause the submit to fail ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=166555" target="mylyn_external">bug# 166555</a>). To resolve, select ‘Local users enabled’ option on the Repository Configuration page. + </li> + </ul> + <ul> + <li>If tasks + <b>fail to submit</b> with credentials error, but the repository validates fine, make sure that you’ve correctly setup your account’s username and password and are not using the HTTP authentication fields instead. + </li> + </ul> + <ul> + <li>If tasks + <b>fail to submit</b> with credentials error, but the repository validates fine, make sure that you’ve correctly setup your bugzilla instance’s cookie domain under the required settings. The cookie domain must lead with a dot. + </li> + </ul> + <ul> + <li>If + <b>attachments are failing to submit</b> and you see that after processing the attachment, the bugzilla bug shows a size of “bytes” (no numbers), your database may be dropping the packet sending the file. + <b>On MySQL</b>, check the + <a href="http://dev.mysql.com/doc/refman/5.0/en/packet-too-large.html" target="mylyn_external">max_allowed_packet directive</a>. You may see errors like: <code>DBD::mysql::st execute</code> failed: Got a packet bigger than 'max_allowed_packet' bytes + <a href="for">Statement “INSERT INTO attach_data (id, thedata) VALUES (38, ?)”</a> at <code>/path/to/bugzilla/attachment.cgi</code> line 993. Also, + <b>check the maximum attachment size</b> in + <i>Bugzilla Parameters → Attachments</i>. + </li> + </ul> + <ul> + <li>If a submit fails with an + <b>Invalid Username or Password</b> error even though repository settings do validate, make sure that cookies could be set. See also + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=175502" target="mylyn_external">bug 175502</a> + </li> + </ul> + <h2 id="What_time_zone_is_used_in_the_task_editor.3F">What time zone is used in the task editor?</h2> + <ul> + <li>The + <b>times</b> that appear in the Bugzilla bug editor (ie. created, modified) + <b>are local to the server hosting the Bugzilla repository</b>, not your local machine’s time zone. + </li> + </ul> + <h2 id="Known_limitations">Known limitations</h2> + <ul> + <li>The <code>usermatchmode</code> is not currently supported ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=168204" target="mylyn_external">bug 168204</a>) and as such full email addresses need to be used. + </li> + </ul> + <ul> + <li>The <code>usevisibilitygroups</code> parameter is not supported ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=180876" target="mylyn_external">bug#180876</a>). Group assignment will currently be lost if updated using the Bugzilla rich task editor. + </li> + </ul> + <ul> + <li>Version 1.0 of Mylyn presents an error message upon new comment submission to Red Hat’s public Bugzilla repository. The comment is in fact posted. This issue is resolved in Mylyn 2.0M2 and higher. ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=183251" target="mylyn_external">bug#183251</a>) + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Repositories.html" title="Task Repositories"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="JIRA-Connector.html" title="JIRA Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task Repositories</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">JIRA Connector</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Context-and-Timing-data.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Context-and-Timing-data.html new file mode 100644 index 000000000..e42713504 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Context-and-Timing-data.html @@ -0,0 +1,72 @@ +<?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 FAQ - Context and Timing data</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">Context and Timing data</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Focused-UI.html" title="Task-Focused UI"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Java-Development.html" title="Java Development"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task-Focused UI</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Java Development</td> + </tr> + </table><hr/> + <h1 id="Context_and_Timing_data">Context and Timing data</h1> + <h2 id="How_do_I_prevent_code_checked_out_from_polluting_my_task_context.3F">How do I prevent code checked out from polluting my task context?</h2> + <p>When checking out a new project, you must first deactivate the active task. Otherwise all newly created files will become interesting. </p> + <h2 id="Why_do_I_see_strange_elapsed_times_on_my_Planning_tab.3F">Why do I see strange elapsed times on my Planning tab?</h2> + <p>Some platform/jvm combinations can fill with invalid timestamps. This is known to have happened on Mac OSX 10.4 with Java 1.5. See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=207419" target="mylyn_external">bug 207419</a>. + To resolve you can try and manually edit <workspace>/.metadata/.mylyn/contexts/activity.xml.zip. + </p> + <h2 id="Is_the_backwards_compatibility_and_refactoring_of_task_context_handled.3F">Is the backwards compatibility and refactoring of task context handled?</h2> + <ul> + <li>The Task List and Context Store are compatible across all currently-supported Eclipse versions. This means that you can use the same .mylyn data in both Eclipse 3.x. </li> + </ul> + <ul> + <li>If elements have been renamed they may not appear as interesting when the context is activated.</li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Focused-UI.html" title="Task-Focused UI"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Java-Development.html" title="Java Development"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task-Focused UI</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Java Development</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/FAQ.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/FAQ.html new file mode 100644 index 000000000..e0551bcd5 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/FAQ.html @@ -0,0 +1,71 @@ +<?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 FAQ</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">Mylyn FAQ</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/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="../../Mylyn/User_Guide/User-Guide.html" title="Mylyn/User Guide">Mylyn/User Guide</a>, + + <a href="http://eclipse.org/mylyn" target="mylyn_external">Mylyn Home</a>, + + <a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=Special:Userlogout" target="mylyn_external">Log in to edit</a> + </p> + <p>For instructions on + <a href="../../Mylyn/User_Guide/User-Guide.html#Download_Mylar" title="Mylyn/User_Guide#Download_Mylar">downloading</a> + <a href="../../Mylyn/User_Guide/User-Guide.html#Installation" title="Mylyn/User_Guide#Installation">installing</a> and + <a href="../../Mylyn/User_Guide/User-Guide.html#Configuration" title="Mylyn/User_Guide#Configuration">configuring</a> + Mylyn, see the + <a href="../../Mylyn/User_Guide/User-Guide.html" title="Mylyn/User Guide">Mylyn/User Guide</a>. For instructions on developing and contributing to Mylyn, see the + <a href="/wiki/Mylyn_Contributor_Reference" title="Mylyn Contributor Reference">Mylyn Contributor Reference</a>. + </p> + <h1 id="What_is_Mylyn.3F">What is Mylyn?</h1> + <p>For + <b>tutorials and articles on using Mylyn</b> refer to the + <b> + <a href="http://www.eclipse.org/mylyn/start/" target="mylyn_external">Get Started</a> + </b> page. + </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, JIRA, and + <a href="http://wiki.eclipse.org/index.php/Mylyn/Extensions" target="mylyn_external">others</a>). + </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 in 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><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/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>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html new file mode 100644 index 000000000..c33bd6499 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Installation.html @@ -0,0 +1,725 @@ +<?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 FAQ - 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="FAQ.html" title="Mylyn FAQ"> + <img alt="Previous" border="0" src="../../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/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Mylyn FAQ</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> + </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> + <h2 id="What_is_the_release_schedule.3F">What is the release schedule?</h2> + <ul> + <li>Weekly builds: available every Wednesday and on-demand (should be used by all Mylyn contributors not self-hosting from CVS + <a href="http://wiki.eclipse.org/index.php/Mylyn_Contributor_Reference#Self-hosting" target="mylyn_external">straight from CVS</a>) + </li> + <li>Release builds: see the + <a href="http://www.eclipse.org/projects/project-plan.php?projectid=tools.mylyn" target="mylyn_external">project plan</a> + </li> + </ul> + <h2 id="What_versions_of_Eclipse_are_supported.3F">What versions of Eclipse are supported?</h2> + <p>See the + <a href="http://eclipse.org/mylyn/dl.php" target="mylyn_external">download page</a>. + </p> + <p>Mylyn also relies on a web browser that works with the Standard Widget Toolkit; Windows and MacOS users are fine, but Linux users might have to download another browser. See + <a href="http://www.eclipse.org/swt/faq.php#browserlinux" target="mylyn_external">the SWT Browser guide</a> for which browsers will work. See + <a href="../../Mylyn/User_Guide/User-Guide.html#Installing_Browser_on_Linux" title="Mylyn/User_Guide#Installing_Browser_on_Linux">installing browser on Linux</a> for installation instructions. + </p> + <h2 id="What_version_of_Java_is_required.3F">What version of Java is required?</h2> + <p>Mylyn needs the + <b>Java 5</b> virtual machine. + </p> + <p>To check the version of the Java virtual machine that Eclipse was launched with to to + <i>Help → About Eclipse SDK → Configuration Details</i> and verify that the java.vm.version is 1.5. + </p> + <p>Mac users should refer to the last comment on + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=116347#c4" target="mylyn_external">bug 1163477</a> for instructions on how to change the 1.4 default. + </p> + <ul> + <li>If you do not have Java 5, you can download it from + <a href="http://72.5.124.55/javase/downloads/index.jsp" target="mylyn_external">Sun’s web site</a>. + </li> + <li>If you have more than one VM, you need to specify that Eclipse should use the JDK1.5 VM. </li> + </ul> + <p>In Unix, set the environment variable <code>JAVA_HOME</code> to the root of the JDK1.5 installation and/or set the <code>PATH</code> variable to put the JDK1.5 executable directory before any other VM executable directories. For example, under <code>bash</code> in Unix:</p> + <pre>export JAVA_HOME="''(location of JDK1.5 root)''" +export PATH=$JAVA_HOME/bin:$PATH +</pre> + <p><b>We do + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=140955" target="mylyn_external">not recommend</a> using JDK 1.6 on Eclipse 3.1.</b> (It works fine with Eclipse 3.2 or 3.3.) To use JDK 1.6 on Eclipse 3.1, you must add the following line to your <code>config.ini</code>file: + </p> + <pre>org.osgi.framework.executionenvironment=OSGi/Minimum-1.0,OSGi/Minimum-1.1,JRE-1.1,J2SE-1.2, +J2SE-1.3,J2SE-1.4,J2SE-1.5,JavaSE-1.6 +</pre> + <h2 id="What_version_of_Mylyn_is_distributed_with_the_Eclipse_downloads.3F">What version of Mylyn is distributed with the Eclipse downloads?</h2> + <p>The + <a href="http://www.eclipse.org/downloads/" target="mylyn_external">default Eclipse downloads</a> contain the following Mylyn redistributions. Since the redistributed versions can be missing important bug fixes or feature additions, we recommend using the + <a href="http://www.eclipse.org/mylyn/downloads" target="mylyn_external">latest version of Mylyn</a>. + </p> + <ul> + <li>Eclipse IDE for Java Developers: all of Mylyn except Team integration (e.g. automatic change sets) integration. Install the Eclipse CVS integration and then install the latest Mylyn build to get this component.</li> + </ul> + <ul> + <li>Eclipse IDE for Java EE Developers: all of Mylyn redistribution, install manually</li> + </ul> + <ul> + <li>Eclipse IDE for C/C++ Developers: no Mylyn redistribution, install manually</li> + </ul> + <ul> + <li>Eclipse for RCP/Plug-in Developers: all of Mylyn redistributed</li> + </ul> + <ul> + <li>Eclipse Classic: no Mylyn redistribution, install manually</li> + </ul> + <h2 id="My_tasks_or_queries_disappeared.2C_what_do_I_do.3F">My tasks or queries disappeared, what do I do?</h2> + <p>This happens if Mylyn failed to install. First ensure that you have a correct install by following the instructions in the next section. After that, if you still do not see your tasks use the + <i>Task List</i> view menu → + <i>Restore Tasks From History…</i> command (also available via + <i>File → Import → Task List</i>. + </p> + <h2 id="General_Installation_Troubleshooting">General Installation Troubleshooting</h2> + <p> + <b>I’m being asked to restart Eclipse, should I?</b> + Upon installing you will get a dialog box asking if you would like to restart Eclipse. We recommend that you select + <i>Yes</i>. + </p> + <p> + <b>I’ve installed Mylyn ; why can’t I see anything different?</b> + </p> + <p>The two most likely possibilities are:</p> + <ol> + <li>You don’t have any Mylyn views open. Select + <i>Window → Show View → Other</i>, then select + <i>Mylyn</i> and you should see the available Mylyn Views. + </li> + <li>If you still don’t see anything, then perhaps you aren’t using the JDK1.5 VM (or later). See + <a href="/wiki/Mylyn_Installation_Guide#Download_and_configure_Java" title="Mylyn_Installation_Guide#Download_and_configure_Java">configuring Java</a>. + </li> + </ol> + <p> + <b>What does “<code>Root exception: java.lang.UnsupportedClassVersionError: org/eclipse/mylar/tasklist/MylarTasklistPlugin (Unsupported major.minor version 49.0)</code>” mean?</b> + </p> + <p>It probably means that the virtual machine is JDK1.4 or lower. See + <a href="/wiki/Mylyn_Installation_Guide#Download_and_configure_Java" title="Mylyn_Installation_Guide#Download_and_configure_Java">download and configure Java</a>. + </p> + <p> + <b>What does “Could not create Browser page: No more handles (<code>java.lang.UnsatisfiedLinkError: …</code>)” mean?</b> + </p> + <p>It probably means that you are running Linux and don’t have Eclipse and a Web browser configured to work together. See + <a href="../../Mylyn/User_Guide/User-Guide.html#Installing_Browser_on_Linux" title="Mylyn/User_Guide#Installing_Browser_on_Linux">installing a browser on Linux</a>. + </p> + <p> + <b>What does “Could not create Bugzilla editor input” and “<code>java.io.IOException</code>: SAX2 driver class <code>org.apache.xerces.parsers.SAXParser</code> not found” mean?</b> + </p> + <p>It probably means that you are on MacOS, and for some reason are missing Xerces from the Mac JDK1.5. You will probably 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" target="mylyn_external">bug 144287</a> if you see this problem. + </p> + <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" target="mylyn_external">bug 1163477</a> for instructions on how to change the 1.4 default. + </p> + <p> + <i>' Startup warnings</i>' + </p> + <p>If you see startup errors or warnings such as <code>BundleException</code> or timeout messages restart Eclipse with the <code>-clean</code> flag either on the command line, in your shortcut link, or by temporarily it into the <code>eclipse/eclipse.ini</code> file. These warnings do not cause any bad behavior, but this bug has been fixed in all Mylyn builds after 2.1. The warnings have this form:</p> + <pre> !MESSAGE While loading class "org.eclipse.mylar.tasks.ui.TasksUiPlugin", thread "Thread + [main,6,main]" timed out waiting (5000ms) for thread "Thread[Worker-3,5,main]" to finish + starting bundle "update@plugins/org.eclipse.mylar.tasks.ui_2.0.0.v20070514-1800.jar [809]". + To avoid deadlock, thread "Thread[main,6,main]" is proceeding but + "org.eclipse.mylar.tasks.ui.TasksUiPlugin" may not be fully initialized. +</pre> + <h2 id="Installation_Troubleshooting_on_Eclipse_3.4_and_later">Installation Troubleshooting on Eclipse 3.4 and later</h2> + <p>Ensure that all required update sites are enabled under Help > Software Updates > Available Software > Manage Sites:</p> + <ul> + <li> + <a href="http://download.eclipse.org/tools/mylyn/update/e3.4" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/e3.4</a> + </li> + <li> + <a href="http://download.eclipse.org/tools/mylyn/update/extras" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/extras</a> + </li> + <li> + <a href="http://download.eclipse.org/tools/mylyn/update/incubator" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/incubator</a> + </li> + </ul> + <p>Then follow these steps:</p> + <ol> + <li>Use Help > Software Update > Update to ensure that the latest version of all features is installed</li> + <li>Install again</li> + <li>If Install fails with a "No repository found containing..." message, remove and re-add the update site that hosts the feature for which the download is failing</li> + <li>Install again</li> + <li>If the update fails with a "Cannot complete the request..." message, uninstall Mylyn and all Mylyn dependencies</li> + <li>Install again</li> + </ol> + <h3 id="Why_does_the_installation_fail_with_.27.27No_repository_found.27.27.3F">Why does the installation fail with ''No repository found''?</h3> + <p>The message indicates that the Eclipse provisioning system P2 has found meta data to install a plug-in but can not locate an artifact repository that provides the required downloads. To recover please remove the Mylyn update sites under + <i>Help → Software Updates… → Available Software → Manage Sites</i>. Then re-add the sites which will refresh the meta data and artifacts available on the update sites. + </p> + <p>Also see steps under + <a href="Installation.html#Installation_Troubleshooting_on_Eclipse_3.4_and_later">Installation Troubleshooting on Eclipse 3.4 and later</a>. + </p> + <h3 id="Why_does_update_fail_with_.27.27Cannot_complete_the_request.27.27.3F">Why does update fail with ''Cannot complete the request''?</h3> + <p>If any of the installed features have unsatisfied dependencies or if features where previously installed from the extras or incubator update site P2 may fail with an error similar to the ones below. Try these steps to recover:</p> + <ol> + <li>Ensure that the Mylyn for Eclipse 3.4 and Mylyn Extras sites are enabled in Software Updates > Available Software > Manage Sites</li> + <li>Select Update from Software Updates > Installed Software</li> + <li>Retry the installation</li> + </ol> + <pre style="overflow:scroll"> + Cannot complete the request. See the details. + Mylyn Focused UI (Recommended) is already installed, so an update will be performed instead. + Mylyn Task List (Required) is already installed, so an update will be performed instead. + Mylyn Bridge: Eclipse IDE is already installed, so an update will be performed instead. + Mylyn Bridge: Java Development is already installed, so an update will be performed instead. + Mylyn Bridge: Plug-in Development is already installed, so an update will be performed instead. + Mylyn Bridge: Team Support is already installed, so an update will be performed instead. + Mylyn Connector: Bugzilla is already installed, so an update will be performed instead. + Cannot find a solution where both Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.mylyn.monitor.ui/[3.0.3.v20081015-1500 -e3x,3.0.3.v20081015-1500-e3x]] and Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.mylyn.monitor.ui/[3.0.1.v20080721-2100-e3x,3.0.1.v20080721-2100-e3x]]can be satisfied. + […] +</pre> + <pre>Cannot find a solution satisfying the following requirements org.eclipse.ui [3.4.2.M20090204-0800]. +</pre> + <p>Also see steps under + <a href="Installation.html#Installation_Troubleshooting_on_Eclipse_3.4_and_later">Installation Troubleshooting on Eclipse 3.4 and later</a>. + </p> + <h2 id="Installation_Troubleshooting_on_Eclipse_3.3_and_earlier">Installation Troubleshooting on Eclipse 3.3 and earlier</h2> + <p> + <i>' Update failures '</i> + </p> + <p>First, try running the update again via + <i>Help → Software Updates → Search for new features…</i> and ensure that all of the Mylyn features have been updated. + </p> + <p>On Eclipse versions earlier than 3.3 (final) use + <b>only the “Search for new features…”</b> option when updating Mylyn. If you use “Search for updates…” the Update Manager will allow a partial install that can cause Mylyn to fail to start, and you will need to run update again. See the + <i>feature configuration problem</i> section below for details. If you encounter this problemm consider voting for Platform + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=132450" target="mylyn_external">bug 132450</a>. + </p> + <p>If you have + <b>updated your Eclipse 3.3 to an Eclipse 3.4 milestone</b>, you will not be able to update the 3.3 copy, because Mylyn has two separate downloads for Eclipse 3.3 and 3.4. Also, not all of the 3.3 version of Mylyn will work in Eclipse 3.4. Install the latest 3.4 version from: + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">http://www.eclipse.org/mylyn/downloads/</a> + </p> + <p> + <i>' Java Persistence API Tools error when updating the JEE Eclipse Package '</i> + </p> + <p>If you are trying to install additional features and get this error you have hit + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=194959" target="mylyn_external">bug 194959</a> which should be resolved soon. The work-around is to check off the + <i>Europa Discovery Site</i> and install the first two components of the + <i>Data Tools Platform</i>. + </p> + <p> + <b>Subclipse related problems</b> + </p> + <p>If you see the following message:</p> + <pre> Subclipse Mylyar Integration (1.0.1) requires plug-in "org.eclipse.mylar.tasks.core (0.9.2)", + or later version +</pre> + <p>You need to uninstall the old (pre 2.0) version of Subclipse and Mylar integration. Most users should not need to do this since the old Mylar 1.x version disabled itself after the update to 2.0. But if you see this error uninstall via: </p> + <ul> + <li>Help → Software Updates → Manage Configuration</li> + <li>Uninstall the Subclipse Mylar Integration (1.0.1)</li> + <li>Uninstall the old version of Mylar</li> + </ul> + <p> + <i>' Incompatible VM (e.g. JDK 1.4) '</i> + </p> + <p>If you are using the wrong VM, you’ll see errors like the following in your log file. </p> + <pre>Root exception: java.lang.UnsupportedClassVersionError: +org/eclipse/mylar/tasklist/MylarTasklistPlugin (Unsupported major.minor version 49.0) +</pre> + <p>See + <a href="Installation.html#What_version_of_Java_is_required.3F">Configure Java</a> to fix this problem. + </p> + <p> + <i>' Incompatible version of Eclipse '</i> + </p> + <p>Separate versions and update sites exist + <a href="http://eclipse.org/mylyn/dl.php" target="mylyn_external">for Eclipse 3.1 and 3.2</a>), in which case you may see errors like the following in your <code><workspace>/.metadata/.log </code>file or in a Mylyn view: + </p> + <pre>java.lang.NoSuchMethodError: org.eclipse.ui.internal.dialogs.FilteredTree.getFilterControl() +The activator org.eclipse.mylar.java.MylarJavaPlugin for bundle org.eclipse.mylar.java is invalid +</pre> + <p> + <i>' Mylyn feature configuration problem '</i> + </p> + <p>If the above do not address the issue, the easiest thing to do is uninstall any old versions and update to the latest Mylyn. Your tasks won’t be lost, because by default they are stored in the <code><workspace>/.metadata/.mylyn</code> folder which will be read next time Mylyn starts correctly. </p> + <ul> + <li>First, uninstall the old version of Mylyn using + <i>Help → Software Updates → Manage Configuration</i>. + </li> + <li>You need to Disable all Mylyn features by right-clicking them.</li> + <li>Allow Eclipse to restart after the last is disabled.</li> + <li>After restart, ensure that the 3rd toolbar button is pressed (figure below) so that you see the disabled features to uninstall.</li> + <li>Uninstall all the disabled features using the popup menu. </li> + </ul> + <p>If you don’t uninstall, the the Update Manager will think that you have the latest and tell you that there are no updates. </p> + <p><b>Note: manually removing the plug-ins and features can lead to configuration errors.</b> </p> + <p>After uninstalling, update Eclipse by adding the correct update site specified at on the + <a href="http://eclipse.org/mylar/dl.php" target="mylyn_external">download page</a>, and after that automatically or manually updating will install the correct version. + </p> + <p> + <img border="0" src="images/mylar-eclipse-manage-configuration.gif"/> + </p> + <p> + <b>What do I need to do in installation to be able to use Mylyn task management features with bug/task/issue trackers?</b> + </p> + <p>When you install, make sure that you select a connector for your bug/task/issue tracking software. For example, to use Bugzilla, you have to install the Bugzilla connector component.</p> + <p> + <b>What does the error “Network connection problems encountered during search” mean?</b> + </p> + <p>If you get that message while trying to download Mylyn, it means that Eclipse couldn’t find the location you entered. This might be because you copied something incorrectly (watch for extra characters -- even extra spaces can cause errors), or because the site went down. You may be able to see if the site is up or down by copying the URL into your Web browser.</p> + <p> + <i>'What does the “Update manager failure” message mean? '</i> + </p> + <p>It means that Eclipse could not access the update site, or that it got confused about the configuration state of your Eclipse. First try updating again to see if the update site is accessible. </p> + <p>If you are trying to update the JIRA connector you can also try de-selecting that feature in case the <code>Tigris.org</code> update site is not accessible. Using + <i>Search for new features to install…</i> when installing can help to avoid this problem. If that does not work see the feature configuration troubleshooting below. + </p> + <p> + <b>Why am I getting messages in my <code><workspace>/.metadata/.log</code> or my Mylyn view that say things like “<code>java.lang.NoSuchMethodError: org.eclipse.ui.internal.dialogs.FilteredTree.getFilterControl()</code>” and “The activator <code>org.eclipse.mylar.java.MylarJavaPlugin</code> for bundle <code>org.eclipse.mylar.java</code> is invalid”?</b> + </p> + <p>This probably means that your Mylyn download version didn’t match your Eclipse download version. Note that + <a href="http://eclipse.org/mylar/dl.php" target="mylyn_external">the download site</a> has different downloads for Eclipse 3.1 and Eclipse 3.2. + </p> + <p>To fix this problem, see the + <a href="/wiki/Mylyn_Uninstallation_Guide" title="Mylyn_Uninstallation_Guide">uninstallation guide</a>, then re-install from + <a href="http://eclipse.org/mylar/dl.php" target="mylyn_external">the correct download site</a>. + </p> + <p> + <b>Why am I getting messages in my <code><workspace>/.metadata/.log</code> or my Mylyn view that say things like “<code>java.lang.NoSuchMethodError: org.eclipse.mylyn.internal.context.core.InteractionContextManager.getScalingFactors()</code>”?</b> + </p> + <p>This could mean that some of your Mylyn plugins are on different versions. Use the update manager (“''Search for new features to install…''”) to obtain the latest versions of the Mylyn features.</p> + <p> + <b>Why doesn’t the Eclipse Update Manager display the latest versions of the Mylyn features?</b> + </p> + <p>It does. Note, however, that if you select both the Mylyn site and the Weekly Builds site, using “''Search for new features to install…''”, you must uncheck the “''Show the latest version of a feature only''” checkbox in order to see the updates available on both sites.</p> + <p> + <b>I’ve just updated to Mylyn 2.0 and I don’t see any tasks in my Task List</b> + </p> + <p>As part of the update to Mylyn 2.0 the old data folder has been migrated to <workspace folder>/.metadata/.mylyn from the old location <workspace folder>/.mylar. IF for some reason migration failed (.mylar folder still exists), simply shut down Eclipse and manually move your old <workspace folder>/.mylar folder to <workspace folder>/.metadata/.mylyn (note the name change to .mylyn)</p> + <p> + <b>Error: Network connection problems encountered during search</b> + Eclipse couldn’t find the location you entered. This might be because you copied something incorrectly (watch for extra characters -- even extra spaces can cause errors), or because the site went down. You might be able to see if the site is down by copying the URL into your Web browser. + </p> + <p> + <b>Error: Update manager failure</b> + Eclipse could not access the update site, or that it got confused about the configuration state of your Eclipse. First try updating again to see if the update site 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 + <i>Search for new features…</i> when installing can help to avoid this problem. You will probably get a warning that + <b>the feature is unsigned</b>. If you trust that hackers have not befouled the Mylyn plug-in, select + <i>Install All</i>. + </p> + <h2 id="Why_can.27t_I_update_Mylyn_3.0_to_a_newer_release.3F">Why can't I update Mylyn 3.0 to a newer release?</h2> + <p>The update site link in the 3.0 and 3.0.1 features for Eclipse 3.3 points to the Mylyn for Eclipse 3.4 update site ({{bug|244618}}). An attempt to update will result in an error: “Mylyn Task List (Required) (3.0.1.v20080721-2100-e3x) requires plug-in "org.eclipse.ui (3.4.0.I20070918)", or later version.”</p> + <p>To resolve the error follow these steps:</p> + <ol> + <li>Open update + <b>Help → Software Updates → Find and Install…</b> + </li> + <li>Select + <b>Search for new features…</b> and + <b>Next</b> + </li> + <li> + <b>Uncheck Mylyn</b>. Add a + <b>New Remote Site</b>: + <ul> + <li>Name: + <b>Mylyn for Eclipse 3.3</b> + </li> + <li>URL: + <b> + <a href="http://download.eclipse.org/tools/mylyn/update/e3.3" target="mylyn_external">http://download.eclipse.org/tools/mylyn/update/e3.3</a> + </b>. + </li> + </ul> + </li> + </ol> + <p>Make sure the new site is selected and select Finish to proceed with the update.</p> + <h2 id="Installing_on_Linux">Installing on Linux</h2> + <h3 id="How_can_I_get_the_SWT_internal_browser_to_work_under_Linux.3F">How can I get the SWT internal browser to work under Linux?</h3> + <p>Mylyn uses the Standard Widget Toolkit Browser, and users have experienced problems with the SWT Browser on Linux. This is not a Mylyn specific problem and also occurs if you try to use Eclipse’s Browser view. To test to see if your browser is properly configured, select + <i>Window → Show View → Other → General → Internal Web Browser</i>, then try to load a web page. If the internal browser is problematic, consider enabling the external default browser (i.e. Firefox) via + <i>Window → Preferences → General → Web Browser</i> and select the + <b>Use external Web browser</b> option. + </p> + <h3 id="I.E2.80.99m_getting_a_.E2.80.9CCould_not_create_Browser_page:_No_more_handles.E2.80.9D_error">I’m getting a “Could not create Browser page: No more handles” error</h3> + <p>When the Browser is not properly configured exceptions such such as “Could not create Browser page: No more handles (<code>java.lang.UnsatisfiedLinkError: …</code>)” will appear when attempting to open tasks. See + <a href="http://www.eclipse.org/swt/faq.php#browserlinux" target="mylyn_external">the SWT Browser guide</a> for which browsers will work. + </p> + <h3 id="I.E2.80.99m_having_unstable_performance_on_Linux_with_a_Sun_JVM_are_there_options.3F">I’m having unstable performance on Linux with a Sun JVM are there options?</h3> + <p>For those experiencing unstable performance with Linux using the Sun JVM, try the + <a href="http://www-128.ibm.com/developerworks/java/jdk/linux/download.html" target="mylyn_external">IBM JVM</a>, which will require you to register with IBM prior to download. We’ve also had good reports from those using JRockit JVM. + </p> + <h3 id="Memory_consumption_problem_with_internal_browser_on_Linux-GTK">Memory consumption problem with internal browser on Linux-GTK</h3> + <p>If you are experiencing abnormal memory consumption upon launching the internal browser (or opening repository tasks), try shutting down eclipse, renaming/moving your <code>~/.mozilla/eclipse</code> folder and relaunching eclipse. (see + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=173782" target="mylyn_external">bug#172782</a>) + </p> + <h3 id="Error:_No_more_handles_error">Error: No more handles error</h3> + <pre>(java.lang.UnsatisfiedLinkError: no swt-mozilla-gtk-3449 or swt-mozilla-gtk in swt.library.path, java.library.path or the jar file) +</pre> + <p>To resolve this error install a package that provides the Gecko engine library. On Ubuntu and Debian the package is called libxul0d.</p> + <h3 id="Recommended_Settings_for_GTK">Recommended Settings for GTK</h3> + <p> + <a href="http://blog.xam.dk/archives/81-Making-Eclipse-look-good-on-Linux.html" target="mylyn_external">This article</a> describes how to improve the visual appearance of Eclipse on GTK. + </p> + <h3 id="Recommended_GTK_Setup_for_KDE">Recommended GTK Setup for KDE</h3> + <p>The recommended GTK theme to use for KDE (and KDE based distributions like Kubuntu) is the + “Human” theme. (Possibly, this is also a good recommendation for GNOME. GNOME users, please comment.)</p> + <p>With Debian based distributions (e.g. Ubuntu), this theme can be installed with</p> + <pre> aptitude install human-theme +</pre> + <p>The appearance of GTK applications is controlled by the KDE System Settings / Control Center + in the section “Appearance”.</p> + <dl> + <dt>GTK Styles and Fonts: GTK Styles: Select “Use another style + <a href="Human">Human</a>” + </dt> + </dl> + <dl> + <dt>Colors: At bottom: + <a href="x">x</a> Apply colors to non-KDE applications + </dt> + </dl> + <p>These changes are applied to these two GTK configuration files, respectively:</p> + <ul> + <li><tt>$HOME/.gtkrc-2.0-kde</tt></li> + <li><tt>$HOME/.kde/share/config/gtkrc-2.0</tt></li> + </ul> + <h3 id="Solving_issues_with_KDE_environment_variable_settings">Solving issues with KDE environment variable settings</h3> + <p>Most of the + <a href="Installation.html#Known_UI_issues_with_KDE">known UI issues below</a> are due to a broken environment variable setting. The environment variable <tt>GTK2_RC_FILES</tt> contains a search path to find the GTK configuration files to be used by the GTK application and can be checked with + </p> + <pre> env | grep GTK2_RC_FILES +</pre> + <p>The correct setting is obtained by</p> + <pre> export GTK2_RC_FILES=$HOME/.gtkrc-2.0-kde:$HOME/.kde/share/config/gtkrc-2.0 ''# Bourne shell'' + setenv GTK2_RC_FILES $HOME/.gtkrc-2.0-kde:$HOME/.kde/share/config/gtkrc-2.0 ''# C shell'' +</pre> + <p> + <b>Important note:</b> The used environment setting seems to differ depending on the way KDE starts + the application: from Konsole, using “Run Command…”, using a desktop icon etc. Please use this simple script to check the different ways: + </p> + <pre> #!/bin/bash + env | grep GTK2_RC_FILES >/tmp/GTK2_RC_FILES.env +</pre> + <p>and look at the resulting output in <tt>/tmp</tt>.</p> + <p>Consider filing a bug against the distribution showing this inconsistent behaviour.</p> + <h3 id="Known_UI_issues_with_KDE">Known UI issues with KDE</h3> + <p>There a couple of bugs related to UI features not working in specific Linux distributions:</p> + <ul> + <li> + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=176716" target="mylyn_external">176716: Task colors are not displayed</a> + </li> + <li> + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=173928" target="mylyn_external">173928: Task acivate button does not work under linux</a> + </li> + </ul> + <p>Debian 3.1 (sarge) with KDE and standard X11 installation (XFree86) works fine for all three issues.</p> + <p>Debian testing (etch) with KDE and new X11 installation (X.Org) has issues with the color display (bug 176716 and 135928), but the Task Activate button works.</p> + <p>Kubuntu Dapper 6.06 with KDE and X.Org triggers all above issues. An upgrade to Edgy enables Task Color display and the date picker selection. To get the Task Activation button working you have to use Edgy and Eclipse 3.3M5eh (or newer).</p> + <p>Kubuntu Gutsy 7.10 has issues with the color display (bug 176716). A workaround is to change the GTK-Style to “Human”. + More details and another solution in the comments of bug 176716.</p> + <h2 id="Installing_on_MacOS">Installing on MacOS</h2> + <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" target="mylyn_external">bug 144287</a> if you see this problem. + </p> + <pre> Could not create Bugzilla editor input + java.io.IOException: SAX2 driver class org.apache.xerces.parsers.SAXParser not found +</pre> + <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" target="mylyn_external">bug 1163477</a> for instructions on how to change the 1.4 default. + </p> + <h2 id="Configuration_Troubleshooting">Configuration Troubleshooting</h2> + <h3 id="The_default_Key_Mappings_aren.E2.80.99t_working_correctly.2C_what_can_I_do.3F">The default Key Mappings aren’t working correctly, what can I do?</h3> + <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> + <h4 id="Linux_key_mappings_a_problem.3F">Linux key mappings a problem?</h4> + <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 Center → 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 <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 & Frame</i> area, change the + <i>Modifier Key</i> option from <code>Alt</code> to <code>Meta</code>. + </li> + </ol> + <h3 id="How_do_I_enable_spell_checking_in_Eclipse_3.2_and_older.3F">How do I enable spell checking in Eclipse 3.2 and older?</h3> + <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" target="mylyn_external">here</a>. A word list is available + <a href="/wiki/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> + <h3 id="How_can_I_change_the_number_of_editors_left_open_before_Mylyn_starts_closing_editors.3F">How can I change the number of editors left open before Mylyn starts closing editors?</h3> + <p>Turn off or increase the number of editors to leave open using + <i>Preferences → General → Editors → Number of opened editors before closing</i>. Since Mylyn will manage the open editors with task activation, this number can be set higher or you can disable automatic closing entirely. + </p> + <h3 id="Do_I_need_the_Outline_View_when_running_Mylyn.3F">Do I need the Outline View when running Mylyn?</h3> + <p>No, not really. The Package Explorer and folded signatures should provide enough context for you. If, at some point, you really need to see an Outline View, you can always enter (Ctrl+O) to show the in-place Outline View.</p> + <h3 id="What_does_the_message_.E2.80.9Ccontent_assist_proposals_no_longer_appear.E2.80.9D_mean.3F">What does the message “content assist proposals no longer appear” mean?</h3> + <p>This usually happens when uninstalling when using Eclipse 3.2. Make sure that the “Java Completions” and “Java Types” proposal categories are included in the default proposals via: + <i>Preferences → Java → Editor → Content Assist → Advanced → Restore Defaults</i>. Also see: + <a href="/wiki/Mylyn_FAQ#Content_assist_troubleshooting" title="Mylyn FAQ#Content assist troubleshooting">content assist troubleshooting</a>. This + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=140416" target="mylyn_external">bug</a> has been fixed in Eclipse 3.2.1. + </p> + <h3 id="Why_do_I_get_errors_like_.E2.80.9CHTTP_Response_Code_407.E2.80.9D_or_.E2.80.9CProxy_Authentication_Error.E2.80.9D_when_accessing_repositories_through_a_proxy_server.3F">Why do I get errors like “HTTP Response Code 407” or “Proxy Authentication Error” when accessing repositories through a proxy server?</h3> + <p>It is likely that you need to configure these proxy server settings. Select + <i>Window → Preferences → General → Network Connections</i>, and update the section in the “Proxy settings” section of the form. + </p> + <h3 id="I_can.E2.80.99t_use_.3Ccode.3ECtrl.2BAlt.2BShift.2BArrow_Up.3C.2Fcode.3E_for.27.27_Mark_as_Landmark.27.27.__What_do_I_do.3F">I can’t use <code>Ctrl+Alt+Shift+Arrow Up</code> for'' Mark as Landmark''. What do I do?</h3> + <p>This is usually a Linux/GNOME problem, where the Gnome keyboard shortcuts are interfering with the Eclipse shortcuts. Go to the Keyboard shortcuts (which might be something like + <i>Desktop → Control Center → Keyboard Shortcuts</i> or + <i>System → Preferences → Keyboard Shortcuts</i>) and disable both of these shortcuts: + </p> + <ul> + <li>Move one workspace up</li> + <li>Move one workspace down</li> + </ul> + <p>See also: + <a href="../../Mylyn/User_Guide/User-Guide.html#Keyboard_mappings_on_Linux" title="Mylyn/User_Guide#Keyboard_mappings_on_Linux">keyboard mappings on Linux</a>. + </p> + <h3 id="How_do_I_turn_on_spell_checking.3F">How do I turn on spell checking?</h3> + <p>See + <a href="../../Mylyn/User_Guide/User-Guide.html#Spell_Checking" title="Mylyn/User_Guide#Spell_Checking">spell checking</a>. + </p> + <h3 id="Why_do_I_get_an_error_when_accessing_secured_web_sites.3F">Why do I get an error when accessing secured web sites?</h3> + <p>The internal browser may display an error if the web site certificate is not trusted and block access to the site:</p> + <pre>(Error code: sec_error_unknown_issuer) +</pre> + <p>On Linux start <code>firefox -profile ~/.mozilla/eclipse -no-remote</code> from the command line and open the web site in Mozilla Firefox. Add an exception for the web site and restart Eclipse. The site should now be accessible from Eclipse.</p> + <p> + <b>Notes</b> + </p> + <ol> + <li><code>-no-remote</code> is added because it would otherwise open a new window in the running process. You’re probably viewing this page in firefox, so the command above will not work without <code>-no-remote</code>.</li> + <li>Replace <code>firefox</code> by the exact command that you use to start your Mozilla browser.</li> + </ol> + <h2 id="Uninstall_troubleshooting">Uninstall troubleshooting</h2> + <p>We recommend + <b>uninstalling in Eclipse</b> via the + <i>Help → Software Updates → Manage Configuration</i> dialog. If you get an error message when trying to uninstall, you will need to first uninstall dependencies that use Mylyn. These include things like the Subclipse Mylyn integration and the Bugzilla Connector. + </p> + <p>You can also + <b>uninstall manually</b> by deleting all of the Mylyn plug-ins and features from the <code>eclipse/plugins</code> and <code>eclipse/features</code> directory make sure to delete all of the plug-ins and then restart Eclipse with the -clean option (e.g. by inserting it into a shortcut or the <code>eclipse.ini</code> file. + </p> + <p>On + <b>Eclipse 3.2:</b> if after uninstalling + <b>content assist proposals no longer appear</b> you need to ensure that the + <i>Java Completions</i> and + <i>Java Types</i> proposal categories are included in the default proposals via: + <i>Preferences → Java → Editor → Content Assist → Advanced → Restore Defaults</i>. Also see: + <a href="/wiki/Mylyn_FAQ#Content_assist_troubleshooting" title="Mylyn FAQ#Content assist troubleshooting">content assist troubleshooting</a>. This + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=140416" target="mylyn_external">bug</a> has been fixed in Eclipse 3.2.1. + </p> + <p>On + <b>Eclipse 3.1:</b> you may need to reset the Java editor to be default for <code>.java</code> again via: + <i>Preferences → General → Editors → File Associations</i> + </p> + <h2 id="Why_am_seeing_.3Ccode.3Ejava.lang.OutOfMemoryError:_PermGen_space.3C.2Fcode.3E_errors.3F">Why am seeing <code>java.lang.OutOfMemoryError: PermGen space</code> errors?</h2> + <p>If your Eclipse crashes, or you see the above error after installing Mylyn or other plug-ins, you have most likely hit the infamous MaxPermSize bug. This is not a Mylyn specific problem, but a general problem with the Sun Java VM that is often triggered on Eclipse 3.2 and later, if you have many plug-ins installed.</p> + <p>To fix it simply add the following to your launch arguments. This is usually to your shortcut:</p> + <pre> -vmargs -XX:MaxPermSize=128m +</pre> + <p>Or to the <tt>eclipse/configuration/config.ini</tt> file:</p> + <pre> -XX:MaxPermSize=128m +</pre> + <p>Note: For Eclipse 3.4 with the Equinox P2 profile-based provisioning support, this setting can also be modified in the current P2 profile. With a default installation of the SDK, see: </p> + <p>@config.dir/../p2/org.eclipse.equinox.p2.engine/profileRegistry/<name>.profile/<timestamp>.profile</p> + <p>For more information, see: + <a href="http://wiki.eclipse.org/Equinox_p2_Admin_UI_Users_Guide" target="mylyn_external">http://wiki.eclipse.org/Equinox_p2_Admin_UI_Users_Guide</a> + </p> + <p>If you are using a very large number of plug-ins (e.g. WTP) and still get this error you may need to increase the number to 256M. Note that on some VMs the size may need to be a power of 2 and may drop down to the default (e.g. 32M) if it is not accepted.</p> + <p>Eclipse 3.3.1 users: note note that due to Platform {{bug|203325}} you need to use the instructions above and cannot set the size using <code>-launcher.XXMaxPermSizeL</code>, which will be ignored.</p> + <p>For more information see the + <a href="/wiki/FAQ_How_do_I_increase_the_permgen_size_available_to_Eclipse?" title="FAQ How do I increase the permgen size available to Eclipse?">Eclispe FAQ entry</a>. Details of the problem are on + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=92250" target="mylyn_external">Platform bug 92250</a>. + </p> + <h2 id="What_is_Mylyn.E2.80.99s_performance_profile.3F">What is Mylyn’s performance profile?</h2> + <p>Mylyn should have + <b>no noticeable effect</b> on Eclipse’s speed or memory usage, no matter how large your workspace is. You do not need to increase the amount of memory Eclipse runs with to use Mylyn. Any performance issue should be + <a href="https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Mylyn" target="mylyn_external">reported as a bug</a>. + </p> + <p>The current + <b>performance profile</b> is: + </p> + <ol> + <li>Mylyn 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 Mylyn 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 Mylyn 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> + <p> + <b>If you are seeing performance problems, this is either a bug, or caused by other performance problems in other Eclipse plug-ins</b>'. If you are performance problems we suggest increasing the amount of memory available to Eclipse. This is especially useful for very large Java project workspaces, on which the size of JDT’s element cache will grow proportionally to the amount of available memory. The setting we recommend for launching workspaces with a couple hundred large projects is: + </p> + <pre> -Xmx768M -XX:MaxPermSize=128M +</pre> + <p> + <b>If you are seeing content assist timeouts</b> that indicate the Mylyn proposal computer did not complete quickly enough, note that the problem is not with Mylyn, but with the standard content assist mechanism timing out due to an intensive computation (eg, a large number of matches). In this scenario switching or + <a href="/wiki/Mylyn_FAQ#Content_assist_troubleshooting" title="Mylyn_FAQ#Content_assist_troubleshooting">disabling the Mylyn proposal computers</a> does not help improve performance, although it will get rid of those messages. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../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/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Mylyn FAQ</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/Mylyn/FAQ/Integration-with-other-tools.html index 713a9ef0b..5e4608064 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Integration-with-other-tools.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Integration-with-other-tools.html @@ -2,8 +2,8 @@ <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"/> + <title>Mylyn FAQ - 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"> @@ -12,32 +12,32 @@ </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 href="WikiText.html" title="WikiText"> + <img alt="Previous" border="0" src="../../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 href="Misc.html" title="Misc"> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Task Repository Connectors</td> + <td style="width: 20%" align="left" valign="top">WikiText</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Updating This Document</td> + <td style="width: 20%" align="right" valign="top">Misc</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> + <a href="/wiki/Mylyn/Extensions" title="Mylyn/Extensions">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>. + <a href="/wiki/Mylyn/Architecture" title="Mylyn/Architecture">Bridges</a> to integrate the context model with the structure and UI features of domain-specific tools. To create a Bridge, see + <a href="/wiki/Mylyn/Integrator_Reference#Creating_Bridges" title="Mylyn/Integrator_Reference#Creating_Bridges">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>, @@ -50,7 +50,7 @@ <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. + <a href="Integration_with_other_tools" title="Mylyn/FAQ#Integration_with_other_tools">"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 @@ -68,25 +68,25 @@ <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 href="WikiText.html" title="WikiText"> + <img alt="Previous" border="0" src="../../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 href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../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 href="Misc.html" title="Misc"> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Task Repository Connectors</td> + <td style="width: 20%" align="left" valign="top">WikiText</td> <td style="width: 60%" align="center"></td> - <td style="width: 20%" align="right" valign="top">Updating This Document</td> + <td style="width: 20%" align="right" valign="top">Misc</td> </tr> </table> </body> diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/JIRA-Connector.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/JIRA-Connector.html new file mode 100644 index 000000000..a29e9ad1f --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/JIRA-Connector.html @@ -0,0 +1,219 @@ +<?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 FAQ - JIRA Connector</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">JIRA Connector</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Bugzilla-Connector.html" title="Bugzilla Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Trac-Connector.html" title="Trac Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Bugzilla Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Trac Connector</td> + </tr> + </table><hr/> + <h1 id="JIRA_Connector">JIRA Connector</h1> + <p>If you see errors like the following, work around this by opening repository + <i>Properties Page</i> and clicking OK (bug + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=169102" target="mylyn_external">169102</a>). + </p> + <pre> org.tigris.jira.core.service.exceptions.AuthenticationException + at org.tigris.jira.internal.core.service.soap.SoapJiraService.getProjectsNoSchemes(SoapJiraService.java:204) +</pre> + <h2 id="Why_does_the_installation_fail_with_a_long_error_message.3F">Why does the installation fail with a long error message?</h2> + <p>If the error message indicates unsatisfied dependencies on Mylyn plug-ins, make sure that you have the main Mylyn update site enabled as well as the extras update site for the JIRA connector. The error message would look similar to this:</p> + <pre style="overflow:scroll"> + … + Cannot find a solution where both Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.swt/[3.4.1.v3449c,3.4.1.v3449c]] and Match[requiredCapability: org.eclipse.equinox.p2.iu/org.eclipse.swt/[3.4.0.v3448f,3.4.0.v3448f]] can be satisfied. + Unsatisfied dependency: [org.eclipse.mylyn.commons.soap 3.1.0.I20090109-0100-e3x] requiredCapability: osgi.bundle/org.eclipse.mylyn.commons.net/[3.1.0,4.0.0) +</pre> + <p>The update sites are listed on the + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">download page</a>. + </p> + <h2 id="What_are_the_server_requirements.3F">What are the server requirements?</h2> + <ul> + <li>JIRA 3.3.3 or higher (3.7 or higher for attachment support)</li> + <li>JIRA RPC plugin 1.4.3 or higher</li> + </ul> + <p>The + <b>JIRA SOAP/RPC services have to be running on the JIRA server</b> (set Administration → General Configuration → Accept remote API calls to ON in the JIRA web interface). + </p> + <p>Related Resources:</p> + <ul> + <li> + <a href="http://confluence.atlassian.com/display/JIRA/JIRA+Development+Hub" target="mylyn_external">Jira Development Wiki</a> + </li> + <li> + <a href="http://confluence.atlassian.com/pages/viewpage.action?pageId=1035" target="mylyn_external">Jira RPC Plugin Overview</a> + </li> + </ul> + <h2 id="Why_can.E2.80.99t_I_connect.3F">Why can’t I connect?</h2> + <ul> + <li>If you get a <code>org.tigris.jira.core.service.exceptions.ServiceUnavailableException</code> you need to turn on the JIRA SOAP/RPC services on the server.</li> + <li>Similarly, if you get a “Processing instructions are not allowed within SOAP messages” message, ensure that SOAP/RPC services are on.</li> + <li>If you get a + <b>503</b> error code verify that the SOAP/RPC interface is enabled. + </li> + <li>If you get a + <b>403</b> error code verify that the SOAP/RPC interface is enabled, and also check your authentication mechanism. If the server is using NTLM authentication, see + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=156397" target="mylyn_external">bug 156937</a> for diagnosis steps. + </li> + <li>If you see an + <b>“unrecognized priority” message</b> in the + <i>Error Log</i>, the problem is that the JIRA Connector does not support customized priorities so the priority value specified in that message will not correspond to the priority icons visible in the Task List. + </li> + <li>If you are being + <b>prompted for your log-in credentials</b> by the Browser tab of the task editor or the new task editor, this is because without rich editor support the connector is using the web-based UI instead of logging in on your behalf as is done with a rich task editor ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=142869" target="mylyn_external">bug 142869</a>). + </li> + <li>If you get a <code>AuthenticationException</code> and a query won’t synchronize, use Task Repositories (view) → Properties (on the repository) → Validate Settings. This will clear the connection if it died.</li> + </ul> + <h2 id="Why_do_I_get_a_.E2.80.9CJIRA_connector_requires_server_3.3.3_or_later.E2.80.9D_message.3F">Why do I get a “JIRA connector requires server 3.3.3 or later” message?</h2> + <p>Version 2.0 of the JIRA connector misinterprets version 3.10 as being lower than version 3.3.3. This is fixed in version 2.1 of the connector (see below for installation instructions on Eclipse 3.2).</p> + <h2 id="What_is_the_latest_version_of_the_JIRA_connector_that_supports_Eclipse_3.2_.28IBM_Rational_Application_Developer_7.29.3F">What is the latest version of the JIRA connector that supports Eclipse 3.2 (IBM Rational Application Developer 7)?</h2> + <p>The most recent version that works on Eclipse 3.2 is Mylyn 2.0.0 and version + <i>2.1.0</i> of the JIRA connector. See + <a href="http://confluence.atlassian.com/display/JIRAEXT/Mylyn#Mylyn-e3.2" target="mylyn_external">this page for instructions</a>. + </p> + <h2 id="Why_are_attachments_missing_in_the_task_editor_although_they_are_displayed_in_the_web_interface.3F">Why are attachments missing in the task editor although they are displayed in the web interface?</h2> + <p>Attachment retrieval including retrieval of task contexts and attachment lists in the task editor requires JIRA 3.7 or above.</p> + <h2 id="Are_custom_fields_supported_by_the_JIRA_connector.3F">Are custom fields supported by the JIRA connector?</h2> + <p>Custom fields are supported with the following limitations, see {{bug|249057}} and its subtasks for additional details:</p> + <ul> + <li>Custom fields are not displayed in the task editor when creating new issues. This can cause issue creation to fail if custom fields are mandatory.</li> + <li>Custom fields that are specific to a workflow state, e.g. are only displayed when resolving an issue, are not displayed in the task editor. This can cause a workflow transition to fail if custom fields are mandatory.</li> + <li>If a value is not set for a custom field it will not be displayed in the task editor.</li> + <li>Single-select and multi-select fields are not editable and options for these fields are not displayed in the task editor.</li> + </ul> + <h2 id="Known_limitations_2">Known limitations</h2> + <ul> + <li>Attachment retrieval (including retrieval of the task context and attachment list in the task editor) require JIRA 3.7 or above ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=169757" target="mylyn_external">bug 169757</a>) + </li> + </ul> + <p><!-- * NTLM authentication is not supported ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=172395" target="mylyn_external">bug 172395</a>) --> + </p> + <ul> + <li>Customized priorities are not currently supported, so all issues with a customized priority will have the default priority level ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=165518" target="mylyn_external">bug 165518</a>). + </li> + <li>blank but editable custom fields doesn’t appear in the RSS data, and as result we can’t show them for editing</li> + <li>because of JIRA api limitations, we can support custom fields in the task editor, but not in the new custom task editor</li> + </ul> + <p><!-- * On JIRA 3.6.x private filters saved on the server can fail to retrieve results ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=174328" target="mylyn_external">bug 174328</a>). The work-around is to create a custom query in Mylyn using the form-based query designer or to share the filter in JIRA. --> + </p> + <ul> + <li>Mylyn only allows the usage of US-ASCII characters in the filename when uploading an attachment ({{bug|203663}})</li> + </ul> + <h2 id="How_can_I_enable_compression_for_SOAP_messages.3F">How can I enable compression for SOAP messages?</h2> + <p>If your repository has lots of projects and components you can speed up the download of the repository configuration by enabling compression. </p> + <ul> + <li>Add a filter-mapping to your JIRA server configuration: + <a href="http://jira.atlassian.com/browse/JRA-10353" target="mylyn_external">http://jira.atlassian.com/browse/JRA-10353</a>. + </li> + <li>Enable compression in your global JIRA configuration.</li> + <li>Check the compression setting for your task repository in Mylyn versions 2.0M2 and later.</li> + </ul> + <h2 id="Reporting_issues">Reporting issues</h2> + <p>Since JIRA can be heavily customized there is a chance that some particular customizations may not work, so if you can’t connect to your proprietary repository it is a good idea to try the following public repositories to make sure you have working configuration:</p> + <ul> + <li> + <a href="http://jira.codehaus.org" target="mylyn_external">http://jira.codehaus.org</a> + </li> + <li> + <a href="http://issues.apache.org/jira/" target="mylyn_external">http://issues.apache.org/jira/</a> + </li> + <li> + <a href="http://opensource.atlassian.com/projects/spring" target="mylyn_external">http://opensource.atlassian.com/projects/spring</a> + </li> + </ul> + <p>If you can’t get query results, you could try to call “Open with Browser” on query node in the Task List view and then save link “Current view: XML” and attach it to the bug report.</p> + <p>Even if query don’t work you could try “Open Repository Task” from your JIRA repository node on the Task Repositories view and check if you can open JIRA task editor for that issue. Same for the Task search (Ctrl-H, Task Search)</p> + <p>To investigate various error you may need to enable debug tracing. To do that you need to create the <code>.options</code> file with the following content:</p> + <pre> + org.eclipse.mylyn.jira.ui/connector=true + org.eclipse.mylyn.jira.ui/dataHandler=true +</pre> + <p>and then add the following options to the Eclipse command line (or eclipse.ini file):</p> + <pre> + -debug <path to the .options file>/.options +</pre> + <p>The additional logging will go into the regular Eclipse log and the Error Log view</p> + <h2 id="Why_do_I_get_errors_about_an_unexpected_redirect_when_submitting_an_issue.3F">Why do I get errors about an unexpected redirect when submitting an issue?</h2> + <p>Please go to the repository properties and validate the repository. If errors about circular redirects are logged in your Eclipse error log your JIRA server or proxy might be misconfigured. </p> + <p>In some cases unexpected redirects can be caused by a JIRA server accessed via Apache and mod_jk (using the AJP/1.3 Tomcat connector). Some server configurations may benefit from the ‘proxyHost’, ‘proxyPort’, ‘scheme’ and ‘secure’ settings on the AJP Connector in the Tomcat server configuration.</p> + <p>Please see {{bug|202834}} for a more details.</p> + <h2 id="What_does_.3Ccode.3EError_parsing_server_response:_No_project_with_key_.E2.80.98xyz.E2.80.99_found.3C.2Fcode.3E.3F">What does <code>Error parsing server response: No project with key ‘xyz’ found</code>?</h2> + <p>This error is caused by Mylyn not having an up-to-date copy of the repository configuration for that repository. The corresponding report to automate updating of the repository configuration is {{bug|189689}}.</p> + <p>As a work-around right-click on the query and select + <b>Repository → Update Attributes</b>. That will download and store a fresh copy of the repository configuration. + </p> + <h2 id="Why_does_the_estimated_time_displayed_in_the_task_editor_differ_from_the_web_interface.3F">Why does the estimated time displayed in the task editor differ from the web interface?</h2> + <p>Mylyn defaults to a day having 24 working hours and a week having 7 work days. If your JIRA repository uses different settings time tracking information will not show correctly when converted between Mylyn and JIRA. In order to fix this change the time tracking settings in Mylyn in the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to match the server configuration. Your JIRA administrator will be able to tell you the correct settings which can be located under Administration → Time Tracking in the JIRA web interface.</p> + <p> + <img border="0" src="images/Time-tracking-jira-admin.png"/> + <br/> + + <b>JIRA Web Interface</b> + </p> + <p> + <img border="0" src="images/Time-tracking-jira-mylyn.png"/> + <br/> + + <b>Mylyn Task Repository Settings</b> + </p> + <h2 id="Why_am_I_getting_the_message_.E2.80.9CYou_did_not_enter_a_valid_date.E2.80.9D_when_I_try_to_submit_a_JIRA_issue.3F">Why am I getting the message “You did not enter a valid date” when I try to submit a JIRA issue?</h2> + <p>Your server may be configured to use a custom date format or a non English locale. You can change the date format settings in the Advanced Configuration section under the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to match the server configuration.</p> + <p> + <img border="0" src="images/Jira-advanced-configuration.png"/> + </p> + <h2 id="How_can_I_make_issue_dependencies_visible_in_the_Task_List.3F">How can I make issue dependencies visible in the Task List?</h2> + <p>By default only subtask relationships are displayed in the Task List. You can enable + <i>Show linked tasks</i> in the Additional Settings section of the repository properties (Window → Show View → Task Repositories) to also show issue links in the Task List. After enabling the setting + <i>Synchronize All Tasks</i> from the popup menu of the task repository in the Task Repositories view needs to be selected to update all tasks. More discussion is on {{bug|255680}}. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Bugzilla-Connector.html" title="Bugzilla Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Trac-Connector.html" title="Trac Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Bugzilla Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Trac Connector</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Java-Development.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Java-Development.html new file mode 100644 index 000000000..26ddf0f5d --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Java-Development.html @@ -0,0 +1,120 @@ +<?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 FAQ - Java Development</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">Java Development</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Context-and-Timing-data.html" title="Context and Timing data"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Context and Timing data</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Team Support</td> + </tr> + </table><hr/> + <h1 id="Java_Development">Java Development</h1> + <h2 id="Content_assist_troubleshooting">Content assist troubleshooting</h2> + <p>Mylyn uses custom 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>Type Proposals (Mylyn)</i> kinds checkbox enabled in the list below, otherwise you will see duplicates. + <b>If you do not see any proposals, check this list</b> to ensure that either the Mylyn or the plain proposals are enabled. + <b>To do this automatically</b>, run + <i>New → Mylyn → Recommended Preferences</i>. Or you can select them manually as in the preference page below. + </p> + <p> + <img border="0" src="images/mylar-content-assist-prefs.gif"/> + </p> + <p> + <b>Why do I see duplicate proposals?</b> + </p> + <p>Ensure that you have only the + <i>(Mylyn)</i> proposals kinds enabled in + <i>Window → Preferences → Java → Editor → Content Assist → Advanced</i>, otherwise you will see duplicates. + </p> + <p>If you use proposals via Ctrl+Shift+Space instead of the typical Ctrl+Space you will see duplicates. Vote for JDT/Text + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=147781" target="mylyn_external">bug 147781</a> if you use this mechanism. Also see: + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=129080" target="mylyn_external">bug 129080</a> + </p> + <p> + <b>Why do I get an error message when using content assist?</b> + </p> + <p>If after invoking Content Assist you see an error message dialog that states:</p> + <pre>The extension took too long to return from the 'computeCompletionProposals()' operation +</pre> + <p>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 <code>-Xmx384M</code> command line argument). See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=141457" target="mylyn_external">bug 141457</a> for more details. + </p> + <p>Note that Mylyn should only add a trivial amount of overhead to content assist computation, however, the standard content assist mechanism will not report timeouts of this sort (i.e. taking longer than 5s to compute proposals). If the system that you are working on is so large that increasing memeory does not reduce the timings to avoid the message, you could also consider disabling the Mylyn-specific content assist, as described above, but if doing so please comment on {{bug|141457}}.</p> + <p> + <img border="0" src="images/mylyn-content-assist-timeout.gif"/> + </p> + <h2 id="Why_do_interesting_elements_not_show_in_the_Project_Explorer.3F">Why do interesting elements not show in the Project Explorer?</h2> + <p>The + <i>Package Presentation → Hierarchical</i> mode is not supported on the + <i>Project Explorer</i> view in Eclipse 3.2 through 3.3M3 and possibly later versions + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=161362" target="mylyn_external">bug 161362</a>. Use the view menu to set + <i>Package Presentation → Flat</i> as a work-around. + </p> + <h2 id="How_do_I_stop_declarations_from_showing_in_the_Package_Explorer.3F">How do I stop declarations from showing in the Package Explorer?</h2> + <p>If you don’t like Mylyn’s constant showing of Java members in the + <i>Package Explorer</i>, select the drop-down menu, then + <i>Filters…</i> and enable the + <i>Mylyn Java Declarations Filter</i>. It will then stick in the menu in case you want to toggle between modes. + </p> + <p>Note that this will hide interest information about members that aren’t in your current file (e.g. showing you which methods are landmarks). This means that you will need to commit those methods to memeory, and the next time that you start working on the task you will have the burden of figuring out what they are. On smaller screen resolutions this mode can be useful, but also consider turning the Package Explorer into a fast view.</p> + <p> + <img border="0" src="images/mylar-java-filtering-declarations.gif"/> + </p> + <h2 id="Why_does_nothing_show_up_in_the_Active_Search_or_Active_Hierarchy.3F">Why does nothing show up in the Active Search or Active Hierarchy?</h2> + <p>As you work, elements become Landmarks (bold decoration), and these elements populate the + <i>Active Search</i> and + <i>Active Hierarchy</i> views. To force an element to populate the views manually, make it a Landmark by <code>right+clicking</code> or hitting <code>Ctrl+Alt+Shift+UpArrow</code>. + </p> + <h2 id="Known_limitations_5">Known limitations</h2> + <ul> + <li> + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=106678" target="mylyn_external">Bug 106678</a>: The Project Explorer’s Hierarchical Java package presentation layout is not supported on Eclipse 3.3Mx, and interesting elements will be hidden if enabled. Work-around is to use the default Flat package presentation. + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Context-and-Timing-data.html" title="Context and Timing data"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Context and Timing data</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Team Support</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Misc.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Misc.html new file mode 100644 index 000000000..71c75190d --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Misc.html @@ -0,0 +1,176 @@ +<?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 FAQ - Misc</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">Misc</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <img alt="Previous" border="0" src="../../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/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Integration with other tools</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="Misc">Misc</h1> + <h2 id="Performance">Performance</h2> + <h3 id="Retrieval_of_repository_configuration">Retrieval of repository configuration</h3> + <p>In order to present the valid options for attributes in the Task Editor, the repository 'configuration' must be retrieved from the repository. The default connector implementation requests a new configuration every 24hrs. In the case of Bugzilla, this is further refined by first performing a head request on the configuration to see if the Last-Modified header has changed. If so, the repository configuration is retrieved. Additionally, Eclipse.org's webmaster has redirected the config.cgi request to a static page, eliminating the processing overhead server side. For details on server side optimization of Bugzilla see + <a href="/wiki/Mylyn_FAQ#Tips_for_server_administrators" title="Mylyn_FAQ#Tips_for_server_administrators">Mylyn_FAQ#Tips_for_server_administrators</a>. + </p> + <h2 id="Command_Line">Command Line</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 -argument</code>.</p> + <table> + <tr> + <td>Argument</td> + <td>Mylyn Version</td> + <td>Description</td> + </tr> + <tr> + <td><code>-no-activate-task</code></td> + <td><center>3.1</center></td> + <td>Disables task activation on startup. The last active task is not re-activated on startup if a workspace crash is detected.</td> + </tr> + </table> + <h2 id="System_Properties">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.linkProviderTimeout</code></td> + <td><center>3.1</center></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> + <tr> + <td><code>mylyn.discovery.directory</code></td> + <td><center>3.2</center></td> + <td> + <a href="http://www.eclipse.org/mylyn/discovery/directory.xml" target="mylyn_external">http://www.eclipse.org/mylyn/discovery/directory.xml</a> + </td> + <td>URL for the discovery directory.</td> + </tr> + </table> + <h2 id="How_do_I_enable_debugging_output_for_network_communications.3F">How do I enable debugging output for network communications?</h2> + <p>Add the following lines to the <code>eclipse.ini</code> file in your eclipse directory to enable tracing of header information for HTTP requests. Log output is written to the console eclipse was started from. Make sure to add these after the line that says + <b><code>-vmargs</code></b>. Add a <code>-vmwargs</code> line if there is none in the file. + </p> + <pre>-Dorg.apache.commons.logging.Log=org.apache.commons.logging.impl.SimpleLog +-Dorg.apache.commons.logging.simplelog.showlogname=true +-Dorg.apache.commons.logging.simplelog.defaultlog=off +-Dorg.apache.commons.logging.simplelog.log.httpclient.wire.header=debug +-Dorg.apache.commons.logging.simplelog.log.org.apache.commons.httpclient=off +-Dorg.apache.commons.logging.simplelog.log.org.apache.axis.message=debug +</pre> + <p>To also enable logging of message content, also add this lines:</p> + <pre>-Dorg.apache.commons.logging.simplelog.log.httpclient.wire.content=debug +</pre> + <h2 id="How_do_I_enable_debugging_output_for_plug-ins.3F">How do I enable debugging output for plug-ins?</h2> + <p>Create a + <b><code>.options</code></b> file in your eclipse directory and enable tracing by including the corresponding lines which set the tracing setting for a particular concern to true: + </p> + <p> + <b>JIRA</b> + </p> + <pre>org.eclipse.mylyn.jira.core/debug/connector=true +org.eclipse.mylyn.jira.core/debug/dataHandler=true +org.eclipse.mylyn.jira.core/debug/repository=true +</pre> + <p> + <b>Trac</b> + </p> + <pre># trace authentication requests +org.eclipse.mylyn.trac.core/debug/authentication=true +# trace XML-RPC calls +org.eclipse.mylyn.trac.core/debug/xmlrpc=true +</pre> + <p>Then start eclipse with + <b><code>-debug</code></b>. You can also optionally pass a filename to <code>-debug</code> if your <code>.options</code> file is not located in the eclipse directory. + </p> + <p>See also + <a href="/wiki/FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F" title="FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F">FAQ_How_do_I_use_the_platform_debug_tracing_facility%3F</a>. + </p> + <h2 id="Which_usage_monitoring_framework_should_I_use.3F">Which usage monitoring framework should I use?</h2> + <p>Three usage data collection frameworks have been created for Eclipse:</p> + <ol> + <li> + <a href="http://dev.eclipse.org/viewcvs/index.cgi/platform-ui-home/instrumentation/index.html?revision=1.12" target="mylyn_external">Eclipse Instrumentation Framework</a>: created as part of Platform UI, not released, not currently maintained + </li> + <li> + <a href="/wiki/Mylyn_Integrator_Reference#Monitor_API" title="Mylyn_Integrator_Reference#Monitor_API">Mylyn Monitor UI Usage Reporting</a>: created in 2004, maintained as part of the Mylyn project, first released in 2005 + </li> + <li> + <a href="http://www.eclipse.org/epp/usagedata/index.php" target="mylyn_external">Usage Data Collector</a>: maintained as part of the EPP project, first released in 2008 + </li> + </ol> + <p>While (1) and (3) are work in a similar way, there is a significant difference between the approach used by the Mylyn Monitor and the other usage data collectors. Instead of gathering statistics, the Mylyn UI Usage Reporting component uses the interaction history that is captured by the Mylyn Monitor. This is the same interaction history stream that is used to determine the interest level of elements in Mylyn’s Task-Focused UI and has been refined by long-term use of Mylyn’s Task-Focused UI. The UI Usage Monitor is extensible, de-coupled from the other parts of Mylyn and can be used independently. </p> + <p>There are several main benefits to the approach of capturing a full interaction history stream instead of reporting on particular statistics.</p> + <ul> + <li>Since all of the interaction information is captured on the client, server-side reporting facilities can report on usage statistics that were not defined at deployment time. For example, during one of the Mylyn studies we did not decide to monitor which views were opened within which perspective. Since we had the full interaction histories this reporting was easy to add.</li> + <li>Interaction histories make it possible to report not just on the usage of the UI, but on the state of the UI at any given time. For example, in one study we wanted to know what actinos the user did after invoking a build and which views were visible while the invoked that action.</li> + <li>An explicit interaction history makes it easier to avoid and debug privacy problems. The Mylyn Monitor has a robust facility for filtering, encrypting and obfuscating data from interaction histories.</li> + </ul> + <p>For an example study see: + <a href="http://kerstens.org/mik/publications/mylar-ieee2006.pdf" target="mylyn_external">http://kerstens.org/mik/publications/mylar-ieee2006.pdf</a> + </p> + <h2 id="How_does_Mylyn_relate_to_IBM.E2.80.99s_Jazz.3F">How does Mylyn relate to IBM’s Jazz?</h2> + <p>At the EclipseCon and JavaONE 2006 conferences IBM demonstrated previews of Jazz, a collaborative team server and Eclipse-based client. Articles have remarked on the similarities between Mylyn and Jazz because both integrate tasks into Eclipse (Jazz’s “work items” and Mylyn’s “tasks”), and both provide change sets grouped by task. But there are both significant differences and complementary aspects to the two approaches. A key goal of Mylyn is to provide an open source framework to support integration of task management with + <i>existing issue trackers and source repositories</i>. According to the presentations, components that come with Jazz include include a + <i>next-generation issue tracker and source repository</i> and related lifecycle management tools such as project health. In addition, a driving and unique goal of Mylyn is to focus the UI around a usage-based and degree-of-interested weighted task context, which is complementary to the Jazz platform. Just as it integrates with Mylyn’s Task List, Mylyn’s Task Focused UI and task context model components are possible to integrate with other kinds of task management systems, such as the one provided by Jazz. + </p> + <p>Update: at EclipseCon 2007 the IBM Jazz team showed a Mylyn connector for Jazz.</p> + <p> + <a href="/wiki/Category:FAQ" title="Category:FAQ">Category:FAQ</a> + + <a href="/wiki/Category:Mylyn" title="Category:Mylyn">Category:Mylyn</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../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/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Integration with other tools</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/Mylyn/FAQ/Task-Editor.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Editor.html new file mode 100644 index 000000000..7419b7832 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Editor.html @@ -0,0 +1,67 @@ +<?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 FAQ - Task Editor</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 Editor</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-List.html" title="Task List"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Task-Repositories.html" title="Task Repositories"> + <img alt="Next" border="0" src="../../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">Task Repositories</td> + </tr> + </table><hr/> + <h1 id="Task_Editor">Task Editor</h1> + <h2 id="When_I_submit_a_new_bug_to_eclipse.org_the_priority_isn.E2.80.99t_updated.3F">When I submit a new bug to eclipse.org the priority isn’t updated?</h2> + <p>Eclipse.org’s Bugzilla repository forces all new bug reports to priority 3 (P3) regardless of what is selected in Mylyn. Eventually we will disable this field in the new bug editor for bugs.eclipse.org and provide a tooltip with explanation ( {{bug|204630}} ).</p> + <h2 id="Why_am_I_seeing_strange_boxes_where_I_expect_to_see_proper_characters.3F">Why am I seeing strange boxes where I expect to see proper characters?</h2> + <p>If for example you aren’t seeing the proper single quote chacters in the summary of + <a href="/wiki/https://bugs.eclipse.org/bugs/show_bug.cgi?id=197644_bug#197644" title="https://bugs.eclipse.org/bugs/show_bug.cgi?id=197644 bug#197644">https://bugs.eclipse.org/bugs/show_bug.cgi?id=197644 bug#197644</a>, check that the encoding is set correctly for the repository in the asociated Task Repositories view (Properties → Additional Settings → Character Encoding). For bugs.eclipse.org/bugs set your charcter encoding to + <i>ISO-8859-1</i>. + </p> + <h2 id="How_can_I_view_images_or_screenshots_that_are_attached_to_an_image.3F">How can I view images or screenshots that are attached to an image?</h2> + <p>By default Eclipse does not provide a built-in image viewer so images can either be opened with a browser or saved to disk and opened in a native image viewer. Alternatively Eclipse extension such as QuickImage can be installed which support opening images within Eclipse.</p><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/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Task-Repositories.html" title="Task Repositories"> + <img alt="Next" border="0" src="../../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">Task Repositories</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Focused-UI.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Focused-UI.html new file mode 100644 index 000000000..5e679cbdc --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Focused-UI.html @@ -0,0 +1,183 @@ +<?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 FAQ - Task-Focused UI</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-Focused UI</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Web-Templates-Connector.html" title="Web Templates Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Context-and-Timing-data.html" title="Context and Timing data"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Web Templates Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Context and Timing data</td> + </tr> + </table><hr/> + <h1 id="Task-Focused_UI">Task-Focused UI</h1> + <h2 id="What_is_the_Task-Focused_UI.3F">What is the Task-Focused UI?</h2> + <p>When you activate a task, Mylyn automatically maintains a task context by monitoring your interaction. The task context provides a predictable degree-of-interest weighting of the relevance of the elements and relations that you work with to the task-at-hand (as described in the + <a href="http://kerstens.org/mik/publications/2006-11-mylar-fse.pdf" target="mylyn_external">Foundations of Software Engineering conference paper</a>). The Task-Focused UI is the mechanism by which Mylyn presents Mylyn the task-context model in order to reduce information overload and to automate the manual management of UI elements like editors and change sets. Examples: + </p> + <ul> + <li>Filtering, decoration and expansion management in views</li> + <li>Automatic folding in editors</li> + <li>Ranking in content assist</li> + <li>Editor management</li> + <li>Perspective management</li> + <li>Change set management</li> + </ul> + <h2 id="Why_do_files_disappear_from_Focused_views_when_I_close_them.3F">Why do files disappear from Focused views when I close them?</h2> + <p>By default Mylyn automatically manages the set of open files to match the task context, so that you don’t have to. This ensures that the editor list (viewable via mechanisms like Ctrl+E) corresponds to what you in views like the + <i>Package Explorer</i> when they are in Focused mode. When you close a file manually, you express that it is uninteresting, and as such it will be removed from the task context. It will also disappear from the corresponding automatically managed change sets for the same reason. This behavior can be turned off via + <i>Preferences → Mylyn → Context → Manage open editors to match task context</i>. However, it is highly recommended since Mylyn will prevent the number of editors from bloating by automatically closing editors for elements that have decayed in interest, and always keep the editors for interesting elements open. + </p> + <h2 id="Why_did_all_my_editor_tabs_disappear.3F">Why did all my editor tabs disappear?</h2> + <p>When you deactivate a task, all editors will be closed, and then when you reactivate the task all the windows will be open again. Try it, it’s fun. </p> + <p>Mylyn actively manages your open editors with task context. It takes some getting used to, but enables switching between tasks when you are multitasking without cluttering your editor tabs. This editor management can be disabled via + <i>Window → Preferences → Mylyn → Context</i>. However, before disabling it consider reading the + <i>“Managing open editors…”</i> section of + <a href="http://www-128.ibm.com/developerworks/java/library/j-mylar2/index.html#N10116" target="mylyn_external"> Task-focused programming with Mylar</a>. + </p> + <h2 id="How_do_I_get_rid_of_an_element_if_it_is_not_interesting.3F">How do I get rid of an element if it is not interesting?</h2> + <p>When a view is focused elements will disappear on their own if they are not repeatedly selected via a mechanism called interest decay. Note that decay does not use the wall clock, but instead relies on the number of selections that you have made when working on that task to determine which elements disappear. This helps make it feel very predictable.</p> + <p>If you want want to force one or more elements to disappear from the context use the + <b>Remove from Focus</b> action on the context menu. Note that the element will still be part of the task context since it was previously part of the interaction. + </p> + <p>If you want to permanently delete the element from the interaction history use the + <b>Remove from Context</b> action on the + <b>Context</b> tab of the + <b>Task Editor</b>. For example, if a company private element was part of a task context that is to be shared with a public repository, this action can be used to clean it up before sharing. Note that elements will be removed from the task context recursively. + </p> + <h2 id="Which_Focused_UI_features_can_I_turn_off.3F">Which Focused UI features can I turn off?</h2> + <p> + <b>All of them.</b> When no task is active neither are any of Mylyn’s features. When working with task contexts Mylyn’s Focused UI features are all optional and in general configurable. While many find it the key benefit of Mylyn, the entire Focused UI is optional and can be uninstalled via + <i>Help → Software Updates → Manage Configuration</i>. + </p> + <p>The following table summarizes how the key features can be toggled:</p> + <table> + <tr> + <th> + <b>UI Mechanism</b> + </th> + <th> + <b>Example/description</b> + </th> + <th> + <b>Toggle using</b> + </th> + </tr> + <tr> + <td>Interest filtering</td> + <td>Package Explorer</td> + <td> + <i>Focus on Active Task</i> button on view toolbar + </td> + </tr> + <tr> + <td>Automatic toggling of filtering</td> + <td>Package Explorer</td> + <td>''Preferences → Mylar → Context → Toggle focused mode..</td> + </tr> + <tr> + <td>Interest decoration</td> + <td>Bolding of landmark elements</td> + <td> + <i>Preferences -> General -> Appearance -> Label Decoration</i> + </td> + </tr> + <tr> + <td>Content assist</td> + <td>Ranking of interesting elements</td> + <td>Eclipse 3.2: + <i>Java -> Editor -> Content Assist -> Work in Progress -></i> turn off Mylyn, turn on Java + </td> + </tr> + <tr> + <td>Active change sets</td> + <td>Grouping of changes by tasks</td> + <td> + <i>Preferences -> Mylyn -> Team</i> + </td> + </tr> + <tr> + <td>Editor management</td> + <td>Auto opening/closing of editors</td> + <td> + <i>Preferences -> Mylyn -> Editor Management</i> + </td> + </tr> + <tr> + <td>Active views</td> + <td>Active Search and Hierarchy</td> + <td>Only on if view is active</td> + </tr> + </table> + <p>For additional configuration options see the + <i>Mylyn</i> and + <i>General → Appearance</i> preference pages. + </p> + <p> + <b>Note</b>: if you have turned off automatic focusing of views consider using the + <i>Navigate → Quick Context View</i> facility. + </p> + <h2 id="Why_can.E2.80.99t_I_Alt.2BClick_to_references_libraries.3F">Why can’t I Alt+Click to references libraries?</h2> + <p>Due to {{bug|200832}}, if you have the “Show ‘Referenced Libraries’ Node” option enabled in the view menu of the + <i>Package Explorer</i> you will not be able to Alt+click to library nodes if there isn’t a library visible already. Disable this option to make Alt+Click work. + </p> + <h2 id="Why_is_the_.27.27Link_with_Editor.27.27_button_disabled.3F">Why is the ''Link with Editor'' button disabled?</h2> + <p>Mylyn automatically turns on editor linking when the view is focused, since the main use case for turning it off (having the view jump around) is remedied by focusing the view. In other words, the button is pressed for you automatically and we need to ensure that it cannot be manually unchecked, which is why it appears disabled.</p> + <h2 id="What_happened_to_the_Active_Search_and_Active_Hierarchy_views.3F">What happened to the Active Search and Active Hierarchy views?</h2> + <p>These views were not included in the Mylyn 1.0 release because they never made it beyond the experimental phase. </p> + <ul> + <li>The + <i>Active Search</i> view has not been sufficiently tuned to adapt to the lifecycle of a task context, and as a result requires manual manipulation of the degree-of-separation scope as you work on long-running tasks. Otherwise it becomes overloaded with elements. In addition, it is not yet clear whether an additional view is the right UI for this facility, and it is hard to find room for an additional view of this size on screen resolutions of 1600x1200 and smaller. + </li> + <li>The + <i>Active Hierarchy</i> view is also hard to allocate space for, especially when using the in-place hierarchy (Ctrl+T) on a landmark can be a quick way to see the relevant part of the task context’s hierarchy. + </li> + </ul> + <p>These features still show promise in displaying task context and saving repetitive searches, so we have not removed them. They have instead moved to the Mylyn Sandbox, and can be used and experimented with by following the + <a href="http://wiki.eclipse.org/index.php/Mylyn_Contributor_Reference#Sandbox" target="mylyn_external">instructions on the Contributors page</a>. For feedback on these views please use the corresponding bug reports or newsgroup. + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Web-Templates-Connector.html" title="Web Templates Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Context-and-Timing-data.html" title="Context and Timing data"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Web Templates Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Context and Timing data</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-List.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-List.html new file mode 100644 index 000000000..bbe181049 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-List.html @@ -0,0 +1,176 @@ +<?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 FAQ - 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/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/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 Editor</td> + </tr> + </table><hr/> + <h1 id="Task_List">Task List</h1> + <h2 id="How_do_I_restore_my_tasks_from_backup.3F">How do I restore my tasks from backup?</h2> + <p>The task list can be restored from automated backup via the Task List view’s drop down view menu and selecting Restore Tasks from History…</p> + <h2 id="How_do_I_clear_outgoing_changes_on_a_task.3F">How do I clear outgoing changes on a task?</h2> + <p>If a task has outgoing changes you wish to discard, right click on the task and select Mark as → Clear Outgoing. If a mid-air collision occurs, press the Synchronize button in the Task editor toolbar to bring in the incoming changes. Your outgoing changes will remain.</p> + <h2 id="Why_do_my_tasks_not_appear_in_the_Task_List.3F">Why do my tasks not appear in the Task List?</h2> + <p>The task list has filtering mechanisms that can limit the items visible in the task list. If a task is missing from the task list, use the following steps to remove all filters:</p> + <p> + <img border="0" src="images/Tasklist-filter.png"/> + </p> + <ol> + <li>Check the filter settings in the view menu. Make sure Filter Completed tasks is not enabled and all items are checked in the Filter Priority Lower Than menu.</li> + <li>If the Go Up To Root icon is visible in the toolbar, select it to make all items in the task list visible.</li> + <li>If the Focus on Workweek button is pressed, select it to unfilter the task list.</li> + <li>If text is typed in the Find, use the clear button next to the find box.</li> + <li>Switch to All to make all all working sets visible.</li> + </ol> + <h2 id="Why_do_tasks_appear_in_the_.27.27Unmatched.27.27_container.3F">Why do tasks appear in the ''Unmatched'' container?</h2> + <p>The + <i>Unmatched</i> containers will automatically appear if a task needs to be shown but is not matched by any query. This is needed to ensure that the corresponding tasks do not disappear, for example, if the query is set up to only match resolved/completed tasks (a usage anti-pattern, since Mylyn has other mechanisms for preventing completed tasks from showing in the Task List). + </p> + <p>In order to ensure that you do not miss reminders or notifications the following tasks will always be shown in the Task List, even if they have been removed from a category or a query:</p> + <ul> + <li>Tasks scheduled for this week or overdue. Remove these by using the + <i>Schedule</i> pop-up menu option to defer them to a future week or to clear the schedule. + </li> + <li>Repository tasks that have incoming changes, such as comments. Remove these by reading them or marking them as “read” via the + <i>Mark → Read</i> pop-up menu. + </li> + </ul> + <p>To + <b>get rid of tasks in the + <i>Unmatched</i> container + </b> you can: + </p> + <ul> + <li>Create a new query that matches the tasks.</li> + <li>Right-click on one or more tasks to delete them.</li> + </ul> + <p>Recommended Mylyn usage is to keep the + <i>Unmatched</i> container empty. For query setup recommendations see the sidebar at: + <a href="http://www.ibm.com/developerworks/java/library/j-mylyn1/?ca=dgr-eclipse-1" target="mylyn_external">http://www.ibm.com/developerworks/java/library/j-mylyn1/?ca=dgr-eclipse-1</a> + </p> + <h2 id="How_do_I_change_the_Task_List_colors.3F">How do I change the Task List colors?</h2> + <p>Use + <i>Window → Preferences → General → Appearance → Colors and Fonts</i>. + </p> + <h2 id="The_Unmatched_category_contains_many_irrelevant_tasks.2C_how_do_I_clean_it_up.3F">The Unmatched category contains many irrelevant tasks, how do I clean it up?</h2> + <p>If you created very broad queries you could end up with thousands of tasks in your Unmatched containers. Other than clearing the <tt>workspace/.metadata/.mylyn/tasklist.xml.zip</tt> and <code>workspace/.metadata/.mylyn/offline</code> folder (note that this will entirely reset your Task List) the easiest option is to:</p> + <ul> + <li>Clean up your queries to include only tasks of interest (note that including completed/resolved tasks is recommended).</li> + <li>Turn off + <i>Focus on Workweek</i> in the + <i>Task List</i>. + </li> + <li>Delete all of the unneeded tasks from within the Unmatched containers. Note that if the tasks are not matched by queries they will be deleted permanently and any local notes or scheduling information that you have added to them will be lost.</li> + </ul> + <h2 id="How_does_Mylyn_count_the_active_time_for_a_task.3F">How does Mylyn count the active time for a task?</h2> + <p>Whenever you work on a task, Mylyn accumulates the time you spend actively working on a task. This time can be viewed in the + <i>Personal Planning</i> section of the + <i>Task Editor</i>. When you are not interacting with Eclipse, the timing automatically times out after 3 minutes by default. This means that activity outside of Eclipse will not be captured when you work on the task and that the timings in Mylyn are a lower bound of the total time spent on the task (capturing timings for work done outside of Eclipse involves OS specific extensions). + </p> + <h2 id="How_do_I_prevent_long-running_tasks_from_adding_to_the_progress_bar.3F">How do I prevent long-running tasks from adding to the progress bar?</h2> + <p>If you have many long-running or recurring tasks scheduled for this week, they can affect the + <i>Task List</i> weekly progress bar. This can be misleading as they may never be completed. The current work-around to prevent long-running tasks from being included in the weekly progress bar is to schedule their estimated time to be 0 (zero). Alternatively, you can schedule only the amount of time you plan on spending on that task this week. + </p> + <h2 id="Does_the_Task_List_replace_the_Eclipse_Tasks_view.3F">Does the Task List replace the Eclipse Tasks view?</h2> + <p>The SDK’s + <i>Tasks</i> 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 finer granularity than Mylyn’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 + <i>Apply Mylyn</i> filter is available for both the + <i>Problems</i> and the + <i>Tasks</i> views. + </p> + <h2 id="What_if_I_use_multiple_workspaces.3F">What if I use multiple workspaces?</h2> + <p>Mylyn’s support for multiple workspaces is currently limited (see + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=130658" target="mylyn_external">bug 130658</a> for a discussion) because the Task List is considered to be specific to the person, and not to the workspace. In addition, Eclipse’s support for multiple workspaces is limited to import/export based usage, and Mylyn inherits this limitation. We highly recommend configuring your Eclipse workspace to use working sets instead of relying on multiple workspaces. + </p> + <p>If using a single workspace is not possible you can do the following, Mylyn does provide an advanced facility for using the same data directory that’s outside of the workspace. However, this is not generally recommended because it can cause you to overwrite an existing Task List if both workspaces are launched at the same time. </p> + <ul> + <li>In + <i>Preferences → Tasks → Task List</i> set the + <i>Data Directory</i> to be a shared location, and do this for both workspaces. + </li> + <li>Be sure to avoid launching both Eclipse workspaces at the same time, as changes in one workspaces could overwrite the Task List in the other workspace.</li> + <li>If you upgrade Eclipse or move your workspace and don’t see your tasks, check the + <i>Data Directory</i> setting. + </li> + </ul> + <p>Note that using + <i>File → Import → Task Data</i> is another way to get an existing + <i>Task List</i> into your workspace. If you use this mechanism for sharing the + <i>Task List</i> between workspaces you should export the + <i>Task List</i> when switching, because in this mode you are working with two separate + <i>Task List''s. While much of the task state that yo uwork on is stored in shared task repositories, all read state, activity history, planning information and local tasks are maintained in the ''Task List</i> and as such it can become cumbersome to end up with two different lists to manage. + </p> + <p>See also:</p> + <ul> + <li>John O’Shea’s blog: + <a href="http://www.xlml.com/aehso/2007/02/02/eclipse-workspaces-containing-projects-with-overlapping-locations-and-mylar/" target="mylyn_external">Eclipse workspaces containing projects with overlapping locations, and Mylar</a> + </li> + </ul> + <h2 id="How_do_I_export_my_task_and_repository_data.3F">How do I export my task and repository data?</h2> + <p>Export via File → Export → Mylyn → Task Data</p> + <h2 id="Why_does_Mylyn_use_the_term_.E2.80.9Ctask.E2.80.9D.3F">Why does Mylyn use the term “task”?</h2> + <p>There are many work items that make up the developer’s workday. Many issue trackers and project management tools refer to these as: bugs, defects, actions, tickets, stories, enhancements, and the list goes on. We refer to all such work items as “tasks” because the word tasks is short and commonly used in time management tools. Task Repository connectors can customize the presentation of tasks, for example, indicating which is a defect and which is an action item.</p> + <h2 id="Why_are_closed_tasks_not_greyed_out_on_Linux.3F">Why are closed tasks not greyed out on Linux?</h2> + <p>If you are running Eclipse from KDE go to KControl → GTK Styles and Fonts and select “Use another style” in the GTK Styles section ({{bug|206399}}).</p> + <p>See the + <a href="../../Mylyn/User_Guide/User-Guide.html#Recommended_GTK_Setup_for_KDE" title="Mylyn/User_Guide#Recommended_GTK_Setup_for_KDE">Recommended GTK Setup for KDE</a> if the style selection does not work. + </p> + <h2 id="Why_is_starring_tasks_not_supported.3F">Why is starring tasks not supported?</h2> + <p>The current mechanism for starring tasks is to schedule them for + <i>Today</i>, which has a very similar effect to starring in other UIs. If you schedule a task for today, the task will stand out as blue and always show (i.e., have guaranteed visibility when the Task List is focused). If that’s too visible, you can schedule it for + <i>This Week</i>, in which case the task will always show but not turn blue. + </p> + <p>The alternative to mark a shared task as outgoing by adding text into it and (e.g. “ + <a href="review">review</a>”). The ougtoing change will also give the task guaranteed visibility. This is currently the only work-around for ‘starring’ completed tasks. + </p> + <p>The task-focused interface consider tasks orthogonal to resources (e.g., files and web pages). Resources make sense to star/bookmark, since their primary residence is in some structural hierarchy (e.g. folders or a type hierarchy). Starring provides a mechanism for locating the most relevant parts of a large hierarchy (at the cost of having our starred/bookmark lists bloat and become yet another thing to manage). Tasks are inherently different than resources because their primary residence is in time (e.g. due dates, milestones, things completed in the past). As such, the equivalent of starring for tasks is to schedule them to be viewed in the “current” time window (e.g. today or this week). For a discussion on this refer to {{bug|168363}}.</p><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/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../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/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 Editor</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Repositories.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Repositories.html new file mode 100644 index 000000000..daa39bdf2 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Task-Repositories.html @@ -0,0 +1,221 @@ +<?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 FAQ - 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">Task Repositories</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Editor.html" title="Task Editor"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Bugzilla-Connector.html" title="Bugzilla Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task Editor</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Bugzilla Connector</td> + </tr> + </table><hr/> + <h1 id="Task_Repositories">Task Repositories</h1> + <h2 id="What_if_I.E2.80.99m_not_using_a_Task_Repository.3F">What if I’m not using a Task Repository?</h2> + <p>Mylyn does not require the use a of a task repository and can be used entirely with the + <i>Local Tasks</i> repository that it comes bundled with. However, if working with a team, a shared + <i>Task Repository</i> provides the key infrastructure needed to let your team work in a Task-Focused way via Mylyn’s collaborative facilities. + </p> + <p>Those not currently using another supported + <i>Task Repository</i> should consider the repositories currently + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">supported by Mylyn</a> as well as those supported by the + <a href="http://wiki.eclipse.org/index.php/Mylyn_Extensions" target="mylyn_external">third party Mylyn extensions</a>. + </p> + <h2 id="What_if_Mylyn_doesn.E2.80.99t_support_my_task.2Fbug.2Fissue.2Fticket_repository.3F">What if Mylyn doesn’t support my task/bug/issue/ticket repository?</h2> + <p>To see support for your repository faster, do a search of the open repository connector requests and + <a href="https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=anywordssubstr&short_desc=%5Bconnector%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 tracker is there, or + <a href="http://www.eclipse.org/mylar/bugs.php" target="mylyn_external">create a new bug</a>. + </p> + <p> + <a href="../../Mylyn/User_Guide/User-Guide.html#Generic_Web_Repository_Connector" title="Mylyn/User_Guide#Generic_Web_Repository_Connector">Generic Repository Connector</a>, allows creating Queries to the web-based issue tracking repositories and get list of issues from the web UI into the Task List. + </p> + <p>It is also possible to link a + <i>local task</i> with the web page in web-based repository via the Mylyn Web integration. + </p> + <p> + <b>To create a task from any web-based repository:</b> + </p> + <ul> + <li>Drag the URL from the address bar of the browser, or from a hyperlink in a bug listing to the + <i>Mylyn Tasks</i> 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. + <b>In Mozilla:</b> simply drag the URL. + <b>In Internet Explorer:</b> you must have <code>Ctrl</code> pressed in order for Eclipse to recognize the drop. + </li> + <li> + <b>Alternatively,</b> you can copy the URL, press the + <i>New Task</i> button on the + <i>Mylyn Tasks</i> 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 <code>right+click</code> the task and select + <i>Open in External Browser</i>. + </li> + </ul> + <p> + <img border="0" src="images/mylar-tasklist-weblink-editor.gif"/> + </p> + <h2 id="Why_were_my_repository_credentials_reset.3F">Why were my repository credentials reset?</h2> + <p>If you upgrade Eclipse or your Java VM, you will need to reset your credentials in the + <i>Task Repositories</i> view because these are stored in the secure Eclipse workbench keyring. Also see + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=149607" target="mylyn_external">bug 149607</a>. If you are migrating + <b>from Eclipse 3.2 to 3.3</b> note that you will need to use a different update site, which is listed here: + <a href="http://eclipse.org/mylyn/dl.php" target="mylyn_external">http://eclipse.org/mylyn/dl.php</a> + </p> + <h2 id="Why_are_my_updated_repository_attributes_not_showing_up.3F">Why are my updated repository attributes not showing up?</h2> + <p>Your server’s repository attributes can change frequently, for example, there can be a new "milestone" or "version" added to the Bugzilla repository with each release. When the + <i>Preferences → Mylyn → Task List → Synchronization</i> setting is enabled, every 10th synchronization will update the attributes from the repository. If you do not have this setting enabled, your can force the update via the + <i>Update Attributes</i> action on the task repositories’ context menu in the + <i>Task Repositories</i> view. Note that you will need to reopen a task editor to see the updated attributes. If you instead update via the button on the + <i>Attributes</i> section of the + <i>Task Editor</i> the attribute settings will be reloaded without needing to reopen. + </p> + <p> + <b>bugs.eclipse.org users</b>: Note that the attributes listing on eclipse.org is mirrored, and the mirrors are only updated 24 hours. As such, you may need to wait up to 24 hours for the new attributes to show up. + </p> + <h2 id="Authentication_Troubleshooting">Authentication Troubleshooting</h2> + <p>You must ensure repository credentials are filled out correctly. Refer to the diagram below:</p> + <p> + <a href="/wiki/image:_AuthenticationTroubleshooting2.png" title="image: AuthenticationTroubleshooting2.png">right</a> + </p> + <ol> + <li>Enter the repository URL (i.e. + <a href="https://bugs.eclipse.org/bugs" target="mylyn_external">https://bugs.eclipse.org/bugs</a>) and an optional label + </li> + <li>Credentials + <ul> + <li>Usually email address and password </li> + <li>Some sites, such as <code>dev.eclipse.org</code>, use anonymous logon with password left blank.</li> + </ul> + </li> + <li>Http Authentication (optional) + <ul> + <li>Some sites are protected by either BASIC or DIGEST http authentication. If this is the case, enter appropriate credentials here.</li> + <li>One way to test if the site requires http authentication is to point your browser at the repository. If you are presented with an authentication dialog popup, the site is likely protected by http authentication.</li> + </ul> + </li> + <li>Proxy Server Configuration (optional) + <ul> + <li>By default Mylyn uses the Platform’s Install/Update proxy settings. Uncheck this box if you wish to use an alternative proxy.</li> + <li>If the proxy requires authentication, this is where you enable and enter your proxy credentials.</li> + <li>If you are experiencing connection problems, ensure your Install/Update proxy settings are valid or the repository specific settings are correct</li> + <li>Mylyn has been tested with HTTP proxy servers. Currently SOCKS is not supported.</li> + </ul> + </li> + <li>Validate Settings + <ul> + <li>Press the + <i>validate</i> button to test the settings + </li> + <li>If you are seeing errors like “HTTP Response Code 407” or “Proxy Authentication Error” it is likely that you need to configure proxy settings as described above.</li> + <li>If your sever uses a certificate and fails to connect, e.g. you see exceptions <tt>sun.security.validator.ValidatorException: PKIX path building failed</tt> then you need to point Eclipse at your certificate, see below.</li> + </ul> + </li> + </ol> + <h3 id="Certificate_authentication">Certificate authentication</h3> + <p>Mylyn supports authentication with certificates from a Java keystore. The path and password to the keystore need to be specified in system properties. These can be set in the eclipse.ini in your eclipse install directory:</p> + <pre>-vmargs +… +-Djavax.net.ssl.keyStore=/path/to/.eclipsekeystore +-Djavax.net.ssl.keyStorePassword=123456 +</pre> + <p>If your keystore does not have the default type (JKS) you can specify a different type:</p> + <pre>-Djavax.net.ssl.keyStoreType=PKCS12 +</pre> + <h4 id="Creating_a_keystore">Creating a keystore</h4> + <p>If you do not have a client certificate you can create one and have it signed by a CA:</p> + <pre>keytool -genkey -keyalg DSA -keysize 1024 +</pre> + <p>Use this command to create a new certificate signing request:</p> + <pre>keytool -certreq > client.csr +</pre> + <p>Submit the client.csr file to your CA for signing. The CA’s certificate as well as your signed certificate that is returned by the CA need to be imported into the keystore:</p> + <pre>keytool -importcert -alias ca -file ca.crt +keytool -importcert -file client.crt +</pre> + <p>See + <a href="http://java.sun.com/j2se/1.5.0/docs/guide/security/SecurityToolsSummary.html" target="mylyn_external">this page</a> for links to the keytool documentation. + </p> + <h3 id="NTLM_authentication">NTLM authentication</h3> + <p>For NTLM authentication to work a special format for the username needs to be used where + <i>DOMAIN</i> needs to be replaced by the Windows login domain: + </p> + <pre>DOMAIN\username +</pre> + <p>The built-in NTLM support of the JDK which is used by Eclipse does + <b>not work</b> with Mylyn since it uses the HttpClient library to access repositories. Limitations in regard to NTLM authentication are documented in the + <a href="http://wiki.apache.org/jakarta-httpclient/FrequentlyAskedNTLMQuestions" target="mylyn_external">NTLM FAQ</a> and also discussion on {{bug|201911}}. + </p> + <ul> + <li>If your repository uses MS NTLM authentication and only standard http authentication is being passed to the repository this can result when the local hostname cannot be resolved. Ensure your machine’s hostname is set correctly and resolves to a valid address.</li> + <li>It is not possible to use NTLM authentication for the proxy as well as for the repository.</li> + </ul> + <p>If NTLM authentication fails the + <b> + <a href="http://ntlmaps.sourceforge.net/" target="mylyn_external">NTLM Authorization Proxy Server</a> + </b> has been reported to + <b>work</b> with Mylyn. + </p> + <h2 id="Network_Troubleshooting">Network Troubleshooting</h2> + <h3 id="Performance_Problems_with_HTTPS">Performance Problems with HTTPS</h3> + <p>The built-in SSL support of the JDK will to a name lookup for each new connection. In case your network setup cannot resolve the host name (e.g. no proper name server), this lookup will time out, delaying the whole job. + If setting up a name server is not an option, a work around would be to edit your local hosts file, and add the server IP there (and, if possible, add your computer's IP to the server's hosts file).</p> + <h2 id="Why_are_task_hyperlinks_not_working.3F">Why are task hyperlinks not working?</h2> + <p>For task hyperlinks in textual editors (e.g. Java editor) and other text viewers (e.g. History view comments) you must associate the project that contains the resource to the task repository. </p> + <dl> + <dd> + <i>Project association can also come from 3rd party metadata trough the contrubuted + <a href="/wiki/Mylar_Integrator_Reference#Mapping_from_projects_to_Task_Repositories" title="Mylar_Integrator_Reference#Mapping_from_projects_to_Task_Repositories">extension point</a>. + <a href="http://subclipse.tigris.org/" target="mylyn_external">Subclipse</a> and + <a href="http://docs.codehaus.org/display/M2ECLIPSE/Integration+with+Mylyn" target="mylyn_external">Maven integration for Eclipse</a> plugins contributing it. See few more details + <a href="http://jroller.com/page/eu?entry=linking_projects_from_the_eclipse" target="mylyn_external">here</a>. + </i> + </dd> + </dl> + <p>Note that to view a hyperlink you must hold down the <code>Ctrl</code> key when hovering over the reference to the task. References to tasks are connector specific and the common reference is found on the top left of the task editor and other conventions tend to follow those used in the web UI (e.g. “bug 123” for Bugzilla, “ABC-123” for JIRA).</p> + <p> + <img border="0" src="images/mylyn-project-repository-association.gif"/> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Task-Editor.html" title="Task Editor"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Bugzilla-Connector.html" title="Bugzilla Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Task Editor</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Bugzilla Connector</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Team-Support.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Team-Support.html new file mode 100644 index 000000000..6550d4dd2 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Team-Support.html @@ -0,0 +1,113 @@ +<?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 FAQ - Team Support</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">Team Support</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Java-Development.html" title="Java Development"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="WikiText.html" title="WikiText"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Java Development</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">WikiText</td> + </tr> + </table><hr/> + <h1 id="Team_Support">Team Support</h1> + <h2 id="My_change_set_is_missing_or_doesn.E2.80.99t_contain_elements_it_should._Help.21">My change set is missing or doesn’t contain elements it should. Help!</h2> + <p>If a task change set disappears or is missing items, toggle the Incoming/Outgoing mode of the Synchronize view via its toolbar button. </p> + <h2 id="Why_does_task_change_set_not_appear_when_I_modify_files.3F">Why does task change set not appear when I modify files?</h2> + <p>A task change set should appear if you activate a task and modify a file connected to a compatible source repository (e.g. CVS, SVN). If it does not try the following:</p> + <ul> + <li>Ensure you have installed the [ + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">http://www.eclipse.org/mylyn/downloads/</a> + <i>Mylyn Bridge: Eclipse IDE</i> feature]. Note that previously this feature was named Eclipse SDK and not distributed with the Java-only Eclipse download ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=191793" target="mylyn_external">bug 191793</a>). + </li> + </ul> + <ul> + <li>If you are using Subclipse or Subversicve, make sure you have the respective integration for Mylyn installed.</li> + </ul> + <ul> + <li>Verify that the [[Mylyn/User_Guide#Configuring_the_Synchronize_view_for_change_sets|configured + <i>Synchronize View</i> is configured for change sets]]. + </li> + </ul> + <ul> + <li>Verify that Mylyn Tasks UI and Mylyn Team UI are enabled under General → Startup and Shutdown in the Eclipse preferences.</li> + </ul> + <p>If the above are working but the change set appears to be missing relevant files:</p> + <ul> + <li>You may be seeing the + <i>Synchronize</i> view’s refresh problem ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=142395" target="mylyn_external">bug 142395</a>). Toggle from + <i>Incoming/Ougtoing</i> to + <i>Incoming</i> mode and back again to refresh the view. + </li> + </ul> + <ul> + <li>If the files or change set are still missing deactivate and reactivate the task to force a full refresh.</li> + </ul> + <h2 id="Why_do_files_disappear_from_the_change_set_when_I_close_them.3F">Why do files disappear from the change set when I close them?</h2> + <p>If you have the + <i>Preferences → Mylyn → Context → Manage open editors to match task context</i> option enabled, Mylyn will perform editor management so that you don’t have to. Closing a file makes it less interesting, and causes it to disappear from the active task context, and hence from the change set. This option prevents you from having to manage the set of open files, will automatically close editors for files that become uninteresting, and will ensure that the open editors match the task context. + </p> + <h2 id="Why_am_I_missing_elements_when_I_retrieve_someone_else.E2.80.99s_context.3F">Why am I missing elements when I retrieve someone else’s context?</h2> + <p>To identify elements within a project, Mylyn relies on the name of the project being consistent across workspaces. If the project name in the workspace that the context was created with is different than its name in your workspace, the task context will not show elements within that project ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=164058" target="mylyn_external">bug 164058</a>). The other case where context can be lost is if the elements change names outside of the workspace ( + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=164243" target="mylyn_external">bug 164243</a>). + </p> + <p>The work-around is to use the same project names across your team’s workspaces. We recommend the following two approaches for standardizing on project names:</p> + <ul> + <li>Use + <b>Team Project Sets</b>: these are a very useful Eclipse facility that allows your entire team to check out numerous projects from version control by importing a single file. Create a project set via + <i>File → Export → Team Project Set</i>, host this file somewhere accessible, then have others import vai + <i>File → Import → Team Project Set</i>. + </li> + <li>Have developers check out projects into their workspace without renaming them. The above is a shortcut for doing this. If alphabetical sort order in the + <i>Package Explorer</i> is a problem, organize your projects via + <i>Project Explorer → view menu → Top Level Elements → Working Sets</i>. + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Java-Development.html" title="Java Development"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="WikiText.html" title="WikiText"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Java Development</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">WikiText</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Trac-Connector.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Trac-Connector.html new file mode 100644 index 000000000..9cdab2ebb --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Trac-Connector.html @@ -0,0 +1,155 @@ +<?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 FAQ - Trac Connector</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">Trac Connector</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="JIRA-Connector.html" title="JIRA Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Web-Templates-Connector.html" title="Web Templates Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">JIRA Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Web Templates Connector</td> + </tr> + </table><hr/> + <h1 id="Trac_Connector">Trac Connector</h1> + <h2 id="What_are_the_server_requirements.3F_2">What are the server requirements?</h2> + <p>The Trac connector supports two different access methods: The recommended XML-RPC mode offers complete integration with Mylyn but requires additional setup and privileges which may not be available to all users. Web mode offers less functionality but will work with any public Trac repository. </p> + <h4 id="XML-RPC_.28recommended.29">XML-RPC (recommended)</h4> + <p>Requirements:</p> + <ul> + <li>Trac 0.10 or later</li> + <li> + <a href="http://trac-hacks.org/wiki/XmlRpcPlugin" target="mylyn_external">XmlRpcPlugin</a> rev. 1950 or later + </li> + </ul> + <p>This access method offers editing of tasks in a rich editor, attachment support and offline editing. It requires the + <a href="http://trac-hacks.org/wiki/XmlRpcPlugin" target="mylyn_external">XmlRpcPlugin</a> for Trac to be enabled for the accessed repository. The XmlRpcPlugin provides a remote interface to the Trac repository and is distributed separately from Trac (see + <a href="http://trac.edgewall.org/ticket/217" target="mylyn_external">#217</a>). See these + <a href="http://trac-hacks.org/wiki/XmlRpcPlugin#Installation" target="mylyn_external">install instructions</a> for requirements and documentation. + </p> + <p>In order to access the repository through XML_RPC each user needs to have the corresponding permission which can be configured through Trac's admin tool:</p> + <pre>trac-admin </path/to/projenv> permission add <user> XML_RPC +</pre> + <h4 id="Web">Web</h4> + <p>Requirements:</p> + <ul> + <li>Trac 0.9 or later</li> + </ul> + <p>In this mode the standard Trac web interface is used for repository access. Tickets may be created and edited through a web browser. Offline editing and attachments are not supported.</p> + <h2 id="Recommended_Trac_version">Recommended Trac version</h2> + <p>Mylyn works with any stable Trac release that is version 0.9 or later (see below for known limitations). Mylyn works best when used with Trac’s XML-RPC Plugin (see above) but we do not recommend a particular Trac version. </p> + <p>The Trac connector tests are run against these Trac versions:</p> + <ul> + <li>Trac 0.11.6, XML-RPC Plugin 1.0.6 (r7194)</li> + <li>Trac 0.10.5, XML-RPC Plugin 0.0.2 (r2125)</li> + <li>Trac 0.9.6 (support ended with Mylyn 3.3)</li> + </ul> + <h2 id="Does_Mylyn_support_Trac_0.11.3F">Does Mylyn support Trac 0.11?</h2> + <p>When Mylyn 3.2.1 or later is used with the latest version of the + <a href="http://trac-hacks.org/wiki/XmlRpcPlugin" target="mylyn_external">Trac XmlRpcPlugin</a> from + <a href="http://trac-hacks.org/svn/xmlrpcplugin/trunk/" target="mylyn_external">SVN trunk</a> the Mylyn Trac connector is fully functional ({{bug|175211}}. + </p> + <h2 id="Why_do_I_get_an_HTTP_Error_500_Internal_server_error_when_creating_a_ticket_that_contains_non-ASCII_characters.3F">Why do I get an HTTP Error 500 Internal server error when creating a ticket that contains non-ASCII characters?</h2> + <p>Problems related to character encodings have been reported when Trac is run with Python 2.3. Upgrading to Python 2.4 may help to resolve this. Please comment on + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=188363" target="mylyn_external">bug #188363</a> if you encounter an internal server error when creating a ticket that contains non-ASCII characters. + </p> + <h2 id="Known_limitations_3">Known limitations</h2> + <ul> + <li>Trac 0.10.1 + <ul> + <li>Known incompatibility with Trac XML-RPC Plugin. See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=164272" target="mylyn_external">bug 164272</a> for details. + </li> + </ul> + </li> + <li>Trac 0.10.3 + <ul> + <li>Known incompatibility with old versions of the Trac HttpAuthPlugin (fixed in revision 1890 or later). The plug-in enables basic auth for XML-RPC when Trac AccountManagerPlugin for form based authentication is used. See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=168413" target="mylyn_external">bug 168413</a> for details. + </li> + </ul> + </li> + <li>Trac 0.11 + <ul> + <li>Known incompatibility with XML-RPC Plugin version 1.0.2 - 1.0.5. Using 1.0.6 or later is recommended.</li> + </ul> + </li> + </ul> + <h2 id="Why_are_tasks_opened_in_a_web_browser_and_not_in_the_rich_editor.3F">Why are tasks opened in a web browser and not in the rich editor?</h2> + <p>Please make sure that the access type in the repository properties is set to XML-RPC. This requires Trac 0.10 and XML-RPC (see above).</p> + <h2 id="Which_URLs_does_Mylyn_access_in_a_Trac_repository.3F">Which URLs does Mylyn access in a Trac repository?</h2> + <p>XML-RPC:</p> + <ul> + <li>The expected URL is either /xmlrpc or /login/xmlrpc (if login credentials are provided)</li> + </ul> + <p>Web:</p> + <ul> + <li>Authentication: /login </li> + <li>Querying: /query?format=tab…</li> + <li>Synchronizing ticket details: /ticket/…</li> + <li>Getting repository configuration to populate query dialog: /query or /newticket</li> + </ul> + <p>The web mode relies on screen scraping and is likely to fail if the design + (i.e. HTML output) of the Trac repository is heavily customized.</p> + <h2 id="Problems_opening_the_web_editor_on_Linux">Problems opening the web editor on Linux</h2> + <p>If you’re having problems opening the web task editor on Linux and the message + <b>Could not create Browser page: XPCOM error -2147221164</b> appears in the error log, try installing the packages + <b>xulrunner</b> and + <b>xulrunner-gnome-support</b> on your Linux distribution. + </p> + <h2 id="Which_Trac_Plugins_are_supported_by_Mylyn.3F">Which Trac Plugins are supported by Mylyn?</h2> + <ul> + <li> + <a href="http://trac-hacks.org/wiki/XmlRpcPlugin" target="mylyn_external">XML-RPC Plugin</a> for rich-editing and attachment support + </li> + <li> + <a href="http://trac-hacks.org/wiki/AccountManagerPlugin" target="mylyn_external">Account Manager Plugin</a> for form-based authentication (Mylyn 2.0 or higher) + </li> + <li> + <a href="http://trac-hacks.org/wiki/MasterTicketsPlugin" target="mylyn_external">Master Tickets Plugin</a> for sub-task support (Mylyn 2.3 or higher) + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="JIRA-Connector.html" title="JIRA Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Web-Templates-Connector.html" title="Web Templates Connector"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">JIRA Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Web Templates Connector</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Updating-This-Document.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Updating-This-Document.html new file mode 100644 index 000000000..786dfed58 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Updating-This-Document.html @@ -0,0 +1,54 @@ +<?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 FAQ - Updating This Document</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">Updating This Document</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Misc.html" title="Misc"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Misc</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table><hr/> + <h1 id="Updating_This_Document">Updating This Document</h1> + <p>This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit + + <a href="http://wiki.eclipse.org/Mylyn/FAQ" target="mylyn_external">http://wiki.eclipse.org/Mylyn/FAQ</a> + </p><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Misc.html" title="Misc"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"></td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Misc</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top"></td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Web-Templates-Connector.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Web-Templates-Connector.html new file mode 100644 index 000000000..f6003ba7f --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/Web-Templates-Connector.html @@ -0,0 +1,103 @@ +<?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 FAQ - Web Templates Connector</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">Web Templates Connector</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Trac-Connector.html" title="Trac Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Task-Focused-UI.html" title="Task-Focused UI"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Trac Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Task-Focused UI</td> + </tr> + </table><hr/> + <h1 id="Web_Templates_Connector">Web Templates Connector</h1> + <h2 id="Where_can_I_find_the_Web_Templates_connector.3F">Where can I find the Web Templates connector?</h2> + <p>It is available from the incubator update site. Please see + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">http://www.eclipse.org/mylyn/downloads/</a> . + </p> + <h2 id="Why_can.E2.80.99t_I_connect_using_one_of_the_existing_templates.3F">Why can’t I connect using one of the existing templates?</h2> + <p>The Web Connector have a “Preview” button in “Advanced Configuration” section in the “Query” preferences dialog. If you get an error or preview table does not show the expected list, you can use “Open” button to verify if web page downloaded by the Web Connector is correct. </p> + <p>Alternatively, you can use Query Pattern like + ({Description}.+?)({Id}\n) to see content of the retrieved page in preview table and compare it with the source of the web page for the same url loaded into the web browser.</p> + <p>If retrieved web page is correct, but “Preview” don’t show expected results you need to check the “Query Pattern”. A popular mistake is an unmasked ‘?’ that separates request parameters in the url). For example:</p> + <pre><a href="show_bug.cgi\?id\=(.+?)">.+?<span class="summary">(.+?)</span> +</pre> + <p>If you don’t see the correct web page, check the following:</p> + <ul> + <li>query URL or substituted parameters are correct + <ul> + <li> + <b>Note:</b> only the parameters are URL-encoded, e.g. the query URL <tt>x:${y}</tt> with the substituted parameter <tt>${y}</tt> set to <tt>a:b</tt> gets “<tt>x:a%3Ab</tt>” (only the substituted parameters are URL encoded + </li> + </ul> + </li> + <li>web application require user to login and login configuration in the Web Connector repository configuration is correct (see Web Connector repository settings)</li> + </ul> + <p>To debug web application auth further, you could use the wget tool (on Windows it available as a standalone command line tool and also included with Cygwin) and run the following command:</p> + <pre>wget -v -d -o query.log -O query.html "http://your.query.url" +</pre> + <p>If repository require basic http auth, you’ll need to use ''--http-user=USER'' and ''--http-password=PASS'' options.</p> + <p>Then open file + <i>query.html</i> in the web browser and check if it show list of issues you need to fetch from the web server. If it does have correct list, then there could be a problem with query pattern used for parsing. + </p> + <p>If + <i>query.html</i> does not show expected list of issues you can check + <i>query.log</i> for server responses and try to identify if server require authentication, redirecting your requests somewhere or issue any other errors. + </p> + <h2 id="Known_limitations_4">Known limitations</h2> + <ul> + <li>In Mylyn 1.0: if a web server responds by requesting a redirect to an absolute URL while fetching a resource, the connector falsely prepends “/” to the URL and the request will fail. The workaround is to use final url where redirect is pointing to (you can find it as describe above). See + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=167282" target="mylyn_external">bug 167282</a> for details. + </li> + </ul> + <h2 id="Where_can_I_find_additional_templates.3F">Where can I find additional templates?</h2> + <ul> + <li> + <a href="http://alblue.blogspot.com/2009/04/google-code-and-mylyn-redux.html" target="mylyn_external">Instructions for Google Code</a> + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Trac-Connector.html" title="Trac Connector"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Task-Focused-UI.html" title="Task-Focused UI"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Trac Connector</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Task-Focused UI</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/WikiText.html b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/WikiText.html new file mode 100644 index 000000000..0239d7886 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/WikiText.html @@ -0,0 +1,133 @@ +<?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 FAQ - WikiText</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">WikiText</th> + </tr> + <tr> + <td style="width: 20%" align="left"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right"> + <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Integration with other tools</td> + </tr> + </table><hr/> + <h1 id="WikiText">WikiText</h1> + <h2 id="What_is_WikiText.3F">What is WikiText?</h2> + <p>WikiText is a set of plug-ins for Eclipse that provide lightweight markup (wiki) parsing, editing and display capabilities to the Eclipse platform and Mylyn. WikiText provides a parser for wiki markup and converts the markup to HTML, Docbook, DITA, or Eclipse Help format, either via the API or by using Ant tasks. WikiText also provides UI components (such as an editor) integrating with Eclipse and the Mylyn task editor.</p> + <h2 id="Where_can_I_get_WikiText.3F">Where can I get WikiText?</h2> + <p>WikiText is available on the Mylyn update site. Unreleased weekly builds are also available via the Mylyn Weekly Builds update site. See the + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">Mylyn Downloads</a> for details. + </p> + <p>A stand-alone WikiText package is also available for download from the + <a href="http://www.eclipse.org/mylyn/downloads/" target="mylyn_external">Mylyn Downloads</a> page. + </p> + <h2 id="How_does_WikiText_integrate_with_Mylyn.3F">How does WikiText integrate with Mylyn?</h2> + <p>WikiText extends the Mylyn task editor to be markup-aware. Comments and description text is formatted according to the configured markup language. The description and comment editors are aware of markup and provide content assist, markup help and preview.</p> + <p>More details can be found here: + <a href="http://tasktop.com/blog/eclipse/rich-editing-for-tasks-via-mylyn-wikitext" target="mylyn_external">Rich Editing for Tasks via Mylyn WikiText (Mik Kersten)</a> + </p> + <h2 id="How_do_I_enable.2Fdisable_WikiText_extensions_to_Mylyn.3F">How do I enable/disable WikiText extensions to Mylyn?</h2> + <p>This is done on a per-repository basis. When WikiText is installed it is automatically enabled for all configured task repositories for which there is a default markup language setting.</p> + <p>To change the default settings open the Mylyn <i>Task Repositories</i> view, right-click your task repository and select <i>Properties</i> from the context menu. In the properties dialog choose the <i>Editor</i> settings (you may need to click on it to expand the section).</p> + <p>To disable WikiText for your repository, select <i>Plain Text</i>.</p> + <p>To enable WikiText for your repository, select the desired markup language. The default markup language if available for your repository is labeled <i>(default)</i></p> + <h2 id="Where_can_I_find_WikiText_documentation.3F">Where can I find WikiText documentation?</h2> + <p>WikiText documentation is installed into the Eclipse help system when WikiText is installed. To see the WikiText documentation open Eclipse, from the <i>Help</i> menu open <i>Help Contents</i>. You will find the <i>WikiText User Guide</i> under <i>Tasks</i> in the table of contents. If you're interested in integrating with WikiText then take a look at the <i>WikiText Developer Guide</i>.</p> + <p>The same WikiText documentation is also available in the stand-alone distribution and online:</p> + <ul> + <li> + <a href="http://help.eclipse.org/galileo/topic/org.eclipse.mylyn.wikitext.help.ui/help/Mylyn%20WikiText%20User%20Guide.html" target="mylyn_external">WikiText User Guide</a> + </li> + <li> + <a href="http://help.eclipse.org/galileo/topic/org.eclipse.mylyn.wikitext.help.ui/help/devguide/WikiText%20Developer%20Guide.html" target="mylyn_external">WikiText Developer Guide</a> + </li> + </ul> + <h2 id="How_do_I_run_the_WikiText_Ant_tasks.3F">How do I run the WikiText Ant tasks?</h2> + <p>The WikiText documentation provides detailed information on how this is done in the <i>WikiText User Guide</i>.</p> + <h2 id="Can_I_use_WikiText_without_Eclipse.3F">Can I use WikiText without Eclipse?</h2> + <p>Yes, the WikiText markup parser and Ant tasks may be used outside of Eclipse without reference to any Eclipse classes.</p> + <p>Detailed information about using WikiText APIs is available within the <i>WikiText Developer Guide</i>. Information about using WikiText Ant tasks is available within the <i>WikiText User Guide</i>.</p> + <h2 id="What_output_can_WikiText_create.3F">What output can WikiText create?</h2> + <p>WikiText can create HTML, Eclipse Help, DITA, DocBook and FOP from wiki markup. Using the WikiText APIs you can also extend WikiText to create other output formats. + DITA, DocBook and FOP can all be used to create PDF. More information is available in the <i>WikiText User Guide</i>.</p> + <h2 id="What_wiki_markup_languages_does_WikiText_support.3F">What wiki markup languages does WikiText support?</h2> + <p>WikiText can parse the following markup languages:</p> + <ul> + <li>Confluence</li> + <li>MediaWiki</li> + <li>Textile</li> + <li>TracWiki</li> + <li>TWiki</li> + </ul> + <p>WikiText is also designed to make it easy to add support for new markup languages.</p> + <h2 id="Where_can_I_find_out_more_about_WikiText.3F">Where can I find out more about WikiText?</h2> + <ul> + <li> + <a href="http://greensopinion.blogspot.com/2009/03/mylyn-wikitext-10-released.html" target="mylyn_external">Mylyn WikiText 1.0 Released (David Green)</a> + </li> + <li> + <a href="http://tasktop.com/blog/eclipse/rich-editing-for-tasks-via-mylyn-wikitext" target="mylyn_external">Rich Editing for Tasks via Mylyn WikiText (Mik Kersten)</a> + </li> + <li> + <a href="http://www.peterfriese.de/getting-started-with-wikitext/" target="mylyn_external">Getting started with WikiText (Peter Friese)</a> + </li> + <li> + <a href="http://www.peterfriese.de/advanced-wikitext/" target="mylyn_external">Advanced WikiText (Peter Friese)</a> + </li> + <li> + <a href="http://greensopinion.blogspot.com/2009/04/mylyn-wikitext-produces-pdf.html" target="mylyn_external">Mylyn WikiText Produces PDF (David Green)</a> + </li> + <li> + <a href="/wiki/Mylyn/WikiText" title="Mylyn/WikiText">Mylyn WikiText wiki</a> + </li> + <li> + <a href="/wiki/Mylyn/Incubator/WikiText" title="Mylyn/Incubator/WikiText">The original WikiText incubation project page</a> + </li> + <li> + <a href="http://greensopinion.blogspot.com/2008/08/textile-j-is-moving-to-mylyn-wikitext.html" target="mylyn_external">Textile-J Is Moving to Mylyn WikiText</a> + </li> + </ul><hr/> + <table class="navigation" style="width: 100%;" border="0" summary="navigation"> + <tr> + <td style="width: 20%" align="left"> + <a href="Team-Support.html" title="Team Support"> + <img alt="Previous" border="0" src="../../images/prev.gif"/> + </a> + </td> + <td style="width: 60%" align="center"> + <a href="FAQ.html" title="Mylyn FAQ"> + <img alt="Mylyn FAQ" border="0" src="../../images/home.gif"/> + </a> + </td> + <td style="width: 20%" align="right"> + <a href="Integration-with-other-tools.html" title="Integration with other tools"> + <img alt="Next" border="0" src="../../images/next.gif"/> + </a> + </td> + </tr> + <tr> + <td style="width: 20%" align="left" valign="top">Team Support</td> + <td style="width: 60%" align="center"></td> + <td style="width: 20%" align="right" valign="top">Integration with other tools</td> + </tr> + </table> + </body> +</html>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/AuthenticationTroubleshooting2.png b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/AuthenticationTroubleshooting2.png Binary files differnew file mode 100644 index 000000000..90dc13f03 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/AuthenticationTroubleshooting2.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Jira-advanced-configuration.png b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Jira-advanced-configuration.png Binary files differnew file mode 100644 index 000000000..fe9e509c0 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Jira-advanced-configuration.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-content-assist-prefs.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-content-assist-prefs.gif Binary files differnew file mode 100644 index 000000000..47e59b973 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-content-assist-prefs.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-eclipse-manage-configuration.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-eclipse-manage-configuration.gif Binary files differnew file mode 100644 index 000000000..dbafa4af2 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-eclipse-manage-configuration.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-java-filtering-declarations.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-java-filtering-declarations.gif Binary files differnew file mode 100644 index 000000000..9362a231f --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-java-filtering-declarations.gif diff --git a/org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-resource-exclusion.gif Binary files differindex 833f71685..833f71685 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/mylar-resource-exclusion.gif +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-resource-exclusion.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-spell-checking-preference.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-spell-checking-preference.gif Binary files differnew file mode 100644 index 000000000..2cf5f62a7 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-spell-checking-preference.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-tasklist-weblink-editor.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-tasklist-weblink-editor.gif Binary files differnew file mode 100644 index 000000000..dd903ec8e --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylar-tasklist-weblink-editor.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-content-assist-timeout.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-content-assist-timeout.gif Binary files differnew file mode 100644 index 000000000..21e6500e5 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-content-assist-timeout.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-project-repository-association.gif b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-project-repository-association.gif Binary files differnew file mode 100644 index 000000000..20899d93e --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Mylyn-project-repository-association.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Tasklist-filter.png b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Tasklist-filter.png Binary files differnew file mode 100644 index 000000000..c8c6f0967 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Tasklist-filter.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-admin.png b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-admin.png Binary files differnew file mode 100644 index 000000000..119f39c30 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-admin.png diff --git a/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-mylyn.png b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-mylyn.png Binary files differnew file mode 100644 index 000000000..4b1e67c75 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/FAQ/images/Time-tracking-jira-mylyn.png diff --git a/org.eclipse.mylyn.help.ui/userguide/Preferences.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html index f71953d51..f42b0bf22 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Preferences.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Preferences.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Preferences</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Preferences</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Shortcuts.html" title="Shortcuts"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -119,17 +119,17 @@ <tr> <td style="width: 20%" align="left"> <a href="Shortcuts.html" title="Shortcuts"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"> <a href="Task-Repository-Connectors.html" title="Task Repository Connectors"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html index 23e5f2102..11d22a946 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Shortcuts.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Shortcuts.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Shortcuts</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Shortcuts</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Team-Support.html" title="Team Support"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Preferences.html" title="Preferences"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -83,17 +83,17 @@ <tr> <td style="width: 20%" align="left"> <a href="Team-Support.html" title="Team Support"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"> <a href="Preferences.html" title="Preferences"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html index 294c56537..4045f842b 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Editor.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Editor.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Task Editor</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Task Editor</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Repositories.html" title="Task Repositories"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Task-Focused-Interface.html" title="Task-Focused Interface"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -193,17 +193,17 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Repositories.html" title="Task Repositories"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"> <a href="Task-Focused-Interface.html" title="Task-Focused Interface"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Focused-Interface.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html index 5dc7e9ebe..1bd00e745 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Focused-Interface.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Focused-Interface.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Task-Focused Interface</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Task-Focused Interface</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Editor.html" title="Task Editor"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Team-Support.html" title="Team Support"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -83,17 +83,17 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Editor.html" title="Task Editor"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"> <a href="Team-Support.html" title="Team Support"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repositories.html index 71cb2a98e..562007ef2 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Repositories.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repositories.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Task Repositories</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Task Repositories</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -12,19 +12,19 @@ </tr> <tr> <td style="width: 20%" align="left"> - <a href="Mylyn Reference.html" title="Task List"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <a href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Previous" border="0" src="../../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"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Task List</td> + <td style="width: 20%" align="left" valign="top">Mylyn User Guide</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task Editor</td> </tr> @@ -51,23 +51,23 @@ <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> - <a href="Mylyn Reference.html" title="Task List"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <a href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../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"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> <tr> - <td style="width: 20%" align="left" valign="top">Task List</td> + <td style="width: 20%" align="left" valign="top">Mylyn User Guide</td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right" valign="top">Task Editor</td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html index 2bd426769..ebb426956 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Task-Repository-Connectors.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Task-Repository-Connectors.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Task Repository Connectors</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Task Repository Connectors</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Preferences.html" title="Preferences"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -34,22 +34,22 @@ <b>Connector</b> to your particular repository. </p> <p>See - <a href="http://wiki.eclipse.org/Mylyn/Extensions" title="Mylyn/Extensions" target="mylyn_external">Mylyn Extensions</a> for a list of available connectors. + <a href="/wiki/Mylyn/Extensions" title="Mylyn/Extensions">Mylyn Extensions</a> for a list of available connectors. </p> <h2 id="Bugzilla_Connector">Bugzilla Connector</h2> <p>See - <a href="http://wiki.eclipse.org/Mylyn/FAQ#Bugzilla_Connector" title="Mylyn/FAQ#Bugzilla_Connector" target="mylyn_external">Bugzilla Connector Troubleshooting</a>. + <a href="../../Mylyn/FAQ/Bugzilla-Connector.html#Bugzilla_Connector" title="Mylyn/FAQ#Bugzilla_Connector">Bugzilla Connector Troubleshooting</a>. </p> <h2 id="Trac_Connector">Trac Connector</h2> <p>See - <a href="http://wiki.eclipse.org/Mylyn/FAQ#Trac_Connector" title="Mylyn/FAQ#Trac_Connector" target="mylyn_external">Trac Connector Troubleshooting</a>. + <a href="../../Mylyn/FAQ/Trac-Connector.html#Trac_Connector" title="Mylyn/FAQ#Trac_Connector">Trac Connector Troubleshooting</a>. </p> <h2 id="JIRA_Connector">JIRA Connector</h2> <p>See <a href="http://confluence.atlassian.com/display/JIRAEXT/Mylyn" target="mylyn_external">this page</a> for install instructions and additional screen shots. Note that the Mylyn JIRA connector requires at least JIRA version 3.3.3 and SOAP/RPC services have to be enabled on the server. </p> <p>See also - <a href="http://wiki.eclipse.org/Mylyn/FAQ#JIRA_Connector" title="Mylyn/FAQ#JIRA_Connector" target="mylyn_external">JIRA Connector Troubleshooting</a>. + <a href="../../Mylyn/FAQ/JIRA-Connector.html#JIRA_Connector" title="Mylyn/FAQ#JIRA_Connector">JIRA Connector Troubleshooting</a>. </p> <h2 id="Generic_Web_Templates_Connector">Generic Web Templates Connector</h2> <p>The generic web repository connector is NOT part of the default Mylyn install. You can install it from the incubator update site. See @@ -61,7 +61,7 @@ <li>IssueZilla (<code>java.net, dev2dev, tigris.org</code>)</li> <li>GForge (<code>objectweb.org</code>)</li> <li>SourceForge (<code>sf.net</code>), see - <a href="http://wiki.eclipse.org/Mylyn/Using_Sourceforge_with_Mylyn" title="Using Sourceforge with Mylyn" target="mylyn_external">Using Sourceforge with Mylyn</a> + <a href="/wiki/Using_Sourceforge_with_Mylyn" title="Using Sourceforge with Mylyn">Using Sourceforge with Mylyn</a> </li> <li>Mantis (<code>www.futureware.biz/mantis</code>)</li> <li>ChangeLogic (<code>changelogic.araneaframework.org</code>)</li> @@ -76,7 +76,7 @@ <i>Edit Query</i> page. </p> <p>See - <a href="http://wiki.eclipse.org/Mylyn/FAQ#Web_Templates_Connector" title="Mylyn/FAQ#Web_Templates_Connector" target="mylyn_external">FAQ</a> for the troubleshooting tips. + <a href="../../Mylyn/FAQ/Web-Templates-Connector.html#Web_Templates_Connector" title="Mylyn/FAQ#Web_Templates_Connector">FAQ</a> for the troubleshooting tips. </p> <p> <b>For example</b>, consider the configuration steps for GlassFish project at <code>java.net</code>: @@ -173,23 +173,23 @@ <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> + <a href="/wiki/Category:Draft_Documentation" title="Category:Draft Documentation">Category:Draft Documentation</a> </p><hr/> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> <tr> <td style="width: 20%" align="left"> <a href="Preferences.html" title="Preferences"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../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"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html index 60e34832c..ebc0d2506 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Team-Support.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Team-Support.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Team Support</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Team Support</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,13 +13,13 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Focused-Interface.html" title="Task-Focused Interface"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Shortcuts.html" title="Shortcuts"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -82,17 +82,17 @@ <tr> <td style="width: 20%" align="left"> <a href="Task-Focused-Interface.html" title="Task-Focused Interface"> - <img alt="Previous" border="0" src="images/images/prev.gif"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"> <a href="Shortcuts.html" title="Shortcuts"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Updating-This-Document.html index bfc1a3931..569b366fc 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Updating-This-Document.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/Updating-This-Document.html @@ -2,8 +2,8 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference - Updating This Document</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide - Updating This Document</title> + <link type="text/css" rel="stylesheet" href="../../book.css"/> </head> <body> <table class="navigation" style="width: 100%;" border="0" summary="navigation"> @@ -13,7 +13,7 @@ <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"/> + <img alt="Previous" border="0" src="../../images/prev.gif"/> </a> </td> <td style="width: 60%" align="center"></td> @@ -34,12 +34,12 @@ <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"/> + <img alt="Previous" border="0" src="../../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 href="User-Guide.html" title="Mylyn User Guide"> + <img alt="Mylyn User Guide" border="0" src="../../images/home.gif"/> </a> </td> <td style="width: 20%" align="right"></td> diff --git a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html index 8836e9187..0642b94e2 100644 --- a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference.html +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/User-Guide.html @@ -2,20 +2,20 @@ <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> - <title>Mylyn Reference</title> - <link type="text/css" rel="stylesheet" href="book.css"/> + <title>Mylyn User Guide</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">Mylyn Reference</th> + <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="Task-Repositories.html" title="Task Repositories"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> @@ -395,7 +395,7 @@ <td style="width: 60%" align="center"></td> <td style="width: 20%" align="right"> <a href="Task-Repositories.html" title="Task Repositories"> - <img alt="Next" border="0" src="images/images/next.gif"/> + <img alt="Next" border="0" src="../../images/next.gif"/> </a> </td> </tr> diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Focused-Editor.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Focused-Editor.png Binary files differindex 8bff3c9a5..8bff3c9a5 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Focused-Editor.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Focused-Editor.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Local-Task.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Local-Task.png Binary files differindex 07d702a18..07d702a18 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Local-Task.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Local-Task.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Package-Explorer-Focused.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Package-Explorer-Focused.png Binary files differindex a33cc75d3..a33cc75d3 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Guide-3.0-Package-Explorer-Focused.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Guide-3.0-Package-Explorer-Focused.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-Task-Repository.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-Task-Repository.png Binary files differindex 3c0075797..3c0075797 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-Task-Repository.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-Task-Repository.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-To-Context.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-To-Context.png Binary files differindex e0e920aff..e0e920aff 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Add-To-Context.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Add-To-Context.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Category-Progress.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Category-Progress.png Binary files differindex 111cb8aa9..111cb8aa9 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Category-Progress.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Category-Progress.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Change-Sets.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Change-Sets.png Binary files differindex def07dff4..def07dff4 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Change-Sets.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Change-Sets.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Context-Tab.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Context-Tab.png Binary files differindex e59221960..e59221960 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Context-Tab.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Context-Tab.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Error-Log.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Error-Log.png Binary files differindex 8dbf3704f..8dbf3704f 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Error-Log.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Error-Log.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Query-Combined.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Query-Combined.png Binary files differindex 77015c7f0..77015c7f0 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Query-Combined.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Query-Combined.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Task.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Task.png Binary files differindex d76413da9..d76413da9 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-New-Task.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-New-Task.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Open-Task.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Open-Task.png Binary files differindex 6077edeee..6077edeee 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Open-Task.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Open-Task.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Planning-Tab.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Planning-Tab.png Binary files differindex 2b497afd4..2b497afd4 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Planning-Tab.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Planning-Tab.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Bottom.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Bottom.png Binary files differindex fecfde95c..fecfde95c 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Bottom.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Bottom.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Top.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Top.png Binary files differindex f422e7c7f..f422e7c7f 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-Editor-Top.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-Editor-Top.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Categorized.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Categorized.png Binary files differindex 650c0539a..650c0539a 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Categorized.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Categorized.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png Binary files differindex 6784a64fb..6784a64fb 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Presentation-Select.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Tooltip.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Tooltip.png Binary files differindex 1b760b18f..1b760b18f 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Task-List-Tooltip.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Task-List-Tooltip.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-UI-Legend.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png Binary files differindex 960138276..960138276 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-UI-Legend.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-UI-Legend.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Weekly-Progress.png b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Weekly-Progress.png Binary files differindex b6b52d7d5..b6b52d7d5 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Feature-Reference-3.0-Weekly-Progress.png +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Feature-Reference-3.0-Weekly-Progress.png diff --git a/org.eclipse.mylyn.help.ui/userguide/images/Generic-web-repository-settings.gif b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Generic-web-repository-settings.gif Binary files differindex 1f3b766da..1f3b766da 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/Generic-web-repository-settings.gif +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/Generic-web-repository-settings.gif diff --git a/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerQuery.jpg b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerQuery.jpg Binary files differnew file mode 100644 index 000000000..bfe01cea9 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerQuery.jpg diff --git a/org.eclipse.mylyn.help.ui/userguide/images/XPlannerTaskEditor.gif b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerTaskEditor.gif Binary files differindex 8266a4cf3..8266a4cf3 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/XPlannerTaskEditor.gif +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerTaskEditor.gif diff --git a/org.eclipse.mylyn.help.ui/userguide/images/XPlannerUserStoryEditor.gif b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerUserStoryEditor.gif Binary files differindex 06b688ee8..06b688ee8 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/XPlannerUserStoryEditor.gif +++ b/org.eclipse.mylyn.help.ui/Mylyn/User_Guide/images/XPlannerUserStoryEditor.gif diff --git a/org.eclipse.mylyn.help.ui/book.css b/org.eclipse.mylyn.help.ui/book.css new file mode 100644 index 000000000..84d8880f2 --- /dev/null +++ b/org.eclipse.mylyn.help.ui/book.css @@ -0,0 +1 @@ +@import "../PRODUCT_PLUGIN/book.css"; diff --git a/org.eclipse.mylyn.help.ui/build-helper.xml b/org.eclipse.mylyn.help.ui/build-helper.xml index d83cacd92..52d30d5d8 100644 --- a/org.eclipse.mylyn.help.ui/build-helper.xml +++ b/org.eclipse.mylyn.help.ui/build-helper.xml @@ -42,72 +42,32 @@ </target> <target name="all" depends="init" description="Generate Eclipse help content for the Mylyn user guide"> - <eclipse-wiki-to-help - help.doc.filenamenoextension="Mylyn Reference" - help.doc.url.base="${mylyn.help.doc.url.base}" - help.doc.pageName="Mylyn/User_Guide" - help.imagefolder="${imageFolder}" - targetfolder="userguide" - wiki.url.base="${mylyn.help.doc.url.base}/Mylyn"/> - <replaceregexp file="userguide/Mylyn Reference-toc.xml" match="(<topic.*?href="userguide/Task-Repository-Connectors.html.*?>(\s*<topic\s*href=".*?"\s*label=".*">\s*?</topic>)+)(\s*)(</topic>)" - replace="\1\3<anchor id="additions-repository-connectors"/>\3\4" - flags="s"/> - </target> - - <macrodef name="eclipse-wiki-to-help"> - <attribute name="help.doc.url.base"/> - <attribute name="wiki.url.base"/> - <attribute name="help.doc.pageName"/> - <attribute name="help.doc.filenameNoExtension"/> - <attribute name="help.imageFolder"/> - <attribute name="targetFolder"/> - <sequential> - <get dest="tmp/@{help.doc.filenameNoExtension}.mediawiki" src="@{help.doc.url.base}/index.php?title=@{help.doc.pageName}&action=raw"/> - <echo append="true" file="tmp/@{help.doc.filenameNoExtension}.mediawiki"> + + <mediawiki-to-eclipse-help + wikiBaseUrl="${mylyn.help.doc.url.base}" + validate="true" + failonvalidationerror="true" + prependImagePrefix="${imageFolder}" + formatoutput="true" + defaultAbsoluteLinkTarget="mylyn_external" + dest="${basedir}" + title="Mylyn" + generateUnifiedToc="false"> + <path name="Mylyn/User_Guide" title="Mylyn User Guide" generateToc="true"/> + <path name="Mylyn/FAQ" title="Mylyn FAQ" generateToc="true"/> + <stylesheet url="book.css"/> + <pageAppendum> = Updating This Document = This document is maintained in a collaborative wiki. If you wish to update or modify this document please visit -@{help.doc.url.base}/@{help.doc.pageName} - </echo> - - <copy todir="tmp"> - <fileset dir="images"/> - </copy> - <mediawiki-fetch-images dest="tmp" url="@{help.doc.url.base}" pageName="@{help.doc.pageName}"/> - - - <wikitext-to-eclipse-help markupLanguage="org.eclipse.mylyn.wikitext.mediawiki.core.MediaWikiLanguage" - multipleOutputFiles="true" - navigationImages="true" - helpPrefix="@{targetFolder}" - internallinkpattern="@{wiki.url.base}/{0}" - validate="true" - failonvalidationerror="true" - prependImagePrefix="${imageFolder}" - formatoutput="true" - defaultAbsoluteLinkTarget="mylyn_external"> - <fileset dir="tmp" includes="**/*.mediawiki"/> - <stylesheet url="book.css"/> - </wikitext-to-eclipse-help> - - <mkdir dir="@{targetFolder}/${imageFolder}"/> - <copy todir="@{targetFolder}/${imageFolder}" overwrite="true"> - <fileset dir="tmp"> - <include name="*.gif"/> - <include name="*.png"/> - </fileset> - </copy> - <copy todir="@{targetFolder}" overwrite="true"> - <fileset dir="tmp"> - <include name="*.html"/> - <include name="*toc.xml"/> - <exclude name="help.doc.html"/> - </fileset> - </copy> - <antcall target="test"/> - </sequential> - </macrodef> +{url}</pageAppendum> + </mediawiki-to-eclipse-help> + <replaceregexp file="Mylyn-User-Guide-toc.xml" match="(<topic.*?href="Mylyn/User_Guide/Task-Repository-Connectors.html.*?>(\s*<topic\s*href=".*?"\s*label=".*">\s*?</topic>)+)(\s*)(</topic>)" + replace="\1\3<anchor id="additions-repository-connectors"/>\3\4" + flags="s"/> + <antcall target="test"/> + </target> <target name="test" depends="init" description="verify that all of the HTML files are well-formed XML"> @@ -127,14 +87,18 @@ or inadvertently starting a line with a space character (in MediaWiki this start Don't bother with DTD validation: we only care if the files are well-formed. We therefore provide an empty DTD --> + <mkdir dir="tmp"/> <echo file="tmp/__empty.dtd" message=""/> <xmlvalidate lenient="true"> - <fileset dir="userguide"> + <fileset dir="Mylyn"> <include name="**/*.xml"/> </fileset> - <fileset dir="userguide"> + <fileset dir="Mylyn"> <include name="**/*.html"/> </fileset> + <fileset dir="."> + <include name="*toc.xml"/> + </fileset> <dtd publicid="-//W3C//DTD XHTML 1.0 Transitional//EN" location="${basedir}/tmp/__empty.dtd"/> </xmlvalidate> </target> diff --git a/org.eclipse.mylyn.help.ui/build.properties b/org.eclipse.mylyn.help.ui/build.properties index 33bd2ad16..19b1a97a7 100644 --- a/org.eclipse.mylyn.help.ui/build.properties +++ b/org.eclipse.mylyn.help.ui/build.properties @@ -16,7 +16,11 @@ bin.includes = plugin.xml,\ cheatsheets/,\ toc.xml,\ userguide/,\ - plugin.properties + plugin.properties,\ + Mylyn/,\ + Mylyn-FAQ-toc.xml,\ + Mylyn-User-Guide-toc.xml,\ + book.css src.includes = about.html source.. = src/ jars.compile.order = . diff --git a/org.eclipse.mylyn.help.ui/userguide/images/images/home.gif b/org.eclipse.mylyn.help.ui/images/home.gif Binary files differindex 4472e8ce5..4472e8ce5 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/images/home.gif +++ b/org.eclipse.mylyn.help.ui/images/home.gif diff --git a/org.eclipse.mylyn.help.ui/userguide/images/images/next.gif b/org.eclipse.mylyn.help.ui/images/next.gif Binary files differindex e2f8c3e1f..e2f8c3e1f 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/images/next.gif +++ b/org.eclipse.mylyn.help.ui/images/next.gif diff --git a/org.eclipse.mylyn.help.ui/userguide/images/images/prev.gif b/org.eclipse.mylyn.help.ui/images/prev.gif Binary files differindex 4fb415010..4fb415010 100644 --- a/org.eclipse.mylyn.help.ui/userguide/images/images/prev.gif +++ b/org.eclipse.mylyn.help.ui/images/prev.gif diff --git a/org.eclipse.mylyn.help.ui/plugin.xml b/org.eclipse.mylyn.help.ui/plugin.xml index f34922c88..a70fac97e 100644 --- a/org.eclipse.mylyn.help.ui/plugin.xml +++ b/org.eclipse.mylyn.help.ui/plugin.xml @@ -20,9 +20,11 @@ primary="true"> </toc> <toc - file="userguide/Mylyn Reference-toc.xml" - primary="false"> - </toc> + file="Mylyn-User-Guide-toc.xml" + primary="false"/> + <toc + file="Mylyn-FAQ-toc.xml" + primary="false"/> </extension> <extension diff --git a/org.eclipse.mylyn.help.ui/toc.xml b/org.eclipse.mylyn.help.ui/toc.xml index 00604a9ad..96e714418 100644 --- a/org.eclipse.mylyn.help.ui/toc.xml +++ b/org.eclipse.mylyn.help.ui/toc.xml @@ -15,10 +15,16 @@ <anchor id="before-reference" /> <topic label="Feature Reference"> <anchor id="before-reference-content"/> - <link toc="userguide/Mylyn Reference-toc.xml"/> + <link toc="Mylyn-User-Guide-toc.xml"/> <anchor id="after-reference-content"/> <anchor id="additions-reference" /> </topic> + <topic label="Frequently Asked Questions"> + <anchor id="before-faq-content"/> + <link toc="Mylyn-FAQ-toc.xml"/> + <anchor id="after-faq-content"/> + <anchor id="additions-faq" /> + </topic> <anchor id="after-reference" /> <anchor id="additions" /> <topic href="doc/notices.html" label="Legal" /> diff --git a/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html b/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html deleted file mode 100644 index af1eb2033..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Configuring-Task-Repositories.html +++ /dev/null @@ -1,76 +0,0 @@ -<?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 deleted file mode 100644 index ec67866a8..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Creating-new-Queries.html +++ /dev/null @@ -1,131 +0,0 @@ -<?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 deleted file mode 100644 index ac55b8a3b..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Creating-new-Tasks.html +++ /dev/null @@ -1,131 +0,0 @@ -<?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 deleted file mode 100644 index 20dd20691..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Installation.html +++ /dev/null @@ -1,140 +0,0 @@ -<?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/Mylyn Reference-toc.xml b/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml deleted file mode 100644 index a8d845532..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Mylyn Reference-toc.xml +++ /dev/null @@ -1,56 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="userguide/Mylyn Reference.html" label="Mylyn Reference"> - <topic href="userguide/Mylyn Reference.html" label="Task List"> - <topic href="userguide/Mylyn Reference.html#Task_List_Presentation" label="Task List Presentation"></topic> - <topic href="userguide/Mylyn Reference.html#Icon_Legend_and_Color_Coding" label="Icon Legend and Color Coding"></topic> - <topic href="userguide/Mylyn Reference.html#Creating_new_Tasks" label="Creating new Tasks"> - <topic href="userguide/Mylyn Reference.html#Local_Tasks" label="Local Tasks"></topic> - <topic href="userguide/Mylyn Reference.html#Repository_Tasks" label="Repository Tasks"></topic> - </topic> - <topic href="userguide/Mylyn Reference.html#Creating_new_Queries" label="Creating new Queries"></topic> - <topic href="userguide/Mylyn Reference.html#Scheduling" label="Scheduling"></topic> - <topic href="userguide/Mylyn Reference.html#Synchronization" label="Synchronization"></topic> - <topic href="userguide/Mylyn Reference.html#Incoming_Changes" label="Incoming Changes"></topic> - <topic href="userguide/Mylyn Reference.html#Reviewing_Tasks" label="Reviewing Tasks"></topic> - <topic href="userguide/Mylyn Reference.html#Task_Progress_Indicators" label="Task Progress Indicators"></topic> - <topic href="userguide/Mylyn Reference.html#Task_List_Settings_and_Operations" label="Task List Settings and Operations"></topic> - </topic> - <topic href="userguide/Task-Repositories.html" label="Task Repositories"></topic> - <topic href="userguide/Task-Editor.html" label="Task Editor"> - <topic href="userguide/Task-Editor.html#Repository_Task_Details" label="Repository Task Details"></topic> - <topic href="userguide/Task-Editor.html#Context" label="Context"></topic> - <topic href="userguide/Task-Editor.html#Planning" label="Planning"></topic> - </topic> - <topic href="userguide/Task-Focused-Interface.html" label="Task-Focused Interface"> - <topic href="userguide/Task-Focused-Interface.html#Focusing_Navigator_Views" label="Focusing Navigator Views"></topic> - <topic href="userguide/Task-Focused-Interface.html#Alt.2BClick_Navigation" label="Alt+Click Navigation"></topic> - <topic href="userguide/Task-Focused-Interface.html#Focusing_Editors" label="Focusing Editors"></topic> - <topic href="userguide/Task-Focused-Interface.html#Task-focused_Ordering" label="Task-focused Ordering"></topic> - <topic href="userguide/Task-Focused-Interface.html#Working_Set_Integration" label="Working Set Integration"></topic> - <topic href="userguide/Task-Focused-Interface.html#Open_Task_dialog" label="Open Task dialog"></topic> - <topic href="userguide/Task-Focused-Interface.html#Task_Hyperlinking" label="Task Hyperlinking"></topic> - <topic href="userguide/Task-Focused-Interface.html#Reporting_Bugs_from_the_Error_Log" label="Reporting Bugs from the Error Log"></topic> - </topic> - <topic href="userguide/Team-Support.html" label="Team Support"> - <topic href="userguide/Team-Support.html#Task-focused_Change_Sets" label="Task-focused Change Sets"></topic> - <topic href="userguide/Team-Support.html#Automatic_Commit_Messages" label="Automatic Commit Messages"></topic> - <topic href="userguide/Team-Support.html#Working_with_Patches" label="Working with Patches"></topic> - </topic> - <topic href="userguide/Shortcuts.html" label="Shortcuts"></topic> - <topic href="userguide/Preferences.html" label="Preferences"> - <topic href="userguide/Preferences.html#Tasks" label="Tasks"></topic> - <topic href="userguide/Preferences.html#Context_2" label="Context"></topic> - <topic href="userguide/Preferences.html#Resources" label="Resources"></topic> - <topic href="userguide/Preferences.html#Team" label="Team"></topic> - <topic href="userguide/Preferences.html#Shortcuts_2" label="Shortcuts"></topic> - </topic> - <topic href="userguide/Task-Repository-Connectors.html" label="Task Repository Connectors"> - <topic href="userguide/Task-Repository-Connectors.html#Bugzilla_Connector" label="Bugzilla Connector"></topic> - <topic href="userguide/Task-Repository-Connectors.html#Trac_Connector" label="Trac Connector"></topic> - <topic href="userguide/Task-Repository-Connectors.html#JIRA_Connector" label="JIRA Connector"></topic> - <topic href="userguide/Task-Repository-Connectors.html#Generic_Web_Templates_Connector" label="Generic Web Templates Connector"></topic> - <topic href="userguide/Task-Repository-Connectors.html#XPlanner_Connector" label="XPlanner Connector"></topic> - <anchor id="additions-repository-connectors"/> - </topic> - <topic href="userguide/Updating-This-Document.html" label="Updating This Document"></topic> -</toc>
\ No newline at end of file diff --git a/org.eclipse.mylyn.help.ui/userguide/Task-List.html b/org.eclipse.mylyn.help.ui/userguide/Task-List.html deleted file mode 100644 index 54a939265..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/Task-List.html +++ /dev/null @@ -1,325 +0,0 @@ -<?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/book.css b/org.eclipse.mylyn.help.ui/userguide/book.css deleted file mode 100644 index faa4199fe..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/book.css +++ /dev/null @@ -1 +0,0 @@ -@import "../../PRODUCT_PLUGIN/book.css"; diff --git a/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview-small.gif b/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview-small.gif Binary files differdeleted file mode 100644 index 2e88b0b6f..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview-small.gif +++ /dev/null diff --git a/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview.gif b/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview.gif Binary files differdeleted file mode 100644 index 74409455d..000000000 --- a/org.eclipse.mylyn.help.ui/userguide/images/mylyn-overview.gif +++ /dev/null |
