Tracking Changes between Baselines

Caliber provides a feature to track changes in requirement descriptions, and/or status, priority, UDAs using DocFactory in between two baselines for Microsoft Word 2003 Pro and above. All these changes between two baselines of a project are tracked in an XML output generated from the Document Factory.

This feature in doc factory works like the Compare feature in MS Word, the results are generated based on the comparison of two documents.

Note: This feature allows you to compare only two baselines of a particular project at a time.
CAUTION:
The global keywords (like projects, project descriptions, baselines, baseline description etc.,) should be used outside the $BEGIN_SECTION/$END_SECTION to get the correct results when used with the $DIFF command.

To Track Changes between Baselines

  1. Open a Document Factory template or Microsoft word document.
  2. Enter the DIFF tag with proper parameters. Following is an example of the DIFF command usage/syntax.

    $DIFF {Current Baseline – Baseline 1.0}

  3. Enter Commands, Keywords, operators you would like to use that correspond to requirement attributes, or whose changes you want to track for the project, along with the $DIFF command and save the template in a desired location.

    Example: The following example illustrates the use of DIFF command to print out the changes for hierarchy, requirement name, id number, requirement description, priority, status in between baselines, Current and Version 1.0 of project Automated Teller Machine:

    $PROJECT{Automated Teller Machine}
    $DIFF{Version 1.0-Current Baseline}
    $BEGIN_SECTION
    
    $SORT{hierarchy}
    <<hierarchy>> <<name>> — <<id_number>>
    Priority — <<priority>>
    Status — <<status>>
    <<description>>
    
    $END_SECTION
  4. Open document factory by selecting Programs > Caliber > Caliber Document Factory from the Windows Start menu.

    Caliber Document Factory prompts you to log on if you have not already logged in.

  5. Select the above created template from the respective location while using the Caliber document Factory wizard. See related procedures on “Creating a Document Using Document Factory”. Complete the four steps of the wizard. The above works in the way as mentioned, when there are differences found in between baselines for the parameters specified in the template. For when there are no differences found, see Step 8.
  6. The result document can be viewed by navigating to the directory where it is saved and opened in MS Word. A word document (.xml) opens up on the screen displaying the differences (track changes) between the two baseline versions based on the parameters provided in the document factory template.
  7. Preview the changes between the two baselines and save the file to a folder of choice if you wish to.
    Note: Make sure that in MS Word, Word Options > Advanced > Show Document Content > Show field codes instead of their values is unchecked. This is for the images to appear correctly in the output document.
  8. If there are no differences corresponding to the requirement attributes in between two baseline versions that are specified using commands and keywords in the template, then a message pops out saying “No difference found”. The result file will still be generated with values for the parameters specified in the doc factory template and will not indicate any difference.
  9. Click OK to dismiss the dialog box.

You can also work in a Word document, and later convert it to a template file and place it in a folder reserved for Document Factory templates for future reuse.