Checklist for Jira - Data Center

Using special formatting

A variety of special formatting can be applied to text entered in a checklist item.

image-20200916-164449.png

Basic Markdown

HTML cannot be inserted directly, as this poses a potential security risk. Instead, you can use the following basic Markdown syntax to format your text.

Formatting

Syntax

Example

Italics

The customer said *what*?

The customer said what?

Bold

Invoices **must** be submitted by 5.

Invoices must be submitted by 5.

Hyperlinks

See our [return policy](http://www.company.com/return-policy).

See our return policy.

Advanced Markdown

This feature requires that the Advanced Markdown setting be enabled.

You can use almost the full Markdown suite (CommonMark specification) to customize your checklists to your heart’s desire. The only exception is that you cannot insert HTML blocks, as this poses a security risk.

To get you started, here are a few examples of what you can do:

Formatting

Syntax

Example

Heading 1

# Heading

image-20200916-165043.png

Heading 2

## Heading

image-20200916-165111.png

Heading 3

### Heading

image-20200916-165149.png

Heading 4

#### Heading

image-20200916-165225.png

Heading 5

##### Heading

image-20200916-165243.png

Bulleted list

* List

image-20200909-202448.png

Numbered list

1. List

image-20200909-202533.png

Block quote

> Block quote

image-20200909-202658.png

Code block

code block
(4 spaces)

image-20200909-202734.png

Images

This feature requires that the External Images setting be enabled.

You can embed external images into checklist items using Markdown syntax.

Formatting

Syntax

Example

External image

![alt-text](https://okapya.com/checklist-logo)

alt-text

Dates

When dates are entered in DD/MM/YYYY or MM/DD/YYYY format, special formatting is automatically applied.

image-20200904-225350.png

Emojis

The following emojis can be inserted:

Emoji

Code

smiley.png?version=1&modificationDate=1521740444432&cacheVersion=1&api=v2

:-)

smiley-lol.png?version=1&modificationDate=1521740444116&cacheVersion=1&api=v2

:-D

smiley-wink.png?version=1&modificationDate=1521740443790&cacheVersion=1&api=v2

;-)

smiley-sad.png?version=1&modificationDate=1521740443448&cacheVersion=1&api=v2

:-(

smiley-confuse.png?version=1&modificationDate=1521740443116&cacheVersion=1&api=v2

:-S

smiley-money.png?version=1&modificationDate=1521740442770&cacheVersion=1&api=v2

$-)

smiley-eek.png?version=1&modificationDate=1521740442434&cacheVersion=1&api=v2

8O

smiley-roll.png?version=1&modificationDate=1521740441878&cacheVersion=1&api=v2

8-)

Warning.png?version=1&modificationDate=1521740441568&cacheVersion=1&api=v2

(!)

question.png?version=1&modificationDate=1521740441260&cacheVersion=1&api=v2

(?)

information.png?version=1&modificationDate=1521740440939&cacheVersion=1&api=v2

(i)

light-bulb-off.png?version=1&modificationDate=1521740440596&cacheVersion=1&api=v2

(off)

light-bulb.png?version=1&modificationDate=1521740440248&cacheVersion=1&api=v2

(on)

thumb-up.png?version=1&modificationDate=1521740439911&cacheVersion=1&api=v2

(y)

thumb.png?version=1&modificationDate=1521740439297&cacheVersion=1&api=v2

(n)

star.png?version=1&modificationDate=1521740438968&cacheVersion=1&api=v2

(*) (*r) (*g) (*b)

Any issue keys that follow Jira standards will automatically be converted to hyperlinks.

image-20200904-230700.png

User mentions

An @ symbol that is immediately followed by characters will automatically have special formatting applied.

image-20200904-225953.png

This is not a true @mention function and is only a visual indicator. A list of users is not suggested as you type, and users are not notified that their name has been used.