From: Marcin Koziej <marcin.koziej@nowoczesnapolska.org.pl>
Date: Tue, 13 Dec 2011 10:27:26 +0000 (+0100)
Subject: documentation
X-Git-Url: https://git.mdrn.pl/wolnelektury.git/commitdiff_plain/98a11b1afa8d82d4843705f6ffff799b1eeaed50

documentation
---

diff --git a/apps/opds/views.py b/apps/opds/views.py
index cd91a743f..44baf5b2a 100644
--- a/apps/opds/views.py
+++ b/apps/opds/views.py
@@ -332,7 +332,11 @@ class SearchFeed(AcquisitionFeed):
     def get_object(self, request):
         """
         For OPDS 1.1 We should handle a query for search terms
-        and atom:author, atom:contributor, atom:title
+        and criteria provided either as opensearch or 'inline' query.
+        OpenSearch defines fields: atom:author, atom:contributor (treated as translator),
+        atom:title. Inline query provides author, title, categories (treated as book tags),
+        description (treated as content search terms).
+        
         if search terms are provided, we shall search for books
         according to Hint information (from author & contributror & title).