Skip to content

Cleanup and migrate remaining "User Assistance" documents to HTML5 #3298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2025
Merged

Cleanup and migrate remaining "User Assistance" documents to HTML5 #3298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="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." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>User assistance support</title>
</head>
<body>
Expand Down
9 changes: 4 additions & 5 deletions eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="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." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>Cheat sheets</title>
</head>
<body>
Expand Down
58 changes: 30 additions & 28 deletions ...se.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="copyright" content=
"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." />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type=
"text/css" />
<script language="JavaScript" src=
"PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript">
</script>
"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.">
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>
Composite cheat sheets
</title>

<style type="text/css">
<style>
/*<![CDATA[*/
table.c1 {border-collapse: collapse}
table.c1 {
border-collapse: collapse;
border-spacing: 0;
}
table, tr, td { border: 1px solid; }
td { padding: 0 }
td.name { width: 10%; }
td.desc { width: 29%; }
/*]]>*/
</style>
</head>
Expand Down Expand Up @@ -84,21 +86,21 @@ <h3>
task is started, There are three possible parameters to a cheat sheet
task.
</p>
<table border="1" cellpadding="0" cellspacing="0" class="c1">
<table class="c1">
<tr>
<td width="10%">
<td class="name">
Parameter name
</td>

<td width="29%">
<td class="desc">
&nbsp;Description
</td>
</tr>
<tr>
<td width="10%">
<td class="name">
id
</td>
<td width="29%">
<td class="desc">
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
Expand All @@ -107,10 +109,10 @@ <h3>

</tr>
<tr>
<td width="10%">
<td class="name">
path
</td>
<td width="29%">
<td class="desc">
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
Expand All @@ -119,10 +121,10 @@ <h3>
</tr>
<tr>

<td width="10%">
<td class="name">
showIntro
</td>
<td width="29%">
<td class="desc">
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..
Expand Down Expand Up @@ -222,18 +224,18 @@ <h3>
<p>
<a href=
"../../org.eclipse.platform.doc.user/reference/ref-cheatsheets.htm">Working
with cheat sheets</a><br />
with cheat sheets</a><br>
<a href=
"../../org.eclipse.platform.doc.user/reference/ref-composite-cheatsheets.htm">
Working with composite cheat sheets</a><br />
<a href="ua_cheatsheet_simple.htm">Creating cheat sheets</a><br />
Working with composite cheat sheets</a><br>
<a href="ua_cheatsheet_simple.htm">Creating cheat sheets</a><br>

<a href="ua_cheatsheet_guidelines.htm">Authoring guidelines</a><br />
<a href="ua_cheatsheet_guidelines.htm">Authoring guidelines</a><br>
<a href="ua_cheatsheet_composite_content.htm">Composite cheat sheet
content file specification</a><br />
content file specification</a><br>
<a href=
"../reference/extension-points/org_eclipse_ui_cheatsheets_cheatSheetContent.html">
org.eclipse.ui.cheatsheets.cheatSheetContent extension point</a><br />
org.eclipse.ui.cheatsheets.cheatSheetContent extension point</a><br>
</p>
</body>
</html>
25 changes: 12 additions & 13 deletions ...orm.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_composite_content.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="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." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<link rel="stylesheet" href="../schema.css" charset="utf-8" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<link rel="stylesheet" href="../schema.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>Composite cheat sheet content file XML format</title>
</head>
<body>
Expand All @@ -18,7 +17,7 @@ <h6 class="CaptionFigColumn">Since: </h6>3.2

