1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
5 <title>Reference</title>
6 <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7 <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17 </div> <!-- id="product" -->
27 <li><a href="../index.html">Index</a></li>
38 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
42 <a href="../modules/luci.http.html">luci.http</a>
46 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
50 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
54 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
58 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
61 <li><strong>luci.i18n</strong></li>
64 <a href="../modules/luci.ip.html">luci.ip</a>
68 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
72 <a href="../modules/luci.json.html">luci.json</a>
76 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
80 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
84 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
88 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
92 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
96 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
100 <a href="../modules/luci.sys.html">luci.sys</a>
104 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
108 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
112 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
116 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
120 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
124 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
128 <a href="../modules/luci.util.html">luci.util</a>
132 <a href="../modules/nixio.html">nixio</a>
136 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
140 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
144 <a href="../modules/nixio.File.html">nixio.File</a>
148 <a href="../modules/nixio.README.html">nixio.README</a>
152 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
156 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
160 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
164 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
168 <a href="../modules/nixio.bin.html">nixio.bin</a>
172 <a href="../modules/nixio.bit.html">nixio.bit</a>
176 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
180 <a href="../modules/nixio.fs.html">nixio.fs</a>
195 </div><!-- id="navigation" -->
199 <h1>Class <code>luci.i18n</code></h1>
210 <table class="function_list">
213 <td class="name" nowrap><a href="#clear">clear</a> ()</td>
216 Clear the translation table.</td>
220 <td class="name" nowrap><a href="#load">load</a> (file, lang, force)</td>
223 Load a translation and copy its data into the translation table.</td>
227 <td class="name" nowrap><a href="#loadc">loadc</a> (file, force)</td>
230 Load a translation file using the default translation language.</td>
234 <td class="name" nowrap><a href="#setlanguage">setlanguage</a> (lang)</td>
237 Set the context default translation language.</td>
241 <td class="name" nowrap><a href="#string">string</a> (key)</td>
244 Return the translated value for a specific translation key
246 and ensure that the returned value is a Lua string value.</td>
250 <td class="name" nowrap><a href="#stringf">stringf</a> (key, ...)</td>
253 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
257 <td class="name" nowrap><a href="#translate">translate</a> (key)</td>
260 Return the translated value for a specific translation key.</td>
264 <td class="name" nowrap><a href="#translatef">translatef</a> (key, ...)</td>
267 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
281 <h2><a name="functions"></a>Functions</h2>
282 <dl class="function">
286 <dt><a name="clear"></a><strong>clear</strong> ()</dt>
290 Clear the translation table.
307 <dt><a name="load"></a><strong>load</strong> (file, lang, force)</dt>
311 Load a translation and copy its data into the translation table.
323 lang: Two-letter language code
327 force: Force reload even if already loaded (optional)
337 <h3>Return value:</h3>
347 <dt><a name="loadc"></a><strong>loadc</strong> (file, force)</dt>
351 Load a translation file using the default translation language.
353 Alternatively load the translation of the fallback language.
364 force: Force reload even if already loaded (optional)
381 <dt><a name="setlanguage"></a><strong>setlanguage</strong> (lang)</dt>
385 Set the context default translation language.
393 lang: Two-letter language code
410 <dt><a name="string"></a><strong>string</strong> (key)</dt>
414 Return the translated value for a specific translation key
416 and ensure that the returned value is a Lua string value.
417 This is the same as calling <code>tostring(translate(...))</code>
424 key: Default translation text
434 <h3>Return value:</h3>
444 <dt><a name="stringf"></a><strong>stringf</strong> (key, ...)</dt>
448 Return the translated value for a specific translation key and use it as sprintf pattern.
450 Ensure that the returned value is a Lua string value.
451 This is the same as calling <code>tostring(translatef(...))</code>
458 key: Default translation text
462 ...: Format parameters
472 <h3>Return value:</h3>
473 Translated and formatted string
482 <dt><a name="translate"></a><strong>translate</strong> (key)</dt>
486 Return the translated value for a specific translation key.
494 key: Default translation text
504 <h3>Return value:</h3>
514 <dt><a name="translatef"></a><strong>translatef</strong> (key, ...)</dt>
518 Return the translated value for a specific translation key and use it as sprintf pattern.
526 key: Default translation text
530 ...: Format parameters
540 <h3>Return value:</h3>
541 Translated and formatted string
554 </div> <!-- id="content" -->
556 </div> <!-- id="main" -->
559 <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
560 </div> <!-- id="about" -->
562 </div> <!-- id="container" -->