Roughout Help

← Back to editor

Roughout supports four diagram types:
type: flowchart for step-by-step processes and decisions,
type: sequence for messages passing between participants over time,
type: gantt for project planning, i.e. tasks against a calendar timeline,
type: mindmap for a central topic with branches radiating outward.

Philosophy

Focus and Error highlighting

Don't panic! It's just text. You can (and should) save multiple version copies as you go when you are drawing more complicated diagrams.

To help you, we have focus and error highlighting

Flowchart diagram format

type: flowchart (the default) — step-by-step processes and decisions. The only one of the four with mouse editing: click to select, drag to move, right-click to create.

Start simple

box 1
box 2
A plain text line is just a box label. Subsequent lines are auto-connected by arrows

Comments

// a note to yourself
Ignored entirely — whole line only, no trailing // on other lines

Variety of box shapes

box "label"
Rectangle
rbox "label"
Rounded rectangle
bbox / rrbox "label"
Double border (box / rounded box)
diamond "label"
Decision point
text "label"
Plain label, no border
  • box "label" #id the #id is optional — add it when you need to reference this shape from a connector, a group, or a mouse-driven edit.
  • spacer or spacer:N as the last thing on a shape's own line adds extra breathing room around just that shape; useful when printing across multiple pages.

Connectors

Connecting arrows are automatic, or for more control you can give your boxes #id values (eg #myboxid1) and use them as references

Box label 1 -> Box label 2
You can chain many simple boxes (or ids)
#A -> #B
Arrow
#A --> #B
Dashed arrow
#A ->> #B
Arrow with emphasis (e.g. urgency)
#A <-> #B
Points both ways
#A -> #B: label
Add a label to any connector (note the : after the target box!)
#A -> #B: label from:bottom to:top
Choose which edge it leaves and enters — top / right / bottom / left — e.g. to route around another box
  • Trailing tokens, any order, all optional, separated by spaces or commas: flow:right / flow:down overrides the diagram's default direction for just this one connector; line:elbow routes it with a right-angle bend instead of straight; from:<edge> / to:<edge> (top/right/bottom/left) pins exactly which edge it exits/enters; spacer or spacer:N adds extra room around it.

Shortcuts — no mouse needed

A->B->C
Quick chain — boxes are created for you
  • Just type a line of text, then another. Each line becomes a box, connected in order to the one before it.
  • Starting a second, separate flow? A leading \ on that line (e.g. \Alternative start) stops it inheriting a connector from whatever came before — a fresh root, not linked to the previous flow.
  • Want to branch off one of those lines instead of continuing straight down the list? Hit Expand (⌘E / Ctrl+E) to give every line an #id, then add a #id -> #id connector wherever you want a different flow.

Layout — whole diagram

flow: right
New boxes are placed left to right (default)
flow: down
New boxes are placed top to bottom
  • Both are also available as a toolbar toggle — it edits this same line for you. A single connector can override this for just itself — see Connectors above.

Title and footer — whole diagram

title My Diagram, align:left
left / centre / right — defaults to centre
(center also accepted)
footer: Version 1.2 — printed [date]
Export-only — never shown in the live editor
  • title:My Diagram (colon) also works, first one wins. Every shape shifts down to make room — nothing about their own position is changed.
  • footer only appears in an exported PNG/PDF, bottom-left, small and light. [date] anywhere in the text becomes today's date (d-mmm-yyyy) at export time.

Groups — a labeled subset of shapes

group "Label" #gid
Start a labeled boundary
endgroup #gid
Close it
  • Everything between the two lines parses completely normally — a group is just a visual boundary drawn around them. A group's own #id can be used as a connector endpoint, same as any shape.

Styles — define once, whole diagram; apply per box

Use the status: keyword to define a named, reusable appearance.

status:done text:strikethrough border:grey fill:tint
Defines the 'done' appearance
box "..." #id status:done
Apply a named style to a shape
box "..." #id border:red text:italic fill:pastel
For one-off styling, just add border/text/fill instructions to a line.
  • border: green / blue / orange / red / grey / purple / yellow / teal / pink / indigo ("gray" also accepted). text: strikethrough / bold / italic — combine with commas, e.g. text:bold,italic. fill: none / tint / pastel — see its own section below.
  • A shape's own border:/text:/fill: always wins over its status's version, property by property — set both if you want a status's look with one thing overridden.
  • Also settable from the inspector panel's Status field, once at least one status is defined.

Fill — wash a shape's own colour into its background

fill:tint
Diagram-wide default — subtle wash (~12%) of each shape's own border/status colour
fill:pastel
Same idea, stronger (~28%)
box "..." #id border:red fill:pastel
One shape's own fill: overrides the diagram's default for just that shape
  • Diagram-wide fill: defaults to none — every existing diagram looks the same until you opt in. Only ever visible on a shape that already has a border:/status: colour; an uncoloured shape is unaffected regardless.
  • A shape (or its status) can set its own fill: too — same override-wins precedent as border:/text:, including overriding down to fill:none on a diagram that otherwise defaults to tint/pastel.