notation keyword - modelint/flatland-model-diagram-editor GitHub Wiki

The notation keyword selects the notation for your diagram type.

Syntax

notation <notation_name>

where <notation_type> is a name that may contain spaces.

Yep, you can change the notation of your diagram at the click of a button! (well, actually just by changing this value and executing the Flatland command, so maybe a handful of buttons)

Only xUML is supported for state machine diagrams. And both Starr and xUML will work for collaboration diagrams depending on how ugly you want them to look ;)

Example

notation xUML // Because your pointy haired manager insists on it

Function

Selects the notation to use when rendering your diagram. Be careful, since you can only use a notation that is supported for your diagram type.

Support

Flatland will offer built-in support for three different notations matched with four diagram types as follows:

• class diagrams: Starr, xUML and Shlaer-Mellor
• state machine diagrams: xUML
• collaboration diagrams: Starr, xUML
• domain diagrams: Starr, xUML

As you can see, there is only one notation available for state machine diagrams, but you have three choices for a class diagrams.

The Starr notation is a compact variation on Shlaer-Mellor. While Shlaer-Mellor was designed for ease of drawing on a whiteboard, Starr reduces clutter on a rendered diagram. And xUML keeps you in conformance with the Executable UML subset of the Object Management Group’s UML standard. These notations are built-in because that’s what Leon Starr uses ;)

User extension

Users will be able to edit a YAML template to define a notation compatible with a given diagram type.