hypothesis / h

Annotate with anyone, anywhere.

h

h is the web app that serves most of the https://hypothes.is/ website, including the web annotations API at https://hypothes.is/api/. The Hypothesis client is a browser-based annotator that is a client for h's API.

Development

See the Contributor's guide for instructions on setting up a development environment and contributing to h.

Community

Join us on Slack (request an invite or log in once you've created an account).

If you'd like to contribute to the project, you should also subscribe to the development mailing list and read our Contributor's guide. Then consider getting started on one of the issues that are ready for work.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Hypothesis is released under the 2-Clause BSD License, sometimes referred to as the "Simplified BSD License" or the "FreeBSD License". Some third-party components are included. They are subject to their own licenses. All of the license information can be found in the included LICENSE file.

h's Issues

INSTALL files

Should be a base INSTALL file and platform specific ones that detail dependencies and where to get them / how to install them.

top level annotation detail should not have a thread expander

Heatmap - Slightly wider, hypothes.is logo at the top.

sandbox the bulk of the app

The app should load most of its content in an iframe. This would help mitigate styling clashes.

The tricky part is cross-domain iframe communication and the need to inject d3 / jquery into the top frame while accessing them from the iframe.

Detail threads / replies should highlight on hover, same as bucket

fix releaser to work with webassets

Should use releaser to regenerate webassets and check them in

make a readme

Adding 1 annotation to hypothes.is/new results in heatmap showing annotations on every page

avoid thread locals in store integration

SITE: sslshopper.com - Errors on annotator load

http://www.sslshopper.com/godaddy-certificate-authority-reviews.html

Heatmap - Arrows w/ number of annotations below and above

Question--- are we going to poll periodically (or push notification) so that the number might increase as new annotations are added below.

When "not logged in", we should pop up login fields / sidebar

Also-- if I load annotator on a page w/ bookmarklet and it's not logged in, should prompt me to login.

annotations which fail to anchor totally break heatmap

Not sure if this is an annotator bug or a h. bug.
Somewhere an exception needs to be caught and handled more gracefully.

switch all code to js

hypothesis.coffee needs to go. no new coffeescript. whatever I happen to think about it myself is irrelevant: it's an unnecessary barrier to contribution.

bookmarklet auto-update

The URLs generated by webassets have a query string parameter.

When these end up in the embed, the bookmarklet always gets the assets from cache. That's kind of awesome but also means that the bookmarklet never updates itself...

switch to deform and deform_jinja2 with uniform

Chrome throws "insecure content" warning when trying to annotate https content.

Is this a bug?

backlight / highlight source text

On heatmap or annotation hover.

adder art

Clicking out once on detail should go to bucket - twice to exit

Create ability to delete your own annotations.

If you're the author of the annotation / reply, you should get an extra option on hover, next to the reply link, allowing you to delete the annotation... lets use icon of a trash can.

Heatmap - Tabs w/ numbers of annotations.

add handle to left edge of sidebar, so can be resized

created time not immediately visible on new replies

Annotator not loading at Gizmodo (FF & Chrome both)

http://gizmodo.com/5914898/you-wont-believe-how-this-cat-walks-down-this-fridge

bootstrap horizontal forms

pull in the bootstrap form styles
they have margins in px which needs to change
and probably support more IE junk than I want

explore traversal for API

create browser extensions [f3]

For the purposes of this issue, Chrome and Firefox will suffice.

Font in sidebar small sometimes-- needs to be reset?

no-conflict loading

Currently it seems possible to load the annotator twice if you click a bookmarklet or so too fast.yepnope handler for negative case should maybe set an indicator that loading is already occurring.

requirements.txt and getting running

SITE: cryptogon.com - Heatmap & sidebar elements all oddly 'centered' overtop of eachother

http://cryptogon.com/?p=28357

add minifiers to asset pipeline

Get collapsors working

time-based sorting for now

For this milestone, we need some sorting.... make it time for now.

excerpt in editor view

SITE: edgar.sec.gov - Can't load annotator on GOOG 10-Q form

http://edgar.sec.gov/Archives/edgar/data/1288776/000119312512182401/d307179d10q.htm

Annotations that span paragraphs show as multiple bars on heatmap.

integrate annotator

SITE: Thomas.gov - Annotator not loading

http://thomas.loc.gov/cgi-bin/query/C?c112:./temp/~c112EBa3qB

Registration / login function from sidebar

So, I think the profile should include the twitter set of fields

handle
password
email
name
location
bio
avatar

Registration should probably include a subset

handle
password
name (optional)
email

I wouldn't worry about styling the reg page, jehan can focus on that.

Also, we need a login function as well.

Loading annotator cause page to stutter briefly (on nearly all sites)

Link: Short url service

Provide a short url service that integrates with the extension (#43) to load the destination and scroll automatically to the relevant passage.

Move reply up to meta bar - overwrite time

SITE: federalregister.gov - Error highlighting text / fetching annotator

https://www.federalregister.gov/articles/2012/05/09/2012-11133/amendments-to-financial-responsibility-rules-for-broker-dealers#p-9

log in from extension / bookmarklet

We could punt on this for the bookmarklet for now. But if we have an extension soon, that should at least be possible from there. For example, in the page action for a chrome extension.

Link: Enable linking to an annotation

switch to imperative view config

two clicks to exit detail

first click should go back to the bucket

Add drop shadow to left edge of heatmap so that it floats off the page a little better.