platform-help-home/infocenter.html

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.4, Tue Apr 16 15:18:16 2002 UTC revision 1.5, Tue Apr 16 15:35:07 2002 UTC
# Line 1  Line 1 
1  <!doctype html public "-//w3c//dtd html 4.0 transitional//en">  <!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
2  <html>  <html>
3  <head>  <head>
4     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">     <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
5     <meta name="Author" content="eclipse.org">     <meta name="Author" content="eclipse.org">
6     <meta name="GENERATOR" content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]">        <meta name="GENERATOR" content=
7     <title>Infocenter</title>        "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">  <link rel="stylesheet" href="default_style.css" type="text/css">
12  </head>  </head>
13  <body>  <body>
14          <p>
15  &nbsp;  &nbsp;
16  <table BORDER=0 CELLSPACING=5 CELLPADDING=2 WIDTH="100%" >        </p>
17          <table border="0" cellspacing="5" cellpadding="2" width="100%">
18  <tr>  <tr>
19  <td ALIGN=LEFT VALIGN=TOP COLSPAN="2" BGCOLOR="#0080C0"><b><font face="Arial,Helvetica"><font color="#FFFFFF">Information              <td align="LEFT" valign="TOP" colspan="2" bgcolor="#0080C0">
20  Center</font></font></b></td>                 <b><font face="Arial,Helvetica"><font color=
21                   "#FFFFFF">Information Center</font></font></b>
22                </td>
23  </tr>  </tr>
   
24  <tr>  <tr>
25  <td>Infocenter (served) - You can also allow your users to access the help system over the              <td>
26  Internet or their intranet, by installing the stand-alone help system and the documentation                 Infocenter (served) - You can also allow your users to access
27  plug-ins on a web server. The application accesses the documentation by calling a URL,                 the help system over the Internet or their intranet, by
28  and the help system is shown in their web browser. The infocenter help system can be                 installing the stand-alone help system and the documentation
29  used both for client applications and for web applications, either of which can have                 plug-ins on a web server. The application accesses the
30  their help accessed remotely.                 documentation by calling a URL, and the help system is shown in
31  All features except infopops and active help are supported.                 their web browser. The infocenter help system can be used both
32  <p><b>Installing steps:</b>                 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>  <ol>
39  <li> Make sure an application server is installed on the machine.&nbsp;                    <li>
40  We have tested with Tomcat 3 and Tomcat 4.                       Make sure an application server is installed on the
41  </li>                       machine.&nbsp; We have tested with Tomcat 3 and Tomcat 4.
42  <li>Install (unzip) Eclipse 2.0 driver.&nbsp; This steps are for                    </li>
43  20020411 integration driver or later.&nbsp; Let us assume Eclipse has been                    <li>
44  installed to d:\eclipse\.                       Install (unzip) Eclipse 2.0 driver.&nbsp; This steps are
45  </li>                       for 20020411 integration driver or later.&nbsp; Let us
46  <li>Register Eclipse Help application residing in d:\eclipse\plugins\org.eclipse.help.webapp                       assume Eclipse has been installed to d:\eclipse\.
47  with the web server.&nbsp; Do not copy this directory elsewhere, it must                    </li>
48  remain in eclipse installation tree.                    <li>
49  <br>In Tomcat this can be accomplished by adding the two lines                       Register Eclipse Help application residing in
50  <br><em>&lt;Context path="/help"&nbsp; docBase="d:\eclipse\plugins\org.eclipse.help.webapp">                       d:\eclipse\plugins\org.eclipse.help.webapp with the web
51  <br>&lt;/Context></em>                       server.&nbsp; Do not copy this directory elsewhere, it
52  <br>to the tomcat/conf/server.xml file.&nbsp; In Tomcat 3 this section                       must remain in eclipse installation tree.<br>
53  can be added near end of the file, as the last element inside the ContextManager                       In Tomcat this can be accomplished by adding the two
54  section.&nbsp; In Tomcat 4 this section can be added as the last element                       lines<br>
55  inside the Host section.                       <em>&lt;Context path=&quot;/help&quot;&nbsp;
56  </li>                       docBase=&quot;d:\eclipse\plugins\org.eclipse.help.webapp&quot;&gt;<br>
 <li>Install server specific fixes.  
         <ul>  
         <li><b>Tomcat 3:</b>&nbsp; Tomcat 3 does not have XML parser library  
         available to a web application.&nbsp; To fix that, copy xerces.jar from  
         d:\eclipse\plugins\org.apache.xerces\ to d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF\lib\  
         </li>  
         <li><b>Tomcat 4:</b>&nbsp; Both Eclipse and Tomcat contain code to set  
         a URLStreamHandler, but it can only be set once.&nbsp; To allow both Tomcat  
         and Eclipse to work correctly, a library d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar  
         needs to be added to the class path at Tomcat startup.&nbsp; In Tomcat  
         4.0.3 edit tomcat/bin/setclasspath.bat file and after a line&nbsp;  
   
         <br><em>set CLASSPATH=%JAVA_HOME%\lib\tools.jar</em>  
         <br>insert line  
         <br><em>set CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar.</em>  
57    
58                         &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>          </li>
65          <li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.1 or plan to ship the jasper                    <li>
66          jar files you should also copy d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\web.xml to                       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.          d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF.
97          </li>          </li>
98          </ul>          </ul>
99  </li>  </li>
100  </ol>  </ol>
101                   <p>
102  <p><b>Using Information center:</b>                    <b>Using Information center:</b><br>
103  <br>Start web server.                    Start web server.<br>
104  <br>Point a web browser to the path of the web application.&nbsp; On the                    Point a web browser to the path of the web application.&nbsp;
105  machine the Tomcat is installed, this would be <a href="http://localhost:8080/help/">http://localhost:8080/help/</a>.                    On the machine the Tomcat is installed, this would be <a
106  <p><b>Installing custom documentation:</b>                    href=
107  <br>Eclipse comes with its own documentation.&nbsp; It will be available                    "http://localhost:8080/help/">http://localhost:8080/help/</a>.
108  in the infocenter by default.                 </p>
109  <br>To have you own documentation show up, package the documentation as                 <p>
110  Eclipse plugins.&nbsp; Install them to d:\eclipse\plugins\.&nbsp; To remove                    <b>Installing custom documentation:</b><br>
111  Eclipse documentation that is in the infocenter default, delete following                    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:  directories:
118                   </p>
119  <ul>  <ul>
120  <li>d:\eclipse\plugins\org.eclipse.jdt.doc.isv                    <li>
121  <li> d:\eclipse\plugins\org.eclipse.jdt.doc.user                       d:\eclipse\plugins\org.eclipse.jdt.doc.isv
122  <li>d:\eclipse\plugins\org.eclipse.pde.doc.user                    </li>
123  <li> d:\eclipse\plugins\org.eclipse.platform.doc.isv                    <li>
124  <li>d:\eclipse\plugins\org.eclipse.platform.doc.user.                       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>  </ul>
136  <p><b>Customizing infocenter look:</b>                 <p>
137  <br>TBD</td>                    <b>Customizing infocenter look:</b><br>
138                      TBD
139                   </p>
140                </td>
141  </tr>  </tr>
142  </table>  </table>
   
143  </body>  </body>
144  </html>  </html>
145    

Legend:
Removed from v.1.4  
changed lines
  Added in v.1.5