ether / ep_author_hover Goto Github PK

View Code? Open in Web Editor NEW

6.0 4.0 19.0 272 KB

Hover over Etherpad pad contents to see who the author is

License: Apache License 2.0

JavaScript 96.83% EJS 3.17%

ep_author_hover's Introduction

Show Author Name on hover

Hover over an author to see their name

Other functionality

Shows the author color on hover Supports fast switching between hovers (Doesn't depend on native browser support)

Settings

Disable/enable author hover locally in your browser

This plugin adds a new switch called Show Author on Hover to the settings menu. This allows you to disable/enable the display of author names on hover in your browser.

Disable author hover by default for all clients

To don't show the author names on hover by default (the user has to activate in manually), add the following to your setting.json:

  // disable author hover by default
  "ep_author_hover": {
    "disabledByDefault": true
  }

Why did I rewrite this?

I don't really like plugins that depdend on manipulating the ACE inner DOM, rewriting this plugin and using events meant I could still have hover functionality without the risk of running into nasty ACE issues down the line. It also meant that as new authors joined and updated their name I could update hte hovers in real time. Previous attempts at writing this plugin have required a browser refresh to know who authors are, that wasn't good enough for me.

TODO

use JQTip
Your ideas here..
Test in IE
Settings for font size/background color switch
Your sponsorship here..

ep_author_hover's People

Contributors

Stargazers

Watchers

Forkers

ioki amfl r1kk3r netray framasoft bhanditz sanspseudofix seballot apmole techware01 falkirks rittmeier cristiansilvagrosseli mconf woeterman94 isabella232 lgtm-migrator

ep_author_hover's Issues

[Question] Unusual behaviour with new version

System

OS: Windows as well as iOS and Linux
Browser: Firefox 76
Etherpad: Version 1.8.3

Problem Description

Hover shows directly and follows the mouse. With this, it always shadows text and distracts from writing and reading. We (10 users) really don't like the new functionality. The old functionality worked way better for us. Maybe the hover should show after 2 seconds, in the old version it maybe took a bit too long.

Possible solution

Restore old functionality with shorter delay or put the hover to the right side of the pad.

creation of locales to help to translate

Hi, thank you for this plugin, it is very useful to know at first glance who wrote a sentence.

It seems that label name is always in english, is it possible to put it in locale file to allow contributors to translate it?

In french, it would be translated into "Afficher l'auteur en surimpression".
Thank you. :)

Show date of change with author_hover

Hello,

is it possible to get, convert and show the timestamp of each author?
Could do it myself it I get some hint`s for the functions and code.

thanks
Birgit

error with etherpad 1.8.3

Hi, after updating to etherpad 1.8.3 (and updating all plugins) i got this error Failed to load 'ep_author_hover/static/js/index' for 'ep_author_hover/ep_author_hover/client_hooks/postAceInit': Error: The module at "ep_author_hover/static/js/index" does not exist. which result in a state that the hover is never shown.

TypeError: $(...).closest(...).get(...) is undefined

I think the changes in 4569f63 are spamming my logfile.

[2015-04-06 11:01:22.687] [WARN] client - TypeError: $(...).closest(...).get(...) is undefined -- { errorId: 'UKFjC9yiVwmBQ91hw90b',
  msg: 'TypeError: $(...).closest(...).get(...) is undefined',
  url: 'REDACTED',
  linenumber: 65,
  userAgent: 'Mozilla/5.0 (Windows NT 6.2; WOW64; rv:36.0) Gecko/20100101 Firefox/36.0' }

Please document how this plugin relates to ep_authornames

https://www.npmjs.com/package/ep_authornames looks similar to this plugin. How do they relate/differ? The README for this plugin has a "Why did I rewrite this?" section. Is this plugin a rewrite of ep_authornames? Please document in the README.

Author tooltip's position is is tied to the page window instead of the pad content

This produces that on wide screens the tooltip is displayed far off from the cursor position and text

small video example https://covid19.framadrop.org/lufi/r/zs78RHhHG8#Q/q/gD5jmWwwu7tiGWrxNcHIXE5RLZvFfBruXu0tfG4=

pr #19 seems to fix the issue

authorId not properly decoded causing "Unknown Author"

Issue Description:

For this author string "author-a-z76zuz70zz81zz67zz122zgoz122zz88zz83zz75zz89zz66zz67z5" specified in html span tag, static/js/index.js wrongly decodes it to "a.LuFQCzgozXSz75", whereas the real author id should be "a.LuFQCzgozXSKYBC5". This caused this plugin to show "Unknown Author" in our etherpad lite instance.

Environment:

Etherpad Lite: commit 08b90437c1fdcb62609f03c6b75a9dcb43865deb (2016-08-01)
OS: Linux dev-businesstime-4 3.2.0-4-amd64 #1 SMP Debian 3.2.41-2+deb7u2 x86_64 GNU/Linux
ep_author_hover installed by npm install: ├── [email protected]

Hovering over link shows unknown author

To replicate
create pad
Copy/Paste

Where can I read more about this?
http://beta.etherpad.org/p/sfc

Way to disabled hover on existing text

Would be good if you had a way to disable the hover on existing text and a way to disable the hover all together.

The hover on existing text causes some readability problems and issues on phones. Maybe a way to address this would be to only show hover on text when the mouse has been hovering for a few seconds.

The ability to disable the hover altogether would be good to give the option to the end users.

Thanks

"Me" not shown on hover

When hovering over a text part I get this error:

Could not find string ep_author_hover.unknow_author html10n.js:742:34
TypeError: authorName is undefined
anonymous/<["ep_author_hover/static/js/index.js"]/showAuthor.draw()
 require-kernel.js line 226 > Function:137
anonymous/<["ep_author_hover/static/js/index.js"]/showAuthor.show()
 require-kernel.js line 226 > Function:71
anonymous/<["ep_author_hover/static/js/index.js"]/showAuthor.hover/timer<()
 require-kernel.js line 226 > Function:59
 require-kernel.js line 226 > Function:137:5
Syntax-Fehler

Firefox 46.0.1
Etherpad 1.6

Add background color

Usually I can't read the names because the hover appears over some other text.
Adding a background color to the div may helb to make the names readable.