Icycoide/searxng
1
0
Fork 1
mirror of https://github.com/searxng/searxng.git synced 2025-08-07 20:36:44 +02:00
Code Issues Projects Releases Packages Wiki Activity

[doc] build from commit b95a3e905d

Browse source
This commit is contained in:
inetol 2025-07-19 08:19:34 +00:00
commit b95d2f9b76
429 changed files with 98580 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

388
dev/result_types/answer.html Normal file
View file

File diff suppressed because one or more lines are too long

273
dev/result_types/base_result.html Normal file
View file

@ -0,0 +1,273 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Result &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Main Search Results" href="main_result.html" />
<link rel="prev" title="Result Types" href="index.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="main_result.html" title="Main Search Results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Result Types"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Result</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-searx.result_types._base">
<span id="result"></span><h1>Result<a class="headerlink" href="#module-searx.result_types._base" title="Link to this heading"></a></h1>
<p>Basic types for the typification of results.</p>
<ul class="simple">
<li><p><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> base class</p></li>
<li><p><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LegacyResult</span></code></a> for internal use only</p></li>
</ul>
<hr class="docutils" />
<dl class="py class">
<dt class="sig sig-object py" id="searx.result_types._base.Result">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types._base.</span></span><span class="sig-name descname"><span class="pre">Result</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'default.html'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parsed_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.13)"><span class="pre">ParseResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result" title="Link to this definition"></a></dt>
<dd><p>Base class of all result types <a class="reference internal" href="index.html#result-types"><span class="std std-ref">Result Types</span></a>.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.Result.url">
<span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.url" title="Link to this definition"></a></dt>
<dd><p>A link related to this <em>result</em></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.Result.template">
<span class="sig-name descname"><span class="pre">template</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.template" title="Link to this definition"></a></dt>
<dd><p>Name of the template used to render the result.</p>
<p>By default <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/default.html">result_templates/default.html</a> is used.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.Result.engine">
<span class="sig-name descname"><span class="pre">engine</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.engine" title="Link to this definition"></a></dt>
<dd><p>Name of the engine <em>this</em> result comes from. In case of <em>plugins</em> a
prefix <code class="docutils literal notranslate"><span class="pre">plugin:</span></code> is set, in case of <em>answerer</em> prefix <code class="docutils literal notranslate"><span class="pre">answerer:</span></code> is
set.</p>
<p>The field is optional and is initialized from the context if necessary.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.Result.parsed_url">
<span class="sig-name descname"><span class="pre">parsed_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.13)"><span class="pre">ParseResult</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.Result.parsed_url" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://docs.python.org/3/library/urllib.parse.html#urllib.parse.ParseResult" title="(in Python v3.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">urllib.parse.ParseResult</span></code></a> of <a class="reference internal" href="#searx.result_types._base.Result.url" title="searx.result_types._base.Result.url"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.url</span></code></a>.</p>
<p>The field is optional and is initialized from the context if necessary.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="searx.result_types._base.Result.normalize_result_fields">
<span class="sig-name descname"><span class="pre">normalize_result_fields</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.normalize_result_fields"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.normalize_result_fields" title="Link to this definition"></a></dt>
<dd><p>Normalize fields <code class="docutils literal notranslate"><span class="pre">url</span></code> and <code class="docutils literal notranslate"><span class="pre">parse_sql</span></code>.</p>
<ul class="simple">
<li><p>If field <code class="docutils literal notranslate"><span class="pre">url</span></code> is set and field <code class="docutils literal notranslate"><span class="pre">parse_url</span></code> is unset, init
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> from field <code class="docutils literal notranslate"><span class="pre">url</span></code>. The <code class="docutils literal notranslate"><span class="pre">url</span></code> field is initialized
with the resulting value in <code class="docutils literal notranslate"><span class="pre">parse_url</span></code>, if <code class="docutils literal notranslate"><span class="pre">url</span></code> and
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> are not equal.</p></li>
</ul>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="searx.result_types._base.Result.filter_urls">
<span class="sig-name descname"><span class="pre">filter_urls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.filter_urls"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.filter_urls" title="Link to this definition"></a></dt>
<dd><p>A filter function is passed in the <code class="docutils literal notranslate"><span class="pre">filter_func</span></code> argument to
filter and/or modify the URLs.</p>
<p>The filter function receives the <a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span> <span class="pre">object</span></code></a> as
the first argument and the field name (<code class="docutils literal notranslate"><span class="pre">str</span></code>) in the second argument.
In the third argument the URL string value is passed to the filter function.</p>
<p>The filter function is applied to all fields that contain a URL,
in addition to the familiar <code class="docutils literal notranslate"><span class="pre">url</span></code> field, these include fields such as:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="s2">&quot;url&quot;</span><span class="p">,</span> <span class="s2">&quot;iframe_src&quot;</span><span class="p">,</span> <span class="s2">&quot;audio_src&quot;</span><span class="p">,</span> <span class="s2">&quot;img_src&quot;</span><span class="p">,</span> <span class="s2">&quot;thumbnail_src&quot;</span><span class="p">,</span> <span class="s2">&quot;thumbnail&quot;</span><span class="p">]</span>
</pre></div>
</div>
<p>and the <code class="docutils literal notranslate"><span class="pre">urls</span></code> list of items of the infobox.</p>
<p>For each field, the filter function is called and returns a bool or a
string value:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">True</span></code>: leave URL in field unchanged</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">False</span></code>: remove URL field from result (or remove entire result)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">str</span></code>: modified URL to be used instead</p></li>
</ul>
<p>See <a class="reference internal" href="../plugins/development.html#filter-urls-example"><span class="std std-ref">Filter URLs example</span></a>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="searx.result_types._base.Result.defaults_from">
<span class="sig-name descname"><span class="pre">defaults_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#Result.defaults_from"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.Result.defaults_from" title="Link to this definition"></a></dt>
<dd><p>Fields not set in <em>self</em> will be updated from the field values of the
<em>other</em>.</p>
</dd></dl>
</dd></dl>
<dl class="py class" id="legacyresult">
<dt class="sig sig-object py" id="searx.result_types._base.LegacyResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types._base.</span></span><span class="sig-name descname"><span class="pre">LegacyResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#LegacyResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.LegacyResult" title="Link to this definition"></a></dt>
<dd><p>A wrapper around a legacy result item. The SearXNG core uses this class
for untyped dictionaries / to be downward compatible.</p>
<p>This class is needed until we have implemented an <a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></a> class for
each result type and the old usages in the codebase have been fully
migrated.</p>
<p>There is only one place where this class is used, in the
<code class="xref py py-obj docutils literal notranslate"><span class="pre">searx.results.ResultContainer</span></code>.</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>Do not use this class in your own implementations!</p>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="searx.result_types._base.LegacyResult.filter_urls">
<span class="sig-name descname"><span class="pre">filter_urls</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_func</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/collections.abc.html#collections.abc.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#searx.result_types._base.Result" title="searx.result_types._base.Result"><span class="pre">Result</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#searx.result_types._base.LegacyResult" title="searx.result_types._base.LegacyResult"><span class="pre">LegacyResult</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/searx/result_types/_base.html#LegacyResult.filter_urls"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.LegacyResult.filter_urls" title="Link to this definition"></a></dt>
<dd><p>See <a class="reference internal" href="#searx.result_types._base.Result.filter_urls" title="searx.result_types._base.Result.filter_urls"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Result.filter_urls</span></code></a></p>
</dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Result</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types._base.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.url"><code class="docutils literal notranslate"><span class="pre">Result.url</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.template"><code class="docutils literal notranslate"><span class="pre">Result.template</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.engine"><code class="docutils literal notranslate"><span class="pre">Result.engine</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.parsed_url"><code class="docutils literal notranslate"><span class="pre">Result.parsed_url</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.normalize_result_fields"><code class="docutils literal notranslate"><span class="pre">Result.normalize_result_fields()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.filter_urls"><code class="docutils literal notranslate"><span class="pre">Result.filter_urls()</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.Result.defaults_from"><code class="docutils literal notranslate"><span class="pre">Result.defaults_from()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="#searx.result_types._base.LegacyResult"><code class="docutils literal notranslate"><span class="pre">LegacyResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.LegacyResult.filter_urls"><code class="docutils literal notranslate"><span class="pre">LegacyResult.filter_urls()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li><a href="index.html">Result Types</a>
<ul>
<li>Previous: <a href="index.html" title="previous chapter">Result Types</a>
<li>Next: <a href="main_result.html" title="next chapter">Main Search Results</a></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/base_result.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

