Inserting Topic Comments

You can include comments with any topic in your Help file. Comments are purely optional statements that you create for your own use. They have no meaning to users or to the Help compiler, but they may be useful in your process. For example, you could use a comment footnote that tells writers and editors the topic's status. Whether you use comments and how you use them is strictly up to you. You use an at sign (@) footnote to identify a comment.

To insert a comment into a topic

1.1.Position the insertion point at the beginning of the topic (to the right of the other footnotes).

2.2.From the Insert menu, choose Footnote.

The Footnote dialog box appears.

3.3.Type the at sign as the custom footnote mark, and then choose OK.

A superscript at sign ( @ ) appears in the text window, and the insertion point moves to the footnote window.

4.4.Type the comment to the right of the at sign in the footnote window.

Use only a single space between the at sign and the first word of the comment. For example, you might type the following comment for the “Saving Files” topic in Cardfile Help:

@ This topic has been edited but not proofed yet.

Figure 6.15 shows this footnote window.