platform-help-home/infocenter.html

Parent Directory Parent Directory | Revision Log Revision Log

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

1 : dbirsan 1.5 <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
2 : kkolosow 1.1 <html>
3 : dbirsan 1.5 <head>
4 :     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5 :     <meta name="Author" content="eclipse.org">
6 :     <meta name="GENERATOR" content=
7 :     "Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]">
8 :     <title>
9 :     Infocenter
10 :     </title>
11 : dbirsan 1.6 <link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css">
12 : dbirsan 1.5 </head>
13 : dbirsan 1.6 <body>
14 : kkolosow 1.1
15 : dbirsan 1.6 <h1 style="background:#0080C0;color:#ffffff;">Installing the help system as an infocenter</h1>
16 :    
17 :     <p>You can allow your users to access the help system over the Internet or an
18 :     intranet, by installing the stand-alone help system and the documentation
19 :     plug-ins on a web server. The application accesses the documentation by calling
20 :     a URL, and the help system is shown in their web browser. The infocenter help
21 :     system can be used both for client applications and for web applications, either
22 :     of which can have their help accessed remotely. All features except infopops and
23 :     active help are supported. </p>
24 :     <h2><b>Installation/packaging</b> </h2>
25 :     These steps are for the help system
26 :     integrator and web admin and are not meant to address all the possible scenarios. It is
27 :     assumed that all your documentation is delivered as Eclipse plug-ins and, in general, you are
28 :     familiar with the eclipse help system. For the end users, it is assumed that they have
29 :     IE5.x or 6.x or Mozilla installed on their machines.
30 :    
31 :     <ol>
32 :     <li>Make sure an application server is installed on the machine.&nbsp; We have
33 :     tested with Tomcat 3 and Tomcat 4.</li>
34 :     <li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver from
35 :     <a href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li>
36 :     <li>Install (unzip) the driver to a directory <var>d:\eclipse</var>.
37 :     </li>
38 :     <li>Register the Eclipse Help application residing in
39 : dbirsan 1.7 d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0 with the web server. Do not copy
40 : dbirsan 1.6 this directory elsewhere; it must remain in Eclipse installation tree.<p>In
41 :     Tomcat this registration can be accomplished by adding the following lines to
42 :     the tomcat\conf\server.xml file:</p>
43 : dbirsan 1.7 <pre><em><span style="font-style: normal">&lt;</span></em>Context path=&quot;/help&quot;&nbsp; docBase=&quot;d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0&quot;&gt;
44 : dbirsan 1.6 &lt;/Context&gt;</pre>
45 :     <p>In Tomcat 3 add the lines near end of the file, as the last element inside
46 :     the ContextManager section.&nbsp; In Tomcat 4, add this section as the last element
47 :     inside the Host section. </li>
48 :     <li>Install the following fixes, depending on which server you are using:
49 :     <ul>
50 :     <li><b>Tomcat 3:</b>&nbsp; Tomcat 3 does not have XML parser library available to
51 : dbirsan 1.7 a web application.&nbsp; To fix that, copy xercesImpl.jar and xmlParserAPIs.jar from
52 :     d:\eclipse\plugins\org.apache.xerces_4.0.3\ to
53 :     d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF\lib\ </li>
54 : dbirsan 1.10
55 :     <li><b>Tomcat 4:</b>&nbsp;
56 :     <ul><li> Both Eclipse and Tomcat contain code to set a
57 : dbirsan 1.6 URLStreamHandler, but it can only be set once.&nbsp; To allow both Tomcat and
58 :     Eclipse to work correctly, a library
59 : dbirsan 1.7 d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\eclipseurl.jar needs
60 : dbirsan 1.6 to be added to the class path at Tomcat startup.&nbsp; In Tomcat 4.0.3 edit
61 :     tomcat/bin/setclasspath.bat file and after the line:&nbsp;<pre><em><span style="font-style: normal">set CLASSPATH=%JAVA_HOME%\lib\tools.jar</span></em></pre>
62 :     <p>insert the line:</p>
63 : dbirsan 1.11 <pre><em><span style="font-style: normal">set CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\eclipseurl.jar</span></em> </pre>
64 : dbirsan 1.10
65 :     </li>
66 :     <li>
67 :     Because of changes to the xml library, remove tomcat\common\lib\xerces.jar, then edit setclasspath.bat by replacing the line
68 :     <pre><em><span style="font-style: normal">set JAVA_OPTS=</span></em> </pre>
69 :     with
70 : dbirsan 1.11 <pre><em><span style="font-style: normal">set JAVA_OPTS=-Xbootclasspath/a:d:\eclipse\plugins\org.apache.xerces_4.0.3\xercesImpl.jar;d:\eclipse\plugins\org.apache.xerces_4.0.3\xmlParserAPIs.jar</span></em> </pre>
71 : dbirsan 1.10 </li>
72 :     </ul>
73 : dbirsan 1.6 </li>
74 :     <li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.x or
75 :     plan to ship the jasper jar files, you should also copy
76 : dbirsan 1.7 d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\web.xml to
77 :     d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF. </li>
78 :     </ul>
79 : dbirsan 1.6 </li>
80 :     </ol>
81 :     <h2>Using the infocenter</h2>
82 :     <p>Start the web server. Point a web browser to the path of the web
83 :     application.&nbsp; On the machine the Tomcat is installed, this would be
84 :     http://localhost:8080/help/. </p>
85 :     <h2>Installing custom documentation</h2>
86 :     <p>The Eclipse platform comes with its own documentation, contained in the
87 :     org.eclipse.platform.doc.user plug-in.&nbsp; It will be available in the
88 :     infocenter by default. To have you own documentation show up, package the
89 :     documentation as Eclipse documentation plug-ins.&nbsp; Install them to
90 :     d:\eclipse\plugins\.&nbsp; </p>
91 :    
92 : dbirsan 1.10
93 : dbirsan 1.6
94 :     </body>
95 : dbirsan 1.5 </html>
96 : dbirsan 1.2