Attach UML Diagrams for Confluence Cloud

VicoSoft
3 min readSep 28, 2019

--

UML for Confluence Cloud enables to add various charts in UML syntax into a Confluence page with no extra work by typing /uml and insert an UML code block using a special syntax defined by the PlantUML Project.

Get Started

  1. Install UML for Confluence Cloud in your instance.
  2. Within you Confluent page editor type /uml to activate the plugin.
Type /uml to activate the plugin

Sometimes, it takes a while for the shortcut to get activated. You need to use insert (+) to add the plugin yourself

Insert UML Plugin
Filter UML Macro

3. Type 3 backticks (```) to enable code block so that you can format the UML code easily.

Type 3 backticks to enable code block

4. Type or paste UML text to the code block.

Edit UML in the code block

5. Click at pencil icon to preview the diagram

Show Preview Dialog
UML Preview Diagram

6. Publish your page once done

Generated UML Diagrams

Learn about the UML syntax

The plugin can be used to generate all kind of PlantUML diagrams. In order to create a specific diagram, you can follow the link to learn about the UML syntax:

PlantUML syntax support many feature to help you easily to customize your diagrams including:

Color

You can use specify fill and line colors either:

Skin

You can change colors and font of the drawing using the skinparam command.

Sprites

A Sprite is a small graphic element that can be used in diagrams.

In PlantUML, sprites are monochrome and can have either 4, 8 or 16 gray level.

To define a sprite, you have to use a hexadecimal digit between 0 and F per pixel.

Then you can use the sprite using <$XXX> where XXX is the name of the sprite.

Creole

A light Creole engine has been integrated into PlantUML to have a standardized way of defining text style.

All diagrams are now supporting this syntax.

Note that ascending compatibility with HTML syntax is preserved.

--

--