Viewing documentation offline

Overview

Where available, the online version of the product documentation is the supported version. However, documentation is typically provided in supplemental formats, such as an Eclipse Help System plug-in and Adobe Acrobat PDF. These methods can be used to view the information:

Using an existing local Eclipse Help System

These instructions require that you have a local copy of an Eclipse-based product, such as IBM Rational Team Concert, or the Eclipse IDE. It is assumed that the Eclipse-based product is installed into a directory <eclipse_install>, such as C:\install\RTC-Client-Win-3.0iFix1\client.

  1. Download the Eclipse Help System plug-in .jar file.
  2. Copy the .jar file into <eclipse_install>\plugins
  3. Start your copy of the Eclipse-based product as usual.
  4. Click the Help menu, and select the Help contents option.

Using a PDF file

  1. Download the product documentation that is available as a PDF file.
  2. Open the .pdf file using Adobe Acrobat Reader, or other tool that supports PDF format.

Using the IBM Toolkit for Custom and Reusable Solution Information

The Toolkit enables you to view product documentation offline. The Toolkit offers many more capabilities, which are documented in a series of IBM developerWorks articles:
http://www.ibm.com/developerworks/opensource/library/os-eclipse-infocenter1/index.html

The IBM Toolkit is available from IBM alphaworks:
IBM Toolkit for Custom and Reusable Solution Information

  1. Download the most recent version of the IBM Toolkit, for example tkcarsi1.5.zip
  2. Unpackage the IBM Toolkit file into a folder of your choice, for example C:\install. The result is a new folder <toolkit>, for example C:\install\tkcarsi1.5
  3. Download the Eclipse Help System plug-in .jar file.
  4. Copy the .jar file into the IBM Toolkit folder <toolkit>\bigeasy\plugins.
  5. Start the IBM toolkit, by running the batch command:
    <toolkit>\run.bat
  6. When the IBM Toolkit window appears, click the Help menu, and select the Help contents option.

You should now see a collection of help topics, including the downloaded product documentation.