Using this documentation offline

Work offline by downloading an information center (known as the IBM User Interface Help System built on Eclipse) and populating it with one or more documentation plug-ins. This is analogous to downloading the Adobe Acrobat Reader and one or more PDF documents to view. Note that PDF versions of this documentation are the other option for working offline.

These instructions require Internet access and a machine 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 (here, used interchangeably with the term information center) that you downloaded, follow the latter instructions.

  1. Download the ZIP file that contains the IBM User Interface Help System built on Eclipse (information center).

    The help system is a download from the Alphaworks Web site at: http://www.alphaworks.ibm.com/tech/iehs
    You will need an IBM ID to download the information center. Registration is free.

  2. Extract the ZIP file contents.

    Unzip the file to the local drive. A folder titled IBM_Help_301_Win is created on the local drive. You can choose to unzip the files to another directory on your local drive.

  3. Read the installation instructions that are contained in the IBM_Help_301_Win\getting_started.html file.

    The file describes in detail how to set up a local information center. Pay particular attention to the section that addresses installing the IBM User Interface Help System built on Eclipse. If you have an adequate Java Runtime Environment (JRE) installed, you can launch the help_start.bat file to complete the installation.

  4. Launch the IBM_Help_301_Win\ibm_help\help_start.bat file.

    You can double-click the file or type its path and name at a DOS prompt. 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 \IBM_Help_301_Win\getting_started.html file. Be sure to shut down the local information center after successful installation has occurred. Use the \IBM_Help_301_Win\ibm_help\help_end.bat file

  5. Download the documentation plug-in zipped files of your choice.

    Select product-specific documentation plug-ins from the plug-ins available at: ftp://ftp.software.ibm.com/software/iea/plugins

  6. Extract the plug-in contents.

    Unzip the documentation plug-in to the following path: IBM_Help_301_Win\ibm_help\eclipse\plugins\.

    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 sometimes also a zip file called doc.zip. Do not unzip the doc.zip file.

  7. Launch the help system.

    Using the IBM_Help_301_Win\ibm_help\help_start.bat file, launch the help system. Your documentation plug-in is available in your local help system. You can download additional documentation plug-ins from other IBM, or third-party vendors using an Eclipse-based help system like the WebSphere Help System.



timestamp  Last updated: Wed, 29 Mar 2006 15:55:56 GMT
© Copyright IBM Corporation 2006. All Rights Reserved.
This is powered by Eclipse technology. (http://www.eclipse.org)