Versatile PlantUML Jira Plugin

Created by Terry Mallory-Robinson
Last updated: Feb 04, 2022

For a high-level overview of what PlantUML is see https://purplerhapsodytech.atlassian.net/wiki/spaces/VPP/pages/26443836

And what does this plugin do in Jira?

It allows you to add diagrams directly into Jira issues...

Type/Copy/Paste PlantUML

and have it create an image in your page(s). It looks like this:

There is also a small selection of templates you can use to get you started, accessible from the Templates button in the editor:

Automatically refresh the preview image as you type. Pause your typing for a couple of seconds and the preview image will refresh itself.

 

You can also apply Themes to your diagrams. See https://purplerhapsodytech.atlassian.net/wiki/spaces/VPP/pages/44990465 for more information.

Step-by-step

Showing the PlantUML Diagrams panel

While in an issue click the issue menu (3 dots or dropdown symbol) and select PlantUML Diagrams from the list of apps. It will show the panel inline in the issue view. If you have no diagrams already created for this issue then it will simple have an “Add Diagram” button.

 

Adding a Diagram

Clicking the “Add Diagram” button opens up the PlantUML Editor. Enter a title, select whether you want a PNG or SVG generated and then do one of the following:

  • Choose from one of the templates.

  • Type your PlantUML in.

  • Tick the “Get PlantUML from a URL” box and enter a URL to PlantUML text. This URL must be publicly available on the internet.

To preview at any time click the “Refresh” button. Once you’re happy with the diagram click the “Submit” button.

 

Diagram is added to the Issue View

The diagram is then added to the Issue View. Clicking the 3 dots menu gives you options to edit or remove the diagram - NOTE: Removing a diagram cannot be undone so use this option carefully!

 

Zoom Zoom Zoom!

The diagrams are fully zoomable. Either select the “View Full Screen” option from the menu or click on the diagram itself and it opens up in fullscreen mode with options to zoom in/out and move around.

 

Multiple Diagrams

If you have added more than one diagram to the issue then you can move the diagrams up and down by clicking the “3 dots” menu for a diagram and selecting “Move up” or “Move down”. These are context-sensitive and so you won’t be able to move the first document up or the last document down…