Authoring - Using annotations

The following steps demonstrate the actual use of annotation. In our role playing here, the user "MICK" was the editor who made a mistake. User "DON", the reviewer, detected this, added an annotation and rejected MICK's work.

We are now back at MICK's Workbench session. The next steps explain how the annotation can help him to correct his work.

Annotation notification received in the inbox

Step 1

Start a new Workbench session and log on with the user ID "MICK".

Step 2

Click on the "Inbox" pane on the bottom of the Workbench. If required, refresh the message list by clicking on the "Refresh" button on the far right of the pane.

Step 3

The inbox probably contains messages about the task transition but ignore these for now. Just double click on the message about the annotation.

The associated content object will be preselected in the tree, and you can read the annotation in the bottom pane of the Workbench.

Reading annotations

By default, you see the annotation of all contributors. Use the drop-down list in the top bar of the "Tasks" pane to see the annotations of one specific person.

You can remove your own annotations at any time. If you are the assigned performer of the current task, you can also remove annotations added by other people.

the first time you select a folder or a topic its annotations will appear automatically on top of the tabbed pane on the bottom of the Workbench. If you switch to another tab (e.g the Inbox) and reselect the same topic or folder, then the selected tab will not change. Of course to enable this behavior, you should have enabled the visibility of the Annotations tab by means of the 'Window>Show view>Annotations'.

Authoring

 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Smartcontent
 Notification
 Feedback
 Translating
 Customizing the look and feel
 User accounts
 Security
 Working with templates
 Working with metadata
 Versioning
 Auditing
 Workflow management
 Annotations
 Overview
 The annotation notification
 Adding annotations to folders and topics
 Using annotations
 Searching for objects with annotations
 Inserting annotations in a topic body
 Controlling the applicability of annotations
 Setting the access permissions of annotations
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript