kb:common:plantuml
Table of Contents
PlantUML
RAT Integration
Java
GraphViz
GraphViz is an open-source graph visualization software. It provides a program called dot. This dot program is able to generate a directed graph from a textual description.
You will need to add the path to the Graphviz bin
directory to the PATH
variable.
Optionally, create an environment variable called GRAPHVIZ_DOT
that points to the DOT executable.
The latest release of GraphViz tested to be compatible with RAT (v3.25.1, July. 2023) is
8.1.0 EXE installer for Windows 10 (64-bit)
Fallback: graphviz-2.38.msi (download provided via HSE's server)
For setting environment variables like PATH
, see the our **Shell dokuwiki page**.
PlantUML Server via Docker (the easy way!)
-
Install Docker (Linux) or Docker-Desktop (Windows). If not included, install Docker Compose.
-
Clone the “HSE PlantUML Server” docker compose script with
git clone git@gitlab.com:hampel-soft/hse-labs/hse-plantuml-server.git
. -
Open a terminal in the project folder.
-
Execute
docker-compose up -d
(für Compose v2:docker compose up -d
) -
Open a browser and type in
http://localhost:8123
. The PlantUML site with an input field and some example code should be displayed.
Synology NAS Docker
-
in docker webinterface register & download plantuml/plantuml-server
-
under image start image
-
configure a local port
-
create firewall rule for that port in synology DS
-
[create port forwarding rule for that port in router]
VS Code integration
-
Install the extension “PlantUML”.
-
Go to the extension settings and make the following changes:
-
Renderer: “PlantUMLServer”
-
Server: “http://localhost:8123” (or another server URL).
Open a new file and add a PlantUML script. Open the preview windows by pressingAlt + D
.Notepad++ integration
-
install java
-
move UDL to folder for import
-
%AppData%\Notepad++\userDefineLangs
-
restart notepad++
-
create plantuml.bat
-
menu execute –> run external program insert cmd PathToYour\PlantUML\plantuml.bat “$(FULL_CURRENT_PATH)”
content of plantuml.bat
@echo off java -jar Z:\plantUML\plantuml.jar -charset UTF-8 -o "C:\Users\ae\Pictures" %1
-
kb/common/plantuml.txt · Last modified: 2023/07/12 13:50 by alexander.elbert