PlantUML as our best practice for diagrams for xwiki.org

Development
1

Hi everyone,

I’d like to propose to make PlantUML our best practice format when adding diagrams on xwiki.org (rather than insert images for which we don’t have the sources).

Example usage:

Source:

Available diagram types and syntaxes:

If everyone is ok I’ll modify https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide accordingly.

WDYT?

Thanks

2

+1 Thanks

I was going to suggest to add XWiki to https://plantuml.com/running but it’s already there :slight_smile:
Also, several online tools exist with a live visualization of the diagrams (see https://www.planttext.com/ or https://plantuml-editor.kkeisuke.com/). It also seems to be integrated with IntelliJ and Eclipse.

3

+1 it will be much easier to update some existing schema, even if it’s going to take some time to learn all that :slight_smile:

This will be useful, thanks !

4

Isn’t there any visual editor available?

5

Manuel mentioned a few that provide live rendering (or close to live, with the hit of a button). It’s probably nicer than visual editors to learn the syntax.

Note that the learning was not an issue for me when I used it for the first time to convert the 2 existing diagrams. I was really amazed at how fast I was able to do it (I was expecting to struggle a lot more ;)).

6

OK, +1 then.

7

Documentation added to https://dev.xwiki.org/xwiki/bin/view/Community/DocGuide#HDiagrams

Note: I’ve mentioned to use the bluegray theme which is the one I’ve used after testing several. If someone disagrees we can always do a vote.

Thanks