README.markdown
1# This plugin is not maintained anymore
2
3---
4
5This plugin integrates [PlantUML](http://plantuml.sourceforge.net) into the [DukuWiki](http://www.dokuwiki.org) wiki engine.
6It allows to generate UML graph images from simple description text block.
7
8# Features
9* Create any UML graph supported by PlantUML.
10* Generated images are PNGs.
11* Generated images are cached and regenerated when needed.
12* Toolbar button (optional)
13* Control the display witdh, height and alignment.
14* Works with the PlantUML webservice and/or a local installation.
15
16# Local Rendering
17
18Requirements (for local PlantUML installation):
19* [plantuml.jar](http://plantuml.sourceforge.net/download.html)
20* [Java runtime](http://www.java.com/download)
21* [Graphviz](http://www.graphviz.org) _You don't need this if you only want to generate sequence diagrams_
22
23See [PlantUML Installation Notes](http://plantuml.sourceforge.net/faqinstall.html) for troubleshooting.
24
25# Remote Rendering
26
27The plugin can use PlantUML server to generate diagrams. So nothing is required to be installed on the server running DokuWiki.
28However, the server must have a access to the Web. This can be an issue if you're on a Corporate network for example.
29
30If you set java and plantuml location in the configuration (in the Administration section of DokuWiki), then java will be used to compress the url.
31
32# Sample
33This block describes a sequence diagram:
34
35 <uml>
36 Alice -> Bob: Authentication Request
37 Bob --> Alice: Authentication Response
38
39 Alice -> Bob: Another authentication Request
40 Alice <-- Bob: another authentication Response
41 </uml>
42
43and results in:
44
45
46
47# Control display size
48Inside the start tag *`<uml>`*, you can specify the width and/or height of the image using one of the following ways:
49
50 <uml w=100>
51 <uml width=100>
52 <uml w=80%>
53 <uml width=80%>
54 <uml 100x200>
55
56# Image Title
57By default, html img title attribute is set to "PlantUML Graph". You can specify your own graph title like this:
58
59 <uml title="This will be the title">
60 <uml t=Diagram>
61
62Note: Multiple words need to be placed in double quotes.
63
64
65# Contributors
66* [Willi Schönborn](https://github.com/whiskeysierra): rewrite of the syntax plugin with many additional features
67
){kind=link}