Kindly EditDocumentationTry the editor

Turn on Developer mode

Who can switch modes, where the setting is stored, and what happens to unsaved changes.

Watch the video

Chapters and transcript Captions are included.

Reference#

  • Open the editor (Edit this page), choose ⋯, then Developer mode. It's a toggle: the item shows as pressed while it's on.
  • The editor opens again in the other mode. With unsaved changes it asks first: Save draft and switch, Switch without saving or Cancel. After the reload a note says which mode you're in.
  • In Developer mode the first click on words, a button or a link selects it and shows its spacing bars and size corner on the page; a second click types (0.9.15). Simple mode keeps one click to type. See Selection and Spacing on the page.
  • The switch is per person (user meta cantata_edit_dev) and off by default. Switching it on never changes what a client sees.
  • By default only administrators (manage_options) get the switch. The capability can be changed with the cantata_edit_developer_mode_cap filter.
  • In PHP, cantata_edit_can_dev( $user_id ) says whether someone may switch, and cantata_edit_is_dev_mode( $user_id ) whether they're in it. A browser's cantata_edit_mode cookie overrides the user meta for people allowed to switch. The test kit uses it (run.mjs --dev), so parallel runs never change each other's mode. The switch itself posts to cantata-edit/v1/mode. In editor.js, isDev() is the one test, and the editor's layer carries .is-dev or .is-simple. The editor config has C.dev and C.can.dev.

The ⋯ menu also has How to edit this page, in both modes: the client guide (Pages → How to edit, C.helpUrl) in a new tab. Point clients to it.

About this page

Documents Kindly Edit 0.9.16. Source: docs/DEVELOPER.md, assets/editor.js. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.