UML Viewer for Confluence

Owned by Kabir Adm
Last updated: Jun 24, 2023
4 min read

Installation

From the Confluence Instance

  1. Log into your Confluence instance.

  2. Click the Apps dropdown and choose Find new apps.The Find new apps screen loads.

  3. Search for UML Viewer for Confluence and click on the app tile.The App Details screen loads.

  4. Click Try it free to start installing your app.

  5. You're all set! Click Close in the Installed and ready to go dialog.

From the Marketplace

  1. Visit https://marketplace.atlassian.com/vendors/1224360/

  2. Click on UML Viewer for Confluence

  3. Click at Try it free and follow the installation process

Insert the diagram

There are two ways to insert the diagram into the Confluence page

1. From the toolbar

  • Click on the + icon in the top toolbar of the page

  • Type into the add-on search box with “UML Diagram“

 

  • Click on the item highlighted in the green box

2. With slash(/) shortcut

  • Type /uml

  • Click in the green box

 

After inserted, the add-on will look like

 

For updating the diagram and getting more about the Mermaid Diagram features. You can go through the next sections.

Update the diagram

How to update the diagrams?

Select the add-on to show the toolbar then click on the pencil button

After clicked you will see the configuration panel shown up from right

You can choose any theme that you want. We supported many themes and you can take it out at - https://the-lum.github.io/puml-themes-gallery/

The add-ons allows to config the output diagram render size including: Auto (max width: 100%) which is default, Large (max width: 992px), Medium (max width: 768px), Small (max width: 576px), X-Small (Max width: 256px). This field is very useful for configuring the diagram size especially when exporting your page.

Type allows you to select the generate output type including: SVG, PNG, ASCII Art. If you want the link in the diagram clickable, you should select SVG in this field.

Then, update the code block. You can copy and paste the sample code below to the Code box.

@startuml actor Bob [[http://plantuml.com/sequence]] actor "This is [[http://plantuml.com/sequence Alice]] actor" as Alice Bob -> Alice [[http://plantuml.com/start]] : hello note left [[http://plantuml.com/start]] a note with a link end note Alice -> Bob : hello with [[http://plantuml.com/start{Tooltip for message} some link]] note right [[http://plantuml.com/start]] : another note note left of Bob You can use [[http://plantuml.com/start links in notes]] also. end note @enduml

 

After pasted, click outside the Code box or close the configuration panel to see the generated diagram.

 

You can also overwrite the theme by code. When you use this feature, you have to select None in theme selector. Example code:

@startuml !theme reddress-lightblue a -> b b -> c @enduml

When done, you can preview and publish your page at any time.

Learn more about the PlantUML diagram and syntax?

You take a look at the PlantUML document. All supported diagrams are listed there with details. You can also use the Live Editor to write your code, then copy and paste it to the add-on configuration Code.

Export your page

UML Diagram is supported to work with exporters including the native PDF Exporter.

You can click at more actions in the top toolbar and choose Export, then select the export type that you want.

Our support channel

You can reach us anytime at Gluebin Softs Portal for any information regarding our product user guide and issues during using our applications.