Is there a way to include a dashes (i.e. pairs of double-hyphens) in a Jira comment and not get strikethrough?

Atlassian's markup seems to interpret a commonly used grammatical construct, dashes (i.e. pairs of double-hyphens), to imply strikethrough (like this) is desired.  Dashes are a commonly used grammatical construct–to emphasize some text or provide in-line explanation–so, it's unfortunate that Atlassian syntax seems to have co-opted them...  Is this a bug in how hyphens (the strikethrough indicator) are interpreted?  Atlassian's markdown interpreter seems smart enough not to understand that a very-hyphenated-phrase is not a call for strikethrough...

4 answers

For those who may come back to this question in the future.

A solution to this problem is to prefix the first dash with a backslash (escape character). For example, the following text produces a strikethrough between the two dashes:

-Xloggc:/shared/[name of service]/logs/gc-%t.log

ends up looking like:

-Xloggc:/shared/[name of service]/logs/gc-%t.log

To avoid this you do the following:

\-Xloggc:/shared/[name of service]/logs/gc-%t.log

This works well, but:

1. If you have more than 2 dashes - it's better to escape ALL of them with \

2. After saving, if you try to edit the text the \ are removed and you will have to re-add them again :(

 

Hi Drew,

This happens because some of the JIRA fields support Markdown. If you know Markdown it can be useful but if you're not familiar it, then it can be very annoying.

It was first availalbe as a plug-in and that still may be how it's implemented today but I'm not sure. Either way, check with your JIRA admin because it may be possible to change how the fields are rendered.

Jim

Yes, other renderers are possible. The admin can change which renderer is used in Field Configuration, so you can select which field uses which renderer. The JEditor plugin makes another renderer available, which gives go a more WYSIWYG experience and adds a toolbar for styles, templates and such. It can be a bit pricy if that's the only feature you use, but it's been very helpful on my server.

FWIW - I'm definitely familiar with markdown and am not looking to change markdown renderers.  Rather, I'm just curious if Jira's markdown renderer has a bug in it.

Ideally, IMHO, the markdown for strikethrough should require some form of whitespace before the beginning tag and after ending tag–both tags being hyphens in this case.

I'm just wondering why a multi-hyphenated-word doesn't have some of the middle words treated with strikethrough, yet a supporting clauses embedded in a pair of dashes within a sentence does.

 

Examples (of what actually gets displayed in Jira):

A multi-hyphenated-word doesn't get any strikethrough.

A sentence with a pair of dashes–to further explain something–does get strikethrough.

This feels like a bug to me.

 

 

 

Just to note: I experienced this issue when trying to add documentation with Confluence, in particular the line: git commit -m "SJ-1234 this is a commit message" The first hyphen disappeared and the ' SJ1234 ' was shown with strike-through. My work-around was to NOT type the first hyphen until AFTER I typed the second hyphen, fwiw.

Suggest an answer

Log in or Join to answer
Community showcase
Sarah Schuster
Posted Jan 29, 2018 in Jira

What are common themes you've seen across successful & failed Jira Software implementations?

Hey everyone! My name is Sarah Schuster, and I'm a Customer Success Manager in Atlassian specializing in Jira Software Cloud. Over the next few weeks I will be posting discussion topics (8 total) to ...

3,167 views 13 19
Join discussion

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you
Atlassian Team Tour

Join us on the Team Tour

We're bringing product updates and pro tips on teamwork to ten cities around the world.

Save your spot