PlantUml Diagrams for Confluence

About the add-on

About

“PlantUML Diagrams for Confluence” is an add-on for Confluence (Cloud and on-prem) that allows PlantUML and Graphviz DOT diagrams to be created, edited and stored on customer’s Confluence instance. The add-on only stores the text description and resulting image output on customer’s Confluence instance.

For cloud based add-on, diagram markup passes through secured servers where image is generated and both the markup and the resulting image are persisted only on the Confluence instance.

For on-prem based add-on, there is no outgoing traffic. Everything is contained within the server.

The PlantUML website has thorough documentation on how to build the various UML diagram types it supports.

The plugin also supports Graphviz DOT flowcharts:

1 2 3 4 5 6 7 8 9 10 @startdot digraph foo { node [style=rounded] node1 [shape=box] node2 [fillcolor=yellow, style="rounded,filled", shape=diamond] node3 [shape=record, label="{ a | b | c }"] node1 -> node2 -> node3 } @enddot

The second line of a Graphviz definition must be of the form:

1 digraph name {

Note that you can use @startuml / @enduml or @startdot / @enddot, both will work. Only the DOT language is supported.

Usage

To insert a PlantUML or Graphviz diagram, whilst a page is being edited, insert a “plantumlcloud” macro. See the Atlassian documentation for inserting and editing macros. Once inserted you will see a macro window like this one:

On the left side is PlantUML diagram editor. On the right side is diagram preview that can be generated by clicking Ctrl+Enter (Cmd+Enter on Mac).

Click on Publish button to insert the diagram into the page. “Save as “ popup asking for diagram name will appear. After user gives diagram name, it will appear in the page viewer, page editor and page PDF export.

There is also option to directly import diagrams from the GitHub repository.