PlantUML mit Notepad++

JAR vom PlantUML lokal speichern. Im Menü „Sprachen“ vom Notepad++ über „Eigene Sprache definierten…“ die Definition (UDL) importieren. Neue Datei mit Endung „puml“ abspeichern. Die Batch-Datei „pantuml.bat“ zum JAR mit dem Namen „PlantUML“ anlegen.

@echo off
java -jar C:\PlantUML\plantuml.jar -charset UTF-8 %1

Im Menü „Ausführen“ über den Punkt „Externes Programm ausführen…“ den Befehl C:\PlantUML\plantuml.bat "$(FULL_CURRENT_PATH)" hinterlegen/starten.

UML (be)schreiben

Mit PlantUML kann man eine Vielzahl verschiedener Diagrammentypen beschreiben. Die Deklaration kann beispielsweise in JavaDoc oder in MediaWiki eingebettet werden. Aus Bob->Alice : hello macht PlantUML folgendes Diagramm:

Im JavaDoc werden Diagrammbeschreibungen mit @startuml dateiname.png eingeleitet und mit @enduml beendet. Per Ant-Skript werden die JavaDoc-Diagramme mit folgendem target übersetzt.

<target name="plantuml" description="erzeugt die Diagramme mit PlantUML">
   <taskdef name="plantuml" classname="net.sourceforge.plantuml.ant.PlantUmlTask" classpath="/home/jenkins/libs/plantuml.jar"/>
   <property name="PLANTUML_PATH" value="/home/jenkins/plantuml"/>
   <delete dir="${PLANTUML_PATH}" />
   <mkdir dir="${PLANTUML_PATH}" />
   <plantuml output="${PLANTUML_PATH}" checkonly="false" verbose="false">
       <fileset dir="${JENKINS_JOBS}">
           <include name="**/workspace/src/**/*.java" />
       </fileset>
   </plantuml>
</target>