JIRA Editor Documentation

Installation and configuration guide

 1. Install JEditor (using UPM interface)  12. Inserting templates
 2. Enable JEditor in the Field Configurations  13. Inserting tables
 3. Trial license  14. Inserting links
 4. How to configure JEditor  15. Using source mode
 5. Can JEditor be used with custom fields?  16. Creating Forms
 6. Pasting from Word and Excel  17. Restoring Autosaved Content
 7. Mentioning users in JIRA  18. Styles and Formatting
 8. Prepopulating JEditor fields  19. Keyboard Shortcuts
 9. Configuring emails  20. Shift-Enter
 10. Inserting images  21. Browser support
 11. Using context menu

Install JEditor using UPM interface

To install JEditor go to JIRA administration > Plugins. In Plugins section select Install Plugins tab, then click on the Upload Plugin link. Select the downloaded .jar file and click the Upload button. JIRA will automatically upload and install the plugin.

To install JEditor open Plugins and select Upload

Enable JEditor in the Field Configurations

It is possible to enable JEditor for the textarea fields on certain projects. To enable JEditor on your project go to JIRA administration > Field Configurations. Select Configure to edit the field configuration. Modify the renderer and select JEditor Renderer for the fields you wish to use JEditor.

To enable JEditor go to Field Configurations and change the renderer Select JEditor Renderer to enable JEditor

Issues created with wiki renderer or tinyMCE are properly rendered by JEditor. It is safe to change the renderer if you already have tasks, bugs or other issues in your JIRA project.

Back to top ↑

Trial license

You can get your trial license on Atlassian Marketplace: https://marketplace.atlassian.com/plugins/com.jiraeditor.jeditor, you will need an account on https://my.atlassian.com.
If you need an extended trial license please contact our support by submitting the form http://jiraeditor.com/support/ or send your request directly to support@jiraeditor.com.

Back to top ↑

How to configure JEditor

To configure your JEditor instance go to JIRA administration > Plugins > JEditor Configuration. You can change the default settings of the editor area, toolbar and templates.

To configure JEditor select JEditor Configuration in Plugins menu

XSS filter

XSS filter helps to prevent XSS attacks on public JIRA servers (that is, Internet-facing servers). It is enabled by default after JEditor installation. This filter blocks forms, buttons, checkboxes, iframes and other potentially insecure elements. If your JIRA is private (cannot be accessed from the Internet) it is safe to disable this filter. To disable the XSS filter go to JIRA administration > Plugins > JEditor Configuration > Settings tab and switch XSS filter to Off.

Default height

The initial height of the editable area. After the editor is loaded the users may expand and shrink the editor or take advantage of the AutoGrow feature. Default height is provided in pixels and must be in range 100-2000 px.

AutoGrow

Autogrow automatically adjusts the size of the editable area if enabled. Users cannot expand or shrink the editor manually.

Maximum height allowed

The maximum height available to the editor when the AutoGrow feature is enabled.

Default language

The language to be used to display the editor. In case this option is set to Auto, the editor will automatically try to load with user language if supported, otherwise the default language will be used. JEditor’s interface is currently available in 57 languages. Right to left languages are also well supported.

DOM navigation bar

Displays the DOM path to elements in the editable area. The DOM path is the section at the bottom of the editor displaying information about the HTML elements of the document for the position of the cursor. It is an advanced feature aimed at users who want to have more control over the source code of their document.

Table resize

Table resize makes it possible to resize table columns by simply clicking and dragging the borders between the cells.

Restore Defaults

This is a global action that reverts all JEditor settings to factory defaults.

Toolbar

On the Toolbar page you may change the layout of the toolbar. You may wish to add or remove some tools. To restore the default settings select “Restore Defaults” on the Settings page. Click the Save button to submit the changes made to the toolbar.

Templates

Your corporate designer can create pieces of HTML that can be reused again and again, spreading a common design line over your JIRA issues. On the Templates page you may add or remove the templates available in JEditor. To remove the template click Delete (this action cannot be undone). To add a new template submit the Add New Template form:

  • Name – a name for your new template.
  • Description – a description that helps the users to identify the template.
  • HTML – html code of the template (<html> or <body> tags should not be added to the template code).

Can JEditor be used with custom fields?

