OPDS Catalog 1.1

文章已搬家，請點擊前往👈

REDIRECT_MODE = 1;

1. 簡介

Open Publication Distribution System中文翻譯作開放出版發行系統，是一種基於Atom用來對電子出版物(主要用於電子書)作格式化的規範。透過OPDS可以提供電子出版物整合、發布、查詢和取得的功能。

完整的規範可以在此網站查到 http://opds-spec.org/specs/opds-catalog-1-1-20110627/ 。

OPDS繼承自 Atom 。

OPDS目前發展到版本1.1，1.2為 Draft；OPDS 1.1的規範使用到的命名空間與Prefix如下：

名稱 命名空間 Prefix OPDS 1.1 http://opds-spec.org/2010/catalog opds: Atom 1.0 http://www.w3.org/2005/Atom atom: DCTERMS http://purl.org/dc/terms/ dc:

MIME Type雖然基於Atom，不過由於OPDS的文件依據不同類型內容共定義了四種，如下：

文件類型 MIME Type OPDS Catalog Entry Document application/atom+xml;type=entry;profile=opds-catalog OPDS Catalog Feed Document application/atom+xml;profile=opds-catalog Acquisition Feed application/atom+xml;profile=opds-catalog;kind=acquisition Navigation Feed application/atom+xml;profile=opds-catalog;kind=navigation

2. 文件類型

OPDS Catalog定義兩種文件，分別為OPDS Catalog Entry Document和OPDS Catalog Feed Document。

2.1 OPDS Catalog Feed Document

OPDS Catalog Feed Document應該要包含一個連結rel="start"以指向OPDS Catalog Root

OPDS Catalog Feed Document又定義兩種Feed，分別為Acquisition Feed和Navigation Feed

2.1-1 OPDS Catalog Root

OPDS Catalog Root必須是最外層的OPDS Catalog Feed Document且只能有一個Root，可以是Navigation Feed或Acquisition Feed。

2.1-2 Navigation Feed

Navigation Feed用來導向其他的Feed，黑字部分繼承Atom定義，紅字部分為OPDS定義，Navigation Feed定義如下：

Element 必要 多筆 資料型態 說明 Δ O atomPersonConstruct 作者， 必須要包含至少一個 ，除非之下的所有 都有包含 X O 分類 X O atomPersonConstruct 貢獻者 X X 產生者 X X 純文字 圖示，寬高比應該為1:1 O X 純文字 唯一識別ID X O (OPDS擴充) 連結， 應該包含一個連結指向自己(ref="self") 應該包含一個連結指向OPDS Catalog Root(ref="start") X X 純文字 圖示，寬高比應該為2:1 X X atomTextConstruct 版權資訊 X X atomTextConstruct 副標題 O X atomTextConstruct 標題 O X atomDateConstruct 最後更新時間 X O 包含的項目 可以是Navigation Feed或Acquisition Feed的連結，但不可以是OPDS Catalog Entry。 中應該包含 來描述連結 包含之 的rel應該使用OPDS Catalog Relations定義，無合適才用rel="subsection"

指向Navigation Feed的連結type應該為application/atom+xml;profile=opds-catalog;kind=navigation

2.1-3 Acquisition Feed

Acquisition Feed用來列出可取得的項目，黑字部分繼承Atom定義，紅字部分為OPDS定義，Acquisition Feed定義如下：

Element 必要 多筆 資料型態 說明 Δ O atomPersonConstruct 作者， 必須要包含至少一個 ，除非之下的所有 都有包含 X O 分類 X O atomPersonConstruct 貢獻者 X X 產生者 X X 純文字 圖示，寬高比應該為1:1 O X 純文字 唯一識別ID X O (OPDS擴充) 連結， 應該包含一個連結指向自己(ref="self") 應該包含一個連結指向OPDS Catalog Root(ref="start") X X 純文字 圖示，寬高比應該為2:1 X X atomTextConstruct 版權資訊 X X atomTextConstruct 副標題 O X atomTextConstruct 標題 O X atomDateConstruct 最後更新時間 X O ( OPDS Catalog Entry) 包含的項目

指向Acquisition Feed的連結type必須為application/atom+xml;type=entry;profile=opds-catalog

2.1-3 Complete Acquisition Feed

OPDS Catalog可以提供一個Complete Acquisition Feed，以讓外部抓取，規則如下：