173
dev/result_types/correction.html Normal file
View file

@ -0,0 +1,173 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Correction Results &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Suggestion Results" href="suggestion.html" />
<link rel="prev" title="Answer Results" href="answer.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="suggestion.html" title="Suggestion Results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="answer.html" title="Answer Results"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Correction Results</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="correction-results">
<span id="result-types-corrections"></span><h1>Correction Results<a class="headerlink" href="#correction-results" title="Link to this heading"></a></h1>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>There is still no typing for these result items. The templates can be used as
orientation until the final typing is complete.</p>
</div>
<p>The <a class="reference internal" href="index.html#area-corrections-results"><span class="std std-ref">area corrections</span></a> shows the user alternative search terms.</p>
<p>A result of this type is a very simple dictionary with only one key/value pair</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">&quot;correction&quot;</span> <span class="p">:</span> <span class="s2">&quot;lorem ipsum ..&quot;</span><span class="p">}</span>
</pre></div>
</div>
<p>From this simple dict another dict is build up:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># use RawTextQuery to get the corrections URLs with the same bang</span>
<span class="p">{</span><span class="s2">&quot;url&quot;</span> <span class="p">:</span> <span class="s2">&quot;!bang lorem ipsum ..&quot;</span><span class="p">,</span> <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="s2">&quot;lorem ipsum ..&quot;</span> <span class="p">}</span>
</pre></div>
</div>
<p>and used in the template <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/elements/corrections.html">corrections.html</a>:</p>
<dl>
<dt>title<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Corrected search term.</p>
</dd>
<dt>url<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Not really an URL, its the value to insert in a HTML form for a SearXNG query.</p>
</dd>
</dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li><a href="index.html">Result Types</a>
<ul>
<li>Previous: <a href="answer.html" title="previous chapter">Answer Results</a>
<li>Next: <a href="suggestion.html" title="next chapter">Suggestion Results</a></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/correction.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

