Plantuml Cheat Sheet



Usage Command Palette. Open the Markdown file; Press F1 or Ctrl+Shift+P; Type export and select below. Markdown-pdf: Export (settings.json) markdown-pdf: Export (pdf) markdown-pdf: Export (html). PlantUML is a component that allows to quickly write. This is cheat sheet of PlantUML to use frequently.

PlantUML is a component that allows to quickly write.This is cheat sheet of PlantUML to use frequently.

  1. PlantUML cheatsheet. The one-page guide to PlantUML: usage, examples, links, snippets, and more. This is Cheatsheets - W3cubDocs— a collection of cheatsheets.
  2. You can download freely the PlantUML Language Reference Guide in PDF format.
  3. EMOJI CHEAT SHEET; boolean. Default: true; Configuration options markdown-pdf.executablePath. For example, to run Plantuml Server locally #139: docker run -d -p 8080:8080 plantuml/plantuml-server:jetty plantuml/plantuml-server - Docker Hub; markdown-it-include options.

Common

Notes and Comments.

keywordusageimage
titleTitle
note left :Notes Left
note right :Notes Right
' Single-line Comment
/' '/Block Comment

Code

Draw

Participant

Participant actors.

keywordusageimage
actorActor
boundaryBoundary
controlControl
entityEntity
databaseDatabase

Code

Draw

Arrow

Arrow direction.

keywordusageimage
-up->Up
-down->Down
-left->Left
-right->Right

Code

Draw

Use Case

Represent the required functions.

keywordusageimage
( )Use Case
->Use
.>Extend, Include

Code

Draw

Activity

Represent the state of the process.

keywordusageimage
' 'Activity
(*) ->Initial
-> (*)Final

Code

Draw

State

Represent the state of the objects.

keywordusageimage
[*] ->Initial
-> [*]Final

Code

Draw

Sequence

Represent the messages and orders of the interacts.

keywordusageimage
->Message
<--Return

Code

Draw

Object

Represent the logical view of the object.

Sequence
keywordusageimage
objectObject
<|-Extension
*-Composition
o-Agregation

Code

Draw

Class

Represent the logical view of the class.

keywordusageimage
classClass
+Public
-Private
#Protected
~Package

Code

Draw

Component

Represent the dependency of the components.

Plantuml Table

keywordusageimage
[ ]Component
packagePackage
frameFrame
folderFolder
databaseDatabase
nodeNode
cloudCloud

Code

Plantuml Note

Cheat

Draw

Colors

We can add colors to Arrows, Icons, Sprites, Components, Packages, etc.PlantUML support Hexadecimal colors or colors that are already defined.

Site Reference: http://plantuml.com/skinparam

Code

Draw

Legends

Legend can contain only text, or some tables.This example contain a table with some HTML inside and OpenIconic.

OpenIconic Reference: http://plantuml.com/openiconic

Code

Draw

Constants

Plantuml Cheat Sheet

Plantuml Comment Syntax

It’s possible to declare constants that will help us for example to include files or other *.puml

PS: when you use it remove ${}, thats only there for the example

Plantuml

Code

Sprites & Includes

There are a lot of useful sprites and images that we can use.In the next example you have all the ways to implement components using this open source library.

Plantuml Cheat Sheet Printable

Code

Plantuml Cheat Sheet Pdf

Draw