platform-help-home/infocenter.html

Parent Directory Parent Directory | Revision Log Revision Log

Revision 1.5 - (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 :     <link rel="stylesheet" href="default_style.css" type="text/css">
12 :     </head>
13 :     <body>
14 :     <p>
15 :     &nbsp;
16 :     </p>
17 :     <table border="0" cellspacing="5" cellpadding="2" width="100%">
18 :     <tr>
19 :     <td align="LEFT" valign="TOP" colspan="2" bgcolor="#0080C0">
20 :     <b><font face="Arial,Helvetica"><font color=
21 :     "#FFFFFF">Information Center</font></font></b>
22 :     </td>
23 :     </tr>
24 :     <tr>
25 :     <td>
26 :     Infocenter (served) - You can also allow your users to access
27 :     the help system over the Internet or their intranet, by
28 :     installing the stand-alone help system and the documentation
29 :     plug-ins on a web server. The application accesses the
30 :     documentation by calling a URL, and the help system is shown in
31 :     their web browser. The infocenter help system can be used both
32 :     for client applications and for web applications, either of
33 :     which can have their help accessed remotely. All features except
34 :     infopops and active help are supported.
35 :     <p>
36 :     <b>Installation</b>
37 :     </p>
38 :     <ol>
39 :     <li>
40 :     Make sure an application server is installed on the
41 :     machine.&nbsp; We have tested with Tomcat 3 and Tomcat 4.
42 :     </li>
43 :     <li>
44 :     Install (unzip) Eclipse 2.0 driver.&nbsp; This steps are
45 :     for 20020411 integration driver or later.&nbsp; Let us
46 :     assume Eclipse has been installed to d:\eclipse\.
47 :     </li>
48 :     <li>
49 :     Register Eclipse Help application residing in
50 :     d:\eclipse\plugins\org.eclipse.help.webapp with the web
51 :     server.&nbsp; Do not copy this directory elsewhere, it
52 :     must remain in eclipse installation tree.<br>
53 :     In Tomcat this can be accomplished by adding the two
54 :     lines<br>
55 :     <em>&lt;Context path=&quot;/help&quot;&nbsp;
56 :     docBase=&quot;d:\eclipse\plugins\org.eclipse.help.webapp&quot;&gt;<br>
57 : kkolosow 1.1
58 : dbirsan 1.5 &lt;/Context&gt;</em><br>
59 :     to the tomcat/conf/server.xml file.&nbsp; In Tomcat 3 this
60 :     section can be added near end of the file, as the last
61 :     element inside the ContextManager section.&nbsp; In Tomcat
62 :     4 this section can be added as the last element inside the
63 :     Host section.
64 :     </li>
65 :     <li>
66 :     Install server specific fixes.
67 :     <ul>
68 :     <li>
69 :     <b>Tomcat 3:</b>&nbsp; Tomcat 3 does not have XML
70 :     parser library available to a web application.&nbsp;
71 :     To fix that, copy xerces.jar from
72 :     d:\eclipse\plugins\org.apache.xerces\ to
73 :     d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF\lib\
74 :     </li>
75 :     <li>
76 :     <b>Tomcat 4:</b>&nbsp; Both Eclipse and Tomcat
77 :     contain code to set a URLStreamHandler, but it can
78 :     only be set once.&nbsp; To allow both Tomcat and
79 :     Eclipse to work correctly, a library
80 :     d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar
81 :     needs to be added to the class path at Tomcat
82 :     startup.&nbsp; In Tomcat 4.0.3 edit
83 :     tomcat/bin/setclasspath.bat file and after a
84 :     line&nbsp;<br>
85 :     <em>set CLASSPATH=%JAVA_HOME%\lib\tools.jar</em><br>
86 :     insert line<br>
87 :     <em>set
88 :     CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar.</em>
89 :     </li>
90 :     <li>
91 :     <b>Disable precompiled JSP&#39;s:</b>. Unless you
92 :     are using Tomcat 4.0.1 or plan to ship the jasper
93 :     jar files you should also copy
94 :     d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\web.xml
95 :     to
96 :     d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF.
97 :     </li>
98 :     </ul>
99 :     </li>
100 :     </ol>
101 :     <p>
102 :     <b>Using Information center:</b><br>
103 :     Start web server.<br>
104 :     Point a web browser to the path of the web application.&nbsp;
105 :     On the machine the Tomcat is installed, this would be <a
106 :     href=
107 :     "http://localhost:8080/help/">http://localhost:8080/help/</a>.
108 :     </p>
109 :     <p>
110 :     <b>Installing custom documentation:</b><br>
111 :     Eclipse comes with its own documentation.&nbsp; It will be
112 :     available in the infocenter by default.<br>
113 :     To have you own documentation show up, package the
114 :     documentation as Eclipse plugins.&nbsp; Install them to
115 :     d:\eclipse\plugins\.&nbsp; To remove Eclipse documentation
116 :     that is in the infocenter default, delete following
117 :     directories:
118 :     </p>
119 :     <ul>
120 :     <li>
121 :     d:\eclipse\plugins\org.eclipse.jdt.doc.isv
122 :     </li>
123 :     <li>
124 :     d:\eclipse\plugins\org.eclipse.jdt.doc.user
125 :     </li>
126 :     <li>
127 :     d:\eclipse\plugins\org.eclipse.pde.doc.user
128 :     </li>
129 :     <li>
130 :     d:\eclipse\plugins\org.eclipse.platform.doc.isv
131 :     </li>
132 :     <li>
133 :     d:\eclipse\plugins\org.eclipse.platform.doc.user.
134 :     </li>
135 :     </ul>
136 :     <p>
137 :     <b>Customizing infocenter look:</b><br>
138 :     TBD
139 :     </p>
140 :     </td>
141 :     </tr>
142 :     </table>
143 :     </body>
144 :     </html>
145 : dbirsan 1.2