Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw

Information about the PlantUML Eclipse Plugin

The Eclipse Plugin is developed and maintained by Hallvard Trætteberg (many thanks for his work!).

Like the core library PlantUML itself, it is open source and the plugin is distributed under EPL license.

The source code is hosted on GitHub.

How to use it?

First, you have to display the PlantUML View (click the Window menu):

This view displays automatically the class you are working on:

If you write some comment in PlantUML language, the corresponding diagram is automatically displayed. And if you have several comments with diagrams, it selects the one the cursor is in.

In the Preferences Windows, you can also set up GraphViz path if needed:

How to install it?

To install the plugin, you have to:
  • Go to Help/Software Update/Find and install... or Help/Install new software...
  • Create (if needed) or choose the following site as update site: http://hallvard.github.io/plantuml/
  • Select PlantUML features:
  • Restart Eclipse

How to improve it?

The plugin is not limited to Java source file, it also works with Ecore/Xcore files.

So that you can see the corresponding class diagram in a view side-by-side the Ecore/Xcore editor :

If you want to support other file types, you can implement a new extension to do so. You can have a look at the current xcore implementation.

Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.