Annotations Tab

When you click on the Annotations Tab, the following dialog will appear:

Annotations Tab

Annotation View

Annotations are organized into the following different views:

View	Description
Document Annotations	A table of contents that matches the structure of the documentation being created. From this view you can simply click on a topic title to view and edit that topic.
Mismatched Annotations	A list of annotations that you previously created that no longer match any items in your database. This view will only be displayed if the structure of your database changed since the last time you opened your project. You can use this view to either remove the mismatched annotation or reassign it to the correct item.

Annotations

When you click on a topic title in the annotation view, a WYSIWYG editor displaying that topic appears to the right. Using the editor, you can edit any of the annotations associated with that topic. Each topic will contain one or more of the following annotations:

Annotation	Description
Title	The text of the topic title is used as the heading for that topic and displayed in the blue box at the top of the editor. TechWriter uses the name and type of the item to generate a default title. The format of the topic title cannot be modified through the editor. Only the text of the title can be modified.
Descriptions, Remarks and Examples	Descriptions, remarks and examples are used through out the documentation to describe your database. TechWriter creates the default values for these annotations by extracting comments from your database. The annotation editor supports editing the contents of the descriptions, remarks and examples with a rich set of formatting options that be accessed using the Format Menu and Format Toolbar.
Cover Page	When you click on Cover Page in the annotation view, the editor displays the contents used by output formats, like PDF, that include a cover page. The cover page contents are divided into three separate regions: top, middle and bottom. By default, the document title is displayed in the middle region.
Header and Footer	When you click on Header and Footer in the annotation view, the editor displays the contents used by output formats, like PDF, that support page headers and footers. The header contents are divided into three separate regions: left, center and right. And the same is treu for footer contents. By default, the document title is displayed in the left-side header region and the current page number is displayed in the right-side footer region.

If you want to discard the edits that you made, you can revert back to the default value for an annotation using the Restore Default Text option on the Edit Menu.