<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="Up" href="index.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Simple_gettext" rel="Chapter" href="Simple_gettext.html"><link title="Example" rel="Section" href="#0_Example">
<link title="Simple_gettext vs OCamlGettext" rel="Section" href="#0_SimplegettextvsOCamlGettext">
<link title="Functions" rel="Section" href="#0_Functions">
<title>Simple_gettext</title>
</head>
<body>
<div class="navbar"> <a href="index.html">Up</a>
</div>
<center><h1>Module <a href="type_Simple_gettext.html">Simple_gettext</a></h1></center>
<br>
<pre><span class="keyword">module</span> Simple_gettext: <code class="code">sig</code> <a href="Simple_gettext.html">..</a> <code class="code">end</code></pre>Internationalisation of your program / library<br>
<b>Author(s):</b> Pascal (Pixel) Rigaux<br>
<b>Version:</b> 0.1<br>
<b>See also</b><ul><li><a href="ocaml-simple_gettext-0.1.tar.gz">source</a></li>
<li><a href="libsimple-gettext-ocaml_0.1_i386.deb">debian binary (only the shared library)</a></li>
<li><a href="libsimple-gettext-ocaml-dev_0.1_i386.deb">debian binary (everything else)</a></li>
<li><a href="ocaml-simple_gettext-0.1-1mdk.i586.rpm">mandrake rpm</a></li>
</ul>
<hr width="100%">
<br>
<span id="0_Example"><h0>Example</h0></span>
Typical use: <pre><code class="code"> open Simple_gettext
...
Simple_gettext.textdomain "mathplot";
...
print_endline (i18n "Hello %s!" name);
</code></pre>
<p>
Then use <code class="code">xgettext-ocaml -o foo.pot *.ml</code>
<p>
More information: <a href="http://www.gnu.org/manual/gettext-0.11.2/html_chapter/gettext_1.html#SEC6">overview of gettext</a>
<p>
<span id="0_SimplegettextvsOCamlGettext"><h0>Simple_gettext vs OCamlGettext</h0></span>
<p>
Why did you develop yet another gettext binding?
Why not use the existing gettext binding (OCamlGettext)?
<p>
OCamlGettext is:<ul>
<li>hard to build (it needs many tools)</li>
<li>doesn't handle %s in translated strings (very useful in practice)</li>
<li>doesn't have a xgettext (minor pb)</li>
</ul>
<span id="0_Functions"><h0>Functions</h0></span><br>
<pre><span id="VALbindtextdomain"><span class="keyword">val</span> bindtextdomain</span> : <code class="type">string -> string -> unit</code></pre><div class="info">
<code class="code">bindtextdomain domainname dirname</code> tells to use directory <code class="code">dirname</code> to look for translations for <code class="code">domainname</code><br>
</div>
<pre><span id="VALtextdomain"><span class="keyword">val</span> textdomain</span> : <code class="type">string -> unit</code></pre><div class="info">
<code class="code">textdomain domainname</code> sets current domain used by <a href="Simple_gettext.html#VALgettext"><code class="code">Simple_gettext.gettext</code></a><br>
</div>
<pre><span id="VALi18n"><span class="keyword">val</span> i18n</span> : <code class="type">('a, unit, string) Pervasives.format -> 'a</code></pre><div class="info">
<code class="code">i18n msgid args</code> returns the string <code class="code">msgid</code> translated using current domain (set using <a href="Simple_gettext.html#VALtextdomain"><code class="code">Simple_gettext.textdomain</code></a>)<br>
</div>
<pre><span id="VALi18n_"><span class="keyword">val</span> i18n_</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">i18n_ msgid</code> returns the string verbatim. Useful for messages translated later (using <a href="Simple_gettext.html#VALgettext"><code class="code">Simple_gettext.gettext</code></a> or <a href="Simple_gettext.html#VALdgettext"><code class="code">Simple_gettext.dgettext</code></a>) in the program<br>
</div>
<pre><span id="VALgettext"><span class="keyword">val</span> gettext</span> : <code class="type">string -> string</code></pre><div class="info">
<code class="code">gettext msgid</code> returns the string <code class="code">msgid</code> translated using the current domain (set using <a href="Simple_gettext.html#VALtextdomain"><code class="code">Simple_gettext.textdomain</code></a>)<br>
</div>
<pre><span id="VALdgettext"><span class="keyword">val</span> dgettext</span> : <code class="type">string -> string -> string</code></pre><div class="info">
<code class="code">dgettext domainname msgid</code> returns the string <code class="code">msgid</code> translated using <code class="code">domainname</code><br>
</div>
</body></html>
