Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 1.1
43.23.13.02.12.01.11.0
Close
Search Search on Documentation

Comments Panel

Created: July 18, 2018 | Updated: July 19, 2018 | Applies to version: 1.1
Now reading version 1.1. For the latest, read: Comments Panel for version 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

 

Parent page: System & Environment Panels

Add comments to a specific point or area in the active document using the Comments panel.
Add comments to a specific point or area in the active document using the Comments panel.

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 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.

The new Comments panel GUI is seen by Altium NEXUS 18.1 users and Altium NEXUS 1.1 users provided they are signed into Altium NEXUS Server 1.1 as their managed content server. If using a previous version of the design software, or if signed into version 1.0 of the Altium NEXUS Server, the older Comments panel GUI will be seen.
For more information on support for Managed Projects from the managed content server perspective, see Managed Projects.

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 » 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 » Comment.
  • Click the  (to begin a new comment thread for an area) or  (to begin new comment thread for a point) button on the standard toolbar.
The Place » Comment command is available only when a component is selected on the schematic or PCB document. When the comment is made, a rectangular bounding line is drawn around the component, encompassing its symbol (including pins) and designator.
In order to access the Comments panel, the active document must be a schematic or PCB document of an opened managed project. Only those projects currently shared with you will be available for selection. 
Use the following links to access the corresponding command documentation pages for schematic or for PCB. Note also that the Place » Comment command will only present on the menu when a component is selected on the schematic or PCB document. When the comment is made, a rectangular bounding line is drawn around the component, encompassing its symbol (including pins) and designator.

Display Settings

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.  

Use the Context region to switch between Project (view all comments across all source documents in the project) and Document (view all comments for the active document).

Use the Comments region to view either Active or Resolved comments. Comments that have been resolved will display a green bar as shown below in the image on the right.

Working with Comments

Adding a Comment

To add a new comment, 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.

Editing a Comment

To edit a placed comment, click the   associated with the comment you want to change then enter your edits in the text box. Click Update when you are done editing.

Resolving a Comment

To resolve (close out) a comment, 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 workspace.

Viewing and Reopening Resolved Comments

To view Resolved comments, 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, click the  button associated with that comment.

Adding an Avatar

An avatar can be added for a user, as well as the user's name. These are sourced directly from the user's profile in the Server.

Collapsing a Comment

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

Using Review Mode

When using the Review Mode feature (Place » Review mode, 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>.
This command features automatic context identification, so that if you draw a shape around a component, the comment will be bound to that component.

This command features automatic context identification, so that if you draw a shape around a component, the comment will be bound to that component.

Controlling Display of Comments in the Workspace

The display and appearance of comments is 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 display of comments in the workspace, 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.

Visibility of comments in the workspace 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 workspaces.
  • The Comments panel will track the entire thread of a specific comment, however, only the latest comment in that thread is displayed in the workspace.
  • 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 workspace, 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 workspace, the active/selected comment is distinguished by a dashed reference line.
  • You can move a comment around in the workspace, 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.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content