Guides for SE student projects »

This is a WIP community resource, containing contribution from community members.

If you notice any bugs or suggestions for improvements, please report at https://github.com/se-edu/guides/issues
You are welcome to contribute by sending a PRs to https://github.com/se-edu/guides/pulls too.

Intellij IDEA: Useful Plugins

PlantUML

PlantUML is a tool for specifying various diagrams in a textual form. It is particularly useful in software projects where you want to update the diagrams incrementally, as the project evolves over time.

The sections below explain how to install PlantUML. For more tips on using PlantUML in a project, click here

Setting up PlantUML in IntelliJ IDEA

Go to File > Settings to access the Settings page.
Go to Settings > Plugins > Marketplace and install the plugin PlantUML integration.
Then go to Settings > Languages & Frameworks > PlantUML or search for PlantUML. You can also use a specific version of PlantUML from the releases page.

Working with PlantUML in IntelliJ IDEA

After installing the PlantUML integration plugin, simply create or open any .puml file to start editing it.

Any changes you make in editor pane on the left will be reflected in the preview pane on the right. However, do take note that these changes will not be reflected in your actual documentation until you export the diagram.

Saving the Diagram as an image

When using MarkBind as the site generation tool:
- MarkBind has built-in support for PlantUML. The diagram will be generated and saved as an image automatically. No additional work needed from you. Refer to this section of the MarkBind User Guide for more details.
When using Jekyll as the site generation tool:
- The PlantUML integration plugin allows you to export individual diagrams to a location of your choosing. Click the Save Current Diagram Only button and choose the location to export the image file.
- You will have to git add any new diagrams generated!

PlantUML Tips and Tricks

You can refer to this se-edu guide to learn some tips and tricks useful for getting the diagrams to fit your needs.

Authors:

Initial Version: Jeffry Lum
Contributors:
- MUHAMMAD FIKRI BIN ABDUL KALAM (@mfjkri): added the part on SD reference frames