From d20d72206e5656b38057cee1ecc43dcf9426b169 Mon Sep 17 00:00:00 2001 From: Matthias Becker Date: Fri, 4 Oct 2024 14:46:46 +0200 Subject: [PATCH 1/4] Write HTML-Headers in Title Case in platform.doc.isv (I) --- .../guide/ant.htm | 2 +- .../guide/ant_contributing_task.htm | 6 +- .../guide/ant_developing.htm | 2 +- .../guide/ant_eclipse_tasks.htm | 2 +- .../guide/ant_expanding_classpath.htm | 2 +- ...nt_running_buildfiles_programmatically.htm | 4 +- .../guide/arch.htm | 2 +- .../guide/bundle_security.html | 10 +- .../guide/cnf.htm | 2 +- .../guide/cnf_operation.htm | 20 +-- .../guide/cnf_steps_rn_migration.htm | 2 +- .../guide/compare.htm | 2 +- .../guide/compare_beyond.htm | 8 +- .../guide/compare_contentviewer.htm | 8 +- .../guide/compare_structureviewer.htm | 4 +- .../guide/console_shell.htm | 6 +- .../guide/debug_debug.htm | 2 +- .../guide/debug_launch.htm | 2 +- .../guide/debug_launch_adding.htm | 8 +- .../guide/debug_launch_comparators.htm | 2 +- .../guide/debug_launch_groups.htm | 2 +- .../guide/debug_launch_java.htm | 2 +- .../guide/debug_launch_processfactories.htm | 2 +- .../guide/debug_launch_sourcelocators.htm | 8 +- .../guide/debug_launch_status.htm | 2 +- .../guide/debug_launch_ui.htm | 2 +- .../guide/debug_launch_uiimages.htm | 2 +- .../guide/debug_launch_uishortcuts.htm | 2 +- .../guide/debug_model.htm | 2 +- .../guide/debug_presentation.htm | 2 +- .../guide/debug_ui.htm | 2 +- .../guide/dialogs.htm | 2 +- .../dialogs_FilteredItemsSelectionDialog.htm | 2 +- ...s_FilteredItemsSelectionDialog_example.htm | 2 +- ...dItemsSelectionDialog_example_advanced.htm | 8 +- .../guide/dialogs_applications.htm | 4 +- .../guide/dialogs_settings.htm | 4 +- .../guide/dialogs_standard.htm | 2 +- .../guide/dialogs_wizards.htm | 4 +- .../guide/dialogs_wizards_extensions.htm | 2 +- .../guide/dialogs_wizards_multipage.htm | 4 +- .../guide/dialogs_wizards_wizarddialogs.htm | 2 +- .../guide/editors_actions.htm | 10 +- .../guide/editors_annotations.htm | 8 +- .../guide/editors_contentassist.htm | 6 +- .../guide/editors_documents.htm | 6 +- .../guide/editors_highlighting.htm | 6 +- .../guide/editors_hover.htm | 4 +- .../guide/editors_utilities.htm | 4 +- .../guide/editors_workbench.htm | 7 +- .../guide/editors_workbench_outliner.htm | 2 +- .../guide/firstplugin_create.htm | 2 +- .../guide/firstplugin_run.htm | 2 +- .../guide/forms_controls_text.htm | 4 +- .../guide/forms_editors.htm | 2 +- .../guide/int_eclipse.htm | 4 +- .../guide/java_web_start.htm | 14 +-- .../guide/jface.htm | 2 +- .../guide/jface_fieldassist.htm | 18 +-- .../guide/jface_operations.htm | 6 +- .../guide/jface_viewers.htm | 2 +- .../guide/login_extensions.html | 10 +- .../guide/p2_actions_touchpoints.html | 4 +- .../guide/p2_api_overview.htm | 2 +- .../guide/p2_category_generation.htm | 2 +- .../guide/p2_composite_repositories.htm | 10 +- .../guide/p2_customizing_metadata.html | 4 +- .../guide/p2_director.html | 12 +- .../guide/p2_metadata.html | 2 +- .../guide/p2_mirror.html | 14 +-- .../guide/p2_pgp.html | 8 +- .../guide/p2_publisher.html | 2 +- .../guide/p2_publishingtasks.htm | 2 +- .../guide/p2_repositorytasks.htm | 19 +-- .../guide/p2_uipolicy.htm | 4 +- .../guide/p2_uireuse.htm | 6 +- .../guide/preferences_prefs.htm | 2 +- .../guide/preferences_prefs_contribute.htm | 2 +- .../guide/preferences_prefs_implement.htm | 8 +- .../guide/preferences_prop_contribute.htm | 2 +- .../guide/preferences_prop_implement.htm | 2 +- .../guide/product_config_install.htm | 8 +- .../guide/product_configproduct.htm | 14 +-- .../guide/product_def.htm | 2 +- .../guide/product_def_extpt.htm | 2 +- .../guide/product_def_nl.htm | 10 +- .../guide/product_def_plugins.htm | 2 +- .../guide/product_extension.htm | 4 +- .../guide/product_open_file.htm | 2 +- .../guide/product_update.htm | 8 +- .../guide/rcp.htm | 2 +- .../guide/resAdv_batching.htm | 6 +- .../guide/resAdv_buildconfigs.htm | 8 +- .../guide/resAdv_builders.htm | 2 +- .../guide/resAdv_concurrency.htm | 4 +- .../guide/resAdv_derived.htm | 2 +- .../guide/resAdv_efs_api.htm | 2 +- .../guide/resAdv_efs_intro.htm | 2 +- .../guide/resAdv_efs_providers.htm | 2 +- .../guide/resAdv_efs_resources.htm | 6 +- .../guide/resAdv_events.htm | 6 +- .../guide/resAdv_hooks.htm | 6 +- .../guide/resAdv_modify.htm | 2 +- .../guide/resInt_content.htm | 6 +- .../guide/resInt_linked.htm | 4 +- .../guide/resInt_preferences.htm | 4 +- .../guide/resInt_properties.htm | 2 +- .../guide/runtime_app_model.htm | 4 +- .../guide/runtime_content.htm | 2 +- .../guide/runtime_content_contributing.htm | 12 +- .../guide/runtime_content_using.htm | 10 +- .../guide/runtime_jobs.htm | 12 +- .../guide/runtime_jobs_progress.htm | 10 +- .../guide/runtime_jobs_scheduling.htm | 8 +- .../guide/runtime_preferences.htm | 6 +- .../guide/search_page.htm | 2 +- .../guide/st_design.htm | 4 +- .../guide/st_structured_text.htm | 2 +- .../guide/st_text_types.htm | 118 ------------------ .../guide/swt.htm | 2 +- .../guide/swt_threading.htm | 2 +- .../guide/swt_widgets_custom.htm | 10 +- .../guide/swt_widgets_events.htm | 4 +- .../guide/team.htm | 2 +- .../guide/team_howto.htm | 10 +- .../guide/team_model_model.htm | 7 +- .../guide/team_provider_repository.htm | 6 +- .../guide/team_resources.htm | 12 +- .../guide/team_resources_filetypes.htm | 6 +- .../guide/team_resources_linked.htm | 2 +- .../guide/team_resources_private.htm | 2 +- .../guide/team_resources_projects.htm | 2 +- .../guide/team_synchronize.htm | 4 +- .../team_synchronize_localhistory_example.htm | 2 +- .../guide/team_ui_actions.htm | 2 +- .../guide/team_ui_decorators.htm | 2 +- .../guide/team_ui_history.htm | 4 +- .../guide/team_ui_prefs.htm | 2 +- 138 files changed, 315 insertions(+), 462 deletions(-) diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant.htm index 7b7d0960641..17048ee8f4c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant.htm @@ -14,7 +14,7 @@ -

Platform Ant support

+

Platform Ant Support

Ant is a Java-based build tool that uses XML-based configuration files to describe build tasks.  The Eclipse platform allows you to run Ant buildfiles from your plug-in and contribute new Ant tasks, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_contributing_task.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_contributing_task.htm index 39f253d8f24..3a430a86410 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_contributing_task.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_contributing_task.htm @@ -15,7 +15,7 @@

-Contributing tasks and types

+Contributing Tasks and Types

When your plug-in contributes Ant tasks and types, the tasks and types have access to all of the classes inside the contributing plug-in. For example, the eclipse.refreshLocal task contributed by org.eclipse.core.resources plug-in is @@ -72,7 +72,7 @@

-Important rules when contributing tasks and types

+Important Rules When Contributing Tasks and Types

@@ -87,7 +87,7 @@

-

Why a separate JAR for tasks and types?

+

Why a Separate JAR for Tasks and Types?

There are basically two requirements for running Ant in Eclipse that do not fit the plug-in model very well:

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_developing.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_developing.htm index a8b14212b22..9d760171285 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_developing.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_developing.htm @@ -15,7 +15,7 @@

-Developing Ant tasks and types within Eclipse

+Developing Ant Tasks and Types Within Eclipse

Ant tasks and types must be loaded by an Ant classloader instead of a plug-in classloader. This can cause problems when developing and testing new tasks and types diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_eclipse_tasks.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_eclipse_tasks.htm index 45941d2ac9a..31a63a0ee90 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_eclipse_tasks.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_eclipse_tasks.htm @@ -15,7 +15,7 @@

-Ant tasks provided by the platform

+Ant Tasks Provided by the Platform

The platform provides some useful Ant tasks and properties that interact with the workspace. They can be used with buildfiles that are set to build within the same JRE as the workspace.

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_expanding_classpath.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_expanding_classpath.htm index f68d0ccd426..9e55bd18888 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_expanding_classpath.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_expanding_classpath.htm @@ -15,7 +15,7 @@

-Expanding the Ant classpath

+Expanding the Ant Classpath

Plug-ins can contribute extra JAR files to the Ant classpath. The plug-in contributing the JARs is added to the Ant classpath, and as a result, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_running_buildfiles_programmatically.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_running_buildfiles_programmatically.htm index ad8cd5d0ad2..188ca4cdfaa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_running_buildfiles_programmatically.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ant_running_buildfiles_programmatically.htm @@ -15,7 +15,7 @@

-Running Ant buildfiles programmatically

+Running Ant Buildfiles Programmatically

The Ant support built into Eclipse allows plug-ins to programmatically run Ant buildfiles. This is done via the AntRunner @@ -44,7 +44,7 @@

-Special care for native libraries if build occurs within the same JRE as the workspace

+Special Care for Native Libraries if Build Occurs Within the Same JRE as the Workspace

Every time an Ant buildfile runs in Eclipse a new classloader is created. Since a library can only be loaded by one classloader in Java, tasks making use of native libraries could run into problems during diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/arch.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/arch.htm index 0f6add2d8df..aba466de279 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/arch.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/arch.htm @@ -14,7 +14,7 @@ -

Platform architecture

+

Platform Architecture

The Eclipse platform is structured around the concept of plug-ins. Plug-ins are structured bundles of code and/or data that contribute functionality to the system. Functionality can be diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/bundle_security.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/bundle_security.html index 6ebae607a2d..0afc8286826 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/bundle_security.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/bundle_security.html @@ -9,7 +9,7 @@ -

Signed bundles and protecting against malicious code

+

Signed Bundles and Protecting Against Malicious Code

Overview

@@ -21,7 +21,7 @@

Overview

  • Authorize the installation and runtime behaviour of code
    • -

    Authenticating code packaged in a bundle

    +

    Authenticating Code Packaged in a Bundle

    The first step towards protecting the platform from malicious code is 'authentication', or proving the identity of the person who is distributing the code in a bundle. This is facilitated by the use of a Public Key Infrastructure (PKI), where users are issued public certificates and private keys that uniquely identify them. Another common and well know use of certificates is the SSL protocol by which secured web sites are accessed.

    @@ -45,7 +45,7 @@

    Authenticating code packaged in a bundle

  • http://www.onjava.com/pub/a/onjava/2001/04/12/signing_jar.html?page=1
    • -

    Signing code packaged in a bundle

    +

    Signing Code Packaged in a Bundle

    In order to sign a bundle, an Eclipse developer has a handful of options:

    @@ -67,7 +67,7 @@

    Signing code packaged in a bundle

    -

    Verifying signed code packaged in a bundle

    +

    Verifying Signed Code Packaged in a Bundle

    As with generation of signed bundles, verification of signed code can be done by an Eclipse developer in several ways:

    @@ -87,7 +87,7 @@

    Verifying signed code packaged in a bundle

    -

    Authorization of signed code

    +

    Authorization of Signed Code

    Once the signer(s) of code packaged in a bundle is established via authentication, the next step to perform is 'authorization'. Authorization is the process by which the system decides whether a piece of code should be able to perform a specified action. Although the Java runtime supports a fine grained runtime permission model, Eclipse also supports two additional enforcement points with respect to signed code packaged in bundles. This gives Eclipse platform deployers a range of security solutions that allow tradeoffs to be made between flexibility and complexity versus manageability and performance. In Eclipse 3.4 or later, authorization based on signatures can be performed:

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf.htm index 0ad510d7d48..ab6aeb5e6a1 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf.htm @@ -215,7 +215,7 @@

    Drag and Drop Support

    provide handling of additional (non-standard) transfer types or validation in the event of a drop.

    -

    Link with Editor Support

    +

    Link With Editor Support

    The link helper extension point provides a flexible mechanism of determining the appropriate selection in the navigator when an editor is diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_operation.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_operation.htm index c98d9606a5d..9f62c8d05e6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_operation.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_operation.htm @@ -17,7 +17,7 @@

    Operational Topics

    This section covers the operation of the CNF in detail.

    -

    Content Provider selection

    +

    Content Provider Selection

    Selecting the content provider is done by finding one or more NCEs associated with an object. The CNF is registered as a content provider a viewer and thus gets called at the content provider APIs in @@ -56,23 +56,5 @@

    Content Provider selection

    current page. Thus, the initial input becomes the first object that is evaluated for the selection of NCEs.

    - - diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_steps_rn_migration.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_steps_rn_migration.htm index e7b8bdd1a1a..98c1f4642b8 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_steps_rn_migration.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/cnf_steps_rn_migration.htm @@ -15,7 +15,7 @@ -

    Migrating from the ResourceNavigator

    +

    Migrating From the ResourceNavigator

    First follow the steps to add the Common Navigator and check that the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare.htm index 21ca0e5337e..be4dc46d194 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare.htm @@ -33,7 +33,7 @@

    These services are used in the platform to assist with user tasks such as integrating patch files and comparing/merging the workspace with local history.

    -

    Compare viewers

    +

    Compare Viewers

    All compare viewers are standard JFace viewers that expect an input object implementing the ICompareInput diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_beyond.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_beyond.htm index 5856ea312c8..9b97a9f1307 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_beyond.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_beyond.htm @@ -19,7 +19,7 @@

    This section provides additional information about advanced API in the compare plug-in.

    -

    Writing compare operations

    +

    Writing Compare Operations

    A compare operation must be implemented as a subclass of CompareEditorInput.  @@ -85,7 +85,7 @@

    Writing compare operations

    It can be used without modification as the input to the differencing engine.

    -

    Compare functionality outside of compare editors

    +

    Compare Functionality Outside of Compare Editors

    If you want to use compare functionality outside of the standard compare editor @@ -102,7 +102,7 @@

    Compare functionality outside of compare editors

    supports dynamic viewer switching, that is the viewer installed in the pane is dynamically determined by the pane's input object.

    -

    Comparing a single file in an editor

    +

    comparing a Single File in an Editor

    The CompareEditorInput supports the comparison of an arbitrary file/folder structure which can be displayed in an editor, dialog or view. @@ -118,7 +118,7 @@

    Comparing a single file in an editor

  • initializes asynchronously.
    • -

    Working with patches

    +

    working With Patches

    The ApplyPatchOperation provides the ability to launch the Apply Patch wizard programmatically. The pages shown by the wizard are determined using the inputs to the operation. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_contentviewer.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_contentviewer.htm index b970438e5e0..293fe194837 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_contentviewer.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_contentviewer.htm @@ -22,7 +22,7 @@

    -Simple content viewers

    +Simple Content Viewers

    @@ -50,7 +50,7 @@

    You may also use the contentTypeBinding element to associate a content type with a content viewer.

    -

    Content merge viewers

    +

    Content Merge Viewers

    A content merge viewer performs a two-way or three-way compare of its inputs and presents the result side-by-side or in any other suitable way.  The viewer lets the user merge between the inputs. Content merge viewers are common for text or images.

    @@ -113,7 +113,7 @@

    Content merge viewers

    IMergeViewerContentProvider interface.

    -

    Text merging

    +

    Text Merging

    If your viewer uses text, additional classes that  compare @@ -153,7 +153,7 @@

    Text merging

    TextMergeViewer that provide syntax highlighting must implement both the getDocumentPartitioner() and getDocumentPartitioning() methods to support shared documents.

    -

    Range differencing

    +

    Range Differencing

    RangeDifferencer finds the longest sequences of matching and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_structureviewer.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_structureviewer.htm index 6bf226af637..05c01697a3f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_structureviewer.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/compare_structureviewer.htm @@ -19,7 +19,7 @@

    in a hierarchical view, and lets the user merge between the inputs.  Structure merge viewers are common for workspace resources or the members of an archive file.

    -

    Tree-like structure viewers

    +

    Tree-like Structure Viewers

    Because the implementation of many structure compare viewers is based on a tree, the compare plug-in provides a generic tree-based StructureDiffViewer. @@ -33,7 +33,7 @@

    Tree-like structure viewers

    The JDT plug-in defines several contributions for org.eclipse.compare.structureCreators.

    -

    Other hierarchical structure viewers

    +

    Other Hierarchical Structure Viewers

    In some cases, the tree-based StructureDiffViewer may not be appropriate for your plug-in.  The org.eclipse.compare.structureMergeViewers extension point allows you to define your own implementation for a structure diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/console_shell.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/console_shell.htm index 77e0e00f834..09ce616dd0b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/console_shell.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/console_shell.htm @@ -14,7 +14,7 @@

    Console Shell

    -

    General features

    +

    General Features

    The Equinox OSGi console is based on Apache Felix Gogo, which provides a Unix-like shell for OSGi frameworks. The OSGi console is useful for runtime configuration and management of the @@ -114,7 +114,7 @@

    Starting a Telnet Session

    option at all, but if -console is passed it will override any setting present in the configuration/config.ini file.

    -

    Starting an SSH Session with JAAS Authentication

    +

    Starting an SSH Session With JAAS Authentication

    To start a console session in an SSH session, a few more bundles are needed:

    @@ -229,7 +229,7 @@

    Custom JAAS Authentication Login Providers

    must be specified in the configuration/console.auth.config file instead of the default entry there.

    -

    Starting an SSH Session with Public Key Authentication

    +

    Starting an SSH Session With Public Key Authentication

    It's common to want to use public key authentication with SSH and it is possible to configure Equinox to do that instead of using JAAS authentication. First an SSH key-pair should be created diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_debug.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_debug.htm index 0c7e0989a2f..14f5d415022 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_debug.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_debug.htm @@ -12,7 +12,7 @@ -

    Debugging a program

    +

    Debugging a Program

    When you define a launch configuration for running a program, you can specify which modes (run, debug, profile, etc.) are supported by your program. If you support debug mode, then you need to implement a debug diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch.htm index 6e2aa6b90a9..4c806e50cb2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch.htm @@ -12,7 +12,7 @@ -

    Launching a program

    +

    Launching a Program

    The platform debug plug-ins allow your plug-in to extend the platform so that your partiticular type of program can be launched from the workbench, obtaining input from the user if necessary. A unique type of program that can be launched in the platform is called a diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_adding.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_adding.htm index 246e31aeb3a..87442da7caa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_adding.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_adding.htm @@ -12,7 +12,7 @@ -

    Adding launchers to the platform

    +

    Adding Launchers to the Platform

    Your plug-in can add launch configuration types to the platform using the org.eclipse.debug.core.launchConfigurationTypes extension point.  This extension point allows you to declare a configuration type using a unique id.  You must provide a corresponding @@ -40,7 +40,7 @@

    Adding launchers to the platform

    </extension>

    This extension defines a launch configuration delegate that can be used to run or debug programs that are launched using the local Java launch configuration.

    -

    Defining new launch modes

    +

    Defining New Launch Modes

    We mentioned previously that the platform defines launch modes for running, debugging, or profiling a program. These modes are defined using the org.eclipse.debug.core.launchModes extension point. This extension point allows you to declare a launch mode by defining its string mode @@ -64,7 +64,7 @@

    Defining new launch modes

    Note that the mode is not associated with any particular launch configuration type. As shown earlier, that association occurs when a launch delegate is specified for a configuration type.

    -

    Defining launch delegates

    +

    Defining Launch Delegates

    Since launch modes can be specified independently of launch configuration types, it's possible that new modes are defined that are not implemented by the original delegate for a launch configuration. In this case, a plug-in may define a launch delegate that implements a particular mode for a particular launch configuration type. @@ -87,7 +87,7 @@

    Defining launch delegates

    modes. As seen previously, the delegate must implement ILaunchConfigurationDelegate, and can optionally implement ILaunchConfigurationDelegate2 for more control over the launch sequence.

    -

    Other references

    +

    Other References

    We Have Lift-off: The Launching Framework in Eclipse provides a start to finish example for defining your own launch type.

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_comparators.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_comparators.htm index f15d4251627..28a8fca72aa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_comparators.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_comparators.htm @@ -13,7 +13,7 @@ -

    Comparing launch configurations

    +

    Comparing Launch Configurations

    We've seen how a plug-in can use named attributes and values to store important data with a launch configuration. Since the interpretation of a plug-in's attributes are not known by the platform, an extension point is provided that allows you to supply a comparator for a specific attribute. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm index 19fa6e97930..1eb354d90ca 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/debug_launch_groups.htm @@ -12,7 +12,7 @@ -

    Launch groups

    +

    Launch Groups

    The Launch Group launch configuration type allows you to launch multiple other launch configurations sequentially, with configurable actions after launching each group member:

    -

    Adding selected items history

    +

    Adding Selected Items History

    The dialog can be configured to save and restore the history of items that have been selected.
      @@ -93,7 +93,7 @@

      Adding selected items history

    -

    Adding custom filters

    +

    Adding Custom Filters

    Next we will expand the filter to hide all strings that start with a lower case character.
    1. Create a subclass of FilteredItemsSelectionDialog.ItemsFilter, @@ -141,7 +141,7 @@

      Adding custom filters

    -

    Adding an extra check-box to the dialog

    +

    Adding an Extra Check-box to the Dialog

    We will use a check-box and a menu action to indicate whether to filter strings that start with a lower case character.

      diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_applications.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_applications.htm index 28824cf2349..8c3d5739133 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_applications.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_applications.htm @@ -16,7 +16,7 @@

      -Application dialogs

      +Application Dialogs

      When a standard dialog is too simple for your plug-in, you can build your own dialog using the Dialog class. Earlier, we saw how the readme tool contributed an "Open Readme Browser" @@ -95,7 +95,7 @@

      Dialogs can be as simple or as complicated as necessary. When you implement a dialog, most of your dialog code is concerned with creating the SWT controls that represent its content area and handling any events necessary while the dialog is up. Once a button is pressed by the user, the dialog can query the state of the various controls (or viewers) that make up the dialog to determine what to do.

      -

      Popup dialogs

      +

      Popup Dialogs

      In some cases, you might want to show information about something in a dialog, but in a way that is more "lightweight" than launching a regular dialog. For example, a dialog may be intended to provide transient information that can be easily dismissed, without taking the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_settings.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_settings.htm index 3afcf4c5b8a..5fcea59ffb6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_settings.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_settings.htm @@ -16,7 +16,7 @@

      -Dialog settings

      +Dialog Settings

      The org.eclipse.jface.dialogs package provides a utility class, @@ -52,7 +52,7 @@

      super.okPressed(); } -

      Dialog bounds settings

      +

      Dialog Bounds Settings

      In general, the definition and interpretation of dialog settings are the responsibility of your plug-in. However, there are some specific dialog settings keys defined inside the JFace dialog framework that are used to remember the last size and position of a dialog, so that the dialog diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_standard.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_standard.htm index 65836bdb37b..4d784276728 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_standard.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/dialogs_standard.htm @@ -16,7 +16,7 @@

      -Standard dialogs

      +Standard Dialogs

      The package org.eclipse.jface.dialogs defines the basic support for dialogs. This package provides standard dialogs for displaying user messages and obtaining simple input from the user.

    For simplicity, we'll run the new plug-in from within the Eclipse workbench.

    -

    Launching the workbench

    +

    Launching the Workbench

    To launch a runtime workbench, choose diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_controls_text.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_controls_text.htm index 7823abb954d..f94fea30d88 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_controls_text.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_controls_text.htm @@ -31,7 +31,7 @@

    In all the modes, FormText control is capable of rendering either a string or an input stream.

    -

    Rendering normal text (label mode)

    +

    Rendering Normal Text (label Mode)

    	FormText rtext = toolkit.createFormText(form.getBody(), true);
 	String data = "Here is some plain text for the text to render.";
@@ -42,7 +42,7 @@ 
    Rendering normal text (label mode)
    
 	treat input text as-is, and the third that we will not try to expand URLs if 
 	found.
    -

    Automatic conversion of URLs into hyperlinks

    +

    Automatic Conversion of URLs Into Hyperlinks

    It is possible to still handle the text as normal but automatically convert segments with http:// protocol into hyperlinks:

    	FormText rtext = toolkit.createFormText(form.getBody(), true);
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_editors.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_editors.htm
index f5f8fc3000d..6bbd1a65862 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_editors.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/forms_editors.htm
@@ -63,7 +63,7 @@ 
    
 
    In addition to form pages, you can add one or more text editors as a raw 
 source alternative to the GUI pages. For this, you should call 'addPage(IEditorPart, 
 IEditorInput input)' method in the superclass.
    
-
    Recommended practices for Eclipse Forms multi-page editors
    
+
    Recommended Practices for Eclipse Forms Multi-page Editors
    
 
    There are many ways you can go about writing a form-based 
 multi-page editor. It mostly depends on the type of content you are editing and 
 proficiency of your users. There are two ways you can approach it:
    
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/int_eclipse.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/int_eclipse.htm
index 324baceb360..dbf47de8127 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/int_eclipse.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/int_eclipse.htm
@@ -127,7 +127,7 @@ 
    Team support
    
     
 
 
-
    Debug support
    
+
    Debug Support
    
     
     Defines a language independent debug model and UI classes
       for building debuggers and launchers.
@@ -135,7 +135,7 @@ 
    Debug support
    
   
     
   
-
    Other utilities
    
+
    Other Utilities
    
     
     Other utility plug-ins supply functionality such as searching and comparing resources, performing builds using XML configuration files,
     and dynamically updating the platform from a server.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/java_web_start.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/java_web_start.htm
index 69224f51f1e..de936f64c94 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/java_web_start.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/java_web_start.htm
@@ -15,7 +15,7 @@
 
 
 
-
    Deploying eclipse based application with Java Web Start
    
+
    Deploying Eclipse Based Application With Java Web Start
    
 
    
 Applications built on Eclipse can be deployed using Java Web Start.
    
 Java Web Start "is an application-deployment technology that gives you the power to launch full-featured 
@@ -31,13 +31,13 @@ 
    Deploying eclipse based application with Java Web Start
    
 These steps are for applications based on eclipse 3.3. Instructions on how to achieve the same for eclipse
 3.1 and 3.2 can respectively be found in the 3.1 and 3.2 SDKs.
 
-
    Step 1, creating a wrapper feature
    
+
    Step 1, Creating a Wrapper Feature
    
 
      
 
    •  Create a feature including all the features that are listed in your product definition;
      • 
 
    •  Ensure that the org.eclipse.equinox.launcher plug-in is in the feature or in one of the included feature;
      • 
 
    
 
-
     Step 2, exporting the wrapper feature
    
+
     Step 2, Exporting the Wrapper Feature
    
 Note. Before proceeding with this step make sure to have a key store available. Eclipse does not provide any
 facility to create key stores. You can use the keytool application that
 comes with the JDK. In addition, ensure that the eclipse you are developing 
@@ -75,7 +75,7 @@ 
     Step 2, exporting the wrapper feature
    
 
 
 
-
    Step 3, creating the main JNLP file
    
+
    Step 3, Creating the Main JNLP File
    
 
    A Java Web Start application is described by JNLP files. They replace the eclipse.exe and the config.ini
 files by some equivalent mechanism. For example, JNLP has its own mechanism to control splash screen, ways
 to pass parameters and define what constitutes the application.
    
@@ -153,14 +153,14 @@ 
    Step 3, creating the main JNLP file
    
 This folder needs to be referenced from the root property of the build.properties (e.g: root=<folderContainingMainJNLPFile>/).
 
    
 
-
    Plug-ins based application
    
+
    Plug-ins Based Application
    
 
    Even though your RCP application does not use features, Java Web Start-ing it is possible.
    
 To do so, it is recommended to create a wrapper feature in order to facilitate the creation of the 
 main jnlp file and ease the deployment. This wrapper feature will list all the plug-ins of your application. Once the feature has been updated
 copy the generated JNLP file and modify it to become your main JNLP file.
    
 
 
    Miscellaneous
    
-
    Java Web Start on linux
    
+
    Java Web Start on Linux
    
 
    
 When an eclipse application is started with Web Start on Linux the default windowing system is motif. 
 If you want to run GTK, you need to set the property osgi.ws to "gtk" in the main jnlp file.
