kshaffer / hypothesis_aggregator

A WordPress plugin for aggregating data via the hypothes.is API.
GNU General Public License v3.0
25 stars 5 forks source link

Potential future features #2

Open chrisaldrich opened 8 years ago

chrisaldrich commented 8 years ago

This plugin is spectacular by the way... Here are some thoughts on future development:

It would be great if the displayed text output from the shortcode included a permalink to the original annotation on Hypothesis. As a UI suggestion, perhaps you could place it after the title of the annotated page thusly: URL WRAPPED TITLE | < a href="permalinkhere">#</a>

Being able to circumscribe dates for displayed annotations could be useful, particularly in cases where one wants to highlight only a handful of annotations from a particular user with a particular tag but specific ones within certain time parameters. Additionally pages with embeds could, over time, require importing huge numbers of annotations which may not be ideal, or the context may change with significant future annotations that aren't relevant to what could be a static post that's trying to highlight just a few particular annotations. Time parameters could also prevent future possible spam on unwatched embeds with only "tag" parameters that could be targeted by bad actors.

kshaffer commented 8 years ago

These are great ideas! I hope to add the annotation permalink soon, as I think having a link both to the article and the annotation would be helpful.

I like the idea of adding extra search options, but it could get a bit unwieldy if the search gets too complex, especially since I'm thinking primarily of possible uses for UMW's Domain of One's Own project. I'm wondering if for the use of highlighting only a handful of annotations, would the ability to embed single annotations (like with tweets) be better? I think that's on hypothes.is's radar, but not sure the timeline. It would be easy enough to add to this plugin. (Though I could use design help to make it as pretty as Twitter embeds!)

Thanks for your ideas! And if you're willing to dig into the code, I'll always entertain pull requests! (or competing repos :) )