zaclys/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng synced 2024-01-01 19:24:07 +01:00
Code Issues Projects Releases Packages Wiki Activity

[doc] add description of categories_as_tabs (settings.yml)

Browse source 
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 <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2022-07-24 10:51:22 +02:00
parent 2bf4158289
commit 08e48718a3
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/admin/engines/settings.rst
View file

@ -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:``