Skip to content

echoma/text_sequence_diagram

Repository files navigation

Text Sequence Diagram

A cross platform tool for drawing UML sequence diagram in simple text.

Pre-built Executables Download

Download page: Download

Latest release date: 2017-09-07

Online Version

You can also goto http://echoma.github.io/text_sequence_diagram/ for an online web-app.

This online version can not export diagram image as pre-built executables.

Snapshot

main_ui

render_ui

Features

  • Simple pure text syntax to draw beautiful sequence diagram.
  • Export diagram image to local file.
  • Save/open diagram source text to/from local file. Drag and drop supported for opening file.
  • Cross platform, given by nw.js and HTML5.
  • Adjust the diagram view size and zoom ratio as you wish.
  • You can integrate the "text to diagram" library to your own application. See example_integeration.html for an very simple example.

Syntax

  • Title and Author and so on
Title @ v1.0 @ 20160415 @ Author
Title @ @ @ Author
  • Message
From Object -> To Object : Message Content
  • Return Message
From Object --> To Object : Message Content
  • Self Message
Object : Message Content
  • Bottom Description
[ Bottom Description Line 1 ]
[ Bottom Description Line 2 ]
  • Comment
# Comment Line
# Another Comment Line
  • Example:
Conn Server -> Safe Domain GW : single order request
Safe Domain GW -> Trade Gateway : authenticated
Trade Gateway -> Logic Control : internal protocol
Logic Control --> Trade Gateway : success response
Trade Gateway --> Safe Domain GW : success response
Safe Domain GW --> Conn Server : response

Adavanced Syntax

Thanks to @Phy25

  • Self Message with dash link
Object :: Message Content
  • Continuous life-line

In the text, add ^ before the broker object.

As the following example shows, watch the ^ before A in the 4th line.

A -> B: msg-1
B -> C: msg-2
C -> B: msg-3
B -> ^A: msg-4

adv

About

Cross platform tool which convert text into beautiful sequence diagram. Online version: http://echoma.github.io/text_sequence_diagram/

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published