Changes between Version 7 and Version 8 of PlantUmlMacro


Ignore:
Timestamp:
Apr 13, 2012 5:56:26 AM (2 years ago)
Author:
AdrianFritz
Comment:

Detail instructions. Page redesign. (Ref. ticket:9958 comment:2)

Legend:

Unmodified
Added
Removed
Modified
  • PlantUmlMacro

    v7 v8  
    1616== Description == 
    1717 
    18 [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. 
     18[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. 
    1919 
    2020This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams. 
    2121 
    22 == Dependencies == 
     22== Usage == 
    2323 
    24 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) 
     24 1. Inside a wiki page: 
     25    {{{ 
     26    {{{ 
     27    #!PlantUML 
     28    @startuml 
     29    Alice -> Bob: Authentication Request 
     30    Bob --> Alice: Authentication Response 
     31    Alice -> Bob: Another authentication Request 
     32    Alice <-- Bob: another authentication Response 
     33    @enduml 
     34    }}} 
     35    }}} 
     36    * should render: [[BR]] 
     37      [[Image(sequence.PNG)]] 
     38 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] 
    2539 
    26 == Configuration == 
     40== Installation == 
    2741 
    28 The following entry must be added to trac.ini: 
    29  
    30 {{{ 
    31 [components] 
    32 ... 
    33 plantuml.* = enabled 
    34  
    35  
    36 [plantuml] 
    37 plantuml_jar = /path/to/plantuml.jar 
    38 java_bin = /path/to/java_bin (optional, if Java binary is not on the search path) 
    39 }}} 
     42 1. '''Clear''' dependencies 
     43    i. a valid Java runtime 
     44    i. [http://plantuml.sourceforge.net/download.html plantuml.jar]: save it in your `/path/to/plantuml.jar` (see configure section). 
     45       * Check version if the case: 
     46         {{{ 
     47         #!sh 
     48         $ cd /path/to/plantuml.jar 
     49         $ java -jar plantuml.jar -version 
     50         }}} 
     51       * Up-date if the case 
     52         {{{ 
     53         #!sh 
     54         $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download 
     55         }}} 
     56       * ,,`[sudo]` is optional,, 
     57    i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot]. 
     58       {{{ 
     59       #!sh 
     60       $ java -jar plantuml.jar -testdot 
     61       }}} 
     62 1. '''Install''' plugin globally:  
     63    * with easy_install: 
     64      {{{ 
     65      #!sh 
     66      $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk 
     67      }}} 
     68    * ,,`[sudo]` is optional,, 
     69 1. '''Enable''' the plugin by updating TracIni file as follows: 
     70    {{{ 
     71    [components] 
     72    plantuml.* = enabled 
     73    }}} 
     74 1. '''Configure''' the plugin in its own configuration section, by updating TracIni file as follows: 
     75    {{{ 
     76    [plantuml] 
     77    plantuml_jar = /path/to/plantuml.jar 
     78    java_bin = /path/to/java_bin (optional, if Java binary is not on the search path) 
     79    }}} 
     80    * example `plantuml_jar = /project-resources/trac/plugins` 
     81    * example `java_bin = java` assumes that the Java binary is on the search path. 
     82 1. '''Restart''' web server on command line: 
     83    {{{ 
     84    #!sh 
     85    $ [sudo] /etc/init.d/apache2 restart 
     86    }}} 
     87 1. '''Test''' if plugin is working properly. 
    4088 
    4189== Bugs/Feature Requests ==  
    4290 
    43 Existing bugs and feature requests for PlantUmlMacro are  
    44 [report:9?COMPONENT=PlantUmlMacro here]. 
     91Existing bugs and feature requests for !PlantUmlMacro are '''[report:9?COMPONENT=PlantUmlMacro here]'''. 
    4592 
    46 If you have any issues, create a  
    47 [http://trac-hacks.org/newticket?component=PlantUmlMacro&cc=rjollos&owner=airadier new ticket]. 
     93If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=rjollos&owner=airadier new ticket]'''. 
    4894 
    49 == Download == 
     95== Source & Download == 
    5096 
    51 Download the zipped source from [download:plantumlmacro here]. 
     97You can check out !PlantUmlMacro from '''[http://trac-hacks.org/svn/plantumlmacro here]''' using Subversion, or '''[source:plantumlmacro browse the source]''' with Trac. 
    5298 
    53 == Source == 
     99Download the zipped source from '''[download:plantumlmacro here]'''. 
    54100 
    55 You can check out PlantUmlMacro from [http://trac-hacks.org/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac. 
    56  
    57 == Example == 
    58  
    59 Use with: 
    60  
    61 {{{ 
    62 {{{ 
    63 #!PlantUML 
    64 @startuml 
    65 Alice -> Bob: Authentication Request 
    66 Bob --> Alice: Authentication Response 
    67 Alice -> Bob: Another authentication Request 
    68 Alice <-- Bob: another authentication Response 
    69 @enduml 
    70 }}} 
    71 }}} 
    72  
    73 results in something like: 
    74  
    75 [[Image(sequence.PNG)]] 
    76  
    77 More information on the PlantUML language can be found in [http://plantuml.sourceforge.net/sources.html PlantUML Website] 
    78  
    79 == Recent Changes == 
     101=== Recent Changes === 
    80102 
    81103[[ChangeLog(plantumlmacro, 3)]]