Next: , Previous: , Up: Starting and quitting stand-off mode   [Contents]


2.1 Activating stand-off mode

Command: standoff-mode

Activate standoff mode for the file displayed in the current buffer.

After opening a file, standoff mode can be activated by M-x standoff-mode RET. See Stand-Off mode for files of a specific type, to configure Emacs to always open files with a specific suffix in standoff mode.

In standoff mode, the buffer is read-only. This absolutely makes sense, because the external markup references spans of the source document by character offsets. Modifying the source document would break these character offsets.

If standoff mode is active, “Stand-Off” shows up in the modeline and the menu ‘Stand-Off’ is present (not present if minibuffer is active).

Right after activating, standoff mode tries to load existing annotations. Depending on the back-end, standoff mode loads the annotations of a file in the same directory and with the same file name as the source document, but with the additional suffix .json (JSON file back-end), or .dump.el (dummy back-end). See Back-Ends.

Be aware, that a back-end has to be configured, before standoff mode is ready to be used.