提供所有的刊物且不應該分頁，除非資料量很大。 所有刊物必須依照 排序。 如果無分頁的話必須包含 之Element，分頁的話依據[ RFC5005 ]之規則。 應該使用定義於[ RFC2616 ]之Content-Encoding壓縮資料。 包含之Entry必須是Complete Catalog Entry。

2.1-4 OPDS Catalog Relations

連結到OPDS Catalog Feed Document的連結應該要使用OPDS Catalog Relation之定義來表示文件意義：

rel 文件類型 說明 start OPDS Catalog Root OPDS Catalog Root subsection Navigation Feed 無其他更合適的OPDS Catalog Relation可用時才使用 http://opds-spec.org/sort/new Acquisition Feed 最新刊物，應該依時間排序，應該在Navigation Feed或OPDS Catalog Root才使用 http://opds-spec.org/sort/popular Acquisition Feed 熱門刊物，應該依熱門度排序，應該在Navigation Feed或OPDS Catalog Root才使用 http://opds-spec.org/featured Acquisition Feed 特別刊物，例如促銷，應該在Navigation Feed或OPDS Catalog Root才使用 http://opds-spec.org/recommended Acquisition Feed 推薦刊物，應該依推薦度排序，應該在Navigation Feed或OPDS Catalog Root才使用 http://opds-spec.org/shelf Acquisition Feed 使用者書櫃，例如購買之刊物 http://opds-spec.org/subscriptions Acquisition Feed 使用者訂閱 http://opds-spec.org/facet Acquisition Feed 過濾或排序條件，必須在Navigation Feed才使用 http://opds-spec.org/crawlable Acquisition Feed 提供被抓取的位址，應該要是Complete Acquisition Feed

當以上Relation與[ RFC 5988 ]中都無合適時， 之 或 之title應該用來描述此關連。

2.2 OPDS Catalog Entry Document

OPDS Catalog Entry Document又分為Partial和Complete Catalog Entry兩種，

指向OPDS Catalog Entry Document的連結type應該為application/atom+xml;profile=opds-catalog;kind=acquisition

2.2-1 Partial Catalog Entry

Partial Catalog Entry只提供最重要的資訊以減少資料量，黑字部分繼承Atom定義，紅字部分為OPDS定義，Partial Catalog Entry定義如下：

Element 必要 多筆 資料型態 說明 Δ O atomPersonConstruct 作者， 必須要包含至少一個 ，除非之下的 或者此 有包含 X O 分類 ，如果有的話應該包含此資訊 X X 內容 ， 和 應該至少包含其中一個，同時具有時不應該提供 X O atomPersonConstruct 貢獻者 ，如果有的話應該包含此資訊 O X 純文字 唯一識別ID，可以有相同ID的 ，但更新時間必須不同，表示不同版本 X O (OPDS擴充) 連結，如果沒有 就必須包含一個連結(ref="alternate")，且多個具有ref="alternate"的連結，type和hreflang的屬性不能都相同 必須包含一個連結指向Complete Catalog Entry(ref="alternate") 必須包含一個獲取連結(ref為Acquisition Relations定義) X X atomDateConstruct 發布時間 X X atomTextConstruct 版權資訊 ，如果有的話應該包含此資訊 X X 資料來源，當資料來源是從別的 拷貝過來時，應用此Element提供原始 資訊 Δ X atomTextConstruc t純文字 摘要 ，如果 是外部資源(具有src屬性)或內容是Base64編碼時，必須要有 必須是type="text" ， 和 應該至少包含其中一個，同時具有時應該只提供 不應該和 或 重複

O X atomTextConstruct 標題 O X atomDateConstruct 最後更新時間

Acquisition Feed中的Entry應該要是Partial Catalog Entry。

2.2-2 Complete Catalog Entry

Complete Catalog Entry應該要提供完整的資訊，黑字部分繼承Atom定義，紅字部分為OPDS定義，Complete Catalog Entry定義如下：

