====== Prosemirror Plugin ======

---- plugin ----
description: A WYSIWYG editor for DokuWiki, usable but currently only in beta state
author     : Andreas Gohr, Michael Große
email      : dokuwiki@cosmocode.de 
type       : action
lastupdate : 2024-02-05
compatible : Jack Jackrum, Kaos
depends    : 
conflicts  : codemirror, ckgedit, note
similar    : ckgedit, fckg, wysiwyg
tags       : !experimental, wysiwyg, editor, editing

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-prosemirror/zipball/release
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-prosemirror/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-prosemirror/

screenshot_img :
----

[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ https://www.cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

This plugin implements a WYSIWYG editor. Unlike other WYSIWYG plugins, it does not repurpose a HTML editor but uses an editor component written specifically for DokuWiki utilizing the ProseMirror framework. You can learn more about the approach at [[https://wysiwyg.wiki.cosmocode.de/doku.php?id=en:why|Why a new WYSIWYG plugin?]].

The plugin is usable but in a **beta** state.

===== Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

===== Try it out =====

You can try out this plugin at [[https://wysiwyg.wiki.cosmocode.de/doku.php?id=:en:start|wysiwyg.wiki.cosmocode.de]].

===== Development =====

**[[https://wysiwyg.wiki.cosmocode.de/doku.php?id=en:contribute|How to help with Development]]**


  * Travis: [[https://travis-ci.org/cosmocode/dokuwiki-plugin-prosemirror|{{https://travis-ci.org/cosmocode/dokuwiki-plugin-prosemirror.png?branch=master&nocache}}]]
  * Scrutinizer: [[https://scrutinizer-ci.com/g/cosmocode/dokuwiki-plugin-prosemirror/|{{https://scrutinizer-ci.com/g/cosmocode/dokuwiki-plugin-prosemirror/badges/quality-score.png?b=master&nocache}}]]

==== Adding Plugin Support ====

Adding support for your syntax plugin is possible, but it is a complex endeavor. **Please work through the [[https://prosemirror.net/docs/guide/|Prosemirror Library Guide]] before attempting an integration.** After you have done this, please continue to the [[plugin:prosemirror:plugin_support|plugin support subpage]].

==== Commit-Ticker ====

{{rss>https://github.com/cosmocode/dokuwiki-plugin-prosemirror/commits/master.atom date}}

**Releases:**
{{rss>https://github.com/cosmocode/dokuwiki-plugin-prosemirror/releases.atom description author}}

==== Utilized DokuWiki Events ====

  * [[devel:event:ACTION_ACT_PREPROCESS]]
  * [[devel:event:ACTION_HEADERS_SEND]]
  * [[devel:event:AJAX_CALL_UNKNOWN]]
  * [[devel:event:DRAFT_SAVE]]
  * [[devel:event: FORM_EDIT_OUTPUT]]
  * [[devel:event:HTML_EDITFORM_OUTPUT]] (deprecated)
  * [[devel:event:TPL_ACT_RENDER]]


==== FAQ ====

  * __What is the purpose of the "plugin" button (drop down)?__: I mostly figured out all buttons on the toolbar of the Visual Editor. However, on the right end there is a "plugin" button with a drop down arrow on its right. clicking on it offers 2 options: "plugin block" and "plugin inline". I cannot figure out what these do (if anything).