Getting started

Installing JEditor

Installing JEditor is as simple as installing any Jira add-on/app. To install JEditor, do the following:

  1. Go to Jira administration > Find new add-ons
  2. Search the marketplace for JEditor
  3. Click the Free Trial button to get an evaluation license and install the add-on.

Sometimes you may be asked by our support to install a JEditor build manually. To do so, navigate to Jira administration > Manage add-ons and click the Upload add-on link.

Enabling JEditor

JEditor can be enabled on a per-field basis for any multi-line text field (like description or comment), including custom fields. After installing JEditor, you won't see any immediate changes in your Jira fields.

Do the following to enable JEditor for a particular field:

  1. Navigate to Jira administration > Issues
  2. Select Fields > Field Configurations to view all your field configurations
  3. Locate the field configuration of interest and click the Configure link to open the View Field Configuration page, which lists all system and custom fields in your Jira installation for that field configuration
  4. Click the Renderers link for the field you want to change. This will take you to a page where you will have the option to select a renderer from all configured and available renderers
  5. This page will warn you if there are issues that will be affected by the change. If no issues are affected, then the warning does not show. From this page, choose the JEditor Renderer and click Update

JEditor properly renders existing fields that contain wiki markup (created using wiki renderer or Jira RTE).

Test Setup

You can evaluate JEditor in your testing environment or your production Jira.

If you want to evaluate JEditor in your production Jira - it's safe to do so. Create a test project with a separate field configuration and enable JEditor only for the fields in that field configuration.

Configuring JEditor

JEditor comes pre-configured with some default Templates, Styles, ready Toolbar configuration. To change the configuration, navigate to Jira administration > JEditor Configuration. Below is the short review of the sections in JEditor Configuration:

  1. Settings. On this tab, you will find settings related to JEditor's UI/UX, renderer settings, upload parameters.
    If you just installed JEditor, you may want to enable the Attach Uploads param (attaches pasted images to the corresponding Jira issue), the Spellchecker param (allows browser spellchecker in JEditor-enabled fields).
    You can also configure the default height of the editor or enable the Autogrow mode.
  2. Security. On this tab, you can configure the security-related JEditor parameters. It is strongly recommended that the XSS filter (Apply XSS filter when rendering data) is enabled at all times. Another critical parameter that should also be enabled is Users must be authorized to access the editor. Do not disable these settings unless you know what you are doing (or our support team asks you to do so).
  3. Toolbar. On this tab, you can change the toolbar configuration: enable or disable the toolbar buttons, change the number of rows on the toolbar or reorder the buttons. For more information about this tab, see Toolbar and bottom bar.
  4. Templates. On this tab, you can manage HTML templates that users can insert using the Template button on the toolbar. For more information, see Templates and prepopulation.
  5. Prepopulation. On this tab, you can configure field prepopulation schemes. JEditor can automatically populate any multi-line field on the Create Issue screen with a pre-defined template. For more information, see Templates and prepopulation.
  6. Custom Styles. On this tab, you can add custom CSS code to Jira pages as well as configure the Styles dropdown list. For more information, see Custom Styles/CSS.
  7. Custom JavaScript. On this tab, you can add a custom JavaScript code snippet that will be executed on all Jira pages. For more information, see Custom Javascript.
  8. Replace. On this tab, you can configure JEditor global replace rules. These rules are executed by JEditor during page load and can replace any text (it's possible to use regular expressions) in all JEditor-rendered fields across Jira. For more information, see Replace With.
  9. Syntax Highlight. On this tab, you can configure the JEditor code highlighter. It's possible to collapse all code snippets by default and hide/show line numbers.
  10. Wiki Mode. On this tab, you can switch JEditor to wiki mode (Jira default editor first) on a per-project basis. This feature is deprecated and will be removed during 2021.

Why JEditor

If you are currently evaluating JEditor, you probably want to know if JEditor is better than Jira's default editor and why. That's a tricky question. The answer is yes, and no.

Yes, JEditor is much more capable compared to Jira's default RTE. JEditor has way more features, and it allows complex data formatting. Only using JEditor users can copy-paste from documents/spreadsheets/emails/corporate portals without losing formatting.

JEditor is based on HTML formatting, and it has certain drawbacks. HTML formatting is more verbose compared to wiki markup (more substantial volumes of data to store in the DB).

The best answer is: JEditor should co-exist with Jira's default RTE, without completely replacing it. Every Jira needs JEditor to help users when they need to do something the default editor is not capable of:

Top 5 reasons why you need JEditor in your Jira

Enabling JEditor in all possible fields in all Jira projects is overkill. Jira RTE works great for regular comments and most descriptions, especially in R&D projects. Such projects may benefit from having JEditor in a custom field and using it on a when-needed basis.

At the same time, projects that serve as hubs for administrative tasks (where users work with documents a lot) will definitely benefit from JEditor in the Description and Comment field.

Jira notifications

JEditor uses HTML formatting of data instead of wiki markup. This helps JEditor to support a wide range of formatting options and allows end-users to copy data from various sources such as documents, spreadsheets, emails, web pages. However, some Jira notification templates are explicitly designed for wiki markup/plain text, and you will need to edit certain velocity templates adding support for HTML formatting.

If your Jira notification emails start coming with HTML tags, see Jira notification email contain HTML tags.

JEditor for Jira Service Management (Jira Service Desk)

If you use Jira Service Management, you may want to enable JEditor in certain fields on the customer portal.

JEditor for JSM supports rich text formatting, including tables, lists, links, inline images, text coloring, headings. It also supports pasting data from various sources, including:

  • PDF documents
  • Word/Excel documents
  • Images
  • Emails

JEditor for Service Management supports the following request fields:

  • Description
  • Comment
  • Environment
  • Multi-line text custom fields

To enable JEditor for JSM, do the following:

  1. Navigate to Jira administration > Manage apps
  2. In the left navigation panel, select JEditor for JSM > Field Schemes
  3. Create a new field scheme

For more details on how to configure JEditor for Jira Service Management, see Configuring JEditor for JSM.

Mail Handling

JEditor can import your HTML formatted emails, creating new Jira issues or comments. To enable the mail handler, do the following:

  1. Navigate to Jira administration > System > Incoming Mail
  2. Click the Add incoming mail handler button
  3. Select the JEditor Rich Text Mail Handler (create or comment)
  4. Follow the dialog to configure the mail handler

Please note that JEditor's mail handler has limited functionality. It does a great job importing HTML-formatted emails. However, if you need more features, you may want to try apps that specialize in importing emails:

Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk