Changes between Version 13 and Version 14 of TracPlantUmlPlugin


Ignore:
Timestamp:
Mar 15, 2012, 7:56:37 PM (3 years ago)
Author:
rjollos
Comment:

Content moved to PlantUmlMacro page.

Legend:

Unmodified
Added
Removed
Modified
  • TracPlantUmlPlugin

    v13 v14  
    1 [[PageOutline(2-5,Contents,pullout)]]
    2 
    3 = Trac PlantUML Plugin =
    4 
    5 == Description ==
    6 
    7 [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.
    8 
    9 This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically 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 java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
    28 }}}
    29 
    30 == Bugs/Feature Requests ==
    31 
    32 Existing bugs and feature requests for TracPlantUmlPlugin are
    33 [report:9?COMPONENT=TracPlantUmlPlugin here].
    34 
    35 If you have any issues, create a
    36 [http://trac-hacks.org/newticket?component=TracPlantUmlPlugin&cc=rjollos&owner=airadier new ticket].
    37 
    38 == Download ==
    39 
    40 Download the zipped source from [download:tracplantumlplugin here].
    41 
    42 == Source ==
    43 
    44 You can check out TracPlantUmlPlugin from [http://trac-hacks.org/svn/tracplantumlplugin here] using Subversion, or [source:tracplantumlplugin browse the source] with Trac.
    45 
    46 == Example ==
    47 
    48 Use with:
    49 
    50 {{{
    51 {{{
    52 #!PlantUML
    53 @startuml
    54 Alice -> Bob: Authentication Request
    55 Bob --> Alice: Authentication Response
    56 Alice -> Bob: Another authentication Request
    57 Alice <-- Bob: another authentication Response
    58 @enduml
    59 }}}
    60 }}}
    61 
    62 results in something like:
    63 
    64 [[Image(sequence.PNG)]]
    65 
    66 More information on the PlantUML language can be found in [http://plantuml.sourceforge.net/sources.html PlantUML Website]
    67 
    68 == Recent Changes ==
    69 
    70 [[ChangeLog(tracplantumlplugin, 3)]]
    71 
    72 == Author/Contributors ==
    73 
    74 '''Author:''' [wiki:airadier] [[BR]]
    75 '''Maintainers:''' [wiki:airadier], rjollos [[BR]]
    76 '''Contributors:'''
     1[[redirect(wiki:PlantUmlMacro)]]