Note to IBM Internal User

Remove this file before distributing your help system.

Description of the IBM WebSphere Help System package

The following files and directories have been added to the WebSphere Studio Workbench help system minimal subset:

Root directory
The WebSphere Help System (Windows) or ibm_help (Linux and UNIX) directory contains the following files:
  • Batch files (*.bat) / shell scripts (*.sh): These files are basic implementations of the startup and shutdown commands for the WSWB UA System. You may customize, replace, or remove these files as required by your product.
  • installing_and_managing.htm: This file introduces new users to the WSWB UA System.
  • installing_plugins.htm: This optional file is required when your product distributes documentation plug-ins separately from the WSWB UA System. If you require this file, you must edit it to reflect your product. If the file is not needed, remove it from the WSWB UA System package.
eclipse/ directory
The /eclipse/ directory contains the following customizable file:
  • install.ini: Customize this file to specify the primary feature of your information center.

All other files and directories within the /eclipse/ directory must be left in place.

eclipse/features/ directory
The eclipse/features/ directory contains the following feature:
  • com.ibm.help.doc: Feature for the external documentation packaged with the WSWB UA System, including NL licenses.
eclipse/plugins/ directory
The /eclipse/plugins/ directory contains the following plug-ins:
  • com.ibm.help.doc: Includes Sofware Group (SWG) Common Look and Feel Templates for CSS, welcome pages, imagery, in the images and welcome subdirectories. If modifications are needed in other files, follow the SWG User Technology Technical Council Design Change Request Process. For further information about distributing this plug-in with your information center, see External documentation plug-ins. Every SWG product should include this plug-in in their help system.
  • com.ibm.help.doc.nl1: NL fragment that provides the translated resources for the com.ibm.help.doc plug-in.
  • com.ibm.help.hs.doc: External documentation for using the WSWB UA System installed as a standalone help system or with a WSWB-based product. For further information about distributing this plug-in with your information center, see External documentation plug-ins. Delete this plug-in if you are deploying the WSWB UA System on a Web server.
  • com.ibm.help.ic.doc: External documentation for using the WSWB UA System installed on a Web server. For further information about distributing this plug-in with your information center, see External documentation plug-ins. Delete this plug-in if you are deploying the WSWB UA System as a standalone help system or with a WSWB-based product.
  • com.ibm.wswb.start.doc: IBM internal documentation for getting started with the WSWB UA System, including legal requirements for using the WSWB UA System with your product. Delete this plug-in before distributing your information center.
  • com.ibm.wswb.ua.doc: IBM internal documentation for developing plug-ins for the WSWB UA System, including look and feel requirements for Software Group products. Delete this plug-in before distributing your information center.

External documentation plug-ins

Two versions of the "Viewing information in the help system" topics have been included in this package. You must choose the version of the topics that match the way your help system will be deployed for customers and take the corresponding actions.

Help system installed locally
The com.ibm.help.hs.doc plug-in contains documentation and navigation suitable for use in a standalone help system or in a product based on the Eclipse IDE. To deploy this set of topics, delete the com.ibm.help.ic.doc plug-in before distributing your help system to customers.
Help system installed on a server
The com.ibm.help.ic.doc plug-in contains documentation and navigation suitable for use in an information center running on a Web server. To deploy this set of topics, delete the com.ibm.help.hs.doc plug-in before distributing your information center to customers.

(C) Copyright IBM Corporation 2003,2004. All Rights Reserved.