platform-help-home/infocenter.html
Parent Directory
| 
Revision Log
Revision 1.13 - (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.12 | <head> |
| 4 : | |||
| 5 : | <meta http-equiv="Content-Type" | ||
| 6 : | content="text/html; charset=iso-8859-1"> | ||
| 7 : | |||
| 8 : | <meta name="Author" content="eclipse.org"> | ||
| 9 : | |||
| 10 : | <meta name="GENERATOR" | ||
| 11 : | content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]"> | ||
| 12 : | <title>Infocenter</title> | ||
| 13 : | |||
| 14 : | <link rel="stylesheet" href="http://www.eclipse.org/default_style.css" | ||
| 15 : | type="text/css"> | ||
| 16 : | </head> | ||
| 17 : | <body> | ||
| 18 : | |||
| 19 : | <h1 | ||
| 20 : | style="background: rgb(0,128,192) none repeat scroll 0%; color: rgb(255,255,255);">Installing | ||
| 21 : | the help system as an infocenter</h1> | ||
| 22 : | |||
| 23 : | <p>You can allow your users to access the help system over the Internet or | ||
| 24 : | an intranet, by installing the stand-alone help system and the documentation | ||
| 25 : | plug-ins on a web server. The application accesses the documentation by | ||
| 26 : | calling a URL, and the help system is shown in their web browser. The infocenter | ||
| 27 : | help system can be used both for client applications and for web applications, | ||
| 28 : | either of which can have their help accessed remotely. All features except | ||
| 29 : | infopops and active help are supported. </p> | ||
| 30 : | |||
| 31 : | dbirsan | 1.6 | <h2><b>Installation/packaging</b> </h2> |
| 32 : | dbirsan | 1.12 | These steps are for the help system integrator and web admin and are |
| 33 : | not meant to address all the possible scenarios. It is assumed that all | ||
| 34 : | your documentation is delivered as Eclipse plug-ins and, in general, you | ||
| 35 : | are familiar with the eclipse help system. For the end users, it is assumed | ||
| 36 : | that they have IE5.x or 6.x or Mozilla installed on their machines. | ||
| 37 : | dbirsan | 1.6 | <ol> |
| 38 : | dbirsan | 1.12 | <li>Make sure an application server is installed on the machine. |
| 39 : | We have tested with Tomcat 3 and Tomcat 4.</li> | ||
| 40 : | <li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver | ||
| 41 : | from <a href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li> | ||
| 42 : | <li>Install (unzip) the driver to a directory <var>d:\eclipse</var>. | ||
| 43 : | </li> | ||
| 44 : | <li>Register the Eclipse Help application residing in d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0 | ||
| 45 : | with the web server. Do not copy this directory elsewhere; it must remain | ||
| 46 : | in Eclipse installation tree. | ||
| 47 : | <p>In Tomcat this registration can be accomplished by adding the following | ||
| 48 : | lines to the tomcat\conf\server.xml file:</p> | ||
| 49 : | |||
| 50 : | <pre><em><span style="font-style: normal;"><</span></em>Context path="/help" docBase="d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0"><br></Context></pre> | ||
| 51 : | |||
| 52 : | <p>In Tomcat 3 add the lines near end of the file, as the last element | ||
| 53 : | inside the ContextManager section. In Tomcat 4, add this section | ||
| 54 : | as the last element inside the Host section. </p> | ||
| 55 : | dbirsan | 1.6 | </li> |
| 56 : | dbirsan | 1.12 | <li>Install the following fixes, depending on which server you are using: |
| 57 : | |||
| 58 : | <ul> | ||
| 59 : | <li><b>Tomcat 3:</b> Tomcat 3 does not have XML parser library | ||
| 60 : | available to a web application. To fix that, copy xercesImpl.jar | ||
| 61 : | and xmlParserAPIs.jar from d:\eclipse\plugins\org.apache.xerces_4.0.3\ | ||
| 62 : | to d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF\lib\ </li> | ||
| 63 : | <li><b>Tomcat 4:</b> | ||
| 64 : | <ul> | ||
| 65 : | <li> Both Eclipse and Tomcat contain code to set a URLStreamHandler, | ||
| 66 : | but it can only be set once. To allow both Tomcat and Eclipse | ||
| 67 : | to work correctly, a library d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\eclipseurl.jar | ||
| 68 : | needs to be added to the class path at Tomcat startup. In Tomcat | ||
| 69 : | 4.0.3 edit tomcat/bin/setclasspath.bat file and after the line: | ||
| 70 : | <pre><em><span style="font-style: normal;">set CLASSPATH=%JAVA_HOME%\lib\tools.jar</span></em></pre> | ||
| 71 : | |||
| 72 : | <p>insert the line:</p> | ||
| 73 : | |||
| 74 : | <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> | ||
| 75 : | </li> | ||
| 76 : | <li> Because of changes to the xml library, remove tomcat\common\lib\xerces.jar, | ||
| 77 : | then edit setclasspath.bat by replacing the line | ||
| 78 : | <pre><em><span style="font-style: normal;">set JAVA_OPTS=</span></em> </pre> | ||
| 79 : | with | ||
| 80 : | <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> | ||
| 81 : | </li> | ||
| 82 : | |||
| 83 : | dbirsan | 1.10 | </ul> |
| 84 : | dbirsan | 1.12 | </li> |
| 85 : | <li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.x | ||
| 86 : | or plan to ship the jasper jar files, you should also copy d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\web.xml | ||
| 87 : | to d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF. </li> | ||
| 88 : | |||
| 89 : | </ul> | ||
| 90 : | </li> | ||
| 91 : | |||
| 92 : | dbirsan | 1.6 | </ol> |
| 93 : | dbirsan | 1.12 | |
| 94 : | dbirsan | 1.6 | <h2>Using the infocenter</h2> |
| 95 : | dbirsan | 1.12 | |
| 96 : | <p>Start the web server. Point a web browser to the path of the web application. | ||
| 97 : | On the machine the Tomcat is installed, this would be http://localhost:8080/help/. | ||
| 98 : | </p> | ||
| 99 : | |||
| 100 : | dbirsan | 1.6 | <h2>Installing custom documentation</h2> |
| 101 : | dbirsan | 1.12 | |
| 102 : | <p>The Eclipse platform comes with its own documentation, contained in the | ||
| 103 : | org.eclipse.platform.doc.user plug-in. It will be available in the | ||
| 104 : | infocenter by default. To have you own documentation show up, package the | ||
| 105 : | documentation as Eclipse documentation plug-ins. Install them to d:\eclipse\plugins\. | ||
| 106 : | </p> | ||
| 107 : | |||
| 108 : | <h2>[Optional] Installing a minimal set of plugins</h2> | ||
| 109 : | |||
| 110 : | <p>The infocenter does not require the entire Eclipse Platform package. | ||
| 111 : | It is possible to run the infocenter with the following plugins (located | ||
| 112 : | in the eclipse\plugins directory):<br> | ||
| 113 : | </p> | ||
| 114 : | dbirsan | 1.13 | <code> |
| 115 : | dbirsan | 1.12 | <p> org.apache.lucene<br> |
| 116 : | org.apache.xerces<br> | ||
| 117 : | org.eclipse.core.boot<br> | ||
| 118 : | org.eclipse.core.resources<br> | ||
| 119 : | org.eclipse.core.runtime<br> | ||
| 120 : | org.eclipse.help<br> | ||
| 121 : | org.eclipse.help.webapp<br> | ||
| 122 : | org.eclipse.update.core<br> | ||
| 123 : | dbirsan | 1.13 | </code> |
| 124 : | dbirsan | 1.12 | </p> |
| 125 : | <p>In addition to these plugins, depending on the operating system or machine | ||
| 126 : | architecture, you may need to also need to install the corresponding fragments | ||
| 127 : | for the above plugins (when they exist). For example, on Windows, you need | ||
| 128 : | to add the following fragments (also located in the eclipse\plugins directory):<br> | ||
| 129 : | </p> | ||
| 130 : | dbirsan | 1.13 | <p> |
| 131 : | <code>org.eclipse.core.resources.win32<br> | ||
| 132 : | dbirsan | 1.12 | org.eclipse.update.core.win32<br> |
| 133 : | dbirsan | 1.13 | </code> |
| 134 : | dbirsan | 1.12 | </p> |
| 135 : | dbirsan | 1.6 | </body> |
| 136 : | dbirsan | 1.5 | </html> |
| help@eclipse.org | ViewVC Help |
| Powered by ViewVC 1.0.3 |