Changes between Initial Version and Version 1 of PlantUmlMacro

Timestamp:

Mar 15, 2012, 6:56:00 PM (12 years ago)

Author:

Ryan J Ollos

Comment:

Contnent moved from TracPlantUmlPlugin. For previous page history, see wiki/TracPlantUmlPlugin.

PlantUmlMacro

@@ +1 @@
+[[PageOutline(2-5,Contents,pullout)]]
+
+= Trac PlantUML Plugin =
+
+== 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:'''