JEditor can be used with any text-area fields (like description, comment or environment) including custom fields.

Back to top ↑

Pasting from Word, Excel or Outlook

You can directly copy and paste data from/to MS Word and MS Excel. We recommend to use Internet Explorer 11+ for this. IE11 is the only browser that allows to copy/paste text containing images from Word/Outlook.

Back to top ↑

Mentioning users in JIRA

We have added the Mention User button to the default toolbar that brings the user selection popup screen.

  1. Press Ctrl-M to start the User Mention dialog.
  2. Start typing a name to get the list of available users (same as in original feature).
  3. Click on a username to mention the corresponding user.

When you submit the comment the notification is sent to all mentioned users.

Back to top ↑

Prepopulating JEditor fields

To prepopulate any custom field on the create issue screen with a template do the following:

  1. Go to JEditor Configuration > Prepopulation
  2. Select Project Name, Issue Type, Field Name and Template Name for your new prepopulation scheme
  3. Click Save

Configuring emails

JEditor is a powerful rich text editor with HTML under the hood. JEditor creates valid HTML document when you edit a field and submits this document to JIRA. To keep rich formatting intact the document must be stored as HTML.

You need to setup your JIRA to use html format as default format for emails to get properly rendered notifications. If you are receiving all your notifications with bare HTML tags then your default email format is plain text.

JIRA Administrators can specify a default email format under Administration > Users > User Preferences.

Back to top ↑

Why do I still receive emails with bare html tags after I switched to HTML format?

Some notifications (like Issue Updated or Comment Changed) will retain bare html tags. These emails use special renderer from Atlassian to highlight changes with green and red. This renderer cannot properly display changes in rich text and forces plain text format. There’s a workaround to get rid of html tags in these emails.

For JIRA 6.1+ do the following:

  1. Download changelog.vm and replace original changelog.vm under <JIRA-install-directory>\atlassian-jira\WEB-INF\classes\templates\email\html\includes\fields\
  2. Download changelog-issue-description.vm and replace original changelog-issue-description.vm under <JIRA-install-directory>\atlassian-jira\WEB-INF\classes\templates\email\html\includes
  3. Download set-issue-details-context.vm and replace original set-issue-details-context.vm under <JIRA-install-directory>\atlassian-jira\WEB-INF\classes\templates\email\html\includes
  4. Download issuecommentedited.vm and replace original issuecommentedited.vm under <JIRA-install-directory>\atlassian-jira\WEB-INF\classes\templates\email\html\
  5. Restart JIRA to reload templates

Check that JIRA has read access to new files.

For JIRA versions before 6.1 open changelog.vm under <JIRA-install-directory>\atlassian-jira\WEB-INF\classes\templates\email\html\includes\fields\.

To get properly rendered new value in html emails change these 3 lines:

#set ($oldText = $velocityhelper.getPrettyFieldString($changeitem.getString("field"), $changeitem.getString($oldstringKey), $i18n, ""))
#set ($newText = $velocityhelper.getPrettyFieldString($changeitem.getString("field"), $changeitem.getString($newstringKey), $i18n, ""))
$!diffutils.diff($oldText, "background-color:${auiErrorBackgroundColour};text-decoration:line-through;", $newText, "background-color:${auiSuccessBackgroundColour};")

To these:

#if ($changeitem.getString("field") == "description" || $changeitem.getString("field") == "Comment")
#if ($changeitem.getString($newstringKey)) $changeitem.getString($newstringKey)
#else Empty
#end
#else
#set ($oldText = "") #set ($newText = "")
#set ($oldText = $velocityhelper.getPrettyFieldString($changeitem.getString("field"), $changeitem.getString($oldstringKey), $i18n, ""))
#set ($newText = $velocityhelper.getPrettyFieldString($changeitem.getString("field"), $changeitem.getString($newstringKey), $i18n, ""))
$!diffutils.diff($oldText, "background-color:${auiErrorBackgroundColour};text-decoration:line-through;", $newText, "background-color:${auiSuccessBackgroundColour};")
#end

You can also use the following line to add the old value to emails: $changeitem.getString($oldstringKey).

For example the below set will render the new value, the horizontal line and the old value:

<p>New value:</p>
$changeitem.getString($newstringKey)
<hr />
<p>Old value:</p>
$changeitem.getString($oldstringKey)