@@ -171,7 +171,7 @@ 
    Java Web Start on linux
    
         <property name="osgi.ws" value="gtk"/>
   </resources>
    -

    Known limitations

    +

    Known Limitations

    • Eclipse Update and Java Web Start
      Those two deployment technologies can work together under the following restrictions: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface.htm index 57f91bd211f..edeb81c125a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface.htm @@ -46,7 +46,7 @@

      The JFace UI framework

      plug-in's function, rather than focusing on the underlying widget system or solving problems that are common in almost any UI application.

      -JFace and the workbench

      +JFace and the Workbench

    Where does JFace end and the workbench begin? Sometimes the lines aren't so obvious. In general, the JFace APIs (from the packages org.eclipse.jface.*) are independent of the workbench extension points and APIs. Conceivably, a JFace program could be written without using any workbench code at all.

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_fieldassist.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_fieldassist.htm index 0660d68f681..8c641422114 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_fieldassist.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_fieldassist.htm @@ -29,7 +29,7 @@

    image decorations adjacent to a control in order to cue the user about the status of a particular field. Content proposal support allows you to provide a content assist popup that provides content choices for the user.

    -

    Control decorations

    +

    Control Decorations

    A control decoration is a rendered image that can be placed adjacent to a field in a window or dialog. Decorations may be placed adjacent to a control in one of six positions (top, center, or bottom to the left or right of the control). One or @@ -38,7 +38,7 @@

    Control decorations

    ControlDecoration     allows you to hide and show the decoration, assign descriptive text to the decoration, and listen to events associated with the decoration.

    -

    Creating a control decoration

    +

    Creating a Control Decoration

    Creating a control decoration is straightforward. Clients simply specify the control to be decorated and SWT constants describing the position of the decoration relative to the control. Consider this snippet, in @@ -74,7 +74,7 @@

    Creating a control decoration

    The setShowHover method allows clients to configure whether the description text is shown in a hover when the mouse hovers over the decoration.

    -

    Laying out decorated controls

    +

    Laying Out Decorated Controls

    When adding decorations to controls that appear inside a dialog or window, you should make sure there is enough space adjacent to the control to render the decoration without @@ -95,14 +95,14 @@

    Laying out decorated controls

    layout can get more complicated if you are using decorations with different widths. If this is the case, you can simplify things by first creating field decorations to represent all of your control decorations.

    -

    Field decorations

    +

    Field Decorations

    A FieldDecoration is simply a data object that combines the image and text used to show a decoration. Once created, these field decorations can be registered in the FieldDecorationRegistry.

    -

    Field decoration registry

    +

    Field Decoration Registry

    The field decoration registry allows you to register and access field decorations using a string id. This provides a convenient way for you to refer to decorations used throughout your application. You may choose to define API that exposes your decoration ids if you wish to @@ -140,7 +140,7 @@

    Field decoration registry

    dec.setDescriptionText(errorFieldIndicator.getDescription()); ... -

    Content proposals

    +

    Content Proposals

    In addition to annotating fields with decorations, applications may provide a content proposal assistant that activates a proposal popup for a field. You may install a @@ -189,7 +189,7 @@

    Content proposals

    IContentProposalProvider for advanced usage.

    -

    Configuring a content proposal adapter

    +

    Configuring a Content Proposal Adapter

    We've seen that the basic definition for a content proposal adapter includes the control for which the proposals are provided, the content adapter used to alter the content of the control, and the proposal provider that defines the list of proposals in the popup. In addition to these basics, there are many ways that the content proposal @@ -218,14 +218,14 @@

    Configuring a content proposal adapter

    control, causing it to behave much like the text editor content assist. See the javadoc for more specifics about each of these methods and how they interact with each other.

    -

    Auto complete fields

    +

    Auto Complete Fields

    The content proposal adapter methods can be used to configure an adapter so that it behaves more like the type-ahead field completion used in web browser URL or search fields. AutoCompleteField can be used when this style of interaction is desired. Clients need only specify the list of completions when defining an auto complete field. Configuration of the content proposal adapter and proposal provider will be handled internally.

    -

    Workbench field assist

    +

    Workbench Field Assist

    Field assist support at the JFace level gives your application a lot of flexibility in determining how to decorate fields and show proposals for field content. This is desirable for stand-alone JFace applications or stand-alone rich client applications. However, if your application is intended to integrate diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_operations.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_operations.htm index 677f3badfa7..eee960d429a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_operations.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_operations.htm @@ -14,7 +14,7 @@

    -Long-running operations

    +Long-running Operations

    The @@ -29,7 +29,7 @@

    a complete discussion of the available support for progress dialogs and views. The remainder of this discussion highlights the details of the JFace operations infrastructure which is used by the workbench.

    -

    Runnables and progress

    +

    Runnables and Progress

    The platform runtime defines a common interface, IProgressMonitor, @@ -72,7 +72,7 @@

    Runnables and progress

    and IWorkspaceRunnable.  See the javadoc for further detail. -

    Modal operations

    +

    Modal Operations

    The diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_viewers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_viewers.htm index 48d2824638e..0fe97674ae0 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_viewers.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/jface_viewers.htm @@ -44,7 +44,7 @@

    Each viewer has an associated SWT widget. This widget can be created implicitly by supplying the parent Composite in a convenience viewer constructor, or explicitly by creating it first and supplying it to the viewer in its constructor.

    -

    List-oriented viewers

    +

    List-oriented Viewers

    Lists, trees, and tables share many common capabilities from a user's point of view, such as population with objects, selection, sorting, and filtering. 

    These viewers keep a list of domain objects (called elements) and display them in their diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/login_extensions.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/login_extensions.html index 19f5c448494..0f79c40b4b3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/login_extensions.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/login_extensions.html @@ -9,7 +9,7 @@ -

    Login based on JAAS

    +

    Login Based on JAAS

    Overview

    @@ -19,7 +19,7 @@

    Overview

  • http://download.oracle.com/javase/7/docs/technotes/guides/security/jaas/JAASRefGuide.html
    • -

    Extension-point based contribution

    +

    Extension-point Based Contribution

    JAAS has specific expectations of where the classes that are used to build a LoginContext should be found - typically the extension classloader. In order to get around these limitations and bridge into the Eclipse environment, there are several extension points available for bundles to contribute JAAS artifacts into the system. Specifically, the following artifacts have corresponding extension points in the org.eclipse.equinox.security bundle:

    • javax.security.auth.Configuration
      • @@ -28,12 +28,12 @@

      Extension-point based contribution

    In order to evolve the API but still embrace the model, there is an org.eclipse.equinox.security.auth.ILoginContext interface which maps to the LoginContext class in JAAS. Additional features are available on this interface, but most functionality still speaks in terms of core JAAS artifacts (Subjects, Principals, etc).

    -

    Declarative wiring via LoginContextFactory

    +

    Declarative Wiring via LoginContextFactory

    Another limitation of the JAAS framework is that there is a strong coupling between the backend login Configuration and the CallbackHandler (UI) which will service the login execution. There is an extension to create the mapping from a configuration name to a specific CallbackHandler, and a factory (org.eclipse.equinox.security.auth.LoginContextFactory) which can generate an ILoginContext without knowledge required of specific CallbackHandlers.

    -

    Notifications through ILoginContextListener

    +

    Notifications Through ILoginContextListener

    Another use case which is implemented is the ability to monitor the execution of an applications login lifecycle via an event listener model. This functionality is available through the org.eclipse.equinox.security.auth.ILoginContextListener interface.

    -

    Future work

    +

    Future Work

    Feedback surrounding this functionality is greatly appreciated. Potential future direction involves integrating login into the RCP lifecycle, Jobs framework, etc and using the user context to affect the behaviour of the runtime system (filter, etc).

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_actions_touchpoints.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_actions_touchpoints.html index 32e7f3a6c9f..25102f3c2ce 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_actions_touchpoints.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_actions_touchpoints.html @@ -476,7 +476,7 @@

    Built-in Action Variables

    What follows is a catalog of the variables made available by the phases and touchpoints. Many of these are mostly useful to the implementor of new actions and touchpoint types.

    -

    Variables Available in all phases

    +

    Variables Available in All Phases

    @@ -511,7 +511,7 @@

    Variables Available in all phases

    the actions operand (e.g. IU pair)
    -

    Variables Available in all installable unit phases

    +

    Variables Available in All Installable Unit Phases

    e.g. collect, unconfigure, uninstall, install, configure, ...

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm index dbc6bdc0a66..a81a49a5eb4 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm @@ -176,7 +176,7 @@

    Profiles and Profile Registries

    The profile is managed by a profile registry. IProfileRegistry manages all the profiles for a given p2 agent. It can be acquired through the agent.

    -

    Putting it all together

    +

    Putting It All Together

    The following snippet demonstrates everything that must be done to trigger the installation of an IU into the running application. We use the operations API to perform the install, so we don't diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_category_generation.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_category_generation.htm index 0da9614d69b..e59d3079c07 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_category_generation.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_category_generation.htm @@ -10,7 +10,7 @@ Content categorization -

    Content categorization

    +

    Content Categorization

    By default, the p2 Install Software Dialog groups all the installable units by category. If an installable unit is not categorized, it will not be displayed in the user interface. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm index e2df0f23105..c2157963252 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm @@ -10,14 +10,14 @@ -

    Composite repositories

    +

    Composite Repositories

    As repositories continually grow in size they become harder to manage. The goal of composite repositories is to make this task easier by allowing site maintainers to have a parent repository which refers to multiple child repositories. Users are then able to reference the parent repository and the content of all the child repositories will be transparently available to them.

    -

    How it works

    +

    How It Works

    With the built-in repository types defined by p2, when a user connects to a server, p2 checks to see if there are any files that are recognized. In particular for metadata repositories it searches for a content.xml file or a content.jar and in the case of @@ -29,7 +29,7 @@

    How it works

    a different index file name to help p2 recognize them as composite repositories.

    -

    Sample composite metadata repository

    +

    Sample Composite Metadata Repository

    File: compositeContent.xml @@ -50,7 +50,7 @@

    Sample composite metadata repository

    -

    Sample composite artifact repository

    +

    Sample Composite Artifact Repository

    File: compositeArtifacts.xml @@ -72,7 +72,7 @@

    Sample composite artifact repository

    -

    Composite repositories as part of the build

    +

    Composite Repositories as Part of the Build

    In order to automate composite repository actions in release engineering builds, Ant tasks have been provided which can be called to create and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_customizing_metadata.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_customizing_metadata.html index 50146e2ad47..4a827626725 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_customizing_metadata.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_customizing_metadata.html @@ -10,7 +10,7 @@ Customizing p2 metadata -

    Customizing p2 metadata

    +

    Customizing p2 Metadata

    Disclaimer: Authoring p2 metadata is something we expect to support with better tooling in a future release. The support for customizing metadata with a p2.inf file is provisional although we expect to maintain a basic level @@ -129,7 +129,7 @@

    Property Advice

    -

    Update descriptor advice

    +

    Update Descriptor Advice

    The update descriptor advice allows to override the default update descriptor generated by p2. Typically this is useful if an IU has been renamed and automatic update detection is still desired.

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
index 2b9da3acbb7..d8f664d0b73 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_director.html
@@ -12,7 +12,7 @@
 
 
 
-
    Installing software using the p2 director application
    
+
    Installing Software Using the p2 Director Application
    
 In addition to the "Software Updates" dialog, you can also perform
 provisioning operations from a command line or script.
 This is achieved using a tool called the director application. The director application
@@ -36,7 +36,7 @@ 
    Terminology
    
 
 
    
 
-
    Running inside the target application
    
+
    Running Inside the Target Application
    
 
    In this mode, the provisioning operation happens from within the
 targeted product that you are provisioning. It is equivalent to starting
 up the targeted product and using the p2 UI to perform the equivalent
@@ -56,7 +56,7 @@ 
    Running inside the target application
    -

    Provisioning without running the target application

    +

    Provisioning Without Running the Target Application

    In this case the provisioning operation happens "outside" of the targeted product. The "targeted product" is *not* started. This allows one to both modify an existing installation and create a complete @@ -67,7 +67,7 @@

    Provisioning without running the target application

    any platform for any other platform (e.g. on my linux machine, one can add plug-ins to a windows-based target application).

    -

    Installing / uninstalling IUs into a target product

    +

    Installing / Uninstalling IUs Into a Target Product

    To install or uninstall something into an existing target product a few extra arguments than for the "inside" mode need to be set. These mostly consist in providing the provisioning operation the ID of the @@ -91,7 +91,7 @@

    Installing / uninstalling IUs into a target product

    available in the profile of the application in which we are provisioning.

    -

    Installing a complete product

    +

    Installing a Complete Product

    The creation of a complete product using the director application only needs a few extra arguments compared to the previous example. Most of these consist of values used to initialize the profile in which the @@ -120,7 +120,7 @@

    Installing a complete product

    The -p2.* arguments describe the os/ws/arch that the provisioned product is targeting.

    -

    Installing a complete product for macOS

    +

    Installing a Complete Product for macOS

    The creation of a complete product for the macOS Operating System requires that the destination folder end with ".app/" as in the following example. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_metadata.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_metadata.html index c0ec4c5d353..ddd213af4bd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_metadata.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_metadata.html @@ -10,7 +10,7 @@ Metadata management -

    Metadata management

    +

    Metadata Management

    As described in the overview, p2 provides facilities for software dependency management, and for performing all of the necessary diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_mirror.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_mirror.html index 1c4da41a0cf..c8fac3ebbed 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_mirror.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_mirror.html @@ -10,11 +10,11 @@ Mirroring repositories with p2 -

    Mirroring repositories with p2

    +

    Mirroring Repositories With p2

    p2 provides two applications that support copying (mirroring) the content of remote repositories to a local repository. There is also a p2.mirror ant task.

    -

    Mirroring an artifact repository

    +

    Mirroring an Artifact Repository

    The artifact mirroring application supports duplicating a complete artifact repository into a target repository. To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.artifact.repository bundle. The following command will copy the complete contents of a source repository into the destination repository. If the destination @@ -28,14 +28,14 @@

    Mirroring an artifact repository

    -

    Arguments description

    +

    Arguments Description

    • -application org.eclipse.equinox.p2.artifact.repository.mirrorApplication: the application ID.
    • -source <source location>: the artifact repository to mirror from.
    • -destination <destination location>: the artifact repository to mirror to.
    -

    Additional arguments

    +

    Additional Arguments

    • -writeMode clean: removes all artifacts from the destination repository before performing the mirroring process.
    • -verbose: enables error messages and error logging.
      • @@ -52,7 +52,7 @@

      Additional arguments

    • -references <boolean>: enables or disables the mirroring of references. Default value is true.
    -

    Mirroring a metadata repository

    +

    Mirroring a Metadata Repository

    The metadata mirroring application supports copying a complete metadata repository into a target repository. To perform this operation you simply need an eclipse installation that contains the org.eclipse.equinox.p2.metadata.repository bundle. The following command will copy the complete source repository into the destination repository. If the destination @@ -66,7 +66,7 @@

    Mirroring a metadata repository

    -

    Arguments description

    +

    Arguments Description

    • -application org.eclipse.equinox.p2.metadata.repository.mirrorApplication: the application ID.
      • @@ -74,7 +74,7 @@

      Arguments description

    • -destination <destination location>: the metadata repository to mirror to.
    -

    Additional arguments

    +

    Additional Arguments

    • -writeMode clean: removes all installable units from the destination repository before performing the mirroring process.
    • -destinationName <destination name>: specifies what the destination repository should be named. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_pgp.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_pgp.html index 29438425bcf..887ea5af99d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_pgp.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_pgp.html @@ -10,7 +10,7 @@ Using PGP signatures in p2 -

      Using PGP signatures in p2

      +

      Using PGP Signatures in p2

      The p2 infrastructure analyzes the integrity and trustworthiness of artifacts during provisioning and installation, to guarantee artifact integrity, and also to help users decide whether or not to trust a particular artifact source. @@ -19,7 +19,7 @@

      Using PGP signatures in p2

      To avoid this problem, as of Eclipse 4.21, p2 provides support for extrinsic signatures, relying on industry-standard PGP (as is used by Maven for signing artifacts).

      -

      PGP signatures are published as artifact metadata

      +

      PGP Signatures Are Published as Artifact Metadata

      A PGP signature is stored as a property of an artifact's p2 metadata. Each artifact may specify a pgp.signatures @@ -40,7 +40,7 @@

      PGP signatures are published as artifact metadata

      Build technologies such as Eclipse Tycho have direct support for including signatures and keys on the artifact metadata and for including keys on the overall artifact repository metadata.

      -

      Invalid PGP signatures abort installation

      +

      Invalid PGP Signatures Abort Installation

      During provisioning, each artifact that has one or more associated PGP signatures will be verified that it is in fact signed by each signature's corresponding PGP public key, @@ -49,7 +49,7 @@

      Invalid PGP signatures abort installation

      For any given PGP signed artifact, at least one of its signatures must have a corresponding key that is verified as trusted.

      -

      Trust PGP keys to trust artifacts

      +

      Trust PGP Keys to Trust Artifacts

      Before PGP signature verification proceeds, each artifact with one or more PGP signatures is analyzed to determine the set PGP public keys corresponding to its set of PGP signatures. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publisher.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publisher.html index 3b21a84bda6..9e5572b282e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publisher.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publisher.html @@ -10,7 +10,7 @@ Publishing p2 metadata -

      Publishing p2 metadata

      +

      Publishing p2 Metadata

      The p2 metadata contains useful information about the elements that can be installed. These elements are called Installable Units (IUs). Among other things, the IUs describe dependencies, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publishingtasks.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publishingtasks.htm index 84fa595265d..170b4a86e44 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publishingtasks.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_publishingtasks.htm @@ -9,7 +9,7 @@ Ant tasks for publishing p2 metadata -

      Ant tasks for publishing p2 metadata

      +

      Ant Tasks for Publishing p2 Metadata

      p2 ships with two publisher ant tasks. The ant tasks are contained in org.eclipse.equinox.p2.publisher. This bundles is part of the Eclipse SDK.

      diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_repositorytasks.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_repositorytasks.htm index 8c6d67e3aa9..792bcac4fa3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_repositorytasks.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_repositorytasks.htm @@ -21,7 +21,7 @@

      - Ant tasks for managing repositories + Ant Tasks for Managing Repositories

    @@ -661,8 +661,7 @@

    @@ -734,10 +733,7 @@

    - p2.repo2runnable + p2.repo2runnable

    @@ -880,10 +876,7 @@

    -

    - p2.process.artifacts -

    - +

    p2.process.artifacts
    @@ -936,9 +929,7 @@

    -

    - - p2.remove.iu -

    +

    p2.remove.iu
    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uipolicy.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uipolicy.htm index 9f22e86b4cb..f5301cb54cd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uipolicy.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uipolicy.htm @@ -57,7 +57,7 @@

    - Example: Installing from the Cloud + Example: Installing From the Cloud

    This kind of customization is best described by example. A common @@ -339,7 +339,7 @@

    org.eclipse.equinox.p2.examples.rcp.cloud/showAllBundlesInstalled=true

    - Modifying the p2 UI Policy while reusing the p2 UI feature + Modifying the p2 UI Policy While Reusing the p2 UI Feature

    Because the p2 UI Policy is defined as an OSGi service, products that diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uireuse.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uireuse.htm index b9f7b6db243..32593ae9cc2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uireuse.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_uireuse.htm @@ -17,7 +17,7 @@

    You may reuse the p2 UI in its entirety, or you may pick and choose which aspects of the UI you want to include in your application.

    -

    Reusing the Eclipse SDK UI in its entirety

    +

    Reusing the Eclipse SDK UI in Its Entirety

    If your goal is to simply use the same update UI used in the SDK inside your RCP app, very few modifications are required. You'll need to include the org.eclipse.equinox.p2.user.ui feature in your application. This will add the following UI bundles to your application (in addition to all of the p2 core and other required bundles):

    @@ -36,7 +36,7 @@

    Reusing the Eclipse SDK UI in its entirety

    here.

    Example RCP Application with p2 UI

    -

    Reusing the Eclipse SDK UI without automatic updating

    +

    Reusing the Eclipse SDK UI Without Automatic Updating

    If you want to use the SDK UI, but do not wish to add automatic update support, the application is modified as above. However, the following bundles can be eliminated from the product:

    @@ -49,7 +49,7 @@

    Reusing the Eclipse SDK UI without automatic updating

    A sample RCP Mail application which shows how to do this can also be found here.

    -

    Modifying the UI contributions

    +

    Modifying the UI Contributions

    If you want to include p2 update functionality in the UI, but you don't want these items to appear in exactly the same way as they do in the SDK, you can provide your own bundle that makes p2 UI contributions in lieu of the SDK bundle. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs.htm index 684d1f4d740..564e8c3013d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs.htm @@ -15,7 +15,7 @@

    -Preference pages

    +Preference Pages

    Once a plug-in has contributed extensions to the workbench user interface, it is common for the plug-in to allow the user to control some of the behavior of the plug-in through diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_contribute.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_contribute.htm index b4d47422cae..a82af3ea519 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_contribute.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_contribute.htm @@ -15,7 +15,7 @@ -

    Contributing a preference page

    +

    Contributing a Preference Page

    The org.eclipse.ui.preferencePages extension point allows you to contribute pages to the general preferences diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_implement.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_implement.htm index 9f6380cee8b..e9ab3baee27 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_implement.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_implement.htm @@ -14,10 +14,10 @@ -

    Implementing a preference page

    +

    Implementing a Preference Page

    -Defining the page

    +Defining the Page

    The JFace plug-in provides a framework for implementing wizards, preference pages, and dialogs. The implementation for these dialogs follows a common pattern. @@ -84,7 +84,7 @@

    -Plug-in preference store

    +Plug-in Preference Store

    Preference stores are a convenience mechanism for accessing and storing preference values in a plug-in class. They provide plug-in level access to preferences that are actually stored using the runtime preferences service. AbstractUIPlugin @@ -120,7 +120,7 @@

    }

    -Retrieving and saving preferences

    +Retrieving and Saving Preferences

    Once you've associated your plug-in's preference store with your preference page, you can implement the logic for retrieving and saving the preferences.

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm index 057c799569a..4a99dc656df 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm @@ -14,7 +14,7 @@ -

    Contributing a property page

    +

    Contributing a Property Page

    You can contribute a property page for an object by using the org.eclipse.ui.propertyPages extension point. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_implement.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_implement.htm index eb95ed8871f..8dafd88c0b2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_implement.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_implement.htm @@ -14,7 +14,7 @@ -

    Implementing a property page

    +

    Implementing a Property Page

    When the workbench creates and launches a properties page, it sets the selected resource into the page. The page can use the getElement() method to obtain its element, an IAdaptable.

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_config_install.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_config_install.htm index 8105ed9caed..e2ea63987f6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_config_install.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_config_install.htm @@ -12,7 +12,7 @@ -

    Product installation guidelines

    +

    Product Installation Guidelines

    The platform provides standard tools for updating and extending products.  In order to participate in the platform mechanisms for updating and extending products, your packaged product should follow the following @@ -96,11 +96,11 @@

    Product installation guidelines

    processing and cache the results, so that when the user starts the product it comes up promptly in an open-for-business state. -

    Multi-user issues

    +

    Multi-user Issues

    When a product is installed with the intention of sharing the installation among multiple users, care must be taken to separate individual user's data (such as the workspace directory) from the shared product install directory.

    -

    Uninstall issues

    +

    Uninstall Issues

    When a product is uninstalled, the following concepts are important.

    • all files in the eclipse/features and eclipse/plugins @@ -114,7 +114,7 @@

      Uninstall issues

      that reinstalling the product after an uninstall will produce expected results.
    -

    Reinstalling the product

    +

    Reinstalling the Product

    When the product is already installed, the installer should allow a service update or upgrade if one is available.  The existence of the product can be confirmed by looking for acmeweb/eclipse/.eclipseproduct.  The diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_configproduct.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_configproduct.htm index 66be8fe94f6..aae21085453 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_configproduct.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_configproduct.htm @@ -13,14 +13,14 @@ -

    Customizing a product

    +

    Customizing a Product

    There are many customizable aspects of a product, such as its splash screen, about dialog text, window icons, etc. Most of these customizations are defined in the contribution to the org.eclipse.core.runtime.products extension point.

    Let's look at how some of the more common customizable elements are defined.

    -

    About dialogs

    +

    About Dialogs

    The platform "about" dialog is shown whenever the user selects @@ -54,7 +54,7 @@

    About dialogs

    See IProductConstants for more information about these properties.

    -

    Window images

    +

    Window Images

    A 16x16 pixel color image can be used to brand windows created by the product.  It will appear in the upper left hand corner of product windows.  It is specified in the windowImage attribute in the @@ -66,7 +66,7 @@

    Window images

    value="icons/eclipse.png,icons/eclipse32.png"/>

    The windowImages property supercedes the windowImage property if both are specified.

    -

    Welcome page

    +

    Welcome Page

    Products using the Eclipse 2.1 welcome page mechanism can specify the name and location of their welcome page file in the welcomePage property.

    	<property
@@ -76,7 +76,7 @@ 
    Welcome page
    
 now discouraged in favor of the org.eclipse.ui.intro
 extension point.  See Welcome/Intro support for more
 detail about the new welcome/intro mechanisms.
    
-
    Preferences defaults
    
+
    Preferences Defaults
    
 
 
    The preferenceCustomization property can be used to specify a file containing
 default preference values for the product.
    
@@ -89,7 +89,7 @@ 
    Preferences defaults
    
   refer to preferences that are used by plug-ins but not defined formally in the
   API.  
    
 
-
    Dialog settings defaults
    
+
    Dialog Settings Defaults
    
 
 
    If the custom preferences file is used as described above, setting the org.eclipse.ui/default_dialog_settings_rootUrl
 property in that file allows to specify a folder containing default dialog settings values for product plug-ins.
@@ -109,7 +109,7 @@ 
    Dialog settings defaults
    
 Those dialog_settings.xml files for each bundle can be retrieved from a running instance of the Eclipse Platform, under the folder ${workspace}/.metadata/.plugins. You can simply copy-paste those existing files into the directory set as value for the org.eclipse.ui/default_dialog_settings_rootUrl preference.
 
    
 
-
    Splash screens
    
+
    Splash Screens
    
 
    The product splash screen is specified in the config.ini which is
   located underneath the product's configuration directory. The osgi.splashPath property
   in this file describes places to search for a file called splash.bmp.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
index b0f9c51f8c9..80f005b6228 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
@@ -12,7 +12,7 @@
 
 
 
-
    Products and features
    
+
    Products and Features
    
 
    An Eclipse based product is a stand-alone program built with the
 Eclipse platform.  A product may optionally be packaged and delivered as one or more
 features, which are simply groupings of plug-ins that are managed as a single entity by
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
index d5a0e12ad33..28cea1d39ef 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
@@ -12,7 +12,7 @@
 
 
 
-
    Products extension point
    
+
    Products Extension Point
    
 
    The preferred mechanism for defining a product based on the Eclipse platform
   is to contribute to the
 org.eclipse.core.runtime.products
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_nl.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_nl.htm
index ef7ee314dab..21b5e15094d 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_nl.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_nl.htm
@@ -12,7 +12,7 @@
 
 
 
-
    Locale specific files
    
+
    Locale Specific Files
    
 
    Fragments are a convenient way to package national language
 translations.  Let's look more closely at the directory structure used for
 installing locale-specific translation files.  This directory structure is
@@ -29,7 +29,7 @@ 
    Locale specific files
    
 
    It is important to understand which mechanism is used to access any given
 file that must be translated so that you'll know what to name the file and where
 to put it in the file system relative to the plug-in.
    
-
    Platform core mechanism
    
+
    Platform Core Mechanism
    
 
    The platform core defines a directory structure that uses locale-specific
 subdirectories for files that differ by locale.  Translated files are
 placed in a directory called nl under the plug-in.  For example, the
@@ -97,7 +97,7 @@ 
    Platform core mechanism
    
   
    (Note:  The plugin.properties and fragment.properties are
   conspicuously absent from this list. They are treated in a sightly different way described below.)
    
 
-
    Java resource bundles
    
+
    Java Resource Bundles
    
 
    The standard Java handling of property resource bundles is used for other
 files.  Translated files are contained in a JAR file, with each properties
 file having a locale-specific name, such as "message_en_CA.properties". 
@@ -105,12 +105,12 @@ 
    Java resource bundles
    
 itself or one of its fragments.  Each translated properties file may be
 partial since lookup of keys accesses a well-defined chain of properties files.
    
 
-
    The plugin.properties mechanism
    
+
    The Plugin.properties Mechanism
    
 The mechanism used to translate plugin.properties files uses the Java resource bundles naming convention. However the files must be located in the root 
 of the plug-in or in the root of a fragment of this plug-in. 
 The same rules apply to the translation of MANIFEST.MF.
 
-
    Defining NL fragments
    
+
    Defining NL Fragments
    
 
    The shape of NL fragments has evolved slightly since 2.1. 
 Previously all translation files (including the plugin.properties) were provided in a jar. 
 This was inconsistent since the plugin.properties file was provided at the root of the plug-in.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
index 8c63636d096..62423f71ebd 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
@@ -12,7 +12,7 @@
 
 
 
-
    Plug-ins and fragments
    
+
    Plug-ins and Fragments
    
 
    Features are described in terms of the plug-ins that comprise them. A plug-in 
 is used to group your code into a modular, extendable and sharable unit.
    
 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_extension.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_extension.htm
index 0cca6e76a66..ab59002b0ee 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_extension.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_extension.htm
@@ -13,7 +13,7 @@
 
 
 
-
    Product extensions
    
+
    Product Extensions
    
 
    An extension is a set of Eclipse features and plug-ins that are
 designed to extend the functionality of already-installed Eclipse based
 products.  Extensions are installed separately, but used only in
@@ -56,7 +56,7 @@ 
    Product extensions
    
 directory of any product that it is intending to extend.  This link file
 makes the original product aware of the existence of the extension.
    
 
-
    Installing and uninstalling extensions
    
+
    Installing and Uninstalling Extensions
    
 
 
    The install process for extensions is similar to that for products except for
 the following differences:
    
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
index be1c82722d8..a4552e21ff5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_open_file.htm
@@ -87,7 +87,7 @@ 
    Talking to SWT
    
 Workbench when it creates the display and the value is the "appName" taken from the product extension point.
 
    
 
-
    Listening to SWT.OpenDocument events
    
