| 8 |
<title> |
<title> |
| 9 |
Infocenter |
Infocenter |
| 10 |
</title> |
</title> |
| 11 |
<link rel="stylesheet" href="default_style.css" type="text/css"> |
<link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css"> |
| 12 |
</head> |
</head> |
| 13 |
<body> |
<body> |
| 14 |
<p> |
|
| 15 |
|
<h1 style="background:#0080C0;color:#ffffff;">Installing the help system as an infocenter</h1> |
| 16 |
</p> |
|
| 17 |
<table border="0" cellspacing="5" cellpadding="2" width="100%"> |
<p>You can allow your users to access the help system over the Internet or an |
| 18 |
<tr> |
intranet, by installing the stand-alone help system and the documentation |
| 19 |
<td align="LEFT" valign="TOP" colspan="2" bgcolor="#0080C0"> |
plug-ins on a web server. The application accesses the documentation by calling |
| 20 |
<b><font face="Arial,Helvetica"><font color= |
a URL, and the help system is shown in their web browser. The infocenter help |
| 21 |
"#FFFFFF">Information Center</font></font></b> |
system can be used both for client applications and for web applications, either |
| 22 |
</td> |
of which can have their help accessed remotely. All features except infopops and |
| 23 |
</tr> |
active help are supported. </p> |
| 24 |
<tr> |
<h2><b>Installation/packaging</b> </h2> |
| 25 |
<td> |
These steps are for the help system |
| 26 |
Infocenter (served) - You can also allow your users to access |
integrator and web admin and are not meant to address all the possible scenarios. It is |
| 27 |
the help system over the Internet or their intranet, by |
assumed that all your documentation is delivered as Eclipse plug-ins and, in general, you are |
| 28 |
installing the stand-alone help system and the documentation |
familiar with the eclipse help system. For the end users, it is assumed that they have |
| 29 |
plug-ins on a web server. The application accesses the |
IE5.x or 6.x or Mozilla installed on their machines. |
| 30 |
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> |
|
| 31 |
<ol> |
<ol> |
| 32 |
<li> |
<li>Make sure an application server is installed on the machine. We have |
| 33 |
Make sure an application server is installed on the |
tested with Tomcat 3 and Tomcat 4.</li> |
| 34 |
machine. We have tested with Tomcat 3 and Tomcat 4. |
<li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver from |
| 35 |
</li> |
<a href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li> |
| 36 |
<li> |
<li>Install (unzip) the driver to a directory <var>d:\eclipse</var>. |
| 37 |
Install (unzip) Eclipse 2.0 driver. This steps are |
</li> |
| 38 |
for 20020411 integration driver or later. Let us |
<li>Register the Eclipse Help application residing in |
| 39 |
assume Eclipse has been installed to d:\eclipse\. |
d:\eclipse\plugins\org.eclipse.help.webapp with the web server. Do not copy |
| 40 |
</li> |
this directory elsewhere; it must remain in Eclipse installation tree.<p>In |
| 41 |
<li> |
Tomcat this registration can be accomplished by adding the following lines to |
| 42 |
Register Eclipse Help application residing in |
the tomcat\conf\server.xml file:</p> |
| 43 |
d:\eclipse\plugins\org.eclipse.help.webapp with the web |
<pre><em><span style="font-style: normal"><</span></em>Context path="/help" docBase="d:\eclipse\plugins\org.eclipse.help.webapp"> |
| 44 |
server. Do not copy this directory elsewhere, it |
</Context></pre> |
| 45 |
must remain in eclipse installation tree.<br> |
<p>In Tomcat 3 add the lines near end of the file, as the last element inside |
| 46 |
In Tomcat this can be accomplished by adding the two |
the ContextManager section. In Tomcat 4, add this section as the last element |
| 47 |
lines<br> |
inside the Host section. </li> |
| 48 |
<em><Context path="/help" |
<li>Install the following fixes, depending on which server you are using: |
|
docBase="d:\eclipse\plugins\org.eclipse.help.webapp"><br> |
|
|
|
|
|
</Context></em><br> |
|
|
to the tomcat/conf/server.xml file. In Tomcat 3 this |
|
|
section can be added near end of the file, as the last |
|
|
element inside the ContextManager section. In Tomcat |
|
|
4 this section can be added as the last element inside the |
|
|
Host section. |
|
|
</li> |
|
|
<li> |
|
|
Install server specific fixes. |
|
| 49 |
<ul> |
<ul> |
| 50 |
<li> |
<li><b>Tomcat 3:</b> Tomcat 3 does not have XML parser library available to |
| 51 |
<b>Tomcat 3:</b> Tomcat 3 does not have XML |
a web application. To fix that, copy xerces.jar from |
|
parser library available to a web application. |
|
|
To fix that, copy xerces.jar from |
|
| 52 |
d:\eclipse\plugins\org.apache.xerces\ to |
d:\eclipse\plugins\org.apache.xerces\ to |
| 53 |
d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF\lib\ |
d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF\lib\ </li> |
| 54 |
</li> |
<li><b>Tomcat 4:</b> Both Eclipse and Tomcat contain code to set a |
| 55 |
<li> |
URLStreamHandler, but it can only be set once. To allow both Tomcat and |
|
<b>Tomcat 4:</b> Both Eclipse and Tomcat |
|
|
contain code to set a URLStreamHandler, but it can |
|
|
only be set once. To allow both Tomcat and |
|
| 56 |
Eclipse to work correctly, a library |
Eclipse to work correctly, a library |
| 57 |
d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar |
d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar needs |
| 58 |
needs to be added to the class path at Tomcat |
to be added to the class path at Tomcat startup. In Tomcat 4.0.3 edit |
| 59 |
startup. In Tomcat 4.0.3 edit |
tomcat/bin/setclasspath.bat file and after the line: <pre><em><span style="font-style: normal">set CLASSPATH=%JAVA_HOME%\lib\tools.jar</span></em></pre> |
| 60 |
tomcat/bin/setclasspath.bat file and after a |
<p>insert the line:</p> |
| 61 |
line <br> |
<pre><em><span style="font-style: normal">set CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar.</span></em> </pre> |
| 62 |
<em>set CLASSPATH=%JAVA_HOME%\lib\tools.jar</em><br> |
</li> |
| 63 |
insert line<br> |
<li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.x or |
| 64 |
<em>set |
plan to ship the jasper jar files, you should also copy |
| 65 |
CLASSPATH=%CLASSPATH%;d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\eclipseurl.jar.</em> |
d:\eclipse\plugins\org.eclipse.help.webapp\infocenter\web.xml to |
| 66 |
</li> |
d:\eclipse\plugins\org.eclipse.help.webapp\WEB-INF. </li> |
|
<li> |
|
|
<b>Disable precompiled JSP'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> |
|
| 67 |
</ul> |
</ul> |
| 68 |
</li> |
</li> |
| 69 |
</ol> |
</ol> |
| 70 |
<p> |
<h2>Using the infocenter</h2> |
| 71 |
<b>Using Information center:</b><br> |
<p>Start the web server. Point a web browser to the path of the web |
| 72 |
Start web server.<br> |
application. On the machine the Tomcat is installed, this would be |
| 73 |
Point a web browser to the path of the web application. |
http://localhost:8080/help/. </p> |
| 74 |
On the machine the Tomcat is installed, this would be <a |
<h2>Installing custom documentation</h2> |
| 75 |
href= |
<p>The Eclipse platform comes with its own documentation, contained in the |
| 76 |
"http://localhost:8080/help/">http://localhost:8080/help/</a>. |
org.eclipse.platform.doc.user plug-in. It will be available in the |
| 77 |
</p> |
infocenter by default. To have you own documentation show up, package the |
| 78 |
<p> |
documentation as Eclipse documentation plug-ins. Install them to |
| 79 |
<b>Installing custom documentation:</b><br> |
d:\eclipse\plugins\. </p> |
| 80 |
Eclipse comes with its own documentation. It will be |
|
| 81 |
available in the infocenter by default.<br> |
|
|
To have you own documentation show up, package the |
|
|
documentation as Eclipse plugins. Install them to |
|
|
d:\eclipse\plugins\. 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> |
|
| 82 |
</body> |
</body> |
| 83 |
</html> |
</html> |
| 84 |
|
|
Parent Directory
| 
Revision Log
| 
Patch