platform-help-home/standalone.html
Parent Directory
| 
Revision Log
Revision 1.3 - (view) (download) (as text)
| 1 : | dbirsan | 1.1 | <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"> |
| 2 : | <html> | ||
| 3 : | <head> | ||
| 4 : | <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | ||
| 5 : | <meta name="Author" content="eclipse.org"> | ||
| 6 : | <title> | ||
| 7 : | dbirsan | 1.3 | Installing Standalone Help |
| 8 : | dbirsan | 1.1 | </title> |
| 9 : | dbirsan | 1.3 | <link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css"> |
| 10 : | dbirsan | 1.1 | </head> |
| 11 : | dbirsan | 1.3 | <body> |
| 12 : | |||
| 13 : | <h1 style="background:#0080C0;color:#ffffff;">Installing the stand-alone help system</h1> | ||
| 14 : | <p>If you are creating an application that is not based on | ||
| 15 : | the Eclipse framework, you can still use the Eclipse help system. Your | ||
| 16 : | application can package and install the stand-alone help system, a very small | ||
| 17 : | version of Eclipse that has had everything except the help system stripped out | ||
| 18 : | of it. Then, your application can make API calls from its Help menu, or from UI | ||
| 19 : | objects, to launch the help browser. The stand-alone help system has all the | ||
| 20 : | features of the integrated help system, except infopops and active help. </p> | ||
| 21 : | <h2><b>Installation/packaging</b> </h2> | ||
| 22 : | These steps are for the help system | ||
| 23 : | integrator and are not meant to address all the possible scenarios. It is | ||
| 24 : | assumed that the launching application is in Java, and that | ||
| 25 : | all your documentation is delivered as Eclipse plug-ins and, in general, you are | ||
| 26 : | familiar with the eclipse help system. | ||
| 27 : | <ol> | ||
| 28 : | <li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver from | ||
| 29 : | <a target="_blank" href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li> | ||
| 30 : | <li>Install (unzip) the driver under your application directory, for | ||
| 31 : | example, <var>d:\myApp</var>. This will create an eclipse subdirectory, d:\myApp\eclipse that | ||
| 32 : | contains the code required for the Eclipse platform (which includes the help | ||
| 33 : | system). </li> | ||
| 34 : | </ol> | ||
| 35 : | <h2><b>How to call the help classes</b></h2> | ||
| 36 : | <ol> | ||
| 37 : | <li>Make sure <em><span style="font-style: normal">d:\myApp\eclipse\plugins\org.eclipse.help\help.jar</span></em> is | ||
| 38 : | on your app classpath. The class you use to start, launch, and shut down the help system is | ||
| 39 : | org.eclipse.help.standalone.Help. </li> | ||
| 40 : | <li>In your application, create an instance of the Help class by passing the plugins | ||
| 41 : | 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> | ||
| 43 : | <li>To start the help system: | ||
| 44 : | <pre><em><span style="font-style: normal">helpSystem.start();</span></em> </pre> | ||
| 45 : | <p>At the end of your application, to shutdown the help system: </p> | ||
| 46 : | <pre><em><span style="font-style: normal">helpSystem.shutdown();</span></em> </pre> | ||
| 47 : | </li> | ||
| 48 : | <li>To invoke help when needed: | ||
| 49 : | <pre><em><span style="font-style: normal">helpSystem.displayHelp();</span></em> </pre> | ||
| 50 : | <p>You can also call help on specific primary TOC files or topics:</p> | ||
| 51 : | <pre>helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); | ||
| 52 : | helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");</pre> | ||
| 53 : | </li> | ||
| 54 : | <li>To launch context sensitive help, call | ||
| 55 : | helpSystem.displayContext(contextId, x, y) where contextId is a fully | ||
| 56 : | qualified context id. The screen coordinates, x and y, are not currently used. | ||
| 57 : | </li> | ||
| 58 : | </ol> | ||
| 59 : | <h2><b>Testing stand-alone help</b> </h2> | ||
| 60 : | <p>The org.eclipse.help.standalone.Help class has a simple main program that you | ||
| 61 : | can launch and see how the stand-alone help works out of the box. From a command | ||
| 62 : | line, run the following command:</p> | ||
| 63 : | <pre>java -classpath d:\myApp\eclipse\plugins\org.eclipse.help\help.jar | ||
| 64 : | org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins</pre> | ||
| 65 : | |||
| 66 : | |||
| 67 : | </body> | ||
| 68 : | dbirsan | 1.1 | </html> |
| 69 : |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |