Changes between Version 24 and Version 25 of PlantUmlMacro


Ignore:
Timestamp:
Jun 14, 2015, 9:39:09 AM (9 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified

  • PlantUmlMacro

    v24 v25  
    1010 * Work towards v2.0, improving documentation and fixing minor defects.
    1111 * Render plantuml files from repository #7053.
    12 
    13 '''News'''
    14  * 19-September-2013: Since r13397 [http://plantuml.sourceforge.net/qa/?qa=90/web-links-in-generated-images-e-g-using-image-maps image maps] are supported.
    15  * 19-March-2012: License changed from GPL to BSD 3-Clause, which is the license used by Trac.
    1612}}}
    1713
    … …  
    3127
    3228[[TicketQuery(component=PlantUmlMacro&group=type,format=progress)]]
     29
     30== Download
     31
     32Download the zipped source from [download:plantumlmacro here].
     33
     34== Source
     35
     36You can check out PlantUmlMacro from [http://trac-hacks.org/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac.
     37
     38== Installation
     39
     40  1. '''Note''':
     41     1. Below instructions should be specific to some operating systems. Please help expanding these instructions.
     42     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins].
     43     1. Unused sections are for future use and are suggested to be commented out. For example:
     44        {{{
     45        {{{
     46        #!comment
     47        1. '''Check''' dependencies:
     48           i. none required
     49        }}}       
     50        }}}
     51     1. `[sudo]` is optional in case you already have enough authorisation to modify your server.
     52     [[BR]]
     53  2. '''Check''' dependencies:
     54     1. A valid Java runtime environment.
     55     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`.
     56        *
     57          {{{
     58          #!sh
     59          [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
     60          }}}
     61        * Check version of PlantUML jar:
     62          {{{
     63          #!sh
     64          cd /path/to/plantuml.jar
     65          [sudo] java -jar plantuml.jar -version
     66          }}}
     67     1. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
     68        {{{
     69        #!sh
     70        [sudo] java -jar plantuml.jar -testdot
     71        }}}
     72        [[BR]]
     73  1. '''Install''' component:
     74     * with easy_install, globally:
     75       {{{
     76       #!sh
     77       [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
     78       }}}
     79       [[BR]]
     80  1. '''Enable''' this component as follows:
     81     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
     82       {{{
     83       #!ini
     84       [components]
     85       plantuml.* = enabled
     86       }}}
     87     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
     88     [[BR]]
     89  1. '''Configure''' the Trac environment as follows:
     90     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
     91       {{{
     92       #!ini
     93       [plantuml]
     94       plantuml_jar = /path/to/plantuml.jar
     95       java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
     96       }}}
     97       * example `plantuml_jar = /project-resources/trac/plugins`
     98       * example `java_bin = java` assumes that the Java binary is on the search path.[[BR]][[BR]]
     99     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
     100     [[BR]]
     101  1. '''Restart''' web server:
     102     * Apache on Ubuntu, example command line:
     103       {{{
     104       #!sh
     105       [sudo] /etc/init.d/apache2 restart
     106       }}}
     107       [[BR]]
     108  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.   
    33109
    34110== Usage
    … …  
    53129 3. 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].
    54130
    55 == Installation
    56 
    57   1. '''Note''':
    58      1. Below instructions should be specific to some operating systems. Please help expanding these instructions.
    59      1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins].
    60      1. Unused sections are for future use and are suggested to be commented out. For example:
    61         {{{
    62         {{{
    63         #!comment
    64         1. '''Check''' dependencies:
    65            i. none required
    66         }}}       
    67         }}}
    68      1. `[sudo]` is optional in case you already have enough authorisation to modify your server.
    69      [[BR]][[BR]]
    70   2. '''Check''' dependencies:
    71      1. A valid Java runtime environment.
    72      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`.
    73         *
    74           {{{
    75           #!sh
    76           [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
    77           }}}
    78         * Check version of PlantUML jar:
    79           {{{
    80           #!sh
    81           cd /path/to/plantuml.jar
    82           [sudo] java -jar plantuml.jar -version
    83           }}}
    84      1. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
    85         {{{
    86         #!sh
    87         [sudo] java -jar plantuml.jar -testdot
    88         }}}
    89         [[BR]][[BR]]
    90   1. '''Install''' component:
    91      * with easy_install, globally:
    92        {{{
    93        #!sh
    94        [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
    95        }}}
    96        [[BR]][[BR]]
    97   1. '''Enable''' this component as follows:
    98      * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
    99        {{{
    100        #!ini
    101        [components]
    102        plantuml.* = enabled
    103        }}}
    104      * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
    105      [[BR]][[BR]]
    106   1. '''Configure''' the Trac environment as follows:
    107      * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
    108        {{{
    109        #!ini
    110        [plantuml]
    111        plantuml_jar = /path/to/plantuml.jar
    112        java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
    113        }}}
    114        * example `plantuml_jar = /project-resources/trac/plugins`
    115        * example `java_bin = java` assumes that the Java binary is on the search path.[[BR]][[BR]]
    116      * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
    117      [[BR]][[BR]]
    118   1. '''Restart''' web server:
    119      * Apache on Ubuntu, example command line:
    120        {{{
    121        #!sh
    122        [sudo] /etc/init.d/apache2 restart
    123        }}}
    124        [[BR]][[BR]]
    125   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.   
    126 
    127 == Source and Download
    128 
    129 You 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.
    130 
    131131== Recent Changes
    132132