Display XWikiClass UML Diagram

Last modified by Jeremie Bousquet on 2021/03/17 21:36

cogGenerates nice UML diagram for XWiki Classes of a specific space using plantuml macro
TypeXAR
Category
Developed by

Jeremie Bousquet, Denis Gervalle

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Draws a class diagram with information from XWiki classes defined in a specific space.

Usage

{{xuml/}}

Plantuml macro must be properly installed. Alternatively you can use parameter "debug" = "true" and copy plantuml content somewhere else to generate a diagram.

Parameters definition

NameOptionalAllowed valuesDefault valueDescription
spaceyesSpace nameCurrent space namethe space to look for XWiki classes to draw.
showSheetsyestrue/falsefalseto display or not information about class sheets (displayed as fake "S" classes)
showListsyestrue/falsefalseto display or not information about lists (displayed as enums)
debugyestrue/falsefalseinstead of showing a diagram, shows plantuml source for debugging purposes

Associations are displayed (only for DBList properties having class name filled, so if you fill HQL query, please also specify class name for better display even if redundant).

Sample result:

sample_uml.png

The same with options showLists and showSheets:

sample_uml_full.png

Release Notes

v1.1

  • Add basic support for relation based on SQL queries (matching .classname="..." pattern)
  • Fix a issue with class names that cause class definition to be rendered separately from class relations.

v1.0

Made it a xar packaged macro with parameters.

Get Connected