PlantUML
Explanation
The PlantUML Macro lets users draw diagrams in wiki pages with PlantUML. It requires XWiki 16.10 or later and is installed from the Extension Manager, together with the PlantUML Administration extension, which adds a "PlantUML" section to the wiki administration.
To use the macro, see PlantUML for users.
Embedded Mode and PlantUML Server
By default, XWiki generates the diagrams itself, with the PlantUML library bundled in the macro: nothing needs to be installed or configured, and no internet access is needed. When GraphViz is not installed, PlantUML lays out the class, use case, component and similar diagrams with its built-in layout engine. Raw GraphViz diagrams (dot type) are the exception: XWiki does not generate them.
The diagrams can instead be generated by a PlantUML server, for example one installed next to XWiki: XWiki sends it the text of the diagram and displays the image it returns. To set one up, see Use a PlantUML Server.
The server that generates a diagram is chosen as follows.
Security
- XWiki contacts a PlantUML server only when its domain is in the trusted domains, so that the macro cannot be used to reach other servers.
- PlantUML Macro 2.5+ Only wiki administrators can choose a server in a macro, and only wiki administrators can edit the "PlantUML" administration section. A configuration last saved by another user is ignored.
- PlantUML Macro 2.5+ In embedded mode, PlantUML runs with the SANDBOX security profile, which denies it any access to local files and URLs.
- PlantUML Macro 2.5+ Calls to a PlantUML server time out, and the size of the diagram it returns is limited.
These settings are described in Configuration Properties.
More
To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.
