wiki:TracPlantUmlPlugin

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

Fixed typo.

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

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 14341

Author/Contributors

Author: airadier
Maintainer: airadier
Contributors:

Attachments (1)

Download all attachments as: .zip