Skip to content
ScriptoriumDocumentation
English
Download

Annotations

An annotation is a note to yourself about a specific paragraph: “cliché, rewrite”, “check this against the timeline”, “does she know this yet?”. It stays attached to those words while you keep working. Tick it off when you have dealt with it.

Annotations work the same way everywhere there is prose: manuscript sections, notes, and an entity’s description.

Open the paragraph’s  drag-handle menu and choose  Add a comment. The right panel opens on an empty remark, with the paragraph it is about named at the top. Type the remark and click Save, or press ModEnter. Cancel, Escape and  all leave without writing anything.

From the keyboard, ModShiftM comments on the paragraph the cursor is in.

Saving files the remark and takes you back to the Annotations list for the document, with the new thread on it. Your cursor stays exactly where you left it in the paragraph.

An amber  appears in the paragraph’s right margin. The text itself looks unchanged.

Once a paragraph carries an annotation, an amber stays in its right margin. Click it to open the Annotations list in the right panel, scrolled to the thread for that paragraph. Show comment, which replaces Add a comment in the paragraph’s menu, does the same thing.

To reply to the remark, resolve it or delete it, use the thread in the panel.

Open the right panel and choose  Annotations. It lists every thread on the document you are looking at, oldest first. Each shows the passage it is about above the remarks written on it.

From a thread you can:

  •  Find: scroll the document to the passage the remark is about. Handy in a long chapter, where the passage may be several screens away. It doesn’t appear on a detached thread, since there is no longer any text to scroll to.
  •  Edit the remark.
  • Resolved: tick the box to retire the thread without losing it. Untick it to bring it back.
  •  Delete: removes the thread, its remark, and the amber marker beside the paragraph. This one is permanent.

Clicking a thread highlights it. Clicking a paragraph’s amber  scrolls the panel to its thread.

Ticking Resolved takes the amber  out of the paragraph’s margin. A chapter you have worked through stops being dotted with marks for remarks you have already dealt with.

The thread itself is kept. It moves behind the Show resolved checkbox at the top of the panel, and unticking Resolved puts the marker back.  Find still works on a resolved thread. That is how you get back to a passage whose mark is no longer visible.

If you delete the words an annotation was attached to, the remark is not deleted with them. The thread stays in the panel, marked Detached, still showing the passage it used to be about.

This is deliberate. The remark is something you wrote, and deleting a sentence should not silently throw away the thought you had about it. If the deletion was a mistake, undo puts the text back and the thread re-attaches itself.

A detached thread can be resolved or deleted like any other once you have dealt with it.

Annotations are part of your project. They are included in workspace archives and travel with a project when you duplicate it.

Because they are excluded from every export, the archive is the only copy. Keep that in mind if you rely on annotations heavily and back up rarely.