Changes between Version 11 and Version 12 of PlantUmlMacro

Timestamp:

Apr 21, 2012, 3:34:00 PM (12 years ago)

Author:

Adrian Fritz

Comment:

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

PlantUmlMacro

@@ -40 +40 @@
 == Installation ==
 
- 1. '''Check''' dependencies:
-    i. a valid Java runtime
-    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`.
-       * 
-         {{{
-         #!sh
-         $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
-         }}}
-           * ,,`[sudo]` is optional,,
-       * Check version of PlantUML jar:
-         {{{
-         #!sh
-         $ cd /path/to/plantuml.jar
-         $ java -jar plantuml.jar -version
-         }}}
-    i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
+  1. '''Be noticed''':
+     1. Below instructions should be specific for some O.S. Please, help expanding this instructions.
+     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins]
+     1. Unused sections are suggested to be kept under comment. In future you might need it. For example:
+        {{{
+        {{{
+        #!comment
+        1. '''Check''' dependencies:
+           i. none required
+        }}}        
+        }}}
+     1. `[sudo]`, when used, is optional case you already have enough authority to modify your server.
+     [[BR]][[BR]]
+  2. '''Check''' dependencies:
+     i. a valid Java runtime
+     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`.
+        * 
+          {{{
+          #!sh
+          $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
+          }}}
+        * Check version of PlantUML jar:
+          {{{
+          #!sh
+          $ cd /path/to/plantuml.jar
+          $ [sudo] java -jar plantuml.jar -version
+          }}}
+     i. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot].
+        {{{
+        #!sh
+        $ [sudo] java -jar plantuml.jar -testdot
+        }}}
+        [[BR]][[BR]]
+  1. '''Install''' component: 
+     * with easy_install, globally:
        {{{
        #!sh
-       $ java -jar plantuml.jar -testdot
+       $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
        }}}
- 1. '''Install''' plugin globally: 
-    * with easy_install:
-      {{{
-      #!sh
-      $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
-      }}}
-        * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,
- 1. '''Enable''' the plugin by updating TracIni file as follows:
-    {{{
-    [components]
-    plantuml.* = enabled
-    }}}
- 1. '''Configure''' the plugin in its own configuration section, by updating TracIni file as follows:
-    {{{
-    [plantuml]
-    plantuml_jar = /path/to/plantuml.jar
-    java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
-    }}}
-    * example `plantuml_jar = /project-resources/trac/plugins`
-    * example `java_bin = java` assumes that the Java binary is on the search path.
- 1. '''Restart''' web server on command line:
-    {{{
-    #!sh
-    $ [sudo] /etc/init.d/apache2 restart
-    }}}
-      * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,
- 1. '''Test''' if plugin is working properly. 
-    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.
+       [[BR]][[BR]]
+  1. '''Enable''' this component as follows:
+     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
+       {{{
+       [components]
+       plantuml.* = enabled
+       }}}
+     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
+     [[BR]][[BR]]
+  1. '''Configure''' Trac environment as follows:
+     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section;
+       {{{
+       [plantuml]
+       plantuml_jar = /path/to/plantuml.jar
+       java_bin = /path/to/java_bin (optional, if Java binary is not on the search path)
+       }}}
+       * example `plantuml_jar = /project-resources/trac/plugins`
+       * example `java_bin = java` assumes that the Java binary is on the search path.[[BR]][[BR]]
+     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
+     [[BR]][[BR]]
+  1. '''Restart''' web server:
+     * Apache on Ubuntu, example command line:
+       {{{
+       #!sh
+       $ [sudo] /etc/init.d/apache2 restart
+       }}}
+       [[BR]][[BR]]
+  1. '''Test''' if this component is working properly (main environment and secondary ones if you have).
+     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.   
+     [[BR]][[BR]]
 
 == Bugs/Feature Requests ==