| 3 |
<head> |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| 5 |
<meta name="Author" content="eclipse.org"> |
<meta name="Author" content="eclipse.org"> |
|
<meta name="GENERATOR" content= |
|
|
"Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]"> |
|
| 6 |
<title> |
<title> |
| 7 |
Standalone |
Installing Standalone Help |
| 8 |
</title> |
</title> |
| 9 |
<link rel="stylesheet" href="default_style.css" type="text/css"> |
<link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css"> |
| 10 |
</head> |
</head> |
| 11 |
<body> |
<body> |
| 12 |
<p> |
|
| 13 |
|
<h1 style="background:#0080C0;color:#ffffff;">Installing the stand-alone help system</h1> |
| 14 |
</p> |
<p>If you are creating an application that is not based on |
| 15 |
<table border="0" cellspacing="5" cellpadding="2" width="100%"> |
the Eclipse framework, you can still use the Eclipse help system. Your |
| 16 |
<tr> |
application can package and install the stand-alone help system, a very small |
| 17 |
<td align="LEFT" valign="TOP" colspan="2" bgcolor="#0080C0"> |
version of Eclipse that has had everything except the help system stripped out |
| 18 |
<b><font face="Arial,Helvetica"><font color= |
of it. Then, your application can make API calls from its Help menu, or from UI |
| 19 |
"#FFFFFF">Stand-alone</font></font></b> |
objects, to launch the help browser. The stand-alone help system has all the |
| 20 |
</td> |
features of the integrated help system, except infopops and active help. </p> |
| 21 |
</tr> |
<h2><b>Installation/packaging</b> </h2> |
| 22 |
<tr> |
These steps are for the help system |
| 23 |
<td> |
integrator and are not meant to address all the possible scenarios. It is |
| 24 |
Stand-alone (local) - If you are creating an application that is |
assumed that the launching application is in Java, and that |
| 25 |
not based on the Eclipse framework, you can still use the |
all your documentation is delivered as Eclipse plug-ins and, in general, you are |
| 26 |
Eclipse help system. Your application can package and install |
familiar with the eclipse help system. |
|
the stand-alone help system, a very small version of Eclipse |
|
|
that has had everything except the help system stripped out of |
|
|
it. Then, your application can make API calls from its Help |
|
|
menu, or from UI objects, to launch the help browser. The |
|
|
stand-alone help system has all the features of the integrated |
|
|
help system, as described in the following sections. However, it |
|
|
interacts with the application UI for features such as |
|
|
context-sensitive help or active help will vary. All features |
|
|
except infopops and active help are supported. |
|
|
<p> |
|
|
<b>Installation/packaging</b> |
|
|
</p> |
|
| 27 |
<ol> |
<ol> |
| 28 |
<li style="list-style: none"> |
<li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver from |
| 29 |
These steps are for the help system integrator and are not |
<a target="_blank" href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li> |
| 30 |
meant to address all the possible scenarios. It is |
<li>Install (unzip) the driver under your application directory, for |
| 31 |
asssumed that you have java application that requires launching |
example, <var>d:\myApp</var>. This will create an eclipse subdirectory, d:\myApp\eclipse that |
| 32 |
help, and that all your documentation is delivered as |
contains the code required for the Eclipse platform (which includes the help |
| 33 |
plugins and, in general, you are familiar with the eclipse |
system). </li> |
|
help system. |
|
|
</li> |
|
|
<li> |
|
|
Install (unzip) Eclipse 2.0 driver under your applicatin directory, |
|
|
say, d:\myApp\. This will create an eclipse subdirectory, d:\myApp\eclipse |
|
|
that contains the plugins directory, etc. |
|
|
</li> |
|
|
<li> |
|
|
Optionally, until a trimmed down version of the stand-alone packaging is |
|
|
provided, you can remove most of the plugins, and leave only org.apache.xerces, |
|
|
org.apache.lucene, org.eclipse.core.boot, org.eclipse.core.runtime, org.eclipse.help, |
|
|
org.eclipse.help.ui, org.eclipse.help.webapp, org.eclipse.ui, org.eclipse.swt and |
|
|
org.eclipse.tomcat. |
|
|
</li> |
|
| 34 |
</ol> |
</ol> |
| 35 |
<p> |
<h2><b>How to call the help classes</b></h2> |
|
<b>How to call the help classes:</b><br> |
|
| 36 |
<ol> |
<ol> |
| 37 |
<li> |
<li>Make sure <em><span style="font-style: normal">d:\myApp\eclipse\plugins\org.eclipse.help\help.jar</span></em> is |
| 38 |
Make sure <em>d:\myApp\eclipse\plugins\org.eclipse.help\help.jar</em> is on your app classpath. |
on your app classpath. The class you use to start, launch, and shut down the help system is |
| 39 |
</li> |
org.eclipse.help.standalone.Help. </li> |
| 40 |
<li> |
<li>In your application, create an instance of the Help class by passing the plugins |
| 41 |
org.eclipse.help.standalone.Help is the class that you should be using to start, launch and shutdown help. |
directory. This object should be held onto until the end of your application.<pre><em><span style="font-style: normal">Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");</span></em> </pre> |
| 42 |
</li> |
</li> |
| 43 |
<li> |
<li>To start the help system: |
| 44 |
At some point, create an instance of the Help class by passing the plugins directory. |
<pre><em><span style="font-style: normal">helpSystem.start();</span></em> </pre> |
| 45 |
This object should be hold onto until the end of your app. |
<p>At the end of your application, to shutdown the help system: </p> |
| 46 |
<br> |
<pre><em><span style="font-style: normal">helpSystem.shutdown();</span></em> </pre> |
| 47 |
<em>Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");</em> |
</li> |
| 48 |
</li> |
<li>To invoke help when needed: |
| 49 |
<li> |
<pre><em><span style="font-style: normal">helpSystem.displayHelp();</span></em> </pre> |
| 50 |
Start the help system: |
<p>You can also call help on specific primary TOC files or topics:</p> |
| 51 |
<br> |
<pre>helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); |
| 52 |
<em>helpSystem.start();</em> |
helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");</pre> |
| 53 |
<br> |
</li> |
| 54 |
At the end of your app, shutdown the help system: |
<li>To launch context sensitive help, call |
| 55 |
<br> |
helpSystem.displayContext(contextId, x, y) where contextId is a fully |
| 56 |
<em>helpSystem.shutdown();</em> |
qualified context id. The screen coordinates, x and y, are not currently used. |
|
</li> |
|
|
<li> |
|
|
Invoke help when needed: <em>helpSystem.displayHelp();</em> |
|
|
<br> |
|
|
You can also call help on specific books or topics (make sure the url's are help specific, |
|
|
see the eclipse docs: "/pluginID/path/to/book.xml" or "/pluginID/path/to/topic.html") |
|
|
<br> |
|
|
<em>helpSystem.displayHelp("/pluginId/toc.xml")</em> |
|
|
</li> |
|
|
<li> |
|
|
To launch context sensitive help, call helpSystem.displayContext(contextId, x, y) |
|
|
where contextId is a fully qualified context id. The screen coordinates, x and y, are |
|
|
not currently used. |
|
|
</li> |
|
|
<li><b>Test drive standalone help</b> |
|
|
The org.eclipse.help.standalone.Help class has a simple main program that you can launch and see how |
|
|
the stand-alone help works out of the box (if it does :-) |
|
| 57 |
</li> |
</li> |
| 58 |
</ol> |
</ol> |
| 59 |
</p> |
<h2><b>Testing stand-alone help</b> </h2> |
| 60 |
<p> |
<p>The org.eclipse.help.standalone.Help class has a simple main program that you |
| 61 |
<b>Installing custom documentation:</b><br> |
can launch and see how the stand-alone help works out of the box. From a command |
| 62 |
Eclipse comes with its own documentation. It will be |
line, run the following command:</p> |
| 63 |
available in the infocenter by default.<br> |
<pre>java -classpath d:\myApp\eclipse\plugins\org.eclipse.help\help.jar |
| 64 |
To have you own documentation show up, package the |
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins</pre> |
| 65 |
documentation as Eclipse plugins. Install them to |
|
| 66 |
d:\myApp\eclipse\plugins\. To remove Eclipse documentation |
|
|
that is in the infocenter default, delete following |
|
|
directories: |
|
|
</p> |
|
|
<ul> |
|
|
<li> |
|
|
d:\myApp\eclipse\plugins\org.eclipse.jdt.doc.isv |
|
|
</li> |
|
|
<li> |
|
|
d:\myApp\eclipse\plugins\org.eclipse.jdt.doc.user |
|
|
</li> |
|
|
<li> |
|
|
d:\myApp\eclipse\plugins\org.eclipse.pde.doc.user |
|
|
</li> |
|
|
<li> |
|
|
d:\myApp\eclipse\plugins\org.eclipse.platform.doc.isv |
|
|
</li> |
|
|
<li> |
|
|
d:\myApp\eclipse\plugins\org.eclipse.platform.doc.user. |
|
|
</li> |
|
|
</ul> |
|
|
<p> |
|
|
<b>Customizing standalone look:</b><br> |
|
|
TBD |
|
|
</p> |
|
|
</td> |
|
|
</tr> |
|
|
</table> |
|
| 67 |
</body> |
</body> |
| 68 |
</html> |
</html> |
| 69 |
|
|
Parent Directory
| 
Revision Log
| 
Patch