Accessing the local context-sensitive help in Eclipse environments

To access the context-sensitive help from within Eclipse, you must download the documentation files locally.

Before you begin

You must download the help files onto your computer.

About this task

To use the local context-sensitive help from within Eclipse, you must start the local instance of the knowledge center. The installer inserts the necessary parameters to access the help from the Designers.

If you want to change the parameters to point to a different instance of the knowledge center, for example a shared knowledge center server running on an internal network, you can modify the values in the Eclipse.

Procedure

  1. Check that the settings to use the local help are set correctly:
    1. Click Window > Preferences > Help > Content.
    2. Select the link to the knowledge center and click Edit.
    3. Make sure that the local knowledge center has the following values:
      • Name: Local
      • URL: http://localhost:9090/kc/SSQP76_8.8.0

      Make sure that the local help entry is at the top of the list. If not, move it up by using the Up button.

    4. Click OK, and then click Apply and OK.
  2. Start the local help:
    • In the Start menu, click All Programs > IBM > package_group > Help and Support > Start Knowledge Center (local)
    • Run the <InstallDir>/doc/launchKC.bat (Windows) or <InstallDir>/doc/launchKC.sh (Linux)
    Important:

    If you installed the product on Windows 7 in the Program Files or Program Files (x86) directory without administrator privileges, you might not be able to start the help system. To avoid potential issues, be sure to install the product with administrator rights or in a different directory.

  3. On the Help menu, click Help Contents.

    The local help system opens with all the downloaded documentation in the table of contents. You can access the context-sensitive help by clicking F1 in the user interface.

Parent topic: Installing and accessing the documentation locally