plantuml plugin

Download and install the plugin using the Plugin Manager using this URL given above. Refer to Plugins on how to install plugins manually.

Two modes are available: local rendering or remote rendering.

If you choose local rendering, you'll need

• plantuml.jar
• Java runtime

PlantUML doesn't requires anything more to render sequence diagrams. However, for other diagram types, you'll also need to install

• Graphviz

See PlantUML Installation Notes for troubleshooting.

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.

• 2011-07-16
  • Fixed issue: remote rendering failed
• 2011-19-03
  • Fixed issue #10 (plantuml base field should be lowercase)
• 2011-31-01
  • Added support for width in percent
• 2010-12-19
  • Fixed attributes not captured correctly (width, multi word title)
  • Added ability to view the unresized version of the images.
• 2010-12-04
  • Complete rewrite.
  • Images are now saved in the cache folder.
  • Remote image generation support (default to http://plantuml.no-ip.org/plantuml/uml)
  • Alignment support.
  • Odt support.
• 2010-10-08
  • Very first version posted on GitHub.

Please refer to http: http://plantuml.sourceforge.net/ do get full description of the PlantUML syntax.

With PlantUML, you can draw:

• sequence diagram,
• use case diagram,
• class diagram,
• activity diagram,
• component diagram,
• state diagram
• object diagram

A typical PlantUML diagram is enclosed by @startuml and @enduml. Replace these by <uml> and </uml>.

This block:

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

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

renders this:

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 w=80%>
<uml width=100>
<uml width=80%>
<uml 100x200>

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.

• Doesn't seem to allow a backslash character so cannot enter newline.
  I've tried disabling all other plugins. It appears to be running standard syntax processing on the text. 2012-03-13 JK