Exploring the GetStarted template

The GetStarted template creates a document that includes all the diagrams and all the classes in a model, arranged in alphabetic order by name. The template extracts the diagram names and images, and the class name and description. The template view displays the GetStarted template you just opened.

About this task

Follow these steps:

Procedure

  1. Expand the template nodes by clicking the plus signs (+).
  2. Click the first node in the template view to select it. The text displayed on the Text tab is a text node that contains only the Table of Contents for the document.
  3. Click the next node (From class "Model"…), expand the tree by clicking the (+) sign and review at the information about the Text tab. You see boilerplate text (in black), attributes (in blue), and formatting commands (in green). This node is an iteration node. The iteration node and the subnode extract every collaboration diagram from a model.
  4. Click through the other tabs in the template node view to see what is there. The information about the Sort tab tells IBM® Rational® Rhapsody® ReporterPLUS to sort the collaboration diagrams alphabetically by name. The information about the No Data tab tellsRational Rhapsody ReporterPLUS to print "No collaboration diagrams" when you generate a document from a model that does not contain any collaboration diagrams.
  5. Click the subnode (…iterate over instances of class "Collaboration Diagram") The «$name» attribute tellsRational Rhapsody ReporterPLUS to print the diagram name in the generated document; the «image» attribute represented by the [INSERT PICTURE] command prints the diagram itself.
  6. Click the next node. It is a text node that holds a section heading for the table.
  7. Click the table node (also labeled From class "Model"…). A table node is simply an iteration node that displays information in a table. The table node extracts every class from the model and prints the class name, description, and displayName in a three-column table. The headings for the table columns are in the body section of the Text tab.

    If you click the Iteration tab, you can see that the Table box is checked. To turn a regular iteration node into a table node, you check this box and set up the columns.
  8. Click the subnode (…iterate over instances of class "Class") to see the definition for the rest of the table. The attributes on the Text tab indicate that the class name, description, and displayName are included in the table.

Feedback