Adding an Annotation

You can add an annotation to a repository object by clicking an icon in a Browse view or the Reviewer interface, using a Workbench context menu command, or through an integrated XML editor repository menu command.

• To add an annotation to a structured document element from the Browse view or Reviewer interface, click the comment icon () at the top of the window, then drag and drop the resulting box onto the element on which you want to attach the annotation.
  The element is highlighted and a dialog box appears.

  
  

  

  
  

  The fields that appear in the dialog vary, depending on the definition of the annotations in your repository.

  1. Select the Type of annotation from the list.
     Note: If only one annotation type has been defined in your repository, that type will be selected automatically.
  2. Enter or select values for the remaining fields as appropriate for the annotation definition.
     Other fields might include details such as:

     • a free-text comment field
     • review status
     • due date
  3. Click Save.
     The annotation is saved in the repository. A green annotation indicator icon () appears to the left of the annotated element. A comment box displaying the user who made the comment, the date and time the comment was added, and the annotation summary text, appears in the right margin of the window.

     
     

     

     
     
• To add an annotation to a folder object or document element using a Workbench context menu command, or to a structured document element using an integrated XML editor repository menu command, select the object or element for the annotation and open the Annotations dialog.

  Option	Action
  Workbench context command	Navigate to the object or element in the Navigation view or a Details view. Note: If your system is not configured to allow annotations on the selected element name, an error message will be issued when you try to add an annotation. For example, if your system is configured to allow annotations only on elements that contain text, you cannot set an annotation directly on a step element, because the step element is only a container for lower-level elements. Instead, you must expand the step element to the command element or other lower-level element that contains text. See Annotation View Options. Note: Annotations placed on a structured document filename are not visible in a Browse view or in the Reviewer interface. Instead, expand the structure in the Navigation view and select a document element, such as the title. Right-click the object and select Task > Show Annotations.
  integrated XML editor	Place your cursor in the element of interest and select Repository > Astoria > Show Annotations. Or select the Get Next Annotated Element command from the repository menu.

  The Annotations dialog appears.

  
  

  

  
  
  1. Below the Annotations box, click Add and, if prompted, select the annotation type from the list, then click OK.
     Note: If only one annotation type has been defined in your repository, that type will be selected automatically.
     In the Annotations dialog, the Annotation box displays the fields defined for the annotation type selected.

     
     

     

     
     
  2. Enter or select values for the remaining fields as appropriate for the annotation definition.
  3. Click Ok.
     The annotation is saved in the repository, noting the user who created it and the date and time it was created.