Отрисовка Pluntuml в программе AsciidocFX
Базовая структура:
[plantuml, имя_файла_изображения, формат]
....
@startuml
' Ваш код PlantUML здесь
Alice -> Bob: Привет!
Bob --> Alice: Привет!
@enduml
....
plantuml (обязательно): Указывает процессору, что это диаграмма PlantUML.
имя_файла_изображения (опционально): Имя, под которым будет сохранен сгенерированный файл изображения (без расширения).
формат (опционально): Формат итогового изображения. Основные варианты:
- png (по умолчанию)
- svg
- txt (текстовое представление, а не картинка)
В процессе работы в каталоге создается временная папка
/image куда складываются картинки диаграмм
Важно: при работе c git, нужно прописать папку с временными файлами диаграмм в gitignore
Подключение отдельного файла.
plantuml::путь/к/файлу/my_diagram.puml[format=svg, title="Моя диаграмма"]
Проверка синтаксиса PlantUML
- скопируйте код из блока @startuml...@enduml на сайт plantuml.com в онлайн-редактор
Пример:
[plantuml, sequence_diagram_example, svg]
....
@startuml
actor Пользователь
participant "Веб-сервер" as WS
database БазаДанных
Пользователь -> WS: Отправляет запрос
WS -> БазаДанных: Запрашивает данные
БазаДанных --> WS: Возвращает данные
WS --> Пользователь: Отображает результат
@enduml
....
Важно: после @enduml должно быть 4 точки.
Заметка: Для AstraLinux 1.7 лучше использовать вывод временных файлов диаграмм в png
