otetard / ownpad

Ownpad is a Nextcloud application that allows to create and open Etherpad and Ethercalc documents.
GNU Affero General Public License v3.0
58 stars 24 forks source link

Clarify purpose/function of this plugin #71

Closed artfulrobot closed 5 years ago

artfulrobot commented 5 years ago

I'm confused about how this works, and I've read the README (and I've installed it and got it working), so I'm submitting this issue.

From this description:

Ownpad is a Nextcloud application that allows to create and open Etherpad and Ethercalc documents.

I thought that the etherpad service would be accessed by nextcloud such that there was a document stored in nextcloud, edited with etherpad. Like the text editor plugin allows you to edit text documents stored in nextcloud.

But I think what this does is stores a link to an etherpad document and opens etherpad in an iframe; the document is never stored in nextcloud.

So if you use the Link plugin and paste in the link to your etherpad document, it's pretty much the same thing, except that the document opens in a separate tab instead of an iframe.

This is not a criticism of the project :+1: just that it would be great to clarify what it does.

An explanation like this (apols if I've got anything wrong) would have helped me:

Ownpad is a Nextcloud application that provides a way to store a link to an Etherpad or Ethercalc document on a third party service, and to open the document in an IFRAME.

  • When you create an Etherpad or Ethercalc document from the + button in the Files app a randomly named document will be created at your service provider and its URL will be stored in a file with your nextcloud files.

  • When you click the item in your Nextcloud file browser the Etherpad or Ethercalc site will be loaded in an IFRAME for convenient editing.

Note that the documents are only stored with your Etherpad/Ethercalc service provider; no copy is kept on Nextcloud. As documents are created this way Nextcloud is not responsible for the documents' security, e.g. anyone with access to the Etherpad/Ethercalc service can access your document.

Would you consider adding something like this to the README? Thanks.

m0urs commented 5 years ago

The subject of this plugin reads "Ownpad — Etherpad and Ethercalc links in Nextcloud". So for me it was already clear that it creates a link. As far as I know pads in Etherpad are not real documents anyway but entries in the database, so I am unsure how you could create a pad document within Nextcloud?

An advantage over just using the link plugin is the ability to create a pad just from the Nextcloud menu. And also create protected pads where only the users in Nextcloud can access (also that functionality seems to be broken at the moment ;-))

artfulrobot commented 5 years ago

@otetard Thanks, I appreciate that, it's much clearer now.