plugins.html 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. <!DOCTYPE html>
  2. <html lang="en">
  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>Plugins builtin &#8212; Searx Documentation (Searx-1.1.0.tex)</title>
  8. <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  9. <link rel="stylesheet" type="text/css" href="../_static/searx.css" />
  10. <link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
  11. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  12. <script src="../_static/jquery.js"></script>
  13. <script src="../_static/underscore.js"></script>
  14. <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
  15. <script src="../_static/doctools.js"></script>
  16. <script src="../_static/sphinx_highlight.js"></script>
  17. <link rel="index" title="Index" href="../genindex.html" />
  18. <link rel="search" title="Search" href="../search.html" />
  19. <link rel="next" title="Buildhosts" href="buildhosts.html" />
  20. <link rel="prev" title="Query SQL and NoSQL servers" href="no-sql-engines.html" />
  21. </head><body>
  22. <div class="related" role="navigation" aria-label="related navigation">
  23. <h3>Navigation</h3>
  24. <ul>
  25. <li class="right" style="margin-right: 10px">
  26. <a href="../genindex.html" title="General Index"
  27. accesskey="I">index</a></li>
  28. <li class="right" >
  29. <a href="../py-modindex.html" title="Python Module Index"
  30. >modules</a> |</li>
  31. <li class="right" >
  32. <a href="buildhosts.html" title="Buildhosts"
  33. accesskey="N">next</a> |</li>
  34. <li class="right" >
  35. <a href="no-sql-engines.html" title="Query SQL and NoSQL servers"
  36. accesskey="P">previous</a> |</li>
  37. <li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.1.0.tex)</a> &#187;</li>
  38. <li class="nav-item nav-item-1"><a href="index.html" accesskey="U">Administrator documentation</a> &#187;</li>
  39. <li class="nav-item nav-item-this"><a href="">Plugins builtin</a></li>
  40. </ul>
  41. </div>
  42. <div class="document">
  43. <div class="documentwrapper">
  44. <div class="bodywrapper">
  45. <div class="body" role="main">
  46. <section id="plugins-builtin">
  47. <span id="plugins-generic"></span><h1>Plugins builtin<a class="headerlink" href="#plugins-builtin" title="Permalink to this heading">¶</a></h1>
  48. <aside class="sidebar">
  49. <p class="sidebar-title">Further reading ..</p>
  50. <ul class="simple">
  51. <li><p><a class="reference internal" href="../dev/plugins.html#dev-plugin"><span class="std std-ref">Plugins</span></a></p></li>
  52. </ul>
  53. </aside>
  54. <p>Configuration defaults (at built time):</p>
  55. <dl class="field-list simple">
  56. <dt class="field-odd">DO<span class="colon">:</span></dt>
  57. <dd class="field-odd"><p>Default on</p>
  58. </dd>
  59. </dl>
  60. <span id="configured-plugins"></span><table class="docutils align-default" id="id1">
  61. <caption><span class="caption-number">Table 3 </span><span class="caption-text">Plugins configured at built time (defaults)</span><a class="headerlink" href="#id1" title="Permalink to this table">¶</a></caption>
  62. <colgroup>
  63. <col style="width: 23%" />
  64. <col style="width: 8%" />
  65. <col style="width: 69%" />
  66. </colgroup>
  67. <thead>
  68. <tr class="row-odd"><th class="head stub"><p>Name</p></th>
  69. <th class="head"><p>DO</p></th>
  70. <th class="head"><p>Description</p>
  71. <p>JS &amp; CSS dependencies</p>
  72. </th>
  73. </tr>
  74. </thead>
  75. <tbody>
  76. <tr class="row-even"><th class="stub"><p>Open Access DOI rewrite</p></th>
  77. <td></td>
  78. <td><p>Avoid paywalls by redirecting to open-access versions of publications when available</p></td>
  79. </tr>
  80. <tr class="row-odd"><th class="stub"><p>Hash plugin</p></th>
  81. <td><p>y</p></td>
  82. <td><p>Converts strings to different hash digests.</p></td>
  83. </tr>
  84. <tr class="row-even"><th class="stub"><p>HTTPS rewrite</p></th>
  85. <td><p>y</p></td>
  86. <td><p>Rewrite HTTP links to HTTPS if possible</p></td>
  87. </tr>
  88. <tr class="row-odd"><th class="stub"><p>Infinite scroll</p></th>
  89. <td></td>
  90. <td><p>Automatically load next page when scrolling to bottom of current page</p>
  91. <div class="line-block">
  92. <div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/infinite_scroll.js</span></code> </div>
  93. <div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/css/infinite_scroll.css</span></code> </div>
  94. </div>
  95. </td>
  96. </tr>
  97. <tr class="row-even"><th class="stub"><p>Self Informations</p></th>
  98. <td><p>y</p></td>
  99. <td><p>Displays your IP if the query is “ip” and your user agent if the query contains “user agent”.</p></td>
  100. </tr>
  101. <tr class="row-odd"><th class="stub"><p>Hostname replace</p></th>
  102. <td></td>
  103. <td><p>Rewrite result hostnames</p></td>
  104. </tr>
  105. <tr class="row-even"><th class="stub"><p>Search on category select</p></th>
  106. <td><p>y</p></td>
  107. <td><p>Perform search immediately if a category selected. Disable to select multiple categories. (JavaScript required)</p>
  108. <div class="line-block">
  109. <div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/search_on_category_select.js</span></code> </div>
  110. </div>
  111. </td>
  112. </tr>
  113. <tr class="row-odd"><th class="stub"><p>Search operators</p></th>
  114. <td></td>
  115. <td><p>Filter results using hyphen, site: and -site:.</p></td>
  116. </tr>
  117. </tbody>
  118. </table>
  119. <p>Please note that you might get less results with the additional filtering.</p>
  120. <blockquote>
  121. <div><ul>
  122. <li><ul class="simple">
  123. <li><p>Tracker URL remover</p></li>
  124. <li><p>y</p></li>
  125. <li><p>Remove trackers arguments from the returned URL</p></li>
  126. </ul>
  127. </li>
  128. <li><ul>
  129. <li><p>Vim-like hotkeys</p></li>
  130. <li></li>
  131. <li><p>Navigate search results with Vim-like hotkeys (JavaScript required). Press “h” key on main or result page to get help.</p>
  132. <div class="line-block">
  133. <div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/js/vim_hotkeys.js</span></code> </div>
  134. <div class="line"><code class="docutils literal notranslate"><span class="pre">plugins/css/vim_hotkeys.css</span></code> </div>
  135. </div>
  136. </li>
  137. </ul>
  138. </li>
  139. </ul>
  140. </div></blockquote>
  141. </section>
  142. <div class="clearer"></div>
  143. </div>
  144. </div>
  145. </div>
  146. <span id="sidebar-top"></span>
  147. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  148. <div class="sphinxsidebarwrapper">
  149. <p class="logo"><a href="../index.html">
  150. <img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
  151. </a></p>
  152. <h3>Project Links</h3>
  153. <ul>
  154. <li><a href="https://searx.github.io/searx/blog/index.html">Blog</a>
  155. <li><a href="https://github.com/searx/searx">Source</a>
  156. <li><a href="https://github.com/searx/searx/wiki">Wiki</a>
  157. <li><a href="https://twitter.com/Searx_engine">Twitter</a>
  158. <li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
  159. </ul><h3>Navigation</h3>
  160. <ul>
  161. <li><a href="../index.html">Overview</a>
  162. <ul>
  163. <li><a href="index.html">Administrator documentation</a>
  164. <ul>
  165. <li>Previous: <a href="no-sql-engines.html" title="previous chapter">Query SQL and NoSQL servers</a>
  166. <li>Next: <a href="buildhosts.html" title="next chapter">Buildhosts</a></ul>
  167. </li>
  168. </ul>
  169. </li>
  170. </ul>
  171. <div id="searchbox" style="display: none" role="search">
  172. <h3 id="searchlabel">Quick search</h3>
  173. <div class="searchformwrapper">
  174. <form class="search" action="../search.html" method="get">
  175. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  176. <input type="submit" value="Go" />
  177. </form>
  178. </div>
  179. </div>
  180. <script>document.getElementById('searchbox').style.display = "block"</script>
  181. </div>
  182. </div>
  183. <div class="clearer"></div>
  184. </div>
  185. <div class="footer" role="contentinfo">
  186. &#169; Copyright 2015-2022, Adam Tauber, Noémi Ványi.
  187. Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.3.0.
  188. </div>
  189. <script src="../_static/version_warning_offset.js"></script>
  190. </body>
  191. </html>