+
    Listening to SWT.OpenDocument Events
    
 
    
 The launcher communicates with SWT to inform SWT about a request to open one or more files.  SWT then
 can fire the SWT.OpenDocument event.  For an RCP application to take advantage of this it must register
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_update.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_update.htm
index 4a0348242a8..1e91d737005 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_update.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_update.htm
@@ -12,7 +12,7 @@
 
 
 
-
    Updating a product or extension
    
+
    Updating a Product or Extension
    
 
    By following the prescribed procedures for packaging and installing products,
 we can take advantage of platform provisioning support, which treats
 products and extensions in a uniform way and allows users to discover and
@@ -36,7 +36,7 @@ 
    Updating a product or extension
    
 
 
    That said, what do we do if we want to fully participate in the platform
 implementation of product updating and use its update server?
    
-
    Feature and plug-in packaging
    
+
    Feature and Plug-in Packaging
    
 
    The previous example product and extension directory structures show how
 features and plug-ins are laid out once they are installed.  In order to
 install features using the software site, the features must be packaged in a
@@ -44,7 +44,7 @@ 
    Feature and plug-in packaging
    
 Archive Files. 
    
 
    Plug-ins and fragments must be packaged according to the format described in  Plug-in
 Archive Files.
    
-
    Software site layout
    
+
    Software Site Layout
    
 
    The software site must be a URL-accessible server with a fixed layout. 
 The list of available features and plug-ins provided by the server is described
 in a site map file, content.xml.  The server URL can be
@@ -69,7 +69,7 @@ 
    Software site layout
    
 		com.example.betterwebs.betterfeature_1.0.1.jar
 		com.example.betterwebs.betterwebsupport_1.0.1.jar
 		...
    -

    Update servers

    +

    Update Servers

    An Eclipse project software site is provided for updating the platform itself. In addition, the platform update UI allows users to maintain a list of software sites that can be searched for new features. Any site that conforms to the specified update server diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/rcp.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/rcp.htm index e67bfdef2f5..3f70140b7bc 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/rcp.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/rcp.htm @@ -14,7 +14,7 @@ -

    Building a Rich Client Platform application

    +

    Building a Rich Client Platform Application

    While the Eclipse platform is designed to serve as an open tools platform, it is architected so that its components could be used to build just about any client application. The minimal set of plug-ins needed to build a rich client application is collectively diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_batching.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_batching.htm index 4875e0a1185..28d31c627de 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_batching.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_batching.htm @@ -43,7 +43,7 @@

    at the same time. (Even if your plug-in is not using background jobs and the concurrency framework to modify the workspace, other plug-ins may be doing so.)

    -

    Scheduling rules and locking

    +

    Scheduling Rules and Locking

    IWorkspace protocol is used to run a workspace runnable. The preferred technique is using the long form of the run method which supplies a scheduling rule and specifies how resource change events are broadcast. @@ -95,7 +95,7 @@

    Scheduling rules and locking

    During this call, any other runnables created in the runnable will be considered part of the parent batch operation. Resource changes made in those runnables will appear in the parent's resource change notification.

    -

    Resource rule factory

    +

    Resource Rule Factory

    In the example above, we assumed that the code inside our runnable only modified resources in a particular project. This made it very easy to specify a scheduling rule for the runnable. In practice, it can be more difficult to compute what parts of the workspace are affected by a particular change. For example, moving a resource from one @@ -123,7 +123,7 @@

    Resource rule factory

    ISchedulingRule modifyRule = ruleFactory.modifyResource(destinationResource); workspace.run(myRunnable, MultiRule.combine(movingRule, modifyRule), IWorkspace.AVOID_UPDATE, null); -

    Ignoring the rules

    +

    Ignoring the Rules

    The short form of the run method in IWorkspace is also available. It is retained for backward compatibility. The short form does not include a rule or an update diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_buildconfigs.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_buildconfigs.htm index f1829f9b569..a9770f59613 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_buildconfigs.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_buildconfigs.htm @@ -57,7 +57,7 @@

    Client API

    -

    Creating and setting build configurations

    +

    Creating and Setting Build Configurations

    Each project has one default build configuration with name equal to the empty string. Build configurations are set on the @@ -84,7 +84,7 @@

    Creating and setting build configurations

    As each project must have at least one build configuration, it's not possible to remove all configurations from a project. Doing so automatically re-adds the default build configuration, with name: "".

    -

    Active configuration

    +

    Active Configuration

    By default one configuration on the project is defined as 'active'. The active configuration is the one that is built when a build configurations isn't specified (e.g. when: IProject#build(kind, monitor) is called on the project). To set the active build configuration: @@ -94,7 +94,7 @@

    Active configuration

    projDesc.setActiveBuildConfig(String buildConfigName); -

    Creating references between build configurations

    +

    Creating References Between Build Configurations

    Build Configurations can reference each other. Much like project level references, this can be used to ensure that prerequisite build configurations are built before referencing build configurations. @@ -134,7 +134,7 @@

    Builder API

    rather than projects. In simple cases the build configuration will be the default configuration, and the project will only have one configuration.

    -

    Which build configuration is being built

    +

    Which Build Configuration Is Being Built

    A builder can discover which configuration is being built via:

    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_builders.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_builders.htm
index 3a59bc43692..c0e7d08ff3b 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_builders.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_builders.htm
@@ -228,7 +228,7 @@ 
    Build Locking
    
   }
    -

    Discovering what's being built

    +

    Discovering What's Being Built

    It's sometimes useful for a builder to discover why its being built. Builders have access to a build context by calling 
    diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_concurrency.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_concurrency.htm
index ad4d86c26f4..d43b3bdbd4c 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_concurrency.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_concurrency.htm
@@ -14,7 +14,7 @@
 
 
 
-
    Concurrency and the workspace
    
+
    Concurrency and the Workspace
    
 
 
    We've already seen that workspace code must be aware of concurrency even if it is not using the 
 concurrency framework.  Batching of workspace changes and use of scheduling rules helps in sharing 
@@ -23,7 +23,7 @@ 
    Concurrency and the workspace
    
 easy to perform the same work using the platform concurrency mechanisms.
 
    
 
-
    Workspace jobs
    
+
    Workspace Jobs
    
 
    A Job is a basic unit of 
 asynchronous work running concurrently with other jobs.  The resources plug-in defines 
 WorkspaceJob
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_derived.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_derived.htm
index 96b2c06cc26..03b67ba4ae5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_derived.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_derived.htm
@@ -14,7 +14,7 @@
 
 
 
-
    Derived resources
    
+
    Derived Resources
    
 
 
    Many resources get created in the course of translating, compiling, copying,
 or otherwise processing files that the user creates and edits.  Derived
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_api.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_api.htm
index b47d1b021f3..c0e9a2c89b2 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_api.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_api.htm
@@ -14,7 +14,7 @@
 
 
 
-
    Using the file system API
    
+
    Using the File System API
    
 
    
 The org.eclipse.core.filesystem plug-in provides a generic API for 
 interacting with an arbitrary file system.  This API is similar to java.io.File,
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_intro.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_intro.htm
index cccafb88e6d..91889959180 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_intro.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_intro.htm
@@ -14,7 +14,7 @@
 
 
 
-
    Alternate file systems
    
+
    Alternate File Systems
    
 
 
    
 Most of the time, resources in the workspace are stored in a local file system
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_providers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_providers.htm
index 9895278b26a..4383575e708 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_providers.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_providers.htm
@@ -14,7 +14,7 @@
 
 
 
-
    File system providers
    
+
    File System Providers
    
 
 
    
 By default, the org.eclipse.core.filesystem plug-in only includes a file system
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_resources.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_resources.htm
index b4598401826..0c09ab7d133 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_resources.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_efs_resources.htm
@@ -14,7 +14,7 @@
 
 
 
-
    Working with resources in other file systems
    
+
    Working With Resources in Other File Systems
    
 
 
    
 Most of the API in the IResource
@@ -38,7 +38,7 @@ 
    Working with resources in other file systems
    
 only effective in the local file system. The URI-based location methods should
 be used instead.
 
    
-
    Local caching
    
+
    Local Caching
    
 
    
 Say you are working with resources that are not in the local file system, but you
 really need a local file.  For example, you may be using a library that has a 
@@ -57,7 +57,7 @@ 
    Local caching
    
    }
    java.util.zip.ZipFile zip = new java.util.ZipFile(file);
    -

    Linking to other file systems

    +

    Linking to Other File Systems

    You can use linked resources to create projects that draw together resources from multiple file systems. Simply use the method diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_events.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_events.htm index 5aa6b73e365..20a09581f1b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_events.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_events.htm @@ -24,7 +24,7 @@

    IResourceChangeEvent object, which describes the changes.

    -

    Registering a listener

    +

    Registering a Listener

    First, you must register a resource change listener with the workspace.

    @@ -46,7 +46,7 @@

    Registering a listener

    Methods that create, delete, or change a resource typically trigger these events. Methods that read, but do not write, resources typically do not trigger these events.

    -

    Resource change events

    +

    Resource Change Events

    The resource change event describes the specifics of the change (or set of changes) that have occurred in the workspace. The event contains a resource delta that describes the net effect of the changes. @@ -167,7 +167,7 @@

    Resource change events

    -

    - p2.composite.repository -

    +

    p2.composite.repository
    -

    Implementing a resource change listener

    +

    Implementing a Resource Change Listener

    The following example implements a console-based resource change listener. A resource change listener is registered for specific types of events and information about these events is printed to the console: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_hooks.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_hooks.htm index 648b50afceb..59c32e2dc33 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_hooks.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_hooks.htm @@ -31,7 +31,7 @@

    a repository provider for a discussion of how team uses these hooks.  

    -Resource move/delete hooks

    +Resource Move/Delete Hooks

    This hook allows the team plug-in and its providers to control @@ -56,7 +56,7 @@

    team provider is managing a resource and invoke its specific hook.

    -File modification validators

    +File Modification Validators

    It's also possible that team repository providers will need to prevent or intervene in the editing or saving of a file. The team plug-in @@ -73,7 +73,7 @@

    can determine which team provider is managing a resource and invoke its specific validator.

    -

    General team hook

    +

    General Team Hook

    Repository providers sometimes need to hook into additional workspace operations in order to impose extra restrictions or customize workspace behavior. The diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_modify.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_modify.htm index 6b701c3103c..61115a7ec07 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_modify.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resAdv_modify.htm @@ -14,7 +14,7 @@ -

    Modifying the workspace

    +

    Modifying the Workspace

    In the course of performing its function, your plug-in may need to make changes to resources in the workspace. The workspace is an important data model for many plug-ins in the system, many of which rely on keeping up with the current state of the workspace. Plug-ins may even be concurrently updating the workspace. It's important diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_content.htm index 567810c056d..f4e2cef2347 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_content.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_content.htm @@ -25,7 +25,7 @@

    does not define a particular encoding inside its data stream.

    -Setting a character set +Setting a Character Set

    We've seen in Content types that default file encodings can be established @@ -45,7 +45,7 @@

    Both of these features are available to the end-user in the properties page for a resource.

    -

    Querying the character set

    +

    Querying the Character Set

    IFile also defines API for querying the character set of a file. A boolean flag specifies whether only the character set explicitly @@ -63,7 +63,7 @@

    Querying the character set

    itself will be checked. And finally, the platform default character set will be returned if there is no other designation of a default character set. The convenience method getCharset() is the same as using getCharset(true).

    -

    Content types for files in the workspace

    +

    Content Types for Files in the Workspace

    For files in the workspace, IFile provides API for obtaining the file content description:

    IFile file = ...;
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_linked.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_linked.htm
index 99092e622eb..48c710cea00 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_linked.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_linked.htm
@@ -46,7 +46,7 @@ 
    Linked resources
    
 deleting linked resources.  See IResource
 and its sub-classes for information on individual operations and their limitations.
 
    
-
    Path variables
    
