From 4d1f0e6f81ea474d607fcb9b0d0a57e6f00515f7 Mon Sep 17 00:00:00 2001
From: Tom Limoncelli <tal@talair.home>
Date: Thu, 5 Dec 2013 11:38:00 -0500
Subject: [PATCH] Improve documentation
---
README.md | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index c6838e2..95f7d53 100644
--- a/README.md
+++ b/README.md
@@ -8,13 +8,15 @@ All documentation for this plugin can be found at https://github.com/michael-dev
What does it do?
----------------
-This dokuwiki plugin lets you edit your pages using an existing etherpad lite instance. Using an appropiate configuration of the etherpad lite server, the plugin will enforce dokuwiki acl permissions for pages onto the pads for editing the page and additionally lets you protect the pads using read and read-write passwords. Further, it integrates tightly with the dokuwiki toolbar so that most buttons will work the the etherpad lite editor as well.
+The dokuwikietherpadlite plugin lets you edit your pages using an existing etherpad lite instance. The plug-in uses etherpad lite's API to create a pad
+with the same ACL permissions as the page as well as lets you
+set read and read-write passwords. Further, it integrates tightly with the dokuwiki toolbar so that most buttons will work the the etherpad lite editor as well.
Benefits
--------
-* multiple persons can edit the same page at the same time
-* almost realtime backups of edits typed
+* multiple people can edit the same page at the same time
+* near-realtime backups of edits typed
* tight toolbar integration
* mapping of dokuwiki permissions
* extra password protection for read/readwrite pad access
@@ -22,22 +24,22 @@ Benefits
Usage
-----
-The user who is in (dokuwiki) "edit"-Mode can create a PAD to edit and save the content. Users in "lock"-Mode can join this PAD, but not save nor delete the PAD.
+When a user is in the Dokuwiki editor an additional button appears that moves the document into a Pad. While in the Pad they can edit and save the content. Other users that edit the page will go directly into the Pad for shared editing (without this plugin they would be given the "lock"-mode page). Only the first person can save and delete the Pad.
How does it work?
-----------------
The dokuwiki plugin adds javascript code to the edit page that hooks into the toolbar javascript and adds an extra pad-toogle icon just below the textedit field. This code obviously depends on the template used and has *not* been tested with the most recent dokuwiki default template. The dokuwiki plugin further adds an ajax handler that calls the etherpad lite api as needed and stores the pad details in the dokuwiki page metadata object.
-The etherpad lite gets its pads assigned to groups, group membership managed and pad passwords assigned by the dokuwiki plugin. Further, the dokuwiki plugin sets browser cookies to authorize the client to use the pad. The latter leads to some cross-domain requirements, though this could as well be fixed by adding extra code to etherpad lite.
+The etherpad lite gets its pads assigned to groups, group membership managed and pad passwords assigned by the dokuwiki plugin. Furthermore, the dokuwiki plugin sets browser cookies to authorize the client to use the pad. The latter leads to some cross-domain requirements, though this could as well be fixed by adding extra code to etherpad lite.
-The tight integration works using javascript cross-domain message posting, so it is more or less cross-domain independend. The dokuwiki plugin sends edit-messages (i.e. past text xx at current cursor) and the etherpad lite plugin receives and processes it. Therefore the etherpad lite plugin is just some javascript code loaded into the browser. Messages in the inverse directions are used to indicate the presence of the plugin. Please note that there currently is no synchronous messaging possible, so the dokuwiki javascript code cannot read the current selection from the pad.
+The tight integration works using javascript cross-domain message posting, so it is more or less cross-domain independend. The dokuwiki plugin sends edit-messages (i.e. paste text xx at current cursor) and the etherpad lite plugin receives and processes it. Therefore the etherpad lite plugin is just javascript code loaded into the browser. Messages in the inverse directions are used to indicate the presence of the plugin. Please note that there currently is no synchronous messaging possible, so the dokuwiki javascript code cannot read the current selection from the pad.
Installation
------------
### etherpad lite ###
-Please refer to the etherpad lite dokumentation for its installation steps and remember to use a production-ready backend.
+Install etherpad lite according to its documentation. It is recommended that you use a production-ready backend rather than the default (DirtyDB).
To ensure pad permissions and cleanup, I recommend the following etherpad lite settings. They ensure that only users authorized by the dokuwiki plugin can edit a pad and that there are only pads created using the dokuwiki plugin.
* "requireSession" : true,
@@ -73,17 +75,17 @@ Use https://github.com/michael-dev/dokuwikietherpadlite/blob/releases/dokuwiki-e
## configuration ##
-This plugin needs configuration. See the dokuwiki configuration editor for this. More information can be found on https://www.dokuwiki.org/plugin:etherpadlite .
+The plugin will not work until it is configured. See the dokuwiki configuration editor for this (Admin -> Configure Configuration Settings -> Etherpadlite Plugin Settings). More information can be found on https://www.dokuwiki.org/plugin:etherpadlite .
### etherpad lite plugin ###
-For better integration, see the ep\_iframeinsert etherpad lite plugin.
+For better integration, install the ep\_iframeinsert etherpad lite plugin.
https://github.com/michael-dev/ep_iframeinsert
Shortcomings
------------
-* Please note that password protection only works for group pads. Additionally, there is a single master group for alle wiki pages. So the temporary page id is a secret.
+* Please note that password protection only works for group pads. Additionally, there is a single master group for all wiki pages. Therefore the temporary page id is a secret.
* The dokuwiki plugin sets a browser cookie read by the etherpad lite (session identifier). This leads to some cross-domain restrictions.
* Group sessions last for one week or shorter (if user uses logout button). So after one week, you'll need to reconnect.
* Encrypted pages are not really encrypted but the etherpad-lite builtin password manager is used.
--
1.8.4.3
michael-dev
commented
10 years ago
Here are some suggestions: