DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:etherpadlite

EtherpadLite Plugin

Compatible with DokuWiki

at least 2012-10-13 Adora Belle

plugin This plugins integrates Etherpad-Lite into DokuWiki. You get a pad-icon next to the ace-icon to switch a page into the pad-mode, which permits other users to write into that pad too when being presented the locked-page. There are also replacement functions that enable the toolbar to work with the pad, too. This plugin integrates well with the ace plugin.

Last updated on
2017-02-20
Provides
Action
Repository
Source
By mbr

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Configuration and Settings

Use the plugin manager to configure the plugin. Say you have your pad available at http://pad.example.org/pad/ and your dokuwiki installation at http://wiki.example.org/.

Then you will put 'example.org' into the etherpadlite_domain item, 'http://pad.example.org/pad/' into etherpadlite_url, the API-Key configured with Etherpad-Lite into etherpadlite_apikey. The APIKEY ist generated by etherpad lite on its first start and then writting into APIKEY.txt, from where you'll need to copy&paste it. A random string can be put into etherpadlite_group, as this is the group used in your Etherpad Lite installation to manage permissions - the actual permissions per page and user are derived from the dokuwiki acl.

I recommend the following etherpad lite settings:

  • “requireSession” : true,
  • “editOnly” : true,

This makes sure, that all user have to be authorized by the dokuwiki plugin and can only edit pad managed by the dokuwiki plugin, so they always map to a wiki page.

For better integration (i.e. make the toolbar work), you need the https://github.com/michael-dev/ep_iframeinsert plugin installed with your etherpad lite server.

Usage

The wikipage as to be created (saved) before you can edit it using a pad.

If muliple users want to edit a page in parallel, the first starts a pad by clicking on the pad icon on the right hand side below the edit field. The others then get automatically redirected to the pad when opening the “edit”-page of the pad. When the user who started the pad closes it, it actually gets deleted so he should save the content.

There is at most one pad per page-revision, so if the pad owner dies by accident and does not close the pad, you can just create a new page revision and continue working (in a new pad, of course).

The owner can set a password required to join the pad. He himself can reset it even if he has lost it!

Change Log

Known Bugs and Issues

  • you cannot transfer the ownership of the pad without stopping and resuming editing
  • possibly not compatible with new dokuwiki template
plugin/etherpadlite.txt · Last modified: 2017-03-21 22:15 by 93.209.4.239