+
    Path Variables
    
 
    
   Path variables can be used
 when specifying the location of linked resources.  A path variable is a simple (String ->
@@ -91,7 +91,7 @@ 
    Path variables
    
 If a resource location is not defined with a path variable, the getRawLocationURI
 method acts exactly like the getLocationURI method.
 
    
-
    Broken links
    
+
    Broken Links
    
 
    
 Clients that manipulate resources programmatically need to be aware of the possibility of
 broken links.  Broken links occur when a linked resource's location does not
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_preferences.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_preferences.htm
index 9c85040c46b..2a4e44288ca 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_preferences.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_preferences.htm
@@ -25,7 +25,7 @@ 
    
 inside the project.  This makes it easy to store a set of preferences and exchange them with other users using 
 resource-oriented mechanisms such as a version control system.
 
    
-
    Specifying the scope
    
+
    Specifying the Scope
    
 
 
    The definition for new scopes is pretty simple.  The plug-in defines the name of the scope, as well as the class
 that implements it.  The resources plug-in defines the project scope 
@@ -40,7 +40,7 @@ 
    Specifying the scope
    
 it must be capable of creating preference nodes for the scope.
 
    
 
-
    Project-scoped preference nodes
    
+
    Project-scoped Preference Nodes
    
 
 
    Since the project scope for preferences is not one of the standard runtime scopes, the node representing a project-level
 preference must be obtained specifically.  From the root preference node, you must navigate to the project-scoped
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_properties.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_properties.htm
index eb597890d26..1742c67dcda 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_properties.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/resInt_properties.htm
@@ -15,7 +15,7 @@
 
 
 
-
    Resource properties
    
+
    Resource Properties
    
 
    Resources have properties that can be used to store meta-information about the resource.  Your plug-in
 can use these properties to hold information about a resource that is specific to your purpose.
 Resource properties are declared, accessed, and maintained by various plug-ins, and are not interpreted 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_app_model.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_app_model.htm
index 0c03f2c350a..d2d9701d3dd 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_app_model.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_app_model.htm
@@ -29,7 +29,7 @@ 
    
   information.
 
    
 
    
-The default application
+The Default Application
 
    
 
    
 A given Eclipse configuration may contain many products and applications.  An Eclipse configuration 
@@ -46,7 +46,7 @@ 
    
 
 
 
    
-Defining an application
+Defining an Application
 
    
 
    
 Plug-ins may define their own applications using the 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content.htm
index fd3802c09ec..4b38a10a0f6 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content.htm
@@ -13,7 +13,7 @@
 
 
 
-
    Content types
    
+
    Content Types
    
 
    The org.eclipse.core.runtime.content 
   package provides support for detecting the content type for data streams. Content 
   types are used by several content-sensitive features of Eclipse, such as automatic 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_contributing.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_contributing.htm
index 305f45a0f16..e589609d2dd 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_contributing.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_contributing.htm
@@ -13,8 +13,8 @@
 
 
 
-
    Contributing content types
    
-
    Providing a new content type
    
+
    Contributing Content Types
    
+
    Providing a New Content Type
    
 
    The platform defines some fundamental content types, such as plain text and 
   XML. These content types are defined the same way as those contributed by any 
   other plug-ins. We will look at how the platform defines some of its content 
@@ -41,7 +41,7 @@ 
    Providing a new content type
    
   and description (if the client provides a file name).
    
 
    The describer element is used to define a content describer 
   for the content type.
    
-
    Detecting and describing content
    
+
    Detecting and Describing Content
    
 
    A content type should provide a content describer if there are any identifiable 
   characteristics that allow automatic content type detection, or any interesting 
   properties in data belonging to the content type. In the case of org.eclipse.core.runtime.text, 
@@ -73,7 +73,7 @@ 
    Detecting and describing content
    
   premature activation, which must be avoided. Future implementations of the platform 
   might refuse to instantiate describers if doing so would trigger activation 
   of the corresponding plug-in.
    
-
    Extending an existing content type
    
+
    Extending an Existing Content Type
    
 
 
    Content types are hierarchical in nature. This allows new content types to 
   leverage the attributes or behavior of more general content types. For example, 
@@ -101,7 +101,7 @@ 
    Extending an existing content type
    
 
    Note that the default value for the charset property is inherited. It is possible 
   to cancel an inherited property or describer by redeclaring them with the empty 
   string as value.
    
-
    Additional file associations
    
+
    Additional File Associations
    
 
    New file associations can be added to existing content types. For instance, 
   the Resources plug-in associates the org.eclipse.core.runtime.xml 
   to ".project" files:
    
@@ -109,7 +109,7 @@ 
    Additional file associations
    
 	<file-association content-type="org.eclipse.core.runtime.xml" file-names=".project"/>
 	...
    -

    Content type aliasing

    +

    Content Type Aliasing

    Due to the extensible nature of Eclipse, a content type a plug-in rely on may not be available in a given product configuration. This can be worked around by using content type aliasing. A content type alias is a placeholder diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_using.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_using.htm index d2cbffd14b4..7e77ca23856 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_using.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_content_using.htm @@ -13,7 +13,7 @@ -

    Using content types

    +

    Using Content Types

    Note:  For this discussion, we specifically avoid the use of the word file when talking about content. The runtime content engine does not assume that content is contained in a file in the file system. However, @@ -24,7 +24,7 @@

    Using content types

    content types discusses the file-oriented content type capabilities contributed by the platform resources plug-in and is a must-read for developers interested in using the content type API in that context.
    -

    Finding out about content types

    +

    Finding Out About Content Types

    Content types are represented by IContentType. This interface represents a unique content type that knows how to read a data stream and interpret content type-specific information. Content types are hierarchical @@ -45,7 +45,7 @@

    Finding out about content types

  • getContentType allows clients to obtain a content type by its unique identifier.
    • -

    Detecting the content type for a data stream

    +

    Detecting the Content Type for a Data Stream

    Given a stream of bytes, it is possible to determine its content type by calling the IContentTypeManager API as follows:

    @@ -64,7 +64,7 @@

    Detecting the content type for a data stream

    a big performance hit, since all content types in the platform have to be given a chance of analysing the stream. So, unless it is not available, clients should always provide a file name along with the stream.

    -

    Describing a data stream

    +

    Describing a Data Stream

    Another interesting feature of the content type support in the platform is the ability of describing the contents of a binary or character stream. The following code snippet shows how to do that:

    @@ -77,7 +77,7 @@

    Describing a data stream

    properties in form of key/value pairs. The platform itself is able to describe properties such as the character set and the byte order of text-based streams, but others can be defined by content type providers.

    -

    Providing content-sensitive features

    +

    Providing Content-sensitive Features

    New content types are often defined as specialization of existing ones. This hierarchy establishes a "is a" relationship between a derived content type and its base type. Plug-in developers must honor this when implementing diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs.htm index 0d0fc35936d..c694c30add6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs.htm @@ -99,7 +99,7 @@

    Jobs

    indicate failure (by returning an IStatus with severity IStatus.ERROR), or cancellation (IStatus.CANCEL).

    -

    Common job operations

    +

    Common Job Operations

    We've seen how to schedule a job and wait for it complete, but there are many other interesting things you can to do jobs. If you @@ -123,7 +123,7 @@

    Common job operations

    and a wakeUp() call will cause the job to be added to the wait queue where it will eventually be executed.

    -

    Job states

    +

    Job States

    A job goes through several states during its lifetime. Not only can it be manipulated through API such as cancel() and sleep(), but its state also changes as the platform runs and completes the @@ -145,7 +145,7 @@

    Job states

    notified as the job moves through its life-cycle. This is useful for showing progress or otherwise reporting on a job.

    -

    Job change listeners

    +

    Job Change Listeners

    The Job method addJobChangeListener can be used to register a listener on a particular job. @@ -170,7 +170,7 @@

    Job change listeners

    change state again by the time the call returns. Job change listeners are the recommended mechanism for discovering state changes in a job.     -

    The job manager

    +

    The Job Manager

    IJobManager defines protocol for working with all of the jobs in the system. Plug-ins that show progress or otherwise @@ -183,7 +183,7 @@

    The job manager

    Plug-ins interested in the state of all jobs in the system can register a job change listener on the job manager rather than registering listeners on many individual jobs.

    -

    Job families

    +

    Job Families

    It is sometimes easier for a plug-in to work with a group of related jobs as a single unit. This can be accomplished using job families. A job declares that it belongs to a certain family by @@ -217,7 +217,7 @@

    Job families

    given time.

    -

    Completing jobs before shutdown

    +

    Completing Jobs Before Shutdown

    Since jobs run concurrently, it is possible for your jobs to be still running when the platform begins to shutdown. This is a dangerous situation, since after your plug-in stops it diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_progress.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_progress.htm index af62c753b4c..b8c3d1feba1 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_progress.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_progress.htm @@ -14,7 +14,7 @@

    -Reporting progress

    +Reporting Progress

    Long running jobs (those lasting more than a second) should report progress to the @@ -60,7 +60,7 @@

    completion based on the amount of work reported in the worked calls.

    -

    Progress monitors and the UI

    +

    Progress Monitors and the UI

    As you can see, the IProgressMonitor @@ -73,7 +73,7 @@

    Progress monitors and the UI

    See Workbench Concurrency Support for a detailed look at the APIs available for showing progress for jobs.

    -

    System jobs

    +

    System Jobs

    What if your job is a low-level implementation detail that you don't want to show to users? You can flag your job as a system job. A @@ -96,7 +96,7 @@

    System jobs

    scheduled. An exception will be triggered if you attempt this call on a job that is currently waiting, sleeping, or running.

    -

    User jobs

    +

    User Jobs

    If your job is a long running operation that is initiated by a user, then you should flag your job as a user job. A user job will @@ -120,7 +120,7 @@

    User jobs

    The setUser call must also be made before the job is scheduled.

    -

    Progress groups

    +

    Progress Groups

    Progress groups are another mechanism that can be used to influence the way that a job is shown in the UI. When it is more diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_scheduling.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_scheduling.htm index 2565890311d..d8e9e4e782c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_scheduling.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_jobs_scheduling.htm @@ -21,7 +21,7 @@

    scheduling conditions.

    -Job priorities

    +Job Priorities

    A job priority can be used to establish the importance of a job relative to other jobs in the system. Setting the priority of a job won't affect a job that is already running, but it will affect how @@ -47,7 +47,7 @@

    job.schedule(); -

    Scheduling with a delay

    +

    Scheduling With a Delay

    Another technique for controlling how a job is scheduled is to use a scheduling delay. A scheduling delay can be specified when the job is scheduled. The job will be delayed for the specified number of milliseconds @@ -57,7 +57,7 @@

    Scheduling with a delay

    job.schedule(1000); // wait one second before scheduling -

    Rescheduling a job

    +

    Rescheduling a Job

    Scheduling a job that is already waiting or is sleeping has no effect. However, scheduling a job that is already running will cause it to be rescheduled after it is finished. This is a convenient mechanism for @@ -79,7 +79,7 @@

    Rescheduling a job

    } -

    Custom scheduling conditions

    +

    Custom Scheduling Conditions

    Additional protocol in the Job class allows a job to check for preconditions just before it is scheduled or run. This is best demonstrated by example: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_preferences.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_preferences.htm index e53ffc8b9f3..74698698c7c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_preferences.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/runtime_preferences.htm @@ -24,7 +24,7 @@

    file system. The exact location of the saved preferences depends upon the scope of the preference.

    -Preference scopes +Preference Scopes

    The scope of a preference is closely related to where the preference is stored. Plug-in developers can decide which of the standard scopes apply for their preferences, or can define @@ -83,7 +83,7 @@

    is always consulted if no node can be found using the specified scopes.

    -Using scopes and nodes +Using Scopes and Nodes

    If a plug-in needs finer control over the scope search order, classes that represent the scopes can be used @@ -119,7 +119,7 @@

    ...

    -Extending the scopes +Extending the Scopes

    Plug-ins may define their own specialized scopes using the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/search_page.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/search_page.htm index c7396bddf4d..5ef20db6039 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/search_page.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/search_page.htm @@ -49,7 +49,7 @@

    infrastructure to find the search page most appropriate for a given resource.

    If a search page can search all possible resources then "*" should be used.

    Implementing -the search page

    +the Search Page

    The protocol for ISearchPage is simple.  Your search page must implement performAction() which diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_design.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_design.htm index e1314c6b18a..4a73fef1b95 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_design.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_design.htm @@ -178,7 +178,7 @@

    Text Analysis

    The processed expression, after addition of directional formatting characters, is called full text.

    -

    LRM Addition (structured text with LTR base text direction)

    +

    LRM Addition (structured Text With LTR Base Text Direction)

    A LRM will be added before a token if the following conditions are satisfied:

    • The last strong character before the token has a bidi type equal to R or @@ -202,7 +202,7 @@

      LRM Addition (structured text with LTR base text direction)

      ARABIC NUMBER 123 @< 456 -

      RLM Addition (structured text with RTL base text direction)

      +

      RLM Addition (structured Text With RTL Base Text Direction)

      A RLM will be added before a token if the following conditions are satisfied:

      • The last strong character before the token has a bidi type equal diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_structured_text.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_structured_text.htm index a1d00fce214..49ec31a034a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_structured_text.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_structured_text.htm @@ -40,7 +40,7 @@

        Structured Text Overview

        http://www-128.ibm.com/developerworks/websphere/library/techarticles/bidi/bidigen.html.

        -

        Working with Structured Text

        +

        Working With Structured Text

        Eclipse provides support for correct presentation of structured text. The base functionality can be found in the package "org.eclipse.equinox.bidi". diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_text_types.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_text_types.htm index ab8ad31c850..420eeaf28d2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_text_types.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/st_text_types.htm @@ -353,124 +353,6 @@

        Detailed Design

        Logical order (with LRM): DEF@!GHI@ 'A!B'@=JK Display (without LRM): FED!IHG 'B!A'=KJ - -

         

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt.htm index f27e7dfedea..19d65b38645 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt.htm @@ -26,7 +26,7 @@

        The Standard Widget Toolkit

        platform works.

        -

        Portability and platform integration

        +

        Portability and Platform Integration

        SWT defines a common portable API that is provided on all supported platforms, and implements the API on each platform using native widgets diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_threading.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_threading.htm index 789b0b54b5a..35c9341e735 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_threading.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_threading.htm @@ -21,7 +21,7 @@

        Threading issues

        applications must follow when using Java threads in their code.

        -

        Native event dispatching

        +

        Native Event Dispatching

        Underneath any GUI application, regardless of its language or UI toolkit, the OS platform detects GUI events and places them in application event queues. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_custom.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_custom.htm index ffd659a5a95..3db14e154f9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_custom.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_custom.htm @@ -13,7 +13,7 @@ -

        Custom widgets

        +

        Custom Widgets

        You may want to extend SWT by implementing your own custom widget. SWT itself provides a package, org.eclipse.swt.custom, @@ -86,7 +86,7 @@

        Custom widgets

        -

        Implementing a custom widget

        +

        Implementing a Custom Widget

        Once you've determined that you need a custom widget and have decided which platforms must be supported, you can consider several implementation techniques @@ -94,7 +94,7 @@

        Implementing a custom widget

        is available in the underlying OS platform.

        -

        Native implementation

        +

        Native Implementation

        If your application requires a native widget that is not provided by SWT, you will need to implement it natively. This may be a platform widget, a third @@ -104,7 +104,7 @@

        Native implementation

        Your Own Widgets using SWT.

        -

        Combining existing widgets

        +

        Combining Existing Widgets

        Widgets can be combined to form widgets that are more sophisticated. For example, a Combo can be implemented using a text entry widget along with a @@ -116,7 +116,7 @@

        Combining existing widgets

        A simple example can be found in CCombo.

        -

        Custom drawn implementation

        +

        Custom Drawn Implementation

        In some cases, you don't have any native code or existing widgets that help you in the implementation of your new widget. This means you must draw the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_events.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_events.htm index 930b2792fa2..d40a1228d2e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_events.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/swt_widgets_events.htm @@ -56,7 +56,7 @@

        Events

        implementations.

        -

        High level events

        +

        High Level Events

        @@ -211,7 +211,7 @@

        High level events

        -

        Low level events

        +

        Low Level Events

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team.htm index 76760ff7fb7..434be1851ad 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team.htm @@ -11,7 +11,7 @@ -

        Version Control (Team) support

        +

        Version Control (Team) Support

        The Eclipse version control support, via the team plug-ins, defines API that allow plug-ins to integrate the function of a versioning and configuration management repository. The function provided by a repository fundamentally affects diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_howto.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_howto.htm index 0b8ca5a5731..ff3e0007c77 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_howto.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_howto.htm @@ -42,7 +42,7 @@

        Rich Team Integration

        achieve similar integration? Here are some basic steps to start with and links for information (both team-specific and workbench-oriented) on these topics.

        -

        Getting started

        +

        Getting Started

        @@ -84,7 +84,7 @@

        Getting started
        -

        Enhancing resource views

        +

        Enhancing Resource Views

        @@ -119,7 +119,7 @@

        Enhancing resource views
        -

        Handling user editing and changes to resources

        +

        Handling User Editing and Changes to Resources

        @@ -187,7 +187,7 @@

        Handling user editing and changes to resources
        -

        Streamlining repository-related tasks

        +

        Streamlining Repository-related Tasks

        @@ -214,7 +214,7 @@

        Streamlining repository-related tasks
        -

        Enhancing platform integration

        +

        Enhancing Platform Integration

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_model_model.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_model_model.htm index 8f1258cf4e4..ea57e693611 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_model_model.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_model_model.htm @@ -201,8 +201,7 @@

        Resource Mapping Context

        the necessary resources are included in the traversal. If a context is not provided, the mapping can assume that only the local state is of interest.

        -

        When does a ResourceMapping need to worry about the -RemoteResourceMappingContext?

        +

        When Does a ResourceMapping Need to Worry About the RemoteResourceMappingContext?

        A ResourceMapping need only worry about a context supplied to the getTraversals method in cases were the resources that make up a model change over time and the relationship @@ -448,7 +447,7 @@

        Using the Saveable API

        provider wants to ensure that there are no open dirty editors on a set of resources before a repository operation is performed.

        -

        Showing the history of sub-file elements

        +

        Showing the History of Sub-file Elements

        The ElementLocalHistoryPageSource class can be used by models to show the local history for a sub-file element such as a Java method. @@ -463,7 +462,7 @@

        Showing the history of sub-file elements

        replacing the current element with an element from the history.

        -

        Grouping related changes

        +

        Grouping Related Changes

        Model providers that wish to ensure that changes to sets of resources are committed or checked-in to a repository together can subclass the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_provider_repository.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_provider_repository.htm index 65c9d81890a..38828771e4c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_provider_repository.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_provider_repository.htm @@ -13,7 +13,7 @@ -

        Repository providers

        +

        Repository Providers

        A repository provider (RepositoryProvider) @@ -181,7 +181,7 @@

        Configuring a project

        RepositoryProvider.map(project, CVSProviderPlugin.getTypeId()); } -

        Finding a provider

        +

        Finding a Provider

        Static methods in RepositoryProvider make it easy for clients to map projects to providers and to find the providers @@ -235,7 +235,7 @@

        Repository Providers and Capabilities

        Project... wizard which allows filtering of repository providers based on the enabled/disabled state of workbench capabilities, and the other is the Team plug-in auto-enablement trigger.

        -

        Resource modification hooks

        +

        Resource Modification Hooks

        Most of the interesting functionality associated with a repository provider occurs as the user works with resources in the project that is configured for the provider.  In order to be aware of changes the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources.htm index fe760bc7f65..51675f24be8 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources.htm @@ -13,7 +13,7 @@ -

        Repository resource management

        +

        Repository Resource Management

        Once you have created a RepositoryProvider, there are other resource management mechanism that should be understood:
        @@ -38,7 +38,7 @@

        Repository resource management

        from the user as team private.
        -

        Ignored files

        +

        Ignored Files

        In several cases, it may be unnecessary to keep certain files under repository control.  For example, resources that are derived from existing @@ -83,7 +83,7 @@

        File Types

        -

        Team and linked resources

        +

        Team and Linked Resources

        A project may contain resources that are not located within the project's directory in the local file system. These resources are referred to as linked resources.

        @@ -140,7 +140,7 @@

        Strategies for Handling Linked Resources

        another provider). Our recommendation therefore is to support version controlled projects which contain non-version controlled linked resources.

        -

        Technical Details for Being "Link Friendly"

        +

        Technical Details for Being "link Friendly"

        Repository provider implementations can be upgraded to support linked resources by overriding the RepositoryProvider.canHandleLinkedResources() @@ -163,7 +163,7 @@

        Technical Details for Being "Link Friendly"

        String linkedParentName = resource.getProjectRelativePath().segment(0);
        IFolder linkedParent = resource.getProject().getFolder(linkedParentName);
        boolean isLinked = linkedParent.isLinked();

        Repository providers should ignore any resource for which the above code evaluates to true.

        -

        Team private resources

        +

        Team Private Resources

        It is common for repository implementations to use extra files and folders to store information specific about the repository implementation.  @@ -195,7 +195,7 @@

        Team private resources

        Attempts to mark projects or the workspace root as team private will be ignored.

        -

        Project sets

        +

        Project Sets

        Since the resources inside a project under version control are kept in the repository, it is possible to share projects with team members by diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_filetypes.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_filetypes.htm index 5ed545a8df0..1970a3395d6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_filetypes.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_filetypes.htm @@ -12,7 +12,7 @@ -

        File types

        +

        File Types

        The presence of a repository management system may dictate special handling needs for files.  For example, some files should be omitted from version control.  Some providers have special handling for text vs. binary @@ -21,7 +21,7 @@

        File types

        handling is ultimately left up to the user via the team Preferences page.  These extensions allow plug-ins to seed the preferences with values appropriate for the plug-in.

        -

        Ignored files

        +

        Ignored Files

        In several cases, it may be unnecessary to keep certain files under repository control.  For example, resources that are derived from existing resources can often be omitted from the repository.  For example, compiled @@ -37,7 +37,7 @@

        Ignored files

        to decide which files should be ignored.  The user may select, deselect, add or delete file types from the default list of ignored files.

        -

        Text vs. binary files

        +

        Text vs. Binary Files

        Some repositories implement different handling for text vs. binary files.  The org.eclipse.team.core.fileTypes extension allows plug-ins to declare file types as text or binary files.  diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_linked.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_linked.htm index 1bb63932874..5e2442eee32 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_linked.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_linked.htm @@ -12,7 +12,7 @@ -

        Team and linked resources

        +

        Team and Linked Resources

        A project may contain resources that are not located within the project's directory in the local file system. These resources are referred to as linked resources.

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_private.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_private.htm index 8175e3590e5..53cd0dcce95 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_private.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_private.htm @@ -12,7 +12,7 @@ -

        Team private resources

        +

        Team Private Resources

        It is common for repository implementations to use extra files and folders to store information specific about the repository implementation.  Although these files may be needed in the workspace, they are of no interest to other diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_projects.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_projects.htm index 376dd80ee10..f3c060cdb75 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_projects.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_resources_projects.htm @@ -12,7 +12,7 @@ -

        Project sets

        +

        Project Sets

        Since the resources inside a project under version control are kept in the repository, it is possible to share projects with team members by sharing a reference to the repository specific information needed to reconstruct a project diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize.htm index ac4fe880349..52f73770c42 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize.htm @@ -105,7 +105,7 @@

        The Basics - SyncInfo

        This package also contains collections specifically designed to contain SyncInfo and filters that can be applied to SyncInfo instances.

        -

        Managing the synchronization state

        +

        Managing the Synchronization State

        As we have seen in the examples above, SyncInfo @@ -172,7 +172,7 @@

        Managing the synchronization state

        and SyncInfo#getLocal().

        -

        Displaying the synchronizations state in the UI

        +

        Displaying the Synchronizations State in the UI

        We could spend more time explaining how to manage synchronization state but instead let's see how to actually get the state shown to the user. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize_localhistory_example.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize_localhistory_example.htm index 45987117fdc..2a9c81f245c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize_localhistory_example.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_synchronize_localhistory_example.htm @@ -42,7 +42,7 @@

        Local History Example

        to the contents in the local history. Notice also that the standard Synchronize View presentation is used which provide problem annotations, compressed folder layout, and navigation buttons.

        -

        Defining the variants for local history

        +

        Defining the Variants for Local History

        The first step is to define a variant to represent the elements from local history. This will allow the synchronize APIs to access the contents from the local history so it can be compared with the current contents and displayed diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_actions.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_actions.htm index 5e156f481b7..37690006cf0 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_actions.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_actions.htm @@ -13,7 +13,7 @@

        - Adding team actions + Adding Team Actions

        The team UI plug-in defines a popup menu extension in order to consolidate all team-related actions in one place.  The team menu includes many diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_decorators.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_decorators.htm index 43c9feb3fd0..12d7478093a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_decorators.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_decorators.htm @@ -12,7 +12,7 @@ -

        Team decorators

        +

        Team Decorators

        Since any view that shows resources can contain projects that are configured with different team providers, it is helpful for team providers to contribute decorators that distinguish resources diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_history.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_history.htm index df48b755a75..b0fd58d4f5b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_history.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_history.htm @@ -13,7 +13,7 @@

        - Adding History support + Adding History Support

        There are two parts to adding History support to your repository:

          @@ -71,7 +71,7 @@

          Showing History for Sub-file Elements

          to show the history.
        -

        FileSystem History example

        +

        FileSystem History Example

        The FileSystem example illustrates how you can provide history and a history page for repository items. Select a resource in a FileSystem managed project and choose Team > Show History. The FileSystem History page will be displayed in the History view with all of the local revisions as well as the FileSystem revision diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_prefs.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_prefs.htm index d6e64df46bf..8343bf8f93d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_prefs.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/team_ui_prefs.htm @@ -12,7 +12,7 @@ -

        Adding preferences and properties

        +

        Adding Preferences and Properties

        Preferences and properties can be contributed by team UI plug-ins using the standard techniques.  The only difference for a team plug-in is that preferences should be contributed From 91854c523bdbc72a5ee858d5d87d3a36f4bdb245 Mon Sep 17 00:00:00 2001 From: Matthias Becker Date: Fri, 4 Oct 2024 15:18:33 +0200 Subject: [PATCH 2/4] Write HTML-Headers in Title Case in platform.doc.isv (II) --- .../org.eclipse.platform.doc.isv/guide/ua.htm | 4 ++-- .../guide/ua_cheatsheet.htm | 6 +++--- .../guide/ua_cheatsheet_composite.htm | 10 +++++----- .../guide/ua_cheatsheet_composite_content.htm | 2 +- .../guide/ua_cheatsheet_guidelines.htm | 17 +++++++---------- .../guide/ua_cheatsheet_simple.htm | 18 ++++++++---------- .../guide/ua_dynamic.htm | 6 +++--- .../guide/ua_dynamic_extensions.htm | 16 ++++------------ .../guide/ua_dynamic_filters.htm | 10 +++++----- .../guide/ua_dynamic_includes.htm | 2 +- .../guide/ua_help_abstract_scope.htm | 2 +- .../guide/ua_help_content.htm | 2 +- .../guide/ua_help_content_active.htm | 2 +- .../guide/ua_help_content_active_action.htm | 2 +- .../guide/ua_help_content_active_debug.htm | 10 +++++----- .../guide/ua_help_content_active_invoke.htm | 2 +- .../guide/ua_help_content_command.htm | 2 +- .../ua_help_content_command_authoring.htm | 2 +- .../guide/ua_help_content_criteria.htm | 12 ++++++------ .../guide/ua_help_content_files.htm | 6 +++--- .../guide/ua_help_content_manifest.htm | 2 +- .../guide/ua_help_content_nested.htm | 6 +++--- .../guide/ua_help_content_toc.htm | 2 +- .../guide/ua_help_content_xhtml.htm | 2 +- .../guide/ua_help_context.htm | 2 +- .../guide/ua_help_context_dynamic.htm | 2 +- .../guide/ua_help_context_id.htm | 2 +- .../guide/ua_help_context_xml.htm | 8 ++++---- .../guide/ua_help_infocenter_preferences.htm | 8 ++++---- .../guide/ua_help_search.htm | 2 +- .../guide/ua_help_search_types.htm | 2 +- .../guide/ua_help_setup.htm | 6 +++--- .../guide/ua_help_setup_about.htm | 2 +- .../guide/ua_help_setup_infocenter.htm | 10 +++++----- .../guide/ua_help_setup_nav.htm | 2 +- .../guide/ua_help_setup_preferences.htm | 10 +++++----- .../guide/ua_help_setup_preindex.htm | 8 ++++---- .../guide/ua_help_setup_rcp.htm | 2 +- .../guide/ua_help_setup_standalone.htm | 8 ++++---- .../guide/ua_help_war.htm | 4 ++-- .../guide/ua_intro_cust_static.htm | 2 +- .../guide/ua_intro_define_content.htm | 2 +- .../guide/ua_intro_defining.htm | 2 +- .../guide/ua_intro_defining_config.htm | 2 +- .../guide/ua_intro_ext_custom_url.htm | 2 +- .../guide/ua_intro_ext_standbypart.htm | 2 +- .../guide/ua_intro_ext_theme.htm | 4 ++-- .../guide/ua_intro_extending.htm | 2 +- .../guide/ua_intro_extending_content.htm | 2 +- .../guide/ua_intro_hello_world.htm | 2 +- .../guide/ua_intro_minimal.htm | 8 ++++---- .../guide/ua_intro_universal.htm | 6 +++--- .../guide/ua_intro_universal_contributing.htm | 2 +- .../guide/ua_intro_universal_defaults.htm | 2 +- .../guide/ua_intro_universal_extending.htm | 4 ++-- .../guide/ua_intro_universal_links.htm | 2 +- .../guide/ua_intro_universal_preference.htm | 2 +- .../guide/ua_intro_xhtml.htm | 2 +- .../guide/ua_statushandling.htm | 2 +- .../guide/ua_statushandling_defining.htm | 2 +- .../guide/ua_statushandling_sample.htm | 2 +- .../guide/workbench.htm | 2 +- .../guide/workbench_advext_activities.htm | 16 ++++++++-------- .../guide/workbench_advext_contexts.htm | 6 +++--- .../guide/workbench_cmd_bindings.htm | 2 +- .../guide/workbench_cmd_commands.htm | 2 +- .../guide/workbench_cmd_handlers.htm | 8 ++++---- .../guide/workbench_cmd_menus.htm | 8 ++++---- .../guide/workbench_jobs.htm | 8 ++++---- .../guide/workbench_perspectives.htm | 13 +++++-------- .../guide/workbench_resources.htm | 2 +- .../guide/workbench_scalability.htm | 2 +- .../guide/workbench_statushandling.htm | 14 +++++++------- .../workbench_statushandling_defining.htm | 4 ++-- .../guide/wrkAdv_accessibility.htm | 8 ++++---- .../guide/wrkAdv_commands_handlers.htm | 2 +- .../guide/wrkAdv_efs_resources.htm | 2 +- .../guide/wrkAdv_encoding.htm | 2 +- .../guide/wrkAdv_keyBindings.htm | 2 +- .../guide/wrkAdv_keyBindings_accelConfig.htm | 4 ++-- .../guide/wrkAdv_keyBindings_accelSet.htm | 2 +- .../guide/wrkAdv_keyBindings_actionDef.htm | 2 +- .../guide/wrkAdv_keyBindings_contexts.htm | 2 +- .../guide/wrkAdv_marker_support.htm | 2 +- .../guide/wrkAdv_markerhelp.htm | 2 +- .../guide/wrkAdv_markerresolution.htm | 2 +- .../guide/wrkAdv_markers.htm | 2 +- .../guide/wrkAdv_singleclick.htm | 8 ++++---- .../guide/wrkAdv_undo.htm | 14 +++++++------- .../guide/wrkAdv_workingsets.htm | 4 ++-- 90 files changed, 205 insertions(+), 221 deletions(-) diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm index 5890646f388..efd7bf825ea 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm @@ -10,9 +10,9 @@ -

        User assistance support

        +

        User Assistance Support

        -

        What is user assistance?

        +

        What Is User Assistance?

        User assistance is a set of components that together introduce the user diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm index 6f988399132..461acea246f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm @@ -10,9 +10,9 @@ -

        Cheat sheets

        +

        Cheat Sheets

        -

        Guiding the user through tasks

        +

        guiding the User Through Tasks

        Even when the platform UI filters out unneeded functionality, there is still a steep learning @@ -30,7 +30,7 @@

        Guiding the user through tasks

        Each task is represented by a simple cheat sheet. -

        Related links

        +

        Related Links

        Working with cheat sheets
        Working with composite cheat sheets
        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm index d8e0ddfde64..617e98eba35 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm @@ -23,7 +23,7 @@

        - Composite cheat sheets + Composite Cheat Sheets

        org.eclipse.ui.cheatsheets.cheatSheetContent extension point.

        - Content file format + Content File Format

        The composite cheat sheet content itself is defined in a separate file @@ -77,7 +77,7 @@

        - Cheat sheet task parameters + Cheat Sheet Task Parameters

        If a task has kind = "cheatsheet" a cheat sheet will be opened when that @@ -130,7 +130,7 @@

        - Example of a composite cheat sheet + Example of a Composite Cheat Sheet

        @@ -217,7 +217,7 @@

        - Related links + Related Links

        -

        Composite cheat sheet content file XML format

        +

        Composite Cheat Sheet Content File XML Format

        Identifier:
        org.eclipse.ui.cheatsheets.composite_schema
        Since:
        3.2 diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm index 2763f754d3e..68d9177a429 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm @@ -10,15 +10,14 @@ -

        Cheat sheet authoring guidelines

        +

        Cheat Sheet Authoring Guidelines

        Cheat sheets and composite cheat sheets enable a user to achieve a goal by completing a sequence of steps. These guidelines discuss when to use cheat sheets and how to best write a cheat sheet.

        -

        -When to create cheat sheets

        +

        When to Create Cheat Sheets

        Cheat sheets are well suited to tasks which consist of  steps which lead @@ -29,8 +28,7 @@

        usually contain up to 10 steps and can be completed in a half an hour or less. For larger tasks consider using a composite cheat sheet.

        -

        -When to create composite cheat sheets

        +

        When to Create Composite Cheat Sheets

        Composite cheat sheets are used to for @@ -38,15 +36,14 @@

        cheat sheet or which has multiple goals. A composite cheat sheet can be used to describe a sequence of tasks each of which builds on its predecessor.

        -

        -When not to use cheat sheets

        +

        When Not to Use Cheat Sheets

        Cheat sheets work best when problem can be solved by a sequence of simple steps. Cheat sheets are not a substitute for the help system which allows for creation of HTML pages with rich graphics and random access of information using search and hyperlinks. Cheat sheets are not intended for tasks which require a large amount of text to be input by the user.

        -

        Guidelines for creating a cheat sheet

        +

        Guidelines for Creating a Cheat Sheet

        • Choose a short and meaningful title.
        • Utilize links to the help system in cheat sheet tasks whenever possible to @@ -83,7 +80,7 @@

          Guidelines for creating a cheat sheet

        • Test cheat sheets with the error log view open so you can see if any warnings are written to the log.
        -

        Guidelines for creating a composite cheat sheet

        +

        Guidelines for Creating a Composite Cheat Sheet

        • A composite cheat sheet should contain tasks that are related by a common theme.
          • @@ -101,7 +98,7 @@

          Guidelines for creating a composite cheat sheet

          which tasks can be started.
        -

        Related links

        +

        Related Links

        Working with cheat sheets
        Working with composite cheat sheets
        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm index ffc402dbb01..6714e0db82f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm @@ -10,7 +10,7 @@ -

        Simple cheat sheets

        +

        Simple Cheat Sheets

        Cheat sheets guide the user through a series of complex tasks to achieve @@ -29,7 +29,7 @@

        Simple cheat sheets

        translated into other languages.

        -Contributing a cheat sheet

        +Contributing a Cheat Sheet

        Contributing a cheat sheet is pretty straightforward. Let's look at a cheat sheet contributed by the JDT for building a simple Java application.

        @@ -54,7 +54,7 @@

        appear in the Other category.

        Cheat sheet dialog

        -

        Cheat sheet items

        +

        Cheat Sheet Items

        The real work for cheat sheets is done in the content file. The content file is an XML file whose name and location are specified in the contentFile attribute. The path for the file is relative to the plug-in's directory. (Note @@ -144,7 +144,7 @@

        Subitems

        be visited in any particular order. Subitems may also define actions that automatically perform the subtask for the user. Subitem actions are described in the same way as item actions.

        -

        Conditional expressions and cheat sheet variables

        +

        Conditional Expressions and Cheat Sheet Variables

        Conditional expressions can be used to define cheat sheet elements whose content or behavior depends upon a particular condition being true. Conditions are described in the condition element of a subitem @@ -184,7 +184,7 @@

        Conditional expressions and cheat sheet variables

        The action to be performed is chosen based on the value of the v1 variable. If the variable value is neither a or b, it is considered an error. -

        Repeated subitems

        +

        Repeated Subitems

        Repeated subitems describe a subitem that can can expand into 0, 1, or more similar substeps. The substeps are individualized using the special variable ${this}. This variable will be replaced by the values specified in the values attribute. The values attribute is a string of values that are separated @@ -202,8 +202,7 @@

        Repeated subitems

        action paramater value. It can also be accessed from the ICheatSheetManager while the action is executing. -

        -Cheat sheet listeners

        +

        Cheat Sheet Listeners

        In some cases, you may want to change other parts of your UI if a cheat sheet is active. For example, you may have an editor that shows special annotations if a cheat sheet is guiding the @@ -215,8 +214,7 @@

        ICheatSheetEvent when there is a change in the cheat sheet's life cycle, such as when it opens, closes, or completes.

        -

        -Contributing attributes to an existing cheat sheet

        +

        Contributing Attributes to an Existing Cheat Sheet

        The org.eclipse.ui.cheatsheets.cheatSheetItemExtension extension can be used to contribute arbitrary attributes to a pre-existing cheat sheet. @@ -228,7 +226,7 @@

        See the extension point documentation for more detail.

        -

        Related links

        +

        Related Links

        Working with cheat sheets
        Creating composite cheat sheets
        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm index 5c1c1a416a0..d18239f187b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm @@ -16,9 +16,9 @@ -

        Dynamic content

        +

        Dynamic Content

        -

        What is dynamic content?

        +

        What Is Dynamic Content?

        Several user assistance components allow you to provide dynamic content. This @@ -98,7 +98,7 @@

        XML Annotations

        -

        Content producers

        +

        Content Producers

        A content producer is a mechanism for plugging-in Java code to produce the document diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm index 483f33624a7..4b5b642a715 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_extensions.htm @@ -22,18 +22,14 @@ -

        - Content extensions -

        +

        Content Extensions

        A content extension is either a contribution of content into a known anchor (similar to an extension into an extension point), or the replacement of an existing element in a document.

        -

        - Contributing into anchors -

        +

        Contributing Into Anchors

        Anchor elements (e.g. <anchor id="my_anchor"/>) can be specified in any user assistance XML document, and represent places at @@ -108,9 +104,7 @@

        it was explicitly added into the original document.

        -

        - Replacing content -

        +

        Replacing Content

        Any XML element in a user assistance document that has an id attribute that is unique to that document can be replaced with any other @@ -151,9 +145,7 @@

        org.eclipse.ui.intro.configExtension extension point)

        -

        - Path format -

        +

        Path Format

        The format of the path attribute is /pluginId/path/file.xml#elementId, except welcome where it diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm index 4e8b194cec7..0f1d6e27de3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_filters.htm @@ -37,7 +37,7 @@

        Filters

        core expressions, which is the same syntax used to filter menu contributions, etc from the UI.

        -

        System tests

        +

        System Tests

        Expressions check criteria by performing tests. One type of test is a system test, which tests @@ -128,7 +128,7 @@

        System tests

        expressions syntax specification for more details.

        -

        Property tests

        +

        Property Tests

        In addition to system tests, you can test any property of an available object as long as @@ -277,7 +277,7 @@

        Property tests

        expressions syntax specification for more details on how to write expressions.

        -

        Defining your own test

        +

        Defining Your Own Test

        The core expressions framework allows you define your own test that can test on any arbitrary property of any object that is accessible through the variables defined for @@ -308,7 +308,7 @@

        </enablement> </topic> -

        Filter attributes/elements (deprecated)

        +

        Filter Attributes/Elements (deprecated)

        Prior to the 3.3, filters were specified using filter attributes or elements. @@ -502,7 +502,7 @@

        Information Center

        see help system customization.

        -

        Where can I use filters?

        +

        Where Can I Use Filters?

        Filtering can be used in any XML-based user assistance document, such as help XHTML topics, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm index 90af295808f..1682b3dca7e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic_includes.htm @@ -67,7 +67,7 @@

        - Where can I use includes? + Where Can I Use Includes?

        See below for a list of the document types in which includes can be used. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm index cdac5ee4f82..024bdc80ec9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm @@ -18,7 +18,7 @@

        - Using AbstractHelpScope to filter an information center + Using AbstractHelpScope to Filter an Information Center

        An information center can be used to serve information for more than one diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm index 5a7f7134e97..07e5b7436d6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm @@ -10,7 +10,7 @@ -

        Help content

        +

        Help Content

        Building a help plug-in

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm index 0fafd1bf58d..99f6ac83bdd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm @@ -10,7 +10,7 @@ -

        Active help

        +

        Active Help

        Active help is the ability to invoke Eclipse code from on-line documentation. It is implemented by including some JavaScript in your diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm index 9c711e3cdbb..cd02f8c9cf3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm @@ -10,7 +10,7 @@ -

        Writing the help action

        +

        Writing the Help Action

        The interface ILiveHelpAction is used to build an active help action.

        diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm index bd18f63b78d..53abc086c8d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm @@ -10,7 +10,7 @@ -

        Tips for debugging active help

        +

        Tips for Debugging Active Help

        The code and markup that triggered our active help link looks pretty @@ -18,7 +18,7 @@

        Tips for debugging active help

        to work?

        -

        Test your action ahead of time

        +

        Test Your Action Ahead of Time

        If your action implementation is fairly involved, you should invoke the @@ -26,7 +26,7 @@

        Test your action ahead of time

        that the action is error-free before invoking it from the JavaScript. 

        -

        Ensure the JavaScript is running

        +

        Ensure the JavaScript Is Running

        You can modify "liveHelp.js" (make a copy of this from the plugins/org.eclipse.help @@ -47,7 +47,7 @@

        Ensure the JavaScript is running

        then you have a problem in the HTML markup.

        -

        Debug the active help action

        +

        Debug the Active Help Action

        Once you know that the JavaScript is running, you can debug your action from @@ -67,7 +67,7 @@

        Debug the active help action

        the action as you would any other Java code.

        -

        Make sure your UI code is wrapped in Display.syncExec

        +

        Make Sure Your UI Code Is Wrapped in Display.syncExec

        A common runtime problem is improperly accessing UI code from the thread that diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm index 3180f87d3e1..f13d362c472 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm @@ -10,7 +10,7 @@ -

        Invoking the action from HTML

        +

        Invoking the Action From HTML

        To include active help links in your documentation, you must first declare the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm index 0740fa292a8..86a64a91047 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm @@ -10,7 +10,7 @@ -

        Embedding commands in help

        +

        Embedding Commands in Help

        It is possible to create links to workbench commands in help content. When the user clicks the link, the command will be executed. This feature is similar diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm index 8c253e879e9..8729de8f76d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm @@ -10,7 +10,7 @@ -

        Authoring a command link

        +

        Authoring a Command Link

        To include command links in your documentation, you must first declare the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm index 33760e32b1d..33db60218f3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_criteria.htm @@ -9,20 +9,20 @@ -

        Adding criteria to help content

        +

        Adding Criteria to Help Content

        This page will explain how to activate criteria. To enable criteria you need define which criteria are associated with each topic and also set preferences which tell the help system to show criteria. The association between criteria and topics can be either in a toc file or using a criteria provider class.

        -

        What are criteria?

        +

        What Are Criteria?

        Some topics of the plug-in might only be of interest to certain users, for example a topic may be specific to the linux platform. The document writer can define a criterion "platform" with values such as "linux", "windows" etc applied to different topics. The user can then filter the documentation to show only documents applicable to a specific platform.

        -

        How to define criteria in a table of contents file

        +

        How to Define Criteria in a Table of Contents File

        When defining a table of contents file criteria information can be appended according to these steps:

          @@ -53,7 +53,7 @@

          How to define criteria in a table of contents file

          <criteria name="Platform" value="AIX,Linux"/>. The name attribute takes a single value.
        -

        How to define criteria using a criteria provider

        +

        How to Define Criteria Using a Criteria Provider

        As an alternative to defining criteria in a table of contents file the extension point org.eclipse.criteriaProvider can be used to define a class which will associate criteria with topics. @@ -62,7 +62,7 @@

        How to define criteria using a criteria provider

        -

        Criteria localization

        +

        Criteria Localization

        The names and values of criteria can be localized. Follow these steps to add localization information for criteria:

          @@ -94,7 +94,7 @@

          Criteria localization

        -

        How to set the preferences to enable criteria

        +

        How to Set the Preferences to Enable Criteria

        Define the necessary preferences in your plugin customization file.

        • enableCriteria. This preference must be true to enable filtering by criteria. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm index 803412fa844..4242b890a5e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_files.htm @@ -10,7 +10,7 @@ -

          Help server and file locations

          +

          Help Server and File Locations

          The platform utilizes its own documentation server to provide the actual web pages @@ -69,7 +69,7 @@

          Help server and file locations

             <topic label="Ref1" href="http://www.example.com/myReference.html"/>
          -

          National language and translated documentation

          +

          National Language and Translated Documentation

          The platform help system uses the same national language directory lookup @@ -86,7 +86,7 @@

          National language and translated documentation

          resource, like images which differ between system, should be placed under ws or os directories for specific platform.

          -

          Cross plug-in referencing

          +

          Cross Plug-in Referencing

          The href argument can also refer to content from another plug-in.  This is done by using a special cross plug-in referencing diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm index b25b927df1c..b5db5c00e76 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_manifest.htm @@ -10,7 +10,7 @@ -

          Completing the plug-in manifest

          +

          Completing the Plug-in Manifest

          We started this example by creating our plug-in and document files. Next we created diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_nested.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_nested.htm index 20347216bd6..0c2528014a8 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_nested.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_nested.htm @@ -10,7 +10,7 @@ -

          Building nested documentation structures

          +

          Building Nested Documentation Structures

          As plug-ins contribute functionality to the platform, it's common to add documentation that describes the new function.  How can this documentation @@ -19,7 +19,7 @@

          Building nested documentation structures

          provides mechanisms for building documentation in both a top-down and bottom-up fashion.

          -

          Top-down nesting

          +

          Top-down Nesting

          Top-down nesting refers to the technique of defining a master table of contents which refers to all other included tocs.  Top-down nesting is a @@ -44,7 +44,7 @@

          Top-down nesting

          individual tocs are free to evolve.  They in turn might link to other sub-tocs.

          -

          Bottom-up composition

          +

          Bottom-up Composition

          Bottom-up composition is more flexible in that it lets new plug-ins decide where the documentation should exist in the toc structure.  Bottom-up diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_toc.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_toc.htm index 453e0e974a8..da3f938ddda 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_toc.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_toc.htm @@ -10,7 +10,7 @@ -

          Table of contents (toc) files

          +

          Table of Contents (toc) Files

          Now that we have our sample content files we can create a table of contents (toc) diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_xhtml.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_xhtml.htm index 75c72b08d36..10710c2976d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_xhtml.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_xhtml.htm @@ -10,7 +10,7 @@ -

          Contributing XHTML help documents

          +

          Contributing XHTML Help Documents

          Why use XHTML?

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm index a50da1582ee..11fc37d2e8f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context.htm @@ -10,7 +10,7 @@ -

          Context-sensitive help

          +

          Context-sensitive Help

          A focused set of help topics that is related to the current context can be shown to users on demand using context-sensitive help. This form of user diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_dynamic.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_dynamic.htm index 0029e41a640..5d9bf85f701 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_dynamic.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_dynamic.htm @@ -10,7 +10,7 @@ -

          Dynamic context help

          +

          Dynamic Context Help

          In addition to statically associating widgets and context Ids, it is possible to diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_id.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_id.htm index bde9fecd79a..87f27cb9f1a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_id.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_id.htm @@ -10,7 +10,7 @@ -

          Declaring a context id

          +

          Declaring a Context Id

          The setHelp method in diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm index 96ec442991d..db7eb64fd23 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_context_xml.htm @@ -10,7 +10,7 @@ -

          Describing and packaging context-sensitive help content

          +

          Describing and Packaging Context-sensitive Help Content

          Context-sensitive help is described by associating the context id declared in @@ -71,7 +71,7 @@

          Describing and packaging context-sensitive help content

          name of the plug-in in which the org.eclipse.help.contexts extension is declared.

          -Context-sensitive help from multiple plug-ins

          +Context-sensitive Help From Multiple Plug-ins

          Another level of flexibility is the ability to contribute context-sensitive @@ -90,7 +90,7 @@

          context (the UI plug-in) is shown first.  Additional descriptions and links are appended in no guaranteed order.

          -

          Dynamic content

          +

          Dynamic Content

          Dynamic content is available for the context help in the form of @@ -100,7 +100,7 @@

          Dynamic content

          -Adding Context Help to your Java Code

          +Adding Context Help to Your Java Code

          See declaring a context Id for more diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_infocenter_preferences.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_infocenter_preferences.htm index d11c6a01061..10aaa10fb6e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_infocenter_preferences.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_infocenter_preferences.htm @@ -10,7 +10,7 @@ -

          Information center customization

          +

          Information Center Customization

          All of the customizations which can apply to the Eclipse help system can also be applied to an Eclipse information center including product specific branding, style sheets, banner and ordering of books. The easiest way to do this is to @@ -23,7 +23,7 @@

          Information center customization

          defines them.

          -

          Creating a product plug-in

          +

          Creating a Product Plug-in

          A product plugin can be created using the menu item File/New/Project and selecting Plug-in Project. Uncheck the check box titled "Create Java Project", give the project a name, hit "next" and "finish" to exit the wizard. In the extensions tab of the plug-in manifest editor add the extension @@ -48,7 +48,7 @@

          Creating a product plug-in

          -

          Installing the product plug-in

          +

          Installing the Product Plug-in

          Export the product plug-in as a deployable plug-in. Copy the jar file for the exported plug-in to the "dropins" folder in the eclipse installation which will be used to start the information center. @@ -56,7 +56,7 @@

          Installing the product plug-in

          product plugin is called help.product and its product id is "custom" add the argument "-product help.product.custom". Open the information center, the title will now show the customized product name.

          -

          Additional customization

          +

          Additional Customization

          Modify plugin_customization.ini in the product plugin to add more customizations, see Help system customization, re-export and replace the plug-in in the dropins folder. To modify the banner diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search.htm index 484aac13925..6bbc1bba7db 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search.htm @@ -10,7 +10,7 @@ -

          Help search

          +

          Help Search

          Since Eclipse 3.1, search in the workbench has been partitioned into two major categories: development artifact search and information search. The former diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search_types.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search_types.htm index 0c3c92fb51e..9e059e94557 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search_types.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_search_types.htm @@ -10,7 +10,7 @@ -

          Plugging in search engines

          +

          Plugging in Search Engines

          The new federated information search in Help system uses the notion of search diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup.htm index be6ef6292de..aea9b3d5452 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup.htm @@ -17,7 +17,7 @@

          Configuration/setup

          the help system to work in different environments and products.

          -

          Help modes

          +

          Help Modes

          The help system can run in three modes: workbench (normal), @@ -31,7 +31,7 @@

          Help modes

          over the Web. Consult the links above for details.

          -

          Rich Client Platform (RCP) support

          +

          Rich Client Platform (RCP) Support

          The Help system is an optional Rich Client Platform (RCP) component. That @@ -39,7 +39,7 @@

          Rich Client Platform (RCP) support

          added to it to provide help in your RCP application.

          -

          Product customization

          +

          Product Customization

          Help provides preferences that products diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_about.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_about.htm index aac13018475..52614151c74 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_about.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_about.htm @@ -8,7 +8,7 @@ -

          Using about.html to debug information centers

          +

          Using about.html to Debug Information Centers

          When developing an information center sometimes not all of the books show as expected or diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm index 4875a234b91..1dad94e3f3f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_infocenter.htm @@ -122,7 +122,7 @@

          Installation/packaging

          • -

          How to start or stop information center from command line

          +

          How to Start or Stop Information Center From Command Line

          The org.eclipse.help.standalone.Infocenter class has a @@ -144,7 +144,7 @@

          How to start or stop information center from command line

          java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse
          -

          Using the information center

          +

          Using the Information Center

          Start the information center using the instructions above. Point a web browser to the @@ -154,7 +154,7 @@

          Using the information center

          http://localhost:8081/help/index.jsp.

          -

          How to start and stop an information center from Java

          +

          How to Start and Stop an Information Center From Java

          When including an information center as part of another application, it may be more @@ -194,7 +194,7 @@

          How to start and stop an information center from Java

          -

          Making information center available on the web

          +

          Making Information Center Available on the Web

          Eclipse contains a complete information center and does not require any other server @@ -228,7 +228,7 @@

          Making information center available on the web

          to have browsers display documents using correct character set.

          -

          Running multiple instances of an information center

          +

          Running Multiple Instances of an Information Center

          Multiple instances of an information center can be run on a machine from one diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_nav.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_nav.htm index f2e484d3f3e..b82f7393fe4 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_nav.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_nav.htm @@ -6,7 +6,7 @@ -

          Generated navigation topics

          +

          Generated Navigation Topics

          If a topic in the table of contents does not specify an href attribute, or a toc diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm index 6c1d4a4ef4f..d9f0cf3364c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preferences.htm @@ -19,7 +19,7 @@ -

          Help system customization

          +

          Help System Customization

          The Eclipse help system can be configured and branded to suit your product by @@ -31,7 +31,7 @@

          Help system customization

          defines them.

          -

          org.eclipse.help plug-in:

          +

          org.eclipse.help Plug-in:

          @@ -92,7 +92,7 @@

          org.eclipse.help plug-in:

          -

          org.eclipse.help.base plug-in:

          +

          org.eclipse.help.base Plug-in:

          @@ -487,7 +487,7 @@

          org.eclipse.help.base plug-in:

          -

          org.eclipse.help.appserver plug-in:

          +

          org.eclipse.help.appserver Plug-in:

          Deprecated: This plug-in is no longer used by help. See table for alternative usage. @@ -521,7 +521,7 @@

          org.eclipse.help.appserver plug-in:

          -

          org.eclipse.tomcat plug-in:

          +

          org.eclipse.tomcat Plug-in:

          Deprecated: This plug-in is no longer used by help. No alternative commands available. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm index bb2e0f5f4fb..e9db2cf64ee 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_preindex.htm @@ -10,7 +10,7 @@ -

          Pre-indexing documentation

          +

          Pre-indexing Documentation

          When user searches help contents of a product, the search is performed within a documentation index.  By default, this index  is created @@ -23,7 +23,7 @@

          Pre-indexing documentation

          on the user machine and lets the user obtain first search results faster.

          -

          Building a documentation index for a plug-in.

          +

          Building a Documentation Index for a Plug-in.

          To build an index follow the steps:

            @@ -56,7 +56,7 @@

            Building a documentation index for a plug-in.

          -

          Building an index for a product

          +

          Building an Index for a Product

          Per-product index is a one aggregate index of all documentation in the product. It should be used in scenarios in which the set of documentation plug-ins is @@ -86,7 +86,7 @@

          Building an index for a product

          when they run the product in the en locale.

          -

          Packaging and Installation of the product's pre-built index

          +

          Packaging and Installation of the Product's Pre-built Index

          Pre-built indices, the doc_index.zip files, need to be packaged as a plug-in.   You can choose to use a plug-in associated with the primary diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm index 2784d40720f..e706bc9e6d5 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_rcp.htm @@ -10,7 +10,7 @@ -

          Rich Client Platform (RCP) help

          +

          Rich Client Platform (RCP) Help

          The Help system is an optional Rich Client Platform (RCP) component. That diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm index 659b8c4e11e..7edc0f42cff 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_setup_standalone.htm @@ -10,7 +10,7 @@ -

          Standalone help

          +

          Standalone Help

          If you are creating an application that is not based on the Eclipse framework, you can still use the Eclipse help system. Your @@ -65,7 +65,7 @@

          Installation/packaging

          (which includes the help system). -

          How to call the help classes from Java

          +

          How to Call the Help Classes From Java

          1. Make sure d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar @@ -104,7 +104,7 @@

            How to call the help classes from Java

            helpSystem.shutdown();
          -

          How to call the help from the command line

          +

          How to Call the Help From the Command Line

          The org.eclipse.help.standalone.Help class has a main method you can @@ -122,7 +122,7 @@

          How to call the help from the command line

          The calls above to display help will cause help system to start, display help, and keep running to allow a user to continue browsing help after the command is executed. To control the life cycle of the help system, use start and shutdown commands, in addition to the displayHelp command. For example, you may call

          java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start
          -

          [Optional] Installing a minimal stand-alone help system

          +

          [Optional] Installing a Minimal Stand-alone Help System

          The stand-alone help does not require the entire eclipse Platform package. It is diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm index e827b073d82..64f0a024d77 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_war.htm @@ -10,7 +10,7 @@ -

          Deploying the information center as a Web Archive

          +

          Deploying the Information Center as a Web Archive

          Using Eclipse 3.4 or later it is possible to configure the help plugins to be deployed as a web archive (war file) which will act as a fully functioning information center. @@ -46,7 +46,7 @@

          Deploying the information center as a Web Archive

          Troubleshooting

          -

          HTTP 404 with Message "BridgeServlet: /help/"

          +

          HTTP 404 With Message "BridgeServlet: /help/"

          In the web.xml activate the init parameter enableFrameworkControls. This enables endpoints to control the embedded OSGi container. Call http://localhost:8080/help/sp_test. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_cust_static.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_cust_static.htm index 064ae308364..38d98adce7f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_cust_static.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_cust_static.htm @@ -10,7 +10,7 @@ -

          Displaying static HTML content in a CustomizableIntroPart

          +

          Displaying Static HTML Content in a CustomizableIntroPart

          Just like any intro part implementation, to use a CustomizableIntroPart you need to follow the basic steps to bind it to a product. However, there is an extra step needed to use this intro part and it is binding a "configuration" with it. Just like you bind an intro to a product, you must bind an introConfig to a customizableIntroPart. Here is a sample configuration:

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_define_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_define_content.htm index 3aff58eda0b..0d606170153 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_define_content.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_define_content.htm @@ -10,7 +10,7 @@ -

          Defining intro content

          +

          Defining Intro Content

          Now we can look at the content itself. Content is described in terms of pages. All pages have an id attribute. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining.htm index b91a6755b4b..f6e53e33ec4 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining.htm @@ -10,7 +10,7 @@ -

          Defining an intro part

          +

          Defining an Intro Part

          The IIntroPart interface diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining_config.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining_config.htm index 33d08334c63..ea7ed819a73 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining_config.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_defining_config.htm @@ -10,7 +10,7 @@ -

          Defining an intro config

          +

          Defining an Intro Config

          org.eclipse.ui.intro.config diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_custom_url.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_custom_url.htm index 758cdf96db3..226b9ba1172 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_custom_url.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_custom_url.htm @@ -10,7 +10,7 @@ -

          Defining a custom IntroURL action

          +

          Defining a Custom IntroURL Action

          Using the org.eclipse.ui.intro.configExtension diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_standbypart.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_standbypart.htm index 340f8e12e67..431debe1043 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_standbypart.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_standbypart.htm @@ -10,7 +10,7 @@ -

          Contributing a standby content part

          +

          Contributing a Standby Content Part

          Plug-ins can also implement a part for displaying alternative content when the intro page is in standby mode. For diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_theme.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_theme.htm index 758bb3c331b..95189fc16d3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_theme.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_ext_theme.htm @@ -10,7 +10,7 @@ -

          Defining intro themes

          +

          Defining Intro Themes

          A theme defines the overall appearance of the intro. It is simply a way @@ -75,7 +75,7 @@

          Definition

          org.eclipse.ui.intro/INTRO_THEME in plugin_customization.ini.

          -

          Enabling themes

          +

          Enabling Themes

          Theme support by itself does not make intro implementations theme-enabled. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending.htm index b30b654a720..fdcdcd4ea8b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending.htm @@ -10,7 +10,7 @@ -

          Extending an intro config

          +

          Extending an Intro Config

          An intro configuration can be extended in several ways: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending_content.htm index be31119b815..204da07a85f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending_content.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_extending_content.htm @@ -10,7 +10,7 @@ -

          Extending the content of an intro config

          +

          Extending the Content of an Intro Config

          Plug-ins can contribute intro content to a page defined elsewhere. However, the defining page must define an diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_hello_world.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_hello_world.htm index 04381c20bf0..1d840984971 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_hello_world.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_hello_world.htm @@ -10,7 +10,7 @@ -

          Contributing a HelloWorld intro Part

          +

          Contributing a HelloWorld Intro Part

          We will now contribute a very basic intro part just to illustrate the steps needed to contribute a part implementation to the Workbench and get it to show up as the welcome page. To do this:

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_minimal.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_minimal.htm index 44b708109d4..f062b3466a6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_minimal.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_minimal.htm @@ -10,7 +10,7 @@ -

          Defining a minimal intro configuration

          +

          Defining a Minimal Intro Configuration

          The first stage in creating a new intro configuration is to add the necessary @@ -19,7 +19,7 @@

          Defining a minimal intro configuration

          and have it show up in a product.

          -Create a plugin project and add extension points

          +Create a Plugin Project and Add Extension Points

          Create an new plugin project "org.eclipse.intro.minimal" which has a dependency @@ -53,7 +53,7 @@

          </plugin>

          -Create the intro config file

          +Create the Intro Config File

          Create a file introcontent.xml in the plugin project org.eclipse.intro.minimal @@ -78,7 +78,7 @@

          <text>This page under construction</text> </page> </introContent> -

          Define a product binding

          +

          Define a Product Binding

          In this step we need to determine the product which is being used and create an intro product binding and modify its plugin.xml file. If you are using the Eclipse SDK this will be in the plugin project org.eclipse.sdk  which can diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal.htm index 4ef06225c50..f6ebd0fdb9e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal.htm @@ -10,9 +10,9 @@ -

          Universal intro

          +

          Universal Intro

          -

          What is the universal intro?

          +

          What Is the Universal Intro?

          The universal intro is complete, ready out-of-the-box implementation of intro with a @@ -74,7 +74,7 @@

          Motivation

          -

          Enter universal intro

          +

          Enter Universal Intro

          The universal intro is based on experience with intro implementations and the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_contributing.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_contributing.htm index 0fc7326bddc..442e415a161 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_contributing.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_contributing.htm @@ -10,7 +10,7 @@ -

          Contributing to universal intro

          +

          Contributing to Universal Intro

          In order to hook into to the universal intro, developers should have a diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_defaults.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_defaults.htm index 7885149ce09..36161b10139 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_defaults.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_defaults.htm @@ -10,7 +10,7 @@ -

          Configuring product defaults

          +

          Configuring Product Defaults

          In addition to providing intro customization to the end users for the first diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_extending.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_extending.htm index e76fc7043a0..2d426d20199 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_extending.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_extending.htm @@ -10,7 +10,7 @@ -

          Extending the universal intro

          +

          Extending the Universal Intro

          When launching the universal Welcome configured as shown above, you will notice @@ -123,7 +123,7 @@

          Extending the universal intro

          them as children of the 'hidden' element.

          -

          Contributing into extensions

          +

          Contributing Into Extensions

          An extension contributed into one of the root pages can itself contain diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_links.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_links.htm index bdccf4456d6..5f1d8cfad39 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_links.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_links.htm @@ -10,7 +10,7 @@ -

          Managing links

          +

          Managing Links

          Most of the extensions coming into the main Welcome pages offer links to open diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_preference.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_preference.htm index e08873e0d87..d07539271f8 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_preference.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_universal_preference.htm @@ -10,7 +10,7 @@ -

          Adding the preference page

          +

          Adding the Preference Page

          The combination of product properties and default preference values can fully diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_xhtml.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_xhtml.htm index 192d8595f02..d8e9c48ceb9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_xhtml.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_xhtml.htm @@ -9,7 +9,7 @@ -

          Using XHTML as intro content

          +

          Using XHTML as Intro Content

          Depending on the usage scenario of the intro framework, XHTML files can be contributed as intro content. The idea is to use the fact that XHTML is well formed XML and parse each document, manipulating the DOM to allow for contributions and extensions to be merged. Three xml elements from the 3.0 intro markup where used to extend the XHTML 1.0 element list. These are include, anchor, and contentProvider:

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling.htm index bbb2cb7da93..3f73bbaee85 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling.htm @@ -10,7 +10,7 @@ -

          Status handling

          +

          Status Handling

          Status handling is a facility that diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_defining.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_defining.htm index 93d2d3fe0ea..9d4cb1016c1 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_defining.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_defining.htm @@ -10,7 +10,7 @@ -

          Defining a product status handler

          +

          Defining a Product Status Handler

          The AbstractStatusHandler diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_sample.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_sample.htm index 9533b09c9e5..04fb9b9c132 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_sample.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_statushandling_sample.htm @@ -10,7 +10,7 @@ -

          Contributing a sample handler

          +

          Contributing a Sample Handler

          We will now contribute a very basic status handler just to illustrate the steps diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench.htm index 2d2fdd764a5..b5f5a06b51e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench.htm @@ -24,7 +24,7 @@

          perspective.  We will show how a plug-in can contribute to the workbench UI.

          -Quick tour of the workbench

          +Quick Tour of the Workbench

          The workbench is the cockpit for navigating all of the functionality provided by plug-ins. By using the workbench, we can navigate resources and we can view and edit diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_activities.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_activities.htm index 4c0107af23f..4327f22243c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_activities.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_activities.htm @@ -38,7 +38,7 @@

          Activities

          An activity is a logical grouping of functionality tha -

          Conventional activities

          Conventional activities are exposed to the +

          Conventional Activities

          Conventional activities are exposed to the user under the name capabilities, although not in a way that is apparent to a new user. When an activity is enabled in the platform, the UI contributions associated with that activity are shown. When a activity is @@ -62,7 +62,7 @@

          Conventional activities

          Conventional activities are exposed to the activities can also still be used programmatically using the Eclipse API.

          -

          Expression-based activities

          +

          Expression-based Activities

          Expression-based activities differ from conventional activities in that: @@ -78,7 +78,7 @@

          Expression-based activities

          to, for example, the New... wizard. -

          Conventional Activities vs. perspectives

          We have seen +

          Conventional Activities vs. Perspectives

          We have seen (in Perspectives) how perspectives are used to organize different view layouts and action sets into tasks. Why do we need activities? While perspectives and activities define similar kinds of tasks, @@ -104,7 +104,7 @@

          Conventional Activities vs. perspectives

          We have seen concepts.

          -

          Defining activities

          Activities are defined using the org.eclipse.ui.activities +

          Defining Activities

          Activities are defined using the org.eclipse.ui.activities extension point.
          Let's look at first at a simplified version of how the Eclipse SDK @@ -164,7 +164,7 @@

          Defining activities

          Activities are defined using the Using the activities API +

          Using the Activities API

          The workbench activity support includes an API for working with all defined activities (to some extent also expression-based @@ -309,7 +309,7 @@

          Using the activities API

          activities, or similar requests that do not apply to expression-based activities.

          -

          Using expression-based activities

          +

          Using Expression-based Activities

          To filter a UI element using an expression-based activity, create an activity like the following:
          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_contexts.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_contexts.htm index 405e99ba37f..a033db05756 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_contexts.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_advext_contexts.htm @@ -22,7 +22,7 @@

          in time. For example, the commands available to a user while editing text might be different than those available to a user while editing Java text or browsing packages in the package explorer.

          -

          Defining a context

          +

          Defining a Context

          Contexts are declared in the org.eclipse.ui.contexts @@ -39,7 +39,7 @@

          Defining a context

          Contexts are assigned a name and description that are used when showing information about the context to the user. The id of the context is used when binding UI contributions such as commands to a particular context. -

          Context hierarchies

          +

          Context Hierarchies

          Contexts are hierarchical in nature. When a context is active, the commands available in the context and in its parent contexts are also available. This is useful for defining levels of contexts that move from very general situations down to more @@ -67,7 +67,7 @@

          Context hierarchies

          id="org.eclipse.ui.contexts.dialogAndWindow"> </context> -

          Associating a contribution with a context

          +

          Associating a Contribution With a Context

          So far, all we've done is define a hierarchy of contexts. The context becomes useful when it is referenced in the description of another UI contribution. The most common use of contexts is in key bindings. When a context is diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm index 12d78cea50d..3ef26f4f27e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_bindings.htm @@ -14,7 +14,7 @@ -

          Key bindings

          +

          Key Bindings

          The association between a command and the key combinations that should diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm index 6ce0d863338..91a3507dc4b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_commands.htm @@ -31,7 +31,7 @@

          Commands

          behaviour implemented in different plug-ins may share the same key binding.

          -

          Defining a command

          +

          Defining a Command

          Commands are defined using the org.eclipse.ui.commands diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm index 35d87b405c5..1ba24baf5ae 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_handlers.htm @@ -26,7 +26,7 @@

          Handlers

          command has an active handler, we say the command is handled.

          -

          Associating a default handler with a command

          +

          Associating a Default Handler With a Command

          While there is a shortcut for a default handler, most handlers are associated @@ -63,7 +63,7 @@

          Associating a default handler with a command

          -

          Associating a handler with a command while a part type is active

          +

          Associating a Handler With a Command While a Part Type Is Active

          The <activeWhen/> expressions in the plugin.xml and programmatic core @@ -161,7 +161,7 @@

          Associating a handler with a command while a part type is active

          against the default variable.

          -

          Associating a handler programmically with a command while a specific part is active

          +

          Associating a Handler Programmically With a Command While a Specific Part Is Active

          Sometimes it is desirable to instantiate your handlers when your part is @@ -220,7 +220,7 @@

          Associating a handler programmically with a command while a specific part is -

          Implementing the handler

          +

          Implementing the Handler

          A handler must implement org.eclipse.core.commands.IHandler diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm index fcb357abbdf..355f3e714bf 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_cmd_menus.htm @@ -27,7 +27,7 @@

          org.eclipse.ui.menus

          trim locations.

          -

          Contribution location

          +

          Contribution Location

          The org.eclipse.ui.menus extension point requires the id of a menu, toolbar, or trim area and an insertion @@ -134,7 +134,7 @@

          Contribution location

          </enabledWhen> -

          Contribution visibility

          +

          Contribution Visibility

          A command's enabled state is controlled by a combination of the command @@ -303,7 +303,7 @@

          Contribution visibility

          enabled state track the current selection.

          -

          Contributing to popup menus

          +

          Contributing to Popup Menus

          Commands can be contributed to a specific context menu by the context menu's id, or to any @@ -353,7 +353,7 @@

          Contributing to popup menus

          -

          Adding toolbars to trim areas

          +

          Adding Toolbars to Trim Areas

          A 'trim' widget is a control that gets sited into a location (called a 'Trim Area') on the outer boundary of the Workbench Window. The most common example is the generic 'status line' which almost all GUI's place along the bottom of the window. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_jobs.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_jobs.htm index 4a3d40d9897..e318212a6a7 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_jobs.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_jobs.htm @@ -14,7 +14,7 @@

          -Workbench concurrency support

          +Workbench Concurrency Support

          We've seen that the JFace UI framework provides basic support for showing task progress in a dialog (see Long @@ -123,7 +123,7 @@

          -

          Progress service

          +

          Progress Service

          The workbench progress service (IProgressService) @@ -189,7 +189,7 @@

          Progress service

          service.registerIconForFamily(newImage, ResourcesPlugin.FAMILY_MANUAL_BUILD); service.registerIconForFamily(newImage, ResourcesPlugin.FAMILY_AUTO_BUILD); -

          Showing that a part is busy

          +

          Showing That a Part is Busy

          IWorkbenchSiteProgressService @@ -239,7 +239,7 @@

          Progress Properties for Jobs

          job.setUser(true); job.schedule(); -

          Workbench jobs

          +

          Workbench Jobs

          Where possible, long running operations should be performed outside of the UI thread. However, this cannot always be diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_perspectives.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_perspectives.htm index 8d515da9b2f..e79beb362c5 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_perspectives.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_perspectives.htm @@ -41,7 +41,7 @@

          -Workbench part layout

          +Workbench Part Layout

          One of the main jobs of an IPageLayout is to describe the placement of the editor and the views in the workbench window. Note that these layouts are different than the @@ -82,8 +82,7 @@

          - -Linking views and editors with "show-in"

          +Linking views and editors with "show-in" @@ -119,8 +118,7 @@

          -

          -Show-in source

          +

          Show-in Source

          If you want to allow users to use Navigate > Show In from your editor or view to jump to another view, you must implement IShowInSource.  Your part can supply its IShowInSource @@ -147,8 +145,7 @@

          -

          -Show-in target

          +

          Show-in Target

          @@ -162,7 +159,7 @@

          first in deciding what to show, since this is the more specific information.  It should show the input element only if no selection is indicated.

          -

          Presenting appropriate targets

          +

          Presenting Appropriate Targets

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_resources.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_resources.htm index a2f1217686c..f856357175f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_resources.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_resources.htm @@ -14,7 +14,7 @@

          -Workbench resource support

          +Workbench Resource Support

          The Eclipse platform is structured so that you can develop a workbench application even if your application has nothing to do with the platform resource model. However, the workbench does provide support for diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_scalability.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_scalability.htm index 09438b922df..55b92dc6258 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_scalability.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_scalability.htm @@ -14,7 +14,7 @@

          -Filtering large user interfaces

          +Filtering Large User Interfaces

          The rich extensibility mechanisms in the workbench provide many ways for plug-ins to contribute to the platform UI. However, extensibility can introduce its own set of problems. While allowing for a rich set of features diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling.htm index bd29896efff..1f1fb276b56 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling.htm @@ -10,13 +10,13 @@ -

          Status handling

          +

          Status Handling

          Status handling is a facility that allows to introduce a custom way of showing problems in the Eclipse based applications to users. The facility can be configured at both the application and the product level. -

          Status handlers

          +

          Status Handlers

          The handlers are responsible for presenting problems by logging or showing appropriate @@ -48,7 +48,7 @@

          Status handlers

          and parameter set are set during initialization of the handler with the use of elements and attributes of the statusHandler element. -

          Logging with the use of the default logging mechanism

          +

          Logging With the Use of the Default Logging Mechanism

          In order to log extra information with the use of the default logging mechanism, @@ -75,7 +75,7 @@

          Logging with the use of the default logging mechanism

          -

          The default status handler

          +

          The Default Status Handler

          The platform supplies its own status handler implementation org.eclipse.ui.statushandlers.WorkbenchErrorHandler. @@ -83,7 +83,7 @@

          The default status handler

          and a dialog based on the JFace org.eclipse.jface.dialogs.ErrorDialog.

          -

          Registering the ErrorSupportProvider with your status handler

          +

          Registering the ErrorSupportProvider With Your Status Handler

          There is a simple way to contribute a support area in the JFace ErrorDialog. @@ -113,7 +113,7 @@

          Registering the ErrorSupportProvider with your status handler

          support area.

          -

          Status manager

          +

          Status Manager

          The status manager is the entry point for all statuses that are to be displayed in the user interface. @@ -153,7 +153,7 @@

          Status manager

          If any creation error occurs in the product handler, the workbench handler will process this error.

          -

          Acceptable styles

          +

          Acceptable Styles

          Below is a list of StatusManager styles which can be combined with logical OR:

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling_defining.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling_defining.htm index 6587abec604..3e03462e6fa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling_defining.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/workbench_statushandling_defining.htm @@ -12,7 +12,7 @@ -

          Defining a status handler

          +

          Defining a Status Handler

          There are two ways for contributing handlers to the Workbench:

            @@ -23,7 +23,7 @@

            Defining a status handler

          -

          Contributing a status handler using the custom advisor

          +

          Contributing a Status Handler Using the Custom Advisor

          First, a custom workbench advisor for your application has to be created. In this new custom advisor override getWorkbenchErrorHandler(). diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_accessibility.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_accessibility.htm index 892da8d4c96..48250f64698 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_accessibility.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_accessibility.htm @@ -14,7 +14,7 @@ -

          Accessible user interfaces

          +

          Accessible User Interfaces

          The term accessible is used to refer to software that has been designed so that people who have disabilities have a successful interaction with it.  Accessible software takes many different kinds of disabilities into account:

          @@ -29,7 +29,7 @@

          Accessible user interfaces

        • cognitive - people who have learning disabilities and may need more consistency or simplicity in their interfaces
          • -

          Assistive technology

          +

          Assistive Technology

          Assistive technology is equipment or software that is used to increase the accessibility of existing operating systems and applications.  While it is beyond the scope of this programmer's guide to cover the broad scope of @@ -38,14 +38,14 @@

          Assistive technology

          documentation, such as providing alternate text descriptions for images in your HTML, or keyboard equivalents for all of your software actions, can greatly improve the effectiveness of assistive technologies that make use of these techniques.

          -

          Accessibility resources

          +

          Accessibility Resources

          There are some basic coding tips you can use when building plug-in user interfaces that will increase the accessibility of your software.  See Tips for Making User Interfaces More Accessible for more information.

          IBM's Accessibility Center Website has many useful resources for accessibility, including guidelines and checklists for developing software and web interfaces.

          -

          SWT and accessibility

          +

          SWT and Accessibility

          Because SWT uses the operating system's native widgets, user interfaces built with SWT will inherit any assistive technologies that have been installed on the host operating system.  SWT implements an interface, AccessibleListener, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm index a1ead182dfb..1b96a363190 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_commands_handlers.htm @@ -32,7 +32,7 @@

          Commands

          actions implemented in different plug-ins may share the same key binding.

          -

          Defining a command

          +

          Defining a Command

          Commands are defined using the org.eclipse.ui.commands diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_efs_resources.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_efs_resources.htm index 019567d9d22..ae108ad25dc 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_efs_resources.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_efs_resources.htm @@ -14,7 +14,7 @@ -

          User interface support for alternative file systems

          +

          User Interface Support for Alternative File Systems

          In environments where there is more than one file system there are several places in the user interface where the user can select a file system.

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_encoding.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_encoding.htm index 323be569b3b..8f73c36d6fa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_encoding.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_encoding.htm @@ -15,7 +15,7 @@ -

          Text file encoding

          +

          Text File Encoding

          If your plug-in reads text files, it should honor the text file encoding preference in the workbench. 

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings.htm index 12d42e3bb55..b03957c387d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings.htm @@ -14,7 +14,7 @@ -

          Workbench key bindings

          +

          Workbench Key Bindings

          The workbench defines many keyboard accelerators for invoking common actions with the keyboard.  In early versions of the platform, plug-ins could define the accelerator key to be used for their action when the action was diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelConfig.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelConfig.htm index af179f7f093..d83085c0439 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelConfig.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelConfig.htm @@ -69,7 +69,7 @@

          Schemes

          active, the sequence "Ctrl+X Ctrl+S" will invoke the command.

          -

          Defining new schemes

          +

          Defining New Schemes

          When your plug-in defines a binding, it will most likely assign it to an existing @@ -99,7 +99,7 @@

          Defining new schemes

          schemes.

          -

          Activating a scheme

          +

          Activating a Scheme

          The user controls the active scheme via the preferences page.  diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelSet.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelSet.htm index d0456d34c92..07815efdbca 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelSet.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_accelSet.htm @@ -14,7 +14,7 @@ -

          Key bindings

          +

          Key Bindings

          The association between a command and the key combinations that should diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_actionDef.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_actionDef.htm index 54bb3181f0c..8eed53912a1 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_actionDef.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_actionDef.htm @@ -21,7 +21,7 @@

          Commands

          them in menus.

          -

          Associating a legacy action with a command

          +

          Associating a Legacy Action With a Command

          When still using the old legacy action extension points, actions can be associated with a diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_contexts.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_contexts.htm index db5fc62e220..c272ea2a792 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_contexts.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_keyBindings_contexts.htm @@ -14,7 +14,7 @@ -

          Contexts and key bindings

          +

          Contexts and Key Bindings

          A context can be specified for a key binding so that the binding is only available when the user is working within a specific context. Contexts are declared in the diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_marker_support.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_marker_support.htm index 99069594708..558a710e977 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_marker_support.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_marker_support.htm @@ -15,7 +15,7 @@ -

          Support for displaying markers

          +

          Support for Displaying Markers

          The org.eclipse.ui.ide.markerSupport extension point provides facilities for controlling how markers are diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerhelp.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerhelp.htm index 7181b424e7d..861c542b36a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerhelp.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerhelp.htm @@ -14,7 +14,7 @@ -

          Contributing marker help

          +

          Contributing Marker Help

          Now we are ready to look at how to add help to the readme tool's markers.  Adding marker help is done using the org.eclipse.ui.ide.markerHelp extension point.  This extension point allows plug-ins to associate a help diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerresolution.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerresolution.htm index 769712c4119..897a35708cd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerresolution.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markerresolution.htm @@ -14,7 +14,7 @@ -

          Contributing marker resolution

          +

          Contributing Marker Resolution

          Plug-ins can also define marker resolutions, so that their problem markers can participate in the workbench Quick Fix feature. Users can select a problem marker and choose a Quick Fix from a popup containing the list of supplied diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markers.htm index 07b88e0af66..0b16d87c337 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markers.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_markers.htm @@ -14,7 +14,7 @@ -

          Marker help and resolution

          +

          Marker Help and Resolution

          In Resource markers, we saw how plug-ins can define specialized marker types in order to annotate resources with information.  The readme diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_singleclick.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_singleclick.htm index 160b1ef112a..6161ce2ca21 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_singleclick.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_singleclick.htm @@ -14,7 +14,7 @@ -

          Honoring single click support

          +

          Honoring Single Click Support

          The General Preferences allow users to specify whether views should open their objects on single or double click.

          @@ -37,7 +37,7 @@

          Honoring single click support

          click.

          -

          Single click in JFace viewers

          +

          Single Click in JFace Viewers

          If you are using a JFace list-oriented @@ -52,7 +52,7 @@

          Single click in JFace viewers

          such as expanding the items in a tree on double-click.

          -

          Single click in SWT controls

          +

          Single Click in SWT Controls

          JFace provides a utility class, OpenStrategy, @@ -83,7 +83,7 @@

          Single click in SWT controls

          This means that the "right thing" will happen if you use JFace viewers or the OpenStrategy class to implement open behavior.

          -

          Activating editors on open

          +

          Activating Editors on Open

          When handling an open event, you should use OpenStrategy.activateOnOpen() to determine whether an opened editor should be activated by default.  Activating an editor switches the focus from the view to the editor, which can diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_undo.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_undo.htm index 6dd66edbafc..8cd30cec15f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_undo.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_undo.htm @@ -14,7 +14,7 @@ -

          Undoable operations

          +

          Undoable Operations

          We've looked at many different ways to contribute commands to the workbench, but we haven't focused on the implementation of a command's execute(ExecutionEvent) method. The mechanics @@ -28,7 +28,7 @@

          Undoable operations

          IUndoableOperation, the operation can be made available for undo and redo. Converting an command or action to use operations is straightforward, apart from implementing the undo and redo behavior itself.

          -

          Writing an undoable operation

          +

          Writing an Undoable Operation

          We'll start by looking at a very simple example. Recall the simple example in org.eclipse.ui.examples.contributions.editor.DeltaInfoHandler. @@ -100,7 +100,7 @@

          Writing an undoable operation

          to use operations is similar to converting an execute method. The method is responsible for creating and executing an operation that does the work previously done inline.

          -

          Operation history

          +

          Operation History

          So far we've used an operations history without really explaining it. Let's look again at the code that creates our example operation.

          @@ -142,7 +142,7 @@

          Operation history

          to set limits on the history or notify listeners about changes to a particular operation. Before we look at the protocol in detail, we need to understand the undo context. -

          Undo contexts

          +

          Undo Contexts

          When an operation is created, it is assigned an undo context that describes the user context in which the original operation was performed. The undo context typically depends on the view or editor that originated the undoable operation. For @@ -256,7 +256,7 @@

          Undo contexts

          } -

          Undo and redo action handlers (Deprecated)

          +

          Undo and Redo Action Handlers (Deprecated)

          The platform provides standard undo and redo retargetable action handlers that can be configured by views and editors to provide undo and redo support for their particular context. When the action handler is created, a context is assigned to it so that the operations history is filtered in a way appropriate for @@ -270,7 +270,7 @@

          Undo and redo action handlers (Deprecated)

          be disposed when the operation currently available for undo or redo is not valid. The setting for this parameter is related to the undo context provided and the validation strategy used by operations with that context. -

          Application undo models

          +

          Application Undo Models

          Earlier we looked at how undo contexts can be used to implement different kinds of application undo models. The ability to assign one or more contexts to operations allows applications to implement undo strategies that @@ -287,7 +287,7 @@

          Application undo models

          of its position in the history. The operation history can be configured so that the model appropriate for an application can be implemented. This is done with an interface that is used to pre-approve any undo or redo request before the operation is undone or redone.

          -

          Operation approvers

          +

          Operation Approvers

          IOperationApprover defines the protocol for approving undo and redo of a particular operation. An operation approver is installed on an operation history. Specific operation approvers may in turn check all operations for their validity, check operations of only certain contexts, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_workingsets.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_workingsets.htm index d24cb6bfcde..e491cfbf184 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_workingsets.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/wrkAdv_workingsets.htm @@ -14,7 +14,7 @@ -

          Working sets

          +

          Working Sets

          Users often find it necessary to filter views such as the navigator view in order to reduce clutter.  Plug-ins can assist in filtering using different techniques.

          @@ -52,7 +52,7 @@

          Working sets

          also provides property change notification as working sets are added, removed, or as they change.  If your view or editor needs to respond to changes in the selected working set, it can add a listener for CHANGE_WORKING_SET_CONTENT_CHANGE.

          -

          Adding new working set types

          +

          Adding New Working Set Types

          For many plug-ins, using IWorkingSetManager From 3baad98f9f8ca46c6fe85ca754f3f589bc0ac638 Mon Sep 17 00:00:00 2001 From: Matthias Becker Date: Fri, 4 Oct 2024 15:32:43 +0200 Subject: [PATCH 3/4] Write HTML-Headers in Title Case in platform.doc.isv (III) --- .../porting/4.10/faq.html | 2 +- .../porting/4.10/incompatibilities.html | 2 +- .../porting/4.10/recommended.html | 4 +- .../porting/4.11/faq.html | 2 +- .../porting/4.11/incompatibilities.html | 2 +- .../porting/4.11/recommended.html | 4 +- .../porting/4.12/faq.html | 10 +- .../porting/4.12/incompatibilities.html | 2 +- .../porting/4.12/recommended.html | 12 +- .../porting/4.13/incompatibilities.html | 2 +- .../porting/4.13/recommended.html | 2 +- .../porting/4.14/incompatibilities.html | 2 +- .../porting/4.14/recommended.html | 2 +- .../porting/4.15/faq.html | 2 +- .../porting/4.15/incompatibilities.html | 2 +- .../porting/4.15/recommended.html | 2 +- .../porting/4.16/incompatibilities.html | 2 +- .../porting/4.16/recommended.html | 5 +- .../porting/4.17/incompatibilities.html | 2 +- .../porting/4.17/recommended.html | 2 +- .../porting/4.18/incompatibilities.html | 2 +- .../porting/4.18/recommended.html | 2 +- .../porting/4.19/incompatibilities.html | 2 +- .../porting/4.19/recommended.html | 2 +- .../porting/4.20/incompatibilities.html | 4 +- .../porting/4.20/recommended.html | 6 +- .../porting/4.21/incompatibilities.html | 2 +- .../porting/4.21/recommended.html | 2 +- .../porting/4.22/incompatibilities.html | 2 +- .../porting/4.22/recommended.html | 2 +- .../porting/4.23/incompatibilities.html | 2 +- .../porting/4.23/recommended.html | 2 +- .../porting/4.24/incompatibilities.html | 4 +- .../porting/4.24/recommended.html | 2 +- .../porting/4.25/incompatibilities.html | 6 +- .../porting/4.25/recommended.html | 2 +- .../porting/4.26/incompatibilities.html | 2 +- .../porting/4.26/recommended.html | 6 +- .../porting/4.27/faq.html | 2 +- .../porting/4.27/incompatibilities.html | 2 +- .../porting/4.27/recommended.html | 4 +- .../porting/4.28/incompatibilities.html | 2 +- .../porting/4.28/recommended.html | 2 +- .../porting/4.29/incompatibilities.html | 2 +- .../porting/4.29/recommended.html | 2 +- .../porting/4.3/faq.html | 2 +- .../porting/4.3/incompatibilities.html | 8 +- .../porting/4.3/recommended.html | 4 +- .../porting/4.30/incompatibilities.html | 2 +- .../porting/4.30/recommended.html | 2 +- .../porting/4.31/incompatibilities.html | 2 +- .../porting/4.31/recommended.html | 2 +- .../porting/4.32/incompatibilities.html | 4 +- .../porting/4.32/recommended.html | 2 +- .../porting/4.33/incompatibilities.html | 4 +- .../porting/4.33/recommended.html | 2 +- .../porting/4.4/incompatibilities.html | 8 +- .../porting/4.4/recommended.html | 2 +- .../porting/4.5/incompatibilities.html | 10 +- .../porting/4.5/recommended.html | 4 +- .../porting/4.6/incompatibilities.html | 10 +- .../porting/4.6/recommended.html | 12 +- .../porting/4.7/faq.html | 2 +- .../porting/4.7/incompatibilities.html | 6 +- .../porting/4.7/recommended.html | 4 +- .../porting/4.8/faq.html | 4 +- .../porting/4.8/incompatibilities.html | 4 +- .../porting/4.8/recommended.html | 6 +- .../porting/4.9/faq.html | 6 +- .../porting/4.9/incompatibilities.html | 2 +- .../porting/4.9/recommended.html | 8 +- .../porting/removals.html | 108 +++++++++--------- .../questions/index.html | 10 +- .../reference/misc/api-usage-rules.html | 30 ++--- .../reference/misc/bidi.html | 8 +- .../reference/misc/buddy_loading.html | 2 +- .../reference/misc/eclipse-install.html | 16 +-- .../reference/misc/eclipsestarter.html | 2 +- .../reference/misc/feature_manifest.html | 2 +- .../reference/misc/index.html | 6 +- .../reference/misc/launcher.html | 10 +- .../reference/misc/launcher_ini.html | 2 +- .../reference/misc/message_bundles.html | 8 +- .../reference/misc/multi_user_installs.html | 18 +-- .../reference/misc/overview-platform.html | 2 +- .../reference/misc/p2_dropins_format.html | 4 +- .../reference/misc/plugin_manifest.html | 2 +- .../misc/project_description_file.html | 2 +- .../reference/misc/runtime-options.html | 16 +-- .../reference/misc/terminology.html | 2 +- .../reference/misc/ui_accessibility_tips.html | 2 +- .../reference/services/index.html | 78 +------------ .../samples/samples.html | 6 +- 93 files changed, 256 insertions(+), 335 deletions(-) diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/faq.html index 3dccb3c52f1..898c5cd1fa7 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/faq.html @@ -19,7 +19,7 @@

          Eclipse 4.10 Plug-in Migration FAQ

          -

          1. Equinox DS bundle removal

          +

          1. Equinox DS Bundle Removal

          Bundle org.eclipse.equinox.ds is not part of the default features and products any more. It's been usefully replaced by the org.apache.felix.scr bundle which provide support for declarative services.

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/incompatibilities.html index 61cd515996a..c4827b42f65 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/incompatibilities.html @@ -10,7 +10,7 @@ -

          Incompatibilities between Eclipse 4.9 and 4.10

          +

          Incompatibilities Between Eclipse 4.9 and 4.10

          Eclipse changed in incompatible ways between 4.9 and 4.10 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/recommended.html index d01bd15ed92..b6bff4ac749 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.10/recommended.html @@ -10,7 +10,7 @@ -

          Adopting 4.10 mechanisms and APIs

          +

          Adopting 4.10 Mechanisms and APIs

          This section describes changes that are required if you are trying to change @@ -24,7 +24,7 @@

          Adopting 4.10 mechanisms and APIs

          -

          1. Direct usage of Equinox DS bundle should be replaced

          +

          1. Direct Usage of Equinox DS Bundle Should be Replaced

          What is affected: Clients directly using or referencing Equinox DS

          Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/faq.html index 54ae186bc22..26f2d2bd493 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/faq.html @@ -19,7 +19,7 @@

          Eclipse 4.11 Plug-in Migration FAQ

          -

          1. Error Log view moved from PDE to Platform

          +

          1. Error Log View Moved from PDE to Platform

          Bundle org.eclipse.ui.views.log, which contains the Error Log view, has been moved from PDE feature org.eclipse.pde to Platform feature org.eclipse.platform.

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/incompatibilities.html index 3f161d4f0ac..bb9e1626ad5 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/incompatibilities.html @@ -10,7 +10,7 @@ -

          Incompatibilities between Eclipse 4.10 and 4.11

          +

          Incompatibilities Between Eclipse 4.10 and 4.11

          Eclipse changed in incompatible ways between 4.10 and 4.11 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/recommended.html index 8bccb57f2a8..5011043e9a4 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.11/recommended.html @@ -10,7 +10,7 @@ -

          Adopting 4.11 mechanisms and APIs

          +

          Adopting 4.11 Mechanisms and APIs

          This section describes changes that are required if you are trying to change @@ -24,7 +24,7 @@

          Adopting 4.11 mechanisms and APIs

          -

          1. PDE feature org.eclipse.pde no longer includes the Error Log view

          +

          1. PDE Feature org.eclipse.pde no Longer Includes the Error Log View

          What is affected: Clients including PDE feature org.eclipse.pde to include the Error Log view.

          Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/faq.html index 1e1ee8e8a38..cbce90fa1f9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/faq.html @@ -19,19 +19,19 @@

          Eclipse 4.12 Plug-in Migration FAQ

          -

          1. What happened to the org.eclipse.ecf.filetransfer.httpclient4 feature?

          +

          1. What Happened to the org.eclipse.ecf.filetransfer.httpclient4 Feature?

          The ECF project has contributed a new filetransfer provider implementation that takes full advantage of the modern features offered in the latest versions of the Apache HttpClient library, including improved support for proxied corporate environments. The Eclipse Platform has switched to this new provider implementation, which is supplied by the new org.eclipse.ecf.filetransfer.httpclient45 feature. This new feature has replaced the old org.eclipse.ecf.filetransfer.httpclient4 feature in the Eclipse Platform.

          -

          2. What happened to the org.eclipse.ecf.filetransfer.httpclient4.ssl feature?

          +

          2. What Happened to the org.eclipse.ecf.filetransfer.httpclient4.ssl Feature?

          With the adoption of the new filetransfer provider supplied by the org.eclipse.ecf.filetransfer.httpclient45 feature, the bundle fragment supplied by the org.eclipse.ecf.filetransfer.httpclient4.ssl feature is no longer necessary and was consequently removed from the Eclipse Platform.

          -

          3. How did the IBM ICU4j bundle change?

          +

          3. How Did the IBM ICU4j Bundle Change?

          As part of the Eclipse Platform's effort to support the latest version of Unicode, the third-party IBM ICU4j bundle changed in the following way:

          1. Bundle com.ibm.icu was bumped to version 64.2.0.
          -

          3. How did the Apache Batik bundles change?

          +

          3. How Did the Apache Batik Bundles Change?

          As part of the Eclipse Platform's effort to support the latest version of Apatche Batik, the third-party bundles changed in the following way:

          1. Bundle org.apache.batik.css was bumped to version 1.11.0.
            2. @@ -41,7 +41,7 @@

            3. How did the Apache Batik bundles change?

          2. Bundle org.apache.xmlgraphics was bumped to version 2.3.0.
          -

          4. How did the Apache Lucene bundles change?

          +

          4. How Did the Apache Lucene Bundles Change?

          As part of the Eclipse Platform's effort to support the latest version of Apatche Lucene, the third-party bundles changed in the following way:

          1. Bundle org.apache.lucene.core was bumped to version 8.0.0.
            2. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/incompatibilities.html index 3fd4f4dfa8b..c10fd914fb0 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.11 and 4.12 -

            Incompatibilities between Eclipse 4.11 and 4.12

            +

            Incompatibilities Between Eclipse 4.11 and 4.12

            Eclipse changed in incompatible ways between 4.11 and 4.12 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/recommended.html index 9a13dabfd09..907f7e2cf06 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.12/recommended.html @@ -8,7 +8,7 @@ Adopting 4.12 mechanisms and APIs -

            Adopting 4.12 mechanisms and APIs

            +

            Adopting 4.12 Mechanisms and APIs

            This section describes changes that are required if you are trying to change @@ -23,7 +23,7 @@

            Adopting 4.12 mechanisms and APIs

            -

            1. Removal of the org.eclipse.ecf.filetransfer.httpclient4 and org.eclipse.ecf.filetransfer.httpclient4.ssl features

            +

            1. Removal of the org.eclipse.ecf.filetransfer.httpclient4 and org.eclipse.ecf.filetransfer.httpclient4.ssl Features

            What is affected: Clients including either of the above mentioned features from the 4.11 target platform.

            Description: @@ -37,7 +37,7 @@

            1. Removal of the org.eclipse.ecf.filetransfer.httpclien

            Alternatively: Clients may also continue to use the old ECF features by consuming them directly from the ECF p2 repository instead of from the Eclipse Platform itself.

            -

            2. Direct usages of IBM ICU4j should be upgraded

            +

            2. Direct Usages of IBM ICU4j Should Be Upgraded

            What is affected: Clients directly using IBM ICU4j bundle versions earlier than 64.2.0.

            Description: @@ -51,7 +51,7 @@

            2. Direct usages of IBM ICU4j should be upgraded

          2. Upgrade their products and code to work with IBM ICU4j version 64.2.0
            3. -

            3. Wizards can now be nonmodal

            +

            3. Wizards Can Now Be Nonmodal

            We have introduced new API to WizardDialog to enable a wizard to be nonmodal.

            Description: When a dialog is modal it means that the underlying window can not be used. Eclipse Wizard Dialogs are modal by default. There are cases where it is desired that the dialog is not modal but that the underlying window can be reached WHILE the user is finishing the wizard. @@ -69,7 +69,7 @@

            3. Wizards can now be nonmodal

          3. public int getShellStyle()
            4. -

            4. Direct usages of Apache Batik should be upgraded

            +

            4. Direct Usages of Apache Batik Should Be Upgraded

            What is affected: Clients directly using Apache Batik bundle versions earlier than 1.11.0.

            Description: @@ -83,7 +83,7 @@

            4. Direct usages of Apache Batik should be upgraded

          4. Upgrade their products and code to work with Apache Batik version 1.11.0
            5. -

            5. Pre-built Lucene indexes should be updated

            +

            5. Pre-built Lucene Indexes Should Be Updated

            What is affected: Clients supplying pre-built Lucene help indexes.

            Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/incompatibilities.html index c23c5de4c13..32602e6df82 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.12 and 4.13 -

            Incompatibilities between Eclipse 4.12 and 4.13

            +

            Incompatibilities Between Eclipse 4.12 and 4.13

            Eclipse changed in incompatible ways between 4.12 and 4.13 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/recommended.html index c5988ce944f..f0a7736ce34 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.13/recommended.html @@ -8,7 +8,7 @@ Adopting 4.12 mechanisms and APIs -

            Adopting 4.13 mechanisms and APIs

            +

            Adopting 4.13 Mechanisms and APIs

            This section describes changes that are required if you are trying to change diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/incompatibilities.html index 97a75a67319..efab0e7a5d0 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.13 and 4.14 -

            Incompatibilities between Eclipse 4.13 and 4.14

            +

            Incompatibilities Between Eclipse 4.13 and 4.14

            Eclipse changed in incompatible ways between 4.13 and 4.14 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/recommended.html index 0ace2c12133..a14f90c7e43 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.14/recommended.html @@ -8,7 +8,7 @@ Adopting 4.14 mechanisms and APIs -

            Adopting 4.14 mechanisms and APIs

            +

            Adopting 4.14 Mechanisms and APIs

            This section describes changes that are required if you are trying to change diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/faq.html index e94d7fac448..c17ec26ae44 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/faq.html @@ -17,7 +17,7 @@

            Eclipse 4.15 Plug-in Migration FAQ

            -

            1. How can I force a Flat project layout in the Project Explorer view?

            +

            1. How Can I Force a Flat Project Layout in the project Explorer View?

            As default Project Layout in Project Explorer has been switched to hierarchical, a new preference is available for RCP providers who want to force Flat layout by default instead. The preference is org.eclipse.ui.navigator.resources/defaultToFlatLayout and can be set to true in plugin_customization.ini or programatically before Project Explorer opens for the first time, in order to force a Flat project layout. Subsequent change to this preference after first initialization of Project Explorer will have no effect.

            diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/incompatibilities.html index 5f4d3064fd8..1f8ba29666c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.14 and 4.15 -

            Incompatibilities between Eclipse 4.14 and 4.15

            +

            Incompatibilities Between Eclipse 4.14 and 4.15

            Eclipse changed in incompatible ways between 4.14 and 4.15 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/recommended.html index d4cc28c83fb..51d6cebd931 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.15/recommended.html @@ -8,7 +8,7 @@ Adopting 4.15 mechanisms and APIs -

            Adopting 4.15 mechanisms and APIs

            +

            Adopting 4.15 Mechanisms and APIs

            This section describes changes that are required if you are trying to change diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/incompatibilities.html index 64178444868..3d876ce417c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.15 and 4.16 -

            Incompatibilities between Eclipse 4.15 and 4.16

            +

            Incompatibilities Between Eclipse 4.15 and 4.16

            Eclipse changed in incompatible ways between 4.15 and 4.16 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/recommended.html index cd0ae93d412..45894d61c2f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.16/recommended.html @@ -10,7 +10,7 @@ Adopting 4.16 mechanisms and APIs -

            Adopting 4.16 mechanisms and APIs

            +

            Adopting 4.16 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.15 plug-in to adopt the 4.16 mechanisms and @@ -24,8 +24,7 @@

            Adopting 4.16 mechanisms and APIs

            - 1. Depenendency on ICU4J scheduled for - removal + 1. Depenendency on ICU4J Scheduled for Removal

            What is affected: Clients that refer to classes in diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/incompatibilities.html index 3f8641c1ed3..bc7cd32c932 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.16 and 4.17 -

            Incompatibilities between Eclipse 4.16 and 4.17

            +

            Incompatibilities Between Eclipse 4.16 and 4.17

            Eclipse changed in incompatible ways between 4.16 and 4.17 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/recommended.html index 5d80165639c..7917d060d8a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.17/recommended.html @@ -10,7 +10,7 @@ Adopting 4.17 mechanisms and APIs -

            Adopting 4.17 mechanisms and APIs

            +

            Adopting 4.17 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.16 plug-in to adopt the 4.17 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/incompatibilities.html index 3e389b4b599..bd7472d7d50 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.17 and 4.18 -

            Incompatibilities between Eclipse 4.17 and 4.18

            +

            Incompatibilities Between Eclipse 4.17 and 4.18

            Eclipse changed in incompatible ways between 4.17 and 4.18 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/recommended.html index 12a2ba06e49..95e2fc2e2e2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.18/recommended.html @@ -10,7 +10,7 @@ Adopting 4.18 mechanisms and APIs -

            Adopting 4.18 mechanisms and APIs

            +

            Adopting 4.18 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.17 plug-in to adopt the 4.18 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/incompatibilities.html index 45fc0d4551f..ae01c3afe01 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.18 and 4.19 -

            Incompatibilities between Eclipse 4.18 and 4.19

            +

            Incompatibilities Between Eclipse 4.18 and 4.19

            Eclipse changed in incompatible ways between 4.18 and 4.19 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/recommended.html index fca1a005a8d..72a6d8c4b43 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.19/recommended.html @@ -10,7 +10,7 @@ Adopting 4.19 mechanisms and APIs -

            Adopting 4.19 mechanisms and APIs

            +

            Adopting 4.19 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.18 plug-in to adopt the 4.19 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/incompatibilities.html index 70ed4d6dbb3..a70b53de6b7 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.19 and 4.20 -

            Incompatibilities between Eclipse 4.19 and 4.20

            +

            Incompatibilities Between Eclipse 4.19 and 4.20

            Eclipse changed in incompatible ways between 4.19 and 4.20 in ways that affect @@ -48,7 +48,7 @@

            1. Update to Servlet 4

            -

            2. Jetty updated to version 10.x

            +

            2. Jetty Updated to Version 10.x

            What is affected: Clients that use embedded Jetty server coming with Eclipse Platform.

            Description:

            diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html index d0133a527d8..e4dcaa43d25 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html @@ -10,7 +10,7 @@ Adopting 4.20 mechanisms and APIs -

            Adopting 4.20 mechanisms and APIs

            +

            Adopting 4.20 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.19 plug-in to adopt the 4.20 mechanisms and @@ -25,7 +25,7 @@

            Adopting 4.20 mechanisms and APIs

            - 1. Pack200 artifacts will no longer be generated starting with 4.21 release + 1. Pack200 Artifacts Will No Longer Be Generated Starting With 4.21 Release

            What is affected: Clients relying on availability of pack200 artifacts (*.pack.gz) in Eclipse Platform p2 repository. @@ -41,7 +41,7 @@

            - 2. Pack200 APIs will no longer generate/use packed artifacts starting with 4.24 release and to be removed in 4.28 release + 2. Pack200 APIs Will No Longer Generate/Use Packed Artifacts Starting With 4.24 Release and to Be Removed in 4.28 Release

            What is affected: Callers of pack200 specific APIs to experience pack200 artifacts to no longer be used/fetched/generated/mirrored or dealt with in any other way. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html index 38193126d7d..c9bbb2cfa67 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.20 and 4.21 -

            Incompatibilities between Eclipse 4.20 and 4.21

            +

            Incompatibilities Between Eclipse 4.20 and 4.21

            Eclipse changed in incompatible ways between 4.20 and 4.21 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html index 6d5947e341e..93fe2d42612 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.21/recommended.html @@ -10,7 +10,7 @@ Adopting 4.21 mechanisms and APIs -

            Adopting 4.21 mechanisms and APIs

            +

            Adopting 4.21 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.20 plug-in to adopt the 4.21 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/incompatibilities.html index 32bbd9aaefa..0564f726dc5 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.21 and 4.22 -

            Incompatibilities between Eclipse 4.21 and 4.22

            +

            Incompatibilities Between Eclipse 4.21 and 4.22

            Eclipse changed in incompatible ways between 4.21 and 4.22 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/recommended.html index 29016f3319a..c7af0ac633a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.22/recommended.html @@ -10,7 +10,7 @@ Adopting 4.22 mechanisms and APIs -

            Adopting 4.22 mechanisms and APIs

            +

            Adopting 4.22 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.21 plug-in to adopt the 4.22 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/incompatibilities.html index 4561d917045..01146036e43 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.22 and 4.23 -

            Incompatibilities between Eclipse 4.22 and 4.23

            +

            Incompatibilities Between Eclipse 4.22 and 4.23

            Eclipse changed in incompatible ways between 4.22 and 4.23 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/recommended.html index 7a49600647f..15babd4e8bb 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.23/recommended.html @@ -10,7 +10,7 @@ Adopting 4.23 mechanisms and APIs -

            Adopting 4.23 mechanisms and APIs

            +

            Adopting 4.23 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.22 plug-in to adopt the 4.23 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/incompatibilities.html index b72b49cea41..de18bcfce65 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.23 and 4.24 -

            Incompatibilities between Eclipse 4.23 and 4.24

            +

            Incompatibilities Between Eclipse 4.23 and 4.24

            Eclipse changed in incompatible ways between 4.23 and 4.24 in ways that affect @@ -29,7 +29,7 @@

            Incompatibilities between Eclipse 4.23 and 4.24

            -

            1. Feature org.eclipse.equinox.serverside.sdk removed

            +

            1. Feature org.eclipse.equinox.serverside.sdk Removed

            What is affected: Clients that use org.eclipse.equinox.serverside.sdk Feature coming with Eclipse Platform.

            Description:

            diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/recommended.html index de8b2408e1d..f980159c96e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.24/recommended.html @@ -10,7 +10,7 @@ Adopting 4.24 mechanisms and APIs -

            Adopting 4.24 mechanisms and APIs

            +

            Adopting 4.24 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.23 plug-in to adopt the 4.24 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/incompatibilities.html index 022621e9c2c..62febdf10e7 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.24 and 4.25 -

            Incompatibilities between Eclipse 4.24 and 4.25

            +

            Incompatibilities Between Eclipse 4.24 and 4.25

            Eclipse changed in incompatible ways between 4.24 and 4.25 in ways that affect @@ -30,7 +30,7 @@

            Incompatibilities between Eclipse 4.24 and 4.25

            -

            1. Different providers for 3rd party packages may result on unmatched Required-Bundle

            +

            1. Different Providers for 3rd Party Packages May Result on Unmatched Required-Bundle

            What is affected: Clients that use Require-Bundle with a bundle that was replaced in their target platform.

          -

          2. Different providers for 3rd party packages may result on unmatched Import-Package requirements

          +

          2. Different Providers for 3rd Party Packages May Result on Unmatched Import-Package Requirements

          What is affected: Clients that use Import-Package with a version requirement for some 3rd-party packages:

          • com.ibm.icu
            • diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/recommended.html index 1565127dd5f..8c9995190be 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.25/recommended.html @@ -10,7 +10,7 @@ Adopting 4.25 mechanisms and APIs -

            Adopting 4.25 mechanisms and APIs

            +

            Adopting 4.25 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.23 plug-in to adopt the 4.25 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/incompatibilities.html index 262fcdb2fbe..7ccda2da0dd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.25 and 4.26 -

            Incompatibilities between Eclipse 4.25 and 4.26

            +

            Incompatibilities Between Eclipse 4.25 and 4.26

            diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/recommended.html index 6764daede25..ef9ea5b7cfd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.26/recommended.html @@ -10,13 +10,13 @@ Adopting 4.26 mechanisms and APIs -

            Adopting 4.26 mechanisms and APIs

            +

            Adopting 4.26 Mechanisms and APIs

            This section describes changes that are required if you are trying to change your 4.25 plug-in to adopt the 4.26 mechanisms and APIs.

            -

            JobManager implementation changes: Possible deadlock in IJobChangeListener

            +

            JobManager Implementation Changes: Possible Deadlock in IJobChangeListener

            Attention: The JobManager implementation was changed! The old JobMangager implementation notified IJobChangeListener about various IJobChangeEvent without strict order in various threads. For example @@ -84,7 +84,7 @@

            JobManager implementation changes: Possible deadlock in IJobChangeListener It is recommended to check existing IJobChangeListener implementations for possible regressions if updating to the new target platform. -

            Migration to SLF4J 1.7.36 from Maven-Central

            +

            Migration to SLF4J 1.7.36 From Maven-Central

            The Eclipse Platform migrated to the SLF4J artifacts from Maven-Central in version 1.7.36. With this migration the Bundle-SymbolicName changed from org.slf4j.api to slf4j.api. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/faq.html index 5f805aad77e..d924885a86e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/faq.html @@ -10,7 +10,7 @@

            Eclipse 4.27 Plug-in Migration FAQ

            -

            How did the Apache Lucene bundles change?

            +

            How Did the Apache Lucene Bundles Change?

            As part of the Eclipse Platform's effort to support the latest version of Apatche Lucene, the third-party bundles changed in the following way:

            1. Bundle org.apache.lucene.core was bumped to version 9.4.2.
              2. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/incompatibilities.html index 58c7547e979..5af12441032 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.26 and 4.27 -

              Incompatibilities between Eclipse 4.26 and 4.27

              +

              Incompatibilities Between Eclipse 4.26 and 4.27

              diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/recommended.html index 6ac4ee9dfc6..44afda30bb6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.27/recommended.html @@ -11,14 +11,14 @@ -

              Adopting 4.27 mechanisms and APIs

              +

              Adopting 4.27 Mechanisms and APIs

              This section describes changes that are required if you are trying to change your 4.26 plug-in to adopt the 4.27 mechanisms and APIs.

              -

              Pre-built Lucene indexes should be updated

              +

              Pre-built Lucene Indexes Should Be Updated

              What is affected: Clients supplying pre-built Lucene help indexes.

              Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/incompatibilities.html index 07f5a293bc9..d886c22c4bd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.27 and 4.28 -

              Incompatibilities between Eclipse 4.27 and 4.28

              +

              Incompatibilities Between Eclipse 4.27 and 4.28

              diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/recommended.html index ebbd0e663d2..5de6b06a54a 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.28/recommended.html @@ -11,7 +11,7 @@ -

              Adopting 4.28 mechanisms and APIs

              +

              Adopting 4.28 Mechanisms and APIs

              This section describes changes that are required if you are trying to change your 4.27 plug-in to adopt the 4.28 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/incompatibilities.html index d9f0f6eba50..63649ddb866 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.28 and 4.29 -

              Incompatibilities between Eclipse 4.28 and 4.29

              +

              Incompatibilities Between Eclipse 4.28 and 4.29

              Eclipse changed in incompatible ways between 4.28 and 4.29 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/recommended.html index 218d19785de..8f32ad266ea 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.29/recommended.html @@ -11,7 +11,7 @@ -

              Adopting 4.29 mechanisms and APIs

              +

              Adopting 4.29 Mechanisms and APIs

              This section describes changes that are required if you are trying to change your 4.28 plug-in to adopt the 4.29 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/faq.html index a11b2d75e94..e469ed6b3ab 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/faq.html @@ -19,7 +19,7 @@

              Eclipse 4.3 Plug-in Migration FAQ

              - diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/incompatibilities.html index f980ec4630b..ed23849b180 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/incompatibilities.html @@ -10,7 +10,7 @@ -

              Incompatibilities between Eclipse 4.2 and 4.3

              +

              Incompatibilities Between Eclipse 4.2 and 4.3

              Eclipse changed in incompatible ways between 4.2 and 4.3 in ways that affect @@ -30,7 +30,7 @@

              Incompatibilities between Eclipse 4.2 and 4.3

              -

              1. New incompatible Lucene version

              +

              1. New Incompatible Lucene Version

              What is affected: Clients that directly reference Lucene API included in the platform.

              @@ -45,7 +45,7 @@

              1. New incompatible Lucene version

              -

              2. OleListeners must not dispose OleEvent arguments

              +

              2. OleListeners Must not Dispose OleEvent Arguments

              What is affected: Plug-ins that dispose the arguments (Variants) in received OleEvents.

              Description: Prior to Eclipse 4.3, the arguments (Variants) in OleEvents were never @@ -60,7 +60,7 @@

              2. OleListeners must not dispose OleEvent arguments -

              3. Models created in 4.2 need HandlerProcessAddon added

              +

              3. Models Created in 4.2 Need HandlerProcessAddon Added

              What is affected: All Eclipse 4 RCP applications

              Description: The static method processHierarchy of the E4Workbench class was removed. This method at the time of this removal supported the dynamically changing contexts in which handlers are executed. It was required to be called diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/recommended.html index 215094502f8..15b6ae194c6 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.3/recommended.html @@ -10,7 +10,7 @@ -

              Adopting 4.3 mechanisms and APIs

              +

              Adopting 4.3 Mechanisms and APIs

              This section describes changes that are required if you are trying to change @@ -23,7 +23,7 @@

              Adopting 4.3 mechanisms and APIs

              -

              1. Ensure all plug-ins include an OSGi manifest

              +

              1. Ensure All Plug-ins Onclude an OSGi Manifest

              The Eclipse platform 4.3 release is the final release that will support 2.x style Eclipse plug-ins with no OSGi manifest file (MANIFEST.MF). A warning diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/incompatibilities.html index 8dee280119e..8df32d73802 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.29 and 4.30 -

              Incompatibilities between Eclipse 4.29 and 4.30

              +

              Incompatibilities Between Eclipse 4.29 and 4.30

              Eclipse changed in incompatible ways between 4.29 and 4.30 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/recommended.html index 6dfea7b7486..d4da35760df 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.30/recommended.html @@ -11,7 +11,7 @@ -

              Adopting 4.30 mechanisms and APIs

              +

              Adopting 4.30 Mechanisms and APIs

              This section describes changes that are required if you are trying to change your 4.29 plug-in to adopt the 4.30 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/incompatibilities.html index 05da5168293..1c42f86611f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.30 and 4.31 -

              Incompatibilities between Eclipse 4.30 and 4.31

              +

              Incompatibilities Between Eclipse 4.30 and 4.31

              Eclipse changed in incompatible ways between 4.30 and 4.31 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/recommended.html index bcf4b0c0543..8f5253fd5ec 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.31/recommended.html @@ -11,7 +11,7 @@ -

              Adopting 4.31 mechanisms and APIs

              +

              Adopting 4.31 Mechanisms and APIs

              This section describes changes that are required if you are trying to change your 4.30 plug-in to adopt the 4.31 mechanisms and diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.32/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.32/incompatibilities.html index 7e6b6cfd176..610e226efe8 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.32/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.32/incompatibilities.html @@ -8,7 +8,7 @@ Incompatibilities between Eclipse 4.31 and 4.32 -

              Incompatibilities between Eclipse 4.31 and 4.32

              +

              Incompatibilities Between Eclipse 4.31 and 4.32

              Eclipse changed in incompatible ways between 4.31 and 4.32 in ways that affect @@ -28,7 +28,7 @@

              Incompatibilities between Eclipse 4.31 and 4.32

              -

              1. Multiple platform-specific fragments merged into their host

              +

              1. Multiple Platform-specific Fragments Merged Into Their Host

              The following platform-specific fragments have been merged into their respective host bundle:

              -

              4. Toggling Full-Screen command

              +

              4. Toggling Full-Screen Command

              What is affected: Any code using the OS X-specific org.eclipse.ui.cocoa.fullscreenWindow command. @@ -186,7 +186,7 @@

              4. Toggling Full-Screen command

              org.eclipse.ui.window.fullscreenmode command.

              -

              5. High-DPI icons

              +

              5. High-DPI Icons

              What is affected: Products that use bitmap images.

              Description: On high-DPI screens, SWT now automatically diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/faq.html index d4248d5a9a9..409894eb547 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/faq.html @@ -19,7 +19,7 @@

              Eclipse Oxygen (4.7) Plug-in Migration FAQ

              -

              1. Apache Lucene bundle changes

              +

              1. Apache Lucene Bundle Changes

              As part of the migration to Lucene 6.1, the third-party Lucene bundles were updated from version 3.5 to 6.1.

              1. Bundle org.apache.lucene.core was bumped in version so consumers should not see any difference except the changes of Lucene itself (see link below). diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/incompatibilities.html index acc19ff24b5..b351d647efe 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/incompatibilities.html @@ -10,7 +10,7 @@ -

                Incompatibilities between Eclipse 4.6 and 4.7

                +

                Incompatibilities Between Eclipse 4.6 and 4.7

                Eclipse changed in incompatible ways between 4.6 and 4.7 in ways that affect @@ -29,7 +29,7 @@

                Incompatibilities between Eclipse 4.6 and 4.7

                -

                1. New calling convention for progress monitors

                +

                1. New Calling Convention for Progress Monitors

                What is affected:

                All methods which obtain their own top-level IProgressMonitor.

                @@ -98,7 +98,7 @@

                1. New calling convention for progress monitor -

                2. javax.xml removed from org.eclipse.e4.rcp feature

                +

                2. javax.xml Removed From org.eclipse.e4.rcp Feature

                What is affected: Clients that refer to the javax.xml bundle and use the org.eclipse.e4.rcp feature for that dependency.

                diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html index d70b40bcd25..87243c6e2b1 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html @@ -10,7 +10,7 @@ -

                Adopting Oxygen (4.7) mechanisms and APIs

                +

                Adopting Oxygen (4.7) Mechanisms and APIs

                This section describes changes that are required if you are trying to change @@ -24,7 +24,7 @@

                Adopting Oxygen (4.7) mechanisms and APIs

                -

                1. Pre-built Lucene indexes should be updated

                +

                1. Pre-built Lucene Indexes Should Be Updated

                What is affected: Clients supplying pre-built Lucene help indexes.

                Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/faq.html index e3da61e0acb..1cc52184ba2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/faq.html @@ -20,7 +20,7 @@

                Eclipse Photon (4.8) Plug-in Migration FAQ

                -

                1. Apache Batik bundle changes

                +

                1. Apache Batik Bundle Changes

                As part of the migration of Eclipse Platform to Batik 1.9.0, the third-party Apache Batik bundles changed in the following way:

                1. Bundle org.apache.batik.css was bumped to version 1.9.0.
                  2. @@ -30,7 +30,7 @@

                  1. Apache Batik bundle changes

                -

                2. Apache Lucene bundle changes

                +

                2. Apache Lucene Bundle Changes

                As part of the migration to Lucene 7.1, the third-party Lucene bundles were updated from version 6.1 to 7.1.

                1. Bundle org.apache.lucene.core was bumped in version so consumers should not see any difference except the changes of Lucene itself (see link below). diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/incompatibilities.html index 513dac951fa..5f48fc6e42f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/incompatibilities.html @@ -10,7 +10,7 @@ -

                  Incompatibilities between Eclipse 4.7 and 4.8

                  +

                  Incompatibilities Between Eclipse 4.7 and 4.8

                  Eclipse changed in incompatible ways between 4.7 and 4.8 in ways that affect @@ -30,7 +30,7 @@

                  Incompatibilities between Eclipse 4.7 and 4.8

                  -

                  1. Support for XULRunner dropped

                  +

                  1. Support for XULRunner Dropped

                  What is affected: Clients that use SWT.MOZILLA style in org.eclipse.swt.browser.Browser#Browser(Composite parent, int style) constructor.

                  diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html index e5f9a435c07..233d53877ae 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html @@ -10,7 +10,7 @@ -

                  Adopting Photon (4.8) mechanisms and APIs

                  +

                  Adopting Photon (4.8) Mechanisms and APIs

                  This section describes changes that are required if you are trying to change @@ -25,7 +25,7 @@

                  Adopting Photon (4.8) mechanisms and APIs

                  -

                  1. Direct usages of Apache Batik CSS should be upgraded

                  +

                  1. Direct Usages of Apache Batik CSS Should Be Upgraded

                  What is affected: Clients directly using Apache Batik CSS bundles version 1.8.0.

                  Description: @@ -40,7 +40,7 @@

                  1. Direct usages of Apache Batik CSS should be upgra
                  • Upgrade their code to work with Apache Batik CSS version 1.9.0
                  -

                  2. Pre-built Lucene indexes should be updated

                  +

                  2. Pre-built Lucene Indexes Should Be Updated

                  What is affected: Clients supplying pre-built Lucene help indexes.

                  Description: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/faq.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/faq.html index d809e145e2e..2918145a914 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/faq.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/faq.html @@ -21,7 +21,7 @@

                  Eclipse 4.9 Plug-in Migration FAQ

                  -

                  1. Apache Batik bundle changes

                  +

                  1. Apache Batik Bundle Changes

                  As part of the migration of Eclipse Platform to Batik 1.10.0, the third-party Apache Batik bundles changed in the following way:

                  1. Bundle org.apache.batik.css was bumped to version 1.10.0.
                    2. @@ -31,14 +31,14 @@

                    1. Apache Batik bundle changes

                  -

                  2. IBM ICU4j bundle changes

                  +

                  2. IBM ICU4j Bundle Changes

                  As part of the migration of Eclipse Platform to ICU4j 62.1, the third-party IBM ICU4j bundle changed in the following way:

                  1. Bundle com.ibm.icu was bumped to version 62.1.0.
                  -

                  3. Apache Felix Gogo bundle changes

                  +

                  3. Apache Felix Gogo Bundle Changes

                  As part of the migration of Eclipse Platform to Apache Felix Gogo 1.1, the third-party Apache Felix Gogo bundles changed in the following way:

                  1. Bundle org.apache.felix.gogo.runtime was bumped to version 1.1.0.
                    2. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/incompatibilities.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/incompatibilities.html index 57d6687044f..554a0e4c044 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/incompatibilities.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/incompatibilities.html @@ -10,7 +10,7 @@ -

                    Incompatibilities between Eclipse 4.8 and 4.9

                    +

                    Incompatibilities Between Eclipse 4.8 and 4.9

                    Eclipse changed in incompatible ways between 4.8 and 4.9 in ways that affect diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/recommended.html index 6dcbd0b18e0..984458dac32 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/recommended.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.9/recommended.html @@ -10,7 +10,7 @@ -

                    Adopting 4.9 mechanisms and APIs

                    +

                    Adopting 4.9 Mechanisms and APIs

                    This section describes changes that are required if you are trying to change @@ -26,7 +26,7 @@

                    Adopting 4.9 mechanisms and APIs

                    -

                    1. Direct usages of Apache Batik CSS should be upgraded

                    +

                    1. Direct Usages of Apache Batik CSS Should be Upgraded

                    What is affected: Clients directly using Apache Batik CSS bundles version 1.9.1.

                    Description: @@ -43,7 +43,7 @@

                    1. Direct usages of Apache Batik CSS should be upgra

          -

          2. Direct usages of IBM ICU4j should be upgraded

          +

          2. Direct Usages of IBM ICU4j Should be Upgraded

          What is affected: Clients directly using IBM ICU4j bundle versions earlier than 62.1.0.

          Description: @@ -60,7 +60,7 @@

          2. Direct usages of IBM ICU4j should be upgraded -

          3. Direct usages of Apache Felix Gogo should be upgraded

          +

          3. Direct Usages of Apache Felix Gogo Should be Upgraded

          What is affected: Clients directly using Apache Felix Gogo Runtime or Apache Felix Gogo Shell bundle versions earlier than 1.1.0.

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/removals.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/removals.html index bf673f20db0..6985b9bc016 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/removals.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/removals.html @@ -20,7 +20,7 @@

          Overview

          -

          Planned Deprecated API removals

          +

          Planned Deprecated API Removals

          Deprecated API can be marked for deletion. @@ -35,10 +35,10 @@

          Planned Deprecated API removals

          -

          API removals after June 2017

          +

          API Removals After June 2017

          -

          1. Platform authorization API

          +

          1. Platform Authorization API

          Since Eclipse 1.0, the Eclipse Platform class provided API for storing and retrieving passwords in a keyring file. This API used an inherently insecure method for encrypting @@ -63,7 +63,7 @@

          1. Platform authorization API

          -

          API removals after June 2018

          +

          API Removals After June 2018

          1. org.eclipse.ui.cocoa.fullscreenWindow

          @@ -86,9 +86,9 @@

          1. org.eclipse.ui.cocoa.fullscreenWindow

          -

          API removals after June 2020

          +

          API Removals After June 2020

          -

          1. Remove Dirtable flag from MPartDescriptor

          +

          1. Remove Dirtable Flag From MPartDescriptor

          The DirtableMInput field will be removed from the MPartDescriptor class and related API.

          @@ -97,7 +97,7 @@

          1. Remove Dirtable flag from MPartDescriptor

          -

          2. Remove deprecated dialogs from org.eclipse.ui.dialogs

          +

          2. Remove Deprecated Dialogs From org.eclipse.ui.dialogs

          The following dialogs are planned to be removed from this package: @@ -114,9 +114,9 @@

          2. Remove deprecated dialogs from org.eclipse.ui.dialogs

          -

          API removals after March 2021

          +

          API Removals After March 2021

          -

          1. org.eclipse.core.commands.util package

          +

          1. org.eclipse.core.commands.util Package

          The org.eclipse.core.commands.util package is planned to be removed. It contains one utility class for tracing code. @@ -124,7 +124,7 @@

          1. org.eclipse.core.commands.util package

          For further details or to provide feedback on this change, see bug 143992.

          -

          3. org.eclipse.core.launcher#Main and WebStartMain and related interfaces

          +

          3. org.eclipse.core.launcher#Main and WebStartMain and Related Interfaces

          The classes org.eclipse.core.launcher.Main, org.eclipse.equinox.launcher.WebStartMain its related interfaces will be deleted. @@ -135,13 +135,13 @@

          3. org.eclipse.core.launcher#Main and WebStartMain and -

          API removals after June 2021

          +

          API Removals After June 2021

          -

          API removals after May 2022

          +

          API Removals After May 2022

          -

          1. Hover images from ISharedImages

          +

          1. Hover Images From ISharedImages

          Multiple images not used since Eclipse 3.0 in the platform will be deleted. @@ -165,9 +165,9 @@

          1. Hover images from ISharedImages

          -

          API removals after June 2022

          +

          API Removals After June 2022

          -

          1. ICU4J bundle from SDK

          +

          1. ICU4J Bundle From SDK

          Support and/or usage of ICU4J is being gradually removed from internals. Wherever ICU4J is exposed in API it's being deprecated and scheduled for removal after June 2022 release.

          @@ -177,9 +177,9 @@

          1. ICU4J bundle from SDK

          -

          API removals after September 2022

          +

          API Removals After September 2022

          -

          1. Observable factory classes

          +

          1. Observable Factory Classes

          The following databinding classes will be removed. They have been obsolete since the databinding framework was transitioned to work with property classes in 2014. They are replaced by corresponding property factory classes. @@ -193,7 +193,7 @@

          1. Observable factory classes

        • org.eclipse.ui.databinding.WorkbenchObservables
          • -

          2. Untyped databinding property factory classes

          +

          2. Untyped Databinding Property Factory Classes

          The following classes in the databinding bundles will be removed. They are replaced by typed factory classes with the same name, but in a sub-package that is called "typed". @@ -207,7 +207,7 @@

          2. Untyped databinding property factory classes

        • org.eclipse.jface.databinding.swt.WidgetProperties
          • -

          4. Remove IModelProviderEvent's fields TARGET_CHANGED and ENVIRONMENT_CHANGED

          +

          4. Remove IModelProviderEvent's Fields TARGET_CHANGED and ENVIRONMENT_CHANGED

          The fields org.eclipse.pde.core.IModelProviderEvent.TARGET_CHANGED and org.eclipse.pde.core.IModelProviderEvent.ENVIRONMENT_CHANGED are scheduled for removal after the January 2022 release.

          @@ -216,9 +216,9 @@

          4. Remove IModelProviderEvent's fields TARGET_CHANG -

          API removals after December 2025

          +

          API Removals After December 2025

          -

          1. Support for javax-annotation by the E4 Injector

          +

          1. Support for Javax-annotation by the E4 Injector

          The support of the Eclipse E4 Platform Dependency Injector for annotations from the javax.inject and javax.annotation package is deprecated and scheduled to be disabled by default after the December 2025 release. @@ -234,7 +234,7 @@

          1. Support for javax-annotation by the E4 Injector -

          API removals after March 2026

          +

          API Removals After March 2026

          1. Bundle org.eclipse.osgi.services

          @@ -252,15 +252,15 @@

          2. PluginVersionIdentifier

          -

          Removed API in previous releases

          +

          Removed API in Previous Releases

          -

          API removals in the Eclipse 4.6 release

          +

          API Removals in the Eclipse 4.6 Release

          -

          1. Eclipse 2.0 runtime model and boot API

          +

          1. Eclipse 2.0 Runtime Model and Boot API

          When the Eclipse runtime transitioned to use OSGi as its implementation, some existing APIs for interacting with the old runtime were deprecated and moved to a compatibility fragment @@ -278,7 +278,7 @@

          1. Eclipse 2.0 runtime model and boot API

          For further details or to provide feedback on this change, see bug 370248.

          -

          API removals in the Eclipse 4.7 release

          +

          API Removals in the Eclipse 4.7 Release

          1. org.eclipse.jface.util.ListenerList

          @@ -292,7 +292,7 @@

          1. org.eclipse.jface.util.ListenerList

          -

          API removals in the Eclipse 4.8 release

          +

          API Removals in the Eclipse 4.8 Release

          1. Update Manager

          @@ -300,7 +300,7 @@

          1. Update Manager

          This API was marked for deletion in the 4.2. release via bug 311590.

          -

          2. Methods in Platform deleted

          +

          2. Methods in Platform Deleted

          Platform API as announced for Eclipse 4.2 was deleted. @@ -324,7 +324,7 @@

          3. org.eclipse.ui.views.tasklist.TaskList

          For further details or to provide feedback on this change, see bug 436506.

          -

          4. IContextComputer and related classes

          +

          4. IContextComputer and Related Classes

          The org.eclipse.ui.help.IContextComputer class and dependent classes, i.e., org.eclipse.ui.help.WorkbenchHelp, DialogPageContextComputer and ViewContextComputer have been deleted. They were deprecated since 2002.

          @@ -334,7 +334,7 @@

          4. IContextComputer and related classes

          -

          API removals in the Eclipse 4.10 release

          +

          API Removals in the Eclipse 4.10 Release

          1. TableTreeViewer

          @@ -347,9 +347,9 @@

          1. TableTreeViewer

          -

          API removals in the Eclipse 4.11 release

          +

          API Removals in the Eclipse 4.11 Release

          -

          1. ImageAndMessageArea from JFace

          +

          1. ImageAndMessageArea From JFace

          The org.eclipse.jface.dialogs.ImageAndMessageArea class has been removed.

          @@ -361,9 +361,9 @@

          1. ImageAndMessageArea from JFace

          -

          API removals in the Eclipse 4.12 release

          +

          API Removals in the Eclipse 4.12 Release

          -

          1. Delete IPluginDescriptor and related API

          +

          1. Delete IPluginDescriptor and Related API

          The IPluginDescriptor class has been removed.

          @@ -381,7 +381,7 @@

          2. TableTree

          -

          API removals in the Eclipse 4.17 release

          +

          API Removals in the Eclipse 4.17 Release

          1. Remove Input and MInputPart

          @@ -390,7 +390,7 @@

          1. Remove Input and MInputPart

          For further details or to provide feedback on this change, see bug 562813. -

          2. Remove method org.eclipse.core.runtime.Platform#getJobManager()

          +

          2. Remove Method org.eclipse.core.runtime.Platform#getJobManager()

          The method getJobManager() is planned to be removed from class org.eclipse.core.runtime.Platform. Clients are encouraged to use the method org.eclipse.core.runtime.jobs.Job#getJobManager() instead. @@ -411,7 +411,7 @@

          3. org.eclipse.jface.util.Assert and org.eclipse.jface.text -

          API removals in the Eclipse 4.19 release

          +

          API Removals in the Eclipse 4.19 Release

          1. org.eclipse.pde.core.IModelProvider

          @@ -423,7 +423,7 @@

          1. org.eclipse.pde.core.IModelProvider

          -

          API removals in the Eclipse 4.20 release

          +

          API Removals in the Eclipse 4.20 Release

          1. Delete Job.createSystem(ICoreRunnable) API

          @@ -443,7 +443,7 @@

          2. org.eclipse.core.runtime.IPlatformRunnable

          -

          3. Remove org.eclipse.pde.ui.targetProvisioners extension point

          +

          3. Remove org.eclipse.pde.ui.targetProvisioners Extension Point

          The org.eclipse.pde.ui.targetProvisioners extension point is planned to be removed. @@ -453,7 +453,7 @@

          3. Remove org.eclipse.pde.ui.targetProvisioners exte For further details or to provide feedback on this change, see bug 541806.

          -

          4. Delete 2.0 plug-in compatibility classes and related API

          +

          4. Delete 2.0 Plug-in Compatibility Classes and Related API

          The following classes and its related API will be deleted. @@ -468,9 +468,9 @@

          4. Delete 2.0 plug-in compatibility classes and related

          -

          API removals in the Eclipse 4.24 release

          +

          API Removals in the Eclipse 4.24 Release

          -

          1. BookmarkNavigator view and related API

          +

          1. BookmarkNavigator View and Related API

          BookmarkNavigator view (ResourceNavigator impl) and related API is marked for deletion. @@ -478,7 +478,7 @@

          1. BookmarkNavigator view and related API

          For further details or to provide feedback on this change, see bug 578786.

          -

          2. Remove deprecated contents of org.eclipse.pde.ui.launcher package

          +

          2. Remove Deprecated Contents of org.eclipse.pde.ui.launcher Package

          The following classes from org.eclipse.pde.ui.launcher have been deprecated since 2009 and are scheduled for removal. All classes have corresponding replacements in the org.eclipse.pde.launching bundle. @@ -506,9 +506,9 @@

          3. Remove TargetPlatform::createPlatformCon

          -

          API removals in the Eclipse 4.26 release

          +

          API Removals in the Eclipse 4.26 Release

          -

          1. Delete unsupported methods in WorkbenchWindowConfigurer

          +

          1. Delete Unsupported Methods in WorkbenchWindowConfigurer

          The following methods are not used anymore by the platform and will be deleted. @@ -528,7 +528,7 @@

          1. Delete unsupported methods in WorkbenchWin -

          2. Remove deprecated method and constructor in PopupDialog

          +

          2. Remove Deprecated Method and Constructor in PopupDialog

          The method getPersistBounds() is planned to be removed from class org.eclipse.jface.dialogs.PopupDialog. Clients are encouraged to use the method getPersistLocation() or getPersistSize() instead. @@ -540,9 +540,9 @@

          2. Remove deprecated method and constructor in PopupD

          -

          API removals in the Eclipse 4.28 release

          +

          API Removals in the Eclipse 4.28 Release

          -

          1. org.eclipse.ui.editors.text.EncodingActionGroup and related interfaces

          +

          1. org.eclipse.ui.editors.text.EncodingActionGroup and Related Interfaces

          The class org.eclipse.ui.editors.text.EncodingActionGroup and its related interfaces org.eclipse.ui.editors.text.IEncodingActionsConstants, org.eclipse.ui.editors.text.IEncodingActionsDefinitionIds, org.eclipse.ui.editors.text.IEncodingActionsHelpContextIds @@ -553,7 +553,7 @@

          1. org.eclipse.ui.editors.text.EncodingActionGroup Actual removal has been completed via pull 160 in platform.text repository

          -

          + Navigator view (ResourceNavigator impl) and related API is marked for deletion. @@ -562,7 +562,7 @@ Actual removal has been completed via pull 647 in platform.ui repository

          -

          3. Support for pack200 artifacts in p2

          +

          3. Support for Pack200 Artifacts in P2

          The pack200/unpack200 tools have been removed in Java 14 (March 2020) and underlying API are removed in Java 16 (March 2021). @@ -573,7 +573,7 @@

          3. Support for pack200 artifacts in p2

          -

          API removals in the Eclipse 4.30 release

          +

          API Removals in the Eclipse 4.30 Release

          1. Remove Classic Search API

          @@ -583,7 +583,7 @@

          1. Remove Classic Search API

          For further details or to provide feedback on this change, see PR 1152.

          -

          2. Remove MultiPageEditor and related API

          +

          2. Remove MultiPageEditor and Related API

          The class org.eclipse.ui.part.MultiPageEditor and related API were deprecated in 2002 and are planned for removal after the March 2023 release and actually removed in December 2023 release. @@ -592,8 +592,8 @@

          2. Remove MultiPageEditor and related API

          -

          API removals in the Eclipse 4.31 release

          -

          1. Delete deprecated contents of org.eclipse.ui.commands package

          +

          API Removals in the Eclipse 4.31 Release

          +

          1. Delete Deprecated Contents of org.eclipse.ui.commands Package

          The following deprecated contents of org.eclipse.ui.commands are not used anymore by the platform and will be deleted. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/questions/index.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/questions/index.html index 1b6f7141f66..8e0bded2b8f 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/questions/index.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/questions/index.html @@ -10,12 +10,12 @@

          -Platform questions index

          -

          Getting started

          +Platform Questions Index +

          Getting Started

          -

          Core runtime

          +

          Core Runtime

          -

          New file types in the UI

          +

          New File Types in the UI

          -

          Installation and upgrade

          +

          Installation and Upgrade

          • How do I configure my own splash screens and product name?
            • diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html index 4658f264492..128ea13f33d 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html @@ -13,13 +13,13 @@

            -Eclipse platform
            -API rules of engagement

            +Eclipse Platform
            +API Rules of Engagement Version 0.15 - Last revised 12:00 May 30, 2001

            Here are the rules of engagement for clients of the Eclipse platform API (and other components).

            -What it means to be API

            +What It Means to Be API

            The Eclipse platform defines API elements for use by its clients, namely ISVs writing plug-ins. These plug-ins may in turn define API elements for their clients, and so on. API elements are the public face: they carry @@ -30,7 +30,7 @@

            changes, the Eclipse platform team will also try to evolve API elements gracefully through successive major releases.

            -How to tell API from non-API

            +How to Tell API From Non-api

            By their very nature, API elements are documented and have a specification, in contrast to non-API elements which are internal implementation details usually without published documentation or specifications. So if you cannot @@ -99,7 +99,7 @@

          -General rules

          +General Rules The specification of API elements is generated from Javadoc comments in the element's Java source code. For some types of elements, the specification is in the form of a contract. For example, in the case of methods, the @@ -143,7 +143,7 @@

          -Calling public API methods

          +Calling Public API Methods For most clients, the bulk of the Eclipse API takes the form of public methods on API interfaces or classes, provided for the client to call when appropriate. @@ -178,7 +178,7 @@

          -Instantiating platform API classes

          +Instantiating Platform API Classes Not all concrete API classes are intended to be instantiated by just anyone. API classes have an instantiation contract indicating the terms under which instances may be created. The contract may also cover things like residual @@ -198,7 +198,7 @@

          -Subclassing platform API classes

          +Subclassing Platform API Classes Only a subset of the API classes were designed to be subclassed. API classes have a subclass contract indicating the terms under which subclasses may be declared. This contract also covers initialization responsibilities @@ -213,12 +213,12 @@

          -Calling protected API methods

          +Calling Protected API Methods Calling inherited protected and public methods from within a subclass is generally allowed; however, this often requires more care to correctly call than to call public methods from outside the hierarchy.

          -Overriding API methods

          +Overriding API Methods Only a subset of the public and protected API methods were designed to be overridden. Each API method has a subclass contract indicating the terms under which a subclass may override it. By default, overriding is not permitted. @@ -266,7 +266,7 @@

          -Implementing platform API interfaces

          +Implementing Platform API Interfaces Only a subset of the API interfaces were designed to be implemented by clients. API interfaces have a contract indicating the terms under which it may be implemented. Interfaces that are designed to be implemented by @@ -282,10 +282,10 @@

          -Implementing public API methods

          +Implementing Public API Methods See "Overriding API methods".

          -Accessing fields in API classes and interfaces

          +Accessing Fields in API Classes and Interfaces

          Clients may read API fields, most of which are final. Certain struct-like objects may have non-final public fields, which clients may read and write unless otherwise indicated.

          @@ -296,7 +296,7 @@

          -Casting objects of a known API type

          +Casting Objects of a Known API Type

          An object of a known API type may only be cast to a different API type (or conditionally cast using instanceof) if this is explicitly allowed @@ -314,7 +314,7 @@

          inappropriate.

          -Not following the rules

          +Not Following the Rules

          Whether done knowingly or unwittingly, there are consequences for transgressing the rules. It might be easier for all involved if there were API police that would bust you for breaking the rules. However, that is not the case. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html index 96664e92852..22c754e7da2 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/bidi.html @@ -8,7 +8,7 @@ Supporting bidirectional text -

          Supporting bidirectional text

          +

          Supporting Bidirectional Text

          A bidirectional language is one that can write either right to left or left to right based on context. Bidirectional text is supported throughout the platform. Eclipse will recognize Hebrew, Arabic, Farsi and Urdu as bidirectional by default.

          @@ -87,7 +87,7 @@

          Default Base Text Direction

              display.dispose();
            }

          -

          Base text direction in individual controls

          +

          Base Text Direction in Individual Controls

          In SWT, base text direction can be set at a control (either leaf or composite) level. Composites propagate the BTD to their children. The base text direction can be applied as follows:

          @@ -160,7 +160,7 @@

          Enabling Text Processing

          to handle special case characters that should not be processed as bidirectional text such as path separators. See org.eclipse.osgi.util.TextProcessor for more details.

          -

          Enabling your plug-in for looking up alternate icons

          +

          Enabling Your Plug-in for Looking up Alternate Icons

          In many cases your icons will not make any sense in right to left mode. In particular any icon to do with editing will have this issue.To enable lookup of images in a fragment, use $nl$ in your icon path and use @@ -177,7 +177,7 @@

          Enabling your plug-in for looking up alternate icons

          prefix on your path and the lookup will be handled for you. If you define your own extension points that involve icons, be sure to load images in the same way.

          -

          How to choose icons to override

          +

          How to Choose Icons to Override

          There are no hard and fast rules for determining what icons need to be overridden in a right to left language. In general, focus on icons that imply a textual direction with a horizontal arrow.

          diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/buddy_loading.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/buddy_loading.html index ba902abbbe5..0a6faf678cd 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/buddy_loading.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/buddy_loading.html @@ -9,7 +9,7 @@ Third party libraries and classloading -

          Third party libraries and classloading

          +

          Third Party Libraries and Classloading

          Because OSGi makes use of multiple classloaders, the transparent usage of extensible / configurable third party libraries in eclipse requires the usage of an eclipse specific mechanism called "buddy loading". This mechanism allows a bundle to indicate that it needs assistance to load classes or resources when it can not find them diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipse-install.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipse-install.html index 601a4b3ed40..81220e97116 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipse-install.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipse-install.html @@ -13,7 +13,7 @@ -

          How to write an Eclipse installer

          +

          How to Write an Eclipse Installer

          Last modified 15:20 Friday June 18, 2004

          Eclipse-based products need to be correctly installed on the end user's computer. Special-purpose packaging tools, such as InstallShield @@ -41,7 +41,7 @@

          How to write an Eclipse installer

          same manner. There is nothing to having gratuitous variety in this matter. -

          Product installer creation script

          +

          Product Installer Creation Script

          A product installer should be self-contained - the kind of thing that could be distributed on a CD and installed on any machine with a suitable operating @@ -258,7 +258,7 @@

          Product installer creation script

          perform all time-consuming first-time processing and cache the results, so that when the user starts the product it comes up promptly in an open-for-business state.

          -

          Uninstaller behavior

          +

          Uninstaller Behavior

          At uninstall time, the uninstaller should behave in the standard manner:

          1. warn user to exit all programs, especially the product being uninstalled
            2. @@ -281,7 +281,7 @@

            Uninstaller behavior

            which must be retained when the product is uninstalled. The user must be able to uninstall and reinstall a product at the same location without losing important data.

            -

            Installer behavior when product already installed

            +

            Installer Behavior When Product Already Installed

            When the product is already installed on the user's computer, the installer should allow a service update or version upgrade to be applied to the installed product.

            @@ -328,13 +328,13 @@

            Installer behavior when product already installed

            if this sub-directory should also exist after the upgrade; if any of the plug-in's files were to change, the plug-in's version number is revised, causing the files for the upgraded plug-in to be installed in a parallel directory <install>/eclipse/plugins/org.eclipse.ui_2.0.1/. 

            -

            Associating a JRE installed elsewhere

            +

            Associating a JRE Installed Elsewhere

            The JRE is expected to be located at <install>/eclipse/jre/bin/javaw.exe. If it is located elsewhere, the absolute path should be specified using the -vm option on the command line; e.g., -vm C:\j2jre1.3.0\jre\bin\javaw.exe. In which case, the installer should add this option to the command line of the desktop shortcut it creates.

            -

            Extension installer creation script

            +

            Extension Installer Creation Script

            By extension we mean a separately installable set of features and their plug-ins that can be associated with, and used from, one ore more Eclipse-based products installed on the @@ -461,7 +461,7 @@

            Extension installer creation script

            link files when it starts up. The installer keeps a record of any link files it creates so that they can be located when the extension is updated or uninstalled.

            -

            Uninstaller behavior

            +

            Uninstaller Behavior

            At un install time, the un installer should behave in the standard manner:

            1. warn user to exit all programs, especially products using the extension @@ -479,7 +479,7 @@

              Uninstaller behavior

              When an extension is uninstalled, all plug-in and feature files should be deleted; there are no important data files to be kept in these subdirectories. This allows the user to uninstall an extension completely, including any updates applied by the Eclipse update manager.

              -

              Installer behavior when extension already installed

              +

              Installer Behavior When Extension Already Installed

              When the extension is already installed on the user's computer, the installer should allow a service update or version upgrade to be applied to the installed extension.

              diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html index 7c2659df8ae..3298b552050 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/eclipsestarter.html @@ -13,7 +13,7 @@ -

              Starting Eclipse from Java

              +

              Starting Eclipse From Java

              Last modified June 1, 2007

              The Eclipse Platform makes heavy use of Java class loaders for loading plug-ins. Even the Eclipse Runtime itself diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html index 06d3d0e2477..ce3795661a9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/feature_manifest.html @@ -11,7 +11,7 @@

              -Eclipse platform feature manifest

              +Eclipse Platform Feature Manifest

              Version 4.2 - Last revised May, 2012

              The feature manifest format is defined by the following dtd:

              diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/index.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/index.html index d13309ee90b..6aad8d7fc12 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/index.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/index.html @@ -14,7 +14,7 @@

              Other Reference Information

              The following specifications, white papers, and design notes describe various aspects of the Eclipse Platform. -

              Basic platform information

              +

              Basic Platform Information

              -

              User interface information

              +

              User Interface Information

              -

              Product install and configuration information

              +

              Product Install and Configuration Information

              • How to write an Eclipse installer
              • About.ini file format
                • diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html index 0944c9bf409..fa3e42080aa 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher.html @@ -13,7 +13,7 @@

                Description

                Eclipse.  There is more to the launcher than just the eclipse executable in the root of the install.

                -

                The launcher and its shared library

                +

                The Launcher and Its Shared Library

                The launcher executable comes in 2 pieces: the executable (eclipse.exe), and a shared library (eclipse_1017.dll). The executable lives in the root of the eclipse install. The shared library @@ -26,7 +26,7 @@

                The launcher and its shared library

                shared library can be loaded via JNI in order to display the splash screen.

                -

                The launcher bundle

                +

                The Launcher Bundle

                Previous versions of Eclipse had a startup.jar JAR file in the root of the install.  In 3.3, this code has been moved to a plug-in org.eclipse.equinox.launcher in the plugins directory. Eclipse can still be started directly with java @@ -48,14 +48,14 @@

                The launcher bundle

                The version numbers above are for illustration purposes only (e.g. 1.0.0.v20070606). The actual version numbers may vary depending on the version of Eclipse you are using.

                -

                Finding a VM and using the JNI Invocation API

                +

                Finding a VM and Using the JNI Invocation API

                The Eclipse launcher is capable of loading the Java VM in the eclipse process using the Java Native Interface Invocation API.  The launcher is still capable of starting the Java VM in a separate process the same as previous version of Eclipse did.  Which method is used depends on how the VM was found.

                -

                No -vm specified

                +

                No -vm Specified

                When no -vm is specified, the launcher looks for a virtual machine first in a jre directory in the root of eclipse and then on the search @@ -67,7 +67,7 @@

                No -vm specified

              • If no jvm shared library is found, the launcher executes the java launcher to start the vm in a new process.
              -

              -vm specified on the command line or in eclipse.ini

              +

              -vm Specified on the Command Line or in eclipse.ini

              Eclipse can be started with "-vm <location>" to indicate a virtual machine to use. There are several possibilities for the value of <location>: diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher_ini.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher_ini.html index f418726e180..0573f4c8e70 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher_ini.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/launcher_ini.html @@ -9,7 +9,7 @@ -

              Eclipse launcher configuration

              +

              Eclipse Launcher Configuration

              Description

              When starting Eclipse there are many command-line arguments which are valid diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/message_bundles.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/message_bundles.html index 205480c3958..06147941a7e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/message_bundles.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/message_bundles.html @@ -15,7 +15,7 @@

              Description

              Since a running Eclipse tends to have many externalized messages, we have implemented a new message bundle system to be used in Eclipse. The mechanism is quite simple and completely generic - it can be used anywhere.

              -

              Summary of the new approach:

              +

              Summary of the New Approach:

              • messages.properties - this file is same as before except all keys need to be valid Java identifiers.
                • @@ -26,7 +26,7 @@

                Summary of the new approach:

                the values from the messages.properties files.
              • The message properties files are purged from memory.
              -

              When creating a new message:

              +

              When Creating a New Message:

              • Create a field in your Messages.java file.
              • Create a key/value pair in your messages.properties file where @@ -88,8 +88,8 @@

                New Code:

                NLS.initializeMessages(BUNDLE_NAME, Messages.class); } } -

                messages.properties

                -

                Old Code:

                +

                messages.properties

                +

                Old Code:

                key.one = Hello world.
 key.two = This is an {0} of binding with one argument.

                New Code:

                diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/multi_user_installs.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/multi_user_installs.html index 1e68f8b8171..21dca54b32b 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/multi_user_installs.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/multi_user_installs.html @@ -10,7 +10,7 @@ Eclipse Multi-user Installs -

                Eclipse multi-user installs

                +

                Eclipse Multi-user Installs

                Eclipse provides a number of strategies for supporting multi-user installs. Each strategy satisfies a specific scenario. This document covers these strategies, @@ -19,7 +19,7 @@

                Eclipse multi-user installs

                setting up Eclipse-based products to be used through a network and developers interested in creating plug-ins that are good citizens in such setups.

                Last Modified: June 17th, 2005

                -

                Basic concepts

                +

                Basic Concepts

                Locations

                As described in the Eclipse Runtime options article, there are three different locations that are important @@ -44,7 +44,7 @@

                Locations

                instance area there is a special directory called .metadata, where plug-ins store their own workspace-specific metadata and user settings.
              -

              Configuration initialization

              +

              Configuration Initialization

              Before Eclipse has been run for the first time, the configuration area is basically an empty directory. This location is gradually populated by the Eclipse runtime, and other plug-ins, across Eclipse sessions. Most of the metadata kept by the @@ -83,13 +83,13 @@

              Configuration initialization

              to be created in the configuration area are visited. Only after that it can be said the configuration area is fully initialized and no write access to it will ever be required in order for Eclipse to run.

              -

              Scenario #1 - private install

              +

              Scenario #1 - Private Install

              This is actually a single-user scenario. The Eclipse install is used by a single user, and the user has full access privileges to it. The configuration area location defaults to the configuration directory under the install location.

              The procedure to set up this scenario requires just making sure the user has full rights to the install location.

              -

              Scenario #2 - shared install

              +

              Scenario #2 - Shared Install

              In this scenario, a single install area is shared by many users. The "configuration" directory under the install area is home only to the config.ini as shipped with the product (it is not initialized). Every user has their own local standalone @@ -99,7 +99,7 @@

              Scenario #2 - shared install

              to automatically default to a directory under the user home dir. If this measure is not taken, all users will end up using the same location for their configuration area, which is not supported.

              -

              Scenario #3 - shared configuration

              +

              Scenario #3 - Shared Configuration

              Here users share not only an install area but also a master configuration area. Users still have, by default, their own private writable configuration areas. A user's private configuration area is cascaded to the master configuration @@ -114,7 +114,7 @@

              Scenario #3 - shared configuration

              will be automatically computed and initialized.

              The more fully initialized the shared configuration is, the less need there is for files to be created under the local configuration.

              -

              Setting the private configuration area location

              +

              Setting the Private Configuration Area Location

              The default location for a private configuration area is:

              <user-home-dir>/.eclipse/<product-id>_<product-version>/configuration

              The user home dir is determined by the user.home Java system property. @@ -125,12 +125,12 @@

              Setting the private configuration area location

              to set it either in the launcher .ini file or in the config.ini file at the base configuration location.

              Updating

              -

              Shared configuration

              +

              Shared Configuration

              Plug-ins can be installed in/removed from the shared configuration. Users will catch up with those changes the next time Eclipse runs. It is necessary to make sure users having the shared configuration as their master configuration are not running Eclipse.

              -

              Private configuration

              +

              Private Configuration

              Users can modify their local configuration areas by installing additional plug-ins. This does not cause any changes to the shared configuration, so other users will not see the changes. Note that plug-ins configured at the shared configuration diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html index 8faadf4d9c2..5209a5c5f2e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/overview-platform.html @@ -13,7 +13,7 @@ -

              Map of platform plug-ins

              +

              Map of Platform Plug-ins

              The Eclipse Platform provides basic support for plug-ins, resources, and the workbench.

              The Eclipse Platform itself is divided up into a number of separate plug-ins. diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html index 9fe2a4131ea..0e2e81c90e3 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/p2_dropins_format.html @@ -11,7 +11,7 @@ The dropins folder and supported file layouts -

              The dropins folder and supported file layouts

              +

              The Dropins Folder and Supported File Layouts

              Provisioning operations should generally occur using the software updates dialog, or by invoking p2 tools or APIs. However, there are situations where scripts need to install plugins and features via file system operations, @@ -38,7 +38,7 @@

              The dropins folder and supported file layouts

              dropins folder behave exactly like plug-ins installed via the user interface.

              -

              Supported file layouts

              +

              Supported File Layouts

              The dropins folder supports a variety of layouts, depending on the scale of your application and the desired degree of separation of its parts. The simplest layout is to just drop plug-ins in either jar or diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html index f1843826b4c..5e31561882c 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/plugin_manifest.html @@ -12,7 +12,7 @@ -

              Eclipse platform plug-in manifest

              +

              Eclipse Platform Plug-in Manifest

              Version 3.2 - Last revised May 9, 2006

              diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html index c713b7e3492..84f8876f496 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/project_description_file.html @@ -11,7 +11,7 @@

              -The project description file

              +The Project Description File Description: When a project is created in the workspace, a project description file is automatically generated that describes the project.  The purpose of this file is to make the project self-describing, diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html index edda75dc824..cd28f4cc22e 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/runtime-options.html @@ -13,14 +13,14 @@ -

              The Eclipse runtime options

              +

              The Eclipse Runtime Options

              Version 4.6 - Last revised September 29, 2015

              The Eclipse platform is highly configurable. Configuration input takes the form of command line arguments and System property settings. In many cases the command line arguments are simply short cuts for setting the related System properties. In fact, there are many more System property settings than command line arguments.

              -

              Command line arguments

              +

              Command Line Arguments

              Listed below are the command line arguments processed by various parts of the Eclipse runtime. Many of these values can also be specified using System properties either on the command line using -D VM arguments, by specifying @@ -232,7 +232,7 @@

              Bidirectional Support

              Valid arguments are "on=[y|n];textDir=[ltr|rtl|auto]",.
              Example: -bidi "on=y;textDir=rtl"
              -

              Obsolete command line arguments

              +

              Obsolete Command Line Arguments

              The following command line arguments are no longer relevant or have been superseded and are consumed by the runtime and not passed on to the application being run to maintain backward compatibility. .

              @@ -276,7 +276,7 @@

              Others

              -allowDeadlock
              <description>
              -

              System properties

              +

              System Properties

              The following System properties are used by the Eclipse runtime. Note that those starting with "osgi" are specific to the OSGi framework implementation while those starting with "eclipse" are particular to the Eclipse @@ -891,7 +891,7 @@

              Locations is the instance area or, in the IDE context, the workspace. To run the default Eclipse configuration on a specific data set you can specify:

                  eclipse -data c:\mydata
              -

              More detail

              +

              More Details

              Locations are URLs. For simplicity, file paths are also accepted and automatically converted to file: URLs. For better control and convenience, there are also a number of predefined symbolic locations which can be used. Note that not @@ -1060,7 +1060,7 @@

              Read-only Locations

              osgi.user.area.readOnly osgi.user.area
              2. -

              Variable substitution in config.ini

              +

              Variable Substitution in config.ini

              The config.ini file located in the configuration area can be used to define configuration property values. This file is a simple properties file with key=value pairs. The values contained in the config.ini file may @@ -1069,7 +1069,7 @@

              Variable substitution in config.ini

              For example, the following uses a windows environment variable LOCALAPPDATA to configure the instance area location: 

                  osgi.instance.area.default=$LOCALAPPDATA$/eclipse/workspace
              -

              Launcher ini file

              +

              Launcher ini File

              The eclipse.exe and more generally executables for RCP applications now read their parameters from an associated ini file. This file offers a platform independent way to pass in arguments that previously had to be specified directly on @@ -1077,7 +1077,7 @@

              Launcher ini file

              and consistency across various installations to only specify the vm location and the vm arguments in this ini file and use the config.ini file for others.

              -

              File format

              +

              File Format

              This file must be named after the executable name (for example, eclipse.exe will read eclipse.ini, whereas launcher.exe will read launcher.ini) and every parameter must be specified on a new line in the file. Here is an example of such a file specifying the vm location and some parameters:

              -vm
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/terminology.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/terminology.html
index 34df4357233..271ba9c9623 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/terminology.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/terminology.html
@@ -11,7 +11,7 @@
 
 
 
              
-Glossary of terms
              