You will need to restart JIRA to reload the templates.

Back to top ↑

Images

Pasting screenshots is simple. After taking a screenshot press Ctrl-V to paste the image into JEditor. This feature works in Google Chrome, Mozilla Firefox and Apple Safari.

Generally it is not possible to paste a local file (including image files) directly to a website located on the server. This issue has nothing to do with JEditor, but is related to the security model of the Internet browsers. To insert images stored as files you need to upload this image file first.

Uploading images

JEditor allows you to add image files to your documents in an easy and intuitive way.

In order to insert an image, simply press the Image button on the toolbar. The Image Properties dialog window that will open lets you upload files and/or set configuration options that define image source, its size, display properties, or other advanced properties. The Image Properties dialog window includes four tabs that group image options.

Image Info

The Image Info tab is the default tab that opens after you press the Image button on the toolbar. It allows you to set the image URL and configure the way it will appear in the document. Below is an overview of all Image Info tab elements:

  • URL – the web address of the image. The image may be located on the same JIRA server you are currently in or on an external server. Example: http://example.com/image1.jpg
  • Alternative Text – a short textual description of the image that tells users with assistive devices (like screen readers) what the image is about. You should always provide your images with meaningful alternative text in order to make it accessible to users with disabilities.
  • Width – the width of the image in pixels. By default this is the size of the original image.
  • Height – the height of the image in pixels. By default this is the size of the original image.
  • Border – the size of the solid border around the image in pixels.
  • HSpace – the horizontal spacing (or margin) between the image border (if present) or the image itself and other document elements that surround the image, in pixels.
  • VSpace – the vertical spacing (or margin) between the image border (if present) or the image itself and other document elements that surround the image, in pixels.
  • Align – the alignment of the image in the document. Available options are Right and Left.
  • Preview – a preliminary view of the selected image formatted according to the options chosen on the left.

With JEditor you do not have to worry about resizing your image. If the image is too big, you can alter its dimensions by entering new values into the Width and Height fields. By default the image ratio is locked, which you can see thanks to a lock button. This means that when you change one of the size values (width or height), the other one will be adjusted automatically.

Back to top ↑

Link

The Link tab lets you assign a link to an image inserted into the document, effectively converting the image into a clickable link. The link can point to any kind of object available in the Internet, like a simple URL address, a PDF document, or an online video.

Advanced

The Advanced tab lets you configure additional image options such as assign it an ID, a class, a longer description, a tooltip, or CSS style properties. It is meant for advanced users with knowledge of HTML as well as CSS, and gives nearly endless possibilities as far as the presentation of the image is concerned. Below is the overview of all Advanced tab elements:

  • Id – a unique identifier for an image element in the document (id attribute).
  • Language Direction – the direction of the text: left to right (LTR) or right to left (RTL) (dir attribute).
  • Language Code – the language of the image element specified according to RFC 1766 (lang attribute).
  • Long Description URL – the web address of an HTML page containing a longer description of the image (longdesc attribute).
  • Stylesheet Classes – the class of the image element (class attribute). Note that an image element might be assigned more than one class. If this is a case, separate class names with spaces.
  • Advisory Title – the text of the tooltip that is shown when the mouse cursor hovers over the image (title attribute).
  • Style – CSS style definitions (style attribute). Note that each value must end with a semi-colon and individual properties should be separated with spaces.

Context Menu

The Context Menu is a pop-up menu that appears whenever you click inside the JEditor editing area with the right mouse button, use the Menu/Application key on your keyboard, or the Shift+F10 keyboard shortcut. It serves as a shortcut for most common operations available for a given type of object.

The menu is context-sensitive which means that the options displayed in it depend on the object that you click. If, for example, you press the right mouse button while inside a table, you will see some table-specific options available in its context menu.

Note that for some more complex objects, like a table, the context menu might include sub-menus with further options. To open the sub-menu, go to the menu option containing a small right-pointing arrow and either click it with your mouse or use the Right Arrow key on your keyboard. To return to the parent menu, use your mouse or the Left Arrow key.

Back to top ↑

Templates

A Content Template is a JEditor feature that lets you control the structure of the document and preserve consistency across multiple documents. Templates are pre-defined, ready-made document forms with page layout, text formatting and styling as well as other elements.

