michael-dev / dokuwikietherpadlite Goto Github PK

I have installed and configured the plugin. However I'm getting the error "no such function" as a js pop up. There is no error in the etherpad log and nothing in the dokuwiki log either.
In the source it looks like the error handler forwards an error raised by something else, thus I wasn't able to track down were the error was raised initially.

I didn't manage to install the ep_iframeinsert plugin as it is neither in the npm repository or the etherpad lite library.

Is there any solution how to solve the error?
Could you help with any ideas on where this error is raised?

It would be nice if we could save to Dokuwiki without having to exit Etherpad.

Sometimes we want to save what we've created so far.
Exiting EP is disruptive to the group.

It would be nice if there was a button that would "checkpoint to Dokuwiki".

Hi,

i think your documentation is quite vague about the prerequisites of who can actually use your plugin...

• Does it work with the recent nightly / git version of dokuwiki?
• Does the used authentication matter (i.e. i am using LDAP)?
• Why do you mention to change "mysql" in the settings.json of etherpad, does that mean it will not work using other databases?

Right now, if i install your plugin with the most recent dokuwiki version from git, it prevents dokuwiki from working completely...

Looks like this isn't actively maintained anymore, which is a shame since both Etherpad and Dokuwiki improved quite a lot.

Here are some suggestions:

From 4d1f0e6f81ea474d607fcb9b0d0a57e6f00515f7 Mon Sep 17 00:00:00 2001
From: Tom Limoncelli <[email protected]>
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

Installed the EtherpadLite Plugin from here https://www.dokuwiki.org/plugin:etherpadlite (https://github.com/michael-dev/dokuwikietherpadlite/raw/releases/dokuwiki-etherpadlite-0.0.1.zip)

It suggests an update within the Extension Manager of DokuWiki from version 2012-05-22 to version 2013-07-31 but the update does not work

Hi,

today i gave your plugin another try and now i figured out what the problem is: When doing "git clone" of your repository, the externals/etherpad-lite-client is not automatically downloaded. so basically invoking dokuwiki will just lead to an "error 500". After i manually cloned the externals/etherpad-lite-client, Error 500 was gone. The next issue is, that the default settings of your plugin lead to beta.etherpadlite.org, which had a broken installation when i was trying it. Next, i set the etherpad installation url to my own etherpad... Dokuwiki then started complaining about a missing or wrong API Key. Fortunately i could solve the mystery with google, finally found out that i have to check the directory of my etherpad installation, open the APIKEY.txt, copy out the key, take it to the plugins settings --- and it works. i guess this process could be described a bit better in the documentation!

Ok. Installed the plugin through DokuWiki Manager.
Configured it the following way:

Url of etherpad lite: http://localhost:9001/p/
APIKEY of etherpad lite: myAPI-Key
Alias of etherpad lite group: etherpad (is this the user/group etherpad is running?)
shared cookie-domain for etherpad lite: localhost or localhost:9001 or http://localhost or http://localhost:9001

I receive the following error when editing a page: JSON response could not be decoded

What is the code-tag to insert a pad?

Hi,

I install the plugin and configure it how the readme say, but i have this error:

[2013-10-10 14:35:02.727] [WARN] message - Authentication try failed:{"component":"pad","type":"CLIENT_READY","padId":"redpatodos","sessionID":"null","password":null,"token":"t.rur37RGgE2cVrd2CVfuz","protocolVersion":2}

And, i can no edit anyting.

We have successfully installed the dokuwikietherpadliteplugin on an older DokuWiki Adora Belle version (including ProxyPass and ProxyPassreverse) and the ep_iframeinsert plugin on an existing, open etherpad-lite (installed manually, which needed a chown on the plugin to make ep work again).

Now we have two formatting rows, see screenshot.

Where would we need to add the parameter "showControls=false" in the API call, as described here, when calling it by URL: https://github.com/ether/etherpad-lite/wiki/Embed-Parameters

First of this looks like a really nice plugin :)

I have installed it on my new Dokuwiki (running the latest version) with the SprintDoc skin.

To my surprise this plugin seems to be still working mostly, in fact for the initial user everything seems to work as expected as far as I can tell.

However if I try edit the same page from another browser-window logged in with another user (in private mode to simulate another computer), this second user is only presented with the regular Page locked message.

Is there anything I would try to debug this? Thanks for the help!

We like Etherpad so much we wish Dokuwiki would go directly to Etherpad when we click "edit" rather than going to the native editor and having to click the Etherpad icon.

Is it possible to replace the saveable icon with a different icon? It seems to be an ordinary save button (diskette), but it has a different function

https://github.com/michael-dev/dokuwikietherpadlite/blob/master/img/saveable.png

Hi,
dokuwikietherpadlite doesn't seem to work DW last version, 2015-08-10 "Detritus", I don't see any icon in toolbar...
Do you plan to update the plugin ? Because it seems to be very interesting and complementary to DW.

Thanks
Olivier

DokuWiki is not accessible after copying the plugin into the dir.
After removing the folder, it's working again.
Permissions set to www-data.

This plugin does not work with the latest Dokuwiki version (Hogfather) because of this new feature: https://www.dokuwiki.org/config:defer_js
The script uses variables when adding the Pad buttons that are not yet initialized and fails.

Dokuwiki 2018-04-22b "Greebo" doesn't provide an editBox to display the source at a locked edit page. When an user edits a page and opens a pad, other users can't access the pad, only the locked page message is shown.

It took me a while to debug this problem. Would you add this to the documentation so that other people with the same problem can learn from my mistake?

Problem: You get pop-up windows that say "Empty or No Response from the server"

Suggestion: etherpad-lite-client.php uses curl_init() to do its own query to the etherpad lite server. If it gets back an invalid response or no response you will see that popup. If you are using SSL to connect to your etherpad lite server the PHP function curl_init() will expect the cert to be valid and not a self-signed certificate. If it is, it will return no information, thus the error message. If this is the problem: (a) use a proper certificate, or (b) add this line to the series of "curl_setopt()" calls around line 94 of etherpad-lite-client.php
curl_setopt($c, CURLOPT_SSL_VERIFYPEER, false);

Also, would you consider changing the error message to be "server-side PHP script had error when contacting $url: Empty or No Response from the server. If you are using HTTPS, there may be a cert issue."

Thanks!
Tom

The default installation is DE and I can't figure out how to change to

Would you please add to the documentation how to change the language from DE to EN?

Thanks!

the download button on
https://www.dokuwiki.org/plugin:etherpadlite
yields
just a textfile containing the fullname of the current release, it seems symbolic links are handled in a special way by github.

have fun ^^