+Glossary of Terms
 It can be confusing when one person refers to the same thing with different
 terms, and downright misleading if they refer to different things using
 the same term. That's why it's important to choose the right words when
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/ui_accessibility_tips.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/ui_accessibility_tips.html
index 7741fc8dc03..7c8cc0310f2 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/ui_accessibility_tips.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/misc/ui_accessibility_tips.html
@@ -9,7 +9,7 @@
 Tips For making user interfaces accessible
 
 
-
              Tips for making user interfaces accessible 
              
+
              Tips for Making User Interfaces Accessible 
              
 
              Below is a series of tips for making applications compatible with accessibility
 programs, such as the Accessibility interface provided by Windows. 
              
 
              
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/services/index.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/services/index.html
index 5acac7cf0b1..89fec8bf2ec 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/services/index.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/reference/services/index.html
@@ -21,7 +21,7 @@
 
   
     
              
-      Available OSGi Services interfaces to extend and customize the Platform
+      Available OSGi Services Interfaces to Extend and Customize the Platform
     
              
     The Platform can be extended and customized by providing some implementation of OSGi services (for example using Declarative Services).
     
              This document lists the service interfaces extenders can provide to the Platform and that Platform will consume as extensions:
              
@@ -61,81 +61,5 @@ 
              
         contribute to content-assist in the Generic Editor, similarly to extensions of org.eclipse.ui.genericeditor.contentAssistProcessors.
       
     
