wiki:PlantUmlMacro

Version 11 (modified by AdrianFritz, 3 years ago) (diff)

note about optional use of sudo command

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

  1. 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
    }}}
    
    • should render:
  2. More information on the PlantUML language and different types of UML diagrams can be found in PlantUML Website

Installation

  1. Check dependencies:
    1. a valid Java runtime
    2. plantuml.jar: save it to the location that you'll specify in the configuration section /path/to/plantuml.jar.
      • $ [sudo] wget http://sourceforge.net/projects/plantuml/files/plantuml.jar/download
        
        • [sudo] is optional
      • Check version of PlantUML jar:
        $ cd /path/to/plantuml.jar
        $ java -jar plantuml.jar -version
        
    3. Graphviz: check if installed and working as required in graphvizdot.
      $ java -jar plantuml.jar -testdot
      
  2. Install plugin globally:
    • with easy_install:
      $ [sudo] easy_install https://trac-hacks.org/svn/plantumlmacro/trunk
      
      • [sudo] is optional case you already have enough authority to modify your server.
  3. Enable the plugin by updating TracIni file as follows:
    [components]
    plantuml.* = enabled
    
  4. 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.
  5. Restart web server on command line:
    $ [sudo] /etc/init.d/apache2 restart
    
    • [sudo] is optional case you already have enough authority to modify your server.
  6. 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.

Bugs/Feature Requests

Existing bugs and feature requests for PlantUmlMacro.

If you have any issues, create a new ticket.

Source & Download

You can check out PlantUmlMacro using Subversion, or browse the source with Trac, or download the zipped source.

Recent Changes

[14362] by rjollos on 2015-01-08 15:05:55
2.0dev: Fixed comparison after splitting filename. Fixes #12132.
[14361] by rjollos on 2015-01-08 07:58:54
2.0dev: Check that plantuml_jar is the path of a file ending in .jar. Refs #12132.
[14360] by rjollos on 2015-01-08 07:52:12
2.0dev: PEP-0008 change and removed unused imports.

Author/Contributors

Author: airadier
Maintainers: airadier, rjollos
Contributors: ebencheung
License: BSD 3-Clause

Attachments (1)

Download all attachments as: .zip