-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Canonical Books Page
RayBB edited this page May 17, 2024
·
1 revision
Community, please make suggestions to represent your values so we can design as Canonical Books Page everyone is proud of:
- Our sitemap will index editions
- Most recently added first [tfm - order doesn't matter ]
- 1 edition per language per work, prioritizing books we have digitized? [tfm - all editions should be in the sitemap]
-
/works
pages will become a redirect page to an edition (i.e. “canonical book” page). A user will not be able to get to a work page. An edition will always be selected / the destination for viewing book information. [lsd - The work metadata must be editable: if work page is inaccessible to users then where?]- redirect to the “best” edition, by default
- E.g. Borrowable + available, readable, newest, highest rated
- Can be done dynamically, at time of hitting url
- Allow default setting to be overridden to accommodate language, or a request for a specific edition
- A lang= parameter could be used to tell the search results /work which edition to redirect to, i.e. as a filter/facet for desired language
- redirect to the “best” edition, by default
- All editions will also incorporate work data into their display (i.e. an edition page is basically a work page with an edition selected)
- To see other editions of a work, we may opt to shown the “best” subset of them (in one more many carousel(s)?) on the selected edition page. Where applicable (i.e. the edition has a work), a user may see a comprehensive listing of all editions (including those without ebooks) by going to:
/works/OL...W/<title>/editions
. In this case, we can guarantee there is a work by virtue of there being multiple editions.- “best” may mean the same thing as defined above (e.g. newest, available, languages)
- For maintainability and clarity, there will be exactly 1 template (disregarding A/B testing) for the “canonical book page”
- Not all editions need a work under this approach [tfm - I don't see how this follows. Work metadata is still needed]
- The Canonical Book Page will be mobile responsive and have a mobile + desktop view
- As a separate (integrally related) issue, solr search should be updated where possible to insert edition match info results to accommodate facet by language, year, etc
- Separate but related issue: How should search results handle works/editions?
- Redirecting
/works/OL...W/<title>
to the "best" edition page (definition of "best" to be discussed) - Adding
work
data (e.g.description
,subject-tags
, otheredition
s) to the edition page - Overhauling the
Canonical Books Page
(i.e. edition page) to have a consistent, mobile friendly design. - Creating a new work's editions endpoint
/works/OL...W/<title>/editions
as the comprehensive listing of a work's editions. - Updating the sitemap to include "select" editions per works (spanning languages, availability, favoring recent date-added, etc -- again, to be discussed)
- Users must be able to easily choose which edition they see of a work by identifiers, search result proximity, facets, etc. Getting five hundred editions of Ovid's Metamorphoses when searching for a specific ISBN is not helpful.
- A superficial record of how other sites (GoodReads, LibraryThing, and Shelfari) handle their Work/edition interactions (interactive SVG; links/hovering work)
https://internetarchive.slack.com/archives/C0ETZV72L/p1521771852000004 https://github.com/internetarchive/openlibrary/issues/844 https://github.com/internetarchive/openlibrary/issues/684
Getting Started & Contributing
- Setting up your developer environment
- Using
git
in Open Library - Finding good
First Issues
- Code Recipes
- Testing Your Code, Debugging & Performance Profiling
- Loading Production Site Data ↦ Dev Instance
- Submitting good Pull Requests
- Asking Questions on Gitter Chat
- Joining the Community Slack
- Attending Weekly Community Calls @ 9a PT
- Applying to Google Summer of Code & Fellowship Opportunities
Developer Resources
- FAQs: Frequently Asked Questions
- Front-end Guide: JS, CSS, HTML
- Internationalization
- Infogami & Data Model
- Solr Search Engine Manual
- Imports
- BookWorm / Affiliate Server
- Writing Bots
Developer Guides
- Developing the My Books & Reading Log
- Developing the Books page
- Understanding the "Read" Button
- Using cache
- Creating and Logging into New Users
- Feature Flagging
Other Portals
- Design
- Librarianship
- Communications
- Staff (internal)
Legacy
Old Getting Started
Orphaned Editions Planning
Canonical Books Page