Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw

Docutils (Install)

Docutils allows to conveniently write and generate documents in various output formats (see installation details here):

  1. Replace/patch your docutils distribution with the files in src/
  2. See usage examples in usage/including how to setup defaults PlantUML

Usage

Use the "uml" directive and write an indented block of PlantUML commands. No arguments are required, an image will be generated and inlined. The name is derived from the input line number, the generated plantuml "source" is keep in the same directory. 

.. uml::

actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C

User -> A: DoWork
activate A

You can pass a filename for the image (WITHOUT extension) as an optional parameter. 

.. uml:: uml2/myDiagram123

actor User
participant "First Class" as A
participant "Second Class" as B
participant "Last Class" as C

User -> A: DoMoreWork
activate A

Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.