Kindly EditDocumentationTry the editor

docs-links.js

Where each editor tool is documented: the map behind the ? help buttons in the inspector and panels.

Responsibility#

Maps each editor tool to its page of this guide, for the ? help buttons beside settings group titles, the selected thing's name and the editor's other panels. KindlyDocs.group(title) returns the page for a group title (matched in the editor's language), KindlyDocs.selection(el, kind) the page for a selected element or kind of thing, and KindlyDocs.panel(name) the page for Structure, History, Search & sharing, Elements or the add pickers. KindlyDocs.paths() lists every page the map can open; the plugin's tests/docs-help-browser.mjs confirms each one exists in the built guide.

The guide's root comes from CantataEdit.docsUrl (see help). When it is empty the editor shows no help buttons.

File characteristics#

  • Source: assets/docs-links.js
  • Lines in this release: 132
  • Type: browser JavaScript

Integration and verification#

Loaded before editor.js, only for people editing. When a guide page is added, renamed or removed, update this map and run the plugin's docs help browser test with DOCS_SITE pointed at the built site/docs. Editor-only UI should not become authored page content. See The visual inspector for where the buttons appear.

About this page

Documents Kindly Edit 0.9.16. Source: assets/docs-links.js. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.