246
dev/result_types/index.html Normal file
View file

@ -0,0 +1,246 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Result Types &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Result" href="base_result.html" />
<link rel="prev" title="Tineye" href="../engines/online_url_search/tineye.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="base_result.html" title="Result"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../engines/online_url_search/tineye.html" title="Tineye"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Result Types</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="result-types">
<span id="id1"></span><h1>Result Types<a class="headerlink" href="#result-types" title="Link to this heading"></a></h1>
<p>To understand the typification of the results, let’s take a brief look at the
structure of SearXNG .. At its core, SearXNG is nothing more than an aggregator
that aggregates the results from various sources, renders them via templates and
displays them to the user.</p>
<p>The <strong>sources</strong> can be:</p>
<ol class="arabic simple">
<li><p><a class="reference internal" href="../engines/index.html#engine-implementations"><span class="std std-ref">engines</span></a></p></li>
<li><p><a class="reference internal" href="../plugins/development.html#dev-plugin"><span class="std std-ref">plugins</span></a></p></li>
<li><p><a class="reference internal" href="../answerers/development.html#dev-answerers"><span class="std std-ref">answerers</span></a></p></li>
</ol>
<p>The sources provide the results, which are displayed in different <strong>areas</strong>
depending on the type of result. The areas are:</p>
<dl class="simple" id="area-main-results">
<dt><a class="reference internal" href="main_result.html#main-search-results"><span class="std std-ref">area main results</span></a></dt><dd><p>It is the main area in which – as is typical for search engines – the
results that a search engine has found for the search term are displayed.</p>
</dd>
</dl>
<dl class="simple" id="area-answer-results">
<dt><a class="reference internal" href="answer.html#result-types-answer"><span class="std std-ref">area answers</span></a></dt><dd><p>This area displays short answers that could be found for the search term.</p>
</dd>
</dl>
<dl class="simple" id="area-info-box">
<dt><a class="reference internal" href="infobox.html#result-types-infobox"><span class="std std-ref">area info box</span></a></dt><dd><p>An area in which additional information can be displayed, e.g. excerpts from
wikipedia or other sources such as maps.</p>
</dd>
</dl>
<dl class="simple" id="area-suggestions-results">
<dt><a class="reference internal" href="suggestion.html#result-types-suggestion"><span class="std std-ref">area suggestions</span></a></dt><dd><p>Suggestions for alternative search terms can be found in this area. These can
be clicked on and a search is carried out with these search terms.</p>
</dd>
</dl>
<dl class="simple" id="area-corrections-results">
<dt><a class="reference internal" href="correction.html#result-types-corrections"><span class="std std-ref">area corrections</span></a></dt><dd><p>Results in this area are like the suggestion of alternative search terms,
which usually result from spelling corrections</p>
</dd>
</dl>
<p>At this point it is important to note that all <strong>sources</strong> can contribute
results to all of the areas mentioned above.</p>
<p>In most cases, however, the <a class="reference internal" href="../engines/index.html#engine-implementations"><span class="std std-ref">engines</span></a> will fill
the <em>main results</em> and the <a class="reference internal" href="../answerers/development.html#dev-answerers"><span class="std std-ref">answerers</span></a> will generally
provide the contributions for the <em>answer</em> area. Not necessary to mention here
but for a better understanding: the plugins can also filter out or change
results from the main results area (e.g. the URL of the link).</p>
<p>The result items are organized in the <code class="xref py py-obj docutils literal notranslate"><span class="pre">results.ResultContainer</span></code> and
after all sources have delivered their results, this container is passed to the
templating to build a HTML output. The output is usually HTML, but it is also
possible to output the result lists as JSON or RSS feed. Thats quite all we need
to know before we dive into typification of result items.</p>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>Typification of result items: we are at the very first beginng!</p>
</div>
<p>The first thing we have to realize is that there is no typification of the
result items so far, we have to build it up first .. and that is quite a big
task, which we will only be able to accomplish gradually.</p>
<p>The foundation for the typeless results was laid back in 2013 in the very first
commit <a class="reference external" href="https://github.com/searxng/searxng/commit/ae9fb1d7d">&#64;ae9fb1d</a>, and the principle has not changed since then. At
the time, the approach was perfectly adequate, but we have since evolved and the
demands on SearXNG increase with every feature request.</p>
<p><strong>Motivation:</strong> in the meantime, it has become very difficult to develop new
features that require structural changes and it is especially hard for newcomers
to find their way in this typeless world. As long as the results are only
simple key/value dictionaries, it is not even possible for the IDEs to support
the application developer in his work.</p>
<p><strong>Planning:</strong> The procedure for subsequent typing will have to be based on the
circumstances ..</p>
<div class="admonition attention">
<p class="admonition-title">Attention</p>
<p>As long as there is no type defined for a kind of result the HTML template
specify what the properties of a type are.</p>
<p>In this sense, you will either find a type definition here in the
documentation or, if this does not yet exist, a description of the HTML
template.</p>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="base_result.html">Result</a><ul>
<li class="toctree-l2"><a class="reference internal" href="base_result.html#searx.result_types._base.Result"><code class="docutils literal notranslate"><span class="pre">Result</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="base_result.html#searx.result_types._base.LegacyResult"><code class="docutils literal notranslate"><span class="pre">LegacyResult</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="main_result.html">Main Search Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/keyvalue.html">Key-Value Results</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="answer.html">Answer Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.BaseAnswer"><code class="docutils literal notranslate"><span class="pre">BaseAnswer</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.Answer"><code class="docutils literal notranslate"><span class="pre">Answer</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.Translations"><code class="docutils literal notranslate"><span class="pre">Translations</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.WeatherAnswer"><code class="docutils literal notranslate"><span class="pre">WeatherAnswer</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="answer.html#searx.result_types.answer.AnswerSet"><code class="docutils literal notranslate"><span class="pre">AnswerSet</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l1"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</div>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Result Types</a><ul>
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li>Previous: <a href="../engines/online_url_search/tineye.html" title="previous chapter">Tineye</a>
<li>Next: <a href="base_result.html" title="next chapter">Result</a></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

