PreviousAnalyzing Data Impacts Exploring and DocumentingNext

Chapter 6: Using Annotations

In this session, you take information from a Revolve analysis and add it to an annotation. Then you use the Annotation tool to modify the annotation.

Please see the Tutorials Map to check that you have run all necessary previous sessions.

6.1 Overview

Annotations are effective ways to document your project. You can use them to make notes to yourself about project components or you can use them in multiple-user projects to tell other users about specific situations or to assign coding tasks.

Annotations are useful in helping analysts track enhancements and to help programmers share code for research. You can use information contained in an annotation as a starting point for analysis.

6.2 Preparation

This session uses the project you created in the chapter Using Revolve.

  1. If you have closed Revolve, open it as before.

  2. Open the Sample project by selecting it from the "recently used files" list at the bottom of the Project menu.

6.3 Creating an Annotation

To create an annotation:

  1. Click Browsers > Variables.

    The Variables browser is displayed.

  2. Type the data-name WS01-XCTL-PROGRAM into the Variable edit box and click Match.

  3. Click Options.

    The Variables dialog box displays, by default, those places in the application where the selected variable(s) is directly modified, referenced, or redefined. You can change this using the Variable Information Options dialog.

  4. Check the Modifications check boxes in the Direct Usage area, Indirect Usage (Lower Levels) area, and the Indirect Usage (Group Levels). Uncheck the References and Redefines check boxes in Direct Usage area.

    The settings should now be as in Figure 6-1. This selection process is called information screening.

    Figure 6-1: Information Screening

  5. Click OK.

  6. Select the WS01-XCTL-PROGRAM folder.

  7. Click Expand Completely.

    A group of information has been isolated and can be used to create a coding task.

  8. Starting from ONLINE4.CBL, select all displayed information, as in Figure 6-2.

    Figure 6-2: Selecting information for an annotation

  9. Click Capture Results.

    The Capture Results interface is displayed. This enables you to add information to annotations, subprojects, Pop files, and Tag files.

  10. Ensure that Add to Annotation is selected.

  11. Click OK.

  12. Click New annotation.

    The Required Field dialog is displayed, prompting you to, "Please Enter a Title for this Annotation:."

  13. Type:
    Locations modifying WS01-XCTL-PROGRAM

    in the open field.

  14. Click OK .

  15. Select the new annotation.

  16. Click Add.

    A Revolve dialog informs you how many elements were added to the annotation.

  17. Click OK.

The annotation is created and ready to be applied in coding tasks. Information can be added to the annotation and it can be edited.

6.4 Viewing the Annotation

To view the annotation:

  1. Click Tools > Annotation.

  2. Ensure that Title is selected in the pull-down list box.

  3. Type:

    in the Match edit field.

    Be sure to include the wild card character (*) or the match will look for an annotation named LOCATIONS.

  4. Click Match.

    The Annotation tool searches for an annotation that begins with LOCATIONS. The annotation we created in the previous procedure is displayed.

  5. Select the folder for LOCATIONS MODIFYING WS01-XCTL-PROGRAM.

  6. Click Expand Completely.

    The information about the annotation as well as the information that we captured from variable WS01-XCTL-PROGRAM is displayed.

6.5 Editing the Annotation



  2. Click Edit Annotation.

    The Edit Annotation dialog is displayed. It contains current information about the annotation, including its title, creator, intended recipients, status, and a description of the contents. You can edit any of these details. See Figure 6-3.

    Figure 6-3: Edit Annotations

  3. In the Description field, enter the text:
    Enhancement Request for all locations modifying WS01-XCTL-PROGRAM

  4. Click Ok.

  5. In the Annotation tool, double click the Details folder.

    This is where programmers will check to see why this annotation was created.

  6. Double-click the Connected to folder.

  7. Select any component that is contained in the Connected to folder.

  8. Click View Source Code.

    Notice that the source code is available for the contents of the annotation. You can implement modifications in the Annotation tool and link to other tools and browsers to extend analysis.

  9. From the Window menu, select the Close All Windows menu option.

6.6 Summary

In this session you:

6.7 Before Continuing

If you want to take a break before going on to the next session, you can close the project; or you can close Revolve with or without closing the project.

Return to the Tutorials Map and choose which session to go on to next.

Comments on the books?

Click Send Us Comments.

Copyright © 2000 MERANT International Limited. All rights reserved.
This document and the proprietary marks and names used herein are protected by international law.

PreviousAnalyzing Data Impacts Exploring and DocumentingNext