Updating the help content

If you use local help or intranet help, you must periodically update the help content to ensure that you are accessing the most up-to-date information.
About this task
Automatic updates are not enabled by default. To enable the automatic updates, so you do not have to complete this task to manually install updates, choose one of the following options:
  • In the product, click Window > Preferences > Help > Local Help Updater. Select Enable automatic updates.
  • Open the Local Help Updater. Select the Automatic Updates option.

If you do not choose to enable the automatic updates, you can manually update content by completing the following procedure.

Procedure

To manually install updates:

  1. Depending on whether you have Internet access, select one of these options:
    • If you are connected to the Internet, complete these steps:
      1. In a browser, open the Help Administration page by typing the URL that is in this format: http://localhost:port/help-name/updater/admin.jsp.
      2. Select the Update help content tab. The Local Help Updater opens.
    • If you are not connected to the Internet, complete these steps:
      1. On a computer that has internet access, open the Rational® help download site and download the compressed help-content file for your product. The file has this format: product_abbreviationversion_updateSite.zip.
      2. Move the updateSite.zip file to the location where the help web archive file is running to host the help system. That location is either your computer or the intranet server.
      3. In a browser, open the Help Administration page by typing the URL that is in this format: http://localhost:port/help-name/updater/admin.jsp.
      4. Select the Update help content tab. The Local Help Updater opens.
      5. Click the Add internal site icon Add internal site icon. Enter a Name for this help source.
        Note: You must enter a name that uses English characters only and does not include punctuation. Double-byte characters are not supported.
        For the File, browse to the location of the local updateSite.zip file.
  2. In the Installed Content pane, if an Update iconUpdate icon is displayed next to a help feature, updates to that feature are available. Select the help features that to update.
  3. Click the Update icon Update icon. The updates are installed on your computer.
  4. When the update is completed, open product and click Help > Help Contents to verify the update.

Feedback