Installing help content locally from the help archive site

If you have an Internet connection, you can use the Local Help Updater to install help content on your computer from the remote IBM® help archive site.

Before you begin

Typically, this task is done on a computer where the product is installed. If you are installing the help on an intranet server where the product is not installed, you must first deploy the help system infrastructure on that server. Then, you can install the local help.

About this task

This task can be used to install help content on your computer or on a server. You use the Local Help Updater to install local help content on your computer from the remote archive site, as shown in this graphic.

The image shows how you can install local help content on your computer from the remote help archive site.

Procedure

  1. With your product open, click Help > Local Help Updater.
    Note: You can also access the Local Help Updater by opening the following Help Administration page URL in a browser: http://server:port/help-name/updater/admin.jsp. Then, select the Update Help Content tab.
  2. In the site list, expand the product that you would like to install the content for. The list of sites in the Available content section are filtered to display your Favorites by default, which includes internal sites you added or public sites that you installed content from. To see other sites, change the filter to All sites. If the site list does not populate, you might have to use the Installing help content locally from a downloaded archive file task instead of this one.
  3. Select the help content features to install from the list that is provided, and click Install.
  4. When the installation finishes, open the help in the product by clicking Help > Help Contents.

Results

The help that you selected is installed and is available from your product.

What to do next

If you downloaded the help to either a server or your computer:
  • You can choose to enable automatic updates. By default, the Automatic Updates option is not selected in the Local Help Updater. If you select the Automatic Updates option, you receive updated content from the site and the sites in the Favorites Sites list when the help archive file is restarted and an internet connection exists. If you choose to leave the Automatic Updates check box cleared, you can manually update content.
If you downloaded the help to a server and the product was installed by using IBM Installation Manager:
  • If other users are accessing this help content from the products that were installed on their computers with IBM Installation Manager, provide them with the server, the port, and the path to the help system. Ensure that the server you provide is not localhost.
    Example: http://server.ibm.com:8080/help-name/index.jsp
    • Server: server.ibm.com
    • Port: 8080
    • Path: /help-name

Feedback