Gretyl's Portal

Heretto Help

XML Comments

Heretto CCMS enables you to add XML comments in the DITA source that show in the Content Editor. You can use XML comments as personal notes, notes for other users that contribute to your content, or as tooltips. There are two types of XML comments: standard and tooltip. XML comments do not publish to any outputs.

Note:

This functionality may not be available by default in Heretto CCMS. For more information, contact your Customer Success Manager.

Standard XML comment

A comment added inside these tags <!-- --> in the Source Editor. In the Content Editor, it is represented by text in green.

A Standard XML Comment Added in a Note
Tooltip XML comment

A comment added inside these tags <!--TIP: --> in the Source Editor. In the Content Editor, it is represented by an icon in the Content Editor. When you hover over it, you see the comment content.

A Tooltip Comment Added in a Note

Add a Tooltip Comment

A tooltip comment <!--TIP: --> is a specialized standard XML comment <!-- --> that you can add in the Source Editor. Just like standard XML comments, tooltip comments do not publish to any outputs.

Note:

This functionality may not be available by default in Heretto CCMS. For more information, contact your Customer Success Manager.

  1. In the Content Library, right-click a topic and select Edit Source.
  2. In the Edit Source window, add a comment in this way <!--TIP: Comment -->.
    Where Comment is the content of your comment.
    Important:

    Use this exact form <!--TIP: of the opening comment tag. Adding spaces or other characters to the opening tag causes the tooltip comment to behave like a standard XML comment.

    <note type="warning">
         <p><!--TIP: Tooltip comment in a warning note --></p>
    </note>
  3. Click Save & Close.

The tooltip comment is represented by an icon in the Content Editor. When you hover over the icon, you see the comment content.

An example of a tooltip comment in the Content Editor