201
dev/result_types/infobox.html Normal file
View file

@ -0,0 +1,201 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Infobox Results &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Simple Theme Templates" href="../templates.html" />
<link rel="prev" title="Suggestion Results" href="suggestion.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../templates.html" title="Simple Theme Templates"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="suggestion.html" title="Suggestion Results"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Infobox Results</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="infobox-results">
<span id="result-types-infobox"></span><h1>Infobox Results<a class="headerlink" href="#infobox-results" title="Link to this heading"></a></h1>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>There is still no typing for these result items. The templates can be used as
orientation until the final typing is complete.</p>
</div>
<p>The <a class="reference internal" href="index.html#area-info-box"><span class="std std-ref">area info box</span></a> is an area where addtional infos shown to the user.</p>
<p>Fields used in the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/elements/infobox.html">infobox.html</a>:</p>
<dl class="simple">
<dt>img_src: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>URL of a image or thumbnail that is displayed in the infobox.</p>
</dd>
<dt>infobox: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>Title of the info box.</p>
</dd>
<dt>content: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></dt><dd><p>Text of the info box.</p>
</dd>
</dl>
<p>The infobox has additional subsections for <em>attributes</em>, <em>urls</em> and
<em>relatedTopics</em>:</p>
<dl>
<dt>attributes: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of attributes. An <em>attribute</em> is a dictionary with keys:</p>
<ul>
<li><p>label <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
<li><p>value <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
<li><p>image <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>] (optional)</p>
<p>A list of images. An <em>image</em> is a dictionary with keys:</p>
<ul class="simple">
<li><p>src <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: URL of an image/thumbnail (mandatory)</p></li>
<li><p>alt <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: alternative text for the image (mandatory)</p></li>
</ul>
</li>
</ul>
</dd>
<dt>urls: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of links. An <em>link</em> is a dictionary with keys:</p>
<ul class="simple">
<li><p>url <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: URL of the link (mandatory)</p></li>
<li><p>title <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: Title of the link (mandatory)</p></li>
</ul>
</dd>
<dt>relatedTopics: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>]</dt><dd><p>A list of topics. An <em>topic</em> is a dictionary with keys:</p>
<ul>
<li><p>name: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: (mandatory)</p></li>
<li><p>suggestions: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code></a>] (optional)</p>
<p>A list of suggestions. A <em>suggestion</em> is simple dictionary with just one
key/value pair:</p>
<ul class="simple">
<li><p>suggestion: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>: suggested search term (mandatory)</p></li>
</ul>
</li>
</ul>
</dd>
</dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li><a href="index.html">Result Types</a>
<ul>
<li>Previous: <a href="suggestion.html" title="previous chapter">Suggestion Results</a>
<li>Next: <a href="../templates.html" title="next chapter">Simple Theme Templates</a></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/infobox.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

