From 3ba9b28c94b9717808df3f0d4704256a316072c5 Mon Sep 17 00:00:00 2001 From: John Schember Date: Mon, 7 Mar 2011 07:29:12 -0500 Subject: [PATCH] More store plugin documentation. --- src/calibre/gui2/store/__init__.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/calibre/gui2/store/__init__.py b/src/calibre/gui2/store/__init__.py index c413fd02dc..3c42588fe2 100644 --- a/src/calibre/gui2/store/__init__.py +++ b/src/calibre/gui2/store/__init__.py @@ -33,6 +33,14 @@ class StorePlugin(object): # {{{ :attr:`gui` member. You can access other plugins by name, for example:: self.gui.istores['Amazon Kindle'] + + Plugin authors can use affiliate programs within their plugin. The + distribution of money earned from a store plugin is 70/30. 70% going + to the pluin author / maintainer and 30% going to the calibre project. + + The easiest way to handle affiliate money payouts is to randomly select + between the author's affiliate id and calibre's affiliate id so that + 70% of the time the author's id is used. ''' def __init__(self, gui, name): @@ -71,6 +79,13 @@ class StorePlugin(object): # {{{ isn't available because the store does not display cover images then it's okay to ignore it. + Also, by default search results can only include ebooks. A plugin can offer users + an option to include physical books in the search results but this must be + disabled by default. + + If a store doesn't provide search on it's own use something like a site specific + google search to get search results for this funtion. + :param query: The string query search with. :param max_results: The maximum number of results to return. :param timeout: The maximum amount of time in seconds to spend download the search results.