Advanced Content Authoring and Reporting - How to set up annotation in Pressbooks with

Pressbooks can be used to author and host basic course content with interactivity as well as more advanced content authoring and reporting (ACAR) features (such as H5P activities, annotations and reporting).

These ACAR features are only recommended for technically advanced instructors or instructors with additional support. If you are interested in these more advanced features, please request a consultation from Learn@UW-Madison. 

This documentation is for instructors who want to create annotations in Pressbooks via the plugin. Instructors can use as an annotator for editing groups working on a book, to handle peer review, and even as a classroom tool for students.

The first version of this document is copied with permission from the Pressbooks 101 documentation from L&S Learning Support Services.

Activate for your Pressbook

By default, the plugin is not activated in your Pressbook. In order to activate the annotation tool, click Settings on the left-hand menu, then click Hypothesis. This will load the Hypothesis Settings Page. The Hypothesis Settings menu includes:

  1. Highlights on by default – check this box if you want the annotation highlights to be turned on by default for your book.
  2. Sidebar open by default –  check this box if you want the annotation pane to be open by default on your book.
  3. Enable annotation for PDFs in Media Library –  check this box if you want to enable annotation for PDFs in your media library.
  4.  Content Settings  – these check boxes control where is loaded on your book. They include the front page, blog page, parts, chapters, front matter, and back matter.
  5. Allow – these fields allow you to apply to specific parts, chapters, front matter, and back matter.
  6. Disallow – these fields allow you to turn off for select specific parts, chapters, front matter, and back matter.

A screenshot showing the Hypothesis settings in Pressbooks

A screenshot from Pressbooks showing more settings

Register for a Account

To use you’ll need to register for an account.  To do so you’ll need to provide a username, email address, and password, and then click the Sign Up button. After that, you should receive a confirmation email with a link to click to validate your account.  If you don’t see this email check your Spam or Junk folder. After confirming your account, enable the Chrome extension in your browser.

A screenshot showing the "SIgn up for Hypothesis" screen which includes fields to enter information for username, email address, and password.

Creating an Annotation

The first time you log into your pane, the How to Get Started box is displayed. It offers explanations of the different button functions and how to use them.

A screenshot showing the "How to get started" screen in with steps 1-6 detailed.

To create an annotation or highlight, start by selecting the text and then choose either annotate or highlight. Choosing annotation will open the annotation pane to a new blank annotation field. Selecting highlight will highlight the text you have selected.

A screenshot showing the "Annotate" and "Highlight" buttons.

Annotation Pane Tour

  1. Filter, Sort, Share, and Account  buttons
  2. Turn on/off highlights, create annotation buttons
  3. Text editor formatting tools – bold, italic, quotation, link, media, LaTex, numbered list, bulleted list,
  4. Preview annotation
  5. Tags Field – add multiple tags separated by commas
  6. Post button – you can use the drop-down button to easily switch between Public, Private, and Group posting

A screenshot showing the annotation pane.

Once you’ve created an annotation it will appear in the annotation pane on the right side of the page.  It features the text that you’ve selected to annotation at the top, your annotation, and tags.

In the screenshot below, draw your attention to (1) the annotation, in this case, I’ve provided a map of Edinburgh, Scotland to show other users what the city’s layout looks like, (2) what tags look like when you use them on an annotation, (3) the edit, delete, reply, and share buttons.

A screenshot showing the annotation pane with an image of Edinburgh, Scotland, and the edit, delete, reply, and share buttons.

You can also adjust the width of the annotation pane by dragging it to left (wider) or to the right (narrower).

An animated GIF showing that you can adjust the width of the annotation pane by dragging to the left or right.

Creating a Group

Follow the Creating a Group step-by-step video tutorial. While it displays annotation on a web page, it is accessed through the panel the same way it would be in Pressbooks.

Joining a Group

Follow the Joining a Group step-by-step guide video tutorial. This might be helpful to show students if you’re using a group to manage class annotations.

Review Annotation Activity

Once you’re the member of a group, you can easily review the annotation activity for that group. To navigate to the annotation activity for a specific group, open the annotation pane on your book and select the user icon to open the drop-down tray of options, then click on your username.

A screenshot showing the pane with the User icon circled and a username highlighted.

This will load your account page. From there, click Groups and from the drop-down tray select the group you want to review. For example, in the screenshot, the PPP Editors group is selected.

A screenshot showing the account page with the "Groups" dropdown menu exapnded and the "PPP Editors" group circled.

This will load the group page that you’ve selected.  At the top of the page you’ll find (1) the group you’ve selected as a filter in the search box, (2) the account and group navigation options in the top right of the page, (3) a listing of the matching annotations for the group tag, (4) the name of the group and group information, (5) a listing of the top tags for the group, (6) a list of members in the group, and (7) the link to invite new members to the group.

A screenshot showing the group page with 1-7 numbered as detailed in the previous text.

Resources offers some great resources for using annotations with students and in groups. Check out the following resources:

If you would like to use H5P with your Pressbook, please refer to Advanced Content Authoring and Reporting - How to create interactive content in Pressbooks with H5P. If you want to add H5P to your Hypothesis annotation pane, please reach out to the DoIT Help Desk.

If you are done creating your interactive Pressbooks content and you want to embed it in Canvas, you'll follow the next set of directions in Advanced Content Authoring and Reporting - How to export a Pressbook as a Thin Common Cartridge for use in Canvas.

See Also:

Keywords:content, authoring, pilot, pressbooks, write, book, interactive, multimedia,, annotate, annotation, highlight   Doc ID:84856
Owner:Learn@UW Madison .Group:Learn@UW-Madison
Created:2018-08-13 12:51 CDTUpdated:2021-08-17 10:24 CDT
Feedback:  0   0