Collaborating in Real Time through the Comments Panel in Altium Designer

Two iterations of the Comments panel. On the left, the panel at it appears when signed into a self-managed server, and on the right as it appears when signed into a Workspace that has been shared with you by another user.

Summary

The Comments panel allows you to add comments to a defined area or point in the active document of a managed project. The panel allows all users who are working on the document to add comments and view all comments without actually modifying the document itself. This feature allows for the facilitation of strong collaboration processes and is invaluable when issues within the document need to be pointed out without receiving conflicts. The Comments panel essentially can be used to create a 'to do' list and as the design matures. the comments can be resolved and closed.

Panel Access

The panel is accessed from a managed project by performing one of the following then clicking in the document to define the point or area for the comment:

• Click Place » Comment for Area from the main menus.
• Click Place » Comment for Point from the main menus.
• Click Place » Freehand comment from the main menus.
• Right-click then select Place » Comment for Area.
• Right-click then select Place » Comment for Point.
• Right-click then select Place » Freehand comment.
• On the Standard toolbar (View » Toolbars » Schematic Standard), click (to begin a new comment thread for an area), (to begin new comment thread for a point) button or (to enter freehand comment mode).

Display Settings

• When signed into a Workspace, you may click the () icon to reveal the Show resolved comments option. This option, which is enabled by default, ensures that comments marked as resolve still appear in the panel. Resolved comments will appear dimmed to distinguish their standing from active comments. Disabling the Show resolved comments option removes resolved comments from the panel, though they will reappear if the option is enabled again.

The options provided in the Comments panel when signed into a Workspace.

• When signed into a self-managed server, you can configure which comments are displayed in the panel as well as specify whether or not to display the comments on the schematic or PCB by clicking the at the top right of the panel.

Content

• Project - use this option to view all comments across all source documents in the project.
• Document - use this option to view all comments for the active document.

Comments

• Active - use this option to view only active comments.
• Resolved - use this option to view only resolved comments. Comments that have been resolved will display a green bar as shown below in the image on the right.

Visibility on canvas

• Visible - use this option to ensure the comment is visible in the design space.
• Hidden - use this option to ensure the comment is hidden in the design space.

Working with Comments

Adding a Comment

The above image demonstrates how to add a new comment when signed into a Workspace that you have been granted shared access to.

• To add a new comment when signed into a self-managed server or Workspace that you have been granted shared access to, type the desired comment in the text box then click the Post button. The comment will be committed and appear in the panel. It will appear in the Workspace linked to the point, area, or component by a dashed reference line.

The above image demonstrates how to add a new comment when signed into a self-managed server.

Editing a Comment

• To edit a placed comment when signed into a Workspace that you have been granted shared access to, click the in the top right corner, then the Edit button associated with the comment you want to change. Enter your edits in the text box and click Update when you are done editing. Comments may only be edited by the user who posted the comment.

The above image demonstrates how to edit a comment when signed into a Workspace that you have been granted shared access to.

• To edit a placed comment when signed into a self-managed server, click the Edit button associated with the comment you want to change then enter your edits in the text box. Click Update when you are done editing. Comments may only be edited by the user who posted the comment.

The above image demonstrates how to edit a comment when signed into a self-managed server.

Resolving a Comment

• To resolve (closeout) a comment when signed into a Workspace that you have been granted shared access to, click in the top right order of the desired comment, then choose Resolve. Once resolved, the comment will dim and move to the bottom of the list of comments. You may resolve your comments as well as those of others.

• To resolve (closeout) a comment when signed into a self-managed server, select the comment to highlight it then click the Reply button and choose Resolve entry. The comment will be removed from the panel and the design space. You may resolve your comments as well as those of others.

Viewing and Reopening Resolved Comments

• To view Resolved comments when signed into a Workspace that you have been granted shared access to, click the control at the top right of the panel. You may resurrect comments that have been resolved by clicking the Unresolve button associated with a relevant comment. The comment will be reinstated in the panel and in the design space.

• To view Resolved comments when signed into a self-managed server, click the control at the top right of the panel and switch to Resolved in the Comments region. You can resurrect comments that have been resolved by clicking the Reopen button associated with a resolved comment. The comment will be reinstated in the panel and in the Workspace.

Deleting a Comment

• To delete a comment when signed into a Workspace that you have been granted shared access to, click the Delete button associated with that comment. Comments may only be deleted by the user who posted the comment.

• To delete a comment when signed into a self-managed server, click the Delete button associated with that comment. Comments may only be deleted by the user who posted the comment.

Adding an Avatar

An avatar can be added for a user, as well as the user's name when signed into a self-managed server. These are sourced directly from the user's profile in the Server.

Collapsing a Comment

You can collapse a comment in the design space by clicking on the small triangle at the top-left of the text area.

Freehand Comments

When using the Freehand comment feature (Place » Freehand comment, which allows you to add comments to a document by freehand drawing), the entry for a comment on the Comments panel will contain context information as follows:

• If you draw a freehand shape around a component, the comment will be tagged with the string <UserName> commented on <ComponentDesignator>.
• If you draw a freehand shape anywhere else on the document, the comment will be tagged with the string <UserName> commented on <DocumentName>.

Right-click to finalize the drawn shape and access its related text box in the Active Comments section.

Controlling Display of Comments in the Design Space

• When signed into a self-managed server, the display and appearance of comments are controlled from the Document Comments region on the Data Management - Servers page of the Preferences dialog. Controls are provided independently for comments displayed on schematic and PCB. To turn off the display of comments in the design space, relying on just the Comments panel, disable the respective Show Comment Threads option. For information regarding the other controls that relate to the look and feel of comments and reference lines, refer to the documentation page here.

• When signed into a self-managed server, the visibility of comments in the design space also can be controlled directly from the Comments panel. To do so, click the control at the top-right of the panel and switch between Visible and Hidden in the Visibility on canvas section.

Tips

• When a comment is added, it is seen instantly by all other users that have the same Managed Project and document open in their design spaces.
• The Comments panel will track the entire thread of a specific comment, however, only the latest comment in that thread is displayed in the design space.
• Within a comment thread on the Comments panel, the latest reply is always added to the bottom of that thread. Where multiple comment threads are present in a document, the latest thread is presented at the top of the panel.
• The active/selected comment on the Comments panel is highlighted. In the design space, the area/point/component that is the focus of the active/selected comment is zoomed and centered in the main design window (where applicable). For a point, area or component type comment, its associated reference line is also displayed.
• The active/selected comment on the Comments panel is highlighted. In the design space, the active/selected comment is distinguished by a dashed reference line.
• You can move a comment around in the design space, only in terms of the area in which the text is displayed. The initial defined point or area cannot be modified. The reference line extends from that point/area to the text area.