Wiki source code of Configuration Properties
Last modified by Vincent Massol on 2026/10/21 19:09
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The PlantUML Macro is configured in ##xwiki.properties## and in the "PlantUML" section of the wiki administration. What these settings control is explained in [[PlantUML>>doc:documentation.extensions.admin.plantuml.WebHome]]. | ||
| 2 | |||
| 3 | == Properties in xwiki.properties == | ||
| 4 | |||
| 5 | Changes apply after XWiki is restarted. | ||
| 6 | |||
| 7 | |=Property |=Default |=What it does | ||
| 8 | |##plantuml.server## |None |URL of the PlantUML server generating the diagrams, used when the "PlantUML" administration section has no server. | ||
| 9 | |##plantuml.format## |##png## |Default output format of the diagrams: ##png##, ##svg## or ##txt##. An unknown value means ##png##. The ##format## parameter of the macro overrides it. | ||
| 10 | |##plantuml.securityProfile## |##SANDBOX## |{{version since="2.5" product="PlantUML Macro"}}PlantUML security profile used when XWiki generates the diagrams itself, for example ##ALLOWLIST##. An unknown value means ##SANDBOX##.{{/version}} | ||
| 11 | |##plantuml.server.connectTimeout## |##10## |{{version since="2.5" product="PlantUML Macro"}}Seconds to wait for the connection to the PlantUML server.{{/version}} | ||
| 12 | |##plantuml.server.responseTimeout## |##30## |{{version since="2.5" product="PlantUML Macro"}}Seconds to wait for data from the PlantUML server.{{/version}} | ||
| 13 | |##plantuml.server.maxResponseSize## |##10485760## (10 MB) |{{version since="2.5" product="PlantUML Macro"}}Maximum size, in bytes, of a diagram returned by the PlantUML server.{{/version}} | ||
| 14 | |||
| 15 | For example: | ||
| 16 | |||
| 17 | {{code language="properties"}} | ||
| 18 | plantuml.server=https://plantuml.example.com | ||
| 19 | plantuml.format=svg | ||
| 20 | plantuml.server.responseTimeout=60 | ||
| 21 | {{/code}} | ||
| 22 | |||
| 23 | == Administration Section == | ||
| 24 | |||
| 25 | |=Field |=Default |=What it does | ||
| 26 | |"PlantUML Server" |Empty |URL of the PlantUML server generating the diagrams of the current wiki. Takes precedence over ##plantuml.server##. Stored in the hidden page ##PlantUML.PlantUMLConfig##, which only wiki administrators can edit. |
