platform-help-home/infocenter.html

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.5 - (download) (as text) (annotate)
Tue Apr 16 15:35:07 2002 UTC (7 years, 7 months ago) by dbirsan
Branch: MAIN
Changes since 1.4: +142 -92 lines
cleanup
<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
<html>
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
      <meta name="Author" content="eclipse.org">
      <meta name="GENERATOR" content=
      "Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]">
      <title>
         Infocenter
      </title>
      <link rel="stylesheet" href="default_style.css" type="text/css">
   </head>
   <body>
      <p>
         &nbsp;
      </p>
      <table border="0" cellspacing="5" cellpadding="2" width="100%">
         <tr>
            <td align="LEFT" valign="TOP" colspan="2" bgcolor="#0080C0">
               <b><font face="Arial,Helvetica"><font color=
               "#FFFFFF">Information Center</font></font></b> 
            </td>
         </tr>
         <tr>
            <td>
               Infocenter (served) - You can also allow your users to access
               the help system over the Internet or their intranet, by
               installing the stand-alone help system and the documentation
               plug-ins on a web server. The application accesses the
               documentation by calling a URL, and the help system is shown in
               their web browser. The infocenter help system can be used both
               for client applications and for web applications, either of
               which can have their help accessed remotely. All features except
               infopops and active help are supported. 
               <p>
                  <b>Installation</b>
               </p>
               <ol>
                  <li>
                     Make sure an application server is installed on the
                     machine.&nbsp; We have tested with Tomcat 3 and Tomcat 4.
                  </li>
                  <li>
                     Install (unzip) Eclipse 2.0 driver.&nbsp; This steps are
                     for 20020411 integration driver or later.&nbsp; Let us
                     assume Eclipse has been installed to d:\eclipse\.
                  </li>
                  <li>
                     Register Eclipse Help application residing in
                     d:\eclipse\plugins\org.eclipse.help.webapp with the web
                     server.&nbsp; Do not copy this directory elsewhere, it
                     must remain in eclipse installation tree.<br>
                     In Tomcat this can be accomplished by adding the two
                     lines<br>
                     <em>&lt;Context path=&quot;/help&quot;&nbsp;
                     docBase=&quot;d:\eclipse\plugins\org.eclipse.help.webapp&quot;&gt;<br>

                     &lt;/Context&gt;</em><br>
                     to the tomcat/conf/server.xml file.&nbsp; In Tomcat 3 this
                     section can be added near end of the file, as the last
                     element inside the ContextManager section.&nbsp; In Tomcat
                     4 this section can be added as the last element inside the
                     Host section.
                  </li>
                  <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>
                        </li>
                        <li>
                           <b>Disable precompiled JSP&#39;s:</b>. Unless you
                           are using Tomcat 4.0.1 or plan to ship the jasper
                           jar files you should also copy
                           d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\web.xml
                           to
                           d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF.
                        </li>
                     </ul>
                  </li>
               </ol>
               <p>
                  <b>Using Information center:</b><br>
                  Start web server.<br>
                  Point a web browser to the path of the web application.&nbsp;
                  On the machine the Tomcat is installed, this would be <a
                  href=
                  "http://localhost:8080/help/">http://localhost:8080/help/</a>.
               </p>
               <p>
                  <b>Installing custom documentation:</b><br>
                  Eclipse comes with its own documentation.&nbsp; It will be
                  available in the infocenter by default.<br>
                  To have you own documentation show up, package the
                  documentation as Eclipse plugins.&nbsp; Install them to
                  d:\eclipse\plugins\.&nbsp; To remove Eclipse documentation
                  that is in the infocenter default, delete following
                  directories:
               </p>
               <ul>
                  <li>
                     d:\eclipse\plugins\org.eclipse.jdt.doc.isv
                  </li>
                  <li>
                     d:\eclipse\plugins\org.eclipse.jdt.doc.user
                  </li>
                  <li>
                     d:\eclipse\plugins\org.eclipse.pde.doc.user
                  </li>
                  <li>
                     d:\eclipse\plugins\org.eclipse.platform.doc.isv
                  </li>
                  <li>
                     d:\eclipse\plugins\org.eclipse.platform.doc.user.
                  </li>
               </ul>
               <p>
                  <b>Customizing infocenter look:</b><br>
                  TBD
               </p>
            </td>
         </tr>
      </table>
   </body>
</html>