platform-help-home/standalone.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.6 - (view) (download) (as text)

1 : dbirsan 1.1 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
2 :     <html>
3 : dbirsan 1.5 <head>
4 :    
5 :     <meta http-equiv="Content-Type"
6 :     content="text/html; charset=iso-8859-1">
7 :    
8 :     <meta name="Author" content="eclipse.org">
9 : dbirsan 1.6 <title>Installing Standalone Help</title>
10 : dbirsan 1.5
11 :     <link rel="stylesheet" href="http://www.eclipse.org/default_style.css"
12 :     type="text/css">
13 :     </head>
14 :     <body>
15 :    
16 :     <h1
17 :     style="background: rgb(0,128,192) none repeat scroll 0% 50%; color: rgb(255,255,255);">Installing
18 :     the stand-alone help system</h1>
19 :    
20 :     <p>If you are creating an application that is not based on the Eclipse framework,
21 :     you can still use the Eclipse help system. Your application can package
22 :     and install the stand-alone help system, a very small version of Eclipse
23 :     that has had everything except the help system stripped out of it. Then,
24 :     your application can make API calls from its Help menu, or from UI objects,
25 :     to launch the help browser. The stand-alone help system has all the features
26 :     of the integrated help system, except infopops and active help. </p>
27 :    
28 : dbirsan 1.3 <h2><b>Installation/packaging</b> </h2>
29 : dbirsan 1.5 These steps are for the help system integrator and are not meant to
30 :     address all the possible scenarios. It is assumed that the launching application
31 :     is in Java, and that all your documentation is delivered as Eclipse plug-ins
32 :     and, in general, you are familiar with the eclipse help system.
33 : dbirsan 1.3 <ol>
34 : dbirsan 1.5 <li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver
35 :     from <a target="_blank" href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li>
36 :     <li>Install (unzip) the driver under your application directory, for
37 :     example, <var>d:\myApp</var>. This will create an eclipse subdirectory,
38 :     d:\myApp\eclipse that contains the code required for the Eclipse platform
39 :     (which includes the help system). </li>
40 :    
41 : dbirsan 1.3 </ol>
42 : dbirsan 1.5
43 : dbirsan 1.3 <h2><b>How to call the help classes</b></h2>
44 : dbirsan 1.5
45 : dbirsan 1.3 <ol>
46 : dbirsan 1.5 <li>Make sure <em><span style="font-style: normal;">d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar</span></em>
47 :     is on your app classpath. The class you use to start, launch, and shut
48 :     down the help system is org.eclipse.help.standalone.Help. </li>
49 :     <li>In your application, create an instance of the Help class by passing
50 :     the plugins directory. This object should be held onto until the end
51 :     of your application.
52 :     <pre><em><span style="font-style: normal;">Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");</span></em> </pre>
53 :     </li>
54 :     <li>To start the help system:
55 :     <pre><em><span style="font-style: normal;">helpSystem.start();</span></em> </pre>
56 :    
57 :     <p>At the end of your application, to shutdown the help system: </p>
58 :    
59 :     <pre><em><span style="font-style: normal;">helpSystem.shutdown();</span></em> </pre>
60 :     </li>
61 :     <li>To invoke help when needed:
62 :     <pre><em><span style="font-style: normal;">helpSystem.displayHelp();</span></em> </pre>
63 :    
64 :     <p>You can also call help on specific primary TOC files or topics:</p>
65 :    
66 :     <pre>helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");<br>helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");</pre>
67 :     </li>
68 :     <li>To launch context sensitive help, call helpSystem.displayContext(contextId,
69 :     x, y) where contextId is a fully qualified context id. The screen coordinates,
70 :     x and y, are not currently used. </li>
71 :    
72 : dbirsan 1.3 </ol>
73 : dbirsan 1.5
74 : dbirsan 1.3 <h2><b>Testing stand-alone help</b> </h2>
75 : dbirsan 1.5
76 :     <p>The org.eclipse.help.standalone.Help class has a simple main program that
77 :     you can launch and see how the stand-alone help works out of the box. From
78 :     a command line, run the following command:</p>
79 :    
80 :     <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>
81 :    
82 :     <h2>[Optional] Installing a minimal set of plug-ins<br>
83 :     </h2>
84 :    
85 :     <p>The stand-alone help does not require the entire &nbsp;Eclipse Platform
86 :     package. It is possible to run the stand-alone help with the following plugins
87 :     (located in the&nbsp; eclipse\plugins directory):<br>
88 :     </p>
89 :    
90 :     <p><code> org.apache.lucene<br>
91 :     org.apache.xerces<br>
92 :     org.eclipse.ant.core<br>
93 :     org.eclipse.core.boot<br>
94 :     org.eclipse.core.resources<br>
95 :     org.eclipse.core.runtime<br>
96 :     org.eclipse.help<br>
97 :     org.eclipse.help.ui<br>
98 :     org.eclipse.help.webapp<br>
99 :     org.eclipse.search<br>
100 :     org.eclipse.swt<br>
101 :     org.eclipse.tomcat<br>
102 :     org.eclipse.ui<br>
103 :     org.eclipse.update.core<br>
104 :     </code> </p>
105 :    
106 :     <p>In addition to these plugins, depending on the operating system or machine
107 :     architecture, you may need to also need to install the corresponding fragments
108 :     for the above plugins (when they exist). For example, on Windows, you need
109 :     to add the following fragments (also located in the eclipse\plugins directory):<br>
110 :     </p>
111 :    
112 :     <p> <code>org.eclipse.core.resources.win32<br>
113 :     org.eclipse.help.ui.win32<br>
114 :     org.eclipse.swt.win32<br>
115 :     org.eclipse.update.core.win32<br>
116 :     </code> </p>
117 :    
118 :     <br>
119 :     <br>
120 :     <br>
121 :    
122 : dbirsan 1.3 </body>
123 : dbirsan 1.1 </html>