plugin:plantumlparser
Table of Contents
PlantUML Parser Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" yes
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" yes
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 plantuml.com 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
- 2023-11-02
- Fixed deprecation warning.
- Contribution by Ralf Stemmer
- 2021-05-17
- New configuration option that allows removal of links section. Defaults to show links.
- 2020-04-22
- Added the ability to use a different plantuml server
- Contribution by Boris Flader
- 2019-10-02
- Made ASCII Math Work
- Contribution by Eduardo Mozart de Oliveira
- 2019-03-26
- When using this plugin and dw2pdf xml was outputted to PDF.
- 2018-08-23
- Stopped using planttext.com because they stopped hosting diagrams.
- Contribution by Antoine Aflalo
- 2018-07-07
- Fixed issue with multi-byte characters.
- 2018-07-03
- Now the menu under the diagram is hidden when printing.
- 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
plugin/plantumlparser.txt · Last modified: by Aleksandr