-
-    
   
 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
index abf64d709fa..2217463f829 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/samples/samples.html
@@ -11,11 +11,9 @@
 
 
 
-
              
-Installing the examples
              
+
              iIstalling the Examples
              
 
-
              
- Installing examples within Eclipse
              
+
              Installing Examples Within Eclipse
              
 
 
              
 The Eclipse SDK examples are found on the Eclipse project update site.

From 044e8baf70c4f7f9b30c603db7c07b3f73c97bca Mon Sep 17 00:00:00 2001
From: Matthias Becker 
Date: Fri, 4 Oct 2024 19:36:28 +0200
Subject: [PATCH 4/4] Write HTML-Headers in Title Case in platform.doc.isv (IV)

---
 .../org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm    | 2 +-
 .../porting/4.20/recommended.html                           | 4 ++--
 .../porting/4.6/recommended.html                            | 6 +++---
 .../porting/4.7/recommended.html                            | 2 +-
 .../porting/4.8/recommended.html                            | 4 ++--
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm
index 461acea246f..9dcea2baa36 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm
@@ -12,7 +12,7 @@
 
 
              Cheat Sheets
              
 
-
              guiding the User Through Tasks
              
+
              Guiding the User Through Tasks
              
 
 
              
 Even when the platform UI filters out unneeded functionality, there is still a steep learning
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html
index e4dcaa43d25..1bfa124eab7 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.20/recommended.html
@@ -25,7 +25,7 @@ 
              Adopting 4.20 Mechanisms and APIs
              
 
 	
 	
              
