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

View file

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