Generate Ruleset Documentation

Overview

This helper generates HTML-based, navigable documentation from an M2M Ruleset.

Applicable To	M2MRuleset, M2MImportRuleset, M2MExportRuleset
Menu Entry	M2M -> Ruleset Documentation -> Generate Ruleset Documentation

Generation Folder

The documentation is generated into a new folder named [Ruleset name] Ruleset Documentation.
That folder is generated into the same folder as the current Rhapsody project.

Automatic Opening

After the documentation has been generated the helper automatically opens in:

In an embedded web panel inside Rhapsody (Rhapsody 10 or above)
In the system web browser (Rhapsody 9 or below)

This may be changed by setting the following property on the ruleset:
M2M.GenerateRulesetDocumentation.OpenInBrowser

You will find this easily on the Tools tab of the M2MRuleset Settings properties perspective:
Open in browser property
The property has the following available values:

Rhapsody
External
Both
None

Note that if using Rhapsody 9 or below then values of Rhapsody or Both will cause the documentation to open in the system web browser instead.
The generated documentation may also be opened manually using the menu M2M -> Ruleset Documentation -> Open Ruleset Documentation

Generated Documentation

Generated documentation

Tabs

The generated documentation has the following tabs:

Welcome
Launch page with convenient links to other pages
Tree
A view that reflects the Rhapsody model browser:
Rules
All M2M Rules regardless of their location in the model
Functions
Conditions
New Contexts

Navigation

Each link in the documentation opens either a list page or a details page for the clicked element in the right-hand panel:
Navigation list
Navigation details
In addition, the documentation allows navigation:

To the Rhapsody Model
To Functions in Eclipse

Navigation to Rhapsody

Clicking the Locate in Rhapsody button will highlight the current model element in the Rhapsody mode browser:

This navigation uses hyperlinks of the form rhapsody:// which are automatically handled by Windows (Rhapsody register itself as a handler for such URLs on install). Only one Rhapsody instance should be running as Windows cannot handle navigation to more than one.

Navigation to Eclipse

This allows navigation from the generated web page to a function in Eclipse that was called from an M2M Function:
See Navigation to Eclipse