You can work with the WebSphere Application Server information
center offline after downloading the IBM User Interface Help System Built
on Eclipse and then populating it with one or more documentation plug-ins.
Note that you can also use the PDF versions of this documentation while you
are offline.
These instructions require Internet access and a machine running on a Windows® or Linux® Intel® operating
system to which you can download content. If you find a difference between
these instructions and the instructions that accompany the IBM User Interface
Help System Built on Eclipse that you download, follow the latter instructions.
- Download the ZIP file that contains the IBM User Interface Help System
Built on Eclipse to a machine running on the Windows or Linux Intel operating system.
Note: The
Requirements tab on this
Web page lists the platform requirements for the IBM User Interface Help System
Built on Eclipse. For example, Version 3.0.1 requires Java™ Runtime
Environment (JRE) 1.4.2 in order to run correctly.
- Extract the ZIP file content.
Unzip the files to a directory on your
local system.
- Read the installation instructions that are contained in the following
file:
- Windows: installation_directory/IBM_Help_301_Win/getting_started.html
- Linux: installation_directory\IBM_Help_301_Linux_Intel\getting_started_linux.html
where installation_directory is
the directory into which you extracted the ZIP file content.This file describes
how to set up a local information center.
- Run the following file to start the help system:
- Windows: installation_directory/IBM_Help_301_Win/ibm_help/help_start.bat
- Linux: installation_directory\IBM_Help_301_Linux_Intel\ibm_help\help_start.sh
If a browser window opens with an empty information center, then you
are successful. If not, troubleshoot the issue beginning with the documentation
that is provided in the following file:
- Windows: installation_directory/IBM_Help_301_Win/getting_started.html
- Linux: installation_directory\IBM_Help_301_Linux_Intel\getting_started_linux.html
- Run the following file to stop the help system:
- Windows: installation_directory/IBM_Help_301_Win/ibm_help/help_end.bat
- Linux: installation_directory\IBM_Help_301_Linux_Intel\ibm_help\help_end.sh
- Download the documentation plug-in ZIP files of your choice.
- Extract the plug-in contents.
Unzip the documentation plug-in to the
following path:
- Windows: installation_directory/IBM_Help_301_Win/ibm_help/eclipse/plug-ins
- Linux: installation_directory\IBM_Help_301_Linux_Intel\ibm_help\eclipse\plug-ins
The architecture of each IBM documentation plug-in consists of
a folder—usually named something like com.ibm.xxx.xxx.doc—within
which is contained a series of XML files, possibly some additional folders,
and a zip file called doc.zip. Do not unzip the doc.zip file.
See
the following document for more information on installing the plug-ins:
- Windows: installation_directory/IBM_Help_301_Win/getting_started.html
- Linux: installation_directory\IBM_Help_301_Linux_Intel\getting_started_linux.html
- Start the help system.
Use the following file to launch the help system:
- Windows: installation_directory/IBM_Help_301_Win/ibm_help/help_start.bat
- Linux: installation_directory\IBM_Help_301_Linux_Intel\ibm_help\help_start.sh
Your documentation plug-in is available in your local help system. You
can also download and use additional documentation plug-ins from other IBM
or third-party vendors that use an Eclipse-based help system like the IBM
User Interface Help System.