Element 必要 多筆 資料型態 說明 Δ O atomPersonConstruct 作者， 必須要包含至少一個 ，除非之下的 或者此 有包含 X O 分類 X X 內容 ， 和 應該至少包含其中一個 X O atomPersonConstruct 貢獻者 O X 純文字 唯一識別ID，可以有相同ID的 ，但更新時間必須不同，表示不同版本 X O (OPDS擴充) 連結，如果沒有 就必須包含一個連結(ref="alternate")，且多個具有ref="alternate"的連結，type和hreflang的屬性不能都相同 必須包含一個獲取連結(ref為Acquisition Relations定義) X X atomDateConstruct 發布時間 X X atomTextConstruct 版權資訊 X X 資料來源，當資料來源是從別的 拷貝過來時，應用此Element提供原始 資訊 Δ X atomTextConstruc t純文字 摘要 ，如果 是外部資源(具有src屬性)或內容是Base64編碼時，必須要有 必須是type="text" ， 和 應該至少包含其中一個 不應該和 或 重複

O X atomTextConstruct 標題 O X atomDateConstruct 最後更新時間

2.2-3 Entry Relations

rel 說明 http://opds-spec.org/acquisition 一般的獲取刊物 http://opds-spec.org/acquisition/open-access 無條件獲取刊物 http://opds-spec.org/acquisition/borrow 借閱刊物 http://opds-spec.org/acquisition/buy 購買刊物 http://opds-spec.org/acquisition/sample 試閱刊物 http://opds-spec.org/acquisition/subscribe 訂閱刊物 http://opds-spec.org/image 刊物圖片(封面) http://opds-spec.org/image/thumbnail 刊物圖片之縮圖

圖片Relation之type應該是image/gif、image/jpeg或image/png

2.3 元素

2.3-1

描述連結，黑字部分繼承Atom定義，紅字部分為OPDS定義， 定義如下：

Attribute 必要 說明 href O IRI rel X 關聯類型，無設定時，預設為alternate。格式應符合isegment-nz-nc或IRI且不包含空白。另外，關聯定義可參考 RFC 5988 ，在Atom中特別定義其中5個項目： alternate: 目前資源別種顯示方式(例如搭配hreflang為其他語言版本) related: 相關資源 self: 目前資源 enclosure: 相關資源，但資料內容較大 via: 資源由何處提供 http://opds-spec.org/facet : 只使用在 之 type X 類型 rel如果是 http://opds-spec.org/acquisition 開頭的，必須要有此屬性 hreflang X 語系 title X 標題 length X 連結內容的大小，當rel為enclosure時，應該要有此屬性 opds:facetGroup X 過濾或排序條件的群組，當rel為 http://opds-spec.org/facet 時，必須要有此屬性 opds:activeFacet X 是否為正在使用的過濾或排序條件，當rel為 http://opds-spec.org/facet 時且為使用時，必須為true，否則不顯示此屬性，一個 群組中一次只能有一個是使用狀態

Atom原定義 不包含Element，而在OPDS之定義了以下Element：

Element 必要 多筆 說明 X O 價格 當 之rel為 http://opds-spec.org/acquisition/buy ，必須要有此Element 當 之rel為， http://opds-spec.org/acquisition/borrow 、 http://opds-spec.org/acquisition/sample 或 http://opds-spec.org/acquisition/subscribe 時，可以有此Element 如果為Partial Catalog Entry且有此資訊時應該包含此Element

X O 次要的Media Type

2.3-2

描述 的價格， 之中定義了以下屬性

Attribute 必要 說明 currencycode O 貨幣單位，定義於[ ISO4217 ]

Element內容必須是價格數字

2.3-3

描述 的次要Media Type，例如用於購買之 中，type可能是text/html之購買網頁，可用此屬性描述購買完成後刊物的Media Type， 之中定義了以下屬性

Attribute 必要 說明 type O Media type

定義了以下Element：

Element 必要 多筆 說明 X O 次要的Media Type

2.4 延展性

OPDS與Atom規範一致，允許自訂未定義Element和Attribute，解析或整合者要遵守以下規則：

遇到未定義標記時，不能中斷處理與視為error。 轉遞OPDS時，應該保留未定義標記。

2.5 搜索

OPDS Catalog可以透過[ OpenSearch ]規範，提供搜索功能，搜索連結必須為rel="search"與type="application/opensearchdescription+xml"。

搜索結果之OPDS Catalog Entry Document可以包含[OpenSearch]定義元素，例如： 或

小殘的程式光廊

提供一些演算法、資料結構、程式題目的整理與說明，PHP和JavaScript的基本教學和一些程式相關問題與解法。

OPDS Catalog 1.1

參觀人氣

熱門文章

文章分類

電腦程式 (10)

最新文章

最新留言

文章搜尋

文章精選