Creating a Review Comment
There are three ways to create Review Comments in a Specification.
- Under the Review menu, select the New Comment menu item;
- In the Navigate > Issues view, click on the Review Comment button in the window;
- In the XML Editor, select the relevant text in the formatted text view and click the New Comment button in the Editor toolbar.
A user can view all comments for all stored Specifications in the Repository. There are no restrictions.
The natural workflow is to first store a new Specification revision into the Repository, and then write review comments on the contents. Review comments can either be saved to the file system or stored into the Repository. The normal workflow is to store all review comments in the Repository. Review comments are unique for a Specification revision.
The Review Comment Window
When a new Review Comment is created for a Specification, a Document Window is opened.
- Write a description in the subject field which makes it easy to later find the Comment in the Navigate > Review Comments table.
- The Responsible field should have been prefilled with the macOS login username. If the contents of the Responsible field is changed, the status of the comment may be impossible to change. Once the Comment is stored in the Repository, the status can be changed only by the user who is subject responsible.
- The identity number field is set by the Repository when the Comment is stored. The number can never be changed.
- A value from the Severity popup menu must be selected before the Comment can be stored.
- Write the comment in the Text view. A log notation can be added by clicking the Log button.
- The Reference part of the Review Comment Window contains information about the Specification. The information can be changed before the comment is stored. Referenced document rows are the rows in the XML document.
- Click the Store button to store the comment in the Repository. Additional information can be added after the Comment has been stored.
- Click the Save button to save the Comment to the local file system. This can be done if the Specification is not yet stored in the Repository. A Review Comment can be opened in the Finder by double clicking it.
Working with comments in the XML Editor
A user can create Review Comments for a Specification that is stored in the Repository by:
- Load the Specification and open the XML Editor.
- Make a selection in the formatted text view where the Comment should appear and click the
New Comment
button in the Editor toolbar. The position of the Comment is marked by a sticker.
- To view a Comment in the Editor, double click the Comment symbol. New text can be added in the Window, but the referenced information cannot be changed. Changes will only be saved by clicking the Store button.
- A user can view Comments for the revision that is displayed in the Editor by
selecting Review > Show Comments > This Revision in the main menu.
- A user can view Comments for the latest stored revision by selecting Review >
Show Comments > Last Stored Revision in the main menu. These Comments may refer to a
different version than the version displayed in the Editor.
- A user can view Comments for older revisions by selecting Review > Show
Comments > Older Revisions in the main menu. These Comments will refer to older
versions than the version displayed in the Editor.
- A user can view all Comments by selecting Review > Show Comments > All Stored Revisions in the main menu. Some of the Comments will refer to other revisions than the version displayed in the Editor.