Merge pull request #621 from not-my-profile/engines-table

[doc] Improve engines table
This commit is contained in:
Markus Heiser 2021-12-20 14:02:29 +01:00 committed by GitHub
commit 6fb6e8c22a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 33 additions and 50 deletions

View file

@ -12,66 +12,47 @@ Configured Engines
Explanation of the :ref:`general engine configuration` shown in the table
:ref:`configured engines`.
.. table:: The legend for the following table
:width: 100%
============= =========== ==================== ============
: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**
============= =========== =================================
.. jinja:: searx
.. flat-table:: Engines configured at built time (defaults)
:header-rows: 1
:stub-columns: 2
{% for category, engines in engines.items() | groupby('1.categories.0') %}
* - Name (cfg)
- S
{{category}} search engines
---------------------------------------
.. 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
- Shortcut
- Engine
- TO
- Categories
- P
- L
- SS
- D
- TR
- ET
- W
- D
- DE
- Disabled
- Timeout
- Weight
- Paging
- Language
- Safe search
- Time range
{% for name, mod in engines.items() %}
{% for name, mod in engines %}
* - {{name}}
- !{{mod.shortcut}}
* - `{{name}} <{{mod.about and mod.about.website}}>`_
- ``!{{mod.shortcut}}``
- {{mod.__name__}}
- {{(mod.disabled and "y") or ""}}
- {{mod.timeout}}
- {{", ".join(mod.categories)}}
- {{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.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 ""}}
{% else %}
- :cspan:`3` not applicable ({{mod.engine_type}})
{% endif %}
{% endfor %}
{% endfor %}

View file

@ -767,7 +767,7 @@ engines:
categories: it
shortcut: ho
about:
website: https://www.haskell.org/
website: https://hoogle.haskell.org/
wikidata_id: Q34010
official_api_documentation: https://hackage.haskell.org/api
use_official_api: false
@ -1372,6 +1372,8 @@ engines:
categories: general
shortcut: wib
disabled: true
about:
website: https://wiby.me/
- name: wikibooks
engine: mediawiki