Difference between revisions of "OPDS"

Revision as of 15:54, 19 June 2019

Kiwix-serve provides an OPDS feed which allow to search through available content. A live instance can be see at https://library.kiwix.org/.

https://library.kiwix.org/searchdescription.xml which proposes an overall OPDS description in XML format
http://library.kiwix.org/catalog/search which accepts a few GET parameter:
- q=<PATTERN> which proposes a keyword based search in the catalogue (on title and description).
- lang=fra which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
- tag=wikipedia to filter on tags (multiple values as intersection).
- count=2 to limit the number of results.
- start=1 to indicate an offset in search results.
http://library.kiwix.org/catalog/root.xml which proposed the index of all the books

@@ Line 4: / Line 4: @@
 * [https://library.kiwix.org/catalog/searchdescription.xml https://library.kiwix.org/searchdescription.xml] which proposes an overall OPDS description in XML format
 * http://library.kiwix.org/catalog/search which accepts a few GET parameter:
-** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue
+** <code>q=<PATTERN></code> which proposes a keyword based search in the catalogue (on title and description).
 ** <code>lang=fra</code> which proposes a language filter. Use an ISO639-3 language value (like in ZIM metadata).
+** <code>tag=wikipedia</code> to filter on tags (multiple values as intersection).
+** <code>count=2</code> to limit the number of results.
+** <code>start=1</code> to indicate an offset in search results.
 * http://library.kiwix.org/catalog/root.xml which proposed the index of all the books