From 08e48718a38cb6386ac7b7728b6957c007c8a2e2 Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Sun, 24 Jul 2022 10:51:22 +0200 Subject: [PATCH] [doc] add description of categories_as_tabs (settings.yml) Add missing documentation of PR [#634]. Related to checkbox "Document how to categorize engines" in [#690]. [#634] https://github.com/searxng/searxng/pull/634#issuecomment-1004757502 [#690] https://github.com/searxng/searxng/issues/690 Signed-off-by: Markus Heiser --- docs/admin/engines/settings.rst | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/admin/engines/settings.rst b/docs/admin/engines/settings.rst index 71ad29b43..aabd5bdf1 100644 --- a/docs/admin/engines/settings.rst +++ b/docs/admin/engines/settings.rst @@ -264,6 +264,36 @@ Global Settings Open result links in a new tab by default. +.. _settings categories_as_tabs: + +``categories_as_tabs:`` +----------------------- + +.. code:: yaml + + categories_as_tabs: + general: + images: + videos: + news: + map: + music: + it: + science: + files: + social media: + +Engines are added to ``categories:`` (compare :ref:`settings engine`), the +categories listed in ``categories_as_tabs`` are shown as tabs in the UI. If +there are no active engines in a category, the tab is not displayed (e.g. if a +user disables all engines in a category). + +On the preferences page (``/preferences``) -- under *engines* -- there is an +additional tab called *other* which lists all categories that are not displayed +in the UI (not included in ``categories_as_tabs``). Engines that are not +assigned to any category are listed there under the title *ungrouped*. + + .. _settings redis: ``redis:``