Краткое руководство по PlantUML

Для тех, кто заинтересован в первоначальном изучении PlantUML, мы рекомендуем использовать онлайн-платформу, которая напрямую поддерживает PlantUML.

Изучите его на нашем онлайн-сервере.

Local Installation Procedure

After trying the online version, if you're considering a more comprehensive local environment, a local installation of PlantUML is suggested. Before installation, ensure the following prerequisites are met:

Java: PlantUML requires Java to be installed on your machine.

GraphViz: Needed only for some diagrams.

Once ready, download the plantuml.jar file and execute it to access PlantUML’s graphical user interface. No further unpacking or installation procedures are needed.

Command Line Operations

For those familiar with command line interfaces or intending to integrate PlantUML with scripting or documentation platforms, PlantUML offers a convenient command line syntax. Follow these steps:

1.Compose a Text File: Document your PlantUML commands. Here's a sample sequenceDiagram.txt:

@startuml
Alice -> Bob: test
@enduml

2.Execute the File: Process the aforementioned text file:

java -jar plantuml.jar sequenceDiagram.txt

3.Alternative: Launch the Graphical User Interface and select the directory that contains the text files:

java -jar plantuml.jar -gui

Upon execution, a sequenceDiagram.png containing the sequence diagram will be generated.

Explore PlantUML to further your diagramming capabilities.

Использование Docker

Использование Docker для тестирования PlantUML обеспечивает изолированную среду, не требуя непосредственной установки PlantUML или его зависимостей на вашу машину.

Инструкции

  1. Извлеките образ PlantUML из Docker

Официальный образ Docker для PlantUML доступен на Docker Hub.

docker pull plantuml/plantuml-server:jetty

Эта команда извлекает образ сервера PlantUML, используя Jetty в качестве сервера.

2. Запуск контейнера сервера PlantUML

После загрузки образа вы можете запустить контейнер на основе этого образа.

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

Эта команда выполняет следующие действия:

3. Доступ к серверу PlantUML

После запуска контейнера вы можете получить доступ к серверу PlantUML в браузере по адресу http://localhost:8080/.

Вы должны увидеть пользовательский интерфейс сервера PlantUML, который позволяет вводить код PlantUML и видеть визуальное представление на лету.

4 тестирование кода PlantUML

В интерфейсе сервера PlantUML:

5. Остановка контейнера (по завершении)

Когда вы закончите тестирование диаграмм PlantUML, вы можете захотеть остановить запущенный контейнер Docker. Сначала определите идентификатор контейнера:

docker ps

Эта команда выводит список всех запущенных контейнеров. Найдите в списке изображение plantuml/plantuml-server:jetty и запишите ID контейнера.

Теперь можно остановить контейнер:

docker stop [CONTAINER_ID]

Замените [CONTAINER_ID] на идентификатор запущенного контейнера PlantUML.

6. Удаление контейнера (необязательно)

Если вы хотите удалить контейнер полностью:

docker rm [CONTAINER_ID]

Эта команда удалит остановленный контейнер с вашей машины.

PlantUML Integration Capabilities

Over the years (since 2009!), the tool has been integrated with a variety of platforms and tools, offering users flexibility and ease of use.

Here's a summary of PlantUML's integration capabilities.

PlantUML Language Reference Guide

For an in-depth understanding of PlantUML, the PlantUML Language Reference Guide is available.

This guide provides comprehensive insights into the language, from basic syntax to advanced techniques. It's a valuable resource for all users. Acquire your copy and expand your diagramming knowledge.