To use one of JEditor templates, press the Template button on the toolbar. The dialog window shows a list of pre-defined templates that are available in your system.

The standard installation of JEditor contains four basic templates, however, this list may be expanded as needed. Since creating and adding new templates is available in JEditor Configuration, please contact your system administrator if you need a special template for your purposes.

In order to select a template, choose it from the list in the Content Templates dialog window and click once. The dialog window will close and the selected template will be applied to the document.

The Content Templates dialog window contains only one configuration option: Replace actual contents. Leaving it checked means that the inserted template will also replace the content entered previously into the JEditor window, deleting it in the process. This is a potentially destructive operation, so if you unintentionally remove the text using this option, you can always revert this operation by pressing the Back button on the toolbar or the Ctrl+Z shortcut on your keyboard. If you leave the Replace actual contents option unchecked, the template will be inserted in the current position of the cursor in the document.

Back to top ↑

Tables

To create a table in JEditor, press the Table button on the toolbar. The Table Properties dialog window that will open lets you set configuration options that define table size, its display properties, or other advanced properties.

The Table Properties dialog window includes two tabs that group table options.

Table Properties tab

  • Rows – the number of rows in the table (obligatory).
  • Columns – the number of columns in the table (obligatory).
  • Width – the width of the table in pixels or a percent value. Giving the width as a percent value lets you set the proportion of the editing area that the table will occupy.
  • Height – the height of the table in pixels.
  • Headers – the drop-down list that formats certain table cells as headers, which applies special formatting to them. You can apply header formatting to First Row, First Column or Both.
  • Border size – the thickness of the table border in pixels.
  • Alignment – the alignment of the table on the page. The following options are available: Left, Center, Right.
  • Cell spacing – the space between individual cells as well as cells and table borders, in pixels.
  • Cell padding – the space between the cell border and its contents, in pixels.
  • Caption – the label of the table that is displayed on top of it.
  • Summary – the summary of the table contents that is available for assistive devices like screen readers. It is a good practice to provide your tables with meaningful summary text in order to make it more accessible to users with disabilities.

Advanced tab

The Advanced tab lets you configure additional image options such as assign it an ID, a class, a language direction, or CSS style properties. It is meant for advanced users with knowledge of HTML as well as CSS, and gives nearly endless possibilities as far as the presentation of the table is concerned. Below is an overview of all Advanced tab elements:

  • Id – a unique identifier for a table element in the document (id attribute).
  • Language Direction – the direction of the text in the table: left to right (LTR) or right to left (RTL) (dir attribute).
  • Stylesheet Classes – the class of the table element (class attribute). Note that a table element might be assigned more than one class. If this is a case, separate class names with spaces.
  • Style – CSS style definitions (style attribute). Note that each value must end with a semi-colon and individual properties should be separated with spaces.

Working with tables

Once inserted into the document, the table can be modified. To edit the table, either double-click it, or open the table context menu by clicking it with the right mouse button or using the Menu/Application key on your keyboard.

To delete the whole table and its contents, use the Delete Table option.

When you choose the Table Properties option, the dialog window of the same name will appear. It allows you to change the configuration options that were set when the table was created, except the number of rows and columns which are grayed out.

Additionally the table context menu lets you modify the rows, columns or particular table cells. This method makes it possible to insert new rows, columns or cells in specified locations as well as merge and split cells.

Changing table look and feel

The style of the table can be changed. To change the style of the inserted table click on the table, then expand the Styles combo. Choose the styling from Object Styles to apply it.

Resizing table columns on the fly

It is possible to resize the columns of the inserted table by dragging the borders. To enable this feature turn on the Table Resize setting in JEditor Configuration.

Back to top ↑

Links

The Link feature of JEditor is a powerful option that lets you add clickable hyperlinks or e-mail addresses to your documents as well as control the way they look and work.

To insert a link to you document, press the Link button on the toolbar or use the Ctrl+L keyboard shortcut. If you want the link to be assigned to a text fragment, select it first. If no text is selected, the link URL or e-mail address will appear in the document as-is.

The Link dialog window that will open lets you choose the link type and configuration options pertaining to your choice. It contains two or three tabs that group link options, depending on the link type.

Link Info

Below is an overview of all Link Info tab elements:

