Adding documentation to pattern libraries

The pattern library maintains information about its member patterns in a static data file. You can add documentation to this library manifest file for the pattern applier to use.

A small subset of library information is displayed in the online help when the pattern applier clicks the Show Pattern Documentation menu item in the Pattern Explorer view. You can add a short description to this library information.

The library's manifest file has the same name as the library, with a file extension of .rmd.

To add a short description to the library:

  1. In the Package Explorer view, locate and expand the PatternFiles node in the pattern project.
    An expanded PatternFiles folder of a pattern project.
  2. Double-click the library manifest file to open it in the RAS Manifest editor.
  3. On the Asset page, delete the default text in the Short Description field and type the information you want to add for the library.
  4. Click File > Save All to save the changes.
  5. In the Pattern Authoring view, right-click the project library and click Generate Help Files to add the manifest information to the project files.
  6. In the Package Explorer view, expand the PatternHelp node under PatternFiles and double-click the library's HTML file. You can view the changes that you made to the file.
Note: You can modify additional library manifest properties by using the RAS Manifest editor, but use caution. Pattern projects depend on the integrity of the library and pattern manifest files to build and import pattern plug-ins.
Related concepts
IBM Rational design patterns
Pattern code and support files
Reusable Asset Specification (RAS) pattern assets
Pattern project contents
Related tasks
Providing short description text
Adding overview diagrams
Generating documentation files
Importing documentation
Feedback
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.