wiki:PlantUmlMacro

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

Fixed incorrect statement about development path, and added note about creating a tag when we reach the 2.0 milestone. Added request for feedback.

The trunk is a development version that works with Trac 0.11 and later. The code is thought to be stable, but please be ready to do some testing and report defects if you intend to install it on a production system. A tag will be created for version 2.0 when the code is known to be stable. Posting a note to #9958 about your experience using the plugin would be very appreciated.

Planned Enhancements

  • Work towards v2.0, improving documentation and fixing minor defects.
  • Render plantuml files from repository #7053.

News

  • 19-March-2012: License changed from GPL to BSD 3-Clause, which is the license used by Trac.

Render 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 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

[13476] by rjollos on 2013-12-15 10:00:18
2.0dev: Restore Python 2.4 compatibility after [13395]. Fixes #11364, Refs #10998.

Untested patch. Please report any issues to #11364.

[13397] by rjollos on 2013-09-19 11:00:08
Fixed some defects in [13395]: added support for image maps. Refs #10998.

It seems that PlantUML only supports using stdin and stdout together, and there doesn't seem to be a way to generate the image map content when outputting to stdout. The documentation on image maps from PlantUML is almost non-existent, so it is hard to be sure. Therefore, we output the markup to a file, and pass the filepath of the markup file to PlantUML, outputting the png and cmapx to files in the same directory.

Thanks to Erwin Rademakers for coming up with this solution, and testing r13395.

[13395] by rjollos on 2013-09-19 04:19:10
Added support for image maps. Refs #10998.

Thanks to Erwin Rademakers for the initial version of the patch applied here.

Author/Contributors

Author: airadier
Maintainers: airadier, rjollos
Contributors: ebencheung
License: BSD 3-Clause

Attachments (1)

Download all attachments as: .zip