Sefaria / Sefaria-Project

New Interfaces for Jewish Texts
https://www.sefaria.org
651 stars 264 forks source link

Please add text to the Auto-Linker's pop-ups to say that they're generated by the Auto-Linker #250

Open unforgettableid opened 7 years ago

unforgettableid commented 7 years ago

To: @EliezerIsrael. Cc: all.

Background

Hi! I was using a certain Torah wiki. I saw some Sefaria links which the wikitext didn't seem to link to, and some unexpected popups which I wasn't expecting. I couldn't figure out what was producing these links and popups. I visited the wiki's "Special:Version" special page and looked through the list of installed extensions; that didn't help. Well, it turns out it wasn't any installed wiki extension at all. Using Google Chrome's developer tools and some Google-fu, I eventually figured out that the links and popups were generated by the Sefaria Auto-Linker.

My request

It would be good if you could please modify the Linker's pop-ups so that it's easier for the reader to figure out what produces them. I suggest that you simply add the following text to the bottom of every pop-up: "To learn more about the Sefaria Auto-Linker, visit <www.sefaria.org/linker>."

EliezerIsrael commented 7 years ago

When the user configures the plugin to show a popup on rollover (the default behavior), we show a line that says "Text from Sefaria.org ..."

screenshot 2016-09-25 11 46 33

It there a context where you didn't see that?

unforgettableid commented 7 years ago

I did see that line, but still had no idea what was producing the pop-ups. I really thought it was a MediaWiki extension, although it turns out it wasn't.

The Sefaria Auto-Linker is a fairly-unique piece of software. I can't think of many similar pieces of software, though there does also exist (l'havdil) IntelliTXT. Because such software is so rare, it's useful for any such piece of software to tell users what it is — especially if the software is sometimes invoked by a publicly-editable wiki.