198
dev/result_types/main/keyvalue.html Normal file
View file

@ -0,0 +1,198 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Key-Value Results &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
<script src="../../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Answer Results" href="../answer.html" />
<link rel="prev" title="&lt;no title&gt;" href="mainresult.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="../answer.html" title="Answer Results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="mainresult.html" title="&lt;no title&gt;"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../index.html" >Result Types</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="../main_result.html" accesskey="U">Main Search Results</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Key-Value Results</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="module-searx.result_types.keyvalue">
<span id="key-value-results"></span><span id="result-types-keyvalue"></span><h1>Key-Value Results<a class="headerlink" href="#module-searx.result_types.keyvalue" title="Link to this heading"></a></h1>
<p>Typification of the <em>keyvalue</em> results. Results of this type are rendered in
the <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/result_templates/keyvalue.html">keyvalue.html</a>
template.</p>
<hr class="docutils" />
<dl class="py class">
<dt class="sig sig-object py" id="searx.result_types.keyvalue.KeyValue">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types.keyvalue.</span></span><span class="sig-name descname"><span class="pre">KeyValue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">title:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">content:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">img_src:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">thumbnail:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">publishedDate:</span> <span class="pre">~datetime.datetime</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">pubdate:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">length:</span> <span class="pre">~time.struct_time</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">views:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">author:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">metadata:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">priority:</span> <span class="pre">~typing.Literal['',</span> <span class="pre">'high',</span> <span class="pre">'low']</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">engines:</span> <span class="pre">set[str]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;,</span> <span class="pre">open_group:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">close_group:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False,</span> <span class="pre">positions:</span> <span class="pre">list[int]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;,</span> <span class="pre">score:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0,</span> <span class="pre">category:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">*,</span> <span class="pre">url:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">template:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'keyvalue.html',</span> <span class="pre">engine:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">parsed_url:</span> <span class="pre">~urllib.parse.ParseResult</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">kvmap:</span> <span class="pre">dict[str,</span> <span class="pre">~typing.Any]</span> <span class="pre">|</span> <span class="pre">~collections.OrderedDict[str,</span> <span class="pre">~typing.Any],</span> <span class="pre">caption:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">key_title:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'',</span> <span class="pre">value_title:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/result_types/keyvalue.html#KeyValue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types.keyvalue.KeyValue" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="mainresult.html#searx.result_types._base.MainResult" title="searx.result_types._base.MainResult"><code class="xref py py-class docutils literal notranslate"><span class="pre">MainResult</span></code></a></p>
<p>Simple table view which maps <em>key</em> names (first col) to <em>values</em>
(second col).</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types.keyvalue.KeyValue.kvmap">
<span class="sig-name descname"><span class="pre">kvmap</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">OrderedDict</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.result_types.keyvalue.KeyValue.kvmap" title="Link to this definition"></a></dt>
<dd><p>Dictionary with keys and values. To sort keys, use <code class="xref py py-obj docutils literal notranslate"><span class="pre">OrderedDict</span></code>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types.keyvalue.KeyValue.caption">
<span class="sig-name descname"><span class="pre">caption</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types.keyvalue.KeyValue.caption" title="Link to this definition"></a></dt>
<dd><p>Optional caption for this result.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types.keyvalue.KeyValue.key_title">
<span class="sig-name descname"><span class="pre">key_title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types.keyvalue.KeyValue.key_title" title="Link to this definition"></a></dt>
<dd><p>Optional title for the <em>key column</em>.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types.keyvalue.KeyValue.value_title">
<span class="sig-name descname"><span class="pre">value_title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types.keyvalue.KeyValue.value_title" title="Link to this definition"></a></dt>
<dd><p>Optional title for the <em>value column</em>.</p>
</dd></dl>
</dd></dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../base_result.html">Result</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="../main_result.html">Main Search Results</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">Key-Value Results</a><ul>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types.keyvalue.KeyValue"><code class="docutils literal notranslate"><span class="pre">KeyValue</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../../index.html">Overview</a>
<ul>
<li><a href="../../index.html">Developer documentation</a>
<ul>
<li><a href="../index.html">Result Types</a>
<ul>
<li><a href="../main_result.html">Main Search Results</a>
<ul>
<li>Previous: <a href="mainresult.html" title="previous chapter">&lt;no title&gt;</a>
<li>Next: <a href="../answer.html" title="next chapter">Answer Results</a></ul>
</li></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/dev/result_types/main/keyvalue.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

262
dev/result_types/main/mainresult.html Normal file
View file

