[[PageOutline(2-5,Contents,pullout)]] [[html(
)]] 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. [[html(
)]] = Render PlantUML Diagrams = == Description == [http://plantuml.sourceforge.net/ 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 [http://plantuml.sourceforge.net/download.html PlantUML compiled jar] being installed on the system, a valid Java runtime, and [http://www.graphviz.org/ Graphviz] installed and [http://plantuml.sourceforge.net/graphvizdot.html 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 [report:9?COMPONENT=PlantUmlMacro here]. If you have any issues, create a [http://trac-hacks.org/newticket?component=PlantUmlMacro&cc=rjollos&owner=airadier new ticket]. == Download == Download the zipped source from [download:plantumlmacro here]. == Source == You can check out PlantUmlMacro from [http://trac-hacks.org/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro 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: [[Image(sequence.PNG)]] More information on the PlantUML language can be found in [http://plantuml.sourceforge.net/sources.html PlantUML Website] == Recent Changes == [[ChangeLog(plantumlmacro, 3)]] == Author/Contributors == '''Author:''' [wiki:airadier] [[BR]] '''Maintainers:''' [wiki:airadier], rjollos [[BR]] '''Contributors:''' ebencheung[[BR]] '''License:''' BSD 3-Clause