Add Comment To Issue Page

This page allows you to add a new comment to an issue.

Comment details

This tab lets you add a comment to the issue. Issue comments appear in the History section of the Details tab of the issue’s page.

Formatting a comment

The comment may be in plain text or in a subset of well-formed HTML. If you type plain text, it will be shown in the comment without any special formatting. By using HTML, you have more control over how the comment will appear. Information about using HTML in your comments is given below.

The only HTML elements (special control codes that change the appearance of the text) that may be used are: <a>, <br/>, <em>, <ul>, <ol>, <li>, <p> and <strong>.

The restriction of using well-formed HTML means that any elements you open must also be closed. An element is closed by repeating it, but with a / character just before the element’s name. For example, if you wish a particular section of text to be shown in bold, you would prefix it with the text <strong> and suffix it with </strong> thus:

Here is some <strong>bold text</strong>!

would be shown in a comment as

Here is some bold text!

If HTML is not well-formed an error message will be displayed, together with an opportunity to re-edit the comment.

The meanings of the various HTML elements that you can use are described below.

<a href="url">

Creates a hyperlink to the url specified in the href attribute. The text surrounded by the element is used as the text for the hyperlink. For example

This is a hyperlink to the <a href="https://www.araxis.com/">Araxis web site</a>!

would be shown in a comment as

This is a hyperlink to the Araxis web site!

<br/>

Breaks the current line and causes following text to start on the next line. This element is written using a / character after the element’s name. This automatically closes the element and so you don’t need a </br> element to close it.

<em>

Gives emphasis to the text surrounded by the element by showing the text in italic.

<ul> and <li>

Allows you to create a bullet point list of items. Use <ul> to start the list, <li> and </li> to surround each item in the list, and </ul> to end the list. For example,

Here is a list of items:
<ul>
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
</ul>

would be shown in a comment as

Here is a list of items:

  • First item

  • Second item

  • Third item

<ol> and <li>

Allows you to create a numbered list of items. Use <ol> to start the list, <li> and </li> to surround each item in the list, and </ol> to end the list. For example,

Here is a list of items:
<ol>
<li>First item</li>
<li>Second item</li>
<li>Third item</li>
</ol>

would be shown in a comment as

Here is a list of items:

  1. First item

  2. Second item

  3. Third item

<p>

Denotes a paragraph of text. Use this in long comments to surround each paragraph of text that you write.

<strong>

Gives strength to the text surrounded by the element by showing it in bold.

To add a new comment:
  • Complete the Comment field.
  • Click the Apply button.
To abandon the addition of a new comment:
  • Click the Don’t Add Comment button.

Description of form field

Comment The comment to be added to the issue.

Issue details

General

This section shows the details of the issue. This is reproduced from the issue page and is copied here for easy access to the issue’s information when writing a comment.

Description of table rows

Summary A summary of the issue.
Topic The topic to which this issue is associated.
Severity The severity.
Reported in The subtopic/version this issue was reported in.
Fixed in The subtopic/version this issue was fixed in.
State The state of the issue.
Type The type of issue.
Description The description of the issue.

History

This section shows what comments have been added to the issue since it was created. This is reproduced from the issue page and is copied here for easy access to the information when writing a comment.

To change the sort order of the comments:
  • Click the column heading link. Each time you click the link, the order in which comments are sorted will be reversed.

Description of table columns

Time The first line in each table row shows the date and time when a comment was added or an event occurred. It also shows the person responsible. The comment itself, or a brief description of an event, appears below.

For help working with tables, see Tutorial 1: The Basics of Working with Ketura.