platform-help-home/standalone.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.6 - (download) (as text) (annotate)
Tue Feb 18 22:38:04 2003 UTC (6 years, 9 months ago) by dbirsan
Branch: MAIN
CVS Tags: R3_0, R3_1, R2_1, HEAD
Changes since 1.5: +1 -1 lines 
document minimal set of plugins

<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
               
  <meta http-equiv="Content-Type"
 content="text/html; charset=iso-8859-1">
               
  <meta name="Author" content="eclipse.org">
  <title>Installing Standalone Help</title>
                            
  <link rel="stylesheet" href="http://www.eclipse.org/default_style.css"
 type="text/css">
</head>
     <body>
      
<h1
 style="background: rgb(0,128,192) none repeat scroll 0% 50%; color: rgb(255,255,255);">Installing
 the stand-alone help system</h1>
     
<p>If you are creating an application that is not based on  the Eclipse framework,
 you can still use the Eclipse help system. Your  application can package
and install 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, except infopops and active help. </p>
     
<h2><b>Installation/packaging</b> </h2>
   These steps are for the help system    integrator and are not meant to 
address all the possible scenarios. It is    assumed that the launching application
 is in Java, and that    all your documentation is delivered as Eclipse plug-ins
 and, in general, you are    familiar with the eclipse help system.   
<ol>
     <li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver
 from   <a target="_blank" href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li>
     <li>Install (unzip) the driver under your application directory, for 
   example, <var>d:\myApp</var>. This will create an eclipse subdirectory,
 d:\myApp\eclipse that    contains the code required for the Eclipse platform
 (which includes the help    system). </li>
     
</ol>
     
<h2><b>How to call the help classes</b></h2>
     
<ol>
     <li>Make sure <em><span style="font-style: normal;">d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar</span></em>
 is    on your app classpath. The class you use to start, launch, and shut
 down the help system is    org.eclipse.help.standalone.Help. </li>
     <li>In your application, create an instance of the Help class by passing
 the plugins    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>
     </li>
     <li>To start the help system:             
    <pre><em><span style="font-style: normal;">helpSystem.start();</span></em> </pre>
               
    <p>At the end of your application, to shutdown the help system: </p>
               
    <pre><em><span style="font-style: normal;">helpSystem.shutdown();</span></em> </pre>
     </li>
     <li>To invoke help when needed:             
    <pre><em><span style="font-style: normal;">helpSystem.displayHelp();</span></em> </pre>
               
    <p>You can also call help on specific primary TOC files or topics:</p>
               
    <pre>helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");<br>helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");</pre>
     </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>
     
</ol>
     
<h2><b>Testing stand-alone help</b> </h2>
     
<p>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. From
 a command  line, run the following command:</p>
     
<pre>java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar <br>org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins</pre>
       
<h2>[Optional] Installing a minimal set of plug-ins<br>
   </h2>
     
<p>The stand-alone help does not require the entire &nbsp;Eclipse Platform
 package. It is possible to run the stand-alone help with the following plugins
 (located in the&nbsp; eclipse\plugins directory):<br>
   </p>
   
<p><code> org.apache.lucene<br>
   org.apache.xerces<br>
   org.eclipse.ant.core<br>
   org.eclipse.core.boot<br>
   org.eclipse.core.resources<br>
   org.eclipse.core.runtime<br>
   org.eclipse.help<br>
   org.eclipse.help.ui<br>
   org.eclipse.help.webapp<br>
   org.eclipse.search<br>
   org.eclipse.swt<br>
   org.eclipse.tomcat<br>
   org.eclipse.ui<br>
   org.eclipse.update.core<br>
   </code> </p>
     
<p>In addition to these plugins, depending on the operating system or machine 
 architecture, you may need to also need to install the corresponding fragments 
 for the above plugins (when they exist). For example, on Windows, you need 
 to add the following fragments (also located in the eclipse\plugins directory):<br>
   </p>
     
<p> <code>org.eclipse.core.resources.win32<br>
   org.eclipse.help.ui.win32<br>
   org.eclipse.swt.win32<br>
   org.eclipse.update.core.win32<br>
   </code> </p>
                                                                        
                           <br>
         <br>
   <br>
   
</body>
</html>