searxng/docs
Markus Heiser 3b10d63e2f [mod] engines_languages.json: add new type EngineProperties
This patch adds the boilerplate code, needed to fetch properties from engines.
In the past we only fetched *languages* but some engines need *regions* to
parameterize the engine request.

To fit into our *fetch language* procedures the boilerplate is implemented in
the `searxng_extra/update/update_languages.py` and the *engine_properties* are
stored along in the `searx/data/engines_languages.json`.

This implementation is downward compatible to the `_fetch_fetch_languages()`
infrastructure we have.  If there comes the day we have all
`_fetch_fetch_languages()` implementations moved to `_fetch_engine_properties()`
implementations, we can rename the files and scripts.

The new type `EngineProperties` is a dictionary with keys `languages` and
`regions`.  The values are dictionaries to map from SearXNG's language & region
to option values the engine does use::

    engine_properties = {
        'type' : 'engine_properties',  # <-- !!!
        'regions': {
            # 'ca-ES' : <engine's region name>
        },
        'languages': {
            # 'ca' : <engine's language name>
        },
    }

Similar to the `supported_languages`, in the engine the properties are available
under the name `supported_properties`.

Initial we start with languages & regions, but in a wider sense the type is
named *engine properties*.  Engines can store in whatever options they need and
may be in the future there is a need to fetch additional or complete different
properties.

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
2022-08-29 18:13:46 +02:00
..
_themes/searxng [fix] sphinx 5.x: add nav.contents everywhere that div.topic is used 2022-07-05 17:05:06 +02:00
admin [mod] engines_languages.json: add new type EngineProperties 2022-08-29 18:13:46 +02:00
build-templates [doc] update documentation of the installation procedures 2022-07-30 13:39:35 +02:00
dev [doc] update documentation of the installation procedures 2022-07-30 13:39:35 +02:00
src [mod] add tor_check plugin - convenient tor checking trough searxng 2022-07-19 07:34:54 +02:00
user Sphinx doc: rename "User documentation" to "User Information" 2022-03-16 22:26:36 +01:00
utils [docs] corrections from @tiekoetter's review 2022-07-30 13:39:35 +02:00
conf.py [doc] update documentation of the installation procedures 2022-07-30 13:39:35 +02:00
donate.rst Update docs/donate.rst 2022-06-29 21:02:46 +02:00
index.rst Move donation page to docs.searxng.org and link to it from instances 2022-06-29 17:26:19 +00:00
own-instance.rst [docs] move own-instance.rst out of docs/user 2022-03-07 08:29:00 +01:00