[[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, objects, ...) from a simple text description file. This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams. == Usage == 1. Inside a wiki page: {{{ {{{ #!PlantUML @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml }}} }}} * should render: [[BR]] [[Image(sequence.PNG)]] 1. More information on the PlantUML language and different types of UML diagrams can be found in [http://plantuml.sourceforge.net/sources.html PlantUML Website] == Installation == 1. '''Check''' dependencies: i. a valid Java runtime i. [http://plantuml.sourceforge.net/download.html plantuml.jar]: save it to the location that you'll specify in the configuration section `/path/to/plantuml.jar`. * {{{ #!sh $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download }}} ,,`[sudo]` is optional,, * Check version of PlantUML jar: {{{ #!sh $ cd /path/to/plantuml.jar $ java -jar plantuml.jar -version }}} i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot]. {{{ #!sh $ java -jar plantuml.jar -testdot }}} 1. '''Install''' plugin globally: * with easy_install: {{{ #!sh $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk }}} ,,`[sudo]` is optional,, 1. '''Enable''' the plugin by updating TracIni file as follows: {{{ [components] plantuml.* = enabled }}} 1. '''Configure''' the plugin in its own configuration section, by updating TracIni file as follows: {{{ [plantuml] plantuml_jar = /path/to/plantuml.jar java_bin = /path/to/java_bin (optional, if Java binary is not on the search path) }}} * example `plantuml_jar = /project-resources/trac/plugins` * example `java_bin = java` assumes that the Java binary is on the search path. 1. '''Restart''' web server on command line: {{{ #!sh $ [sudo] /etc/init.d/apache2 restart }}} 1. '''Test''' if plugin is working properly. If the plugin is installed correct, the example shown in the Usage section on this page should be displayed on the !WikiMacros#PlantUML-macro page. == Bugs/Feature Requests == Existing bugs and feature requests for !PlantUmlMacro are '''[report:9?COMPONENT=PlantUmlMacro here]'''. If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=rjollos&owner=airadier new ticket]'''. == Source & Download == You can check out !PlantUmlMacro from '''[http://trac-hacks.org/svn/plantumlmacro here]''' using Subversion, or '''[source:plantumlmacro browse the source]''' with Trac. Download the zipped source from '''[download:plantumlmacro here]'''. === Recent Changes === [[ChangeLog(plantumlmacro, 3)]] == Author/Contributors == '''Author:''' [wiki:airadier] [[BR]] '''Maintainers:''' [wiki:airadier], rjollos [[BR]] '''Contributors:''' ebencheung[[BR]] '''License:''' BSD 3-Clause