-		1. Pack200 Artifacts Will No Longer Be Generated Starting With 4.21 Release
+		1. Pack200 Artifacts Will No Longer Be Generated Starting With 4.21 Release
 	
              
 	
              
 		What is affected: Clients relying on availability of pack200 artifacts (*.pack.gz) in Eclipse Platform p2 repository.
@@ -41,7 +41,7 @@ 
              
 	
              
 	
 	
              
-		2. Pack200 APIs Will No Longer Generate/Use Packed Artifacts Starting With 4.24 Release and to Be Removed in 4.28 Release
+		2. Pack200 APIs Will No Longer Generate/Use Packed Artifacts Starting With 4.24 Release and to Be Removed in 4.28 Release
 	
              
 	
              
 		What is affected: Callers of pack200 specific APIs to experience pack200 artifacts to no longer be used/fetched/generated/mirrored or dealt with in any other way.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.6/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.6/recommended.html
index 69daa5a138e..b390c133dc2 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.6/recommended.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.6/recommended.html
@@ -94,7 +94,7 @@ 
              1. New Calling Convention for Progress Monitor
 about this change can be found here.
 
 
-
              2. SubProgressMonitor Has Been Deprecated
              
+
              2. SubProgressMonitor Has Been Deprecated
              
 
              What is affected: Clients that refer to org.eclipse.core.runtime.SubProgressMonitor.
              
 
              Description:
 org.eclipse.core.runtime.SubProgressMonitor has been deprecated and replaced by
@@ -144,7 +144,7 @@ 
              2. SubProgressMonitor Has Been Deprecated
 
 
-
              3. ListenerList Has Been Generified
              
+
              3. ListenerList Has Been Generified
              
 
              What is affected: Clients that refer to org.eclipse.core.runtime.ListenerList.
 
              
 
              Description:
@@ -162,7 +162,7 @@ 
              3. ListenerList Has Been Generified
              
 
 
 
-
              4. Toggling Full-Screen Command
              
+
              4. Toggling Full-Screen Command
              
 
              What is affected: Any code using the OS X-specific
 org.eclipse.ui.cocoa.fullscreenWindow command.
 
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html
index 87243c6e2b1..a2c05eedf94 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.7/recommended.html
@@ -24,7 +24,7 @@ 
              Adopting Oxygen (4.7) Mechanisms and APIs
              
 
              
 
 
-
              1. Pre-built Lucene Indexes Should Be Updated
              
+
              1. Pre-built Lucene Indexes Should Be Updated
              
 
              What is affected: Clients supplying pre-built Lucene help indexes.
 
              
 
              Description:
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html
index 233d53877ae..297c25b9b56 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/porting/4.8/recommended.html
@@ -25,7 +25,7 @@ 
              Adopting Photon (4.8) Mechanisms and APIs
              
 
              
 
 
-
              1. Direct Usages of Apache Batik CSS Should Be Upgraded
              
+
              1. Direct Usages of Apache Batik CSS Should Be Upgraded
              
 
              What is affected: Clients directly using Apache Batik CSS bundles version 1.8.0.
 
              
 
              Description:
@@ -40,7 +40,7 @@ 
              1. Direct Usages of Apache Batik CSS Should Be Upgra
 
                
 
              • Upgrade their code to work with Apache Batik CSS version 1.9.0
                • 
 
              
-
              2. Pre-built Lucene Indexes Should Be Updated
              
+
              2. Pre-built Lucene Indexes Should Be Updated
              
 
              What is affected: Clients supplying pre-built Lucene help indexes.
 
              
 
              Description: