Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.08 KB

README.md

File metadata and controls

40 lines (26 loc) · 1.08 KB
Raw

PlantUML Macro Plugin

This is plugin for Redmine.

This plugin adds a plantuml macro to wiki pages or issue description. The content of the macro in PlantUML language is converted into the URL to PlantUML server and this URL is inserted into wiki page as an external image.

Installation

  1. Copy the content of this repository to $REDMINE/plugins/plantuml_macro folder.
  2. Restart Redmine.

Configuration

You can configure the plugin on Administration->Plugins page.

You can define the URL of the PlantUML server. Default value is http://plantuml.com/plantuml/.

Usage

Enter something like this on a wiki page:

{{plantuml
    Bob -> Alice : hello
}}

This will be rendered as the image located on the configured PlantUML server.

Other

The plugin requires redmine, uri and zlib Ruby modules.

The code to encode PlantUML URL is converted from this Python code: https://github.com/dougn/python-plantuml/blob/master/plantuml.py