summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2021-12-20 14:02:29 +0100
committerGitHub <noreply@github.com>2021-12-20 14:02:29 +0100
commit6fb6e8c22acda9adf4fcbb5d0665243a9edf336e (patch)
treeb17fc098d61f117f7986900b9c82057e3fcd42f1
parent7a215e07e73067a2058a6235f942025ffcc65513 (diff)
parent1fb1cca519bb81a8143563d9d48b75908a9c778a (diff)
Merge pull request #621 from not-my-profile/engines-table
[doc] Improve engines table
-rw-r--r--docs/admin/engines/configured_engines.rst81
-rw-r--r--searx/settings.yml4
2 files changed, 34 insertions, 51 deletions
diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst
index af20e5611..21bc0e92b 100644
--- a/docs/admin/engines/configured_engines.rst
+++ b/docs/admin/engines/configured_engines.rst
@@ -12,66 +12,47 @@ Configured Engines
Explanation of the :ref:`general engine configuration` shown in the table
:ref:`configured engines`.
-.. table:: The legend for the following table
- :width: 100%
-
- ============= =========== ==================== ============
- :ref:`engine settings` :ref:`engine file`
- ------------------------- ---------------------------------
- Name (cfg) .. Categories
- ------------- ----------- -------------------- ------------
- Engine .. Paging support **P**
- ------------- ----------- -------------------- ------------
- Shortcut **S** Language support **L**
- Timeout **TO** Time range support **TR**
- Disabled **D** Engine type **ET**
- ------------- ----------- -------------------- ------------
- Safe search **SS**
- ------------- ----------- ---------------------------------
- Weigth **W**
- ------------- ----------- ---------------------------------
- Disabled **D**
- ------------- ----------- ---------------------------------
- Show errors **DE**
- ============= =========== =================================
-
.. jinja:: searx
- .. flat-table:: Engines configured at built time (defaults)
- :header-rows: 1
- :stub-columns: 2
+ {% for category, engines in engines.items() | groupby('1.categories.0') %}
- * - Name (cfg)
- - S
- - Engine
- - TO
- - Categories
- - P
- - L
- - SS
- - D
- - TR
- - ET
- - W
- - D
- - DE
+ {{category}} search engines
+ ---------------------------------------
- {% for name, mod in engines.items() %}
+ .. flat-table::
+ :header-rows: 2
+ :stub-columns: 1
- * - {{name}}
- - !{{mod.shortcut}}
+ * - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`)
+ - :cspan:`3` :ref:`Supported features <engine file>`
+
+ * - Name
+ - Shortcut
+ - Engine
+ - Disabled
+ - Timeout
+ - Weight
+ - Paging
+ - Language
+ - Safe search
+ - Time range
+
+ {% for name, mod in engines %}
+
+ * - `{{name}} <{{mod.about and mod.about.website}}>`_
+ - ``!{{mod.shortcut}}``
- {{mod.__name__}}
+ - {{(mod.disabled and "y") or ""}}
- {{mod.timeout}}
- - {{", ".join(mod.categories)}}
+ - {{mod.weight or 1 }}
+ {% if mod.engine_type == 'online' %}
- {{(mod.paging and "y") or ""}}
- {{(mod.language_support and "y") or ""}}
- {{(mod.safesearch and "y") or ""}}
- - {{(mod.disabled and "y") or ""}}
- {{(mod.time_range_support and "y") or ""}}
- - {{mod.engine_type or ""}}
- - {{mod.weight or 1 }}
- - {{(mod.disabled and "y") or ""}}
- - {{(mod.display_error_messages and "y") or ""}}
+ {% else %}
+ - :cspan:`3` not applicable ({{mod.engine_type}})
+ {% endif %}
{% endfor %}
-
+ {% endfor %}
diff --git a/searx/settings.yml b/searx/settings.yml
index 91487b6ba..434ec0fa9 100644
--- a/searx/settings.yml
+++ b/searx/settings.yml
@@ -767,7 +767,7 @@ engines:
categories: it
shortcut: ho
about:
- website: https://www.haskell.org/
+ website: https://hoogle.haskell.org/
wikidata_id: Q34010
official_api_documentation: https://hackage.haskell.org/api
use_official_api: false
@@ -1372,6 +1372,8 @@ engines:
categories: general
shortcut: wib
disabled: true
+ about:
+ website: https://wiby.me/
- name: wikibooks
engine: mediawiki