PlantUML Plugin for Redmine
Switch branches/tags
Nothing to show
Clone or download
ncreuschling Merge pull request #22 from wate/patch-1
Optimization of command execution processing
Latest commit d4526c4 Sep 7, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app update Sep 4, 2018
assets Redmine 3.4 compatibility Jul 28, 2017
config Add japanese translation Sep 2, 2018
lib rake task added for cleaning up the files directory Jul 28, 2017
test unit and functional tests added Aug 13, 2015
.rubocop.yml initial commit Aug 5, 2015
LICENSE Create LICENSE Jul 28, 2017
README.md add setting option for allowing includes insice code blocks Aug 1, 2017
init.rb fixed bug #11 Aug 9, 2017

README.md

PlantUML Redmine plugin

This plugin will allow adding PlantUML diagrams into Redmine.

Requirements

  • Java
  • PlantUML binary

Installation

  • create a shell script in /usr/bin/plantuml
#!/bin/bash
/usr/bin/java -Djava.io.tmpdir=/var/tmp -Djava.awt.headless=true -jar /PATH_TO_YOUR_PLANTUML_BINARY/plantuml.jar ${@}
  • copy this plugin into the Redmine plugins directory

Usage

  • go to the plugin settings page and add the PlantUML binary path /usr/bin/plantuml
  • PlantUML diagrams can be added as follow:
{{plantuml(png)
  Bob -> Alice : hello
}}
{{plantuml(svg)
  Bob -> Alice : hello
}}
  • you can choose between PNG or SVG images by setting the plantuml macro argument to either png or svg

using !include params

Since all files are written out to the system, there is no safe way to prevent editors from using the !include command inside the code block. Therefore every input will be sanitited before writing out the .pu files for further interpretation. You can overcome this by activating the Setting.plugin_plantuml['allow_includes'] Attention: this is dangerous, since all files will become accessible on the host system.

Known issues

TODO

  • add image caching