-
-
-
-
+
+
+
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 @@
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.
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 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.
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)
-
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:
-
+
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.