Changes between Version 26 and Version 27 of PlantUmlMacro
- Timestamp:
- Nov 20, 2015, 1:37:53 PM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PlantUmlMacro
v26 v27 11 11 == Description 12 12 13 [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.13 [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. 14 14 15 15 This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams. … … 17 17 == Bugs/Feature Requests 18 18 19 Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]'''for !PlantUmlMacro.19 Existing [report:9?COMPONENT=PlantUmlMacro bugs and feature requests] for !PlantUmlMacro. 20 20 21 If you have any issues, create a '''[/newticket?component=PlantUmlMacro&cc=airadier new ticket]'''.21 If you have any issues, create a [/newticket?component=PlantUmlMacro&cc=airadier new ticket]. 22 22 23 23 [[TicketQuery(component=PlantUmlMacro&group=type,format=progress)]] … … 25 25 == Download 26 26 27 Download the zipped source from [ download:plantumlmacro here].27 Download the zipped source from [export:plantumlmacro here]. 28 28 29 29 == Source 30 30 31 You can check out PlantUmlMacro from [ http://trac-hacks.org/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac.31 You can check out PlantUmlMacro from [/svn/plantumlmacro here] using Subversion, or [source:plantumlmacro browse the source] with Trac. 32 32 33 33 == Installation 34 34 35 1. '''Note''': 35 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page. 36 37 '''Notes''': 36 38 1. Below instructions should be specific to some operating systems. Please help expanding these instructions. 37 1. Broader installation guidelines are made available at TracPlugins.38 39 1. `[sudo]` is optional in case you already have enough authorisation to modify your server. 39 [[BR]] 40 2. '''Check''' dependencies: 40 41 '''Installation steps:''' 42 1. '''Check''' dependencies: 41 43 1. A valid Java runtime environment. 42 44 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`. 43 * 44 {{{ 45 #!sh 45 * {{{#!sh 46 46 [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download 47 47 }}} 48 48 * Check version of PlantUML jar: 49 {{{ 50 #!sh 49 {{{#!sh 51 50 cd /path/to/plantuml.jar 52 51 [sudo] java -jar plantuml.jar -version 53 52 }}} 54 53 1. [http://www.graphviz.org/ Graphviz]: check if installed and working as required in [http://plantuml.sourceforge.net/graphvizdot.html graphvizdot]. 55 {{{ 56 #!sh 54 {{{#!sh 57 55 [sudo] java -jar plantuml.jar -testdot 58 56 }}} … … 60 58 1. '''Install''' component: 61 59 * with easy_install, globally: 62 {{{ 63 #!sh 60 {{{#!sh 64 61 [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk 65 62 }}} … … 67 64 1. '''Enable''' this component as follows: 68 65 * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 69 {{{ 70 #!ini 66 {{{#!ini 71 67 [components] 72 68 plantuml.* = enabled 73 69 }}} 74 70 * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). 75 [[BR]]76 71 1. '''Configure''' the Trac environment as follows: 77 72 * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 78 {{{ 79 #!ini 73 {{{#!ini 80 74 [plantuml] 81 75 plantuml_jar = /path/to/plantuml.jar 82 76 java_bin = /path/to/java_bin (optional, if Java binary is not on the search path) 83 77 }}} 84 * example `plantuml_jar = /project-resources/trac/plugins` 85 * example `java_bin = java` assumes that the Java binary is on the search path.[[BR]][[BR]] 86 * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). 87 [[BR]] 78 * example: `plantuml_jar = /project-resources/trac/plugins`. 79 * example: `java_bin = java`, assumes that the Java binary is on the search path. 80 * or accessing your Admin panel (under selected Trac environment {{{..admin/general/plugins}}}). 88 81 1. '''Restart''' web server: 89 82 * Apache on Ubuntu, example command line: 90 {{{ 91 #!sh 83 {{{#!sh 92 84 [sudo] /etc/init.d/apache2 restart 93 85 }}}