| 1 | [[PageOutline(2-5,Contents,pullout)]] |
| 2 | |
| 3 | = Trac PlantUML Plugin = |
| 4 | |
| 5 | == Description == |
| 6 | |
| 7 | 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. |
| 8 | |
| 9 | This plugin allows the integration of PlantUML on Trac Wiki pages, dinamically generating and embedding the diagrams. |
| 10 | |
| 11 | == Dependencies == |
| 12 | |
| 13 | 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) |
| 14 | |
| 15 | == Configuration == |
| 16 | |
| 17 | The following entry must be added to trac.ini: |
| 18 | |
| 19 | {{{ |
| 20 | [components] |
| 21 | ... |
| 22 | plantuml.* = enabled |
| 23 | |
| 24 | |
| 25 | [plantuml] |
| 26 | plantuml_jar = /path/to/plantuml.jar |
| 27 | }}} |
| 28 | |
| 29 | == Bugs/Feature Requests == |
| 30 | |
| 31 | Existing bugs and feature requests for TracPlantUmlPlugin are |
| 32 | [report:9?COMPONENT=TracPlantUmlPlugin here]. |
| 33 | |
| 34 | If you have any issues, create a |
| 35 | [http://trac-hacks.org/newticket?component=TracPlantUmlPlugin&owner=airadier new ticket]. |
| 36 | |
| 37 | == Download == |
| 38 | |
| 39 | Download the zipped source from [download:tracplantumlplugin here]. |
| 40 | |
| 41 | == Source == |
| 42 | |
| 43 | You can check out TracPlantUmlPlugin from [http://trac-hacks.org/svn/tracplantumlplugin here] using Subversion, or [source:tracplantumlplugin browse the source] with Trac. |
| 44 | |
| 45 | == Example == |
| 46 | |
| 47 | Use with: |
| 48 | |
| 49 | {{{ |
| 50 | {{{ |
| 51 | #!PlantUML |
| 52 | @startuml |
| 53 | Alice -> Bob: Authentication Request |
| 54 | Bob --> Alice: Authentication Response |
| 55 | |
| 56 | Alice -> Bob: Another authentication Request |
| 57 | Alice <-- Bob: another authentication Response |
| 58 | @enduml |
| 59 | }}} |
| 60 | }}} |
| 61 | |
| 62 | More information on the PlantUML language can be found in [http://plantuml.sourceforge.net/sources.html PlantUML Website] |
| 63 | |
| 64 | == Recent Changes == |
| 65 | |
| 66 | [[ChangeLog(tracplantumlplugin, 3)]] |
| 67 | |
| 68 | == Author/Contributors == |
| 69 | |
| 70 | '''Author:''' [wiki:airadier] [[BR]] |
| 71 | '''Maintainer:''' [wiki:airadier] [[BR]] |
| 72 | '''Contributors:''' |