wiki:TracPlantUmlPlugin

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

Refs #8823.

Trac PlantUML Plugin

Description

PlantUML (http://plantuml.sourceforge.net/) 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 TracPlantUmlPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out TracPlantUmlPlugin 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:

Example sequence diagram

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

Recent Changes

Error: Macro ChangeLog(tracplantumlplugin, 3) failed
No node tracplantumlplugin at revision 14041

Author/Contributors

Author: airadier
Maintainers: airadier, rjollos
Contributors:

ebencheung forked this plugin on github, for supporting utf8 characters(eg.Chinese)

ebencheung created a new branch WriteImgToFile : So it will work when apache's session size is limited, while the origin code will show nothing if you create large or many diagrams on a single wiki page.

Attachments (1)

Download all attachments as: .zip