...
...
...
...
...
...
| Tip |
|---|
New Feature Announcement Global Checklists are currently in BETA and will be available in Issue Checklist for Jira | Status |
|---|
| colour | Blue |
|---|
| title | ENTERPRISE |
|---|
|
once released. Contact our support team if you currently use Issue Checklist for Jira would like to participate in the Beta. |
Text format can be used in the Checklist Editor, Checklist Text custom field as well as the new item input field.
| Table of Contents |
|---|
| maxLevel | 4 |
|---|
| minLevel | 1 |
|---|
| exclude | On this page |
|---|
|
Video Tutorial
...
Checklist Formatting
| Excerpt |
|---|
|
| A checklist item line can start directly with item text orMarkdowncharacters like the including: * - + [] | | Code Block |
|---|
checklist item
[] checklist item
* checklist item
* [] checklist item
- checklist item
- [] checklist item |
| | Checked items are indicated by [x] | | Code Block |
|---|
[x] checklist item
* [x] checklist item
- [x] checklist item |
| | Statuses are written in square brackets | | Code Block |
|---|
[] Open item
[open] Another open item
[in progress] Item with status 'in progress' which is still unchecked
[done] Completed/checked item with status 'done'
[skipped] Completed/checked item with status 'skipped' |
| | A question mark ? is used to markitems as optional | | Code Block |
|---|
? checklist item
[]? checklist item
*? checklist item
* []? checklist item
-? checklist item
- []? checklist item |
| | Descriptions are indicated by double arrows >> | | Code Block |
|---|
[] Unchecked checklist item with description
>> Description text can be long and multiline.
>> It can contain links, mentions, dates, and other formatting elements.
[x] Checked item without description |
| | You can use Headers to organize long checklists. Headers are proceeded by three dashes --- | | Code Block |
|---|
--- Acceptance Criteria Header
- checklist item 1
- checklist item 2 with **bold** text
- checklist item 3 with link to an issue IC-245 |
| Note |
|---|
Headers must include text. Three dashes that are not followed by text will not be saved/rendered on the checklist UI. |
|
|
Additional Elements
| Excerpt |
|---|
|
| Dates can be included in multiple formats. Type // (double slash) to open a calendar picker. | | Code Block |
|---|
[] Due on 2022-05-18
[] Due on 2022/05/18
[] Due on 18-05-2022
[] Due on 18/05/2022 |
| | Type a colon : to open the emoji menu | | Code Block |
|---|
* [open] Smile 😀 |
| | To reference another issue, type the issue key | | Code Block |
|---|
* [open] See the comment on CSP-61 |
| | URLs can be added in and will be rendered as clickable links | | Code Block |
|---|
* [open] https://marketplace.atlassian.com
* [open] marketplace.atlassian.com |
| | Typing an @ will open a user picker | | Code Block |
|---|
* [open] Task one @JenniferChoban |
|
|
Markdown Formatting
| Excerpt |
|---|
|
| To bold text, add two asterisks, or two underscore characters before and after the word or phrase | | Code Block |
|---|
This is **bold text**
This is __bold text__ |
| | To italicize text, add one asterisk or underscore character before and after a word or phrase | | Code Block |
|---|
This is in *italics*
This is in _italics_ |
| | To strikethrough text, add two tilde characters before and after a word or phrase | | Code Block |
|---|
This text is ~~wrong~~ |
| | To style text as inline code, add back-tick characters before and after a word or phrase | | Code Block |
|---|
This will be shown as `inline code` |
| | Add aURL directly into the text, or enclose the link text in brackets and follow it immediately with the URL in parentheses | | Code Block |
|---|
Contact us at https://www.herocoders.com/contact
[Contact us](https://www.herocoders.com/contact) |
| | Add the email address directly into text, or enclose the link text in brackets follow it immediately with a mailto data (you can specify email subject too) | | Code Block |
|---|
Contact us at support@herocoders.com.
[Contact us](mailto:support@herocoders.com?subject=Issue Checklist questions&body=Email body text) |
|
|
Escaping Markdown Characters
| Excerpt |
|---|
|
To display Markdown formatting characters, use the backslash \ character like demonstrated below Markdown text | Rendered output |
|---|
Escaped \_italic\_ formatting | Escaped _italic_ formatting | Escaped \_italic_ formatting | Escaped _italic_ formatting | Escaped \**bold\** formatting | Escaped **bold** formatting | Escaped \**bold** formatting | Escaped **bold** formatting | Escaped \*\*bold\*\* formatting | Escaped **bold** formatting | Escaped \**bold\\** formatting containing backslash | Escaped **bold\** formatting containing backslash | Escaped \`inline code\` formatting | Escaped `inline code` formatting | Escaped back-tick \` character | Escaped back-tick ` character | Standard text with \ backslash | Standard text with \ backslash | \[In the target instance] | [In the target instance] |
| Note |
|---|
Note that in the Rendered output column: Formatting is not applied due to backslash \ usage The backslash \ is not displayed when it is used to escape Markdown Double backslashes are used to display a single backslash inside a Markdown formatted phrase The backslash behaves like a normal character when used outside Markdown formatted phrase
|
| Info |
|---|
Issue Checklist uses square brackets to represent the state of an item in the text format. Therefore, when you include square brackets at the beginning of a checklist item they are removed. To show brackets in your checklist item, use the \ character prior to the opening bracket. |
|