Changes between Version 21 and Version 22 of PlantUmlMacro
- Timestamp:
- Mar 11, 2015, 9:05:04 AM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PlantUmlMacro
v21 v22 16 16 }}} 17 17 18 = Render PlantUML Diagrams =18 = Render PlantUML Diagrams 19 19 20 == Description ==20 == Description 21 21 22 22 [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. … … 24 24 This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams. 25 25 26 == Usage == 26 == Bugs/Feature Requests 27 28 Existing '''[report:9?COMPONENT=PlantUmlMacro bugs and feature requests]''' for !PlantUmlMacro. 29 30 If 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 27 35 28 36 1. As a !WikiProcessor with markup: … … 38 46 }}} 39 47 }}} 48 will render the following UML diagram: 49 40 50 [[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]42 51 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]. 44 53 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: 49 60 {{{ 50 61 {{{ … … 54 65 }}} 55 66 }}} 56 1. `[sudo]` , when used, is optional case you already have enough authorityto modify your server.67 1. `[sudo]` is optional in case you already have enough authorisation to modify your server. 57 68 [[BR]][[BR]] 58 69 2. '''Check''' dependencies: 59 i. a valid Java runtime60 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`. 61 72 * 62 73 {{{ 63 74 #!sh 64 $[sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download75 [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download 65 76 }}} 66 77 * Check version of PlantUML jar: 67 78 {{{ 68 79 #!sh 69 $cd /path/to/plantuml.jar70 $[sudo] java -jar plantuml.jar -version80 cd /path/to/plantuml.jar 81 [sudo] java -jar plantuml.jar -version 71 82 }}} 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]. 73 84 {{{ 74 85 #!sh 75 $[sudo] java -jar plantuml.jar -testdot86 [sudo] java -jar plantuml.jar -testdot 76 87 }}} 77 88 [[BR]][[BR]] … … 80 91 {{{ 81 92 #!sh 82 $[sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk93 [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk 83 94 }}} 84 95 [[BR]][[BR]] … … 92 103 * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}). 93 104 [[BR]][[BR]] 94 1. '''Configure''' Trac environment as follows:105 1. '''Configure''' the Trac environment as follows: 95 106 * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 96 107 {{{ … … 108 119 {{{ 109 120 #!sh 110 $[sudo] /etc/init.d/apache2 restart121 [sudo] /etc/init.d/apache2 restart 111 122 }}} 112 123 [[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. 115 125 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 123 127 124 128 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. 125 129 126 == Recent Changes ==130 == Recent Changes 127 131 128 132 [[ChangeLog(plantumlmacro, 3)]] 129 133 130 == Author/Contributors ==134 == Author/Contributors 131 135 132 136 '''Author:''' [wiki:airadier] [[BR]] 133 '''Maintainers:''' [ wiki:airadier], rjollos [[BR]]137 '''Maintainers:''' [[Maintainer]], rjollos [[BR]] 134 138 '''Contributors:''' ebencheung, Erwin Rademaker[[BR]] 135 139 '''License:''' BSD 3-Clause