Comments and bookmarks enable you to annotate your text and create jump markers so that you can quickly access topics or chapters that you need to edit frequently.
Comments and bookmarks are separate. You cannot jump to comments and you cannot add text to bookmarks, other than the label that is the bookmark name. However, they can be associated with one another: You can set a configuration option that will automatically create a bookmark for every comment you enter.
Key Information
Comments and bookmarks are only an editing tool to make working on your project easier. They are not normally exported when you publish your project. However, you can export comments to PDF.
|
You can configure Help+Manual to automatically create a topic bookmark for every comment you insert. Open Program Options in the File menu and activate the option Automatically manage topic bookmarks for every comment. Then a bookmark with a pin in the Table of Contents will be added for every comment you create. These bookmarks can be viewed and accessed with the Bookmarks tool in the Project tab.
|
You can insert multiple comments in a single topic. If you wish you can also set a configuration option that automatically creates a bookmark for every new topic you enter.
1.Click in the position in the editor where you want to insert your comment. (You can insert comments both in the topics themselves and in the header.)
2.Select in the Ribbon.
3.Enter your comment text.
4.Select Show comment as icon only if you want to hide its content inside the topic. |
You can include your comments as annotations in PDF output, with a date range to include only comments from a specific time span. This can be a useful option when your project is being reviewed for comments by team members, editors and so on. Then they can see your annotations directly and add their own to the review PDF as well.
To include the comments in the PDF select the comments option displayed in the Publish dialog when you export your PDF file.
|
Bookmarks always link to the top of a topic and you can only manually enter one bookmark per topic. Automatic bookmarks generated for comments (see below) all also link to the top of the topic, even if there are multiple bookmarks for a single topic.
Bookmarked topics are identified with a red "pin" icon in the Table of Contents.
Inserting bookmarks:
1.Select the topic you want to bookmark.
2.Select Bookmark > Bookmark Current Topic in
3.Enter a descriptive name for the bookmark and click OK.
Deleting bookmarks:
Select Bookmark > Remove Bookmarks in then click on the bookmarks you want to remove.
Inserting automatic bookmarks for comments:
This is a configuration option. Go to and check the option Automatically manage bookmarks for every comment. A new bookmark will then be inserted automatically for every comment you create, using the first few words of the comment as the bookmark identifier. See Program Options for details.
|
•Select and select the bookmark want to jump to from the list.
Note that when you jump to a comment or bookmark you are always jumping to the topic containing the bookmark. You cannot jump to the position of a comment within the topic, even if the bookmark was inserted automatically when you created the comment.
|
•Double-click on the comment in the editor. If only the pin icon is displayed you must double-click on the lower half of the icon.
OR:
•Right-click on the comment in the editor and select Edit. Again, note that the clickable area is in the lower half of the pin icon.
Changing the comment's text style:
The appearance of the text in the comment controlled by the standard Comment style, which you can edit by selecting This is a special style that has quite limited features compared to most other styles. See Caption and comment styles for details on this.
|
You can insert the text from comment a into your topic by right-clicking on it in the editor and selecting Convert to plain text. You can "abuse" this feature to use comments as a store for text that you may or may not want to include in your topics – for example for text that is not yet finalized. When you want to insert it just convert the comment to plain text.
|
See also:
Graphic caption and comment styles