Altium Designer Documentation

CreateCommentThread

Created: May 28, 2019 | Updated: May 30, 2019
Now reading version 20.1. For the latest, read: CreateCommentThread for version 21
Applies to Altium Designer versions: 19.0, 19.1, 20.0, 20.1 and 20.2

Parent page: Schematic Commands

The following pre-packaged resources, derived from this base command, are available:


Applied Parameters: Kind=Area

Summary

This command is used to add a new comment thread to a defined area of the active document. Comments are a feature associated with Managed Projects and allows all users working on a document to comment and review the design (or part thereof) in real-time, without actual modification of the document itself.

The commenting feature facilitates strong review and collaboration processes. Due to the server nature of comments (they are stored on the server and do not touch the design document in any way) they become invaluable when:

  • You want to point out some issues in document without physically merging and getting conflicts.
  • You want to add a comment that will became visible to everybody instantly prior to committing your working copy.
  • You want to have list of notes for you current design that are attached to areas of the document and could be closed as the design matures (similar to a to-do list).

Access

Before you can start using the comment feature, ensure that you have opened (checked out) a Managed Project and are working on one of its source schematic documents. This is done using the File » Open Managed Project command. Only those projects currently shared with you will be available for selection.

This command can be accessed from the Schematic Editor by:

  • Choosing the Place » Comment for Area command from the main menus.
  • Clicking the button on the Schematic Standard toolbar.
  • Using the Alt+Ctrl+A keyboard shortcut.
  • Right-clicking in the workspace then choosing the Place » Comment for Area command from the context menu.

Use

After launching the command, the cursor will change to a cross-hair and you will enter comment placement mode. Placement is made by performing the following sequence of actions:

  1. Click or press Enter to anchor the first corner of the rectangular area.
  2. Move the cursor to adjust the size of the rectangle then click or press Enter to complete placement.
  3. The Comments panel will appear ready to enter a new comment. Type your comment then click the Post button.
  4. The comment will be committed and will appear in the panel and also in the workspace linked to the area by a reference line.

Tips

  1. When a comment is added, it is seen instantly by all other users that have that same Managed Project and document open in their respective workspaces.
  2. The Comments panel will track the entire thread of a specific comment with only the latest comment in that thread is displayed in the workspace.
  3. The active/selected comment on the Comments panel is highlighted. In the workspace, that active/selected comment is distinguished through the visibility of its reference line.
  4. You can move a comment around in the workspace only in terms of the area in which the text is displayed. The initial defined area cannot be modified. The reference line extends from that area to the text area.
  5. You can collapse a comment in the workspace. Click on the small triangle at the top-left of the textual area.
  6. The display and appearance of comments on a schematic sheet is controlled from the Document Comments region on the Data Management – Servers page of the Preferences dialog. To turn off display of comments in the workspace – relying on just the Comments panel – disable the Show Comment Threads option. Other controls in the region relate to the look and feel of the comment and its reference line.


Applied Parameters: Kind=Point

Summary

This command is used to add a new comment thread to a specified point in the active document. Comments are a feature associated with Managed Projects and allows all users working on a document to comment and review the design (or part thereof) in real-time, without actual modification of the document itself.

The commenting feature facilitates strong review and collaboration processes. Due to the server nature of comments (they are stored on the server and do not touch the design document in any way) they become invaluable when:

  • You want to point out some issues in document without physically merging and getting conflicts.
  • You want to add a comment that will became visible to everybody instantly prior to committing your working copy.
  • You want to have list of notes for you current design that are attached to areas of the document and could be closed as the design matures (similar to a to-do list).

Access

Before you can start using the comment feature, ensure that you have opened (checked out) a Managed Project and are working on one of its source schematic documents. This is done using the File » Open Managed Project command. Only those projects currently shared with you will be available for selection.

This command can be accessed from the Schematic Editor by:

  • Choosing the Place » Comment for Point command from the main menus.
  • Clicking the button on the Schematic Standard toolbar.
  • Using the Alt+Ctrl+P keyboard shortcut.
  • Right-clicking in the workspace then choosing the Place » Comment for Point command from the context menu.

Use

After launching the command, the cursor will change to a cross-hair and you will enter comment placement mode. Placement is made by performing the following sequence of actions:

  1. Position the cursor at the required point in the workspace then click or press Enter to anchor that point.
  2. The Comments panel will appear ready to enter a new comment. Type your comment then click the Post button.
  3. The comment will be committed, appearing in the panel and also in the workspace linked to the point by a reference line.

Tips

  1. When a comment is added, it is seen instantly by all other users that have that same Managed Project and document open in their respective workspaces.
  2. The Comments panel will track the entire thread of a specific comment, and only the latest comment in that thread is displayed in the workspace.
  3. The active/selected comment on the Comments panel is highlighted. In the workspace, that active/selected comment is distinguished through the visibility of its reference line.
  4. 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 cannot be modified. The reference line extends from that point to the text area.
  5. You can collapse a comment in the workspace. Click on the small triangle at the top-left of the textual area.
  6. The display and appearance of comments on a schematic sheet is controlled from the Document Comments region on the Data Management – Servers page of the Preferences dialog. To turn off display of comments in the workspace – relying on just the Comments panel – disable the Show Comment Threads option. Other controls in the region relate to the look and feel of the comment and its reference line.


