| 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"> |
|
| 5 |
|
<meta http-equiv="Content-Type" |
| 6 |
|
content="text/html; charset=iso-8859-1"> |
| 7 |
|
|
| 8 |
<meta name="Author" content="eclipse.org"> |
<meta name="Author" content="eclipse.org"> |
| 9 |
<meta name="GENERATOR" content= |
|
| 10 |
"Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]"> |
<meta name="GENERATOR" |
| 11 |
<title> |
content="Mozilla/4.79 [en] (Windows NT 5.0; U) [Netscape]"> |
| 12 |
Infocenter |
<title>Infocenter</title> |
| 13 |
</title> |
|
| 14 |
<link rel="stylesheet" href="http://www.eclipse.org/default_style.css" type="text/css"> |
<link rel="stylesheet" href="http://www.eclipse.org/default_style.css" |
| 15 |
|
type="text/css"> |
| 16 |
</head> |
</head> |
| 17 |
<body> |
<body> |
| 18 |
|
|
| 19 |
<h1 style="background:#0080C0;color:#ffffff;">Installing the help system as an infocenter</h1> |
<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 |
|
|
|
<p>You can allow your users to access the help system over the Internet or an |
|
|
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> |
|
| 31 |
<h2><b>Installation/packaging</b> </h2> |
<h2><b>Installation/packaging</b> </h2> |
| 32 |
These steps are for the help system |
These steps are for the help system integrator and web admin and are |
| 33 |
integrator and web admin and are not meant to address all the possible scenarios. It is |
not meant to address all the possible scenarios. It is assumed that all |
| 34 |
assumed that all your documentation is delivered as Eclipse plug-ins and, in general, you are |
your documentation is delivered as Eclipse plug-ins and, in general, you |
| 35 |
familiar with the eclipse help system. For the end users, it is assumed that they have |
are familiar with the eclipse help system. For the end users, it is assumed |
| 36 |
IE5.x or 6.x or Mozilla installed on their machines. |
that they have IE5.x or 6.x or Mozilla installed on their machines. |
|
|
|
| 37 |
<ol> |
<ol> |
| 38 |
<li>Make sure an application server is installed on the machine. We have |
<li>Make sure an application server is installed on the machine. |
| 39 |
tested with Tomcat 3 and Tomcat 4.</li> |
We have tested with Tomcat 3 and Tomcat 4.</li> |
| 40 |
<li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver from |
<li>Download the Eclipse 2.0 Release level Platform Runtime Binary driver |
| 41 |
<a href="http://www.eclipse.org/downloads/">www.eclipse.org</a>.</li> |
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>. |
<li>Install (unzip) the driver to a directory <var>d:\eclipse</var>. |
| 43 |
</li> |
</li> |
| 44 |
<li>Register the Eclipse Help application residing in |
<li>Register the Eclipse Help application residing in d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0 |
| 45 |
d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0 with the web server. Do not copy |
with the web server. Do not copy this directory elsewhere; it must remain |
| 46 |
this directory elsewhere; it must remain in Eclipse installation tree.<p>In |
in Eclipse installation tree. |
| 47 |
Tomcat this registration can be accomplished by adding the following lines to |
<p>In Tomcat this registration can be accomplished by adding the following |
| 48 |
the tomcat\conf\server.xml file:</p> |
lines to the tomcat\conf\server.xml file:</p> |
| 49 |
<pre><em><span style="font-style: normal"><</span></em>Context path="/help" docBase="d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0"> |
|
| 50 |
</Context></pre> |
<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 |
<p>In Tomcat 3 add the lines near end of the file, as the last element inside |
|
| 52 |
the ContextManager section. In Tomcat 4, add this section as the last element |
<p>In Tomcat 3 add the lines near end of the file, as the last element |
| 53 |
inside the Host section. </li> |
inside the ContextManager section. In Tomcat 4, add this section |
| 54 |
|
as the last element inside the Host section. </p> |
| 55 |
|
</li> |
| 56 |
<li>Install the following fixes, depending on which server you are using: |
<li>Install the following fixes, depending on which server you are using: |
|
<ul> |
|
|
<li><b>Tomcat 3:</b> Tomcat 3 does not have XML parser library available to |
|
|
a web application. To fix that, copy xercesImpl.jar and xmlParserAPIs.jar from |
|
|
d:\eclipse\plugins\org.apache.xerces_4.0.3\ to |
|
|
d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF\lib\ </li> |
|
| 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> |
<li><b>Tomcat 4:</b> |
| 64 |
<ul><li> Both Eclipse and Tomcat contain code to set a |
<ul> |
| 65 |
URLStreamHandler, but it can only be set once. To allow both Tomcat and |
<li> Both Eclipse and Tomcat contain code to set a URLStreamHandler, |
| 66 |
Eclipse to work correctly, a library |
but it can only be set once. To allow both Tomcat and Eclipse |
| 67 |
d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\eclipseurl.jar needs |
to work correctly, a library d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\eclipseurl.jar |
| 68 |
to be added to the class path at Tomcat startup. In Tomcat 4.0.3 edit |
needs to be added to the class path at Tomcat startup. In Tomcat |
| 69 |
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> |
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> |
<p>insert the line:</p> |
|
<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> |
|
| 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> |
</li> |
| 76 |
<li> |
<li> Because of changes to the xml library, remove tomcat\common\lib\xerces.jar, |
| 77 |
Because of changes to the xml library, remove tomcat\common\lib\xerces.jar, then edit setclasspath.bat by replacing the line |
then edit setclasspath.bat by replacing the line |
| 78 |
<pre><em><span style="font-style: normal">set JAVA_OPTS=</span></em> </pre> |
<pre><em><span style="font-style: normal;">set JAVA_OPTS=</span></em> </pre> |
| 79 |
with |
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> |
<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> |
</li> |
| 82 |
|
|
| 83 |
</ul> |
</ul> |
| 84 |
</li> |
</li> |
| 85 |
<li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.x or |
<li><b>Disable precompiled JSP's:</b>. Unless you are using Tomcat 4.0.x |
| 86 |
plan to ship the jasper jar files, you should also copy |
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 |
d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\infocenter\web.xml to |
to d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF. </li> |
| 88 |
d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0\WEB-INF. </li> |
|
| 89 |
</ul> |
</ul> |
| 90 |
</li> |
</li> |
| 91 |
|
|
| 92 |
</ol> |
</ol> |
| 93 |
|
|
| 94 |
<h2>Using the infocenter</h2> |
<h2>Using the infocenter</h2> |
| 95 |
<p>Start the web server. Point a web browser to the path of the web |
|
| 96 |
application. On the machine the Tomcat is installed, this would be |
<p>Start the web server. Point a web browser to the path of the web application. |
| 97 |
http://localhost:8080/help/. </p> |
On the machine the Tomcat is installed, this would be http://localhost:8080/help/. |
| 98 |
|
</p> |
| 99 |
|
|
| 100 |
<h2>Installing custom documentation</h2> |
<h2>Installing custom documentation</h2> |
| 101 |
|
|
| 102 |
<p>The Eclipse platform comes with its own documentation, contained in the |
<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 |
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 |
infocenter by default. To have you own documentation show up, package the |
| 105 |
documentation as Eclipse documentation plug-ins. Install them to |
documentation as Eclipse documentation plug-ins. Install them to d:\eclipse\plugins\. |
| 106 |
d:\eclipse\plugins\. </p> |
</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 |
|
<p> org.apache.lucene<br> |
| 115 |
|
org.apache.xerces<br> |
| 116 |
|
org.eclipse.core.boot<br> |
| 117 |
|
org.eclipse.core.resources<br> |
| 118 |
|
org.eclipse.core.runtime<br> |
| 119 |
|
org.eclipse.help<br> |
| 120 |
|
org.eclipse.help.webapp<br> |
| 121 |
|
org.eclipse.update.core<br> |
| 122 |
|
</p> |
| 123 |
|
<p>In addition to these plugins, depending on the operating system or machine |
| 124 |
|
architecture, you may need to also need to install the corresponding fragments |
| 125 |
|
for the above plugins (when they exist). For example, on Windows, you need |
| 126 |
|
to add the following fragments (also located in the eclipse\plugins directory):<br> |
| 127 |
|
</p> |
| 128 |
|
<p>org.eclipse.core.resources.win32<br> |
| 129 |
|
org.eclipse.update.core.win32<br> |
| 130 |
|
</p> |
| 131 |
</body> |
</body> |
| 132 |
</html> |
</html> |
|
|
|
Parent Directory
| 
Revision Log
| 
Patch