JIRA CKEditor Integration
 | CKEditor plugins that allow smoother integration between JIRA and XWiki (e.g. pasting a JIRA link results in |
| Type | XAR |
| Category | Application |
| Developed by | Vincent Massol, Simon Urli, Teodor Caras, XWiki Development Team |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
CKEditor plugins that allow smoother integration between JIRA and XWiki (e.g. pasting a JIRA link results in inserting automatically the JIRA macro).
Using the plugin
The plugin will replace the links you paste in the CKEditor with a JIRA macro. A link will only be converted if it's prefixed by one of the configured JIRA instances. There are three cases covered by the plugin.
Pasting a link to a ticket
If the user pastes a link to a ticket, such as https://myjirainstance/browse/ISSUE-1000, it will be resolved to the following macro call:
XWIKI-1000
{{/jira}}
Note that pasting a link to a ticket also functions inline, since the "enum" style of the JIRA macro supports it.
Pasting a link containing a JQL query
If the user pastes a link containing a JQL query, such as https://myjirainstance/issues/?jql=issuekey%20in%20(ISSUE-1000%2C%20ISSUE-1001), it will be resolved to the following macro call:
issuekey in (ISSUE-1000, ISSUE-1001)
{{/jira}}
Note that pasting a link containing a JQL query does not work inline. Doing so will insert the macro call on a new line.
Pasting a link without formatting
Pasting a link without formatting (CTRL + SHIFT + V) will not transform the link into a macro. Thus, if you don't want the link you paste to be converted, you should paste it without formatting.
Feature preview
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Activating the plugin
After installing the application, you need to update the CKEditor configuration to use the newly added plugin. In order to do that, access Administer XWiki -> Editing -> WYSIWYG Editor and paste the following in the Advanced Configuration: config.extraPlugins = 'xwiki-jira-paste';
Dependencies
Dependencies for this extension (org.xwiki.contrib.jira:jira-ckeditor-ui 10.1.1):
