This is an old revision of the document!
Table of Contents
plantumlparser Plugin
Compatible with DokuWiki
Frusterick Manners
Installation
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
There is no need for the DokuWiki server to have internet access for this to work, just the browser viewing the page needs internet access.
Examples/Usage
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:
There is also a toolbar button that is added to quickly add the tags into the page.
Syntax
Whatever is inside the uml tags will be displayed as a SVG on the wiki page:
<uml> Alice -> Bob: Authentication Request Bob --> Alice: Authentication Response Alice -> Bob: Another authentication Request Alice <-- Bob: another authentication Response </uml>
Change Log
- 2018-03-16
- Fixed bug introduce in previous change where the wrong link was put in for TXT diagrams.
- 2018-03-11
- Diagrams are cached on server instead of being retrieved by every client every time.
- Contribution by Antoine Aflalo
- 2018-03-08
- Links to view the diagram outside the wiki are now added.
- 2018-03-01
- Fixed issue where sometimes the plugin would break the page.
- 2018-02-08
- Changed imaged to be served over https.
- 2018-02-05
- Fixed issue where plugin wouldn't work on Windows server.
- 2018-01-23
- Fixed bug where warnings were being displayed.
- 2018-01-20
- Initial release