Changes between Version 32 and Version 33 of PlantUmlMacro


Ignore:
Timestamp:
Jan 28, 2018, 12:14:29 PM (6 years ago)
Author:
figaro
Comment:

Moved example to description

Legend:

Unmodified
Added
Removed
Modified

  • PlantUmlMacro

    v32 v33  
    88
    99[http://plantuml.sourceforge.net/ PlantUML] is a Java utility that allows generation of different types of [wikipedia:Unified_Modeling_Language UML] diagrams (such as sequence, activity, state, use cases, objects) from a simple text description file.
     10
     11This macro can be used as follows:
     12
     13 1. As a !WikiProcessor with markup:
     14 {{{
     15{{{#!PlantUml
     16@startuml
     17Alice -> Bob: Authentication Request
     18Bob --> Alice: Authentication Response
     19Alice -> Bob: Another authentication Request
     20Alice <-- Bob: another authentication Response
     21@enduml
     22}}}
     23}}}
     24 will render the following UML diagram:
     25
     26 [[Image(sequence.PNG)]]
     27
     28 2. As a !WikiProcess rendering files from the repository:
     29 {{{
     30{{{#!plantuml path="/path/to/repository"
     31...
     32}}}
     33
     34{{{#!plantuml path="/repos/path/to/repository@rev"
     35...
     36}}}
     37}}}
     38
     39 3. As a macro rendering files from the repository:
     40 {{{
     41[[PlantUml(/path/to/repository)]]
     42[[PlantUml(/path/to/repository@rev)]]
     43}}}
     44
     45Additional documentation can be found on the WikiMacros page after installing the macro. More information on the PlantUML language and different types of UML diagrams can be found on the [http://plantuml.sourceforge.net/sources.html PlantUML Website].
    1046
    1147== Bugs/Feature Requests
    … …  
    84120  1. '''Test''' if this component is working properly (main environment and secondary ones if you have). If this component is installed correctly, then the example shown in the [#Usage] section should be also displayed on the WikiMacros#PlantUML-macro page.   
    85121
    86 == Usage
    87 
    88  1. As a !WikiProcessor with markup:
    89  {{{
    90 {{{#!PlantUml
    91 @startuml
    92 Alice -> Bob: Authentication Request
    93 Bob --> Alice: Authentication Response
    94 Alice -> Bob: Another authentication Request
    95 Alice <-- Bob: another authentication Response
    96 @enduml
    97 }}}
    98 }}}
    99  will render the following UML diagram:
    100 
    101  [[Image(sequence.PNG)]]
    102 
    103  2. As a !WikiProcess rendering files from the repository:
    104  {{{
    105 {{{#!plantuml path="/path/to/repository"
    106 ...
    107 }}}
    108 
    109 {{{#!plantuml path="/repos/path/to/repository@rev"
    110 ...
    111 }}}
    112 }}}
    113 
    114  3. As a macro rendering files from the repository:
    115  {{{
    116 [[PlantUml(/path/to/repository)]]
    117 [[PlantUml(/path/to/repository@rev)]]
    118 }}}
    119 
    120 Additional documentation can be found on the WikiMacros page after installing the macro. More information on the PlantUML language and different types of UML diagrams can be found on the [http://plantuml.sourceforge.net/sources.html PlantUML Website].
    121 
    122122== Recent Changes
    123123