Skip to content

Latest commit

 

History

History
85 lines (66 loc) · 6.98 KB

README.md

File metadata and controls

85 lines (66 loc) · 6.98 KB
Raw

PlantUML Viewer

License Downloads Release Build status Donate

A Notepad++ plugin to generate, view and export PlantUML diagrams.

Features

  • Official and full PlantUML syntax
  • Multiple diagrams and pages per document supported
  • Dockable panel to show the generated PlantUML diagrams
  • Zoomable diagrams
  • Export of diagrams as PNG or SVG
  • Dark mode support

Latest changes

You can find the latest and all other changes in the changelog.

Installation

Detailed information about plugins and how they are installed can be found in the Notepad++ User Manual.

Manual

Download a release version and copy the folder PlantUmlViewer with its content to the plugins subfolder of your Notepad++ installation directory.

Plugins Admin (recommended)

Use the built-in Plugins Admin to install it directly. Just open Notepad++ and navigate to Plugins → Plugins Admin. Here under the Available tab, search for PlantUML Viewer. After checking the corresponding box, click Install at the top right corner of the window.

Compatibility

This plugin requires at least

  • Notepad++ 32-bit or 64-bit
  • .NET Framework 4.6.2 or above
  • Java

Usage

PlantUML Viewer can be opened

  • by clicking the toolbar icon UML icon
  • via the Notepad++ Plugins submenu (Plugins → PlantUML Viewer → Preview PlantUML)

PlantUML Viewer PlantUML Viewer dark

By clicking the Refresh () button the diagram(s) are generated out of the current opened document. The file extension doesn't matter. The diagram can be

  • moved by dragging it,
  • zoomed by Ctrl + mouse wheel or clicking the buttons ( / / )
  • or scrolled vertically and horizontally by (Shift +) mouse wheel.

The currently showed diagram can be exported or copied to clipboard as PNG or SVG image by clicking the Export () button or using the right click context menu. If your document contains multiple diagrams and or pages, you can use the navigation buttons to show the next () or previous () diagram and next () or previous () page.

Make sure JAVA_PATH is set in your system or set the right path to your Java installation. It can be set together with other options in the plugins options window.

PlantUML Viewer menu PlantUML Viewer options

Usability hints

  • You may also want use this plugin in combination with PlantUML_Notepad-_UDL, which enables the PlantUML language syntax for Notepad++.
  • Using the Shortcut Mapper, which is accessible via the Settings submenu of Notepad++, you can define a shortcut to generate the diagrams.

License and credits

PlantUML Viewer is released under the MIT License. This means, you can do with it whatever you want as long as you include the original copyright and license notice in any copy of the software.

This Notepad++ plugin integrates multiple other libraries and sources. Credits and thanks to all the developers working on these great projects:

  • The plugin is based on the Notepad++ PluginPack.net by Kasper B. Graversen provided under the Apache 2.0 license.
  • The plugin uses SVG.NET provided under the Microsoft Public License which depends on
    • ExCSS by Tyler Brinks provided under the Microsoft Public License.
  • The plugin uses the ImageBox Control by Richard Moss provided under the MIT License.
  • The plugin uses the LoadingCircle by Martin Gagne provided under the Code Project Open License.
  • The plugin uses Json.NET by James Newton-King provided under the MIT License.
  • The plugin uses Material Design Icons provided under the Pictogrammers Free License.
  • The plugin is packed using ILMerge provided under the MIT License.
  • The plugin release includes the binaries of PlantUML which are free to use and released under the GNU General Public License.
  • The plugin release includes the binaries of JLaTeXMath which are free to use, released under the GNU General Public License and depend on

Feedback, issues and contribution

Resonable feedback, issues and contributions are always very welcome. Feel free to bring in your points!

Disclaimer

This source and the whole package comes without warranty. It may or may not harm your computer. Please use with care. Any damage cannot be related back to the author. The source has been tested on a virtual environment and scanned for viruses and has passed all tests.

Personal Note

I've created this software in my leasure time since I found no comparable solution to preview PlantUML diagrams seamlessly in Notepad++. This software (with all its bugs) is not aiming to be an enterprise solution. It surely will not fulfill the needs of everybody. But it maybe is a nice little helper for some of you. I am always open for your reasonable feedback, issues and contributions. Feel free to contact me and have fun with it.