Changes between Version 11 and Version 12 of PlantUmlMacro


Ignore:
Timestamp:
Apr 21, 2012 5:34:00 PM (2 years ago)
Author:
AdrianFritz
Comment:

Improve install details with learned issues. Refs. ticket/9958

Legend:

Unmodified
Added
Removed
Modified
  • PlantUmlMacro

    v11 v12  
    4040== Installation == 
    4141 
    42  1. '''Check''' dependencies: 
    43     i. a valid Java runtime 
    44     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`. 
    45        *  
    46          {{{ 
    47          #!sh 
    48          $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download 
    49          }}} 
    50            * ,,`[sudo]` is optional,, 
    51        * Check version of PlantUML jar: 
    52          {{{ 
    53          #!sh 
    54          $ cd /path/to/plantuml.jar 
    55          $ java -jar plantuml.jar -version 
    56          }}} 
    57     i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot]. 
     42  1. '''Be noticed''': 
     43     1. Below instructions should be specific for some O.S. Please, help expanding this instructions. 
     44     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] 
     45     1. Unused sections are suggested to be kept under comment. In future you might need it. For example: 
     46        {{{ 
     47        {{{ 
     48        #!comment 
     49        1. '''Check''' dependencies: 
     50           i. none required 
     51        }}}         
     52        }}} 
     53     1. `[sudo]`, when used, is optional case you already have enough authority to modify your server. 
     54     [[BR]][[BR]] 
     55  2. '''Check''' dependencies: 
     56     i. a valid Java runtime 
     57     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`. 
     58        *  
     59          {{{ 
     60          #!sh 
     61          $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download 
     62          }}} 
     63        * Check version of PlantUML jar: 
     64          {{{ 
     65          #!sh 
     66          $ cd /path/to/plantuml.jar 
     67          $ [sudo] java -jar plantuml.jar -version 
     68          }}} 
     69     i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot]. 
     70        {{{ 
     71        #!sh 
     72        $ [sudo] java -jar plantuml.jar -testdot 
     73        }}} 
     74        [[BR]][[BR]] 
     75  1. '''Install''' component:  
     76     * with easy_install, globally: 
    5877       {{{ 
    5978       #!sh 
    60        $ java -jar plantuml.jar -testdot 
     79       $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk 
    6180       }}} 
    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 case you already have enough authority to modify your server.,, 
    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       * ,,`[sudo]` is optional case you already have enough authority to modify your server.,, 
    88  1. '''Test''' if plugin is working properly.  
    89     1. If the plugin is installed correct, the example shown in the Usage section on this page should be displayed on the WikiMacros#PlantUML-macro page. 
     81       [[BR]][[BR]] 
     82  1. '''Enable''' this component as follows: 
     83     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
     84       {{{ 
     85       [components] 
     86       plantuml.* = enabled 
     87       }}} 
     88     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). 
     89     [[BR]][[BR]] 
     90  1. '''Configure''' Trac environment as follows: 
     91     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
     92       {{{ 
     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]][[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]][[BR]] 
     108  1. '''Test''' if this component is working properly (main environment and secondary ones if you have). 
     109     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.    
     110     [[BR]][[BR]] 
    90111 
    91112== Bugs/Feature Requests ==