Overview

JIRA Syntax Highlighter PlugIn

JIRA Syntax Highlighter Banner

The JIRA Syntax Highlighter PlugIn replaces the standard formatting macros {noformat} and {code}. It gives you a more advanced layout and support for additional languages like C#, PHP, Ruby, C++ etc. The plugin solves 50 votes for JRA-21067, JRA-23604 and JRA-25703.

Additional languages Highlight multiple lines Noformat layout

Syntax highlighting is available in standard view issue screen and in preview mode during create, edit or comment of an issue (see screenshots).

Edit issue with macro syntax Edit issue with preview

It is also available in emails, activity streams and JIRA Agile planning and work mode.

JIRA Agile planning mode JIRA Agile Rapidboard

The following languages are supported.

  • Plain text renderer {code} resp. {noformat}
  • Java {code:java}
  • JavaScript {code:js}
  • JavaFX {code:javafx}
  • SQL {code:sql}
  • CSS {code:css}
  • XML {code:xml}, XSLT {code:xslt}, XHTML {code:xhtml}, HTML {code:html}
  • PHP {code:php}
  • Ruby {code:ruby}
  • Perl {code:perl}
  • C# {code:c#} or {code:csharp}
  • C+, C {code:c+} or {code:cpp} resp. {code:c}
  • VB {code:vb}, VB.NET {code:vbnet}
  • Python {code:py} or {code:python}
  • Pascal {code:pas} or {code:pascal}, Delphi {code:delphi}
  • Objective-C {code:objc} or {code:obj-c}
  • Scala {code:scala}
  • D {code:d}
  • Bash {code:bash} resp. Shell {code:sh}
  • Diff {code:diff}
  • Tcl {code:tcl}
  • Gherkin {code:gherkin}
  • Puppet {code:puppet} or {code:pp}

Also highlighting of single or multiple lines is supported by using e.g.

  • {code:java|highlight=11}
  • {noformat:highlight=4,8-10}

Line numbers can be switched on, collapse, starting line number, title, title color and title background color (HTML color names or hex values) can be set e.g.

  • {code:css|linenumbers|title=general.css file from root folder|titleColor=white|titleBGColor=#FFA500|collapse}
  • {code:sql|firstline=10}

In earlier versions (v1.x) linenumbers where shown by default. To hide linenumbers then you have to use e.g. {code:java|hide-linenums}

The JIRA Syntax Highlighter PlugIn is based on SyntaxHighligher by Alex Gorbatchev and Chan Wai Shing. JIRA macro plugin classes have been added and also Java classes and templates for HTML output.

JIRA Syntax Highlighter PlugIns is released under both MIT license and GNU General Public License (GPL) Version 3.

Known Issues

Some minor layout issues in Outlook 2003 and Outlook 2010.

Installation

For installation please add the plugin using the plugin manager or install it manually. Then you need to deactive JIRAs standard macros for code and noformat:

  • Go to "Administration" > "Plugins" resp. "Manage Plugins" or "Manage Add-ons"
  • Scroll down to "System Plugins" resp. "System Add-ons" section and click on "Show System Plugins" / "Show System Add-ons".
  • Then scroll down and click on "Wiki Renderer Macro Plugin" to show details of this plugin
  • Then click on "Manage plugin modules" resp. "7 of 8 modules activated" to show details about plugin modules.
  • Now deactivate "noformat" and "code" modules (see screenshot).

If you don't deactivate JIRAs standard macros for code and noformat as described above, you will see the error message "Unable to find source-code formatter for language..." when using one of the new programming languages supported by JIRA Syntax Highlighter like Phython, C# etc. resp. the new layout is not used.

JIRA with standard noformat and code macros disabled

If not done already you need to switch on the Wiki Style Renderer in Field Configurations for the corresponding text fields like Description and Comment.

Link to Marketplace