Template.uml Template

Template.uml is a UML template for visualizing processes in AutoDoc.

The template contains two special tags:

{processname} — insertion of the process name.
{processbody} — insertion of the schema description.

These tags are used by AutoDoc to automatically populate process data and its structure when generating documentation.

By default, schema rendering occurs remotely using the PlantUML server. If an internet connection is unavailable, local rendering can be performed using the -local parameter in the command line. In this case, rendering will always be performed locally.

For successful local rendering, the following is required:

Install Java Development Kit (JDK).
Set the JAVA_HOME environment variable (preferably, the path should not contain spaces).
Ensure that the plantuml.jar file (~ 11 MB), which is included in the installation package version 1.24.10.X, is located in the program folder.

Example of Template.uml usage

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
:Element presence;
while (ForEachInControls Loop)
:Mouse click;
:Waiting;
:Special button emulation("ENTER");
endwhile
stop
@enduml

alt

The image above shows an example of a schema created using Template.uml, using tags to display the process name and content.
These code blocks are created for PlantUML and include directives for style management, as well as define a process with a loop and actions.