@ -0,0 +1,262 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>&lt;no title&gt; &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../../_static/searxng.css?v=52e4ff28" />
<script src="../../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="Key-Value Results" href="keyvalue.html" />
<link rel="prev" title="Main Search Results" href="../main_result.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="keyvalue.html" title="Key-Value Results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../main_result.html" title="Main Search Results"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="../index.html" >Result Types</a> &#187;</li>
<li class="nav-item nav-item-3"><a href="../main_result.html" accesskey="U">Main Search Results</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">&lt;no title&gt;</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<dl class="py class" id="result-types-mainresult">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">searx.result_types._base.</span></span><span class="sig-name descname"><span class="pre">MainResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">title:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">content:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">img_src:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">thumbnail:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">publishedDate:</span> <span class="pre">~datetime.datetime</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pubdate:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">length:</span> <span class="pre">~time.struct_time</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">views:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">author:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">priority:</span> <span class="pre">~typing.Literal[''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'high'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">'low']</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engines:</span> <span class="pre">set[str]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">open_group:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">close_group:</span> <span class="pre">bool</span> <span class="pre">=</span> <span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">positions:</span> <span class="pre">list[int]</span> <span class="pre">=</span> <span class="pre">&lt;factory&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">score:</span> <span class="pre">float</span> <span class="pre">=</span> <span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">category:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">template:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">'default.html'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">engine:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parsed_url:</span> <span class="pre">~urllib.parse.ParseResult</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/result_types/_base.html#MainResult"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.MainResult" title="Link to this definition"></a></dt>
<dd><p>Base class of all result types displayed in <a class="reference internal" href="../index.html#area-main-results"><span class="std std-ref">area main results</span></a>.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.title">
<span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.title" title="Link to this definition"></a></dt>
<dd><p>Link title of the result item.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.content">
<span class="sig-name descname"><span class="pre">content</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.content" title="Link to this definition"></a></dt>
<dd><p>Extract or description of the result item</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.img_src">
<span class="sig-name descname"><span class="pre">img_src</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.img_src" title="Link to this definition"></a></dt>
<dd><p>URL of a image that is displayed in the result item.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.thumbnail">
<span class="sig-name descname"><span class="pre">thumbnail</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.thumbnail" title="Link to this definition"></a></dt>
<dd><p>URL of a thumbnail that is displayed in the result item.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.publishedDate">
<span class="sig-name descname"><span class="pre">publishedDate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.13)"><span class="pre">datetime</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.publishedDate" title="Link to this definition"></a></dt>
<dd><p>The date on which the object was published.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.pubdate">
<span class="sig-name descname"><span class="pre">pubdate</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.pubdate" title="Link to this definition"></a></dt>
<dd><p>String representation of <a class="reference internal" href="#searx.result_types._base.MainResult.publishedDate" title="searx.result_types._base.MainResult.publishedDate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MainResult.publishedDate</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.length">
<span class="sig-name descname"><span class="pre">length</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/time.html#time.struct_time" title="(in Python v3.13)"><span class="pre">struct_time</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.length" title="Link to this definition"></a></dt>
<dd><p>Playing duration in seconds.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.views">
<span class="sig-name descname"><span class="pre">views</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.views" title="Link to this definition"></a></dt>
<dd><p>View count in humanized number format.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.author">
<span class="sig-name descname"><span class="pre">author</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.author" title="Link to this definition"></a></dt>
<dd><p>Author of the title.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.metadata">
<span class="sig-name descname"><span class="pre">metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#searx.result_types._base.MainResult.metadata" title="Link to this definition"></a></dt>
<dd><p>Miscellaneous metadata.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.priority">
<span class="sig-name descname"><span class="pre">priority</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Literal" title="(in Python v3.13)"><span class="pre">Literal</span></a><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">''</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'high'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'low'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.result_types._base.MainResult.priority" title="Link to this definition"></a></dt>
<dd><p>The priority can be set via <a class="reference internal" href="../../plugins/hostnames.html#hostnames-plugin"><span class="std std-ref">Hostnames</span></a>, for example.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.engines">
<span class="sig-name descname"><span class="pre">engines</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.13)"><span class="pre">set</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#searx.result_types._base.MainResult.engines" title="Link to this definition"></a></dt>
<dd><p>In a merged results list, the names of the engines that found this result
are listed in this field.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="searx.result_types._base.MainResult.normalize_result_fields">
<span class="sig-name descname"><span class="pre">normalize_result_fields</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/searx/result_types/_base.html#MainResult.normalize_result_fields"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#searx.result_types._base.MainResult.normalize_result_fields" title="Link to this definition"></a></dt>
<dd><p>Normalize fields <code class="docutils literal notranslate"><span class="pre">url</span></code> and <code class="docutils literal notranslate"><span class="pre">parse_sql</span></code>.</p>
<ul class="simple">
<li><p>If field <code class="docutils literal notranslate"><span class="pre">url</span></code> is set and field <code class="docutils literal notranslate"><span class="pre">parse_url</span></code> is unset, init
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> from field <code class="docutils literal notranslate"><span class="pre">url</span></code>. The <code class="docutils literal notranslate"><span class="pre">url</span></code> field is initialized
with the resulting value in <code class="docutils literal notranslate"><span class="pre">parse_url</span></code>, if <code class="docutils literal notranslate"><span class="pre">url</span></code> and
<code class="docutils literal notranslate"><span class="pre">parse_url</span></code> are not equal.</p></li>
</ul>
</dd></dl>
</dd></dl>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../../index.html">
<img class="logo" src="../../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="../base_result.html">Result</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="../main_result.html">Main Search Results</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a><ul>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.title"><code class="docutils literal notranslate"><span class="pre">MainResult.title</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.content"><code class="docutils literal notranslate"><span class="pre">MainResult.content</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.img_src"><code class="docutils literal notranslate"><span class="pre">MainResult.img_src</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.thumbnail"><code class="docutils literal notranslate"><span class="pre">MainResult.thumbnail</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.publishedDate"><code class="docutils literal notranslate"><span class="pre">MainResult.publishedDate</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.pubdate"><code class="docutils literal notranslate"><span class="pre">MainResult.pubdate</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.length"><code class="docutils literal notranslate"><span class="pre">MainResult.length</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.views"><code class="docutils literal notranslate"><span class="pre">MainResult.views</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.author"><code class="docutils literal notranslate"><span class="pre">MainResult.author</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.metadata"><code class="docutils literal notranslate"><span class="pre">MainResult.metadata</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.priority"><code class="docutils literal notranslate"><span class="pre">MainResult.priority</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.engines"><code class="docutils literal notranslate"><span class="pre">MainResult.engines</span></code></a></li>
<li class="toctree-l5"><a class="reference internal" href="#searx.result_types._base.MainResult.normalize_result_fields"><code class="docutils literal notranslate"><span class="pre">MainResult.normalize_result_fields()</span></code></a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="keyvalue.html">Key-Value Results</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="../infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../../index.html">Overview</a>
<ul>
<li><a href="../../index.html">Developer documentation</a>
<ul>
<li><a href="../index.html">Result Types</a>
<ul>
<li><a href="../main_result.html">Main Search Results</a>
<ul>
<li>Previous: <a href="../main_result.html" title="previous chapter">Main Search Results</a>
<li>Next: <a href="keyvalue.html" title="next chapter">Key-Value Results</a></ul>
</li></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/dev/result_types/main/mainresult.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

