summaryrefslogtreecommitdiff
path: root/docs/admin/engines
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-06-03 14:54:20 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2021-06-04 15:04:38 +0200
commitd965c634297fc1b6010e45b2050422611d06193b (patch)
tree1025b98201e12f047181ae8931436437b740e5d3 /docs/admin/engines
parent0d31740cfd20fae749277bb7604253aa0c86c898 (diff)
[docs] reorder chapter "Engines & Settings"
- Split chapter "Engines" and rename it into "Engines & Settings" - Move docs/admin/engines.rst -> docs/admin/engines/engine_settings.rst Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/admin/engines')
-rw-r--r--docs/admin/engines/engine_settings.rst76
-rw-r--r--docs/admin/engines/index.rst21
2 files changed, 97 insertions, 0 deletions
diff --git a/docs/admin/engines/engine_settings.rst b/docs/admin/engines/engine_settings.rst
new file mode 100644
index 000000000..9ca5620e2
--- /dev/null
+++ b/docs/admin/engines/engine_settings.rst
@@ -0,0 +1,76 @@
+.. _general engine settings:
+
+=======================
+General Engine Settings
+=======================
+
+.. sidebar:: Further reading ..
+
+ - :ref:`engines-dev`
+ - :ref:`settings engine`
+
+Explanation of the :ref:`general engine configuration` shown in the table
+:ref:`configured engines`.
+
+============= =========== ==================== ============
+: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**
+============= =========== =================================
+
+.. _configured engines:
+
+.. 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 %}
+
diff --git a/docs/admin/engines/index.rst b/docs/admin/engines/index.rst
new file mode 100644
index 000000000..923b20a2b
--- /dev/null
+++ b/docs/admin/engines/index.rst
@@ -0,0 +1,21 @@
+.. _engines and settings:
+
+==================
+Engines & Settings
+==================
+
+.. sidebar:: Further reading ..
+
+ - :ref:`settings engine`
+ - :ref:`engine settings` & :ref:`engine file`
+
+.. toctree::
+ :maxdepth: 1
+
+ engine_settings
+ recoll
+ sql-engines
+ command-line-engines
+ searx.engines.xpath
+
+