A new image toolkit plug-in called "/PlantUML plug-in/" is available
online. If you want to give it a try please start XMLmind XML Editor
*_v10.11+_* and select menu item "*Options*|*Install Add-ons*".
_Documentation of this plug-in as found in the "*Install Add-ons*"
dialog box_
PlantUML may be used to create a number of UML and non-UML diagrams all
specified using simple textual descriptions. This plug-in converts
PlantUML scripts (contained ".puml" or ".pu" text files) to PNG and SVG.
Includes PlantUML <https://plantuml.com/> 1.2025.2.
Disclaimer
This plug-in is the work of Hussein Shafie, an employee of XMLmind
Software. However, unlike the other image toolkit plug-ins, the PlantUML
plug-in is /not officially supported by XMLmind Software/. The reason
for this restriction is that PlantUML has no documented Java™ API
<https://javadoc.io/doc/net.sourceforge.plantuml/plantuml-gplv2/latest/net/sourceforge/plantuml/package-summary.html>
and very little examples <https://plantuml.com/api> letting third-party
programmers integrate this tool in an application like XMLmind XML Editor.
This plug-in is licensed under the same open-source license as
PlantUML's which is found in file
plantuml_imagetoolkit/plantuml.LICENSE. Its source code is found in
plantuml_imagetoolkit/src.zip. The source code of PlantUML is itself
found on GitHub <https://github.com/plantuml/plantuml>.
What is PlantUML?
PlantUML <https://plantuml.com/> is an open-source tool that allows you
to create various UML and non-UML diagrams through simple textual
descriptions. From sequence diagrams to deployment diagrams and beyond,
PlantUML provides an easy way to create visual representations of
complex systems.
Supported UML diagrams:
* Sequence diagram
* Use case diagram
* Class diagram
* Object diagram
* Activity diagram
* Component diagram
* Deployment diagram
* State diagram
* Timing diagram
Supported non-UML diagrams:
* JSON data
* YAML data
* EBNF (Extended Backus-Naur Form)
* Regex (Regular Expression)
* Network diagram (nwdiag)
* Salt (Wireframe graphical interface or UI Mockups)
* Archimate diagram
* SDL (Specification and Description Language)
* Ditaa diagram
* Gantt diagram
* Chronology diagram
* MindMap diagram
* WBS (Work Breakdown Structure)
* Mathematical Notations (AsciiMath, JLaTeXMath)
* Entity Relationship (ER) diagram
o Information Engineering (IE) diagram
o Entity Relationship (ER) diagram (Chen's notation)
Very simple class diagram example:
@startuml
class ArrayList implements List
class ArrayList extends AbstractList
@enduml
Very simple class diagram example
After installing this plug-in using XMLmind XML Editor's
*Options*→*Install Add-ons* and restarting the application, you may want
to open
file:/home/hussein/.xxe10/addon/plantuml_imagetoolkit/sample.xml, a
sample DocBook article containing a few simple diagrams rendered using
this plug-in. It's of course also possible to convert this DocBook
article to a number of formats using *DocBook*→*Convert Document*.
PlantUML plug-in specificities
* PlantUML input scripts must be *UTF-8* encoded text files.
* This plug-in supports a PlantUML configuration file
<https://plantuml.com/command-line> which is to be automatically
included before each diagram. For this to work, such configuration
file must be called plantuml.config and must be found in the same
directory as plantuml.jar. A template configuration file,
plantuml.config.template, is found in plantuml_imagetoolkit/, the
installation directory of this plug-in, next to plantuml.jar. In
order to use it, suffice to rename this file to plantuml.config and
to adapt its contents to your needs.
* By default, PlantUML automatically uses the GraphViz
<https://graphviz.org/> layout engine through an external program
called |dot|, when this tool has been installed on the computer.
However /this plug-in should run fine even on computers where
GraphViz is not available/ (thanks to Smetana
<https://github.com/plantuml/smetana>, the 100% Java™ alternative
layout engine).
o PlantUML automatically detects and uses GraphViz |dot| if
installed at certain locations. You may use environment variable
GRAPHVIZ_DOT to explicitly specify the location of the |dot|
executable. Linux example: |export
GRAPHVIZ_DOT=/usr/local/bin/dot|.
o If you prefer not to use GraphViz |dot| even if it's available
on your computer then set environment variable GRAPHVIZ_DOT to
"-". Linux example: |export GRAPHVIZ_DOT=-|.
* If you want PlantUML to run in verbose mode, set environment
variable XXE_PLANTUML_VERBOSE to 1. Linux example: |export
XXE_PLANTUML_VERBOSE=1|.
--
Hussein SHAFIE, Product Manager,[email protected]
XMLmind Software, 35 rue Louis Leblanc, 78120 Rambouillet, France
Phone: +33 (0)9 52 80 80 37, Fax: +33 (0)9 57 80 80 37,www.xmlmind.com
--
XMLmind XML Editor Support List
[email protected]
http://www.xmlmind.com/mailman/listinfo/xmleditor-support
