docs/api/modules/luci.i18n.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   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"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  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" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  55         </li>
  56
  57         <li><strong>luci.i18n</strong></li>
  58
  59         <li>
  60                 <a href="../modules/luci.ip.html">luci.ip</a>
  61         </li>
  62
  63         <li>
  64                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  65         </li>
  66
  67         <li>
  68                 <a href="../modules/luci.json.html">luci.json</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.html">luci.sys</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.util.html">luci.util</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.xml.html">luci.xml</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Class <code>luci.i18n</code></h1>
 200
 201 <p></p>
 202
 203
 204
 205
 206
 207
 208
 209 <h2>Functions</h2>
 210 <table class="function_list">
 211
 212         <tr>
 213         <td class="name" nowrap><a href="#dump">dump</a>&nbsp;()</td>
 214         <td class="summary">
 215
 216 Return all currently loaded translation strings as a key-value table.</td>
 217         </tr>
 218
 219         <tr>
 220         <td class="name" nowrap><a href="#setlanguage">setlanguage</a>&nbsp;(lang)</td>
 221         <td class="summary">
 222
 223 Set the context default translation language.</td>
 224         </tr>
 225
 226         <tr>
 227         <td class="name" nowrap><a href="#translate">translate</a>&nbsp;(key)</td>
 228         <td class="summary">
 229
 230 Return the translated value for a specific translation key.</td>
 231         </tr>
 232
 233         <tr>
 234         <td class="name" nowrap><a href="#translatef">translatef</a>&nbsp;(key, ...)</td>
 235         <td class="summary">
 236
 237 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 238         </tr>
 239
 240 </table>
 241
 242
 243
 244
 245
 246
 247 <br/>
 248 <br/>
 249
 250
 251 <h2><a name="functions"></a>Functions</h2>
 252 <dl class="function">
 253
 254
 255
 256 <dt><a name="dump"></a><strong>dump</strong>&nbsp;()</dt>
 257 <dd>
 258
 259
 260 Return all currently loaded translation strings as a key-value table. The key is the
 261 hexadecimal representation of the translation key while the value is the translated
 262 text content.
 263
 264
 265
 266
 267
 268
 269
 270
 271 <h3>Return value:</h3>
 272 Key-value translation string table.
 273
 274
 275
 276 </dd>
 277
 278
 279
 280
 281 <dt><a name="setlanguage"></a><strong>setlanguage</strong>&nbsp;(lang)</dt>
 282 <dd>
 283
 284
 285 Set the context default translation language.
 286
 287
 288
 289 <h3>Parameters</h3>
 290 <ul>
 291
 292         <li>
 293           lang: An IETF/BCP 47 language tag or ISO3166 country code, e.g. "en-US" or "de"
 294         </li>
 295
 296 </ul>
 297
 298
 299
 300
 301
 302
 303 <h3>Return value:</h3>
 304 The effective loaded language, e.g. "en" for "en-US" - or nil on failure
 305
 306
 307
 308 </dd>
 309
 310
 311
 312
 313 <dt><a name="translate"></a><strong>translate</strong>&nbsp;(key)</dt>
 314 <dd>
 315
 316
 317 Return the translated value for a specific translation key.
 318
 319
 320
 321 <h3>Parameters</h3>
 322 <ul>
 323
 324         <li>
 325           key: Default translation text
 326         </li>
 327
 328 </ul>
 329
 330
 331
 332
 333
 334
 335 <h3>Return value:</h3>
 336 Translated string
 337
 338
 339
 340 </dd>
 341
 342
 343
 344
 345 <dt><a name="translatef"></a><strong>translatef</strong>&nbsp;(key, ...)</dt>
 346 <dd>
 347
 348
 349 Return the translated value for a specific translation key and use it as sprintf pattern.
 350
 351
 352
 353 <h3>Parameters</h3>
 354 <ul>
 355
 356         <li>
 357           key: Default translation text
 358         </li>
 359
 360         <li>
 361           ...: Format parameters
 362         </li>
 363
 364 </ul>
 365
 366
 367
 368
 369
 370
 371 <h3>Return value:</h3>
 372 Translated and formatted string
 373
 374
 375
 376 </dd>
 377
 378
 379 </dl>
 380
 381
 382
 383
 384
 385 </div> <!-- id="content" -->
 386
 387 </div> <!-- id="main" -->
 388
 389 <div id="about">
 390         <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>
 391 </div> <!-- id="about" -->
 392
 393 </div> <!-- id="container" -->
 394 </body>
 395 </html>