PlantUML - Generate UML diagrams from files and view them in Eclipse

The plantuml library implements a DSL and renderer for many UML diagrams (class, sequence, objects, states, activities, ...). See http://plantuml.com for more info about the DSL and renderer.

This project integrates plantuml's functionality into Eclipse, by means of a view that shows a diagram for the currently active editor. The rendered diagram is typically based on explicit DSL code embedded in the editor, or generated from the content of the editor.

We currently support generating diagrams for

• DSL code embedded in text in any text editor inheriting from the standard eclipse text editor
• the class in the Java editor, based on the Eclipse Java model
• the EClasses in Ecore models in the Ecore editor
• OSGi Manifest files

There's also support for generating a diagram for all the Java classes within one or more Java packages.

Diagram generation is handled by (implementations of) an extension point, called diagram intent providers (supersedes diagram text providers), so you can customize the process of generating a diagram for other file types or editor content. Each diagram intent provider supports a certain way of generating a diagram from a source, typically the content of an editor. There may be several diagram intent providers for a certain source, so the user may select the desired one.

Each diagram intent provider may support properties that affect details of how diagrams are generated, that may be changed pr. workspace by adding properties in a specific properties file in a specific folder. The folder is settable in the PlantUML property sheet. E.g. the diagram intent provider for class diagrams supports two properties, that controls how attributes' name and type are rendered. Certain other behavior is also controlled by properties in properties files, details can be found in Customization.

License

This repo uses the EPL license vers. 1.0.

Community

We use Issues for issue tracking, so head there concerning bugs or suggest features (check if they already exist before adding).

We also use Discussions, so please consider it, before using issues, as the dialog may resolve the issue before it is even raised! Of course, you can also ask questions about how to use PlantUML, tell us about how you use it, comment on where the plug-in should be heading, etc.

Originally, this repository was created and hosted by Hallvard Trætteberg. You'll find previous issues and discussions in the original repository.

Installation

We use GitHub pages at https://plantuml.github.io/plantuml-eclipse/ as the update site URL. Just install the plug-ins in Eclipse via the Help > Install New Software... dialog using that URL. Previous versions can be installed using the update site https://hallvard.github.io/plantuml/.

Beginning with version 1.2.0, you'll need at least the following features

• PlantUML Feature (the PlantUML diagramming support for Eclipse)
• PlantUML Library Feature (the PlantUML library needed for rendering diagrams, it inlcudes the ELK layouting library)

The following features are optional

• PlantUML Ecore Feature (for drawing class diagrams from ecore files)
• PlantUML UML2 Feature (for drawing UML diagrams from UML 2 model files)

For developers / contributors

You'll find some developer documentation here:

• plantuml4eclipse/releng/net.sourceforge.plantuml.parent/README.md (how to build, run, and release)
• plantuml4eclipse/releng/net.sourceforge.plantuml.parent/Customization.md (how to adapt diagrams)

