platform-help-home/infocenter.html

Parent Directory Parent Directory | Revision Log Revision Log


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

1 : kkolosow 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 :     <meta name="GENERATOR" content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]">
7 :     <title>Infocenter</title>
8 :     <link rel="stylesheet" href="default_style.css" type="text/css">
9 :     </head>
10 :     <body>
11 :     &nbsp;
12 :     <table BORDER=0 CELLSPACING=5 CELLPADDING=2 WIDTH="100%" >
13 :     <tr>
14 :     <td ALIGN=LEFT VALIGN=TOP COLSPAN="2" BGCOLOR="#0080C0"><b><font face="Arial,Helvetica"><font color="#FFFFFF">Information
15 :     Center</font></font></b></td>
16 :     </tr>
17 :    
18 :     <tr>
19 : dbirsan 1.4 <td>Infocenter (served) - You can also allow your users to access the help system over the
20 :     Internet or their intranet, by installing the stand-alone help system and the documentation
21 :     plug-ins on a web server. The application accesses the documentation by calling a URL,
22 :     and the help system is shown in their web browser. The infocenter help system can be
23 :     used both for client applications and for web applications, either of which can have
24 :     their help accessed remotely.
25 :     All features except infopops and active help are supported.
26 : kkolosow 1.1 <p><b>Installing steps:</b>
27 : dbirsan 1.2 <ol>
28 :     <li> Make sure an application server is installed on the machine.&nbsp;
29 : kkolosow 1.1 We have tested with Tomcat 3 and Tomcat 4.
30 : dbirsan 1.2 </li>
31 :     <li>Install (unzip) Eclipse 2.0 driver.&nbsp; This steps are for
32 : kkolosow 1.1 20020411 integration driver or later.&nbsp; Let us assume Eclipse has been
33 :     installed to d:\eclipse\.
34 : dbirsan 1.2 </li>
35 :     <li>Register Eclipse Help application residing in d:\eclipse\plugins\org.eclipse.help.webapp
36 : kkolosow 1.1 with the web server.&nbsp; Do not copy this directory elsewhere, it must
37 :     remain in eclipse installation tree.
38 :     <br>In Tomcat this can be accomplished by adding the two lines
39 : dbirsan 1.2 <br><em>&lt;Context path="/help"&nbsp; docBase="d:\eclipse\plugins\org.eclipse.help.webapp">
40 :     <br>&lt;/Context></em>
41 : kkolosow 1.1 <br>to the tomcat/conf/server.xml file.&nbsp; In Tomcat 3 this section
42 :     can be added near end of the file, as the last element inside the ContextManager
43 :     section.&nbsp; In Tomcat 4 this section can be added as the last element
44 :     inside the Host section.
45 : dbirsan 1.2 </li>
46 :     <li>Install server specific fixes.
47 :     <ul>
48 :     <li><b>Tomcat 3:</b>&nbsp; Tomcat 3 does not have XML parser library
49 :     available to a web application.&nbsp; To fix that, copy xerces.jar from
50 :     d:\eclipse\plugins\org.apache.xerces\ to d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF\lib\
51 :     </li>
52 :     <li><b>Tomcat 4:</b>&nbsp; Both Eclipse and Tomcat contain code to set
53 :     a URLStreamHandler, but it can only be set once.&nbsp; To allow both Tomcat
54 :     and Eclipse to work correctly, a library d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar
55 :     needs to be added to the class path at Tomcat startup.&nbsp; In Tomcat
56 :     4.0.3 edit tomcat/bin/setclasspath.bat file and after a line&nbsp;
57 :    
58 :     <br><em>set CLASSPATH=%JAVA_HOME%\lib\tools.jar</em>
59 :     <br>insert line
60 :     <br><em>set CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar.</em>
61 :    
62 :     </li>
63 : dbirsan 1.3 <li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.1 or plan to ship the jasper
64 :     jar files you should also copy d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\web.xml to
65 :     d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF.
66 :     </li>
67 : dbirsan 1.2 </ul>
68 :     </li>
69 :     </ol>
70 :    
71 : kkolosow 1.1 <p><b>Using Information center:</b>
72 :     <br>Start web server.
73 :     <br>Point a web browser to the path of the web application.&nbsp; On the
74 :     machine the Tomcat is installed, this would be <a href="http://localhost:8080/help/">http://localhost:8080/help/</a>.
75 :     <p><b>Installing custom documentation:</b>
76 :     <br>Eclipse comes with its own documentation.&nbsp; It will be available
77 :     in the infocenter by default.
78 :     <br>To have you own documentation show up, package the documentation as
79 :     Eclipse plugins.&nbsp; Install them to d:\eclipse\plugins\.&nbsp; To remove
80 :     Eclipse documentation that is in the infocenter default, delete following
81 : dbirsan 1.2 directories:
82 :     <ul>
83 :     <li>d:\eclipse\plugins\org.eclipse.jdt.doc.isv
84 :     <li> d:\eclipse\plugins\org.eclipse.jdt.doc.user
85 :     <li>d:\eclipse\plugins\org.eclipse.pde.doc.user
86 :     <li> d:\eclipse\plugins\org.eclipse.platform.doc.isv
87 :     <li>d:\eclipse\plugins\org.eclipse.platform.doc.user.
88 :     </ul>
89 : kkolosow 1.1 <p><b>Customizing infocenter look:</b>
90 :     <br>TBD</td>
91 :     </tr>
92 :     </table>
93 :    
94 :     </body>
95 :     </html>