Wiki source code of BlockNote Editor
Last modified by Vincent Massol on 2026/07/28 22:13
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | BlockNote is a WYSIWYG editor built on the [[BlockNote>>https://www.blocknotejs.org/]] JavaScript library, offered as an alternative to the default WYSIWYG editor. Its content is a list of blocks that can be reordered by dragging them, and content other than text is added through the "slash menu" or the formatting toolbar rather than through a permanent menu bar. | ||
| 2 | |||
| 3 | {{warning}} | ||
| 4 | The [[BlockNote Integration>>extensions:Extension.BlockNote Integration.WebHome]] extension is in early stages of development. Its behavior and its user interface are expected to change, so use it with care. | ||
| 5 | {{/warning}} | ||
| 6 | |||
| 7 | == Editing Modes == | ||
| 8 | |||
| 9 | Two modes are offered, and both appear in the dropdown of the "Edit" button. "BlockNote (Inplace)" keeps you on the Page you are reading, which suits short changes. "BlockNote (Standalone)" opens a dedicated edit Page with separate title and content fields, which suits longer rewrites. | ||
| 10 | |||
| 11 | == Availability == | ||
| 12 | |||
| 13 | BlockNote is not part of the default XWiki Standard distribution: an administrator has to install the [[BlockNote Integration>>extensions:Extension.BlockNote Integration.WebHome]] extension before the editor becomes available. | ||
| 14 | |||
| 15 | Once it is installed, the two entries appear in the "Edit" dropdown only for [[advanced users>>xwiki:documentation.xs.user.base.page.edit-page.simple-advanced.WebHome]], only on Pages whose Syntax the WYSIWYG editor supports, and only while BlockNote is not already configured as the default WYSIWYG content editor. "BlockNote (Inplace)" additionally requires in-place editing to be enabled on the wiki. On a Page whose Syntax is not supported, a plain text area is shown instead. | ||
| 16 | |||
| 17 | == Realtime Collaboration == | ||
| 18 | |||
| 19 | Several users can edit the same content at the same time and see each other's changes as they are typed. Undo and redo apply to your own changes only, so undoing never reverts what somebody else wrote. | ||
| 20 | |||
| 21 | == Current Limitations == | ||
| 22 | |||
| 23 | * After you insert or modify a Macro, the editor shows a Macro placeholder instead of the refreshed Macro output. The output is displayed again the next time the editor loads the content. | ||
| 24 | * The button that creates a link is not offered while a Macro is selected. | ||
| 25 | * A [[link>>documentation.xs.user.base.page.edit-page.blocknote-editor.insert-link.WebHome]] target and an [[image>>documentation.xs.user.base.page.edit-page.blocknote-editor.insert-image.WebHome]] are designated by typing their address in full: the fields do not suggest the Pages and Attachments of the wiki. {{version since="18.7.0RC1"}}The fields suggest the matching Pages and Attachments as you type.{{/version}} |
