PCB_Cmd-CreateCommentThreadCreateCommentThread_AD

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 allow all 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 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 which will became visible to everybody instantly, prior to commiting 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 todo list).

Access

This command can be accessed from the PCB Editor by:

• Choosing the Place » Comment for Area command from the main menus.
• Clicking the  button, on the Wiring toolbar.
• Using the Alt+Ctrl+A keyboard shortcut.

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 and click or press Enter to complete placement.
3. The Comments panel will appear, ready to enter a new comment. Simply type your comment, then either click the Comment button beneath, or press Ctrl+Enter.
4. The comment will be commited, appearing 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 wporkspaces.
2. The Comments panel will track the entire thread of a specific comment, whereas 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 simply extends from that area to the text area.
5. You can collapse a comment in the workspace. Simply click on the small triangle at the top-left of the textual area.
6. The display and appearance of comments on the PCB is controlled from the Collaboration region, on the System - Altium Vault 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 respectively.

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 allow all 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 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 which will became visible to everybody instantly, prior to commiting 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 todo list).

Access

This command can be accessed from the PCB Editor by:

• Choosing the Place » Comment for Point command from the main menus.
• Clicking the  button, on the Wiring toolbar.
• Using the Alt+Ctrl+P keyboard shortcut.

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 and click or press Enter to anchor that point.
2. The Comments panel will appear, ready to enter a new comment. Simply type your comment, then either click the Comment button beneath, or press Ctrl+Enter.
3. The comment will be commited, 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 wporkspaces.
2. The Comments panel will track the entire thread of a specific comment, whereas 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 simply extends from that point to the text area.
5. You can collapse a comment in the workspace. Simply click on the small triangle at the top-left of the textual area.
6. The display and appearance of comments on the PCB is controlled from the Collaboration region, on the System - Altium Vault 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 respectively.

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 allow all 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 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 which will became visible to everybody instantly, prior to commiting 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 todo list).

Access

This command can be accessed from the PCB 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.

Use

After launching the command, the Comments panel will appear, ready to enter a new comment. Simply type your comment, then either click the Comment button beneath, or press Ctrl+Enter. The comment will be commited, appearing 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 footprint (including pads) 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 wporkspaces.
2. The Comments panel will track the entire thread of a specific comment, whereas 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 simply extends from the bounding line around the component, to the text area.
5. You can collapse a comment in the workspace. Simply click on the small triangle at the top-left of the textual area.
6. The display and appearance of comments on the PCB is controlled from the Collaboration region, on the System - Altium Vault 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 respectively.