Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Features: Notes and Annotations #27

Open
wants to merge 28 commits into
base: master
Choose a base branch
from

Conversation

aMoniker
Copy link

This branch adds two new features to BookReader called Notes and Annotations.

These features were developed as part of a project sponsored by the Association of Historians of Nineteenth-Century Art and have been featured in an article of their Spring 2013 issue. See the modifications to the reader in action by clicking the additional icons in the toolbar area of the upper-right.

The Notes feature is available by setting br.features.notes = true; in the reader's config. Likewise Annotations are enabled by setting br.features.annotations = true;.

The Notes button will return any notes (when available) for the current page by calling the overridable function getNotes.

The Annotations button will toggle the display of annotated areas of each page. When these areas are clicked they spawn additional popups containing arbitrary HTML content. Their position and content is defined by the br.annotations object within the config. You can see how this is set up here.

In the example, I've added the content as hidden divs in index.html which then gets pulled into each popup (which is useful for SEO purposes). It could also be included via javascript as part of the br.notes and br.annotations objects.

Please take a look at the live features in the article, and the changes to the code. I'll be happy to answer any questions and work with you to get these features integrated with BookReader.

…crolling while they're open, close on non-colorbox/nav clicks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant