From 1d6597b40773b688ca317e1ab1ffe133b370afb1 Mon Sep 17 00:00:00 2001
From: Adam Tauber <asciimoo@gmail.com>
Date: Tue, 17 Nov 2015 23:13:30 +0100
Subject: [enh] initial structure

---
 docs/dev/plugins.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 docs/dev/plugins.rst

(limited to 'docs/dev/plugins.rst')

diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst
new file mode 100644
index 000000000..c51fdf0eb
--- /dev/null
+++ b/docs/dev/plugins.rst
@@ -0,0 +1,45 @@
+Plugins
+-------
+
+Plugins can extend/replace functionality of various components inside
+searx.
+
+example\_plugin.py
+~~~~~~~~~~~~~~~~~~
+
+.. code:: python
+
+    name = 'Example plugin'
+    description = 'This plugin extends the suggestions with the word "example"'
+    default_on = False  # disable by default
+
+    js_dependencies = tuple()  # optional, list of static js files
+    css_dependencies = tuple()  # optional, list of static css files
+
+
+    # attach callback to the post search hook
+    #  request: flask request object
+    #  ctx: the whole local context of the post search hook
+    def post_search(request, ctx):
+        ctx['search'].suggestions.add('example')
+        return True
+
+Currently implemented plugin entry points (a.k.a hooks)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  Pre search hook (``pre_search``)
+-  Post search hook (``post_search``)
+-  Result hook (``on_result``) (is called if a new result is added (see
+   https\_rewrite plugin))
+
+Feel free to add more hooks to the code if it is required by a plugin.
+
+TODO
+~~~~
+
+-  Better documentation
+-  More hooks
+-  search hook (is called while searx is requesting results (for
+   example: things like math-solver), the different hooks are running
+   parallel)
+
-- 
cgit v1.2.3


From 2ad8715b3282557d39da21721487ff85683b1219 Mon Sep 17 00:00:00 2001
From: Noemi Vanyi <sitbackandwait@gmail.com>
Date: Sat, 9 Jul 2016 22:31:21 +0200
Subject: better API docs && more features in list

---
 docs/dev/plugins.rst | 34 +++++++++++++++++-----------------
 1 file changed, 17 insertions(+), 17 deletions(-)

(limited to 'docs/dev/plugins.rst')

diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst
index c51fdf0eb..0f52af0d8 100644
--- a/docs/dev/plugins.rst
+++ b/docs/dev/plugins.rst
@@ -1,11 +1,11 @@
 Plugins
 -------
 
-Plugins can extend/replace functionality of various components inside
+Plugins can extend or replace functionality of various components of
 searx.
 
-example\_plugin.py
-~~~~~~~~~~~~~~~~~~
+Example plugin
+~~~~~~~~~~~~~~
 
 .. code:: python
 
@@ -24,22 +24,22 @@ example\_plugin.py
         ctx['search'].suggestions.add('example')
         return True
 
-Currently implemented plugin entry points (a.k.a hooks)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Plugin entry points
+~~~~~~~~~~~~~~~~~~~
 
--  Pre search hook (``pre_search``)
--  Post search hook (``post_search``)
--  Result hook (``on_result``) (is called if a new result is added (see
-   https\_rewrite plugin))
+Entry points (hooks) define when a plugin runs. Right now only three hooks are implemented. So feel free to implement a hook if it fits the behaviour of your plugin.
 
-Feel free to add more hooks to the code if it is required by a plugin.
+Pre search hook
+```````````````
 
-TODO
-~~~~
+Runs BEFORE the search request. Function to implement: ``pre_search``
 
--  Better documentation
--  More hooks
--  search hook (is called while searx is requesting results (for
-   example: things like math-solver), the different hooks are running
-   parallel)
+Post search hook
+````````````````
 
+Runs AFTER the search request. Function to implement: ``post_search``
+
+Result hook
+```````````
+
+Runs when a new result is added to the result list. Function to implement: ``on_result``
-- 
cgit v1.2.3


From c2cf46092e7e805587fde191ea9c620ee2bcb158 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?No=C3=A9mi=20V=C3=A1nyi?= <sitbackandwait@gmail.com>
Date: Fri, 4 Nov 2016 18:38:07 +0100
Subject: docs: fix typos based on #653

---
 docs/dev/plugins.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'docs/dev/plugins.rst')

diff --git a/docs/dev/plugins.rst b/docs/dev/plugins.rst
index 0f52af0d8..1d77f8611 100644
--- a/docs/dev/plugins.rst
+++ b/docs/dev/plugins.rst
@@ -11,7 +11,7 @@ Example plugin
 
     name = 'Example plugin'
     description = 'This plugin extends the suggestions with the word "example"'
-    default_on = False  # disable by default
+    default_on = False  # disabled by default
 
     js_dependencies = tuple()  # optional, list of static js files
     css_dependencies = tuple()  # optional, list of static css files
-- 
cgit v1.2.3