Explanation

The PlantUML Macro draws diagrams in wiki pages from a textual definition written in the PlantUML language. To use it, see Add a Diagram to a Page and the "plantuml" macro reference.

Besides UML diagrams (sequence, use case, class, activity, component, state and others), PlantUML draws Ditaa and GraphViz diagrams, wireframes, mind maps, work breakdown structures, Gantt charts, regular expressions, EBNF grammars, and JSON or YAML data. The diagram is generated from its text each time the page is displayed, so changing the text is enough to update it.

For example, the following definition:

@startuml
actor User
User -> XWiki : Log in
XWiki -> XWiki : Check the credentials
XWiki --> User : Display the home page
@enduml

is displayed as follows.

An administrator installs the macro and decides whether XWiki generates the diagrams itself or delegates them to a PlantUML server: see PlantUML for administrators.

More

To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.

Related

• PlantUML (for Administrators)
• PlantUML (for Developers)
• PlantUML Macro issues