DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== prosemirror Plugin ======

---- plugin ----
description: A WYSIWYG editor for DokuWiki
author     : Andreas Gohr, Michael Große
email      : dokuwiki@cosmocode.de 
type       : action
lastupdate : 2019-08-21
compatible : Greebo
depends    : 
conflicts  : codemirror, ckgedit
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/|{{ http://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:AJAX_CALL_UNKNOWN]]
  * [[devel:event:ACTION_HEADERS_SEND]]
  * [[devel:event:HTML_EDITFORM_OUTPUT]]
  * [[devel:event:ACTION_ACT_PREPROCESS]]
  * [[devel:event:DRAFT_SAVE]]
  * [[devel:event:TPL_ACT_RENDER]]

==== USER REQUESTS & COMMENTS ====

Really great plugin! It's already a must have, I really appreciate the approach compared to ckgedit ! The downside for us is the loss of paste image from clipboard (we're using https://www.dokuwiki.org/plugin:imgpaste), is there a chance to have imgpaste or similar in the roadmap ?
Thanks again for your work!

--- [[user>x.root|x.root]] //2019-11-29 10:48//

This is excellent, thank you Andrea and Michael.  Please consider:
  - Instead of the big yellow 'Toggle WYSIWYG Editor' rectangle, please consider a button on the editor toolbar, which should also make it more compatible with other good relevant plugins like FastWiki https://www.dokuwiki.org/plugin:fastwiki
  - In Extension Manager, the notice 'Update: New version 2018-10-19 is available.' remains after updating

--- dd //2018-10-22 04:22//

> Instead of the big yellow 'Toggle WYSIWYG Editor' rectangle, please consider a button on the editor toolbar, which should also make it more compatible with other good relevant plugins like FastWiki https://www.dokuwiki.org/plugin:fastwiki

I just added the following line to ''script.js'' and removed the styles of ''.plugin_prosemirror_useWYSIWYG'' from ''style.less'':

jQuery(".button.plugin_prosemirror_useWYSIWYG").appendTo("#wiki__editbar .editButtons");

--- [[user>teatall|teatall]] //2019-07-21 14:41//

Please fill all the letters into the box to prove you're human. K᠎ O G D U Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International