From 06beffdf3148174e4fc54ef9b5dff702aa846e5e Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 07:59:51 +0100 Subject: [PATCH 01/10] [doc] add about.website for wiby --- searx/settings.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/searx/settings.yml b/searx/settings.yml index 91487b6ba..c01fae52c 100644 --- a/searx/settings.yml +++ b/searx/settings.yml @@ -1372,6 +1372,8 @@ engines: categories: general shortcut: wib disabled: true + about: + website: https://wiby.me/ - name: wikibooks engine: mediawiki From 39799ee74b5fda3c78bff7d3ff716702b02b058a Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 08:02:58 +0100 Subject: [PATCH 02/10] [doc] engine-table: link about.website --- docs/admin/engines/configured_engines.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index af20e5611..5019e25ab 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -58,7 +58,7 @@ Explanation of the :ref:`general engine configuration` shown in the table {% for name, mod in engines.items() %} - * - {{name}} + * - `{{name}} <{{mod.about and mod.about.website}}>`_ - !{{mod.shortcut}} - {{mod.__name__}} - {{mod.timeout}} From 24e1e412445090566bd6fd4b257e8f5ca709b445 Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 09:47:45 +0100 Subject: [PATCH 03/10] [doc] engine-table: remove duplicate Disabled column --- docs/admin/engines/configured_engines.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 5019e25ab..7d5b89384 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -30,8 +30,6 @@ Explanation of the :ref:`general engine configuration` shown in the table ------------- ----------- --------------------------------- Weigth **W** ------------- ----------- --------------------------------- - Disabled **D** - ------------- ----------- --------------------------------- Show errors **DE** ============= =========== ================================= @@ -53,7 +51,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - TR - ET - W - - D - DE {% for name, mod in engines.items() %} @@ -70,7 +67,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - {{(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 ""}} {% endfor %} From 966296b866f32e07877ff96ffe35fe882fbefa1c Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 10:07:22 +0100 Subject: [PATCH 04/10] [doc] engine-table: expand cryptic abbreviations --- docs/admin/engines/configured_engines.rst | 52 +++++++++++------------ 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 7d5b89384..0bddc353e 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -15,23 +15,23 @@ Explanation of the :ref:`general engine configuration` shown in the table .. 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** - ------------- ----------- --------------------------------- - Show errors **DE** - ============= =========== ================================= + Name Categories + ------------------------- --------------------------------- + Engine Paging support + ------------------------- --------------------------------- + Shortcut Language support + Timeout Time range support + Disabled Engine type + ------------------------- --------------------------------- + Safe search + ------------------------- --------------------------------- + Weigth + ------------------------- --------------------------------- + Show errors + ========================= ================================= .. jinja:: searx @@ -39,19 +39,19 @@ Explanation of the :ref:`general engine configuration` shown in the table :header-rows: 1 :stub-columns: 2 - * - Name (cfg) - - S + * - Name + - Shortcut - Engine - - TO + - Timeout - Categories - - P - - L - - SS - - D - - TR - - ET - - W - - DE + - Paging + - Language + - Safe search + - Disabled + - Time range + - Engine type + - Weight + - Display errors {% for name, mod in engines.items() %} From 625ebf9cef0cd50153e035a372819af5ebcb6713 Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 10:42:24 +0100 Subject: [PATCH 05/10] [doc] engine-table: group columns logically --- docs/admin/engines/configured_engines.rst | 41 +++++++---------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 0bddc353e..b6b0921b0 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -12,62 +12,45 @@ 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 Categories - ------------------------- --------------------------------- - Engine Paging support - ------------------------- --------------------------------- - Shortcut Language support - Timeout Time range support - Disabled Engine type - ------------------------- --------------------------------- - Safe search - ------------------------- --------------------------------- - Weigth - ------------------------- --------------------------------- - Show errors - ========================= ================================= - .. jinja:: searx - .. flat-table:: Engines configured at built time (defaults) - :header-rows: 1 + .. flat-table:: + :header-rows: 2 :stub-columns: 2 + * - :cspan:`6` Engines configured by default (in :ref:`settings.yml `) + - + - :cspan:`3` :ref:`Supported features ` + * - Name - Shortcut - Engine + - Disabled - Timeout + - Weight + - Display errors - Categories - Paging - Language - Safe search - - Disabled - Time range - Engine type - - Weight - - Display errors {% for name, mod in engines.items() %} * - `{{name}} <{{mod.about and mod.about.website}}>`_ - !{{mod.shortcut}} - {{mod.__name__}} + - {{(mod.disabled and "y") or ""}} - {{mod.timeout}} + - {{mod.weight or 1 }} + - {{(mod.display_error_messages and "y") or ""}} - {{", ".join(mod.categories)}} - {{(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.display_error_messages and "y") or ""}} {% endfor %} From 0d5a356f23c634b5f49205f3185972309eef1b85 Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 10:49:12 +0100 Subject: [PATCH 06/10] [doc] engine-table: format shortcut as inline code --- docs/admin/engines/configured_engines.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index b6b0921b0..6d5a23688 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -16,7 +16,7 @@ Explanation of the :ref:`general engine configuration` shown in the table .. flat-table:: :header-rows: 2 - :stub-columns: 2 + :stub-columns: 1 * - :cspan:`6` Engines configured by default (in :ref:`settings.yml `) - @@ -39,7 +39,7 @@ Explanation of the :ref:`general engine configuration` shown in the table {% for name, mod in engines.items() %} * - `{{name}} <{{mod.about and mod.about.website}}>`_ - - !{{mod.shortcut}} + - ``!{{mod.shortcut}}`` - {{mod.__name__}} - {{(mod.disabled and "y") or ""}} - {{mod.timeout}} From 292faf213c2cb41d824fc9ae74cb4d7ae699973a Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 10:52:21 +0100 Subject: [PATCH 07/10] [doc] engine-table: remove Display errors column (always true) --- docs/admin/engines/configured_engines.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 6d5a23688..945a72b88 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -18,7 +18,7 @@ Explanation of the :ref:`general engine configuration` shown in the table :header-rows: 2 :stub-columns: 1 - * - :cspan:`6` Engines configured by default (in :ref:`settings.yml `) + * - :cspan:`5` Engines configured by default (in :ref:`settings.yml `) - - :cspan:`3` :ref:`Supported features ` @@ -28,7 +28,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - Disabled - Timeout - Weight - - Display errors - Categories - Paging - Language @@ -44,7 +43,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - {{(mod.disabled and "y") or ""}} - {{mod.timeout}} - {{mod.weight or 1 }} - - {{(mod.display_error_messages and "y") or ""}} - {{", ".join(mod.categories)}} - {{(mod.paging and "y") or ""}} - {{(mod.language_support and "y") or ""}} From 26b0ecddcf6f5ef31f3aa5467fc43b330e1ffd7a Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 11:06:42 +0100 Subject: [PATCH 08/10] [doc] engine-table: merge Engine type column --- docs/admin/engines/configured_engines.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 945a72b88..83aa3f554 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -33,7 +33,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - Language - Safe search - Time range - - Engine type {% for name, mod in engines.items() %} @@ -44,11 +43,14 @@ Explanation of the :ref:`general engine configuration` shown in the table - {{mod.timeout}} - {{mod.weight or 1 }} - {{", ".join(mod.categories)}} + {% if mod.engine_type == 'online' %} - {{(mod.paging and "y") or ""}} - {{(mod.language_support and "y") or ""}} - {{(mod.safesearch and "y") or ""}} - {{(mod.time_range_support and "y") or ""}} - - {{mod.engine_type or ""}} + {% else %} + - :cspan:`3` not applicable ({{mod.engine_type}}) + {% endif %} {% endfor %} From 1615ec4a2b07121ff951cff833b416bd57dedeca Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 11:17:48 +0100 Subject: [PATCH 09/10] [doc] engine-table: group engines by first category --- docs/admin/engines/configured_engines.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst index 83aa3f554..21bc0e92b 100644 --- a/docs/admin/engines/configured_engines.rst +++ b/docs/admin/engines/configured_engines.rst @@ -14,12 +14,16 @@ Explanation of the :ref:`general engine configuration` shown in the table .. jinja:: searx + {% for category, engines in engines.items() | groupby('1.categories.0') %} + + {{category}} search engines + --------------------------------------- + .. flat-table:: :header-rows: 2 :stub-columns: 1 * - :cspan:`5` Engines configured by default (in :ref:`settings.yml `) - - - :cspan:`3` :ref:`Supported features ` * - Name @@ -28,13 +32,12 @@ Explanation of the :ref:`general engine configuration` shown in the table - Disabled - Timeout - Weight - - Categories - Paging - Language - Safe search - Time range - {% for name, mod in engines.items() %} + {% for name, mod in engines %} * - `{{name}} <{{mod.about and mod.about.website}}>`_ - ``!{{mod.shortcut}}`` @@ -42,7 +45,6 @@ Explanation of the :ref:`general engine configuration` shown in the table - {{(mod.disabled and "y") or ""}} - {{mod.timeout}} - {{mod.weight or 1 }} - - {{", ".join(mod.categories)}} {% if mod.engine_type == 'online' %} - {{(mod.paging and "y") or ""}} - {{(mod.language_support and "y") or ""}} @@ -53,4 +55,4 @@ Explanation of the :ref:`general engine configuration` shown in the table {% endif %} {% endfor %} - + {% endfor %} From 1fb1cca519bb81a8143563d9d48b75908a9c778a Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Mon, 20 Dec 2021 12:12:09 +0100 Subject: [PATCH 10/10] [doc] fix about.website for hoogle --- searx/settings.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/searx/settings.yml b/searx/settings.yml index c01fae52c..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