infobox.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  1. <!DOCTYPE html>
  2. <html lang="en" data-content_root="../../">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <title>Infobox Results &#8212; SearXNG Documentation (2025.4.30+fd33559cf)</title>
  8. <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=6625fa76" />
  9. <link rel="stylesheet" type="text/css" href="../../_static/searxng.css?v=52e4ff28" />
  10. <script src="../../_static/documentation_options.js?v=b12b0e12"></script>
  11. <script src="../../_static/doctools.js?v=9a2dae69"></script>
  12. <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
  13. <script data-project="searxng" data-version="2025.4.30+fd33559cf" src="../../_static/describe_version.js?v=fa7f30d0"></script>
  14. <link rel="index" title="Index" href="../../genindex.html" />
  15. <link rel="search" title="Search" href="../../search.html" />
  16. <link rel="next" title="Simple Theme Templates" href="../templates.html" />
  17. <link rel="prev" title="Suggestion Results" href="suggestion.html" />
  18. </head><body>
  19. <div class="related" role="navigation" aria-label="Related">
  20. <h3>Navigation</h3>
  21. <ul>
  22. <li class="right" style="margin-right: 10px">
  23. <a href="../../genindex.html" title="General Index"
  24. accesskey="I">index</a></li>
  25. <li class="right" >
  26. <a href="../../py-modindex.html" title="Python Module Index"
  27. >modules</a> |</li>
  28. <li class="right" >
  29. <a href="../templates.html" title="Simple Theme Templates"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="suggestion.html" title="Suggestion Results"
  33. accesskey="P">previous</a> |</li>
  34. <li class="nav-item nav-item-0"><a href="../../index.html">SearXNG Documentation (2025.4.30+fd33559cf)</a> &#187;</li>
  35. <li class="nav-item nav-item-1"><a href="../index.html" >Developer documentation</a> &#187;</li>
  36. <li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Result Types</a> &#187;</li>
  37. <li class="nav-item nav-item-this"><a href="">Infobox Results</a></li>
  38. </ul>
  39. </div>
  40. <div class="document">
  41. <div class="documentwrapper">
  42. <div class="bodywrapper">
  43. <div class="body" role="main">
  44. <section id="infobox-results">
  45. <span id="result-types-infobox"></span><h1>Infobox Results<a class="headerlink" href="#infobox-results" title="Link to this heading">¶</a></h1>
  46. <div class="admonition hint">
  47. <p class="admonition-title">Hint</p>
  48. <p>There is still no typing for these result items. The templates can be used as
  49. orientation until the final typing is complete.</p>
  50. </div>
  51. <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>
  52. <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>
  53. <dl class="simple">
  54. <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>
  55. </dd>
  56. <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>
  57. </dd>
  58. <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>
  59. </dd>
  60. </dl>
  61. <p>The infobox has additional subsections for <em>attributes</em>, <em>urls</em> and
  62. <em>relatedTopics</em>:</p>
  63. <dl>
  64. <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>
  65. <ul>
  66. <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>
  67. <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>
  68. <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>
  69. <p>A list of images. An <em>image</em> is a dictionary with keys:</p>
  70. <ul class="simple">
  71. <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>
  72. <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>
  73. </ul>
  74. </li>
  75. </ul>
  76. </dd>
  77. <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>
  78. <ul class="simple">
  79. <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>
  80. <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>
  81. </ul>
  82. </dd>
  83. <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>
  84. <ul>
  85. <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>
  86. <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>
  87. <p>A list of suggestions. A <em>suggestion</em> is simple dictionary with just one
  88. key/value pair:</p>
  89. <ul class="simple">
  90. <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>
  91. </ul>
  92. </li>
  93. </ul>
  94. </dd>
  95. </dl>
  96. </section>
  97. <div class="clearer"></div>
  98. </div>
  99. </div>
  100. </div>
  101. <span id="sidebar-top"></span>
  102. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  103. <div class="sphinxsidebarwrapper">
  104. <p class="logo"><a href="../../index.html">
  105. <img class="logo" src="../../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  106. </a></p>
  107. <h3><a href="../../index.html">Table of Contents</a></h3>
  108. <ul class="current">
  109. <li class="toctree-l1"><a class="reference internal" href="../../user/index.html">User information</a></li>
  110. <li class="toctree-l1"><a class="reference internal" href="../../own-instance.html">Why use a private instance?</a></li>
  111. <li class="toctree-l1"><a class="reference internal" href="../../admin/index.html">Administrator documentation</a></li>
  112. <li class="toctree-l1 current"><a class="reference internal" href="../index.html">Developer documentation</a><ul class="current">
  113. <li class="toctree-l2"><a class="reference internal" href="../quickstart.html">Development Quickstart</a></li>
  114. <li class="toctree-l2"><a class="reference internal" href="../rtm_asdf.html">Runtime Management</a></li>
  115. <li class="toctree-l2"><a class="reference internal" href="../contribution_guide.html">How to contribute</a></li>
  116. <li class="toctree-l2"><a class="reference internal" href="../extended_types.html">Extended Types</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="../engines/index.html">Engine Implementations</a></li>
  118. <li class="toctree-l2 current"><a class="reference internal" href="index.html">Result Types</a><ul class="current">
  119. <li class="toctree-l3"><a class="reference internal" href="base_result.html">Result</a></li>
  120. <li class="toctree-l3"><a class="reference internal" href="main_result.html">Main Search Results</a></li>
  121. <li class="toctree-l3"><a class="reference internal" href="answer.html">Answer Results</a></li>
  122. <li class="toctree-l3"><a class="reference internal" href="correction.html">Correction Results</a></li>
  123. <li class="toctree-l3"><a class="reference internal" href="suggestion.html">Suggestion Results</a></li>
  124. <li class="toctree-l3 current"><a class="current reference internal" href="#">Infobox Results</a></li>
  125. </ul>
  126. </li>
  127. <li class="toctree-l2"><a class="reference internal" href="../templates.html">Simple Theme Templates</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="../search_api.html">Search API</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="../plugins/index.html">Plugins</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="../answerers/index.html">Answerers</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="../translation.html">Translation</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="../lxcdev.html">Developing in Linux Containers</a></li>
  133. <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>
  134. <li class="toctree-l2"><a class="reference internal" href="../reST.html">reST primer</a></li>
  135. <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>
  136. </ul>
  137. </li>
  138. <li class="toctree-l1"><a class="reference internal" href="../../utils/index.html">DevOps tooling box</a></li>
  139. <li class="toctree-l1"><a class="reference internal" href="../../src/index.html">Source-Code</a></li>
  140. </ul>
  141. <h3>Project Links</h3>
  142. <ul>
  143. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  144. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  145. <li><a href="https://searx.space">Public instances</a>
  146. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  147. </ul><h3>Navigation</h3>
  148. <ul>
  149. <li><a href="../../index.html">Overview</a>
  150. <ul>
  151. <li><a href="../index.html">Developer documentation</a>
  152. <ul>
  153. <li><a href="index.html">Result Types</a>
  154. <ul>
  155. <li>Previous: <a href="suggestion.html" title="previous chapter">Suggestion Results</a>
  156. <li>Next: <a href="../templates.html" title="next chapter">Simple Theme Templates</a></ul>
  157. </li></ul>
  158. </li>
  159. </ul>
  160. </li>
  161. </ul>
  162. <search id="searchbox" style="display: none" role="search">
  163. <h3 id="searchlabel">Quick search</h3>
  164. <div class="searchformwrapper">
  165. <form class="search" action="../../search.html" method="get">
  166. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  167. <input type="submit" value="Go" />
  168. </form>
  169. </div>
  170. </search>
  171. <script>document.getElementById('searchbox').style.display = "block"</script>
  172. <div role="note" aria-label="source link">
  173. <h3>This Page</h3>
  174. <ul class="this-page-menu">
  175. <li><a href="../../_sources/dev/result_types/infobox.rst.txt"
  176. rel="nofollow">Show Source</a></li>
  177. </ul>
  178. </div>
  179. </div>
  180. </div>
  181. <div class="clearer"></div>
  182. </div>
  183. <div class="footer" role="contentinfo">
  184. &#169; Copyright SearXNG team.
  185. </div>
  186. </body>
  187. </html>