on master help sign in
Merge pull request #614 from kvch/gh-pages

documentation updates

commit19b4b47d43e4aa6c9696f631773f07be5f7a187b authorAdam Tauber <asciimoo@gmail.com> dateSun 10 Jul 2016, 08:28 (10 years ago) parent48597820789ba3
30 files changed+568−190
_sources/admin/api.txt+78 _sources/dev/plugins.txt+17−17 _sources/dev/search_api.txt+13−6 _sources/index.txt+15−6 _static/basic.css+10−5 _static/doctools.js+26−2 _static/pygments.css−2 _static/searchtools.js+3−3 _static/style.css+2 _static/websupport.js+2−2 admin/api.html+146 dev/contribution_guide.html+5−5 dev/engine_overview.html+16−16 dev/install/installation.html+6−6 dev/plugins.html+31−35 dev/quickstart.html+5−5 dev/search_api.html+17−10 dev/translation.html+14−14 docs/_themes/searx_theme/static/style.css_t+2 docs/admin/api.rst+78 docs/conf.py+3−3 docs/dev/plugins.rst+17−17 docs/dev/search_api.rst+13−6 docs/index.rst+15−6 genindex.html+4−4 index.html+20−10 objects.inv search.html+4−4 searchindex.js+1−1 user/search_syntax.html+5−5
_sources/admin/api.txtnew file+78
@@ -0,0 +1,78 @@
1+.. _adminapi:
2+
3+Administration API
4+------------------
5+
6+Get configuration data
7+~~~~~~~~~~~~~~~~~~~~~~
8+
9+.. code:: sh
10+
11+ GET /config
12+
13+Sample response
14+```````````````
15+
16+.. code:: sh
17+
18+ {
19+ "autocomplete": "",
20+ "categories": [
21+ "map",
22+ "it",
23+ "images",
24+ ],
25+ "default_locale": "",
26+ "default_theme": "oscar",
27+ "engines": [
28+ {
29+ "categories": [
30+ "map"
31+ ],
32+ "enabled": true,
33+ "name": "openstreetmap",
34+ "shortcut": "osm"
35+ },
36+ {
37+ "categories": [
38+ "it"
39+ ],
40+ "enabled": true,
41+ "name": "arch linux wiki",
42+ "shortcut": "al"
43+ },
44+ {
45+ "categories": [
46+ "images"
47+ ],
48+ "enabled": true,
49+ "name": "google images",
50+ "shortcut": "goi"
51+ },
52+ {
53+ "categories": [
54+ "it"
55+ ],
56+ "enabled": false,
57+ "name": "bitbucket",
58+ "shortcut": "bb"
59+ },
60+ ],
61+ "instance_name": "searx",
62+ "locales": {
63+ "de": "Deutsch (German)",
64+ "en": "English",
65+ "eo": "Esperanto (Esperanto)",
66+ },
67+ "plugins": [
68+ {
69+ "enabled": true,
70+ "name": "HTTPS rewrite"
71+ },
72+ {
73+ "enabled": false,
74+ "name": "Vim-like hotkeys"
75+ }
76+ ],
77+ "safe_search": 0
78+ }
_sources/dev/plugins.txt+17−17
@@ -1,11 +1,11 @@
11Plugins
22-------
33
4−Plugins can extend/replace functionality of various components inside
4+Plugins can extend or replace functionality of various components of
55searx.
66
7−example\_plugin.py
8−~~~~~~~~~~~~~~~~~~
7+Example plugin
8+~~~~~~~~~~~~~~
99
1010.. code:: python
1111
@@ -24,22 +24,22 @@ example\_plugin.py
2424 ctx['search'].suggestions.add('example')
2525 return True
2626
27−Currently implemented plugin entry points (a.k.a hooks)
28−~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27+Plugin entry points
28+~~~~~~~~~~~~~~~~~~~
2929
30−- Pre search hook (``pre_search``)
31−- Post search hook (``post_search``)
32−- Result hook (``on_result``) (is called if a new result is added (see
33− https\_rewrite plugin))
30+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.
3431
35−Feel free to add more hooks to the code if it is required by a plugin.
32+Pre search hook
33+```````````````
3634
37−TODO
38−~~~~
35+Runs BEFORE the search request. Function to implement: ``pre_search``
3936
40−- Better documentation
41−- More hooks
42−- search hook (is called while searx is requesting results (for
43− example: things like math-solver), the different hooks are running
44− parallel)
37+Post search hook
38+````````````````
4539
40+Runs AFTER the search request. Function to implement: ``post_search``
41+
42+Result hook
43+```````````
44+
45+Runs when a new result is added to the result list. Function to implement: ``on_result``
_sources/dev/search_api.txt+13−6
@@ -1,13 +1,20 @@
11Search API
22==========
33
4−Search API endpoints: ``/``, ``/search``
5−^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4+The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
65
7−Endpoints have equivalent functionality.
6+Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
7+
8+.. code:: sh
9+
10+ GET /
11+
12+.. code:: sh
13+
14+ GET /search
815
916Parameters
10−^^^^^^^^^^
17+``````````
1118
1219+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
1320| Name | Description | |
@@ -18,7 +25,7 @@ Parameters
1825+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
1926| ``engines`` | Comma separated list, specifies the active search engines | optional |
2027+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
28+| ``lang`` | Code of the language | optional (default: ``all``) |
29++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
2130| ``pageno`` | Search page number | optional (default: ``1``) |
2231+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
23−
24−Both ``GET`` and ``POST`` methods are supported.
_sources/index.txt+15−6
@@ -1,7 +1,7 @@
1−Privacy-respecting free metasearch engine
2−=========================================
1+Welcome to searx
2+================
33
4−Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
4+Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
55
66
77Features
@@ -15,16 +15,26 @@ Features
1515 - Does not collect its users data
1616 - Offers secure, encrypted connections (HTTPS/SSL)
1717 - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
18+ - About 70 supported search engines
19+ - Easy intergration with any search engine
1820
1921
20−Further reading
21−---------------
22+User documentation
23+------------------
2224
2325.. toctree::
2426 :maxdepth: 1
2527
2628 user/search_syntax
2729
30+Administrator documentation
31+---------------------------
32+
33+.. toctree::
34+ :maxdepth: 1
35+
36+ dev/install/installation
37+ admin/api
2838
2939Developer documentation
3040-----------------------
@@ -34,7 +44,6 @@ Developer documentation
3444
3545 dev/quickstart
3646 dev/contribution_guide
37− dev/install/installation
3847 dev/engine_overview
3948 dev/search_api
4049 dev/plugins
_static/basic.css+10−5
@@ -4,7 +4,7 @@
44 *
55 * Sphinx stylesheet -- basic theme.
66 *
7− * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
7+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88 * :license: BSD, see LICENSE for details.
99 *
1010 */
@@ -52,6 +52,8 @@ div.sphinxsidebar {
5252 width: 230px;
5353 margin-left: -100%;
5454 font-size: 90%;
55+ word-wrap: break-word;
56+ overflow-wrap : break-word;
5557}
5658
5759div.sphinxsidebar ul {
@@ -83,10 +85,6 @@ div.sphinxsidebar #searchbox input[type="text"] {
8385 width: 170px;
8486}
8587
86−div.sphinxsidebar #searchbox input[type="submit"] {
87− width: 30px;
88−}
89−
9088img {
9189 border: 0;
9290 max-width: 100%;
@@ -187,6 +185,13 @@ div.genindex-jumpbox {
187185
188186/* -- general body styles --------------------------------------------------- */
189187
188+div.body p, div.body dd, div.body li, div.body blockquote {
189+ -moz-hyphens: auto;
190+ -ms-hyphens: auto;
191+ -webkit-hyphens: auto;
192+ hyphens: auto;
193+}
194+
190195a.headerlink {
191196 visibility: hidden;
192197}
_static/doctools.js+26−2
@@ -4,7 +4,7 @@
44 *
55 * Sphinx JavaScript utilities for all documentation.
66 *
7− * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
7+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88 * :license: BSD, see LICENSE for details.
99 *
1010 */
@@ -124,6 +124,7 @@ var Documentation = {
124124 this.fixFirefoxAnchorBug();
125125 this.highlightSearchWords();
126126 this.initIndexTable();
127+
127128 },
128129
129130 /**
@@ -252,6 +253,29 @@ var Documentation = {
252253 });
253254 var url = parts.join('/');
254255 return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
256+ },
257+
258+ initOnKeyListeners: function() {
259+ $(document).keyup(function(event) {
260+ var activeElementType = document.activeElement.tagName;
261+ // don't navigate when in search box or textarea
262+ if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
263+ switch (event.keyCode) {
264+ case 37: // left
265+ var prevHref = $('link[rel="prev"]').prop('href');
266+ if (prevHref) {
267+ window.location.href = prevHref;
268+ return false;
269+ }
270+ case 39: // right
271+ var nextHref = $('link[rel="next"]').prop('href');
272+ if (nextHref) {
273+ window.location.href = nextHref;
274+ return false;
275+ }
276+ }
277+ }
278+ });
255279 }
256280};
257281
@@ -260,4 +284,4 @@ _ = Documentation.gettext;
260284
261285$(document).ready(function() {
262286 Documentation.init();
263−});
287+});
_static/pygments.css−2
@@ -4,10 +4,8 @@
44.highlight .err { border: 1px solid #FF0000 } /* Error */
55.highlight .k { color: #007020; font-weight: bold } /* Keyword */
66.highlight .o { color: #666666 } /* Operator */
7−.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
87.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
98.highlight .cp { color: #007020 } /* Comment.Preproc */
10−.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
119.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
1210.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
1311.highlight .gd { color: #A00000 } /* Generic.Deleted */
_static/searchtools.js+3−3
@@ -2,9 +2,9 @@
22 * searchtools.js_t
33 * ~~~~~~~~~~~~~~~~
44 *
5− * Sphinx JavaScript utilties for the full-text search.
5+ * Sphinx JavaScript utilities for the full-text search.
66 *
7− * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
7+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88 * :license: BSD, see LICENSE for details.
99 *
1010 */
@@ -623,7 +623,7 @@ var Search = {
623623 * helper function to return a node containing the
624624 * search summary for a given text. keywords is a list
625625 * of stemmed words, hlwords is the list of normal, unstemmed
626− * words. the first one is used to find the occurance, the
626+ * words. the first one is used to find the occurrence, the
627627 * latter for highlighting it.
628628 */
629629 makeSearchSummary : function(text, keywords, hlwords) {
_static/style.css+2
@@ -38,6 +38,8 @@ div.bodywrapper {
3838
3939div.sphinxsidebar {
4040 width: 220px;
41+ word-wrap: normal !important;
42+ overflow-wrap: normal !important;
4143}
4244
4345hr {
_static/websupport.js+2−2
@@ -2,9 +2,9 @@
22 * websupport.js
33 * ~~~~~~~~~~~~~
44 *
5− * sphinx.websupport utilties for all documentation.
5+ * sphinx.websupport utilities for all documentation.
66 *
7− * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
7+ * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
88 * :license: BSD, see LICENSE for details.
99 *
1010 */
admin/api.htmlnew file+146
@@ -0,0 +1,146 @@
1+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3+
4+
5+<html xmlns="http://www.w3.org/1999/xhtml">
6+ <head>
7+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8+
9+ <title>Administration API &mdash; searx 0.9.0 documentation</title>
10+
11+ <link rel="stylesheet" href="../_static/style.css" type="text/css" />
12+ <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13+
14+ <script type="text/javascript">
15+ var DOCUMENTATION_OPTIONS = {
16+ URL_ROOT: '../',
17+ VERSION: '0.9.0',
18+ COLLAPSE_INDEX: false,
19+ FILE_SUFFIX: '.html',
20+ HAS_SOURCE: true
21+ };
22+ </script>
23+ <script type="text/javascript" src="../_static/jquery.js"></script>
24+ <script type="text/javascript" src="../_static/underscore.js"></script>
25+ <script type="text/javascript" src="../_static/doctools.js"></script>
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
27+ <link rel="next" title="Development Quickstart" href="../dev/quickstart.html" />
28+ <link rel="prev" title="Installation" href="../dev/install/installation.html" />
29+
30+
31+ <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
32+ <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
33+
34+ </head>
35+ <body role="document">
36+
37+ <div class="document">
38+ <div class="documentwrapper">
39+ <div class="bodywrapper">
40+ <div class="body" role="main">
41+
42+ <div class="section" id="administration-api">
43+<span id="adminapi"></span><h1>Administration API<a class="headerlink" href="#administration-api" title="Permalink to this headline">¶</a></h1>
44+<div class="section" id="get-configuration-data">
45+<h2>Get configuration data<a class="headerlink" href="#get-configuration-data" title="Permalink to this headline">¶</a></h2>
46+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">config</span>
47+</pre></div>
48+</div>
49+<div class="section" id="sample-response">
50+<h3>Sample response<a class="headerlink" href="#sample-response" title="Permalink to this headline">¶</a></h3>
51+<div class="code sh highlight-default"><div class="highlight"><pre><span class="p">{</span>
52+ <span class="s">&quot;autocomplete&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
53+ <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
54+ <span class="s">&quot;map&quot;</span><span class="p">,</span>
55+ <span class="s">&quot;it&quot;</span><span class="p">,</span>
56+ <span class="s">&quot;images&quot;</span><span class="p">,</span>
57+ <span class="p">],</span>
58+ <span class="s">&quot;default_locale&quot;</span><span class="p">:</span> <span class="s">&quot;&quot;</span><span class="p">,</span>
59+ <span class="s">&quot;default_theme&quot;</span><span class="p">:</span> <span class="s">&quot;oscar&quot;</span><span class="p">,</span>
60+ <span class="s">&quot;engines&quot;</span><span class="p">:</span> <span class="p">[</span>
61+ <span class="p">{</span>
62+ <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
63+ <span class="s">&quot;map&quot;</span>
64+ <span class="p">],</span>
65+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
66+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;openstreetmap&quot;</span><span class="p">,</span>
67+ <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;osm&quot;</span>
68+ <span class="p">},</span>
69+ <span class="p">{</span>
70+ <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
71+ <span class="s">&quot;it&quot;</span>
72+ <span class="p">],</span>
73+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
74+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;arch linux wiki&quot;</span><span class="p">,</span>
75+ <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;al&quot;</span>
76+ <span class="p">},</span>
77+ <span class="p">{</span>
78+ <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
79+ <span class="s">&quot;images&quot;</span>
80+ <span class="p">],</span>
81+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
82+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;google images&quot;</span><span class="p">,</span>
83+ <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;goi&quot;</span>
84+ <span class="p">},</span>
85+ <span class="p">{</span>
86+ <span class="s">&quot;categories&quot;</span><span class="p">:</span> <span class="p">[</span>
87+ <span class="s">&quot;it&quot;</span>
88+ <span class="p">],</span>
89+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
90+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;bitbucket&quot;</span><span class="p">,</span>
91+ <span class="s">&quot;shortcut&quot;</span><span class="p">:</span> <span class="s">&quot;bb&quot;</span>
92+ <span class="p">},</span>
93+ <span class="p">],</span>
94+ <span class="s">&quot;instance_name&quot;</span><span class="p">:</span> <span class="s">&quot;searx&quot;</span><span class="p">,</span>
95+ <span class="s">&quot;locales&quot;</span><span class="p">:</span> <span class="p">{</span>
96+ <span class="s">&quot;de&quot;</span><span class="p">:</span> <span class="s">&quot;Deutsch (German)&quot;</span><span class="p">,</span>
97+ <span class="s">&quot;en&quot;</span><span class="p">:</span> <span class="s">&quot;English&quot;</span><span class="p">,</span>
98+ <span class="s">&quot;eo&quot;</span><span class="p">:</span> <span class="s">&quot;Esperanto (Esperanto)&quot;</span><span class="p">,</span>
99+ <span class="p">},</span>
100+ <span class="s">&quot;plugins&quot;</span><span class="p">:</span> <span class="p">[</span>
101+ <span class="p">{</span>
102+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
103+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;HTTPS rewrite&quot;</span>
104+ <span class="p">},</span>
105+ <span class="p">{</span>
106+ <span class="s">&quot;enabled&quot;</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
107+ <span class="s">&quot;name&quot;</span><span class="p">:</span> <span class="s">&quot;Vim-like hotkeys&quot;</span>
108+ <span class="p">}</span>
109+ <span class="p">],</span>
110+ <span class="s">&quot;safe_search&quot;</span><span class="p">:</span> <span class="mi">0</span>
111+<span class="p">}</span>
112+</pre></div>
113+</div>
114+</div>
115+</div>
116+</div>
117+
118+
119+ </div>
120+ </div>
121+ </div>
122+ <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
123+ <div class="sphinxsidebarwrapper"><div class="sidebar_container body">
124+<h1>Searx</h1>
125+<ul>
126+ <li><a href="../index.html">Home</a></li>
127+ <li><a href="https://github.com/asciimoo/searx">Source</a></li>
128+ <li><a href="https://github.com/asciimoo/searx/wiki">Wiki</a></li>
129+ <li><a href="https://github.com/asciimoo/searx/wiki/Searx-instances">Public instances</a></li>
130+</ul>
131+<hr />
132+<ul>
133+ <li><a href="https://twitter.com/Searx_engine">Twitter</a></li>
134+ <li><a href="https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software">Flattr</a></li>
135+ <li><a href="https://gratipay.com/searx">Gratipay</a></li>
136+</ul>
137+</div>
138+ </div>
139+ </div>
140+ <div class="clearer"></div>
141+ </div>
142+ <div class="footer">
143+ &copy; Copyright 2015-2016, Adam Tauber.
144+ </div>
145+ </body>
146+</html>
dev/contribution_guide.html+5−5
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>How to contribute &mdash; searx 0.8.0 documentation</title>
9+ <title>How to contribute &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,8 +23,8 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
27− <link rel="next" title="Installation" href="install/installation.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
27+ <link rel="next" title="Engine overview" href="engine_overview.html" />
2828 <link rel="prev" title="Development Quickstart" href="quickstart.html" />
2929
3030
@@ -146,7 +146,7 @@ files, you have to install it on your system. (It can be installed easily using
146146 <div class="clearer"></div>
147147 </div>
148148 <div class="footer">
149− &copy; Copyright 2015, Adam Tauber.
149+ &copy; Copyright 2015-2016, Adam Tauber.
150150 </div>
151151 </body>
152152</html>
dev/engine_overview.html+16−16
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Engine overview &mdash; searx 0.8.0 documentation</title>
9+ <title>Engine overview &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,9 +23,9 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
2727 <link rel="next" title="Search API" href="search_api.html" />
28− <link rel="prev" title="Installation" href="install/installation.html" />
28+ <link rel="prev" title="How to contribute" href="contribution_guide.html" />
2929
3030
3131 <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -190,10 +190,10 @@ overrides are the following:</p>
190190</div>
191191<div class="section" id="example-code">
192192<h3><a class="toc-backref" href="#id7">example code</a><a class="headerlink" href="#example-code" title="Permalink to this headline">¶</a></h3>
193−<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># engine dependent config</span>
194−<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;general&#39;</span><span class="p">]</span>
195−<span class="n">paging</span> <span class="o">=</span> <span class="bp">True</span>
196−<span class="n">language_support</span> <span class="o">=</span> <span class="bp">True</span>
193+<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># engine dependent config</span>
194+<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;general&#39;</span><span class="p">]</span>
195+<span class="n">paging</span> <span class="o">=</span> <span class="k">True</span>
196+<span class="n">language_support</span> <span class="o">=</span> <span class="k">True</span>
197197</pre></div>
198198</div>
199199</div>
@@ -313,17 +313,17 @@ used to specify a search request:</p>
313313</div>
314314<div class="section" id="id1">
315315<h3><a class="toc-backref" href="#id11">example code</a><a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h3>
316−<div class="code python highlight-python"><div class="highlight"><pre><span class="c1"># search-url</span>
317−<span class="n">base_url</span> <span class="o">=</span> <span class="s1">&#39;https://example.com/&#39;</span>
318−<span class="n">search_string</span> <span class="o">=</span> <span class="s1">&#39;search?{query}&amp;page={page}&#39;</span>
316+<div class="code python highlight-default"><div class="highlight"><pre><span class="c"># search-url</span>
317+<span class="n">base_url</span> <span class="o">=</span> <span class="s">&#39;https://example.com/&#39;</span>
318+<span class="n">search_string</span> <span class="o">=</span> <span class="s">&#39;search?{query}&amp;page={page}&#39;</span>
319319
320−<span class="c1"># do search-request</span>
320+<span class="c"># do search-request</span>
321321<span class="k">def</span> <span class="nf">request</span><span class="p">(</span><span class="n">query</span><span class="p">,</span> <span class="n">params</span><span class="p">):</span>
322322 <span class="n">search_path</span> <span class="o">=</span> <span class="n">search_string</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
323− <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
324− <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s1">&#39;pageno&#39;</span><span class="p">])</span>
323+ <span class="n">query</span><span class="o">=</span><span class="n">urlencode</span><span class="p">({</span><span class="s">&#39;q&#39;</span><span class="p">:</span> <span class="n">query</span><span class="p">}),</span>
324+ <span class="n">page</span><span class="o">=</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;pageno&#39;</span><span class="p">])</span>
325325
326− <span class="n">params</span><span class="p">[</span><span class="s1">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
326+ <span class="n">params</span><span class="p">[</span><span class="s">&#39;url&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">base_url</span> <span class="o">+</span> <span class="n">search_path</span>
327327
328328 <span class="k">return</span> <span class="n">params</span>
329329</pre></div>
@@ -582,7 +582,7 @@ Currently the following media-types are supported:</p>
582582 <div class="clearer"></div>
583583 </div>
584584 <div class="footer">
585− &copy; Copyright 2015, Adam Tauber.
585+ &copy; Copyright 2015-2016, Adam Tauber.
586586 </div>
587587 </body>
588588</html>
dev/install/installation.html+6−6
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Installation &mdash; searx 0.8.0 documentation</title>
9+ <title>Installation &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,9 +23,9 @@
2323 <script type="text/javascript" src="../../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../../index.html" />
27− <link rel="next" title="Engine overview" href="../engine_overview.html" />
28− <link rel="prev" title="How to contribute" href="../contribution_guide.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../../index.html" />
27+ <link rel="next" title="Administration API" href="../../admin/api.html" />
28+ <link rel="prev" title="Search syntax" href="../../user/search_syntax.html" />
2929
3030
3131 <link media="only screen and (max-device-width: 480px)" href="../../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -332,7 +332,7 @@ docker run -d --name searx -p $PORT:8888 wonderfall/searx
332332 <div class="clearer"></div>
333333 </div>
334334 <div class="footer">
335− &copy; Copyright 2015, Adam Tauber.
335+ &copy; Copyright 2015-2016, Adam Tauber.
336336 </div>
337337 </body>
338338</html>
dev/plugins.html+31−35
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Plugins &mdash; searx 0.8.0 documentation</title>
9+ <title>Plugins &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
2727 <link rel="next" title="Translation" href="translation.html" />
2828 <link rel="prev" title="Search API" href="search_api.html" />
2929
@@ -41,46 +41,42 @@
4141
4242 <div class="section" id="plugins">
4343<h1>Plugins<a class="headerlink" href="#plugins" title="Permalink to this headline">¶</a></h1>
44−<p>Plugins can extend/replace functionality of various components inside
44+<p>Plugins can extend or replace functionality of various components of
4545searx.</p>
46−<div class="section" id="example-plugin-py">
47−<h2>example_plugin.py<a class="headerlink" href="#example-plugin-py" title="Permalink to this headline">¶</a></h2>
48−<div class="code python highlight-python"><div class="highlight"><pre><span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;Example plugin&#39;</span>
49−<span class="n">description</span> <span class="o">=</span> <span class="s1">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
50−<span class="n">default_on</span> <span class="o">=</span> <span class="bp">False</span> <span class="c1"># disable by default</span>
46+<div class="section" id="example-plugin">
47+<h2>Example plugin<a class="headerlink" href="#example-plugin" title="Permalink to this headline">¶</a></h2>
48+<div class="code python highlight-default"><div class="highlight"><pre><span class="n">name</span> <span class="o">=</span> <span class="s">&#39;Example plugin&#39;</span>
49+<span class="n">description</span> <span class="o">=</span> <span class="s">&#39;This plugin extends the suggestions with the word &quot;example&quot;&#39;</span>
50+<span class="n">default_on</span> <span class="o">=</span> <span class="k">False</span> <span class="c"># disable by default</span>
5151
52−<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c1"># optional, list of static js files</span>
53−<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c1"># optional, list of static css files</span>
52+<span class="n">js_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c"># optional, list of static js files</span>
53+<span class="n">css_dependencies</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">()</span> <span class="c"># optional, list of static css files</span>
5454
5555
56−<span class="c1"># attach callback to the post search hook</span>
57−<span class="c1"># request: flask request object</span>
58−<span class="c1"># ctx: the whole local context of the post search hook</span>
56+<span class="c"># attach callback to the post search hook</span>
57+<span class="c"># request: flask request object</span>
58+<span class="c"># ctx: the whole local context of the post search hook</span>
5959<span class="k">def</span> <span class="nf">post_search</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">ctx</span><span class="p">):</span>
60− <span class="n">ctx</span><span class="p">[</span><span class="s1">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s1">&#39;example&#39;</span><span class="p">)</span>
61− <span class="k">return</span> <span class="bp">True</span>
60+ <span class="n">ctx</span><span class="p">[</span><span class="s">&#39;search&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">suggestions</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="s">&#39;example&#39;</span><span class="p">)</span>
61+ <span class="k">return</span> <span class="k">True</span>
6262</pre></div>
6363</div>
6464</div>
65−<div class="section" id="currently-implemented-plugin-entry-points-a-k-a-hooks">
66−<h2>Currently implemented plugin entry points (a.k.a hooks)<a class="headerlink" href="#currently-implemented-plugin-entry-points-a-k-a-hooks" title="Permalink to this headline">¶</a></h2>
67−<ul class="simple">
68−<li>Pre search hook (<code class="docutils literal"><span class="pre">pre_search</span></code>)</li>
69−<li>Post search hook (<code class="docutils literal"><span class="pre">post_search</span></code>)</li>
70−<li>Result hook (<code class="docutils literal"><span class="pre">on_result</span></code>) (is called if a new result is added (see
71−https_rewrite plugin))</li>
72−</ul>
73−<p>Feel free to add more hooks to the code if it is required by a plugin.</p>
65+<div class="section" id="plugin-entry-points">
66+<h2>Plugin entry points<a class="headerlink" href="#plugin-entry-points" title="Permalink to this headline">¶</a></h2>
67+<p>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.</p>
68+<div class="section" id="pre-search-hook">
69+<h3>Pre search hook<a class="headerlink" href="#pre-search-hook" title="Permalink to this headline">¶</a></h3>
70+<p>Runs BEFORE the search request. Function to implement: <code class="docutils literal"><span class="pre">pre_search</span></code></p>
71+</div>
72+<div class="section" id="post-search-hook">
73+<h3>Post search hook<a class="headerlink" href="#post-search-hook" title="Permalink to this headline">¶</a></h3>
74+<p>Runs AFTER the search request. Function to implement: <code class="docutils literal"><span class="pre">post_search</span></code></p>
75+</div>
76+<div class="section" id="result-hook">
77+<h3>Result hook<a class="headerlink" href="#result-hook" title="Permalink to this headline">¶</a></h3>
78+<p>Runs when a new result is added to the result list. Function to implement: <code class="docutils literal"><span class="pre">on_result</span></code></p>
7479</div>
75−<div class="section" id="todo">
76−<h2>TODO<a class="headerlink" href="#todo" title="Permalink to this headline">¶</a></h2>
77−<ul class="simple">
78−<li>Better documentation</li>
79−<li>More hooks</li>
80−<li>search hook (is called while searx is requesting results (for
81−example: things like math-solver), the different hooks are running
82−parallel)</li>
83−</ul>
8480</div>
8581</div>
8682
@@ -109,7 +105,7 @@ parallel)</li>
109105 <div class="clearer"></div>
110106 </div>
111107 <div class="footer">
112− &copy; Copyright 2015, Adam Tauber.
108+ &copy; Copyright 2015-2016, Adam Tauber.
113109 </div>
114110 </body>
115111</html>
dev/quickstart.html+5−5
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Development Quickstart &mdash; searx 0.8.0 documentation</title>
9+ <title>Development Quickstart &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,9 +23,9 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
2727 <link rel="next" title="How to contribute" href="contribution_guide.html" />
28− <link rel="prev" title="Search syntax" href="../user/search_syntax.html" />
28+ <link rel="prev" title="Administration API" href="../admin/api.html" />
2929
3030
3131 <link media="only screen and (max-device-width: 480px)" href="../_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -154,7 +154,7 @@ locally before creating a PR.</p>
154154 <div class="clearer"></div>
155155 </div>
156156 <div class="footer">
157− &copy; Copyright 2015, Adam Tauber.
157+ &copy; Copyright 2015-2016, Adam Tauber.
158158 </div>
159159 </body>
160160</html>
dev/search_api.html+17−10
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Search API &mdash; searx 0.8.0 documentation</title>
9+ <title>Search API &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
2727 <link rel="next" title="Plugins" href="plugins.html" />
2828 <link rel="prev" title="Engine overview" href="engine_overview.html" />
2929
@@ -41,9 +41,13 @@
4141
4242 <div class="section" id="search-api">
4343<h1>Search API<a class="headerlink" href="#search-api" title="Permalink to this headline">¶</a></h1>
44−<div class="section" id="search-api-endpoints-search">
45−<h2>Search API endpoints: <code class="docutils literal"><span class="pre">/</span></code>, <code class="docutils literal"><span class="pre">/search</span></code><a class="headerlink" href="#search-api-endpoints-search" title="Permalink to this headline">¶</a></h2>
46−<p>Endpoints have equivalent functionality.</p>
44+<p>The search supports both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code>. However, using <code class="docutils literal"><span class="pre">GET</span></code> the parameters of the request remain hidden. So it is advised to use <code class="docutils literal"><span class="pre">GET</span></code> for querying.</p>
45+<p>Furthermore, two enpoints <code class="docutils literal"><span class="pre">/</span></code> and <code class="docutils literal"><span class="pre">/search</span></code> are available for querying.</p>
46+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span>
47+</pre></div>
48+</div>
49+<div class="code sh highlight-default"><div class="highlight"><pre><span class="n">GET</span> <span class="o">/</span><span class="n">search</span>
50+</pre></div>
4751</div>
4852<div class="section" id="parameters">
4953<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
@@ -61,7 +65,7 @@
6165</thead>
6266<tbody valign="top">
6367<tr class="row-even"><td><code class="docutils literal"><span class="pre">q</span></code></td>
64−<td>The search query, see <a class="reference internal" href="../user/search_syntax.html"><em>Search syntax</em></a></td>
68+<td>The search query, see <a class="reference internal" href="../user/search_syntax.html"><span class="doc">Search syntax</span></a></td>
6569<td>required</td>
6670</tr>
6771<tr class="row-odd"><td><code class="docutils literal"><span class="pre">categories</span></code></td>
@@ -72,13 +76,16 @@
7276<td>Comma separated list, specifies the active search engines</td>
7377<td>optional</td>
7478</tr>
75−<tr class="row-odd"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
79+<tr class="row-odd"><td><code class="docutils literal"><span class="pre">lang</span></code></td>
80+<td>Code of the language</td>
81+<td>optional (default: <code class="docutils literal"><span class="pre">all</span></code>)</td>
82+</tr>
83+<tr class="row-even"><td><code class="docutils literal"><span class="pre">pageno</span></code></td>
7684<td>Search page number</td>
7785<td>optional (default: <code class="docutils literal"><span class="pre">1</span></code>)</td>
7886</tr>
7987</tbody>
8088</table>
81−<p>Both <code class="docutils literal"><span class="pre">GET</span></code> and <code class="docutils literal"><span class="pre">POST</span></code> methods are supported.</p>
8289</div>
8390</div>
8491
@@ -107,7 +114,7 @@
107114 <div class="clearer"></div>
108115 </div>
109116 <div class="footer">
110− &copy; Copyright 2015, Adam Tauber.
117+ &copy; Copyright 2015-2016, Adam Tauber.
111118 </div>
112119 </body>
113120</html>
dev/translation.html+14−14
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Translation &mdash; searx 0.8.0 documentation</title>
9+ <title>Translation &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
2727 <link rel="prev" title="Plugins" href="plugins.html" />
2828
2929
@@ -43,13 +43,13 @@
4343<p>run these commands in the root directory of searx</p>
4444<div class="section" id="add-new-language">
4545<h2>Add new language<a class="headerlink" href="#add-new-language" title="Permalink to this headline">¶</a></h2>
46−<div class="code shell highlight-python"><div class="highlight"><pre>pybabel init -i messages.pot -d searx/translations -l it
46+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="n">init</span> <span class="o">-</span><span class="n">i</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span> <span class="o">-</span><span class="n">l</span> <span class="n">it</span>
4747</pre></div>
4848</div>
4949</div>
5050<div class="section" id="update-po-files">
5151<h2>Update .po files<a class="headerlink" href="#update-po-files" title="Permalink to this headline">¶</a></h2>
52−<div class="code shell highlight-python"><div class="highlight"><pre>./utils/update-translations.sh
52+<div class="code shell highlight-default"><div class="highlight"><pre><span class="o">./</span><span class="n">utils</span><span class="o">/</span><span class="n">update</span><span class="o">-</span><span class="n">translations</span><span class="o">.</span><span class="n">sh</span>
5353</pre></div>
5454</div>
5555<p>You may have errors here. In that case, edit the
@@ -59,7 +59,7 @@
5959</div>
6060<div class="section" id="compile-translations">
6161<h2>Compile translations<a class="headerlink" href="#compile-translations" title="Permalink to this headline">¶</a></h2>
62−<div class="code shell highlight-python"><div class="highlight"><pre>pybabel compile -d searx/translations
62+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">pybabel</span> <span class="nb">compile</span> <span class="o">-</span><span class="n">d</span> <span class="n">searx</span><span class="o">/</span><span class="n">translations</span>
6363</pre></div>
6464</div>
6565</div>
@@ -67,10 +67,10 @@
6767<h2>Transifex stuff<a class="headerlink" href="#transifex-stuff" title="Permalink to this headline">¶</a></h2>
6868<div class="section" id="init-project">
6969<h3>Init Project<a class="headerlink" href="#init-project" title="Permalink to this headline">¶</a></h3>
70−<div class="code shell highlight-python"><div class="highlight"><pre>tx init # Transifex instance: https://www.transifex.com/asciimoo/searx/
70+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">init</span> <span class="c"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
7171
72−tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39; \
73−--source-lang en --type PO --source-file messages.pot --execute
72+<span class="n">tx</span> <span class="nb">set</span> <span class="o">--</span><span class="n">auto</span><span class="o">-</span><span class="n">local</span> <span class="o">-</span><span class="n">r</span> <span class="n">searx</span><span class="o">.</span><span class="n">messagespo</span> <span class="s">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> \
73+<span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">lang</span> <span class="n">en</span> <span class="o">--</span><span class="nb">type</span> <span class="n">PO</span> <span class="o">--</span><span class="n">source</span><span class="o">-</span><span class="n">file</span> <span class="n">messages</span><span class="o">.</span><span class="n">pot</span> <span class="o">--</span><span class="n">execute</span>
7474</pre></div>
7575</div>
7676<p><a class="reference external" href="http://docs.transifex.com/client/init/">http://docs.transifex.com/client/init/</a></p>
@@ -78,27 +78,27 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
7878</div>
7979<div class="section" id="get-translations">
8080<h3>Get translations<a class="headerlink" href="#get-translations" title="Permalink to this headline">¶</a></h3>
81−<div class="code shell highlight-python"><div class="highlight"><pre>tx pull -a
81+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">pull</span> <span class="o">-</span><span class="n">a</span>
8282</pre></div>
8383</div>
8484<p><a class="reference external" href="http://docs.transifex.com/client/pull">http://docs.transifex.com/client/pull</a></p>
8585</div>
8686<div class="section" id="upload-source-file">
8787<h3>Upload source File<a class="headerlink" href="#upload-source-file" title="Permalink to this headline">¶</a></h3>
88−<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s
88+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span>
8989</pre></div>
9090</div>
9191</div>
9292<div class="section" id="upload-all-translation">
9393<h3>Upload all Translation<a class="headerlink" href="#upload-all-translation" title="Permalink to this headline">¶</a></h3>
94−<div class="code shell highlight-python"><div class="highlight"><pre>tx push -s -t
94+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">s</span> <span class="o">-</span><span class="n">t</span>
9595</pre></div>
9696</div>
9797</div>
9898</div>
9999<div class="section" id="upload-specifc-translation">
100100<h2>upload specifc Translation<a class="headerlink" href="#upload-specifc-translation" title="Permalink to this headline">¶</a></h2>
101−<div class="code shell highlight-python"><div class="highlight"><pre>tx push -t -l tr
101+<div class="code shell highlight-default"><div class="highlight"><pre><span class="n">tx</span> <span class="n">push</span> <span class="o">-</span><span class="n">t</span> <span class="o">-</span><span class="n">l</span> <span class="n">tr</span>
102102</pre></div>
103103</div>
104104<p><a class="reference external" href="http://docs.transifex.com/client/push">http://docs.transifex.com/client/push</a></p>
@@ -130,7 +130,7 @@ tx set --auto-local -r searx.messagespo &#39;searx/translations/&lt;lang&gt;/LC_
130130 <div class="clearer"></div>
131131 </div>
132132 <div class="footer">
133− &copy; Copyright 2015, Adam Tauber.
133+ &copy; Copyright 2015-2016, Adam Tauber.
134134 </div>
135135 </body>
136136</html>
docs/_themes/searx_theme/static/style.css_t+2
@@ -38,6 +38,8 @@ div.bodywrapper {
3838
3939div.sphinxsidebar {
4040 width: {{ sidebar_width }};
41+ word-wrap: normal !important;
42+ overflow-wrap: normal !important;
4143}
4244
4345hr {
docs/admin/api.rstnew file+78
@@ -0,0 +1,78 @@
1+.. _adminapi:
2+
3+Administration API
4+------------------
5+
6+Get configuration data
7+~~~~~~~~~~~~~~~~~~~~~~
8+
9+.. code:: sh
10+
11+ GET /config
12+
13+Sample response
14+```````````````
15+
16+.. code:: sh
17+
18+ {
19+ "autocomplete": "",
20+ "categories": [
21+ "map",
22+ "it",
23+ "images",
24+ ],
25+ "default_locale": "",
26+ "default_theme": "oscar",
27+ "engines": [
28+ {
29+ "categories": [
30+ "map"
31+ ],
32+ "enabled": true,
33+ "name": "openstreetmap",
34+ "shortcut": "osm"
35+ },
36+ {
37+ "categories": [
38+ "it"
39+ ],
40+ "enabled": true,
41+ "name": "arch linux wiki",
42+ "shortcut": "al"
43+ },
44+ {
45+ "categories": [
46+ "images"
47+ ],
48+ "enabled": true,
49+ "name": "google images",
50+ "shortcut": "goi"
51+ },
52+ {
53+ "categories": [
54+ "it"
55+ ],
56+ "enabled": false,
57+ "name": "bitbucket",
58+ "shortcut": "bb"
59+ },
60+ ],
61+ "instance_name": "searx",
62+ "locales": {
63+ "de": "Deutsch (German)",
64+ "en": "English",
65+ "eo": "Esperanto (Esperanto)",
66+ },
67+ "plugins": [
68+ {
69+ "enabled": true,
70+ "name": "HTTPS rewrite"
71+ },
72+ {
73+ "enabled": false,
74+ "name": "Vim-like hotkeys"
75+ }
76+ ],
77+ "safe_search": 0
78+ }
docs/conf.py+3−3
@@ -49,7 +49,7 @@ master_doc = 'index'
4949
5050# General information about the project.
5151project = u'searx'
52−copyright = u'2015, Adam Tauber'
52+copyright = u'2015-2016, Adam Tauber'
5353author = u'Adam Tauber'
5454
5555# The version info for the project you're documenting, acts as replacement for
@@ -57,9 +57,9 @@ author = u'Adam Tauber'
5757# built documents.
5858#
5959# The short X.Y version.
60−version = '0.8.0'
60+version = '0.9.0'
6161# The full version, including alpha/beta/rc tags.
62−release = '0.8.0'
62+release = '0.9.0'
6363
6464# The language for content autogenerated by Sphinx. Refer to documentation
6565# for a list of supported languages.
docs/dev/plugins.rst+17−17
@@ -1,11 +1,11 @@
11Plugins
22-------
33
4−Plugins can extend/replace functionality of various components inside
4+Plugins can extend or replace functionality of various components of
55searx.
66
7−example\_plugin.py
8−~~~~~~~~~~~~~~~~~~
7+Example plugin
8+~~~~~~~~~~~~~~
99
1010.. code:: python
1111
@@ -24,22 +24,22 @@ example\_plugin.py
2424 ctx['search'].suggestions.add('example')
2525 return True
2626
27−Currently implemented plugin entry points (a.k.a hooks)
28−~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27+Plugin entry points
28+~~~~~~~~~~~~~~~~~~~
2929
30−- Pre search hook (``pre_search``)
31−- Post search hook (``post_search``)
32−- Result hook (``on_result``) (is called if a new result is added (see
33− https\_rewrite plugin))
30+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.
3431
35−Feel free to add more hooks to the code if it is required by a plugin.
32+Pre search hook
33+```````````````
3634
37−TODO
38−~~~~
35+Runs BEFORE the search request. Function to implement: ``pre_search``
3936
40−- Better documentation
41−- More hooks
42−- search hook (is called while searx is requesting results (for
43− example: things like math-solver), the different hooks are running
44− parallel)
37+Post search hook
38+````````````````
4539
40+Runs AFTER the search request. Function to implement: ``post_search``
41+
42+Result hook
43+```````````
44+
45+Runs when a new result is added to the result list. Function to implement: ``on_result``
docs/dev/search_api.rst+13−6
@@ -1,13 +1,20 @@
11Search API
22==========
33
4−Search API endpoints: ``/``, ``/search``
5−^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4+The search supports both ``GET`` and ``POST``. However, using ``GET`` the parameters of the request remain hidden. So it is advised to use ``GET`` for querying.
65
7−Endpoints have equivalent functionality.
6+Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
7+
8+.. code:: sh
9+
10+ GET /
11+
12+.. code:: sh
13+
14+ GET /search
815
916Parameters
10−^^^^^^^^^^
17+``````````
1118
1219+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
1320| Name | Description | |
@@ -18,7 +25,7 @@ Parameters
1825+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
1926| ``engines`` | Comma separated list, specifies the active search engines | optional |
2027+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
28+| ``lang`` | Code of the language | optional (default: ``all``) |
29++------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
2130| ``pageno`` | Search page number | optional (default: ``1``) |
2231+------------------+----------------------------------------------------------------------------------------------------+-----------------------------+
23−
24−Both ``GET`` and ``POST`` methods are supported.
docs/index.rst+15−6
@@ -1,7 +1,7 @@
1−Privacy-respecting free metasearch engine
2−=========================================
1+Welcome to searx
2+================
33
4−Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
4+Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users' data with third parties. Additionally, searx can be used over Tor for online anonymity.
55
66
77Features
@@ -15,16 +15,26 @@ Features
1515 - Does not collect its users data
1616 - Offers secure, encrypted connections (HTTPS/SSL)
1717 - Hosted by organisations, such as La Quadrature du Net, which promote digital rights
18+ - About 70 supported search engines
19+ - Easy intergration with any search engine
1820
1921
20−Further reading
21−---------------
22+User documentation
23+------------------
2224
2325.. toctree::
2426 :maxdepth: 1
2527
2628 user/search_syntax
2729
30+Administrator documentation
31+---------------------------
32+
33+.. toctree::
34+ :maxdepth: 1
35+
36+ dev/install/installation
37+ admin/api
2838
2939Developer documentation
3040-----------------------
@@ -34,7 +44,6 @@ Developer documentation
3444
3545 dev/quickstart
3646 dev/contribution_guide
37− dev/install/installation
3847 dev/engine_overview
3948 dev/search_api
4049 dev/plugins
genindex.html+4−4
@@ -7,7 +7,7 @@
77 <head>
88 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
99
10− <title>Index &mdash; searx 0.8.0 documentation</title>
10+ <title>Index &mdash; searx 0.9.0 documentation</title>
1111
1212 <link rel="stylesheet" href="_static/style.css" type="text/css" />
1313 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -15,7 +15,7 @@
1515 <script type="text/javascript">
1616 var DOCUMENTATION_OPTIONS = {
1717 URL_ROOT: './',
18− VERSION: '0.8.0',
18+ VERSION: '0.9.0',
1919 COLLAPSE_INDEX: false,
2020 FILE_SUFFIX: '.html',
2121 HAS_SOURCE: true
@@ -24,7 +24,7 @@
2424 <script type="text/javascript" src="_static/jquery.js"></script>
2525 <script type="text/javascript" src="_static/underscore.js"></script>
2626 <script type="text/javascript" src="_static/doctools.js"></script>
27− <link rel="top" title="searx 0.8.0 documentation" href="index.html" />
27+ <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
2828
2929
3030 <link media="only screen and (max-device-width: 480px)" href="_static/small_flask.css" type= "text/css" rel="stylesheet" />
@@ -73,7 +73,7 @@
7373 <div class="clearer"></div>
7474 </div>
7575 <div class="footer">
76− &copy; Copyright 2015, Adam Tauber.
76+ &copy; Copyright 2015-2016, Adam Tauber.
7777 </div>
7878 </body>
7979</html>
index.html+20−10
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Privacy-respecting free metasearch engine &mdash; searx 0.8.0 documentation</title>
9+ <title>Welcome to searx &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: './',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,7 +23,7 @@
2323 <script type="text/javascript" src="_static/jquery.js"></script>
2424 <script type="text/javascript" src="_static/underscore.js"></script>
2525 <script type="text/javascript" src="_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="#" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="#" />
2727 <link rel="next" title="Search syntax" href="user/search_syntax.html" />
2828
2929
@@ -38,9 +38,9 @@
3838 <div class="bodywrapper">
3939 <div class="body" role="main">
4040
41− <div class="section" id="privacy-respecting-free-metasearch-engine">
42−<h1>Privacy-respecting free metasearch engine<a class="headerlink" href="#privacy-respecting-free-metasearch-engine" title="Permalink to this headline">¶</a></h1>
43−<p>Searx is a free software internet metasearch engine which aggregates results from other search engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
41+ <div class="section" id="welcome-to-searx">
42+<h1>Welcome to searx<a class="headerlink" href="#welcome-to-searx" title="Permalink to this headline">¶</a></h1>
43+<p>Searx is a free software internet metasearch engine which aggregates results from more than 70 engines, while not storing information about its users. Searx does not track or profile its users, nor does it share its users&#8217; data with third parties. Additionally, searx can be used over Tor for online anonymity.</p>
4444<div class="section" id="features">
4545<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline">¶</a></h2>
4646<blockquote>
@@ -53,24 +53,34 @@
5353<li>Does not collect its users data</li>
5454<li>Offers secure, encrypted connections (HTTPS/SSL)</li>
5555<li>Hosted by organisations, such as La Quadrature du Net, which promote digital rights</li>
56+<li>About 70 supported search engines</li>
57+<li>Easy intergration with any search engine</li>
5658</ul>
5759</div></blockquote>
5860</div>
59−<div class="section" id="further-reading">
60−<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline">¶</a></h2>
61+<div class="section" id="user-documentation">
62+<h2>User documentation<a class="headerlink" href="#user-documentation" title="Permalink to this headline">¶</a></h2>
6163<div class="toctree-wrapper compound">
6264<ul>
6365<li class="toctree-l1"><a class="reference internal" href="user/search_syntax.html">Search syntax</a></li>
6466</ul>
6567</div>
6668</div>
69+<div class="section" id="administrator-documentation">
70+<h2>Administrator documentation<a class="headerlink" href="#administrator-documentation" title="Permalink to this headline">¶</a></h2>
71+<div class="toctree-wrapper compound">
72+<ul>
73+<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
74+<li class="toctree-l1"><a class="reference internal" href="admin/api.html">Administration API</a></li>
75+</ul>
76+</div>
77+</div>
6778<div class="section" id="developer-documentation">
6879<h2>Developer documentation<a class="headerlink" href="#developer-documentation" title="Permalink to this headline">¶</a></h2>
6980<div class="toctree-wrapper compound">
7081<ul>
7182<li class="toctree-l1"><a class="reference internal" href="dev/quickstart.html">Development Quickstart</a></li>
7283<li class="toctree-l1"><a class="reference internal" href="dev/contribution_guide.html">How to contribute</a></li>
73−<li class="toctree-l1"><a class="reference internal" href="dev/install/installation.html">Installation</a></li>
7484<li class="toctree-l1"><a class="reference internal" href="dev/engine_overview.html">Engine overview</a></li>
7585<li class="toctree-l1"><a class="reference internal" href="dev/search_api.html">Search API</a></li>
7686<li class="toctree-l1"><a class="reference internal" href="dev/plugins.html">Plugins</a></li>
@@ -105,7 +115,7 @@
105115 <div class="clearer"></div>
106116 </div>
107117 <div class="footer">
108− &copy; Copyright 2015, Adam Tauber.
118+ &copy; Copyright 2015-2016, Adam Tauber.
109119 </div>
110120 </body>
111121</html>
objects.inv

Binary file not shown.

search.html+4−4
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Search &mdash; searx 0.8.0 documentation</title>
9+ <title>Search &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: './',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -24,7 +24,7 @@
2424 <script type="text/javascript" src="_static/underscore.js"></script>
2525 <script type="text/javascript" src="_static/doctools.js"></script>
2626 <script type="text/javascript" src="_static/searchtools.js"></script>
27− <link rel="top" title="searx 0.8.0 documentation" href="index.html" />
27+ <link rel="top" title="searx 0.9.0 documentation" href="index.html" />
2828 <script type="text/javascript">
2929 jQuery(function() { Search.loadIndex("searchindex.js"); });
3030 </script>
@@ -93,7 +93,7 @@
9393 <div class="clearer"></div>
9494 </div>
9595 <div class="footer">
96− &copy; Copyright 2015, Adam Tauber.
96+ &copy; Copyright 2015-2016, Adam Tauber.
9797 </div>
9898 </body>
9999</html>
searchindex.js+1−1
@@ -1 +1 @@
1−Search.setIndex({envversion:46,filenames:["dev/contribution_guide","dev/engine_overview","dev/install/installation","dev/plugins","dev/search_api","dev/translation","index","user/search_syntax"],objects:{},objnames:{},objtypes:{},terms:{"boolean":1,"break":0,"byte":1,"case":5,"char":[],"default":[],"function":[1,3,4],"import":2,"int":1,"new":[],"null":2,"return":[],"static":3,"switch":0,"true":[1,2,3],"while":[3,6],a2enmod:2,abbrev:7,abl:[0,1],about:[0,2,6],abov:[0,2],accept:7,access_log:2,activ:[2,4],adapt:1,add:[],addit:[1,2],addition:6,address:1,adopt:0,adress:1,after:5,agent:1,aggreg:6,all:[],allow:[2,7],alreadi:0,also:[0,2,7],alter:0,alwai:1,among:0,anonym:6,anoth:1,apache2:2,api_kei:1,app:2,appli:[0,2],applic:2,appreci:[],appropri:0,apt:2,arbitrari:1,arrai:1,asciimoo:[2,5],aspect:0,assign:1,attach:3,author:0,auto:5,avail:2,back:2,base:1,base_url:[1,2],bash:2,becaus:[0,1],behaviour:0,below:[0,2],better:[1,2,3],between:1,bin:2,born:0,both:[0,4],boundingbox:1,branch:0,browser:0,bugreport:0,build:[0,2],built:[0,1],calcul:[],call:3,callback:3,can:[0,1,2,3,5,6],capabl:0,care:[],categori:[1,4,7],certif:2,chainabl:7,chang:[2,5],chapter:0,charact:0,chdir:2,checkout:0,chmod:2,choos:[0,1],chown:2,citi:1,client:5,clone:2,collect:6,com:[1,2,5],combin:2,come:0,comma:4,command:[2,5],compon:3,concern:0,conf:2,config:[1,2],connect:6,consequ:0,construct:1,contain:[],content:[],context:3,convent:0,cooki:[1,6],corner:0,could:1,count:2,countri:1,coupl:2,cpu:2,creat:[0,2],css:3,css_depend:3,cthulhu:7,ctx:3,current:[],custom:[0,7],customlog:2,data:[1,6],date:1,datetim:1,ddg:7,debian:2,debug:2,decim:1,def:[1,3],default_on:3,demon:2,depend:[1,2],deploi:2,descript:[3,4],deserv:0,desir:1,dev:2,develop:[],deviat:[],differ:[0,1,3],digit:6,directori:5,disrespect:0,doc:5,dockerfil:2,doe:[1,6],doesn:[],domain:2,domin:0,don:[],duckduckgo:7,easili:0,edit:[0,2,5],educ:[],effect:0,embed:2,empti:[],en_u:1,enabl:[0,2],encrypt:6,engin:[],enough:[],enter:2,equival:4,error:5,error_log:2,essenti:2,etc:[0,2],everi:1,everyth:2,exampl:[],except:0,execut:5,exist:0,exit:2,expand:[],expect:0,explain:0,extend:[0,3],extens:0,extern:1,facil:[],fals:[2,3],fanci:0,featur:[],feedback:0,feel:3,few:[0,1],file:[],filenam:1,files:1,fill:[],fine:2,fix:0,flask:3,folder:[0,1],follow:[0,1],followsymlink:2,forget:[],fork:0,format:1,free:[],from:[],further:[],furthermor:1,geojson:1,get:[],gid:2,git:2,github:2,give:1,goal:[],goe:[],good:0,grant:2,hack:0,hackerspac:7,handler:2,happen:[],happi:0,have:[0,1,2,4,5],header:1,here:5,hex:2,highli:[],hour:2,hous:1,house_numb:1,howev:1,html:[0,1],http:[1,2,5,6],https_rewrit:3,hub:2,imag:[],img_src:1,implement:[],includ:2,inclus:7,index:2,inform:[0,1,2,6],ini:2,init:[],insert:[],insid:[1,3],instanc:[2,5],intent:0,interfer:0,internet:6,interpret:2,interpretor:2,iso:1,itself:0,js_depend:3,kei:1,known:[],lack:0,lang:5,language_support:1,lat:1,latitud:1,lc_messag:5,least:[],leech:1,leecher:1,length:0,level:0,libapache2:2,libffi:2,librari:[],libssl:2,libxslt:2,light:2,like:[1,2,3],line:0,list:[1,3,4,7],listen:2,local:[1,2,3,5],localhost:2,locat:2,lon:1,longitud:1,magnet_uri_schem:[],magnetlink:1,mai:5,main:[],make:[],manag:2,manner:[],map:[],mass:0,master:2,math:3,matter:1,max:1,maxim:0,maximis:[],maximum:[0,1],mayb:[],media:1,messag:5,messagespo:5,meta:[],method:[1,4],might:0,min:1,misbehav:0,mod:2,modif:[],modifi:[5,7],modul:2,more:[2,3],most:[],multibl:1,must:[0,1],name:[1,2,3,4],necessari:2,need:0,net:6,none:1,nor:6,normal:1,note:[0,2],number:[1,2,4],number_of_result:1,object:[1,3],observ:[],off:0,offer:6,often:1,okhin:2,on_result:3,onli:[],onlin:6,openssl:2,option:[1,2,3,4],order:0,org:1,organis:6,origin:2,osm:1,other:[0,1,6],otherwis:1,out:0,over:6,overwrit:[],overwritten:1,packag:2,page:[0,1,4,7],pageno:[1,4],pagenumb:1,parallel:3,param:1,paramt:1,parti:6,partli:1,patch:0,path:2,pep8:0,per:1,perform:1,perserv:[],pip:0,place:[0,1],pleas:0,plenti:0,plugin:[],point:[],port:2,possibl:2,post:[0,2,3,4],post_search:3,postcod:1,pot:5,pre:3,pre_search:3,prefer:7,prefix:7,preserv:0,preview:1,proce:2,profil:6,promot:6,protect:0,provid:[0,1],publish:1,publishedd:1,pull:[0,2,5],purpos:1,push:5,pybabel2:5,pybabel:[2,5],python2:5,python:2,pythonpath:2,quadratur:6,queri:[1,4,7],quit:0,qwer:7,rand:2,random:1,realli:[],recommend:1,reconsid:0,redefin:1,reduc:0,rememb:0,replac:3,repo:0,repositori:2,repres:1,request:[],requir:[0,1,3,4],respec:[],respect:[],restart:2,result:[],rewrit:2,right:[2,6],road:1,root:[2,5],round:0,rst:0,run:[2,3,5],same:1,script:5,script_nam:2,search:[],search_path:1,search_str:1,searx:[],secur:6,sed:2,see:[2,3,4,7],seed:1,seeder:1,select:7,self:6,separ:[0,4],seper:[],server_nam:2,servic:2,set:[],sethandl:2,setup:2,share:6,shortcut:1,should:[0,2],simpli:0,sinc:[],singl:2,site:[1,2],size:1,small:1,socket:2,softwar:6,solver:3,some:2,someth:0,sourc:[],special:1,specif:[1,2],specifi:[1,4],sphinx:0,ssl:[1,2,6],standard:[0,1],start:[1,2],stash:2,step:[0,2,5],store:[1,6],street:1,string:1,submit:0,sudo:2,suggest:3,support:[0,1,4],sure:2,syntax:[],system:0,take:0,taken:[],tell:1,templat:1,test:[0,2],text:1,thi:[1,2,3,5],thing:3,think:0,third:6,three:0,thu:[],thumbnail:1,thumbnail_src:1,time:1,timeout:1,titl:1,tld:2,tool:0,tor:6,torrentfil:1,toward:[],track:6,transifex:[],try_fil:2,tupl:3,turn:0,twice:2,two:0,txt:0,type:[1,5],ubuntu:2,uid:2,ultrasecretkei:2,uncommon:0,under:[0,1],unfortun:0,unit:0,univers:2,unix:2,unspecifi:1,updat:[],update_packag:2,upgrad:[],uri:2,urlencod:1,user:[0,1,2,6],useradd:2,usr:2,usual:2,util:5,uwsgi_modifier1:2,uwsgi_param:2,uwsgi_pass:2,uwsgisocket:2,valid:1,valu:1,variabl:1,variou:[0,3],vendor:0,verifi:1,via:7,virtual:2,virtualenv:2,wai:[0,1],want:[],warn:2,wathev:[],webapp:2,weird:0,welcom:[],what:[],whatev:2,when:1,where:[],which:[0,1,6],who:2,whole:[2,3],wide:0,width:[],wiki:[],wikipedia:7,wish:0,without:1,wonderfal:2,word:3,work:[0,1,2],worker:2,world:0,wsgi:2,www:5,yet:1,yml:[],you:[0,2,5,7],your:[0,2],yourself:0,zlib1g:2},titles:["How to contribute","Engine overview","Installation","Plugins","Search API","Translation","Privacy-respecting free metasearch engine","Search syntax"],titleterms:{"default":1,"new":5,"return":1,add:5,admin:[],all:5,apach:2,api:4,argument:1,basic:2,check:2,code:[0,1],compil:5,configur:[1,2],content:[1,2],contribut:0,current:3,design:0,develop:6,direct:0,disabl:2,docker:2,document:[0,6],endpoint:4,engin:[1,6],entri:3,exampl:[1,7],example_plugin:3,featur:6,file:[1,5],free:6,from:2,further:6,gener:1,get:5,hackabl:0,hook:3,host:2,how:[0,2],imag:1,implement:3,init:5,instal:2,languag:5,log:2,make:1,map:1,metasearch:6,nginx:2,onli:[],overrid:1,overview:1,paramet:4,pars:1,pass:1,plugin:3,point:3,prime:0,privaci:[0,6],project:5,read:6,request:1,respect:6,result:1,search:[4,7],searx:2,server:2,set:1,sourc:5,specifc:5,stuff:5,subdirectori:2,syntax:7,todo:3,torrent:1,transifex:5,translat:[0,5],updat:[2,5],upload:5,url:2,uwsgi:2,video:1,web:2,yml:1}})
1+Search.setIndex({envversion:49,filenames:["dev/plugins","dev/search_api","index"],objects:{},objnames:{},objtypes:{},terms:{"default":[0,1,2],"function":0,"new":0,"return":0,"static":0,"true":0,"while":2,about:2,activ:1,add:0,addition:2,advis:1,after:0,aggreg:2,all:1,ani:2,anonym:2,attach:0,avail:1,before:0,behaviour:0,both:1,callback:0,can:[0,2],categori:1,code:1,collect:2,comma:1,compon:0,connect:2,context:0,contribut:2,cooki:2,css:0,css_depend:0,ctx:0,data:2,def:0,default_on:0,defin:0,descript:[0,1],digit:2,disabl:0,doe:2,easi:2,encrypt:2,engin:[],engine:2,enpoint:1,entry:0,extend:0,fals:0,feel:0,file:0,fit:0,flask:0,free:[],from:2,furthermor:1,get:1,hidden:1,host:2,how:2,howev:1,https:2,implement:0,inform:2,installat:2,intergr:2,internet:2,js_depend:0,lang:1,languag:1,list:[0,1],local:0,more:2,name:[0,1],net:2,nor:2,now:0,number:1,object:0,offer:2,on_result:0,onli:0,onlin:2,option:[0,1],organis:2,over:2,overview:2,page:1,pageno:1,parti:2,post_search:0,pre_search:0,profil:2,promot:2,quadratur:2,queri:1,quickstart:2,remain:1,replac:0,request:[0,1],requir:1,right:[0,2],run:0,searx:0,secur:2,see:1,self:2,separ:1,share:2,softwar:2,specifi:1,ssl:2,store:2,suggest:0,support:[1,2],syntax:[1,2],than:2,thi:0,third:2,three:0,tor:2,track:2,translat:2,tupl:0,two:1,variou:0,when:0,which:2,whole:0,word:0,your:0},titles:["Plugins","Search API","Welcome to searx"],titleterms:{administr:2,api:1,develop:2,doc:[],document:2,engin:[],entri:0,exampl:0,featur:2,free:[],hook:0,metasearch:[],paramet:1,plugin:0,point:0,post:0,pre:0,privaci:[],respect:[],result:0,search:[0,1],searx:2,user:2,welcom:2}})
user/search_syntax.html+5−5
@@ -6,7 +6,7 @@
66 <head>
77 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
88
9− <title>Search syntax &mdash; searx 0.8.0 documentation</title>
9+ <title>Search syntax &mdash; searx 0.9.0 documentation</title>
1010
1111 <link rel="stylesheet" href="../_static/style.css" type="text/css" />
1212 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
@@ -14,7 +14,7 @@
1414 <script type="text/javascript">
1515 var DOCUMENTATION_OPTIONS = {
1616 URL_ROOT: '../',
17− VERSION: '0.8.0',
17+ VERSION: '0.9.0',
1818 COLLAPSE_INDEX: false,
1919 FILE_SUFFIX: '.html',
2020 HAS_SOURCE: true
@@ -23,8 +23,8 @@
2323 <script type="text/javascript" src="../_static/jquery.js"></script>
2424 <script type="text/javascript" src="../_static/underscore.js"></script>
2525 <script type="text/javascript" src="../_static/doctools.js"></script>
26− <link rel="top" title="searx 0.8.0 documentation" href="../index.html" />
27− <link rel="next" title="How to contribute" href="../dev/contribution_guide.html" />
26+ <link rel="top" title="searx 0.9.0 documentation" href="../index.html" />
27+ <link rel="next" title="Installation" href="../dev/install/installation.html" />
2828 <link rel="prev" title="Privacy-respecting free metasearch engine" href="../index.html" />
2929
3030
@@ -90,7 +90,7 @@ list of engines, categories and languages.</p>
9090 <div class="clearer"></div>
9191 </div>
9292 <div class="footer">
93− &copy; Copyright 2015, Adam Tauber.
93+ &copy; Copyright 2015-2016, Adam Tauber.
9494 </div>
9595 </body>
9696</html>