Page tree
Skip to end of metadata
Go to start of metadata

 

About

PlantUML is a plugin for Confluence Cloud that allows PlantUML and Graphviz DOT diagrams to be created, edited and stored on your Confluence Cloud instance. The plugin only stores both the text description and resulting image output with your Confluence Cloud instance, nowhere else. Data only passes through our servers during image generation and is deleted straight after that process.

The PlantUML website has thorough documentation for how to build the various UML diagram types it supports. We will not repeat the documentation here, but will host a copy of the PDF documentation in case the site is down.

The plugin also support Graphviz DOT flowcharts:

@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

Note that you can use @startuml / @enduml or @startdot / @enddot, both will work.

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

digraph name {

Only the DOT language is supported, below is a copy of the DOT documentation in case the Graphviz web site has issues:

Usage

To insert a PlantUML or Graphviz diagram, whilst a page is being edited, insert a {plantuml} macro. See the Atlassian documentation for inserting and editing macros. Once inserted you will see a macro box that says "PlantUML for Confluence". Click the macro and press "edit". This will bring you to the macro editor:

 

 

Enter the filename and width and height of the viewer you require in your Confluence page.

Next, in the definition, enter your PlantUML or Graphviz definition, for example:

 

 

or

 

 

And then press save. Once the page edit is completed by saving the page, the viewer will display the diagram at the requested size on the page.

Support

 

For support questions please post on Atlassian Answers using the tag "addon-com.mxgraph.confluence.plugins.plantuml".

 

  • No labels