searx/dev/translation.html

162 lines
7.6 KiB
HTML
Raw Normal View History

2019-12-30 18:31:17 +01:00
<!DOCTYPE html>
2015-11-17 23:38:25 +01:00
2020-06-19 11:15:15 +02:00
<html>
2015-11-17 23:38:25 +01:00
<head>
2019-12-30 18:31:17 +01:00
<meta charset="utf-8" />
2020-09-30 10:35:05 +02:00
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
2019-12-30 18:31:17 +01:00
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Translation &#8212; Searx Documentation (Searx-1.0.0.tex)</title>
2015-11-17 23:38:25 +01:00
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/searx.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
2020-02-15 10:08:58 +01:00
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
2016-11-04 21:56:14 +01:00
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
2019-12-30 18:31:17 +01:00
<link rel="next" title="Makefile Targets" href="makefile.html" />
2015-11-17 23:38:25 +01:00
<link rel="prev" title="Plugins" href="plugins.html" />
2019-12-30 18:31:17 +01:00
<script>DOCUMENTATION_OPTIONS.URL_ROOT = '../';</script>
2015-11-17 23:38:25 +01:00
2019-12-30 18:31:17 +01:00
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<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>
2019-12-30 18:31:17 +01:00
<li class="right" >
<a href="makefile.html" title="Makefile Targets"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="plugins.html" title="Plugins"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Searx Documentation (Searx-1.0.0.tex)</a> &#187;</li>
2020-09-30 10:35:05 +02:00
<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="">Translation</a></li>
2019-12-30 18:31:17 +01:00
</ul>
</div>
2015-11-17 23:38:25 +01:00
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="translation">
2019-12-30 18:31:17 +01:00
<span id="id1"></span><h1>Translation<a class="headerlink" href="#translation" title="Permalink to this headline"></a></h1>
<p>Translation currently takes place on <a class="reference external" href="https://www.transifex.com/asciimoo/searx/">searx&#64;transifex</a></p>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline"></a></h2>
2019-12-30 18:31:17 +01:00
<ul class="simple">
<li><p>Transifex account</p></li>
<li><p>Installed CLI tool of Transifex</p></li>
</ul>
</div>
<div class="section" id="init-transifex-project">
<h2>Init Transifex project<a class="headerlink" href="#init-transifex-project" title="Permalink to this headline"></a></h2>
2019-12-30 18:31:17 +01:00
<p>After installing <code class="docutils literal notranslate"><span class="pre">transifex</span></code> using pip, run the following command to
initialize the project.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>tx init <span class="c1"># Transifex instance: https://www.transifex.com/asciimoo/searx/</span>
</pre></div>
</div>
2019-12-30 18:31:17 +01:00
<p>After <code class="docutils literal notranslate"><span class="pre">$HOME/.transifexrc</span></code> is created, get a Transifex API key and insert it
into the configuration file.</p>
<p>Create a configuration file for <code class="docutils literal notranslate"><span class="pre">tx</span></code> named <code class="docutils literal notranslate"><span class="pre">$HOME/.tx/config</span></code>.</p>
<div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[main]</span>
<span class="na">host</span> <span class="o">=</span> <span class="s">https://www.transifex.com</span>
<span class="k">[searx.messagespo]</span>
<span class="na">file_filter</span> <span class="o">=</span> <span class="s">searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po</span>
<span class="na">source_file</span> <span class="o">=</span> <span class="s">messages.pot</span>
<span class="na">source_lang</span> <span class="o">=</span> <span class="s">en</span>
<span class="na">type</span> <span class="o">=</span> <span class="s">PO</span>
</pre></div>
</div>
2019-12-30 18:31:17 +01:00
<p>Then run <code class="docutils literal notranslate"><span class="pre">tx</span> <span class="pre">set</span></code>:</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>tx <span class="nb">set</span> --auto-local -r searx.messagespo <span class="s1">&#39;searx/translations/&lt;lang&gt;/LC_MESSAGES/messages.po&#39;</span> <span class="se">\</span>
--source-lang en --type PO --source-file messages.pot --execute
2015-11-17 23:38:25 +01:00
</pre></div>
</div>
</div>
<div class="section" id="update-translations">
<h2>Update translations<a class="headerlink" href="#update-translations" title="Permalink to this headline"></a></h2>
<p>To retrieve the latest translations, pull it from Transifex.</p>
2019-12-30 18:31:17 +01:00
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>tx pull -a
2015-11-17 23:38:25 +01:00
</pre></div>
</div>
2019-12-30 18:31:17 +01:00
<p>Then check the new languages. If strings translated are not enough, delete those
folders, because those should not be compiled. Call the command below to compile
the <code class="docutils literal notranslate"><span class="pre">.po</span></code> files.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pybabel compile -d searx/translations
2015-11-17 23:38:25 +01:00
</pre></div>
</div>
2019-12-30 18:31:17 +01:00
<p>After the compilation is finished commit the <code class="docutils literal notranslate"><span class="pre">.po</span></code> and <code class="docutils literal notranslate"><span class="pre">.mo</span></code> files and
create a PR.</p>
</div>
</div>
2015-11-17 23:38:25 +01:00
2020-09-30 10:35:05 +02:00
<div class="clearer"></div>
2015-11-17 23:38:25 +01:00
</div>
</div>
</div>
2019-12-30 18:31:17 +01:00
<span id="sidebar-top"></span>
2015-11-17 23:38:25 +01:00
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
2019-12-30 18:31:17 +01:00
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/searx_logo_small.png" alt="Logo"/>
</a></p>
<h3>Project Links</h3>
<ul>
2020-09-30 10:35:05 +02:00
<li><a href="https://github.com/searx/searx">Source</a>
2019-12-30 18:31:17 +01:00
2020-09-30 10:35:05 +02:00
<li><a href="https://github.com/searx/searx/wiki">Wiki</a>
2019-12-30 18:31:17 +01:00
<li><a href="https://searx.space">Public instances</a>
2019-12-30 18:31:17 +01:00
<li><a href="https://twitter.com/Searx_engine">Twitter</a>
<li><a href="https://github.com/searx/searx/issues">Issue Tracker</a>
2019-12-30 18:31:17 +01:00
</ul><h3>Navigation</h3>
2015-11-17 23:38:25 +01:00
<ul>
2019-12-30 18:31:17 +01:00
<li><a href="../index.html">Overview</a>
<ul>
<li><a href="index.html">Developer documentation</a>
<ul>
<li>Previous: <a href="plugins.html" title="previous chapter">Plugins</a>
<li>Next: <a href="makefile.html" title="next chapter">Makefile Targets</a></ul>
</li>
</ul>
</li>
2015-11-17 23:38:25 +01:00
</ul>
2019-12-30 18:31:17 +01:00
<div 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" />
<input type="submit" value="Go" />
</form>
</div>
2015-11-17 23:38:25 +01:00
</div>
2020-02-15 10:08:58 +01:00
<script>$('#searchbox').show(0);</script>
2015-11-17 23:38:25 +01:00
</div>
</div>
<div class="clearer"></div>
</div>
2019-12-30 18:31:17 +01:00
<div class="footer" role="contentinfo">
2020-02-20 19:32:55 +01:00
&#169; Copyright 2015-2020, Adam Tauber, Noémi Ványi.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.3.
2015-11-17 23:38:25 +01:00
</div>
2020-02-15 10:08:58 +01:00
<script src="../_static/version_warning_offset.js"></script>
2019-12-30 18:31:17 +01:00
2015-11-17 23:38:25 +01:00
</body>
</html>