summaryrefslogtreecommitdiff
path: root/docs/admin/engines/configured_engines.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarIT.de>2021-06-08 10:56:18 +0000
committerGitHub <noreply@github.com>2021-06-08 10:56:18 +0000
commit5c5db719d2039d34aa1426bf7eb3e57055d4a54a (patch)
tree15a7a5e1a811f1366cdb49b69e35633afaf56114 /docs/admin/engines/configured_engines.rst
parent5f76238d5cd6f9c850d5237fe639ba2900fd3e6c (diff)
parent6f7b0d72c084845ea073a82a357c5e99cd41a85f (diff)
Merge pull request #97 from return42/drop-searx-admin
[docs] reorder blog articles
Diffstat (limited to 'docs/admin/engines/configured_engines.rst')
-rw-r--r--docs/admin/engines/configured_engines.rst77
1 files changed, 77 insertions, 0 deletions
diff --git a/docs/admin/engines/configured_engines.rst b/docs/admin/engines/configured_engines.rst
new file mode 100644
index 000000000..af20e5611
--- /dev/null
+++ b/docs/admin/engines/configured_engines.rst
@@ -0,0 +1,77 @@
+.. _configured engines:
+
+==================
+Configured Engines
+==================
+
+.. sidebar:: Further reading ..
+
+ - :ref:`engines-dev`
+ - :ref:`settings engine`
+
+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
+
+ * - Name (cfg)
+ - S
+ - Engine
+ - TO
+ - Categories
+ - P
+ - L
+ - SS
+ - D
+ - TR
+ - ET
+ - W
+ - D
+ - DE
+
+ {% for name, mod in engines.items() %}
+
+ * - {{name}}
+ - !{{mod.shortcut}}
+ - {{mod.__name__}}
+ - {{mod.timeout}}
+ - {{", ".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.disabled and "y") or ""}}
+ - {{(mod.display_error_messages and "y") or ""}}
+
+ {% endfor %}
+