Annotations

The Annotations tool displays the annotations that have been created in terminals using the Create Annotation dialog. The most recent annotations are displayed at the bottom of the list, which can be set to autoscroll as new annotations are appended (The tool's search bar contains the autoscroll option). The Annotations tool provides access to convenient note-related actions, including:

Annotations are displayed in the Annotations tool using the same colors as their parent terminal. The status column uses the same display format as the Marks tool. The tool's font and capacity are configurable under the History and Notes Tools category in the Global settings. Note that these settings are shared with the History tool. Via global settings, certain actions can be configured to run on a double-click, Control-click, Shift-click, or middle-click of an annotation.

The Annotations tool is both navigable and searchable, having a current selection that can be moved and acted upon using generic or tool-specific actions. Searches entered into the tool search bar will filter the list of annotations, showing only those annotations whose text matches the search string. Several table columns besides the text and status are available, including the line number, username, hostname, and creation time. Drag table column headers to reorder them and use the header's context menu to show and hide individual columns. If the table header is not visible, show it using Tools→Display or ToggleToolTableHeader. Sorting is not supported; annotations are always displayed in chronological order by their creation time.

When an annotation's terminal has been closed or the annotation has scrolled off the top of its terminal's scrollback buffer, the contents of the annotation region will be lost and some tool functions such as copy and select will not be available.

The Annotations tool can be filtered by terminal and server using Tools→Filter, the context menu, or by calling the various ToolFilter actions directly. Individual terminals or all terminals belonging to a given server can be whitelisted or blacklisted using filter actions. Annotations belonging to closed terminals can also be removed from the list using the filter menu or ToolFilterRemoveClosed. Note that the tool filter is shared between the History, Annotations, and Tasks tools.

The nearby figure shows the Annotations tool in a typical situation. Annotations from two terminals are visible: one using a light-background theme and one using a dark-background theme. The first annotation in the list is selected. The second annotation has been given an exclamation mark as its note character rather than the default number.

Picture of Annotations tool with a selected annotation.

Example of a typical Annotations tool with a selected annotation.