Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Common Commands in PlantUML

Discover the fundamental commands universally applicable across all diagram types in PlantUML. These commands allow you to inject versatility and personalized details into your diagrams. Below, we breakdown these common commands into three major categories:

Global Elements

Comments: Add remarks or explanatory notes in your diagram script to convey additional information or to leave reminders for further modifications.
Notes: Incorporate supplementary information directly onto your diagram to aid in understanding or to highlight important aspects.
Size Control: Adjust the dimensions of various elements to suit your preferences, ensuring a balanced and well-proportioned diagram.
Title and Captions: Define a fitting title and add captions to elucidate the context or to annotate specific parts of your diagram.

Creole Syntax Description

Harness the power of Creole syntax to further format the content of any element within your diagram. This wiki markup style allows for:

Text Formatting: Customize the appearance of your text with various styles and alignments.
Lists: Create ordered or unordered lists to present information neatly.
Links: Integrate hyperlinks to facilitate quick navigation to relevant resources.

Style Control Command

Gain complete control over the presentation style of your diagram elements using the style command. Utilize this to:

Define Styles: Set uniform styles for elements to maintain a cohesive visual theme.
Customize Colors: Choose specific colors for various elements to enhance visual appeal and to create distinct classifications.

Explore these commands to create diagrams that are both functional and aesthetically pleasing, tailoring each element to your exact specifications.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Comments

Simple comment

Everything that starts with simple quote ' at the beginning of a line is a comment.

@startuml
'Line comments use a single apostrophe
@enduml

Block comment

Block comment use C-style comments except that instead of * you use an apostrophe ', then you can also put comments on several lines using /' to start and '/ to end.

@startuml
/'
many lines comments
here
'/
@enduml

[Ref. QA-1353]

Then you can also put block comment on the same line, as:

[Ref. QA-3906 and QA-3910]

Full example

[Ref. GH-214]

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Zoom or Scale

You can use the scale command to zoom the generated image.

You can use either a number or a fraction to define the scale factor. You can also specify either width or height (in pixel). And you can also give both width and height: the image is scaled to fit inside the specified dimension.

scale 1.5
scale 2/3
scale 200 width
scale 200 height
scale 200*100
scale max 300*200
scale max 1024 width
scale max 800 height

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Title

The title keywords is used to put a title. You can add newline using \n in the title description.

Some skinparam settings are available to put borders on the title.

You can use creole formatting in the title.

You can also define title on several lines using title and end title keywords.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Caption

There is also a caption keyword to put a caption under the diagram.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Footer and header

You can use the commands header or footer to add a footer or a header on any generated diagram.

You can optionally specify if you want a center, left or right footer/header, by adding a keyword.

As with title, it is possible to define a header or a footer on several lines.

It is also possible to put some HTML into the header or footer.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Legend the diagram

The legend and end legend are keywords is used to put a legend.

You can optionally specify to have left, right, top, bottom or center alignment for the legend.

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram

Activity

Archimate

Class

Component, Deployment, Use-Case

Gantt project planning

DONE

[(Header, footer) corrected on V1.2020.18]

Object

MindMap

Network (nwdiag)

Sequence

State

Timing

Work Breakdown Structure (WBS)

DONE

[Corrected on V1.2020.17]

Wireframe (SALT)

DONE

[Corrected on V1.2020.18]

Edit in Dokuwiki Edit in Asciidoc Edit in Markdown
Appendix: Examples on all diagram with style

DONE

FYI:

all is only good for Sequence diagram
title, caption and legend are good for all diagrams except for salt diagram

FIXME

🚩

Now (test on 1.2020.18-19) header, footer are not good for all other diagrams except only for Sequence diagram.

To be fix; Thanks

FIXME

Here are tests of title, header, footer, caption or legend on all the diagram with the debug style:

<style>
title {
  HorizontalAlignment right
  FontSize 24
  FontColor blue
}

header {
  HorizontalAlignment center
  FontSize 26
  FontColor purple
}

footer {
  HorizontalAlignment left
  FontSize 28
  FontColor red
}

legend {
  FontSize 30
  BackGroundColor yellow
  Margin 30
  Padding 50
}

caption {
  FontSize 32
}
</style>