Table of Contents
Details about the Comments Field
The Comments field is a standard multiple line text box that holds details and communications regarding the issue. This field is a Wiki field and can understand certain characters as formatting:
This formatting will help improve the layout and allow users to customize the message.
Adding Comments while Logged into Orange Tracker
1. Browse to the issue you wish to comment on.
2. Click the Comment button in the bottom left corner of the issue.
3. Type your comment text in the large box that appears. Next to the lock below this box is a drop-down menu where you can set the permissions for the comment. By default, all users can view the comment. You can change this permission so only a specific project role (ex: consultants) can view this comment.
Viewable by All Users vs. Users
If you leave the permissions for a comment at the default of "Viewable by All Users," anyone who can view the issue can view the comment. If you select the project role of "Users" then people in the "Users" role of the project can see the issue. Since the members of the other roles usually are also members of the project users role, the "viewable by all" and "users" permissions are basically the same.
The permissions set affect only the current comment being added; it doesn't not affect the permissions of other comments. When you are done, select the "Add" button to add the comment.
Once you've added your comment, it will appear under the "Comments" tab of the Activity section of the issue. If you restricted the comment to a particular project role, a lock icon will appear on the comment along with the words "restricted to" and role that can see the comment. If the comment is not restricted, there will be no lock and no mention of any restrictions.
Adding Comments via Email
If you reply to an email generated by Orange Tracker, resulting in an email where the TO: field has the email address of the project and the subject line of the email includes the issue key, the email will be translated into a comment in the existing issue represented by that issue key. You can also create a new email with an issue key in the subject line and an Orange Tracker project's email address in the TO: field to create a comment in that issue once the email is sent.
ex: to create a comment in the DEMO-5 issue, send an email to email@example.com with a subject that includes DEMO-5.
If you forget to put the issue key in the subject line, a new issue will be created in the project when the email is received at the project's email address.
The email is translated into a comment as follows:
|Email Field||Orange Tracker Issue Field|
|FROM||Author of comment|
|BODY of Email||Body of Comment|
|date/time sent||Comment date/time|
|attachment(s)||attachment(s) in the issue|
*The user added as a watcher via the cc field of the email must have permissions to view the issue or they will not be able to access the comment generated by the email or the issue itself.
To edit a comment, hover your cursor over the comment. Three icons will appear in the upper right-hand corner of the comment. Select the pencil icon to edit the comment.
To delete a comment, hover your cursor over the comment. Three icons will appear in the upper right-hand corner of the comment. Select the trash can icon to edit the comment.
Linking to a Comment
To get an address to a comment that you can use to link to the comment, hover your cursor over the comment. Three icons will appear in the upper right-hand corner of the comment. Right-click the icon with two links in it and select "Copy link address." When someone uses this link address, they will be taken to that issue, with the linked comment highlighted. Note that they must have permissions to view the issue and the comment. If they have only permissions to view the issue, the issue will appear but the comment will not be visible. If they don't have permissions to view the issue, they will see a "Permission Violation" error.