You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 16 Next »

OPDS feeds

OPDS is the standard at the core of SimplyE. An OPDS feed is a list of books. Each entry in the feed contains metadata for a book (title, author, etc.) and instructions on how to get a copy of the book.
One OPDS feed can link to another, just like one HTML page can link to another.

There are two basic syndication types

  • Atom/XML - OPDS 1.2
  • JSON-LD -OPDS 2.0 - Not yet supported yet in SimplyE or Circulation Manager

Active Draft Specs:

Library Simplified Extension

There are all kinds of reasons why one OPDS feed might link to another, but these are the two most important, and should give you the general idea:

  • Division: Putting the fiction and nonfiction books in separate sections instead of mixing them together.
  • Pagination: Putting 50,000 books on 100 small pages, rather than all on one huge page.

OPDS as user interface

When the SimplyE mobile app is pointed at an OPDS server, the links between OPDS feeds determine the graphical user interface shown to SimplyE, just as the links between HTML pages become the user interface of a website. There are two main features of OPDS which elevate it past just a big scrolling list of books:

  • Grouped feeds, which create a Netflix-style browsing interface.
  • Navigation feeds, which let a reader drill down into categories and subcategories of books.

(Note that the SimplyE mobile app doesn't actually support navigation feeds yet. Grouped feeds offer a nicer version of the same functionality, but it's more work on your end.)
If your OPDS feed is intended for distributing books through other institutions, rather than for direct consumption by the SimplyE App, you should probably just create a simple paginated list of books with the newest books at the top.

Static generation

In most cases, it's preferable to generate your OPDS feeds statically ahead of time. As your collection becomes more complicated, it may be more practical to generate OPDS feeds as needed and cache them.

Warning

Common Issues with Metadata feeds and the Circulation Manager

  • MUST specify the works language - a book that has no language will be imported but it will never be shown to any particular patron, since there's no situation where we believe the language is compatible with the patron's language settings
  • SHOULD Metadata does not specify nonfiction.
  • SHOULD Metadata does not specif audience
  • SHOULD Classifications included in OPDS Feed see below

Classifications

The CM can use classifications to organize and process works into the catalog.

The following should be brought in if used for classifying works or used when constructing OPDS feeds intended to be used in SimplyE.

category term="Children" scheme="http://schema.org/audience" label="Children"/>
<category term="PS8553" scheme="http://purl.org/dc/terms/LCC"/>
<category term="398.8" scheme="http://purl.org/dc/terms/DDC"/>
<category term="http://librarysimplified.org/terms/fiction/Fiction" scheme="http://librarysimplified.org/terms/fiction/" label="Fiction"/>
<category term="7" scheme="http://schema.org/typicalAgeRange" label="7"/>
<category term="sh85025320" scheme="http://purl.org/dc/terms/LCSH" label="Christmas stories"/>
<category term="856632" scheme="http://id.worldcat.org/fast/" label="Juvenile fiction"/>



  • No labels