searxng/docs/admin/engines/configured_engines.rst
Markus Heiser 2dc4549a27 [mod] show !bang of (secondary) categories in the preference
The name of the *secondary* categories in the preferences are translated, to use
this categories the user needs to know by which !bang the category can be
selected.  Related to "Make 'non tab category' bangs discoverable" in [#690].

[#690] https://github.com/searxng/searxng/issues/690

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-08-01 22:29:52 +02:00

87 lines
2.5 KiB
ReStructuredText

.. _configured engines:
==================
Configured Engines
==================
.. sidebar:: Further reading ..
- :ref:`settings categories_as_tabs`
- :ref:`engines-dev`
- :ref:`settings engine`
- :ref:`general engine configuration`
.. jinja:: searx
SearXNG supports {{engines | length}} search engines (of which
{{enabled_engine_count}} are enabled by default). The UI displays the tabs
that are configured in :ref:`categories_as_tabs <settings
categories_as_tabs>`. In addition to these main categories (aka *tabs*),
engines can be added to *secondary* categories (aka *groups*). A *tab*,
*group* or *engine* can be selected with a `!` (*bang*) in the
:ref:`search-syntax`.
.. contents:: Contents
:depth: 2
:local:
:backlinks: entry
.. jinja:: searx
{% for category, engines in categories_as_tabs.items() %}
tab ``!{{category.replace(' ', '_')}}``
---------------------------------------
{% for group, group_bang, engines in engines | group_engines_in_tab %}
{% if loop.length > 1 %}
{% if group_bang %}group ``{{group_bang}}``{% else %}{{group}}{% endif %}
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
{% endif %}
.. flat-table::
:header-rows: 2
:stub-columns: 1
* - :cspan:`5` Engines configured by default (in :ref:`settings.yml <engine settings>`)
- :cspan:`3` :ref:`Supported features <engine file>`
* - Name
- bang
- Module
- Disabled
- Timeout
- Weight
- Paging
- Language
- Safe search
- Time range
{% for mod in engines %}
* - `{{mod.name}} <{{mod.about and mod.about.website}}>`_
- ``!{{mod.shortcut}}``
- {%- if 'searx.engines.' + mod.__name__ in documented_modules %}
:py:mod:`~searx.engines.{{mod.__name__}}`
{%- else %}
:origin:`{{mod.__name__}} <searx/engines/{{mod.__name__}}.py>`
{%- endif %}
- {{(mod.disabled and "y") or ""}}
{%- if mod.about and mod.about.language %}
({{mod.about.language | upper}})
{%- endif %}
- {{mod.timeout}}
- {{mod.weight or 1 }}
{% 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 ""}}
{% else %}
- :cspan:`3` not applicable ({{mod.engine_type}})
{% endif %}
{% endfor %}
{% endfor %}
{% endfor %}