Edit Operations Reference

The changeset vocabulary: operations, selectors, placement, flags, results and, where the app has them, lint findings.

Applies To

livediagram, livedocuments and livehuddle

Two Forms

The line form is one operation a line, which is what an agent writes most easily. Values with spaces are quoted (label="Sign in"), and blank lines and lines starting with # are skipped:

The JSON form is one object an operation, which is what a script produces. Any line of the text form that starts with { is read as JSON, so the two mix:

One parser turns the line form into the JSON form, so both are checked the same way. A changeset holds at most 500 operations, and a line at most 16,384 characters.

Operations

A few rules hold for every operation:

Selectors

A selector picks the elements an operation acts on. It is a ref, a quoted label, or key:value terms joined by spaces, every one of which must match:

Placement

Without a placement, a new element goes beside the last one added, or to the right of everything. A spot already taken moves along the placement's direction until it is free. In the JSON form a placement is { "rel": "below", "ref": "n2", "gap": 40 } or { "rel": "at", "x": 0, "y": 200 }, and by=dx,dy is "by": [dx, dy].

What you did not ask to change stays put. set moves nothing except a box that grows around its centre to fit a longer label (reported). Only layout and a whole-tab replace lay out many elements, and only the ones they name.

Flags

The Answer

Refusals

A refused changeset applies nothing. It names the operation, the code and the way out. Lines that do not parse are all reported together (up to ten), so a batch of typos is fixed in one round:

Was this article helpful?

Still need help?

Try Troubleshooting, or tell us what you were trying to do.

Contact us