[[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. As a !WikiProcessor with markup: {{{ {{{ #!plantuml @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml }}} }}} [[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. '''Be noticed''': 1. Below instructions should be specific for some O.S. Please, help expanding this instructions. 1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] 1. Unused sections are suggested to be kept under comment. In future you might need it. For example: {{{ {{{ #!comment 1. '''Check''' dependencies: i. none required }}} }}} 1. `[sudo]`, when used, is optional case you already have enough authority to modify your server. [[BR]][[BR]] 2. '''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 }}} * Check version of PlantUML jar: {{{ #!sh $ cd /path/to/plantuml.jar $ [sudo] 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 $ [sudo] java -jar plantuml.jar -testdot }}} [[BR]][[BR]] 1. '''Install''' component: * with easy_install, globally: {{{ #!sh $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk }}} [[BR]][[BR]] 1. '''Enable''' this component as follows: * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; {{{ #!ini [components] plantuml.* = enabled }}} * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). [[BR]][[BR]] 1. '''Configure''' Trac environment as follows: * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; {{{ #!ini [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.[[BR]][[BR]] * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). [[BR]][[BR]] 1. '''Restart''' web server: * Apache on Ubuntu, example command line: {{{ #!sh $ [sudo] /etc/init.d/apache2 restart }}} [[BR]][[BR]] 1. '''Test''' if this component is working properly (main environment and secondary ones if you have). 1. If this component is installed correctly, then the example shown in the [#Usage] section should be also displayed on the WikiMacros#PlantUML-macro page. [[BR]][[BR]] == Bugs/Feature Requests == Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]''' for !PlantUmlMacro. If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=rjollos&owner=airadier new ticket]'''. == Source & Download == You can '''[http://trac-hacks.org/svn/plantumlmacro check out]''' !PlantUmlMacro using Subversion, or '''[source:plantumlmacro browse the source]''' with Trac, or '''[download:plantumlmacro download]''' the zipped source. == Recent Changes == [[ChangeLog(plantumlmacro, 3)]] == Author/Contributors == '''Author:''' [wiki:airadier] [[BR]] '''Maintainers:''' [wiki:airadier], rjollos [[BR]] '''Contributors:''' ebencheung[[BR]] '''License:''' BSD 3-Clause