Importing documentation

Extensive documentation may be required for complex patterns or for an audience of new pattern users. Documentation can be imported into the static pattern data. This documentation is available to the pattern applier in the online help system listed under the heading Description.

Documentation intended for import must be in HTML format. Only the text and tags in the section tagged as body is imported. You can import documentation for both patterns and parameters. The description you import becomes part of the individual Rational® Documentation Manifest (RMD) file supplied for the pattern and parameters.
  1. In the Pattern Authoring view, right-click a pattern or parameter, and click Import Description File. The Import Description File window opens.
  2. Click the browse button and locate the HTML file to be imported.
  3. Ensure that the Update Help check box is selected and click OK. All of the help files associated with the pattern and its parameters are regenerated.

Parent topic: Providing documentation for pattern appliers

Related concepts
IBM Rational design patterns
Pattern code and support files
RAS pattern assets
Pattern project contents

Related tasks
Providing Short Description text
Adding overview diagrams
Generating documentation files
Adding documentation to pattern libraries

Terms of use | Feedback
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.