Changes between Version 21 and Version 22 of PlantUmlMacro


Ignore:
Timestamp:
Mar 11, 2015, 9:05:04 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • PlantUmlMacro

    v21 v22  
    1616}}}
    1717
    18 = Render PlantUML Diagrams =
     18= Render PlantUML Diagrams
    1919
    20 == Description ==
     20== Description
    2121
    2222[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.
    … …  
    2424This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams.
    2525
    26 == Usage ==
     26== Bugs/Feature Requests
     27
     28Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]''' for !PlantUmlMacro.
     29
     30If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=airadier&owner=rjollos new ticket]'''.
     31
     32[[TicketQuery(component=PlantUmlMacro&group=type,format=progress)]]
     33
     34== Usage
    2735
    2836 1. As a !WikiProcessor with markup:
    … …  
    3846}}}
    3947 }}}
     48 will render the following UML diagram:
     49
    4050 [[Image(sequence.PNG)]]
    41  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]
    4251
    43 == Installation ==
     52 2. 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].
    4453
    45   1. '''Be noticed''':
    46      1. Below instructions should be specific for some O.S. Please, help expanding this instructions.
    47      1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins]
    48      1. Unused sections are suggested to be kept under comment. In future you might need it. For example:
     54== Installation
     55
     56  1. '''Note''':
     57     1. Below instructions should be specific to some operating systems. Please help expanding these instructions.
     58     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins].
     59     1. Unused sections are for future use and are suggested to be commented out. For example:
    4960        {{{
    5061        {{{
    … …  
    5465        }}}       
    5566        }}}
    56      1. `[sudo]`, when used, is optional case you already have enough authority to modify your server.
     67     1. `[sudo]` is optional in case you already have enough authorisation to modify your server.
    5768     [[BR]][[BR]]
    5869  2. '''Check''' dependencies:
    59      i. a valid Java runtime
    60      i. [http://plantuml.sourceforge.net/download.html plantuml.jar]: save it to the location that you'll specify in the configuration section `/path/to/plantuml.jar`.
     70     1. A valid Java runtime environment.
     71     1. [http://plantuml.sourceforge.net/download.html plantuml.jar]: save it to the location that you'll specify in the configuration section `/path/to/plantuml.jar`.
    6172        *
    6273          {{{
    6374          #!sh
    64           $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
     75          [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
    6576          }}}
    6677        * Check version of PlantUML jar:
    6778          {{{
    6879          #!sh
    69           $ cd /path/to/plantuml.jar
    70           $ [sudo] java -jar plantuml.jar -version
     80          cd /path/to/plantuml.jar
     81          [sudo] java -jar plantuml.jar -version
    7182          }}}
    72      i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
     83     1. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
    7384        {{{
    7485        #!sh
    75         $ [sudo] java -jar plantuml.jar -testdot
     86        [sudo] java -jar plantuml.jar -testdot
    7687        }}}
    7788        [[BR]][[BR]]
    … …  
    8091       {{{
    8192       #!sh
    82        $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
     93       [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
    8394       }}}
    8495       [[BR]][[BR]]
    … …  
    92103     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
    93104     [[BR]][[BR]]
    94   1. '''Configure''' Trac environment as follows:
     105  1. '''Configure''' the Trac environment as follows:
    95106     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
    96107       {{{
    … …  
    108119       {{{
    109120       #!sh
    110        $ [sudo] /etc/init.d/apache2 restart
     121       [sudo] /etc/init.d/apache2 restart
    111122       }}}
    112123       [[BR]][[BR]]
    113   1. '''Test''' if this component is working properly (main environment and secondary ones if you have).
    114      1. If this component is installed correctly, then the example shown in the [#Usage] section should be also displayed on the WikiMacros#PlantUML-macro page.   
     124  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.   
    115125
    116 == Bugs/Feature Requests ==
    117 
    118 Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]''' for !PlantUmlMacro.
    119 
    120 If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=airadier&owner=rjollos new ticket]'''.
    121 
    122 == Source & Download ==
     126== Source and Download
    123127
    124128You can '''[http://trac-hacks.org/svn/plantumlmacro check out]''' !PlantUmlMacro using Subversion, or '''[source:plantumlmacro browse the source]''' with Trac, or '''[download:plantumlmacro download]''' the zipped source.
    125129
    126 == Recent Changes ==
     130== Recent Changes
    127131
    128132[[ChangeLog(plantumlmacro, 3)]]
    129133
    130 == Author/Contributors ==
     134== Author/Contributors
    131135
    132136'''Author:''' [wiki:airadier] [[BR]]
    133 '''Maintainers:''' [wiki:airadier], rjollos [[BR]]
     137'''Maintainers:''' [[Maintainer]], rjollos [[BR]]
    134138'''Contributors:''' ebencheung, Erwin Rademaker[[BR]]
    135139'''License:''' BSD 3-Clause