In an attempt to improve PlantUML documentation...
Wiki Toc Recent changes View page history Add new chapter Reorder page Raw
![]() |
![]() |
Anwendungsfall-DiagrammLet's have few examples : Note that you can disable the shadowing using theskinparam shadowing false command.
|
Use Case DiagramLet's have a few examples: |
AnwendungsfälleAnwendungsfälle sind von zwei Klammern eingeschossen (da zwei Klammern wie ein Oval aussehen). Alternativ kann man dasusecase Schlüsselwort verwenden, um einen Anwendungsfall zu definieren.
Außerdem ist es möglich, einen Alias mit dem as Schlüsselwort zu definieren. Dieser Alias wird dann verwendet
wenn die Beziehungen festgelegt werden.
|
UsecasesUse cases are enclosed using between parentheses (because two parentheses looks like an oval). You can also use theusecase keyword to define a
usecase.
And you can define an alias, using the as keyword.
This alias will be used later, when defining relations.
|
AkteureDie Namen von Akteuren werden von zwei Doppelpunkten umschlossen. Mann kann aber auch dasactor Schlüsselwort verwenden um einen Akteur zu definieren.
Außerdem ist es möglich, mit dem as Schlüsselwort einen Alias festzulegen. Dieser Alias wird dann später verwendet, wenn die Beziehungen festgelegt werden.
Wie wir sehen werden, ist die Definition eines Akteur nicht zwingend notwendig.
|
ActorsThe name defining an actor is enclosed between colons. You can also use theactor keyword to define an actor.
An alias can be assigned using the as keyword and can be used later instead of the actor's name, e. g. when defining relations.
You can see from the following examples, that the actor definitions are optional.
|
|
Change Actor styleYou can change the actor style from stick man (by default) to:
Stick man (by default)
Awesome man
[Ref. QA-10493] Hollow man
[Ref. PR#396] |
Beschreibung der AnwendungsfälleFalls sich eine Beschreibung über mehrere Zeilen ersterckt, kann diese mit Anführungsstrichen eingeschlossen werden. Außerdem kann man die folgenden Seperatoren verwenden:--
.. == __ .
Außerdem kann man Überschriften innerhalb der Seperatoren verwenden.
|
Usecases descriptionIf you want to have a description spanning several lines, you can use quotes. You can also use the following separators:
|
|
Use packageYou can use packages to group actors or use cases.
You can use rectangle to change the display of the package.
|
Einfaches BeispielUm Akteure und Anwendungsfälle miteinander zu verbinden wird der Pfeil--> verwendet
Je mehr Bindestriche - der Pfeil enthält, desto länger wird der Pfeil.
Mit einem Doppelpunkt : kann dem Pfeil eine Beschreibung
hinzugefügt werden.
In diesem Beispiel kann man sehen, wie ein vorher nicht deklarierter User
automatisch als Akteur deklariert wird.
|
Basic exampleTo link actors and use cases, the arrow--> is
used.
The more dashes - in the arrow, the longer the
arrow.
You can add a label on the arrow, by adding a :
character in the arrow definition.
In this example, you see that User has not been defined
before, and is used as an actor.
|
Erweiterungen / GeneralisierungenWenn ein Akteur oder Anwendungsfall einen anderen erweitert, dann kann dies mit dem Symbol<|-- .
|
ExtensionIf one actor/use case extends another one, you can use the symbol<|-- .
|
Verwenden von NotizenMit dennote left of , note right of ,
note top of , note bottom of Schlüsselwörtern kann man die Position der Notiz relativ zum Objekt festlegen.
Eine Notiz kann aber auch nur mit dem note Schlüsselwort erstellt werden und dann mit dem
.. Symbol den Objekten zugeordnet werden.
|
Using notesYou can use thenote left of , note right of ,
note top of , note bottom of keywords to
define notes related to a single object.
A note can be also define alone with the note
keywords, then linked to other objects using the .. symbol.
|
StereotypenStereotypen könne während der Erstellung der Akteure und der Anwendungsfälle mit den<< und >> Symbolen hinzugefügt werden .
|
StereotypesYou can add stereotypes while defining actors and use cases using<< and >> .
|
Ändern der PfeilrichtungenNormalerweise haben die Verbindungen zwischen den Klassen zwei Striche-- und werden senkrecht gezeichnet.
Es ist aber möglich waagerechte Verbindungen zu erstellen in dem man einen einzelnen Strich (oder Punkt) eingibt:
Sie können auch die Richtung der Verlinkung umkehren:
Die Richtung der Pfeile kann man durch das hinzufügen der left ,
right , up oder down Schlüsselworte im Pfeil bestimmen:
Man kann die Pfeile verkürzen, wenn man nur den ersten Buchstaben für die Richtung verwendet (zum Beispiel, -d- anstelle von -down- ) oder man nimmt die ersten beiden
Buchstaben (-do- ).
Diese Möglichkeit sollte aber nicht missbraucht werden: GraphViz
liefert normalerweise recht gute Ergebnisse, ohne das manuell eingeriffen werden muss.
|
Changing arrows directionBy default, links between classes have two dashes-- and are vertically oriented.
It is possible to use horizontal link by putting a single dash (or dot) like this:
You can also change directions by reversing the link:
It is also possible to change arrow direction by adding left , right , up
or down keywords inside the arrow:
You can shorten the arrow by using only the first character of the direction (for example, -d- instead of
-down- )
or the two first characters (-do- ).
Please note that you should not abuse this functionality : Graphviz gives usually good results without
tweaking.
And with the left to right direction parameter:
|
Aufteilen von Diagrammen auf mehrere SeitenMit dem Befehlnewpage kann das Diagramm auf mehrere Seiten oder Bilder verteilt werden.
|
Splitting diagramsThenewpage keywords to split your diagram into several pages or images.
|
Verändern der Richtung in der die Objekte angeordnet werdenDas voreingestellte verhalten bei der Erstellung des Diagramms ist von oben nach unten.
Dies lässt sich aber durch die Verwendung des
|
Left to right directionThe general default behavior when building diagram is top to bottom.
You may change to left to right using the
|
Der Skinparam-BefehlMit dem skinparam Befehl kann die Farbe und die Schriftart der Zeichnung verändert werden. Sie können den Befehl auf die folgenden Arten verwenden:
|
SkinparamYou can use the skinparam command to change colors and fonts for the drawing. You can use this command :
|
Vollständiges Beispiel
|
Complete example
|
|
Business Use CaseYou can add/ to make Business Use Case.
Business Usecase
Business Actor
[Ref. QA-12179] |
|
Change arrow color and style (inline style)You can change the color or style of individual arrows using the inline following notation:
[Ref. QA-3770 and QA-3816] [See similar feature on deployment-diagram or class diagram] |
|
Change element color and style (inline style)You can change the color or style of individual element using the following notation:
[Ref. QA-5340 and adapted from QA-6852] |