198
dev/result_types/main_result.html Normal file
View file

@ -0,0 +1,198 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Main Search Results &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="&lt;no title&gt;" href="main/mainresult.html" />
<link rel="prev" title="Result" href="base_result.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="main/mainresult.html" title="&lt;no title&gt;"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="base_result.html" title="Result"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Main Search Results</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="main-search-results">
<span id="id1"></span><h1>Main Search Results<a class="headerlink" href="#main-search-results" title="Link to this heading"></a></h1>
<p>In the <a class="reference internal" href="index.html#area-main-results"><span class="std std-ref">area main results</span></a> the results that a search engine has found for
the search term are displayed.</p>
<p>There is still no typing for all items in the <a class="reference internal" href="../templates.html#main-result-list"><span class="std std-ref">Main Result List</span></a>. The
following types have been implemented so far ..</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a><ul>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.title"><code class="docutils literal notranslate"><span class="pre">MainResult.title</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.content"><code class="docutils literal notranslate"><span class="pre">MainResult.content</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.img_src"><code class="docutils literal notranslate"><span class="pre">MainResult.img_src</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.thumbnail"><code class="docutils literal notranslate"><span class="pre">MainResult.thumbnail</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.publishedDate"><code class="docutils literal notranslate"><span class="pre">MainResult.publishedDate</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.pubdate"><code class="docutils literal notranslate"><span class="pre">MainResult.pubdate</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.length"><code class="docutils literal notranslate"><span class="pre">MainResult.length</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.views"><code class="docutils literal notranslate"><span class="pre">MainResult.views</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.author"><code class="docutils literal notranslate"><span class="pre">MainResult.author</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.metadata"><code class="docutils literal notranslate"><span class="pre">MainResult.metadata</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.priority"><code class="docutils literal notranslate"><span class="pre">MainResult.priority</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.engines"><code class="docutils literal notranslate"><span class="pre">MainResult.engines</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="main/mainresult.html#searx.result_types._base.MainResult.normalize_result_fields"><code class="docutils literal notranslate"><span class="pre">MainResult.normalize_result_fields()</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="main/keyvalue.html">Key-Value Results</a><ul>
<li class="toctree-l2"><a class="reference internal" href="main/keyvalue.html#searx.result_types.keyvalue.KeyValue"><code class="docutils literal notranslate"><span class="pre">KeyValue</span></code></a></li>
</ul>
</li>
</ul>
</div>
<p>The <a class="reference internal" href="base_result.html#legacyresult"><span class="std std-ref">LegacyResult</span></a> 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.</p>
<ul class="simple">
<li><p><a class="reference internal" href="../templates.html#template-default"><span class="std std-ref">default.html</span></a> / <code class="xref py py-obj docutils literal notranslate"><span class="pre">Result</span></code></p></li>
<li><p><a class="reference internal" href="../templates.html#template-images"><span class="std std-ref">images.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-videos"><span class="std std-ref">videos.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-torrent"><span class="std std-ref">torrent.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-map"><span class="std std-ref">map.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-paper"><span class="std std-ref">paper.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-packages"><span class="std std-ref">packages</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-code"><span class="std std-ref">code.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-files"><span class="std std-ref">files.html</span></a></p></li>
<li><p><a class="reference internal" href="../templates.html#template-products"><span class="std std-ref">products.html</span></a></p></li>
</ul>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Main Search Results</a><ul>
<li class="toctree-l4"><a class="reference internal" href="main/mainresult.html"><code class="docutils literal notranslate"><span class="pre">MainResult</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="main/keyvalue.html">Key-Value Results</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li><a href="index.html">Result Types</a>
<ul>
<li>Previous: <a href="base_result.html" title="previous chapter">Result</a>
<li>Next: <a href="main/mainresult.html" title="next chapter">&lt;no title&gt;</a></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/main_result.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>

