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

Show page numbers on annotation cards #5986

Closed
robertknight opened this issue Dec 1, 2023 · 4 comments
Closed

Show page numbers on annotation cards #5986

robertknight opened this issue Dec 1, 2023 · 4 comments

Comments

@robertknight
Copy link
Member

We are planning to offer the ability to filter annotations based on page number in VitalSource, and by default annotations outside the current assignment's page range will be hidden. See #5937.

In order for it to be clearer to the user why they are or are not seeing a particular annotation, it is becoming more important to show the page number on the annotation itself. More generally it would be nice to implement this for PDFs as well, though in order to do that we will need to start capturing page numbers on PDF annotations.

A constraint we will have to handle is that older annotations will not have page numbers available.

robertknight added a commit that referenced this issue Dec 1, 2023
Capture the page number and label for PDF selections using the same
`PageSelector` type that we use for selections in PDF-based VitalSource books.
This has various uses, but one of the immediate ones is that it will allow us to
do some testing of the VS page range behaviors with PDFs, which are more
convenient to test with.

Related to:

 - #5986.
 - #3720 (this proposes a more
   PDF-specific selector that would also capture the page region as a rect).
@robertknight
Copy link
Member Author

robertknight commented Dec 1, 2023

A possible design that displays the page number below the username, where the group name is currently displayed today. I tried displaying the page number on the right side of the quote, as it is closely related information, but there is limited space there. Also there may be a More/Less link to expand or collapse the quote.

I took out the group name to reduce overall volume of information on a card. In the context of the sidebar, that duplicates information available in the toolbar. Outside of the sidebar we might want to display the information in a hierarchy like {group name} - {document info} - {page number}. In the sidebar those first two parts can be elided.

Page number display

The same annotation in the notebook:

Notebook page number

@robertknight
Copy link
Member Author

An alternative to showing the information on the card would be adding additional headings to the thread list. We currently have headings for chapters today, which are only used in VitalSource ebooks. We could add a second level for the page number. The downside is that adding this hierarchy in other contexts (eg. notebook / dashboard) could be complex, so we'd probably still want a way to include the info somewhere on the individual annotation.

robertknight added a commit that referenced this issue Dec 4, 2023
Capture the page number and label for PDF selections using the same
`PageSelector` type that we use for selections in PDF-based VitalSource books.
This has various uses, but one of the immediate ones is that it will allow us to
do some testing of the VS page range behaviors with PDFs, which are more
convenient to test with.

Related to:

 - #5986.
 - #3720 (this proposes a more
   PDF-specific selector that would also capture the page region as a rect).
robertknight added a commit that referenced this issue Dec 4, 2023
Display page numbers on annotation cards when:

 - The `page_numbers` feature flag is enabled AND
 - The annotation has a `PageSelector` selector. This applies to VitalSource
   books and PDFs.

Part of #5986
robertknight added a commit that referenced this issue Dec 5, 2023
Display page numbers on annotation cards when:

 - The `page_numbers` feature flag is enabled AND
 - The annotation has a `PageSelector` selector. This applies to VitalSource
   books and PDFs.

Part of #5986
robertknight added a commit that referenced this issue Dec 5, 2023
Display page numbers on annotation cards when:

 - The `page_numbers` feature flag is enabled AND
 - The annotation has a `PageSelector` selector. This applies to VitalSource
   books and PDFs.

Part of #5986
@robertknight
Copy link
Member Author

Discussion about a wider release - https://hypothes-is.slack.com/archives/C2C2U40LW/p1702462198924979.

@robertknight
Copy link
Member Author

This is now shipped.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant