UML Diagrams

Graphyte implements support for UML specification files by leveraging the great PlantUML tool. PlantUML is widely used in IT for a variety of applications, from creating live diagrams while extracting requirements from a customer, to creating specifications for a design, representations of software components or creating charts of any kind.

At the time of this writing, the following UML diagrams are supported by PlantUML:

• Sequence diagram
• Usecase diagram
• Class diagram
• Activity diagram
• Component diagram
• State diagram
• Object diagram
• Deployment diagram
• Timing diagram

On each of the links above, the PlantUML folks guide you through the creation of each type of diagram. It´s worth taking a look at the possibilities.

Once you have your first UML specification ready, you can test it online on PlantUML Web Server. Or, if you prefer, you can download PlantUML and work offline.

Creating UML diagrams for Graphyte

Use the plain text editor of your choice to create the UML file with your diagram's specification, following the guides on PlantUML website.

In order to link an element of your diagram to a specific input template, follow the format described in Using Hyperlinks with PlantUML.

In the following example, graphyte will load the user created template request.txt in the viewer area when clicking on the "Request" text, and will load the template response.txt when it detects a click on the "Response" text in the diagram.

(see also: Supported Link Types section)

Choose the name of your UML file carefully, it will later become the name of the module. The file must keep its .uml extension.