<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Internationalization — elib.intl 0.0.3 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="Table Of Contents" href="index.html" />
</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>
<li class="right" >
<a href="index.html" title="Table Of Contents"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">elib.intl 0.0.3 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-elib.intl">
<span id="internationalization"></span><h1>Internationalization<a class="headerlink" href="#module-elib.intl" title="Permalink to this headline">¶</a></h1>
<p>The elib.intl module provides enhanced internationalization (I18N) services for
your Python modules and applications.</p>
<p>elib.intl wraps Python’s <code class="xref py py-func docutils literal notranslate"><span class="pre">gettext()</span></code> functionality and adds the following on
Microsoft Windows systems:</p>
<blockquote>
<div><ul class="simple">
<li>automatic detection of the current screen language (not necessarily the same
as the installation language) provided by MUI packs,</li>
<li>makes sure internationalized C libraries which internally invoke gettext() or
dcgettext() can properly locate their message catalogs. This fixes a known
limitation in gettext’s Windows support when using eg. gtk.builder or gtk.glade.</li>
</ul>
</div></blockquote>
<p>See <a class="reference external" href="http://www.gnu.org/software/gettext/FAQ.html#windows_setenv">http://www.gnu.org/software/gettext/FAQ.html#windows_setenv</a> for more
information.</p>
<p>The elib.intl module defines the following functions:</p>
<dl class="function">
<dt id="elib.intl.install">
<code class="descclassname">elib.intl.</code><code class="descname">install</code><span class="sig-paren">(</span><em>domain</em>, <em>localedir</em><span class="sig-paren">)</span><a class="headerlink" href="#elib.intl.install" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> – translation domain</li>
<li><strong>localedir</strong> – locale directory</li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Installs the function _() in Python’s builtin namespace, based on
domain and localedir. Codeset is always UTF-8.</p>
<p>As seen below, you usually mark the strings in your application that are
candidates for translation, by wrapping them in a call to the _() function,
like this:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">elib.intl</span>
<span class="n">elib</span><span class="o">.</span><span class="n">intl</span><span class="o">.</span><span class="n">install</span><span class="p">(</span><span class="s1">'myapplication'</span><span class="p">,</span> <span class="s1">'/path/to/usr/share/locale'</span><span class="p">)</span>
<span class="k">print</span> <span class="n">_</span><span class="p">(</span><span class="s1">'This string will be translated.'</span><span class="p">)</span>
</pre></div>
</div>
<p>Note that this is only one way, albeit the most convenient way,
to make the _() function available to your application. Because it affects
the entire application globally, and specifically Python’s built-in
namespace, localized modules should never install _(). Instead, you should
use <a class="reference internal" href="#elib.intl.install_module" title="elib.intl.install_module"><code class="xref py py-func docutils literal notranslate"><span class="pre">elib.intl.install_module()</span></code></a> to make _() available to your module.</p>
</dd></dl>
<dl class="function">
<dt id="elib.intl.install_module">
<code class="descclassname">elib.intl.</code><code class="descname">install_module</code><span class="sig-paren">(</span><em>domain</em>, <em>localedir</em><span class="sig-paren">)</span><a class="headerlink" href="#elib.intl.install_module" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>domain</strong> – translation domain</li>
<li><strong>localedir</strong> – locale directory</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">an anonymous function object, based on domain and localedir.
Codeset is always UTF-8.</p>
</td>
</tr>
</tbody>
</table>
<p>You may find this function usefull when writing localized modules.
Use this code to make _() available to your module:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">elib.intl</span>
<span class="n">_</span> <span class="o">=</span> <span class="n">elib</span><span class="o">.</span><span class="n">intl</span><span class="o">.</span><span class="n">install_module</span><span class="p">(</span><span class="s1">'mymodule'</span><span class="p">,</span> <span class="s1">'/path/to/usr/share/locale'</span><span class="p">)</span>
<span class="k">print</span> <span class="n">_</span><span class="p">(</span><span class="s1">'This string will be translated.'</span><span class="p">)</span>
</pre></div>
</div>
<p>When writing a package, you can usually do this in the package’s __init__.py
file and import the _() function from the package namespace as needed.</p>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Table Of Contents</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/intl.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<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"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="index.html" title="Table Of Contents"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">elib.intl 0.0.3 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2007-2010 Dieter Verfaillie <dieterv@optionexplicit.be>.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.7.9.
</div>
</body>
</html>
