Altium NEXUS Documentation

Collaborating in Real Time through the Comments Panel in Altium NEXUS

Created: January 12, 2021 | Updated: September 14, 2021
All Contents

Parent page: Working with Panels

Summary

The Comments panel allows you to add comments to a defined area or point in the active document of a Workspace 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. Placed comments are available in real-time to collaborating users – those that have shared access to the document – and are saved to the server independently of the project, without altering its constituent documents in any way.

Panel Access

The panel is accessed from a Workspace project in the following ways:

  • Click the Panels button on the bottom-right of the design space then select Comments.

  • Select the View » Panels » Comments command from the main menus.
  • Double-click on the marker pin of a comment placed in the design space.
In order to access the Comments panel, the active document must be a schematic or PCB document of an opened Workspace project. Only those projects currently shared with you will be available for selection.

Use these links to access the corresponding command documentation pages:

Schematic Comment commands

PCB Comment commands

For more information on support for projects from the Workspace perspective, see Design Management with a Connected Workspace.

Display Settings

The panel's  button toggles the visibility of comment marker pins on the document. Comment entries still may be selected as usual in the Comments panel listing.

Use the options drop-down menu in the Comments panel () to configure comment visibility and notifications, and the associated  button to toggle between the filtered and unfiltered view:

  • All – all comments placed on the design will be listed in the panel.
  • My – show only those comments that mention my user name and/or are assigned to my user name.
  • From – show comments placed by the selected user only.
  • Unresolved – comments that have been resolved are not included in the listing.
  • Current Document – show only comments that have been placed on the currently active document.
  • Notifications – receive email alerts for all comment activity in this design (All), for only those comments where you are mentioned or assigned (My), or do not receive email alerts at all (None).

Working with Comments

Placement

To place a comment in the editor space, run the command for it first. This can be done by performing one of the following:

  • Click the  button available in the Comments panel.
  • Click  near the top right-hand corner of the design space.
  • Click Place » Comment from the main menus.
  • Right-click then select Comment from the design space.

Comments can be assigned to an object, a specific point, or an area on the active document. The command invokes the comment placement mode and the cursor changes to a crosshair with a blue circle that detects and highlights objects for selection:

  • Click a highlighted object to attach (pin) a comment to that object.
  • Click in an un-highlighted area to attach a comment to that specific point on the document.
  • Click away from an object and drag the cursor to create a rectangular highlighted area, and then click again to confirm its final shape to attach a comment to the specified area.

The placement action then opens a comment entry dialog that offers a field for entering the comment text, and also additional options for adding a freehand drawing to the comment () and including a reference to a specific user or group (). Click  to confirm the comment creation, which will associate the comment with a numbered pin marker on the document and also add a comment summary entry to the Comments panel.

Comment Dialog

Interaction with a placed comment is through a pop-up comment dialog, which shows all entries in the selected comment thread and includes options to preview, reply, edit, resolve, and delete an entry. The dialog is opened when initially placing a comment, or when a placed comment is selected in the Comments panel or in the design space. Press Esc or click in the design space to close the comment dialog.

You can sequentially step through all available comments using the previous/next buttons () in the dialog's header.

Preview

Select the Show original design screenshot option in the initial comment to see a graphical capture of the editor area when the comment was placed. Click the icon at the top-right of the screenshot to open a full-size preview (click the  icon at the top-right of this preview to close it).

Reply

Enter text, and optionally a user mention (@), in the Reply field to add a new entry to the comment thread. Click  to confirm the entry.

Mentions and Assignments

Along with text in the comment entry dialog, a 'mention' reference can be added for any other user or role registered with the connected Workspace by entering the @ character or clicking the dialog's button. Select a name/email from the dropdown list to add the user (team member) reference to the comment, and also as an Assign To entry. Uncheck the latter option if you do not wish the comment to be regarded as specifically assigned to that user or group. A Role group (say, 'Engineers'), and therefore its constituent users, may also be added as a mention and/or assignment.

Edit and Delete

An existing comment may be edited by the author of that comment using the Edit option available from the comment's  menu. Click the  button to confirm the comment edit.

Use the Delete option to remove the currently selected comment. Note that the entire thread will be removed if the initial comment (as opposed to a Reply) is deleted.

Resolve

Click the dialog's  button to toggle the comment state between Resolved and Unresolved (the default). A resolved comment (closed as complete) is inactive and non-editable, and both its entry in the Comments panel and its pin marker on the document are grayed out.

Positioning

A comment's location in the editor space is moved by dragging its associated 'pin' to a new position – during or after its placement. When selected, the comment pin includes a connecting line to its associated object or area.

A comment also may be positioned during its initial placement by clicking and dragging when in placement mode. 

Drawing

When placing or editing a comment, select the  option button to add freehand drawing with the resulting pen cursor. Click and drag to create lines, and then right-click to finish and associate the drawing with the currently selected comment.

To access the Freehand Drawing mode of the Properties panel, press the Tab key when freehand drawing mode is active (this is indicated by the  icon in the design space). These options allow you to undo and redo comments under the Commands drop-down and change the width size and color under the Properties drop-down.

PCB Comments

Comments also can be placed on a board layout in the PCB editor space using the same placement approach to that in the schematic editor. When a comment entry is selected in the Comments panel, the system will open (and load if necessary) the associated design document. 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

お問合せ

お近くの営業所にお問合せください。

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: