Skip to main content
Documentation

How to Read These Docs

The formatting conventions repeated across Spectralite's documentation, covering menu paths, UI labels, and keyboard shortcuts.

A few conventions repeat on every page. Knowing them makes each instruction quicker to follow.

UI labels and menu paths

Anything you click, type into, or read on screen appears in bold, spelled exactly as the app spells it. A button reads Add fixture, a panel reads the Timeline panel, a checkbox reads Leap Motion input enabled.

Menu paths use > between each level, so Edit > Outputs means open the Edit menu and choose Outputs, and Edit > Inputs > MIDI means open Edit, then the Inputs submenu, then MIDI. Follow the chain left to right.

Keyboard shortcuts

Shortcuts are written for the Mac, so a save shortcut appears as Cmd+S. Press the modifier together with the listed key.

Node Editor colors

In the Node Editor, the input and output sockets on a node, and the wires that connect them, are colored by data type. A number socket, a color socket, and a vector socket each carry their own color, and a wire takes the color of the socket it leaves. Two sockets connect only when their types match, so the colors are a quick check: a valid wire always joins two sockets of the same color. The data types page lists every type and its color.

Callouts

Highlighted boxes flag things worth pausing on. Two types appear throughout:

An info callout adds a tip or a useful detail; the task finishes without it.

A warning callout marks something that can lose work or produce a result you did not intend, such as an action that cannot be undone. Read these before you act.