Link Type – the category of the link that will be inserted into the document. You can choose between the following options:

  • URL – the web address of any resource available in the Internet, like a website, a PDF document, or an image. Example: http://example.com/image1.jpg
  • Link to anchor in the text – an internal link pointing the reader to a designated point in your document. Example: #anchor1
  • E-mail – an e-mail address. Example: myname@example.com

Protocol – the communication protocol used with the web address. You can choose between the following options: http://, https://, ftp://, news://, or <other>.

URL – the web address of the resource that the link is pointing to. It may be located on the same JIRA server you are currently in or on an external server.

  • External server: If you want to use an external address, use the full absolute path. Example: http://example.com/image1.jpg
  • Local JIRA: If the resource is located on the same JIRA server, you can use a relative path that omits the domain name and starts with a slash. Example: /secure/browse/PROJ-71

Target

The Target tab is only available for the URL link type. It specifies the location where the link will open after you click it. By default the target of the URL is not set and the link will open in the same browser window or tab as the document.

This tab contains only one element: a drop-down Target list that lets you choose the location where the link will open. The list contains the following options:

  • <not set> – the default setting that opens the link in the same browser window or tab as the document.
  • <frame> – the setting that opens the link in the frame specified in the Target Frame Name text box. The text box is only visible after you choose <frame> as the target.
  • <popup window> – the setting that opens the link in the pop-up window specified in the Popup Window Name text box. The text box is only visible after you choose <popup window> as the target.
  • New Window (_blank) – the setting that opens the link in a new window.
  • Topmost Window (_top) – the setting that opens the link in a window that is positioned on the top.
  • Same Window (_self) – the setting that opens the link in the same window as the document.
  • Parent Window (_parent) – the setting that opens the link in the window that the document window is nested in.

Advanced

The Advanced tab lets you configure additional link options such as assigning it an ID, a class, a tab index, a tooltip, or CSS style properties. It is meant for advanced users with knowledge of HTML and CSS and gives nearly endless possibilities as far as the presentation of the link is concerned.

  • Id – a unique identifier for the link element in the document (id attribute).
  • Language Direction – the direction of the text: left to right (LTR) or right to left (RTL) (dir attribute).
  • Access key – a keyboard shortcut to access the link element (accesskey attribute).
  • Name – the name of the link element (name attribute).
  • Language Code – the language of the link element specified according to http://www.ietf.org/rfc/rfc1766.txt (lang attribute).
  • Tab Index – the tab order of the link element (tabindex attribute).
  • Advisory Title – the text of the tooltip that is shown when the mouse cursor hovers over the link (title attribute).
  • Advisory Content Type – the content type of the link (type attribute).
  • Stylesheet Classes – the class of the link element (class attribute). Note that an link element might be assigned more than one class. If this is the case, separate class names with spaces.
  • Linked Resource Charset – the character set of the linked resource (charset attribute).
  • Relationship – the relationship between the current document and the link target (rel attribute).
  • Style – CSS style definitions (style attribute). Note that each value must end with a semi-colon and individual properties should be separated with spaces.

Source mode

JEditor is a rich text editor for JIRA that produces clean, standards-compliant HTML code. This means that you can write some text in the editing area and format it in a few simple clicks of the toolbar buttons without knowing the ins and outs of the HTML syntax.

If at any time you would like to check the HTML source code of your document, use the Source toolbar button. The text that will appear in the editing area contains all the relevant HTML tags and attributes.

Since the source code view is not read-only, you can also edit your document while in this mode. In order to return to the default, WYSIWYG view, press the Source button again.

Do remember though that HTML editing is an advanced feature and its use should be limited to users with knowledge of the HTML markup language. JEditor lets you format your document or insert media like images or links without worrying about the source code and tags.

Back to top ↑

Creating Forms

Adding forms into your documents is an advanced feature that requires both knowledge of HTML and access to a server that will process the data sent via the form. Due to these prerequisites the form toolbar is disabled by default and not available in the installation of JEditor that you are using. Please contact your system administrator if you need to add a form.

Form Element

