diff options
| author | Bnyro <bnyro@tutanota.com> | 2024-02-20 10:51:58 +0100 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarIT.de> | 2024-02-25 16:22:37 +0100 |
| commit | e76ab1a4b3a99b0ec2ef90c3aadc92ffbf6889b1 (patch) | |
| tree | be5443686fbe1ab6a6fa95e55a12a189230ba92e /docs | |
| parent | b683aa63fb3e1689c28bd4b762b4ad962e8e232c (diff) | |
| download | searxng-e76ab1a4b3a99b0ec2ef90c3aadc92ffbf6889b1.tar.gz searxng-e76ab1a4b3a99b0ec2ef90c3aadc92ffbf6889b1.zip | |
[refactor] images: add resolution, image format and filesize fields
Co-authored-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/dev/engines/engine_overview.rst | 60 |
1 files changed, 46 insertions, 14 deletions
diff --git a/docs/dev/engines/engine_overview.rst b/docs/dev/engines/engine_overview.rst index 9c1ea0427..091d217c0 100644 --- a/docs/dev/engines/engine_overview.rst +++ b/docs/dev/engines/engine_overview.rst @@ -271,22 +271,54 @@ type. ``images`` ---------- -.. table:: Parameter of the **images** media type: +.. list-table:: Parameter of the **images** media type + :header-rows: 2 :width: 100% - ========================= ===================================================== - result-parameter information - ------------------------- ----------------------------------------------------- - template is set to ``images.html`` - ========================= ===================================================== - url string, url to the result site - title string, title of the result *(partly implemented)* - content *(partly implemented)* - publishedDate :py:class:`datetime.datetime`, - time of publish *(partly implemented)* - img\_src string, url to the result image - thumbnail\_src string, url to a small-preview image - ========================= ===================================================== + * - result-parameter + - Python type + - information + + * - template + - :py:class:`str` + - is set to ``images.html`` + + * - url + - :py:class:`str` + - url to the result site + + * - title + - :py:class:`str` + - title of the result + + * - content + - :py:class:`str` + - description of the image + + * - publishedDate + - :py:class:`datetime <datetime.datetime>` + - time of publish + + * - img_src + - :py:class:`str` + - url to the result image + + * - thumbnail_src + - :py:class:`str` + - url to a small-preview image + + * - resolution + - :py:class:`str` + - the resolution of the image (e.g. ``1920 x 1080`` pixel) + + * - img_format + - :py:class:`str` + - the format of the image (e.g. ``png``) + + * - filesize + - :py:class:`str` + - size of bytes in :py:obj:`human readable <searx.humanize_bytes>` notation + (e.g. ``MB`` for 1024 \* 1024 Bytes filesize). .. _template videos: |