La actual sintaxis para los diagramas de actividades tiene varias limitaciones e inconvenientes (por ejemplo, es difícil de mantener). Entonces, una implementación y sintaxis nueva propuesta como versión beta , es ofrecida a los usuarios (empezando con V7947), sólo así podremos definir un mejor formato y sintaxis. Otra ventaja de esta nueva implementación es que acaba con la necesidad de tener Graphviz instalado (como en los diagramas de secuencia). La nueva sintaxis reemplazará la anterior. Sin embargo, por razones de compatibilidad, la sintaxis vieja seguirá siendo reconocida, para asegurarse la retrocompatibilidad . Los usuarios están siendo motivados para migrarse a la nueva sintaxis.
Una Actividad simple
Las etiquetas de las actividades inician con un dos puntos (:) y terminan con un punto y coma (;). Se puede aplicar formato a un texto usando sintaxis de WikiCreole. Están implícitamente enlazados en el orden de su definición.
@startuml
:Hello world;
:This is on defined on
several **lines**;
@enduml
Start/Stop
Puedes usar las palabras reservadas start y stop para denotar el comienzo y el final del diagrama.
@startuml
start
:Hello world;
:This is on defined on
several **lines**;
stop
@enduml
También puedes usar la palabra reservada end.
@startuml
start
:Hello world;
:This is on defined on
several **lines**;
end
@enduml
Condicionales
Puedes usar las palabras reservadas if, then y else para colocar condiciones en tus diagramas. Las etiquetas pueden ser proporcionadas usando paréntesis.
@startuml
start
if (Graphviz installed?) then (yes)
:process all\ndiagrams;
else (no)
:process only
__sequence__ and __activity__ diagrams;
endif
stop
@enduml
Puedes usar la palabra reservada elseif para tener varias condiciones :
@startuml
start
if (condition A) then (yes)
:Text 1;
elseif (condition B) then (yes)
:Text 2;
stop
elseif (condition C) then (yes)
:Text 3;
elseif (condition D) then (yes)
:Text 4;
else (nothing)
:Text else;
endif
stop
@enduml
Conditional with stop on an action [kill, detach]
You can stop action on a if loop.
@startuml
if (condition?) then
:error;
stop
endif
#palegreen:action;
@enduml
But if you want to stop at an precise action, you can use the kill or detach keyword:
kill
@startuml
if (condition?) then
#pink:error;
kill
endif
#palegreen:action;
@enduml
It is also possible to use a full action as repeat target and insert an action in the return path using the backward keyword.
@startuml
start
repeat :foo as starting label;
:read data;
:generate diagrams;
backward:This is backward;
repeat while (more data?)
stop
@enduml
Break on a repeat loop [break]
You can break after an action on a loop.
@startuml
start
repeat
:Test something;
if (Something went wrong?) then (no)
#palegreen:OK;
break
endif
->NOK;
:Alert "Error with long text";
repeat while (Something went wrong with long text?) is (yes)
->no;
:Alert "Sucess";
stop
@enduml
You can use kill or detach to make an output split (multi-end):
@startuml
start
split
:A;
kill
split again
:B;
detach
split again
:C;
kill
end split
@enduml
@startuml
start
split
:A;
kill
split again
:b;
:c;
detach
split again
(Z)
detach
split again
end
split again
stop
end split
@enduml
Notas
Se puede aplicar formato a un texto usando sintaxis de WikiCreole. Una nota puede ser flotante, usando la palabra clave floating.
@startuml
start
:foo1;
floating note left: This is a note
:foo2;
note right
This note is on several
//lines// and can
contain <b>HTML</b>
====
* Calling the method ""foo()"" is prohibited
end note
stop
@enduml
Colores
Puedes especificar colores en algunas actividades.
@startuml
start
:starting progress;
#HotPink:reading configuration files
These files should edited at this point!;
#AAAAAA:ending of the process;
@enduml
Lines without arrows
You can use skinparam ArrowHeadColor none in order to connect activities using lines only, without arrows.
@startuml
skinparam ArrowHeadColor none
start
:Hello world;
:This is on defined on
several **lines**;
stop
@enduml
@startuml
skinparam ArrowHeadColor none
start
repeat :Enter data;
:Submit;
backward :Warning;
repeat while (Valid?) is (No) not (Yes)
stop
@enduml
Flechas
Usando la notación ->, puedes añadir texto a una flecha y cambiar su color. También es posible tener flechas punteadas, en linea discontinua, en negrita u ocultas.
@startuml
:foo1;
-> You can put text on arrows;
if (test) then
-[#blue]->
:foo2;
-[#green,dashed]-> The text can
also be on several lines
and **very** long...;
:foo3;
else
-[#black,dotted]->
:foo4;
endif
-[#gray,bold]->
:foo5;
@enduml
@startuml
start
:The connector below
wishes he was blue;
#blue:(B)
:This next connector
feels that she would
be better off green;
#green:(G)
stop
@enduml
Es posible remover una flecha usando la palabra reservada detach .
@startuml
:start;
fork
:foo1;
:foo2;
fork again
:foo3;
detach
endfork
if (foo4) then
:foo5;
detach
endif
:foo6;
detach
:foo7;
stop
@enduml
Otras formas de representación de actividades
Cambiando el sepador final, ; , puedes configurar diferentes representaciones para una actividad:
|
<
>
/
]
}
@startuml
:Ready;
:next(o)|
:Receiving;
split
:nak(i)<
:ack(o)>
split again
:ack(i)<
:next(o)
on several line|
:i := i + 1]
:ack(o)>
split again
:err(i)<
:nak(o)>
split again
:foo/
split again
:i > 5}
stop
end split
:finish;
@enduml
Un ejemplo completo
@startuml
start
:ClickServlet.handleRequest();
:new page;
if (Page.onSecurityCheck) then (true)
:Page.onInit();
if (isForward?) then (no)
:Process controls;
if (continue processing?) then (no)
stop
endif
if (isPost?) then (yes)
:Page.onPost();
else (no)
:Page.onGet();
endif
:Page.onRender();
endif
else (false)
endif
if (do redirect?) then (yes)
:redirect process;
else
if (do forward?) then (yes)
:Forward request;
else (no)
:Render page template;
endif
endif
stop
@enduml
Hitchhiker's Guide
