Version 8 (modified by 12 years ago) (diff) | ,
---|
Contents
The trunk is a development version that works with Trac 0.11 and later. The code is thought to be stable, but please be ready to do some testing and report defects if you intend to install it on a production system. A tag will be created for version 2.0 when the code is known to be stable. Posting a note to #9958 about your experience using the plugin would be very appreciated.
Planned Enhancements
- Work towards v2.0, improving documentation and fixing minor defects.
- Render plantuml files from repository #7053.
News
- 19-March-2012: License changed from GPL to BSD 3-Clause, which is the license used by Trac.
Render PlantUML Diagrams
Description
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.
This plugin allows the integration of PlantUML on Trac Wiki pages, dynamically generating and embedding the diagrams.
Usage
- Inside a wiki page:
{{{ #!PlantUML @startuml Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response @enduml }}}
- More information on the PlantUML language and different types of UML diagrams can be found in PlantUML Website
Installation
- Clear dependencies
- a valid Java runtime
- plantuml.jar: save it in your
/path/to/plantuml.jar
(see configure section).- Check version if the case:
$ cd /path/to/plantuml.jar $ java -jar plantuml.jar -version
- Up-date if the case
$ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
[sudo]
is optional
- Check version if the case:
- Graphviz: check if installed and working as required in graphvizdot.
$ java -jar plantuml.jar -testdot
- Install plugin globally:
- with easy_install:
$ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
[sudo]
is optional
- with easy_install:
- Enable the plugin by updating TracIni file as follows:
[components] plantuml.* = enabled
- 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.
- example
- Restart web server on command line:
$ [sudo] /etc/init.d/apache2 restart
- Test if plugin is working properly.
Bugs/Feature Requests
Existing bugs and feature requests for PlantUmlMacro are here.
If you have any issues, create a new ticket.
Source & Download
You can check out PlantUmlMacro from here using Subversion, or browse the source with Trac.
Download the zipped source from [download:plantumlmacro here].
Recent Changes
- 17597 by rjollos on 2019-11-26 05:41:59
-
TracPlantUml 2.3: Tag version 2.3
The release has been published to pypi:TracPlantUml/2.3
Fixes #13679.
- 17596 by rjollos on 2019-11-26 05:39:24
-
TracPlantUml 2.3dev: Add
classifiers
metadata
Refs #13679.
- 17025 by rjollos on 2018-01-28 11:38:22
-
TracPlantUml 2.3dev: Fix
usemap
attribute not prefixed with#
Patch by dries.decock@...
Fixes #13366.
(more)
Author/Contributors
Author: airadier
Maintainers: airadier, rjollos
Contributors: ebencheung
License: BSD 3-Clause
Attachments (1)
- sequence.PNG (6.2 KB) - added by 12 years ago.
Download all attachments as: .zip