forked from Icycoide/searxng
doc: proofread of the all reST sources (no content change)
Normalize reST sources with best practice and KISS in mind. to name a few points: - simplify reST tables - make use of ``literal`` markup for monospace rendering - fix code-blocks for better rendering in HTML - normalize section header markup - limit all lines to a maximum of 79 characters - add option -H to the sudo command used in code blocks - drop useless indentation of lists - ... [1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser
parent
0011890043
commit
e9fff4fde6
17 changed files with 700 additions and 753 deletions
|
|
@ -1,3 +1,4 @@
|
|||
==========
|
||||
Search API
|
||||
==========
|
||||
|
||||
|
|
@ -11,194 +12,101 @@ Furthermore, two enpoints ``/`` and ``/search`` are available for querying.
|
|||
``GET /search``
|
||||
|
||||
Parameters
|
||||
~~~~~~~~~~
|
||||
==========
|
||||
|
||||
.. code:: sh
|
||||
``q`` : required
|
||||
The search query. This string is passed to external search services. Thus,
|
||||
searx supports syntax of each search service. For example, ``site:github.com
|
||||
searx`` is a valid query for Google. However, if simply the query above is
|
||||
passed to any search engine which does not filter its results based on this
|
||||
syntax, you might not get the results you wanted.
|
||||
|
||||
q
|
||||
See more at :ref:`search-syntax`
|
||||
|
||||
The search query. This string is passed to external search services.
|
||||
Thus, searx supports syntax of each search service. For example, ``site:github.com searx`` is a valid
|
||||
query for Google. However, if simply the query above is passed to any search engine which does not filter its
|
||||
results based on this syntax, you might not get the results you wanted.
|
||||
``categories`` : optional
|
||||
Comma separated list, specifies the active search categories
|
||||
|
||||
``engines``: optional
|
||||
Comma separated list, specifies the active search engines.
|
||||
|
||||
See more at :doc:`/user/search_syntax`
|
||||
``lang``: default ``all``
|
||||
Code of the language.
|
||||
|
||||
Required.
|
||||
``pageno``: default ``1``
|
||||
Search page number.
|
||||
|
||||
.. code:: sh
|
||||
``time_range``: optional
|
||||
[ ``day``, ``month``, ``year`` ]
|
||||
|
||||
categories
|
||||
Time range of search for engines which support it. See if an engine supports
|
||||
time range search in the preferences page of an instance.
|
||||
|
||||
Comma separated list, specifies the active search categories
|
||||
``format``: optional
|
||||
[ ``json``, ``csv``, ``rss`` ]
|
||||
|
||||
Optional.
|
||||
Output format of results.
|
||||
|
||||
.. code:: sh
|
||||
``results_on_new_tab``: default ``0``
|
||||
[ ``0``, ``1`` ]
|
||||
|
||||
engines
|
||||
Open search results on new tab.
|
||||
|
||||
Comma separated list, specifies the active search engines.
|
||||
``image_proxy``: default ``False``
|
||||
[ ``True``, ``False`` ]
|
||||
|
||||
Optional.
|
||||
Proxy image results through searx.
|
||||
|
||||
.. code:: sh
|
||||
``autocomplete``: default *empty*
|
||||
[ ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia`` ]
|
||||
|
||||
lang
|
||||
Service which completes words as you type.
|
||||
|
||||
Code of the language.
|
||||
``safesearch``: default ``None``
|
||||
[ ``0``, ``1``, ``None`` ]
|
||||
|
||||
Optional.
|
||||
Filter search results of engines which support safe search. See if an engine
|
||||
supports safe search in the preferences page of an instance.
|
||||
|
||||
Default: ``all``
|
||||
``theme``: default ``oscar``
|
||||
[ ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette`` ]
|
||||
|
||||
.. code:: sh
|
||||
Theme of instance.
|
||||
|
||||
pageno
|
||||
Please note, available themes depend on an instance. It is possible that an
|
||||
instance administrator deleted, created or renamed themes on his/her instance.
|
||||
See the available options in the preferences page of the instance.
|
||||
|
||||
Search page number.
|
||||
``oscar-style``: default ``logicodev``
|
||||
[ ``pointhi``, ``logicodev`` ]
|
||||
|
||||
Optional.
|
||||
Style of Oscar theme. It is only parsed if the theme of an instance is
|
||||
``oscar``.
|
||||
|
||||
Default: ``1``
|
||||
Please note, available styles depend on an instance. It is possible that an
|
||||
instance administrator deleted, created or renamed styles on his/her
|
||||
instance. See the available options in the preferences page of the instance.
|
||||
|
||||
.. code:: sh
|
||||
``enabled_plugins``: optional
|
||||
List of enabled plugins.
|
||||
|
||||
time_range
|
||||
:default: ``HTTPS_rewrite``, ``Self_Informations``,
|
||||
``Search_on_category_select``, ``Tracker_URL_remover``
|
||||
|
||||
Time range of search for engines which support it. See if an engine supports time range search in the preferences page of an instance.
|
||||
:values: [ ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
|
||||
``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
|
||||
``Search_on_category_select`` ]
|
||||
|
||||
Optional.
|
||||
``disabled_plugins``: optional
|
||||
List of disabled plugins.
|
||||
|
||||
Possible: ``day``, ``month``, ``year``
|
||||
:default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
|
||||
:values: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``,
|
||||
``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``,
|
||||
``Search_on_category_select``
|
||||
|
||||
.. code:: sh
|
||||
``enabled_engines``: optional : *all* :origin:`engines <searx/engines>`
|
||||
List of enabled engines.
|
||||
|
||||
format
|
||||
``disabled_engines``: optional : *all* :origin:`engines <searx/engines>`
|
||||
List of disabled engines.
|
||||
|
||||
Output format of results.
|
||||
|
||||
Optional.
|
||||
|
||||
Possible: ``json``, ``csv``, ``rss``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
results_on_new_tab
|
||||
|
||||
Open search results on new tab.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``0``
|
||||
|
||||
Possible: ``0``, ``1``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
image_proxy
|
||||
|
||||
Proxy image results through searx.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``False``
|
||||
|
||||
Possible: ``True``, ``False``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
autocomplete
|
||||
|
||||
Service which completes words as you type.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: empty
|
||||
|
||||
Possible: ``google``, ``dbpedia``, ``duckduckgo``, ``startpage``, ``wikipedia``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
safesearch
|
||||
|
||||
Filter search results of engines which support safe search. See if an engine supports safe search in the preferences page of an instance.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``None``
|
||||
|
||||
Possible: ``0``, ``1``, ``None``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
theme
|
||||
|
||||
Theme of instance.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``oscar``
|
||||
|
||||
Possible: ``oscar``, ``simple``, ``legacy``, ``pix-art``, ``courgette``
|
||||
|
||||
Please note, available themes depend on an instance. It is possible that an instance administrator deleted, created or renamed themes on his/her instance. See the available options in the preferences page of the instance.
|
||||
|
||||
.. code:: sh
|
||||
|
||||
oscar-style
|
||||
|
||||
Style of Oscar theme. It is only parsed if the theme of an instance is ``oscar``.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``logicodev``
|
||||
|
||||
Possible: ``pointhi``, ``logicodev``
|
||||
|
||||
Please note, available styles depend on an instance. It is possible that an instance administrator deleted, created or renamed styles on his/her instance. See the available options in the preferences page of the instance.
|
||||
|
||||
.. code:: sh
|
||||
|
||||
enabled_plugins
|
||||
|
||||
List of enabled plugins.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``HTTPS_rewrite``, ``Self_Informations``, ``Search_on_category_select``, ``Tracker_URL_remover``
|
||||
|
||||
Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
disabled_plugins
|
||||
|
||||
List of disabled plugins.
|
||||
|
||||
Optional.
|
||||
|
||||
Default: ``DOAI_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``
|
||||
|
||||
Possible: ``DOAI_rewrite``, ``HTTPS_rewrite``, ``Infinite_scroll``, ``Vim-like_hotkeys``, ``Self_Informations``, ``Tracker_URL_remover``, ``Search_on_category_select``
|
||||
|
||||
.. code:: sh
|
||||
|
||||
enabled_engines
|
||||
|
||||
List of enabled engines.
|
||||
|
||||
Optional.
|
||||
|
||||
Possible: all engines
|
||||
|
||||
.. code:: sh
|
||||
|
||||
disabled_engines
|
||||
|
||||
List of disabled engines.
|
||||
|
||||
Optional.
|
||||
|
||||
Possible: all engines
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue