Шаблон Template.uml

Template.uml — это шаблон UML для визуализации процессов в AutoDoc. Шаблон содержит два специальных тега:

{processname} — вставка названия процесса.
{processbody} — вставка описания схемы.

Эти теги используются AutoDoc для автоматического заполнения данных о процессе и его структуре при генерации документации.

По умолчанию рендеринг схем происходит удаленно с помощью сервера PlantUML. Если интернет-соединение недоступно, можно выполнить локальный рендеринг с помощью параметра -local в командной строке. В этом случае рендеринг всегда будет выполняться локально.

Для успешного локального рендеринга необходимо:

Установить Java Development Kit (JDK).
Установить переменную среды JAVA_HOME (желательно, чтобы путь не содержал пробелов).
Убедиться, что в папке с программой находится файл plantuml.jar (~ 11 МБ), который входит в пакет установки версии 1.24.10.X.

Пример использования Template.uml:

Template.uml


@startuml
!pragma useVerticalIf on
skinparam ArrowHeadColor none
skinparam backgroundColor transparent
floating note: {processname}
start
:{processbody};
stop
@enduml

UIControlsTest.uml


@startuml
!pragma useVerticalIf on
skinparam ArrowHeadColor none
skinparam backgroundColor transparent
floating note: UIControlsTest
start
:Присутствие элемента;
while (Цикл ForEachInControls)
:Клик мышью;
:Ожидание;
:Эмуляция спецкнопки("ENTER");
endwhile
stop
@enduml

Результат рендеринга UIControlsTest.uml

На изображении выше показан пример схемы, созданной с помощью Template.uml, с использованием тегов для отображения названия и содержимого процесса. Эти блоки кода созданы для PlantUML и включают директивы для управления стилем, а также определяют процесс с циклом и действиями.