Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.29 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.29 KB
Raw

Comments and annotations for Etherpad

Screen shot

Installing this plugin with git.

npm install ep_page_view
git clone https://github.com/JohnMcLear/ep_comments.git node_modules/ep_comments_page
cd node_modules/ep_comments_page
npm install

Creating comment via API

If you need to add comments to a pad:

  • Call this route to create the comments on Etherpad and get the comment ids:

    curl -X POST http://localhost:9001/p/THE_PAD_ID/comments -d "apikey=YOUR_API_KEY" -d 'data=[{"name":"AUTHOR","text":"COMMENT"}, {"name":"ANOTHER_AUTHOR","text":"ANOTHER_COMMENT"}]'

    The response will be:

    {"code":0,"commentIds":["c-VEtzKolgD5krJOVU","c-B8MEmAT0NJ9usUwc"]}

  • Use the returned comment ids to set the pad HTML via API:

    My comment goes <span class="comment c-VEtzKolgD5krJOVU">here<span>.

    Result: Screen shot

NOTE: Adding a comment to a pad via API will make the other editors with that pad to be alerted, but this feature is only active if your Etherpad is run in loadTest mode. Read the Etherpad Guide for how to enable load testing.

License

Apache 2