wiki:PlantUmlMacro

Version 2 (modified by rjollos, 5 years ago) (diff)

Changed page title. Added license.

Display PlantUML Diagrams

Description

PlantUML is a java utility that allows generation of different types of UML diagrams (sequence, activity, state, use cases, ...) from a simple text description file.

This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams.

Dependencies

The plugin depends on PlantUML compiled jar being installed on the system, a valid Java runtime, and Graphviz installed and correctly configured (these are dependencies for PlantUML itself)

Configuration

The following entry must be added to trac.ini:

[components]
...
plantuml.* = enabled


[plantuml]
plantuml_jar = /path/to/plantuml.jar
java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)

Bugs/Feature Requests

Existing bugs and feature requests for PlantUmlMacro are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from [download:plantumlmacro here].

Source

You can check out PlantUmlMacro from here using Subversion, or browse the source with Trac.

Example

Use with:

{{{
#!PlantUML
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
}}}

results in something like:

More information on the PlantUML language can be found in PlantUML Website

Recent Changes

14688 by rjollos on 2015-06-18 02:50:57
2.1dev: Removed tag_svn_revision attribute.

The attribute is not supported in setuptools >= 10.

14668 by rjollos on 2015-06-16 02:26:47
2.0: Tag PlantUmlMacro 2.0. Refs #9958.
14667 by rjollos on 2015-06-16 02:23:55
2.0: Bump version to 2.0.
(more)

Author/Contributors

Author: airadier
Maintainers: airadier, rjollos
Contributors:
License: GPL

Attachments (1)

Download all attachments as: .zip