Generating pattern library documentation

Five types of files are generated: library, pattern, parameters, description, and overview. The pattern and the overview files share the same information. Static data in the files include properties such as library names, pattern names, and parameter names, versions, authors, groups, multiplicity, short descriptions, and parameter UML types. You can import a description file for each pattern and each of its parameters. Pattern descriptions are inserted into the description files and parameter descriptions are all inserted in the pattern's parameter file.

You have the option to generate these file sets for the entire project or for individual patterns. If you generate help for at least one pattern in the project, the individual library file is also generated automatically. Although not essential, additional information about the pattern library can be added by using the RAS Manifest editor.

If you do not generate these files, they are not included with the pattern project. If the pattern applier attempts to view the files, a message states that no documentation is available. If you change any of the information that these files contain, you must generate the help files again to update the files.

The following screen capture shows a section of the online Help window showing the pattern specific topics. The pattern online help is displayed under the Applying patterns topics. In this example, the pattern library name is sample.