abdelazer / openpub

Automatically exported from code.google.com/p/openpub
0 stars 0 forks source link

CatalogSpecDraft: explanation of sorting relations #45

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago
The sorting relations are unclear to me.  Would featured, newly released, or 
popular entries appear before those that are *not* featured, newly released, or 
popular?  Or would the most featured, most newly released, or most popular 
appear before the less featured, less newly released, or less popular items?

Original issue reported on code.google.com by kevin.s.hawkins on 12 Aug 2010 at 8:55

GoogleCodeExporter commented 9 years ago

Original comment by abdela...@gmail.com on 16 Aug 2010 at 7:08

GoogleCodeExporter commented 9 years ago
New text; feedback welcome.

http://code.google.com/p/openpub/wiki/CatalogSpecDraft#OPDS_Catalog_Relations

"""

Sorting Relations¶
This specification defines two new relations, which begin with 
"http://opds-spec.org/sort", to describe how an Acquisition Feed is sorted. 
These relations SHOULD be used when creating Navigation Feeds and the OPDS 
Catalog Root, if applicable.

"http://opds-spec.org/sort/new": An Acquisition Feed with newly released OPDS 
Catalog Entries. These Acquisition Feeds typically contain a subset of the OPDS 
Catalog Entries in an OPDS Catalog based on the publication date of the 
Publication.
"http://opds-spec.org/sort/popular": An Acquisition Feed with popular OPDS 
Catalog Entries. These Acquisition Feeds typically contain a subset of the OPDS 
Catalog Entries in an OPDS Catalog based on a numerical ranking criteria.
Acquisition Feeds using the "http://opds-spec.org/sort/new" relation SHOULD be 
ordered with the most recent items first. Acquisition Feeds using the 
"http://opds-spec.org/sort/popular" relation SHOULD be ordered with the most 
popular items first.

Popular Relation
This specification also defines a relation to describe an Acquisition Feed of 
featured items. This relation SHOULD be used when creating Navigation Feeds and 
the OPDS Catalog Root, if applicable.

"http://opds-spec.org/featured": An Acquisition Feed with featured OPDS Catalog 
Entries. These Acquisition Feeds typically contain a subset of the OPDS Catalog 
Entries in an OPDS Catalog that have been selected for promotion by the OPDS 
Catalog provider. No order is implied.

"""

I also added something to address Roger's point from the call:

"""When creating an OPDS Catalog with Navigation and Acquisition Feeds, OPDS 
Catalog providers are encouraged to use the relations defined in this 
specification and [DRAFT-Web-Linking]. If no appropriate relation is found, the 
Feeds SHOULD use a descriptive "atom:title" element and the "atom:link"s SHOULD 
use a descriptive "title" attribute."""

Original comment by abdela...@gmail.com on 18 Aug 2010 at 5:51

GoogleCodeExporter commented 9 years ago
Looks great.

Original comment by kevin.s.hawkins on 18 Aug 2010 at 6:41