Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKonrad Kolosowski2002-10-28 17:21:39 +0000
committerKonrad Kolosowski2002-10-28 17:21:39 +0000
commit043b494f60d9aa6476da518accebe0155a757a3c (patch)
tree6c3a5a09fb7ccf2e63b94eb4c84d4829f3856405
parentcd6bdde764f1bcf79d6eb0a1913fc14104835d85 (diff)
downloadeclipse.platform.ua-043b494f60d9aa6476da518accebe0155a757a3c.tar.gz
eclipse.platform.ua-043b494f60d9aa6476da518accebe0155a757a3c.tar.xz
eclipse.platform.ua-043b494f60d9aa6476da518accebe0155a757a3c.zip
*** empty log message ***
-rw-r--r--org.eclipse.help/src/org/eclipse/help/internal/protocols/URLHandler.java7
-rw-r--r--org.eclipse.help/src/org/eclipse/help/internal/standalone/StandaloneHelp.java2
-rw-r--r--org.eclipse.help/src/org/eclipse/help/standalone/Help.java11
-rw-r--r--org.eclipse.help/src/org/eclipse/help/standalone/Infocenter.java16
-rw-r--r--org.eclipse.help/src/org/eclipse/help/standalone/package.html46
5 files changed, 29 insertions, 53 deletions
diff --git a/org.eclipse.help/src/org/eclipse/help/internal/protocols/URLHandler.java b/org.eclipse.help/src/org/eclipse/help/internal/protocols/URLHandler.java
index e25eb2144..314e74e9f 100644
--- a/org.eclipse.help/src/org/eclipse/help/internal/protocols/URLHandler.java
+++ b/org.eclipse.help/src/org/eclipse/help/internal/protocols/URLHandler.java
@@ -13,12 +13,9 @@ public class URLHandler extends URLStreamHandler {
super();
}
/**
- * @see URLStreamHandler#openConnection(URL)
+ * @see java.net.URLStreamHandler#openConnection(java.net.URL)
*/
- public URLConnection openConnection(URL url) throws IOException {
- // Note: openConnection() method is made public (rather than protected)
- // to enable request delegation from proxy handlers
-
+ protected URLConnection openConnection(URL url) throws IOException {
String protocol = url.getProtocol();
if (protocol.equals("help"))
return new HelpURLConnection(url);
diff --git a/org.eclipse.help/src/org/eclipse/help/internal/standalone/StandaloneHelp.java b/org.eclipse.help/src/org/eclipse/help/internal/standalone/StandaloneHelp.java
index 5ce00248e..e71311811 100644
--- a/org.eclipse.help/src/org/eclipse/help/internal/standalone/StandaloneHelp.java
+++ b/org.eclipse.help/src/org/eclipse/help/internal/standalone/StandaloneHelp.java
@@ -74,7 +74,7 @@ public class StandaloneHelp extends EclipseController {
}
/**
- * @see org.org.eclipse.help.standalone.Help#displayContextInfopop(java.lang.String,int,int)
+ * @see org.eclipse.help.standalone.Help#displayContextInfopop(java.lang.String,int,int)
*/
public void displayContextInfopop(String contextId, int x, int y) {
}
diff --git a/org.eclipse.help/src/org/eclipse/help/standalone/Help.java b/org.eclipse.help/src/org/eclipse/help/standalone/Help.java
index 56065e2f4..2123bdf13 100644
--- a/org.eclipse.help/src/org/eclipse/help/standalone/Help.java
+++ b/org.eclipse.help/src/org/eclipse/help/standalone/Help.java
@@ -11,9 +11,9 @@ import org.eclipse.help.internal.standalone.StandaloneHelp;
/**
* This is a standalone help system. It takes care of
- * launching the eclipse with its help system implementation,
+ * launching the Eclipse with its help system implementation,
* and controling it.
- * This class can be used instantiated and used in a Java program,
+ * This class can be instantiated and used in a Java program,
* or can be launched from command line to execute single help action.
*
* Usage as a Java component:
@@ -43,6 +43,7 @@ public class Help {
/**
* This contstructs the stand alone help.
* @param pluginsDir directory containing Eclipse plugins
+ * @deprecated use Help#Help(String[])
*/
public Help(String pluginsDir) {
File plugins = new File(pluginsDir);
@@ -58,13 +59,13 @@ public class Help {
help = new StandaloneHelp(args);
}
/**
- * Starts the help system.
+ * Starts the stand alone help system.
*/
public void start() {
help.start();
}
/**
- * Shuts-down the help system.
+ * Shuts-down the stand alone help system.
*/
public void shutdown() {
help.shutdown();
@@ -106,7 +107,7 @@ public class Help {
/**
* Controls standalone help system from command line.
- * @param args array of String containng options
+ * @param args array of String containing options
* Options are:
* <code>-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [platform options] [-vmargs [Java VM arguments]]</code>
* where
diff --git a/org.eclipse.help/src/org/eclipse/help/standalone/Infocenter.java b/org.eclipse.help/src/org/eclipse/help/standalone/Infocenter.java
index b0eabae3d..fa96b69aa 100644
--- a/org.eclipse.help/src/org/eclipse/help/standalone/Infocenter.java
+++ b/org.eclipse.help/src/org/eclipse/help/standalone/Infocenter.java
@@ -7,16 +7,16 @@ package org.eclipse.help.standalone;
import org.eclipse.help.internal.standalone.StandaloneInfocenter;
/**
- * This program is used to start or stop Eclipse
- * Infocenter application.
- * This class can be used instantiated and used in a Java program,
+ * This is a standalone infocenter. It takes care of
+ * launching the Eclipse with its help system implementation.
+ * This class can be instantiated and used in a Java program,
* or can be launched from command line.
*
* Usage as a Java component:
* <ul>
* <li> create an instantance of this class</li>
- * <li> call start() </li>
- * <li> infocenter will run, when no longer needed call shutdown(). </li>
+ * <li> call start(), infocenter will run </li>
+ * <li> when no longer needed call shutdown(). </li>
* </ul>
*/
public class Infocenter {
@@ -34,20 +34,20 @@ public class Infocenter {
infocenter = new StandaloneInfocenter(options);
}
/**
- * Starts the infocenter application.
+ * Starts the stand alone infocenter.
*/
public void start() {
infocenter.start();
}
/**
- * Shuts-down the infocenter application.
+ * Shuts-down the stand alone infocenter.
*/
public void shutdown() {
infocenter.shutdown();
}
/**
* Controls start up and shut down of infocenter from command line.
- * @param args array of String containng options
+ * @param args array of String containing options
* Options are:
* <code>-command start | shutdown [-eclipsehome eclipseInstallPath] [platform options] [-vmargs [Java VM arguments]]</code>
* where
diff --git a/org.eclipse.help/src/org/eclipse/help/standalone/package.html b/org.eclipse.help/src/org/eclipse/help/standalone/package.html
index 19caf6bf3..48c33ba33 100644
--- a/org.eclipse.help/src/org/eclipse/help/standalone/package.html
+++ b/org.eclipse.help/src/org/eclipse/help/standalone/package.html
@@ -7,43 +7,21 @@
<title>Package-level Javadoc</title>
</head>
<body>
-Provides access to stand alone help system.&nbsp;
+Provides access to infocenter and stand alone help system.&nbsp;
Classes in this package are not supposed to be called by Eclipse plugins,
they are intended to be called from outside of Eclipse environment.
<h2>
-Package Specification</h2>
-The help system in Eclipse can be used by other products.&nbsp; Access
-to this help system is provided through <tt>org.eclipse.help.standalone.Help
-</tt>class.
-<p>This Help class should be placed on the application class path, and
-methods of the Help class provide means or launching help.&nbsp; There
+Package Specification</h2>The help system in Eclipse can be used to run an information center or as a stand alone help system for use by other products.&nbsp; Access
+to the help system is provided
+<TT>org.eclipse.help.standalone.Infocenter </TT> and
+<TT>org.eclipse.help.standalone.Help </TT>
+classes.
+<P>To start or stop the infocenter, use the Infocenter class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.</P>
+<p>To start, stop the stand alone help system or cause it to display help on a user machine, use the Help class. The class can be used as a stand alone program, launched from a command line, or can be instantiated and used from a Java program.</P>
+<P>There
is a general mechanism (defined at the plug-in level) by which individual
-plug-ins contribute online help and context-sensitive help for their component.
-This Eclipse mechanism for contributing help content need to be used.&nbsp;
+plug-ins contribute on-line help and context-sensitive help for their component.
+This Eclipse mechanism for contributing help content needs to be used.&nbsp;
The stand alone help system is responsible for accessing this information
-and displaying it to the user.
-<p>The use of the stand-alone help system involves:
-<ul>
-<li>
-Placing the <tt>Help</tt> class from this package on the application class
-path.</li>
-
-<li>
-Instantiation of the H<tt>elp</tt> class, providing name of the directory
-where Eclipse and documentation plugins reside.</li>
-
-<li>
-Calling methods of H<tt>elp</tt> class to start help.</li>
-
-<li>
-Calling methods of H<tt>elp</tt> class to display help.&nbsp; The call
-can be repeated multiple times as needed.</li>
-
-<li>
-Calling methods of H<tt>elp</tt> class to shut down help.</li>
-</ul>
-
-<br>&nbsp;
-<br>&nbsp;
-</body>
+and displaying it to the user. The infocenter, unlike the stand alone help system, does not launch UI on the machine that it is running on. When infocenter is started the help content can be obtained by connecting to a help server (port specified in help plugin preferences) using HTTP connection.</P></body>
</html>

Back to the top