A plugin for Dokuwiki that generates UML graphs from text using PlantUML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
conf
lang
res
.gitignore
README.markdown
action.php
img.php
plugin.history.txt
plugin.info.txt
syntax.php

README.markdown

This plugin is not maintained anymore


This plugin integrates PlantUML into the DukuWiki wiki engine. It allows to generate UML graph images from simple description text block.

Features

  • Create any UML graph supported by PlantUML.
  • Generated images are PNGs.
  • Generated images are cached and regenerated when needed.
  • Toolbar button (optional)
  • Control the display witdh, height and alignment.
  • Works with the PlantUML webservice and/or a local installation.

Local Rendering

Requirements (for local PlantUML installation):

See PlantUML Installation Notes for troubleshooting.

Remote Rendering

The plugin can use PlantUML server to generate diagrams. So nothing is required to be installed on the server running DokuWiki. However, the server must have a access to the Web. This can be an issue if you're on a Corporate network for example.

If you set java and plantuml location in the configuration (in the Administration section of DokuWiki), then java will be used to compress the url.

Sample

This block describes a sequence diagram:

<uml>
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
</uml>

and results in:

Sample

Control display size

Inside the start tag <uml>, you can specify the width and/or height of the image using one of the following ways:

<uml w=100>
<uml width=100>
<uml w=80%>
<uml width=80%>
<uml 100x200>

Image Title

By default, html img title attribute is set to "PlantUML Graph". You can specify your own graph title like this:

<uml title="This will be the title">
<uml t=Diagram>

Note: Multiple words need to be placed in double quotes.

Contributors