<h6 class="CaptionFigColumn">Description: </h6><p>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.</p>
<h6 class="CaptionFigColumn">Configuration Markup:</h6>
<p class="SchemaDtd">&lt;!ELEMENT <a name="e.compositeCheatsheet">compositeCheatsheet</a> (<a href="#e.taskGroup">taskGroup</a> | <a href="#e.task">task</a>)&gt;</p>
<p class="SchemaDtd" id="e.compositeCheatsheet">&lt;!ELEMENT compositeCheatsheet (<a href="#e.taskGroup">taskGroup</a> | <a href="#e.task">task</a>)&gt;</p>
<p class="SchemaDtd">&lt;!ATTLIST compositeCheatsheet</p>
<p class="SchemaDtdAttlist">name&nbsp;CDATA #REQUIRED&gt;</p>
<p class="ConfigMarkupElementDesc">
Expand All @@ -27,7 +26,7 @@ <h6 class="CaptionFigColumn">Configuration Markup:</h6>
<ul class="ConfigMarkupAttlistDesc">
<li><b>name</b> - The name of the composite cheat sheet which will be displayed in large font when the composite cheat sheet is opened.</li>
</ul>
<br><p class="SchemaDtd">&lt;!ELEMENT <a name="e.taskGroup">taskGroup</a> ((<a href="#e.task">task</a> | <a href="#e.taskGroup">taskGroup</a>) , <a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.dependency">dependency</a>*)&gt;</p>
<br><p class="SchemaDtd" id="e.taskGroup">&lt;!ELEMENT taskGroup ((<a href="#e.task">task</a> | <a href="#e.taskGroup">taskGroup</a>) , <a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.dependency">dependency</a>*)&gt;</p>
<p class="SchemaDtd">&lt;!ATTLIST taskGroup</p>
<p class="SchemaDtdAttlist">kind&nbsp;CDATA "set"</p><p class="SchemaDtdAttlist">name&nbsp;CDATA #REQUIRED</p><p class="SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="SchemaDtdAttlist">skip&nbsp;(true | false) "false"&gt;</p>
<p class="ConfigMarkupElementDesc">
Expand All @@ -39,7 +38,7 @@ <h6 class="CaptionFigColumn">Configuration Markup:</h6>
<li><b>id</b> - An id for this task group which is required if this task group is referenced by a dependency element.</li>
<li><b>skip</b> - If true this group of tasks may be skipped.</li>
</ul>
<br><p class="SchemaDtd">&lt;!ELEMENT <a name="e.task">task</a> (<a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.param">param</a>* , <a href="#e.dependency">dependency</a>*)&gt;</p>
<br><p class="SchemaDtd" id="e.task">&lt;!ELEMENT task (<a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.param">param</a>* , <a href="#e.dependency">dependency</a>*)&gt;</p>
<p class="SchemaDtd">&lt;!ATTLIST task</p>
<p class="SchemaDtdAttlist">kind&nbsp;CDATA #REQUIRED</p><p class="SchemaDtdAttlist">name&nbsp;CDATA #REQUIRED</p><p class="SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="SchemaDtdAttlist">skip&nbsp;(true | false) "false"&gt;</p>
<p class="ConfigMarkupElementDesc">
Expand All @@ -51,7 +50,7 @@ <h6 class="CaptionFigColumn">Configuration Markup:</h6>
<li><b>id</b> - An id for this task group which is required if this task group is referenced by a dependency element.</li>
<li><b>skip</b> - If true this task may be skipped.</li>
</ul>
<br><p class="SchemaDtd">&lt;!ELEMENT <a name="e.param">param</a> EMPTY&gt;</p>
<br><p class="SchemaDtd" id="e.param">&lt;!ELEMENT param EMPTY&gt;</p>
<p class="SchemaDtd">&lt;!ATTLIST param</p>
<p class="SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #REQUIRED</p><p class="SchemaDtdAttlist">value&nbsp;CDATA #REQUIRED&gt;</p>
<p class="ConfigMarkupElementDesc">
Expand All @@ -61,15 +60,15 @@ <h6 class="CaptionFigColumn">Configuration Markup:</h6>
<li><b>name</b> - The name of this parameter.</li>
<li><b>value</b> - The value of this parameter.</li>
</ul>
<br><p class="SchemaDtd">&lt;!ELEMENT <a name="e.intro">intro</a> (#PCDATA)&gt;</p>
<br><p class="SchemaDtd" id="e.intro">&lt;!ELEMENT intro (#PCDATA)&gt;</p>
<p class="ConfigMarkupElementDesc">
Contains the text which will be displayed before this task has been started. May contain form text markup.</p>
<br><br>
<p class="SchemaDtd">&lt;!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)&gt;</p>
<p class="SchemaDtd" id="e.onCompletion">&lt;!ELEMENT onCompletion (#PCDATA)&gt;</p>
<p class="ConfigMarkupElementDesc">
Contains the text which will be displayed in the completion panel for this task. May contain form text markup.</p>
<br><br>
<p class="SchemaDtd">&lt;!ELEMENT <a name="e.dependency">dependency</a> EMPTY&gt;</p>
<p class="SchemaDtd" id="e.dependency">&lt;!ELEMENT dependency EMPTY&gt;</p>
<p class="SchemaDtd">&lt;!ATTLIST dependency</p>
<p class="SchemaDtdAttlist">task&nbsp;CDATA #REQUIRED&gt;</p>
<p class="ConfigMarkupElementDesc">
Expand Down
9 changes: 4 additions & 5 deletions ...e.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_guidelines.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="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." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>Cheat sheet authoring guidelines</title>
</head>
<body>
Expand Down
41 changes: 22 additions & 19 deletions eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_cheatsheet_simple.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="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." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>Simple cheat sheets</title>
<style>
img { border: 0; }
p.center { text-align: center; }
</style>
</head>
<body>

Expand Down Expand Up @@ -52,20 +55,20 @@ <h4>
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 <b>Other</b> category.
<p align="center">
<img border="0" src="images/cheatsheets.png" alt="Cheat sheet dialog"></p>
<p class="center">
<img src="images/cheatsheets.png" alt="Cheat sheet dialog"></p>
<h4>Cheat Sheet Items</h4>
<p>
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 <b>contentFile</b> attribute. The path for the file is relative to the plug-in's directory. (Note
the use of the <tt>$nl$</tt> variable in the directory name, which means the file will be located in a directory specific
the use of the <code>$nl$</code> variable in the directory name, which means the file will be located in a directory specific
to the national language of the target environment.)
</p>
<p>The file format itself includes overview information about the cheat sheet followed
by a description of each step (called an <i>item</i>) 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 (<tt>HelloWorld.xml</tt>)
user. Let's look at the first part of the content file (<code>HelloWorld.xml</code>)
for the Java cheat sheet.
</p>
<pre>&lt;?xml version="1.0" encoding="UTF-8" ?&gt;
Expand Down Expand Up @@ -93,8 +96,8 @@ <h4>Cheat Sheet Items</h4>
&lt;/item&gt;
...
</pre>
<p align="center">
<img border="0" src="images/javacheatsheet.png" alt="Simple java cheat sheet">
<p class="center">
<img src="images/javacheatsheet.png" alt="Simple java cheat sheet">
</p>
<p>
The title and intro information are shown at the top of the cheat sheet. Then, the items are described.
Expand Down Expand Up @@ -150,7 +153,7 @@ <h4>Conditional Expressions and Cheat Sheet Variables</h4>
particular condition being true. Conditions are described in the <b>condition</b> element of a subitem
using arbitrary string values that are matched
against the <b>when</b> attribute for each choice. Conditions typically reference cheat sheet
variables using the form <tt>${<i>var</i>}</tt>, where <i>var</i> refers to the name of a cheet sheet variable.
variables using the form <code>${<i>var</i>}</code>, where <i>var</i> refers to the name of a cheet sheet variable.
A few simple examples will help demonstrate how conditional expressions work.
</p>
<p>
Expand All @@ -165,9 +168,9 @@ <h4>Conditional Expressions and Cheat Sheet Variables</h4>
&lt;/conditional-subitem&gt;
&lt;/item&gt;
</pre>
This item specifies two possible subitems that depend on the value of the variable <tt>v1</tt>.
If the variable value is <tt>a</tt>, then the first subitem will be included. If the variable value
is <tt>b</tt>, 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 <code>v1</code>.
If the variable value is <code>a</code>, then the first subitem will be included. If the variable value
is <code>b</code>, then the second subitem will be included. If the variable is neither value, it is considered
an error.
<p>
<b>Conditional actions</b> are similar to conditional subitems. The <b>perform-when</b> element specifies
Expand All @@ -182,11 +185,11 @@ <h4>Conditional Expressions and Cheat Sheet Variables</h4>
&lt;/perform-when&gt;
&lt;/item&gt;
</pre>
The action to be performed is chosen based on the value of the <tt>v1</tt> variable. If the variable
value is neither <tt>a</tt> or <tt>b</tt>, it is considered an error.
The action to be performed is chosen based on the value of the <code>v1</code> variable. If the variable
value is neither <code>a</code> or <code>b</code>, it is considered an error.
<h4>Repeated Subitems</h4>
<p>Repeated subitems describe a subitem that can can expand into 0, 1, or more similar substeps. The
substeps are individualized using the special variable <tt>${this}</tt>. This variable will be replaced by
substeps are individualized using the special variable <code>${this}</code>. This variable will be replaced by
the values specified in the <b>values</b> 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:
Expand All @@ -197,7 +200,7 @@ <h4>Repeated Subitems</h4>
&lt;/repeated-subitem&gt;
&lt;/item&gt;
</pre>
If the value of the variable is <tt>1,b,three</tt>, then three subitems will appear in the cheat sheet, each
If the value of the variable is <code>1,b,three</code>, 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
<a href="../reference/api/org/eclipse/ui/cheatsheets/ICheatSheetManager.html"><b>ICheatSheetManager</b></a>
Expand Down
11 changes: 5 additions & 6 deletions eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_dynamic.htm
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<meta charset="utf-8">
<link rel="STYLESHEET" href="../book.css" type="text/css">
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
<title>Dynamic content</title>

<style type="text/css">
<style>
.highlight {
color: blue;
}
Expand Down
Loading
Loading