176
dev/result_types/suggestion.html Normal file
View file

@ -0,0 +1,176 @@
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Suggestion Results &#8212; SearXNG Documentation (2025.7.19+b95a3e905)</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
<link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
<script src="../../_static/documentation_options.js?v=ab8937c3"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script data-project="searxng" data-version="2025.7.19+b95a3e905" src="../../_static/describe_version.js?v=fa7f30d0"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="Infobox Results" href="infobox.html" />
<link rel="prev" title="Correction Results" href="correction.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="infobox.html" title="Infobox Results"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="correction.html" title="Correction Results"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.7.19+b95a3e905)</a> &#187;</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Suggestion Results</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="suggestion-results">
<span id="result-types-suggestion"></span><h1>Suggestion Results<a class="headerlink" href="#suggestion-results" title="Link to this heading"></a></h1>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>There is still no typing for these result items. The templates can be used as
orientation until the final typing is complete.</p>
</div>
<p>The <a class="reference internal" href="index.html#area-suggestions-results"><span class="std std-ref">area suggestions</span></a> shows the user alternative search terms.</p>
<p>A result of this type is a very simple dictionary with only one key/value pair</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">&quot;suggestion&quot;</span> <span class="p">:</span> <span class="s2">&quot;lorem ipsum ..&quot;</span><span class="p">}</span>
</pre></div>
</div>
<p>From this simple dict another dict is build up:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="p">{</span><span class="s2">&quot;url&quot;</span> <span class="p">:</span> <span class="s2">&quot;!bang lorem ipsum ..&quot;</span><span class="p">,</span> <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="s2">&quot;lorem ipsum&quot;</span> <span class="p">}</span>
</pre></div>
</div>
<p>and used in the template <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/searx/templates/simple/elements/suggestions.html">suggestions.html</a>:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># use RawTextQuery to get the suggestion URLs with the same bang</span>
<span class="p">{</span><span class="s2">&quot;url&quot;</span> <span class="p">:</span> <span class="s2">&quot;!bang lorem ipsum ..&quot;</span><span class="p">,</span> <span class="s2">&quot;title&quot;</span><span class="p">:</span> <span class="s2">&quot;lorem ipsum&quot;</span> <span class="p">}</span>
</pre></div>
</div>
<dl>
<dt>title<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Suggested search term</p>
</dd>
<dt>url<span class="classifier"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></span></dt><dd><p>Not really an URL, its the value to insert in a HTML form for a SearXNG query.</p>
</dd>
</dl>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<span id="sidebar-top"></span>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
</a></p>
<h3><a href="../../index.html">Table of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="../commits.html">Git Commits &amp; Change Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
<li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
<li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Suggestion Results</a></li>
<li class="toctree-l3"><a class="reference internal" href="infobox.html">Infobox Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
<li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
<li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
<li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../makefile.html">Makefile &amp; <code class="docutils literal notranslate"><span class="pre">./manage</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../searxng_extra/index.html">Tooling box <code class="docutils literal notranslate"><span class="pre">searxng_extra</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
</ul>
<h3>Project Links</h3>
<ul>
<li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
<li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
<li><a href="https://searx.space">Public instances</a>
<li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
</ul><h3>Navigation</h3>
<ul>
<li><a href="../../index.html">Overview</a>
<ul>
<li><a href="../index.html">Developer documentation</a>
<ul>
<li><a href="index.html">Result Types</a>
<ul>
<li>Previous: <a href="correction.html" title="previous chapter">Correction Results</a>
<li>Next: <a href="infobox.html" title="next chapter">Infobox Results</a></ul>
</li></ul>
</li>
</ul>
</li>
</ul>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../_sources/dev/result_types/suggestion.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright SearXNG team.
</div>
</body>
</html>