Page Comparison

This page explains how to format text in Jira Cloud using Power Scripts synax. It covers basic formatting, content structure elements, tables, media embeds, detailing field compatibility and known limitations.

description += "Examples: **bold** , //italics// or ~~strike through~~ and __underline__.\n";
description += "Links are given like this: [[https://google.com||Google text that appear]].\n";
description += "This is some {{color:#2266AA}} colored text{{/color}} followed by normal text.\n";
description += "Emojis: {{emoji}}🙂||:slight_smile:||1f642{{/emoji}} {{emoji}}😄||:smile:||1f604{{/emoji}} or a custom one {{emoji}}🎺||:trumpet:||1f3ba{{/emoji}}\n";
description += "A mention: {{mention}}@John Smith||6093b81a539c14006ad3c137{{/mention}}\n";
description += "A--Subscript-- and A^^Superscript^^\n";

\-\- will not be treated as subscript text \-\-       //will display as -

addComment(key, currentUser(), "\\-\\- will not be treated as subscript text \\-\\-");

// Basic task description with header and details
description += "= Bug Report: Login Form Validation =\n";
description += "----\n";
description += "Login validation fails when using special characters\n";

All table elements require both opening and closing tags.

<table>
<tr>
<th>header text</th>
</tr>
<tr>
<td>data</td>
</tr>
</table>

• Each table element starts on a new line

• Line breaks (\n) are required after each element

// Start the table
description += "<table>\n";
// Create header row with three columns
description += "<tr>\n<th>\nColumn 1\n</th>\n<th>\nColumn 2\n</th>\n<th>\nColumn 3\n</th>\n</tr>\n";
// Add first data row
description += "<tr>\n<td>\nrow 1, col 1\n</td>\n<td>\nrow 1, col 2\n</td>\n<td>\nrow 1, col 3\n</td>\n</tr>\n";
// Add second data row
description += "<tr>\n<td>\nrow 2, col 1\n</td>\n<td>\nrow 2, col 2\n</td>\n<td>\nrow 2, col 3\n</td>\n</tr>\n";
// Add third row with colspan
description += "<tr>\n<td>\nrow 3, col 1\n</td>\n<td: colspan 2>\nrow 3, col 2 and 3\n</td>\n</tr>\n";
// Close the table
description += "</table>\n";

<td: colspan 2 rowspan 3 background #CCCCCC>
    This cell spans 2 columns, 3 rows, and has a gray background
</td>

To prevent parsing errors, do NOT include spaces before the colon in <table and <td elements: <td: is correct, <td : is not.

<td>
<!
<media: layout align-start>
[media-id]#file##974#262##
</media>
<note>Panel content here</note>
!>
</td>

description += "<table>\n";
// Standard header row
description += "<tr>\n<th>\nColumn 1\n</th>\n<th>\nColumn 2\n</th>\n<th>\nColumn 3\n</th>\n</tr>\n";
// Regular data rows
description += "<tr>\n<td>\nrow 1, col 1\n</td>\n<td>\nrow 1, col 2\n</td>\n<td>\nrow 1, col 3\n</td>\n</tr>\n";
// Row with merged cells
description += "<tr>\n<td>\nrow 3, col 1\n</td>\n<td: colspan 2>\nrow 3, col 2 and 3\n</td>\n</tr>\n";
// Row with rich content
description += "<tr>\n<td>\n<!\n ** Decorated row 4 ** \n!>\n</td>\n<td>\nrow 4, col 2\n</td>\n<td>\n<!\n<note>\nrow 4 col 3\n</note>\n!>\n</td>\n</tr>\n";
description += "</table>\n";

JComment c = getLastComment(key);
string comment = c.text;
string countryName;
if(startsWith(comment, "Country:") || startsWith(comment, "country:")) {
    string s = trim(substring(comment, 8, -1));
    int ndx = indexOf(comment, " ");
    if(ndx > 0) {
        countryName = substring(s, 0, ndx);
    } else {
        countryName = s;
    }
}
//countryName will actually contain the input from the comment
if(countryName == null) {
    description += "\n<error>\n Bad query\n</error>\n";
    return;
}
//define a structure that matches the CSV data
struct Country {
    string code;
    number latitude;
    number longitude;
    string name;
}
int added = 0;
string tableString = "\n<table>\n<tr><th>Name & Code</th><th>Geo</th></tr>\n"; 
//note that we read structures directly from the CSV:
Country [] allCountries = readFromCSVFile("countries.csv", true);
for(Country c in allCountries) {
    if(startsWith(c.name, countryName)) {
        //add the row
        tableString += "<tr><td>" + c.name + "[" + c.code + "]</td><td>\n<!\n```\n";
        //this is a code block in a cell, so we must escape it 
        tableString += "Lat:" + c.latitude + "\n";
        tableString += "Long:" + c.longitude + "\n";
        tableString += "```\n!>\n</td>\n</tr>\n"; //notice the line breaks.
        added++;
    }
}
tableString += "</table>\n";
string content = added > 0 
        ? "\n### Found " + added + (added > 1 ? " countries" : " country") +" ###\nWe have **" + added + "** countries available. The details follow:\n" + tableString
        : "\n<warn>\n There is no country matching your query\n</warn>\n";
description += content;
JComment c = getLastComment(key);
string comment = c.text;
string countryName;
if(startsWith(comment, "Country:") || startsWith(comment, "country:")) {
    string s = trim(substring(comment, 8, -1));
    int ndx = indexOf(comment, " ");
    if(ndx > 0) {
        countryName = substring(s, 0, ndx);
    } else {
        countryName = s;
    }
}
//countryName will actually contain the input from the comment
if(countryName == null) {
    description += "\n<error>\n Bad query\n</error>\n";
    return;
}
//define a structure that matches the CSV data
struct Country {
    string code;
    number latitude;
    number longitude;
    string name;
}
int added = 0;
string tableString = "\n<table>\n<tr><th>Name & Code</th><th>Geo</th></tr>\n"; 
//note that we read structures directly from the CSV:
Country [] allCountries = readFromCSVFile("countries.csv", true);
for(Country c in allCountries) {
    if(startsWith(c.name, countryName)) {
        //add the row
        tableString += "<tr><td>" + c.name + "[" + c.code + "]</td><td>\n<!\n```\n";
        //this is a code block in a cell, so we must escape it 
        tableString += "Lat:" + c.latitude + "\n";
        tableString += "Long:" + c.longitude + "\n";
        tableString += "```\n!>\n</td>\n</tr>\n"; //notice the line breaks.
        added++;
    }
}
tableString += "</table>\n";
string content = added > 0 
        ? "\n### Found " + added + (added > 1 ? " countries" : " country") +" ###\nWe have **" + added + "** countries available. The details follow:\n" + tableString
        : "\n<warn>\n There is no country matching your query\n</warn>\n";
description += content;

Always verify your formatting against the Atlassian Document Format guidelines. If you receive a 400 (Bad Request) error:

1. Verify your formatting follows Atlassian Document Format guidelines

2. Remove any nested tables

3. Check for unsupported Atlassian constructs

// Replace KEY with your issue key
// description.txt should contain your corrected text
KEY.description = readFromTextFile("description.txt")