The PlantUML4Eclipse plug-ins depend on the PlantUML library bundle, i.e. net.sourceforge.plantuml.library. This bundle is automatically built and published on an Eclipse update site (this repo's GitHub pages publish a composite update site with PlantUML library and PlantUML4Eclipse plug-ins) as soon as there is a new PlantUML release (see GitHub workflows). The net.sourceforge.plantuml.library bundle uses the EPL-licensed version of the PlantUML library.

Main plugins (net.sourceforge.plantuml.)

• eclipse - core Eclipse integration, including the extension point for providing diagrams
• eclipse.imagecontrol - the control for viewing the generated images
• svg - the browser-based svg view
• text - diagrams based on explicit DSL code, with support for editors based on the standard Eclipse text editor
• jdt - diagrams based on the Eclipse Java model, with support for Java and Class File editors
• ecore - diagrams based on Ecore models, with support for most Ecore editors
• uml2 - diagrams based on UML2 models
• osgi - component diagrams based on OSGi meta-data
• (xcore - diagrams based on Xcore models, with support for the Xtext editor)

Releases

Notable features in recent releases are listed below. You'll find all versions in the releases section. (Previously, releases were published by Hallvard Trætteberg).

Note that the net.sourceforge.plantuml.library plugin's versions are similar to those of the included PlantUML library release versions. This plugin's life cycle is strictly coupled with that of the PlantUML library releases.

1.2.0

• Move git repository from https://github.com/hallvard/plantuml to https://github.com/plantuml/plantuml-eclipse (see discussions 1 and 2)
• Separate releases for PlantUML library plug-in (PlantUML lib) and PlantUML support for Eclipse plug-ins (PlantUML4Eclipse). This way, we make the PlantUML library (EPL-licensed) easily re-usable in any Eclipse plug-in (just add a dependency and install it via update site). (issue #145)
• Automate PlantUML library plug-in releases (create new PlantUML library plug-in for Eclipse as soon as a PlantUML library is released) (issue #145)
• Semi-automate PlantUML for Eclipse plug-in releases (issue #145)
• Update dependency to PlantUML library version 1.2025.9 (see changes) and remove some obsolete plug-ins since we no longer need ELK library (it is now included in the PlantUML library).
• Improve saving a diagram as an SVG file, suggest the same folder for the new .svg file as the original .puml file.
• Add UML 2 model support (rendering various diagrams from UML 2 models), original plug-ins implemented by @hallvard were updated and extended. Thanks for the PR to @ansgarradermacher.

1.1.32

• Updated PlantUML library version to 1.2024.5, see changes.

1.1.31

• Updated PlantUML library version to 1.2024.4 (issue #145), see changes.
• Automated some of the steps needed to update to a new PlantUML library version (issue #145)
• Updated target platform to Eclipse 2023-12 and to Java 17.

1.1.30

• Fixed access to environment variables from PlantUML code, using PlantUML functions like %getenv("MY_ENV_VAR"), see PlantUML security profiles.
• Fixed installation on Windows without having to explicitly install Graphviz (issue #175)
• Updated PlantUML library version to 1.2023.11 (issue #145), see changes.

1.1.29

• Updated PlantUML library version to 1.2023.10 (issue #145), see changes.
• Fixed duplicated Java type members entries in diagrams created from Java packages.

1.1.28

• Updated to use PlantUML library version 1.2023.5 (issue #145), see changes.
• Updated target platform to Eclipse 2022-09 and JRE 11 (JavaSE-11).

1.1.27

• Support for injecting code into diagrams, based on regular expressions on the diagram text, e.g. custom styles can be inserted all state diagrams. See section about custom properties.
• Updated to use PlantUML library version 1.2022.7 (issue #145), see changes.
• Fix for issue #152 to more gracefully handle "empty" line.
• Fix for issue #144 concerning installation in Eclipse 2021-09.
• Fix for issue #140 where methods for selecting relevant diagrams weren't called.
• Fix for issue #139 preventing diagram from appearing.

1.1.26

• The svg view can use a jmustache template (according to a preference) when generating its contents issue #116
• Updated to use PlantUML library version 1.2021.5 see changes.
• Support for the ELK layout engine, see plantuml.com/changes.
• Fix for issue #132

1.1.25

• Updated to use PlantUML library version 1.2021.3 (see changes).
• Added new extension point that supports generating several alternative diagrams for the same content (issue #109) and delays the computation of the diagram so it can run on a non-UI thread (issue #82). Uses of old extension point should still work, but should be updated to use new one.
• I needed to remove (for now) the feature that recomputes saved diagram images during builds, when their source have changed.
• Experimental PlantUML SVG view that handles zooming better (issue #116)
• Association is generated when type is Optional and for methods with a specific signature. (thanks to dpolivaev)
• Changes generated diagrams to use name : type UML format for attributes instead of java style type name (issue #115)
• Source features (issue #104)

1.1.24

• Support for diagrams in more text formats, including markdown (issue #65 and issue #91).
• Support for jlatexmath in separately installable feature (issue #72)
• Fixed bugs (issue #93 and (issue #95)
• Updated to use PlantUML library version 1.2019.11 (which includes support for mindmaps).

1.1.23

• Support for generating diagrams for views, e.g. Java element selected in Package Explorer (issue #84).
• Support for generating diagrams from console output.
• Preference page for enabling/disabling diagram providers.
• Avoid generating diagram (image) when PlantUml view is hidden.
• Moved list of diagram into sub-menu of view menu, handles issue #87.
• Now requires Java 1.8.

1.1.22

• Fixes bug (issue #77) concerning incompatibilit with Photon 2018.12.
• The view menu now lists the (explicit) diagrams in a file, so you can select and view it, without navigating inside the file. See (issue #61)
• Updated to use PlantUML library version 1.2019.0.

1.1.21

• Fixes include bug (issue #73).
• Updated to use PlantUML library version 1.2018.12, which fixes another include bug.

1.1.20

• Fixes include bug (issue #35) and copying, exporting and printing pages of multi-page diagrams.
• Fixes problem with dangling Ecore objects (issue #36)
• Fixes problem with object attribute values with newlines and braces (issue #37) by truncating. Also truncates long attribute value strings, to make object boxes smaller.
• Support for marker:/.../ hyperlinks to specific objects within a file, using the Marker API. Ecore object diagrams now use this kind of marker.
• Fixes problem with missing void operation (issue #40). Also appends "[]" to many-valued types.
• Save action, for exporting image or puml file into workspace, and auto-save feature, for automatically updating saved files when the source changes (issue #41).
• Updated to use PlantUML library version 1.2018.9

1.1.19

• Support for the newpage directive. Multi-page diagrams are rendered as numbered tabs (issue #11).
• Support generating packages for project class diagram, and a preference to turn on/off (issue #18).
• Object diagram generator, currently used as a default for Ecore model instances. To support overriding this behavior, e.g. so an Ecore model for state machines can be rendered as state diagrams, diagram text providers can now have a priority (issue #33).
• Refactored project layout, to conform to Eclipse conventions. Prepared for separating PlantUML library and Eclipse plugins update sites, so they can be released separately. The library plugin and feature has changed to same versioning as the jar.

1.1.18.8059

• Support links to fully qualified java classes with java scheme links (issue #31), e.g. java:java.lang.String. Add a fragment to navigate to a specific member. Default diagram generation from java source now uses this kind of link.
• Fix problem with enums in project class diagrams, where associations where generated for the literals (issue #30).

1.1.17.8059

• Hyperlinks that are just paths or use the platform scheme are opened in the default Eclipse editor (issue #25). Class diagrams generated from Java code utilize this feature by including navigatable path links.

1.1.16.8059

• Open several PlantUML views and pin them to a specific resource (issue #21). Please comment on the behaviour.
• Support for hyperlinks, see http://plantuml.com/link (issue #24)

1.1.14.8059

• Experimental support for generating a class diagram for a set of Java files (issue #18). Open the PlantUML Project Class Diagram and drag a Java project or package into the view (suggest improvements by adding a comment to the issue).
• support for generating class diagram for .class files shown in the Class File editor

1.1.13.8054

• Includes EPL-ed version of plantuml.jar
• Fix for issue #13 - recompute diagram on activate not just broughtOnTop