search

abdelazer / openpub

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

Draft specification Terminology section #14

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Please draft a section of specification text that clarifies our terminology. 
The 
existing Glossary may be a useful starting point.

Please note that any discussion should happen on the mailing list rather
than the comments of the issue tracker.

Mailing list threads should reference the number of any open Issue in the
Subject line " (#ISSUE)".

Original issue reported on code.google.com by abdela...@gmail.com on 10 Mar 2010 at 3:53

GoogleCodeExporter commented 9 years ago 
We now have:

 For convenience, instances of this format can be referred to as "OPDS Catalogs" or "OPDS Catalog Documents." The following terminology is used by this 
specification:

  * Acqusition Link - An atom:link element with a relation that begins "http://opds-spec.org/acquisition" and represents the URI from which the  
content's complete representation in a particular media type MAY be requested.
  * Entry - An Atom Entry as defined in [RFC4287].
  * Feed - An Atom Feed as defined in [RFC4287].
  * Hierarchical Collection - A Feed whose Entries are themselves pointers to other Feeds. Catalog publishers use Hierarchical Collections to establish a suggested presentation hierarchy.
  * IRI - An Internationalized Resource Identifier as defined in [RFC3987]. Before an IRI found in a document is used by HTTP, the IRI is first converted to 
a URI.
  * OPDS Catalog Entry - An Entry provides a representation of an available electronic publication and includes an Acqusition Link.
  * OPDS Catalog Root - The Feed that represents either the complete Catalog if it is a Publication Collection or else is the first Feed in a set of 
Hierarchical Collections.
  * Publication Collection - A Feed whose Entries are OPDS Catalog Entries.
  * relation (or "relation of") - Refers to the "rel" attribute value of an atom:link element.
  * Representation - An entity included with a request or response as defined in [RFC2616].
  * Resource - A network-accessible data object or service identified by an IRI, as defined in [RFC2616]. See [REC-webarch] for further discussion on 
Resources.
  * URI - A Uniform Resource Identifier as defined in [RFC3986]. In this specification, the phrase "the URI of a document" is shorthand for "a URI which, 
when dereferenced, is expected to produce that document as a representation".

Original comment by abdela...@gmail.com on 23 Mar 2010 at 1:07

GoogleCodeExporter commented 9 years ago 
People are still confused with the concept of partial and full entries. Maybe 
we should 
also have a definition for those in the spec ?

Original comment by hadrien....@gmail.com on 23 Mar 2010 at 1:28

GoogleCodeExporter commented 9 years ago

Original comment by liza31337@gmail.com on 21 Apr 2010 at 2:44

GoogleCodeExporter commented 9 years ago 
+== Partial and Complete Catalog Entries ==

+OPDS Catalog Entries may be represented as either a Partial or Complete 
Catalog Entry. Partial Catalog 
Entries include only critical metadata elements to reduce the size of OPDS 
Catalog documents for bandwidth- 
and resource-limited clients and link to their alternate representation as a 
Complete Catalog Entries, which 
include all metadata elements. A Partial Catalog Entry MUST include an 
"alternate" link relation referencing the 
Complete Catalog Entry Resource and that atom:link MUST use the type attribute 
"application/atom+xml;type=entry;profile=opds-catalog". Any Catalog Entry 
without a link to a Complete 
Catalog Entry MUST include all metadata elements.
+
+Partial Catalog Entries SHOULD include the following metadata elements, if 
available:
+
+  * atom:category 
+  * atom:rights
+  * dc:extent
+  * dc:identifier
+  * dc:issued 
+  * dc:language
+  * dc:publisher
+  * opds:price 
+  * prism:issue
+  * prism:volume
+
+OPDS Catalog providers are strongly encouraged to limit metadata elements not 
required by Atom, OPDS, or 
listed above from Partial Catalog Entries to help facilitate the efficient 
transmission and consumption of OPDS 
Catalog documents. Implementers are encouraged to use Complete Catalog Entries 
to include experimental, 
exploratory, and esoteric metadata.

+  * Complete Catalog Entry - An OPDS Catalog Entry that includes all known 
metadata and is linked from a 
Partial Catalog Entry.
+  * Partial Catalog Entry - An OPDS Catalog Entry that includes the minimal 
required metadata but no other 
metadata and links to the Complete Catalog Entry.

Original comment by abdela...@gmail.com on 4 May 2010 at 10:09

GoogleCodeExporter commented 9 years ago 
Incorporated, closing and should be reviewed in the main spec.

Original comment by liza31337@gmail.com on 5 May 2010 at 1:47

GoogleCodeExporter commented 9 years ago 
Does Issue 27 mean that this issue is re-opened? Or does 27 simply supersede 14?

Original comment by rsperb...@gmail.com on 6 May 2010 at 2:09

GoogleCodeExporter commented 9 years ago 
I consider this issue closed; revising the terminology used throughout the 
whole specification is different 
from this.

Original comment by liza31337@gmail.com on 6 May 2010 at 2:13

GoogleCodeExporter commented 9 years ago

Original comment by abdela...@gmail.com on 25 May 2010 at 5:44