File name:

Download

Contact

E-mail: jesper.b96@gmail.com

Github: https://github.com/JEPPSER

Specify the type of diagram

The type of diagram you want to make has to be specified at the very first line. To specify that you want to make a flowchart, write <flowchart> in the first line. Load the "Flowchart" example from the menu bar for reference.

Add an object to the diagram

There are a number of different objects that can be added to a flowchart:
Step, If, IOBox, Document, Start and End.
You can explore what the different objects look like by loading the "Flowchart" example.
An object is initialized by typing the name of the object followed by a space and a variable name.
(Variable names can be of any length.)

Example:
Step a
Document b

An object will only appear if it is connected to another object by an arrow.
(note: Each command must be separated by a new line)

Draw arrows between objects

To draw an arrow between two objects, two objects must have been initialized.
The operator for the arrow is [variable]->[variable]

Example:
Step a
IOBox b
a->b

"If" objects can only have one arrow for "yes" and one arrow for "no".
The arrow operator for If is therefore different from all the other objects.
The operator for If is [variable].yes=[variable] and [variable].no=[variable]

Set the text displayed in an object

Every object in a flowchart can display some text. The operator is [variable].text="some text"

Example:
Step a
a.text="Plug in lamp"
If b
b.text="Does lamp work?"

Object placement

When clicking the "Draw" button, an algorithm will place the different objects in the flowchart as well as it can. In most cases smaller flowcharts will look good and well distributed but sometimes you might want to change the placements on your own. This is simply done by dragging and dropping objects with the cursor. You can also change the appearance of the arrows by clicking them and creating new points. The arrow will then be drawn from point to point and create a path. These points can also be moved by dragging and dropping. To delete a point, simply right click on it.

To test changing object placement, simply load the "Flowchart" example from the menu bar and try changing the appearance of the flowchart in as many ways as you can.

Specify the type of diagram

The type of diagram you want to make has to be specified at the very first line. To specify that you want to make a use case diagram, write <usecase> in the first line. Load the "Use Case Diagram" example from the menu bar for reference.

Add an object to the diagram

There are three different objects that can be added to a use case diagram: Actor, UseCase and System.
You can explore what the different objects look like by loading the "Use Case Diagram" example.
An object is initialized by typing the name of the object followed by a space and a variable name.
(Variable names can be of any length.)

Example:
Actor a
UseCase b
System sys

(note: Each command must be separated by a new line)

Set the text displayed in an object

Every object in a use case diagram can display some text. The operator is [variable].text="some text"

Example:
Actor a
a.text="User"
UseCase b
b.text="Check in"

Add UseCases to System

A system is displayed as a square. The size and position of this square depends only on the placement of the use cases that it contains. The system will encapsulate all the use cases that it contains.
The operator for adding a UseCase to a System is [variable] add [variable] where the first variable is of type System and the second variable is of type UseCase.

Example:
System sys
UseCase u
sys add u

Draw line between Actor and UseCase

The operator for drawing a line between an Actor and a UseCase is [variable]->[variable] where the first variable is of type Actor and the second variable is of type UseCase.

Example:
Actor a
UseCase b
a->b

Draw extend and include arrows between UseCases

The operators for drawing include/extend arrows between two usecases are [variable] includes [variable]
and [variable] extends [variable] where both variables are of type UseCase.

Example:
UseCase a
UseCase b
UseCase c
a includes b
b extends c

Draw generalization arrow between Actors

The operator for drawing a generalization arrow between two Actors is [variable] implements [variable] where both variables are of type Actor.

Example:
Actor a
Actor b
a implements b

Object placement

When clicking the "Draw" button, an algorithm will place the different objects in the diagram as well as it can. In most cases smaller diagrams will look good and well distributed but sometimes you might want to change the placements on your own. This is simply done by dragging and dropping objects with the cursor.

To test changing object placement, simply load the "Use Case Diagram" example from the menu bar and try changing the appearance of the diagram in as many ways as you can.

Specify the type of diagram

The type of diagram you want to make has to be specified at the very first line. To specify that you want to make a DFA, write <dfa> in the first line. Load the "DFA" example from the menu bar for reference.

Add an object to the diagram

There are three different objects that can be added to a DFA: start state, normal state and end state. Syntax for start state is ->State, normal state is State, end state is (State). You can explore what the different objects look like by loading the "DFA" example.
An object is initialized by typing the name of the object followed by a space and a variable name.
(Variable names can be of any length.)

Example:
->State s1
State s2
(State) s3

(note: Each command must be separated by a new line)

Draw an arrow between two states (or to itself)

The operator for drawing an arrow is [variable]->[variable]: [text].
[text] is any text you want to display next to the arrow.

Example:
->State s1
State s2
(State) s3
s1->s2: a
s1->s3: b
s2->s2: a,c
s2->s3: b

Object placement

When clicking the "Draw" button, an algorithm will place the different objects in the diagram as well as it can. The algorithm will place all objects that are connected next to eachother and the distance between all objects will be big enough so no objects will overlap but you might want to change the placements on your own. This is simply done by dragging and dropping objects with the cursor.

You can bend arrows by clicking them to create new points that a curve will be drawn though. Move the points by clicking and dragging the red circle visible when hovering over the arrow. Arrows that go from and to the same object and looping arrows do not have this functionality. To remove the point and make the arrow staight again, simply right click on the red circle.

To test changing object placement, simply load the "DFA" example from the menu bar and try changing the appearance of the diagram in as many ways as you can.

Specify the type of diagram

The type of diagram you want to make has to be specified at the very first line. To specify that you want to make a class diagram, write <class> in the first line. Load the "Class Diagram" example from the menu bar for reference.

Add a class to the diagram

There are 3 different types of classes you can include in your class diagram: Class, Enum and Interface. To add a class to the diagram, type the name of the type of class followed by a space and a variable name. The variable name will be considered to be the class name and will be displayed at the top of the class.

Example:
Class Car
Enum FuelType
Interface Vehicle

(note: Each command must be separated by a new line)

Add a package to the diagram

Adding a package works similarly to adding a class. You type "Package" followed by a space and a variable name. The name of the package is the name of the variable unless you manually set the text. This is done by typing the variable name followed by .text="your package name". To add classes to the package, type the package name followed by " add " and the variable name of the class you want to add.

Example:
Package package
package.text="vehicle"
package add Car
package add FuelType

Add dependency

Vehicle-->Car

Add realization

Vehicle--|>Car

Add inheritance (generalization)

Vehicle-|>Car

Add association

Vehicle(0..*)-(1)Car

Add direct association

Vehicle(1)->(1)Car

Add aggregation

Vehicle(1..*)<>-(1)Car

Add Composition

Vehicle(1)<#>-(1..*)Car

Object placement

When clicking the "Draw" button, an algorithm will place the classes in the diagram as well as it can. You will probably want to change the placements on your own. This is simply done by dragging and dropping classes with the cursor. You can also change the appearance of the arrows by clicking them and creating new points. The arrow will then be drawn from point to point and create a path. These points can also be moved by dragging and dropping. To delete a point, simply right click on it.

To test changing class placements, simply load the "Class Diagram" example from the menu bar and try changing the appearance of the class diagram in as many ways as you can.

Export
Flowchart Use Case Diagram DFA Class Diagram
Help Contact