The form element is a container for all form contents, which means that all form controls (for example checkboxes, text fields, or buttons) must be placed inside it. To insert the form into your document, press the Form toolbar button. The Form Properties dialog window that will open lets you configure basic form settings that control the form’s interaction with the server. Below is an overview of all Form Properties dialog window elements:

  • Name – the name of the form (name attribute).
  • Action – the location of the application that processes the form data (action attribute).
  • Id – the unique identifier for a form element in the document (id attribute).
  • Encoding – the parameter that specifies how the form data should be encoded before sending to the server (enctype attribute).
  • Target – the window where the results will be displayed after you send the form to the server (target attribute). You can choose between New Window (_blank), Topmost Window (_top), Same Window (_self), or Parent Window (_parent).
  • Method – the way the data should be sent to the server (method attribute). You can choose between GET and POST.

Once you configure the form and click the OK button, the form area will be visible in JEditor editing area as a frame with a red dotted border.

Since the form element is just a container, to make it usable you need to add some form controls. To do so, place the cursor inside the form frame and use further JEditor form toolbar buttons.

Back to top ↑

Checkbox

A checkbox is a form element that lets you select an item and send your selection to the server when you are submitting the form. Multiple checkboxes may be combined in a logical group, although their selection is independent of one another, which means that more than one item of the group can be selected at a time.

To insert a checkbox into a document in JEditor, place the cursor inside the form element and press the Checkbox toolbar button.

The Checkbox Properties dialog window that will open lets you set the name and value of a checkbox as well as decide whether it should be selected by default. Below is an overview of all Checkbox Properties dialog window elements:

  • Name – the name of the checkbox element (name attribute).
  • Value – the value of the checkbox element (value attribute).
  • Selected – the parameter that specifies the default state of the checkbox — whether it is selected or not (checked attribute).

Once you configure the checkbox and click the OK button, the checkbox will be visible in JEditor editing area and you will be able to add some text that describes the checkbox option.

Back to top ↑

Radio Button

A radio button is a form element that lets you select one item from the list and send your selection to the server when you are submitting the form. Radio buttons are usually used in groups and they differ from another form element, the checkbox, in that only one item can be selected at a time.

To insert a radio button into a document in JEditor, place the cursor inside the form element and press the Radio Button toolbar button.

The Radio Button Properties dialog window that will open lets you set the name and value of a radio button as well as decide whether it should be selected by default. Below is an overview of all Radio Button Properties dialog window elements:

  • Name – the name of the radio button element (name attribute).
  • Value – the value of the radio button element (value attribute).
  • Selected – the parameter that specifies the default state of the radio button — whether it is selected or not (checked attribute).

Once you configure the radio button and click the OK button, the radio button will be visible in JEditor editing area and you will be able to add some text that describes the radio button option.

Back to top ↑

Text Field

A text field is a form element that lets you enter text into a single-line field and send your input to the server when you are submitting the form. Text fields differ from another form element, the textarea, in that they are single-line fields and thus are meant for shorter entries.

A text field element comes in two variants. The first one lets you enter the text and see it as you type. The second one is used for entering passwords and obscures the typed characters with an asterisk (*), a bullet (•), or another symbol used by the browser.

To insert a text field into a document in JEditor, place the cursor inside the form element and press the Text Field toolbar button.

The Text Field Properties dialog window that will open lets you set the name, value, type, and size of a text field. Below is an overview of all Text Field Properties dialog window elements:

  • Name – the name of the text field element (name attribute).
  • Value – the value of the text field element (value attribute). This text will be visible in the text field when the form is loaded in the browser.
  • Character Width – the width of the text field specified as the number of characters that will fit in the field (size attribute). If omitted, the text field will have a default size determined by the browser.
  • Maximum Characters – the limit of characters that may be entered into the text field (maxlength attribute). If omitted, the length of text that you enter into the field will be unlimited and once you exceed the size of the box, the text will scroll to the right.
  • Type – the parameter that specifies whether the form field will be used for plain text (type=”text” attribute) or passwords (type=”password” attribute).

Once you configure the text field and click the OK button, the text field will be visible in JEditor editing area with the default value shown either as plain text, or a series of asterisks/bullets.

Back to top ↑

Textarea

A textarea is a form element that lets you enter text into a multiline, scrollable field, and send your input to the server when you are submitting the form. Textareas differ from another form element, the text field, in that they are multiline fields and thus are meant for longer entries.

To insert a textarea into a document in JEditor, place the cursor inside the form element and press the Text Area toolbar button.

