translation.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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>Translation &#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="Developing in Linux Containers" href="lxcdev.html" />
  17. <link rel="prev" title="Statistics" href="answerers/statistics.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="lxcdev.html" title="Developing in Linux Containers"
  30. accesskey="N">next</a> |</li>
  31. <li class="right" >
  32. <a href="answerers/statistics.html" title="Statistics"
  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" accesskey="U">Developer documentation</a> &#187;</li>
  36. <li class="nav-item nav-item-this"><a href="">Translation</a></li>
  37. </ul>
  38. </div>
  39. <div class="document">
  40. <div class="documentwrapper">
  41. <div class="bodywrapper">
  42. <div class="body" role="main">
  43. <section id="translation">
  44. <span id="id1"></span><h1>Translation<a class="headerlink" href="#translation" title="Link to this heading">¶</a></h1>
  45. <aside class="sidebar">
  46. <p class="sidebar-title"><a class="reference external" href="https://translate.codeberg.org/projects/searxng/"><img alt="translated" src="https://translate.codeberg.org/widgets/searxng/-/searxng/svg-badge.svg" /></a></p>
  47. <ul class="simple">
  48. <li><p><a class="reference internal" href="../src/searx.babel_extract.html#searx-babel-extract"><span class="std std-ref">Custom message extractor (i18n)</span></a></p></li>
  49. <li><p><a class="reference external" href="https://docs.weblate.org">Weblate</a></p></li>
  50. <li><p>SearXNG <a class="reference external" href="https://github.com/searxng/searxng/tree/translations">translations branch</a></p></li>
  51. <li><p>SearXNG <a class="reference external" href="https://translate.codeberg.org/projects/searxng/searxng/#repository">Weblate repository</a></p></li>
  52. <li><p>Weblate Client: <a class="reference external" href="https://docs.weblate.org/en/latest/wlc.html">wlc</a></p></li>
  53. <li><p>Babel Command-Line: <a class="reference external" href="http://babel.pocoo.org/en/latest/cmdline.html">pybabel</a></p></li>
  54. <li><p><a class="reference external" href="https://docs.weblate.org/en/latest/workflows.html">weblate workflow</a></p></li>
  55. </ul>
  56. </aside>
  57. <p>Translation takes place on <a class="reference external" href="https://translate.codeberg.org/projects/searxng/">translate.codeberg.org</a>.</p>
  58. <p>Translations which has been added by translators on the <a class="reference external" href="https://translate.codeberg.org/projects/searxng/">translate.codeberg.org</a> UI are
  59. committed to Weblate’s counterpart of the SearXNG <em>origin</em> repository which is
  60. located at <code class="docutils literal notranslate"><span class="pre">https://translate.codeberg.org/git/searxng/searxng</span></code>.</p>
  61. <p>There is no need to clone this repository, <a class="reference internal" href="#searxng-weblate-workflow"><span class="std std-ref">SearXNG’s PR workflow to be in sync with Weblate</span></a> take
  62. care of the synchronization with the <em>origin</em>. To avoid merging commits from
  63. the counterpart directly on the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch of <em>SearXNG origin</em>, a <em>pull
  64. request</em> (PR) is created by this workflow.</p>
  65. <p>Weblate monitors the <a class="reference external" href="https://github.com/searxng/searxng/tree/translations">translations branch</a>, not the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch. This
  66. branch is an <a class="reference external" href="https://git-scm.com/docs/git-checkout#Documentation/git-checkout.txt---orphanltnewbranchgt">orphan branch</a>, decoupled from the master branch (we already know
  67. orphan branches from the <code class="docutils literal notranslate"><span class="pre">gh-pages</span></code>). The <a class="reference external" href="https://github.com/searxng/searxng/tree/translations">translations branch</a> contains
  68. only the</p>
  69. <ul class="simple">
  70. <li><p><code class="docutils literal notranslate"><span class="pre">translation/messages.pot</span></code> and the</p></li>
  71. <li><p><code class="docutils literal notranslate"><span class="pre">translation/*/messages.po</span></code> files, nothing else.</p></li>
  72. </ul>
  73. <figure class="align-default" id="id3">
  74. <span id="searxng-weblate-workflow"></span><img alt="../_images/translation.svg" src="../_images/translation.svg" />
  75. <figcaption>
  76. <p><span class="caption-number">Fig. 3 </span><span class="caption-text">SearXNG’s PR workflow to be in sync with Weblate</span><a class="headerlink" href="#id3" title="Link to this image">¶</a></p>
  77. </figcaption>
  78. </figure>
  79. <dl class="simple">
  80. <dt>Sync from <em>origin</em> to <em>weblate</em>: using <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">weblate.push.translations</span></code></dt><dd><p>For each commit on the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch of SearXNG <em>origin</em> the GitHub job
  81. <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/.github/workflows/integration.yml">babel / Update translations branch</a> checks for updated translations.</p>
  82. </dd>
  83. <dt>Sync from <em>weblate</em> to <em>origin</em>: using <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">weblate.translations.commit</span></code></dt><dd><p>Every Friday, the GitHub workflow <a class="extlink-origin reference external" href="https://github.com/searxng/searxng/blob/master/.github/workflows/translations-update.yml">babel / create PR for additions from
  84. weblate</a> creates a PR with the
  85. updated translation files:</p>
  86. <ul class="simple">
  87. <li><p><code class="docutils literal notranslate"><span class="pre">translation/messages.pot</span></code>,</p></li>
  88. <li><p><code class="docutils literal notranslate"><span class="pre">translation/*/messages.po</span></code> and</p></li>
  89. <li><p><code class="docutils literal notranslate"><span class="pre">translation/*/messages.mo</span></code></p></li>
  90. </ul>
  91. </dd>
  92. </dl>
  93. <section id="id2">
  94. <h2>wlc<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h2>
  95. <p>All weblate integration is done by GitHub workflows, but if you want to use <a class="reference external" href="https://docs.weblate.org/en/latest/wlc.html">wlc</a>,
  96. copy this content into <a class="reference external" href="https://docs.weblate.org/en/latest/wlc.html#wlc-config">wlc configuration</a> in your HOME <code class="docutils literal notranslate"><span class="pre">~/.config/weblate</span></code></p>
  97. <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[keys]</span>
  98. <span class="na">https</span><span class="o">:</span><span class="s">//translate.codeberg.org/api/ = APIKEY</span>
  99. </pre></div>
  100. </div>
  101. <p>Replace <code class="docutils literal notranslate"><span class="pre">APIKEY</span></code> by your <a class="reference external" href="https://translate.codeberg.org/accounts/profile/#api">API key</a>.</p>
  102. </section>
  103. </section>
  104. <div class="clearer"></div>
  105. </div>
  106. </div>
  107. </div>
  108. <span id="sidebar-top"></span>
  109. <div class="sphinxsidebar" role="navigation" aria-label="Main">
  110. <div class="sphinxsidebarwrapper">
  111. <p class="logo"><a href="../index.html">
  112. <img class="logo" src="../_static/searxng-wordmark.svg" alt="Logo of SearXNG"/>
  113. </a></p>
  114. <h3><a href="../index.html">Table of Contents</a></h3>
  115. <ul class="current">
  116. <li class="toctree-l1"><a class="reference internal" href="../user/index.html">User information</a></li>
  117. <li class="toctree-l1"><a class="reference internal" href="../own-instance.html">Why use a private instance?</a></li>
  118. <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator documentation</a></li>
  119. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer documentation</a><ul class="current">
  120. <li class="toctree-l2"><a class="reference internal" href="quickstart.html">Development Quickstart</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="rtm_asdf.html">Runtime Management</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="contribution_guide.html">How to contribute</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="extended_types.html">Extended Types</a></li>
  124. <li class="toctree-l2"><a class="reference internal" href="engines/index.html">Engine Implementations</a></li>
  125. <li class="toctree-l2"><a class="reference internal" href="result_types/index.html">Result Types</a></li>
  126. <li class="toctree-l2"><a class="reference internal" href="templates.html">Simple Theme Templates</a></li>
  127. <li class="toctree-l2"><a class="reference internal" href="search_api.html">Search API</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="plugins/index.html">Plugins</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="answerers/index.html">Answerers</a></li>
  130. <li class="toctree-l2 current"><a class="current reference internal" href="#">Translation</a><ul>
  131. <li class="toctree-l3"><a class="reference internal" href="#id2">wlc</a></li>
  132. </ul>
  133. </li>
  134. <li class="toctree-l2"><a class="reference internal" href="lxcdev.html">Developing in Linux Containers</a></li>
  135. <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>
  136. <li class="toctree-l2"><a class="reference internal" href="reST.html">reST primer</a></li>
  137. <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>
  138. </ul>
  139. </li>
  140. <li class="toctree-l1"><a class="reference internal" href="../utils/index.html">DevOps tooling box</a></li>
  141. <li class="toctree-l1"><a class="reference internal" href="../src/index.html">Source-Code</a></li>
  142. </ul>
  143. <h3>Project Links</h3>
  144. <ul>
  145. <li><a href="https://github.com/searxng/searxng/tree/master">Source</a>
  146. <li><a href="https://github.com/searxng/searxng/wiki">Wiki</a>
  147. <li><a href="https://searx.space">Public instances</a>
  148. <li><a href="https://github.com/searxng/searxng/issues">Issue Tracker</a>
  149. </ul><h3>Navigation</h3>
  150. <ul>
  151. <li><a href="../index.html">Overview</a>
  152. <ul>
  153. <li><a href="index.html">Developer documentation</a>
  154. <ul>
  155. <li>Previous: <a href="answerers/statistics.html" title="previous chapter">Statistics</a>
  156. <li>Next: <a href="lxcdev.html" title="next chapter">Developing in Linux Containers</a></ul>
  157. </li>
  158. </ul>
  159. </li>
  160. </ul>
  161. <search id="searchbox" style="display: none" role="search">
  162. <h3 id="searchlabel">Quick search</h3>
  163. <div class="searchformwrapper">
  164. <form class="search" action="../search.html" method="get">
  165. <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
  166. <input type="submit" value="Go" />
  167. </form>
  168. </div>
  169. </search>
  170. <script>document.getElementById('searchbox').style.display = "block"</script>
  171. <div role="note" aria-label="source link">
  172. <h3>This Page</h3>
  173. <ul class="this-page-menu">
  174. <li><a href="../_sources/dev/translation.rst.txt"
  175. rel="nofollow">Show Source</a></li>
  176. </ul>
  177. </div>
  178. </div>
  179. </div>
  180. <div class="clearer"></div>
  181. </div>
  182. <div class="footer" role="contentinfo">
  183. &#169; Copyright SearXNG team.
  184. </div>
  185. </body>
  186. </html>