Skip to content

Commit bad2032

Browse files
ptzieglerakurtakov
ptziegler
authored and
akurtakov
committed
Cleanup and migrate "User Assistance Help" documents to HTML5
This primarily cleans up the document header and migrates some of the deprecated elements. Contributes to eclipse-platform#3275
1 parent 38618de commit bad2032

38 files changed

+227
-255
lines changed

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Help</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3-
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
1+
<!DOCTYPE html>
2+
<html lang="en">
43
<head>
54
<meta name="copyright" content=
6-
"Copyright (c) IBM Corporation and others 2010, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." />
7-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
<meta http-equiv="Content-Style-Type" content="text/css" />
9-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type=
10-
"text/css" />
11-
<script language="JavaScript" src=
12-
"PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript">
13-
</script>
5+
"Copyright (c) IBM Corporation and others 2010, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page.">
6+
<meta charset="utf-8">
7+
<link rel="STYLESHEET" href="../book.css" type="text/css">
8+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
149
<title>
1510
Using AbstractHelpScope to filter an information center
1611
</title>
@@ -39,7 +34,7 @@ <h2>
3934
by opening an infocenter with a url of this form:
4035
</p>
4136
<pre>
42-
http://&lt;host&gt;:&lt;port&gt;/help/index.jsp?scope=myId
37+
https://&lt;host&gt;:&lt;port&gt;/help/index.jsp?scope=myId
4338
</pre>This will present an infocenter which shows only those topics which fall
4439
within the scope myId.
4540
<p>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Help content</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2021. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Active help</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_action.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Writing the help action</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_debug.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Tips for debugging active help</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_active_invoke.htm‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Invoking the action from HTML</title>
109
</head>
1110
<body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_child_links.htm‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3-
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
1+
<!DOCTYPE html>
2+
<html lang="en">
43
<head>
54
<meta name="copyright" content=
6-
"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." />
7-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8-
<meta http-equiv="Content-Style-Type" content="text/css" />
9-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type=
10-
"text/css" />
5+
"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.">
6+
<meta charset="utf-8">
7+
<link rel="STYLESHEET" href="../book.css" type="text/css">
118
<title>
129
Adding Child Links to Help Pages
1310
</title>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command.htm‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Embedding commands in help</title>
109
</head>
1110
<body>
@@ -121,9 +120,9 @@ <h2>Embedding Commands in Help</h2>
121120

122121
<p>
123122
If you want to define your own commands, refer to the documentation for the
124-
<a href="../reference/api/org/eclipse/core/commands/package-summary.html"><tt>org.eclipse.core.commands</tt></a> API package
125-
and the <a href="../reference/extension-points/org_eclipse_ui_commands.html"><tt>org.eclipse.ui.commands</tt></a> and
126-
<a href="../reference/extension-points/org_eclipse_ui_handlers.html"><tt>org.eclipse.ui.handlers</tt></a> extension-points.
123+
<a href="../reference/api/org/eclipse/core/commands/package-summary.html"><code>org.eclipse.core.commands</code></a> API package
124+
and the <a href="../reference/extension-points/org_eclipse_ui_commands.html"><code>org.eclipse.ui.commands</code></a> and
125+
<a href="../reference/extension-points/org_eclipse_ui_handlers.html"><code>org.eclipse.ui.handlers</code></a> extension-points.
127126
</p>
128127

129128
</body>

‎eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/ua_help_content_command_authoring.htm‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
1+
<!DOCTYPE HTML>
22
<html lang="en">
33
<head>
44
<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." >
5-
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6-
<meta http-equiv="Content-Style-Type" content="text/css">
7-
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
8-
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
5+
<meta charset="utf-8">
6+
<link rel="STYLESHEET" href="../book.css" type="text/css">
7+
<script src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script>
98
<title>Authoring a command link</title>
109
</head>
1110
<body>
@@ -42,7 +41,7 @@ <h2>Authoring a Command Link</h2>
4241
<P>
4342
The example above shows the bare minimum required to embed a command in an HTML link.
4443
The Eclipse documentation supplements this with two extra pieces of information.
45-
First a <tt>class</tt> attribute is specified to allow for tuning the look of the link
44+
First a <code>class</code> attribute is specified to allow for tuning the look of the link
4645
via CSS. Second, an image tag is included before the link text. The image serves
4746
to distinguish command links from ordinary links to other HTML pages. Supplementing
4847
our initial example with these two extra features will look like this:
@@ -54,7 +53,7 @@ <h2>Authoring a Command Link</h2>
5453

5554
<P>
5655
In the examples above, the About dialog command does not require any parameters, so the
57-
serialization is merely its command id: <tt>org.eclipse.ui.help.aboutAction</tt>.
56+
serialization is merely its command id: <code>org.eclipse.ui.help.aboutAction</code>.
5857
Below is another example showing a command with a parameter. Note the command id is
5958
followed by the parameter id and value in parentheses:
6059
</P>

0 commit comments

Comments
 (0)