Applied Parameters: None

Summary

This command is used to add a new comment thread to a selected component in the active document. Comments are a feature associated with Managed Projects and allows all users working on a document to comment and review the design (or part thereof) in real-time without actual modification of the document itself.

The commenting feature facilitates strong review and collaboration processes. Due to the server nature of comments (they are stored on the server and do not touch the design document in any way) they become invaluable when:

  • You want to point out some issues in document without physically merging and getting conflicts.
  • You want to add a comment that will became visible to everybody instantly prior to committing your working copy.
  • You want to have list of notes for you current design that are attached to areas of the document and could be closed as the design matures (similar to a to-do list).

Access

Before you can start using the comment feature, ensure that you have opened (checked out) a Managed Project and are working on one of its source schematic documents. This is done using the File » Open Managed Project command. Only those projects currently shared with you will be available for selection.

This command can be accessed from the Schematic Editor when a component is selected in the workspace by:

  • Choosing the Place » Comment command from the main menus.
  • Using the Alt+Ctrl+C keyboard shortcut.
  • Right-clicking in the workspace then choosing either the Comment or Place » Comment command from the context menu.
The command will only be available provided a single component is currently selected in the design workspace.

Use

After launching the command, the Comments panel will appear ready to enter a new comment. Type your comment then click the Post button. The comment will be committed and appear in the panel and also in the workspace linked to the component by a reference line. A rectangular bounding line is drawn around the component encompassing its symbol (including pins) and designator.

Tips

  1. When a comment is added, it is seen instantly by all other users that have that same Managed Project and document open in their respective workspaces.
  2. The Comments panel will track the entire thread of a specific comment, and only the latest comment in that thread is displayed in the workspace.
  3. The active/selected comment on the Comments panel is highlighted. In the workspace, that active/selected comment is distinguished through the visibility of its reference line.
  4. You can move a comment around in the workspace only in terms of the area in which the text is displayed. The reference line extends from the bounding line around the component to the text area.
  5. You can collapse a comment in the workspace. Click on the small triangle at the top-left of the textual area.
  6. The display and appearance of comments on a schematic sheet is controlled from the Document Comments region on the Data Management – Servers page of the Preferences dialog. To turn off display of comments in the workspace – relying on just the Comments panel – disable the Show Comment Threads option. Other controls in the region relate to the look and feel of the comment and its reference line.


Applied Parameters: None

Summary

This command is used to add a new comment thread to an object or area in the active document using a line 'drawing'. Comments are a feature associated with Managed Projects and allows all users working on a document to comment and review the design (or part thereof) in real-time without actual modification of the document itself.

The commenting feature facilitates strong review and collaboration processes. Due to the server nature of comments (they are stored on the server and do not touch the design document in any way) they become invaluable when:

  • You want to point out some issues in document without physically merging and getting conflicts.
  • You want to add a comment that will became visible to everybody instantly prior to committing your working copy.
  • You want to have list of notes for you current design that are attached to areas of the document and could be closed as the design matures (similar to a to-do list).

Access

Before you can start using the comment feature, ensure that you have opened (checked out) a Managed Project and are working on one of its source schematic documents. This is done using the File » Open Managed Project command. Only those projects currently shared with you will be available for selection.

This command can be accessed from the Schematic Editor of a managed project by:

  • Choosing the Place » Freehand comment command from the main menus.
  • Clicking the button on the Schematic Standard toolbar.
  • Using the Alt+Ctrl+R keyboard shortcut.
  • Right-clicking in the workspace then choosing the Place » Freehand comment command from the context menu.
The command will only be available for a managed project.

Use

After launching the command, the cursor will change to a crosshair and you will enter freehand placement (drawing) mode. Placement is made by performing the following sequence of actions:

  1. Click to anchor the freehand comment, drag to draw the desired shape and then release the mouse button complete. A freehand line drawn around a specific object will use that object as its context (see Tip 1 below)
  2. The Comments panel will appear displaying the newly-added comment, which may be subsequently edited to suit.
  3. Continue placing further comment reviews or right-click or press Esc to exit placement mode.
  4. The freehand comment will appear in the panel and in the workspace.

Tips

  1. A freehand comment will identify an object (such as a component) within its bounds, which becomes the context of the Comments panel entry – '[user] commented on [object]'. A context of a freehand comment that does not encompass an object is the schematic document name – '[user] commented on [document.SchDoc]'.
  2. When a comment is added, it is seen instantly by all other users that have that same Managed Project and document open in their respective workspaces.
  3. The Comments panel will track the entire thread of a specific comment, and only the latest comment in that thread is displayed in the workspace.
  4. The active/selected comment review on the Comments panel is highlighted.
  5. The display and appearance of comments on a schematic sheet is controlled from the Document Comments region on the Data Management – Servers page of the Preferences dialog. To turn off display of comments in the workspace – relying on just the Comments panel – disable the Show Comment Threads option. Other controls in the region relate to the look and feel of the comment.

 

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

Contact Us

Contact our corporate or local offices directly.

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: