From b4c8e0101d10ad30940b05ffce69f71932589e7e Mon Sep 17 00:00:00 2001 From: Patrick Ziegler Date: Tue, 2 Sep 2025 20:57:46 +0200 Subject: [PATCH] Cleanup and migrate remaining "User Assistance" documents to HTML5 This updates and modernizes document elements and translates the styling to CSS. Contributes to https://github.com/eclipse-platform/eclipse.platform.releng.aggregator/issues/3275 --- .../org.eclipse.platform.doc.isv/guide/ua.htm | 9 ++- .../guide/ua_cheatsheet.htm | 9 ++- .../guide/ua_cheatsheet_composite.htm | 58 ++++++++++--------- .../guide/ua_cheatsheet_composite_content.htm | 25 ++++---- .../guide/ua_cheatsheet_guidelines.htm | 9 ++- .../guide/ua_cheatsheet_simple.htm | 41 +++++++------ .../guide/ua_dynamic.htm | 11 ++-- .../guide/ua_dynamic_extensions.htm | 19 +++--- .../guide/ua_dynamic_filters.htm | 26 ++++++--- .../guide/ua_dynamic_includes.htm | 18 +++--- .../guide/ua_intro.htm | 9 ++- .../guide/ua_intro_cust_intro_part.htm | 9 ++- .../guide/ua_intro_cust_static.htm | 9 ++- .../guide/ua_intro_define_content.htm | 9 ++- .../guide/ua_intro_defining.htm | 9 ++- .../guide/ua_intro_defining_config.htm | 11 ++-- .../guide/ua_intro_ext_custom_url.htm | 15 +++-- .../guide/ua_intro_ext_standbypart.htm | 13 ++--- .../guide/ua_intro_ext_theme.htm | 9 ++- .../guide/ua_intro_extending.htm | 9 ++- .../guide/ua_intro_extending_content.htm | 9 ++- .../guide/ua_intro_hello_world.htm | 15 +++-- .../guide/ua_intro_minimal.htm | 9 ++- .../guide/ua_intro_swt_properties.htm | 9 ++- .../guide/ua_intro_universal.htm | 9 ++- .../guide/ua_intro_universal_contributing.htm | 9 ++- .../guide/ua_intro_universal_defaults.htm | 9 ++- .../guide/ua_intro_universal_extending.htm | 9 ++- .../guide/ua_intro_universal_links.htm | 9 ++- .../guide/ua_intro_universal_preference.htm | 9 ++- .../guide/ua_intro_xhtml.htm | 7 +-- .../guide/ua_statushandling.htm | 9 ++- .../guide/ua_statushandling_defining.htm | 9 ++- .../guide/ua_statushandling_sample.htm | 9 ++- 34 files changed, 218 insertions(+), 239 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 efd7bf825ea..742a88848fb 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 @@ -1,11 +1,10 @@ - + - - - - + + + User assistance support 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 9dcea2baa36..8dbf77d6bd1 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 @@ -1,11 +1,10 @@ - + - - - - + + + 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 617e98eba35..ab6db5d335d 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 @@ -1,23 +1,25 @@ - - + + - - - - + "Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page."> + + + Composite cheat sheets - @@ -84,21 +86,21 @@

task is started, There are three possible parameters to a cheat sheet task.

- +
- - - - - - - -
+ Parameter name +  Description
+ id + The id of a cheat sheet which has been registered using the extension point org.eclipse.ui.cheatsheets.cheatSheetContent. This identifies the cheatsheet which will be associated with this task. Either the id @@ -107,10 +109,10 @@

+ path + The URL of a cheat sheet content file. This may be an absolute URL, or relative to the content file for the composite cheat sheet. If both id and path are specified the path will be used to locate the @@ -119,10 +121,10 @@

+ showIntro + A boolean parameter with default value of true. If "false" the cheat sheet when started will initially show the first step rather than the introduction.. @@ -222,18 +224,18 @@

Working - with cheat sheets
+ with cheat sheets
- Working with composite cheat sheets
- Creating cheat sheets
+ Working with composite cheat sheets
+ Creating cheat sheets
- Authoring guidelines
+ Authoring guidelines
Composite cheat sheet - content file specification
+ content file specification
- org.eclipse.ui.cheatsheets.cheatSheetContent extension point
+ org.eclipse.ui.cheatsheets.cheatSheetContent extension point

diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm index 93851c96d15..4594d11be27 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm @@ -1,12 +1,11 @@ - + - - - - - + + + + Composite cheat sheet content file XML format @@ -18,7 +17,7 @@

Since:
3.2
Description:

The schema definition for a composite cheat sheet content file. A composite cheat sheet consists of a set of tasks organized into task groups. Each task can be a simple cheat sheet or a user contributed task kind.

Configuration Markup:
-

<!ELEMENT compositeCheatsheet (taskGroup | task)>

+

<!ELEMENT compositeCheatsheet (taskGroup | task)>

<!ATTLIST compositeCheatsheet

name CDATA #REQUIRED>

@@ -27,7 +26,7 @@

Configuration Markup:
  • name - The name of the composite cheat sheet which will be displayed in large font when the composite cheat sheet is opened.
-

<!ELEMENT taskGroup ((task | taskGroup) , intro? , onCompletion? , dependency*)>

+

<!ELEMENT taskGroup ((task | taskGroup) , intro? , onCompletion? , dependency*)>

<!ATTLIST taskGroup

kind CDATA "set"

name CDATA #REQUIRED

id   CDATA #IMPLIED

skip (true | false) "false">

@@ -39,7 +38,7 @@

Configuration Markup:
  • id - An id for this task group which is required if this task group is referenced by a dependency element.
  • skip - If true this group of tasks may be skipped.
    • -

    <!ELEMENT task (intro? , onCompletion? , param* , dependency*)>

    +

    <!ELEMENT task (intro? , onCompletion? , param* , dependency*)>

    <!ATTLIST task

    kind CDATA #REQUIRED

    name CDATA #REQUIRED

    id   CDATA #IMPLIED

    skip (true | false) "false">

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

    Configuration Markup:
  • id - An id for this task group which is required if this task group is referenced by a dependency element.
  • skip - If true this task may be skipped.
    • -

    <!ELEMENT param EMPTY>

    +

    <!ELEMENT param EMPTY>

    <!ATTLIST param

    name  CDATA #REQUIRED

    value CDATA #REQUIRED>

    @@ -61,15 +60,15 @@

    Configuration Markup:
  • name - The name of this parameter.
  • value - The value of this parameter.
    • -

    <!ELEMENT intro (#PCDATA)>

    +

    <!ELEMENT intro (#PCDATA)>

    Contains the text which will be displayed before this task has been started. May contain form text markup.



    -

    <!ELEMENT onCompletion (#PCDATA)>

    +

    <!ELEMENT onCompletion (#PCDATA)>

    Contains the text which will be displayed in the completion panel for this task. May contain form text markup.



    -

    <!ELEMENT dependency EMPTY>

    +

    <!ELEMENT dependency EMPTY>

    <!ATTLIST dependency

    task CDATA #REQUIRED>

    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 68d9177a429..339534dad5d 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 @@ -1,11 +1,10 @@ - + - - - - + + + Cheat sheet authoring guidelines 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 6714e0db82f..d478d023da0 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 @@ -1,12 +1,15 @@ - + - - - - + + + Simple cheat sheets + @@ -52,20 +55,20 @@

    list. A category for the cheat sheet can also be defined if you want to place several cheat sheets into a logical grouping. If no category is specified, the cheat sheet will appear in the Other category. -

    -Cheat sheet dialog

    +

    +Cheat sheet dialog

    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 -the use of the $nl$ variable in the directory name, which means the file will be located in a directory specific +the use of the $nl$ variable in the directory name, which means the file will be located in a directory specific to the national language of the target environment.)

    The file format itself includes overview information about the cheat sheet followed by a description of each step (called an item) that the user will perform. At its simplest, an item is just a detailed description of the step that the user should take. However, an item can also specify an action that can be run to perform the step on behalf of the -user. Let's look at the first part of the content file (HelloWorld.xml) +user. Let's look at the first part of the content file (HelloWorld.xml) for the Java cheat sheet. 

    <?xml version="1.0" encoding="UTF-8" ?> 
@@ -93,8 +96,8 @@ 
    Cheat Sheet Items
    
 </item>
 ...
    -

    -Simple java cheat sheet +

    +Simple java cheat sheet

    The title and intro information are shown at the top of the cheat sheet. Then, the items are described. @@ -150,7 +153,7 @@

    Conditional Expressions and Cheat Sheet Variables

    particular condition being true. Conditions are described in the condition element of a subitem using arbitrary string values that are matched against the when attribute for each choice. Conditions typically reference cheat sheet -variables using the form ${var}, where var refers to the name of a cheet sheet variable. +variables using the form ${var}, where var refers to the name of a cheet sheet variable. A few simple examples will help demonstrate how conditional expressions work.

    @@ -165,9 +168,9 @@

    Conditional Expressions and Cheat Sheet Variables

    </conditional-subitem> </item> -This item specifies two possible subitems that depend on the value of the variable v1. -If the variable value is a, then the first subitem will be included. If the variable value -is b, then the second subitem will be included. If the variable is neither value, it is considered +This item specifies two possible subitems that depend on the value of the variable v1. +If the variable value is a, then the first subitem will be included. If the variable value +is b, then the second subitem will be included. If the variable is neither value, it is considered an error.

    Conditional actions are similar to conditional subitems. The perform-when element specifies @@ -182,11 +185,11 @@

    Conditional Expressions and Cheat Sheet Variables

    </perform-when> </item> -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. +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 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 +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 by commas. A variable that expands into a list of values may be used in the values attribute. For example: @@ -197,7 +200,7 @@

    Repeated Subitems

    </repeated-subitem> </item> -If the value of the variable is 1,b,three, then three subitems will appear in the cheat sheet, each +If the value of the variable is 1,b,three, then three subitems will appear in the cheat sheet, each having a unique label ("Step 1," "Step b," "Step three"). The variable can be used in the label or the action paramater value. It can also be accessed from the ICheatSheetManager 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 d18239f187b..2ddcbf155d2 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 @@ -1,14 +1,13 @@ - + - - - - + + + Dynamic content - @@ -45,7 +53,7 @@

    System Tests

    below:

    - +
    Property @@ -165,7 +173,7 @@

    Property Tests

    components. The table below shows some common properties you can test by:

    - +
    Property @@ -320,7 +328,7 @@

    Filter Attributes/Elements (deprecated)

    their possible values for use with filter elements and attributes.

    (deprecated) - +
    Property 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 1682b3dca7e..9048d94ef9f 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 @@ -1,21 +1,17 @@ - - + + - - - - Includes - @@ -57,7 +60,7 @@

    Contributing a HelloWorld Intro Part

    The third and last step is to make sure you run the correct product. For example, if you are self hosting, create a new runtime-workbench launch configuration, choose the "Run a product" option, and select org.eclipse.ui.intro.HelloWorld_product from the dropdown.
    This is what you will see if you run the above HelloWorld sample:

    -

    Image of a basic intro part

    +

    Image of a basic intro part

    Note that the intro part is in control of the full real-estate of the window. A more elaborate intro part can be created that interacts with the workbench and progressively reveals the functionality of the product.

    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 f062b3466a6..a8512c877b0 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 @@ -1,11 +1,10 @@ - + - - - - + + + Defining intro content diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_swt_properties.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_swt_properties.htm index b07c919de65..580920f19e9 100644 --- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_swt_properties.htm +++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_intro_swt_properties.htm @@ -1,11 +1,10 @@ - + - - - - + + + SWT Properties for Intro 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 f6ebd0fdb9e..ccf6ef63cd9 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 @@ -1,11 +1,10 @@ - + - - - - + + + Universal intro 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 442e415a161..8a03d186c07 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 @@ -1,11 +1,10 @@ - + - - - - + + + Contributing to universal intro 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 36161b10139..5e70eefd495 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 @@ -1,11 +1,10 @@ - + - - - - + + + Configuring product defaults 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 2d426d20199..82e59856979 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 @@ -1,11 +1,10 @@ - + - - - - + + + Extending the universal intro 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 5f1d8cfad39..2011f8c5d5a 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 @@ -1,11 +1,10 @@ - + - - - - + + + Managing links 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 d07539271f8..fe04783bee5 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 @@ -1,11 +1,10 @@ - + - - - - + + + Adding the preference page 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 d8e9c48ceb9..b2c6dd71b23 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 @@ -1,10 +1,9 @@ - + - - - + + Using XHTML as intro content 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 3f73bbaee85..a78a0c8e41f 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 @@ -1,11 +1,10 @@ - + - - - - + + + Status handling 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 9d4cb1016c1..d62b640b483 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 @@ -1,11 +1,10 @@ - + - - - - + + + Defining a product status handler 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 04fb9b9c132..ae5ca09f4b8 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 @@ -1,11 +1,10 @@ - + - - - - + + + Contributing a sample handler