summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2026-05-25 17:49:56 +0200
committerMarkus Heiser <markus.heiser@darmarIT.de>2026-05-26 09:19:17 +0200
commitc629dd4f3cca89d9e018acc37694656c9d8dd2dc (patch)
tree0aa93e011dd53e16e87658e9301ee072da07128f /docs
parent28ef4f7447debd6f988963c80b3ad15046c65908 (diff)
[mod] typification of SearXNG: add new result type Image (#6142)
- Python class: searx/result_types/image.py - Jinja template: searx/templates/simple/result_templates/images.html - CSS (less) client/simple/src/less/result_types/image.less Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/result_types/main/image.rst7
-rw-r--r--docs/dev/result_types/main/mainresult.rst4
-rw-r--r--docs/dev/result_types/main_result.rst2
-rw-r--r--docs/dev/templates.rst47
4 files changed, 12 insertions, 48 deletions
diff --git a/docs/dev/result_types/main/image.rst b/docs/dev/result_types/main/image.rst
new file mode 100644
index 000000000..809528ed2
--- /dev/null
+++ b/docs/dev/result_types/main/image.rst
@@ -0,0 +1,7 @@
+.. _result_types.image:
+
+=============
+Image Results
+=============
+
+.. automodule:: searx.result_types.image
diff --git a/docs/dev/result_types/main/mainresult.rst b/docs/dev/result_types/main/mainresult.rst
index dc5d3f005..0173cf837 100644
--- a/docs/dev/result_types/main/mainresult.rst
+++ b/docs/dev/result_types/main/mainresult.rst
@@ -1,4 +1,8 @@
.. _result_types.mainresult:
+============
+Main Results
+============
+
.. autoclass:: searx.result_types._base.MainResult
:members:
diff --git a/docs/dev/result_types/main_result.rst b/docs/dev/result_types/main_result.rst
index eff56740c..acf539a8a 100644
--- a/docs/dev/result_types/main_result.rst
+++ b/docs/dev/result_types/main_result.rst
@@ -18,13 +18,13 @@ following types have been implemented so far ..
main/code
main/paper
main/file
+ main/image
The :ref:`LegacyResult <LegacyResult>` is used internally for the results that
have not yet been typed. The templates can be used as orientation until the
final typing is complete.
- :ref:`template default` / :py:obj:`Result`
-- :ref:`template images`
- :ref:`template videos`
- :ref:`template torrent`
- :ref:`template map`
diff --git a/docs/dev/templates.rst b/docs/dev/templates.rst
index b43a0ea08..2b04e02de 100644
--- a/docs/dev/templates.rst
+++ b/docs/dev/templates.rst
@@ -129,53 +129,6 @@ audio_src : uri,
URL of an embedded ``<audio controls>``.
-.. _template images:
-
-``images.html``
----------------
-
-The images are displayed as small thumbnails in the main results list.
-
-title : :py:class:`str`
- Title of the image.
-
-thumbnail_src : :py:class:`str`
- URL of a preview of the image.
-
-resolution :py:class:`str`
- The resolution of the image (e.g. ``1920 x 1080`` pixel)
-
-
-Image labels
-~~~~~~~~~~~~
-
-Clicking on the preview opens a gallery view in which all further metadata for
-the image is displayed. Addition fields used in the :origin:`images.html
-<searx/templates/simple/result_templates/images.html>`:
-
-img_src : :py:class:`str`
- URL of the full size image.
-
-content: :py:class:`str`
- Description of the image.
-
-author: :py:class:`str`
- Name of the author of the image.
-
-img_format : :py:class:`str`
- The format of the image (e.g. ``png``).
-
-source : :py:class:`str`
- Source of the image.
-
-filesize: :py:class:`str`
- Size of bytes in :py:obj:`human readable <searx.humanize_bytes>` notation
- (e.g. ``MB`` for 1024 \* 1024 Bytes filesize).
-
-url : :py:class:`str`
- URL of the page from where the images comes from (source).
-
-
.. _template videos:
``videos.html``