The Textarea Properties dialog window that will open lets you set the name and size of a textarea. Below is an overview of all Textarea Properties dialog window elements:

  • Name – the name of the textarea element (name attribute).
  • Columns – the width of the textarea specified as the number of characters in the line (cols attribute). If omitted, the textarea will have a default width determined by the browser.
  • Rows – the number of lines of text that will be displayed in the textarea (rows attribute). If omitted, the textarea will have a default height determined by the browser.

Once you configure the textarea and click the OK button, the textarea will be visible in JEditor editing area as an empty rectangle. Depending on a browser, a vertical scrollbar might also be visible, and it might be possible to resize the textarea by clicking its frame and dragging with a mouse.

Back to top ↑

Selection Field

A selection field is a form element that lets you select one or more items from the scrollable list and send your selection to the server when you are submitting the form. Selection fields usually contain numerous options and depending on the settings, you can either limit the selection to one item or choose multiple items, by holding the Ctrl key while selecting them with a mouse or an Arrow key on your keyboard.

To insert a selection field into a document in JEditor, place the cursor inside the form element and press the Selection Field toolbar button.

The Selection Field Properties dialog window that will open lets you set the name of a selection field as well as the number and content of available options. Below is an overview of all Selection Field Properties dialog window elements:

  • Name – the name of the selection field element (name attribute).
  • Value – the value of the selection field element (value attribute). This option is filled in automatically when you set one of the items as a selected value.
  • Size – the number of rows of the selection field that are visible by default (size attribute). If the selection field contains more items, a scrollbar will appear.
  • Available Options – this section contains the options that the user will be able to choose from the selection field.
    • Text – the label of the selection field option.
    • Value – the value of the selection field option submitted to the server.
    • Add – adds an option to the selection field.
    • Modify – modifies a selected option.
    • Up – moves an option one row up the selection field.
    • Down – moves an option one row down the selection field.
    • Set as selected value – sets an option as selected by default.
    • Delete – deletes a selected option.
    • Allow multiple selections – lets the user select more than one option from the selection field.

Once you configure the selection field and click the OK button, the selection field will be visible in JEditor editing area.

Back to top ↑

Button

A button is a form element that gives the user a visual cue for completing a form action. Form button element comes in three variants.

  1. Standard button with arbitrary text.
  2. Submit button that submits the form data to the server.
  3. Reset button that resets the form elements to their default values.

To insert a button into a document in JEditor, place the cursor inside the form element and press the Button toolbar button.

