Drawing diagrams with PlantUML
Custom Images
In addition to the integrated icons, you can also create custom images. Listing 9 shows the source for embedding a custom image, and Figure 8 shows its output.
Listing 9
Embedding Images
01 @startuml 02 sprite tux linuxtux.png 03 Linux->World : I am here <$tux>, where are you? 04 Linux<-World : I am SO glad to see you! 05 @enduml
To do this, define a sprite
(a graphical element) with a label (tux
in my example) and associate it with an actual image on your hard drive. Next, you can place the image where you want by calling its label with the syntax shown in line 3 of Listing 8. In addition to regular images, you may define and embed custom sprites [7], which are monochrome images that are defined similarly to traditional ASCII art right inside your UML code:
startuml sprite $foo1 { FFFFFFFFFFFFFFF F0123456789ABCF F0123456789ABCF FFFFFFFFFFFFFFF }
This format is less esoteric than it may seem. Each hexadecimal digit inside the curly braces corresponds to one pixel of the image, and its value corresponds to the gray level of that pixel, with
being white, and F
being black. For further details on embedded sprites, see the PlantUML guide [5].
UML Programming
UML's creators have given it several capabilities of a real programming language.
You can include comments in your UML files to make them more readable. Single line comments start with one simple quote ('
), and multiline comments are enclosed by /'
and '/
tags.
Lines that start with exclamation marks (!
) are preprocessing directives, with which you can give PlantUML general instructions or make it interact with your system. The following
!log Now generating a Gantt Diagram
tells PlantUML to log a message, by writing it to its standard output.
PlantUML also uses variables and functions. PlantUML variables can only contain strings or integer numbers; it is good practice to give them names starting with a dollar sign ($
), like Perl. Besides storing values for later use, variables can also be used for simple flow control, to decide what to draw where:
Alice -> Bob : Are you free tonight? !if ($day == "Saturday") Alice <- Bob : yes !else Alice -> Bob : no, I'm sorry !endif
PlantUML supports three different types of functions: built-in, void, and return functions. Built-in functions, which have names starting with %
, include operators like %strlen
(string length) or %substr
(substring extraction). Other built-in functions give access to system information, like file location or the current date.
Void and return functions are recognizable, because, like variables, their names must start with a dollar sign ($
). The difference is simple between void and return functions and summarized in Listing 10.
Listing 10
Void and Return Functions
01 !function $warning($source, $recipient) 02 $source --> $recipient : Warning! You have been hacked! 03 !endfunction 04 !function $halfvalue($a) 05 !return $a/2 06 !endfunction
Void functions directly insert something (normally one statement) into the UML diagram description. In Listing 10, the $warning
function (line 1) will print a warning from user $source
to user $recipient
whenever it is called, obviously replacing $source
and $recipient
with the current values of those variables. Return functions perform a calculation or string processing and return the result (lines 4 and 5); they are often called from other functions.
In both void and return functions, you can define local variables, which are not visible from outside the function, and set default values for the arguments.
Code Management
In UML, as in software in general, reuse is almost always good, and duplication is almost always bad. You can put all the configuration and formatting functions that you regularly use in one file and make PlantUML load it as follows:
java -jar /path/to/plantuml.jar -config "./config.cfg" dir1
To do the same thing with the actual drawing code (e.g., the initial part of a sequence exchange or flow diagram) that you want to duplicate in other diagrams, you can write the corresponding code once (maybe packaging it as a function) in one file. Then !include
that file in other files every time you need it as follows:
@startuml !include common-diagrams-section.iuml .. your other UML code here @enduml
By doing this, any change in that single file will be seen and reloaded by all the files that include it the next time you run PlantUML, just as if you had copied and pasted common-diagrams-section
in each file. The !include
directive supports URLs, so you may even load code directly from the Internet or your company network. By default, a file can only be included once. You may include the same file several times in your code with the !include_many
directive, but think twice before doing it: It may make your code unmanageable.
Syntax-wise, you may also put several independent blocks of common code in the same file, each within its own @startuml
/@enduml
statements, and identify each of those blocks by their number. A directive like !include myuml.txt!1
will then load only the second (numbering starts from
) block within myuml.txt
. To improve code readability, you can assign names to a block
@startuml(id=SOME_IDENTIFIER)
and then include only that block with this statement
!include foo.txt!SOME_IDENTIFIER
Buy this article as PDF
(incl. VAT)
Buy Linux Magazine
Subscribe to our Linux Newsletters
Find Linux and Open Source Jobs
Subscribe to our ADMIN Newsletters
Support Our Work
Linux Magazine content is made possible with support from readers like you. Please consider contributing when you’ve found an article to be beneficial.
News
-
Canonical Bumps LTS Support to 12 years
If you're worried that your Ubuntu LTS release won't be supported long enough to last, Canonical has a surprise for you in the form of 12 years of security coverage.
-
Fedora 40 Beta Released Soon
With the official release of Fedora 40 coming in April, it's almost time to download the beta and see what's new.
-
New Pentesting Distribution to Compete with Kali Linux
SnoopGod is now available for your testing needs
-
Juno Computers Launches Another Linux Laptop
If you're looking for a powerhouse laptop that runs Ubuntu, the Juno Computers Neptune 17 v6 should be on your radar.
-
ZorinOS 17.1 Released, Includes Improved Windows App Support
If you need or desire to run Windows applications on Linux, there's one distribution intent on making that easier for you and its new release further improves that feature.
-
Linux Market Share Surpasses 4% for the First Time
Look out Windows and macOS, Linux is on the rise and has even topped ChromeOS to become the fourth most widely used OS around the globe.
-
KDE’s Plasma 6 Officially Available
KDE’s Plasma 6.0 "Megarelease" has happened, and it's brimming with new features, polish, and performance.
-
Latest Version of Tails Unleashed
Tails 6.0 is based on Debian 12 and includes GNOME 43.
-
KDE Announces New Slimbook V with Plenty of Power and KDE’s Plasma 6
If you're a fan of KDE Plasma, you'll be thrilled to hear they've announced a new Slimbook with an AMD CPU and the latest version of KDE Plasma desktop.
-
Monthly Sponsorship Includes Early Access to elementary OS 8
If you want to get a glimpse of what's in the pipeline for elementary OS 8, just set up a monthly sponsorship to help fund its continued existence.