OPDS Parsing library

This library provides a parsing library for OPDS Catalogs.

It also has the ability to discover catalogs in html feeds.

Dependencies

• jquery
• underscore
• classy
• URI

Install

Distribution files are located here :

http://github.com/tchak/opds-js/tree/master/build/

If you provide yourself all of the required libraries juste do

<script type="text/javascript" src="opds.js"></script>

Or you can use standalone version which embed all required libraries do

<script type="text/javascript" src="opds.standalone.js"></script>

Usage

Parsing a feed is done via OPDS.Feed.parseUrl method.

OPDS.Feed.parseUrl("http://catalog.com/catalog.atom", callback);

This method will return an instance of the Feed or Entry classes. Each Atom element is accessible directly via a dedicated method (ex: feed.title). Entry also provides a method to directly access any embeded Dublin Core metadata (dcmeta). The rawDoc attribute gives access to the JQuery parsed source.

Complete atom entries

Complete atom entries are available if detected as another instance of the Entry class. Just call entry.complete(callback) on the partial entry to access it.

Links

Every links are automatically parsed in feeds and entries. They are made available in a collection called links. Relative links should be transformed in their absolute equivalent. On each link there is a navigate(callback) method which will proxy a call to OPDS.Feed.parseUrl.