6.1. Remark menu

You may need to enable this submenu by checking "Enable the 'Tools|Remark' Submenu" in Options → Preferences, General|Features section.

What is a remark?

A remark is simply a <?xxe-remark> processing-instruction nicely rendered as a balloon in the styled view.

Figure 3.2. A remark made by user hussein and its tooltip.

This balloon contains the first two letters of the username (login) of the author of the remark.

This balloon is given a random background color, which is specific to the author of the remark. For example, the color of all the remarks created by user hussein will always be green, but there is no way for user hussein to choose the color of his own remarks.

Hovering the mouse over this balloon displays the contents of the remark in a tooltip.

Double-clicking on this balloon displays a remark editor. Which remark editor is displayed depends on whether this editor is used to create a new remark or to reply to/modify an existing remark.

Figure 3.3. Remark editor #1 displayed when a new remark is to be inserted in the document

Figure 3.4. Remark editor #2 lets the user reply to a remark made by another user or modify her/his own remark or delete it

The Remark menu

Insert or Edit Remark

If a remark is explicitly selected or if the caret is contained in a remark, display the remark editor #2 which lets the user reply to a remark made by another user or modify her/his own remark or delete it.

Otherwise display the remark editor #1 in order to create a new remark. The new remark is inserted before the explicit selection if any, or at caret position otherwise.

Delete Remark

Delete explicitly selected remark, if any. Otherwise if the caret is contained in a remark, delete this remark.

Delete All Remarks

Delete all remarks.

Select Preceding Remark

Select preceding remark, if any.

Select Following Remark

Select following remark, if any.