The Button Properties dialog window that will open lets you set the name, value, and type of the button element. Below is an overview of all Button Properties dialog window elements:

  • Name – the name of the button element (name attribute).
  • Text (Value) – the text displayed on the button (value attribute).
  • Type – the button type. Possible options are Button (standard button with arbitrary text; type=”button” attribute), Submit (a button that submits the form data to the server; type=”submit” attribute), and Reset (a button resetting the form fields to their default values; type=”reset” attribute.

Once you configure the button element and click OK, the button will be visible in JEditor editing area with the text specified in the Text (Value) field.

Back to top ↑

Image Button

An image button is a form element that gives the user a visual cue for completing a form action. It is a clickable image that functions just like a standard button but has a customized appearance.

Back to top ↑

Hidden Field

A hidden field is a special form element in that it does not allow any interaction with the user and is hidden from view. At the same time its value is sent to the server when the form is being submitted.

To insert a hidden field into a document in JEditor, place the cursor inside the form element and press the Hidden Field toolbar button.

The Hidden Field Properties dialog window that will open lets you set the name and value of a hidden field. Below is an overview of all Hidden Field Properties dialog window elements:

  • Name – the name of the hidden field element (name attribute).
  • Value – the value of the hidden field element (value attribute).

Once you configure the hidden field and click the OK button, the hidden field will be visible in JEditor editing area as a small icon. Note, however, that as the name suggests, it will be hidden while in preview mode.

Back to top ↑

Restore Autosaved Content

If you lost your content and cannot recover it with the Redo button (for example you browser quits unexpectedly) you may use the Restore Autosaved Content button. To properly restore the lost content do not edit the text area and click the Restore Autosaved Content button.

This feature only works in browsers that support HTML 5 local storage. You may check if your browser supports this feature by visiting http://html5test.com.

Back to top ↑

Styles and Formatting

You may change the styles and formatting for most elements like text paragraphs, tables, lists, pictures and etc.

To apply the styling click on the element and expand the Styles combo on the toolbar. Click on a style to apply it.

For example create a table by using the Table button. When the table is ready click on it and expand the Styles combo. Apply the Clean style to the table.

Back to top ↑

Keyboard Shortcuts

Many functions in JEditor have their equivalent keyboard shortcuts. This is one of the reasons why working with the editor is simple and efficient. The list below contains available keyboard shortcuts grouped by problem areas.

Rich Text

  • Ctrl+L – opens the Link dialog window.
  • Ctrl+M – opens the Mention dialog window.

Working with a Document

  • Esc – closes a JEditor dialog window, drop-down list, or context menu. Also moves from the context menu submenu to the parent option.
  • Enter – selects a JEditor function from the toolbar, drop-down list, or context menu. Equivalent to the OK button in a dialog window.
  • Shift+F10, Menu/Application key – opens the element’s context menu.

Navigation

  • Home – jumps to the beginning of the line.
  • Ctrl+Home – jumps to the beginning of the document.
  • End – jumps to the end of the line.
  • Ctrl+End – jumps to the end of the document.
  • PgDn – scrolls down the document, approximately by the length of the editing area.
  • PgUp – scrolls up the document, approximately by the length of the editing area.

Writing

  • Enter (Return) – ends a paragraph and starts a new one.
  • Shift+Enter – adds a line break.
  • Backspace, Del – deletes a character.
  • Ctrl+Backspace, Ctrl+Del – deletes a word.

Undo and Redo

  • Ctrl+Z – performs the undo operation.
  • Ctrl+Y – performs the redo operation.

Cut, Copy and Paste

  • Ctrl+X, Shift+Del – cuts a text fragment to clipboard.
  • Ctrl+C – copies a text fragment to clipboard.
  • Ctrl+V, Shift+Insert – pastes a text fragment from clipboard.

Text Selection

  • Ctrl+A – selects all document contents.
  • Shift+Arrow – selects a text fragment by letters.
  • Ctrl+Shift+Arrow – selects a text fragment by words.
  • Shift+Home – selects a text fragment from the cursor to the beginning of the line.
  • Shift+End – selects a text fragment from the cursor to the end of the line.
  • Ctrl+Shift+Home – selects a text fragment from the cursor to the beginning of the document.
  • Ctrl+Shift+End – selects a text fragment from the cursor to the end of the document.
  • Shift+PgDn – selects a text fragment of approximately the length of the editing area starting from the cursor and going down.
  • Shift+PgUp – selects a text fragment of approximately the length of the editing area starting from the cursor and going up.

Text Styling

  • Ctrl+B – applies bold formatting to a text fragment.
  • Ctrl+I – applies italics formatting to a text fragment.
  • Ctrl+U – applies underline formatting to a text fragment.

Navigation

  • Alt+F10 – enters the toolbar or the tab list of the currently open dialog window.
  • Alt+F11 – enters the elements path.
  • Tab – moves to the next toolbar button group, context menu suboption, elements path element, dialog window element, or dialog window tab while in the tab list.
  • Right Arrow – moves to the next toolbar button within the group, context menu suboption, elements path element, dialog window element, or dialog window tab while in the tab list.
  • Tab or Down Arrow – moves to the next drop-down list or context menu option.
  • Shift+Tab – moves to the previous toolbar button group, context menu parent option, elements path element, dialog window element, or dialog window tab while in the tab list.
  • Left Arrow – moves to the previous toolbar button within the group, context menu parent option, elements path element, dialog window element, or dialog window tab while in the tab list.
  • Shift+Tab or Up Arrow – moves to the previous drop-down list or context menu option.
  • Space or Enter – activates a toolbar button, a context menu option, a drop-down list option, an elements path element, or a dialog window tab once selected. Also enters a context menu submenu, if it is available.

Shift-Enter

If you wish to end the line of text but do not wish to create a new paragraph, press Shift-Enter.

Back to top ↑

Browser support

We support Google Chrome, Apple Safari, Mozilla Firefox, MS Internet Explorer 9+.

Back to top ↑