(Feature image from: File type plantuml - Files & Folders Icons Searched by plant umlicon in DDG)

First Impressions

• PlantUML (plantuml.jar) is a java application. So, it can be executed by using java -jar plantuml.jar aDiag.txt Docs

  • Heard from this video: 优秀软件推荐之PlantUML - Karl1864, where the presenter calls PlantUML a “java 程序” (Searched by “plantUML” in Bilibili )

• PlantUML can plot Timing diagram and Network diagram:

  Timing	nwdiag

• Different from Mermaid rendering is in browser, PlantUML needs a server. However, uploading private data to a free public server is dangerous with the risk being caught. PlantUML FAQs; Docsy PlantUML support

Install & Config

VSCode Ext

References:

1. Configuring and Running PlantUML with VS Code - Medium · Sadaf Siddiqu
   • Searched by “vscode for plantuml” in DDG

Notes:

(2024-10-12)

1. A server or a local Java (serving as the plantform for plantuml.jar) is required to render diagrams qjebbs

   So, when there is no server provided, pressing Alt + d won’t display the preview of the diagram.

   

   • If using the official server https://www.plantuml.com/plantuml, the data will be shared with the server. How long do the images generated by PlantUML Server live for?

   • The Graphviz is not necessary since the extension already contains. Reopen the VSCode, the preview can be rendered correctly.

   • The preview will be updated real-time.

(2025/03/14)

2. Previewing diagram successes without specifying plantuml.jar location or setting Plantuml: Render to PlantUMLServer

Windows

References:

1. A Guide to setup and use Plantuml · GitHub
   • Searched by plantuml jar in DDG
2. Local Installation Procedure - Quick Start Guide to PlantUML

Notes:

(2025/03/14)

1. Command line using plantuml-lgpl-1.2025.2.jar ^r2-Start

   • Actions:

     1. Command ^r1-Gist

        1	java -jar %plant_uml% diagram.puml -o output -progress -tpdf

Ubuntu

References:

1. Quick Start Guide to PlantUML
2. Frequently Asked Questions about Installation

Notes:

1. Download the plantuml-gplv2-1.2024.8.jar (GPL v2) ^r1-Start.

2. Test this page ^r2-Faq:

   1	java -jar ~/Programs/plantuml-gplv2-1.2024.8.jar -verbose ./index.md

   

Syntax

Remove Foot Boxes

Don’t show objects at bottom

(2024/10/12)

1. Use skinparam command

   Ref: Using PlantUML in VSCode - Christopher Fuhrman (Searched by “plantuml preview in vscode doesn’t work” in DDG)

   1 2 3 4 5 6 7 8 9 10 11

   @startuml Hello title skinparam style strictuml skinparam SequenceMessageAlignment center ' Sequence diagram A -> B : Hello B -> A : Hi @enduml

2. Use hide footbox

   Ref: Docs

   1 2 3 4

   @startuml hide footbox title Foot Box Removed @enduml

Lifeline

(2024/10/15)

• Lifeline of a participant can be activate (or ++) and deactivate (or --), while Participant can be ** (created) and !! (deleted).

  • return with autoactive on opened will deactivate the most recent lifeline.

  Ref: Sequence - Lifeline Activation and Destruction