documentation/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.protocol.html">luci.http.protocol</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  59         </li>
  60
  61         <li><strong>luci.i18n</strong></li>
  62
  63         <li>
  64                 <a href="../modules/luci.ip.html">luci.ip</a>
  65         </li>
  66
  67         <li>
  68                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.json.html">luci.json</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/luci.sys.html">luci.sys</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.util.html">luci.util</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="#clear">clear</a>&nbsp;()</td>
 214         <td class="summary">
 215
 216 Clear the translation table.</td>
 217         </tr>
 218
 219         <tr>
 220         <td class="name" nowrap><a href="#load">load</a>&nbsp;(file, lang, force)</td>
 221         <td class="summary">
 222
 223 Load a translation and copy its data into the translation table.</td>
 224         </tr>
 225
 226         <tr>
 227         <td class="name" nowrap><a href="#loadc">loadc</a>&nbsp;(file, force)</td>
 228         <td class="summary">
 229
 230 Load a translation file using the default translation language.</td>
 231         </tr>
 232
 233         <tr>
 234         <td class="name" nowrap><a href="#setlanguage">setlanguage</a>&nbsp;(lang)</td>
 235         <td class="summary">
 236
 237 Set the context default translation language.</td>
 238         </tr>
 239
 240         <tr>
 241         <td class="name" nowrap><a href="#string">string</a>&nbsp;(key)</td>
 242         <td class="summary">
 243
 244 Return the translated value for a specific translation key
 245
 246 and ensure that the returned value is a Lua string value.</td>
 247         </tr>
 248
 249         <tr>
 250         <td class="name" nowrap><a href="#stringf">stringf</a>&nbsp;(key, ...)</td>
 251         <td class="summary">
 252
 253 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 254         </tr>
 255
 256         <tr>
 257         <td class="name" nowrap><a href="#translate">translate</a>&nbsp;(key)</td>
 258         <td class="summary">
 259
 260 Return the translated value for a specific translation key.</td>
 261         </tr>
 262
 263         <tr>
 264         <td class="name" nowrap><a href="#translatef">translatef</a>&nbsp;(key, ...)</td>
 265         <td class="summary">
 266
 267 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 268         </tr>
 269
 270 </table>
 271
 272
 273
 274
 275
 276
 277 <br/>
 278 <br/>
 279
 280
 281 <h2><a name="functions"></a>Functions</h2>
 282 <dl class="function">
 283
 284
 285
 286 <dt><a name="clear"></a><strong>clear</strong>&nbsp;()</dt>
 287 <dd>
 288
 289
 290 Clear the translation table.
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302 </dd>
 303
 304
 305
 306
 307 <dt><a name="load"></a><strong>load</strong>&nbsp;(file, lang, force)</dt>
 308 <dd>
 309
 310
 311 Load a translation and copy its data into the translation table.
 312
 313
 314
 315 <h3>Parameters</h3>
 316 <ul>
 317
 318         <li>
 319           file: Language file
 320         </li>
 321
 322         <li>
 323           lang: Two-letter language code
 324         </li>
 325
 326         <li>
 327           force: Force reload even if already loaded (optional)
 328         </li>
 329
 330 </ul>
 331
 332
 333
 334
 335
 336
 337 <h3>Return value:</h3>
 338 Success status
 339
 340
 341
 342 </dd>
 343
 344
 345
 346
 347 <dt><a name="loadc"></a><strong>loadc</strong>&nbsp;(file, force)</dt>
 348 <dd>
 349
 350
 351 Load a translation file using the default translation language.
 352
 353 Alternatively load the translation of the fallback language.
 354
 355
 356 <h3>Parameters</h3>
 357 <ul>
 358
 359         <li>
 360           file: Language file
 361         </li>
 362
 363         <li>
 364           force: Force reload even if already loaded (optional)
 365         </li>
 366
 367 </ul>
 368
 369
 370
 371
 372
 373
 374
 375
 376 </dd>
 377
 378
 379
 380
 381 <dt><a name="setlanguage"></a><strong>setlanguage</strong>&nbsp;(lang)</dt>
 382 <dd>
 383
 384
 385 Set the context default translation language.
 386
 387
 388
 389 <h3>Parameters</h3>
 390 <ul>
 391
 392         <li>
 393           lang: Two-letter language code
 394         </li>
 395
 396 </ul>
 397
 398
 399
 400
 401
 402
 403
 404
 405 </dd>
 406
 407
 408
 409
 410 <dt><a name="string"></a><strong>string</strong>&nbsp;(key)</dt>
 411 <dd>
 412
 413
 414 Return the translated value for a specific translation key
 415
 416 and ensure that the returned value is a Lua string value.
 417 This is the same as calling <code>tostring(translate(...))</code>
 418
 419
 420 <h3>Parameters</h3>
 421 <ul>
 422
 423         <li>
 424           key: Default translation text
 425         </li>
 426
 427 </ul>
 428
 429
 430
 431
 432
 433
 434 <h3>Return value:</h3>
 435 Translated string
 436
 437
 438
 439 </dd>
 440
 441
 442
 443
 444 <dt><a name="stringf"></a><strong>stringf</strong>&nbsp;(key, ...)</dt>
 445 <dd>
 446
 447
 448 Return the translated value for a specific translation key and use it as sprintf pattern.
 449
 450 Ensure that the returned value is a Lua string value.
 451 This is the same as calling <code>tostring(translatef(...))</code>
 452
 453
 454 <h3>Parameters</h3>
 455 <ul>
 456
 457         <li>
 458           key: Default translation text
 459         </li>
 460
 461         <li>
 462           ...: Format parameters
 463         </li>
 464
 465 </ul>
 466
 467
 468
 469
 470
 471
 472 <h3>Return value:</h3>
 473 Translated and formatted string
 474
 475
 476
 477 </dd>
 478
 479
 480
 481
 482 <dt><a name="translate"></a><strong>translate</strong>&nbsp;(key)</dt>
 483 <dd>
 484
 485
 486 Return the translated value for a specific translation key.
 487
 488
 489
 490 <h3>Parameters</h3>
 491 <ul>
 492
 493         <li>
 494           key: Default translation text
 495         </li>
 496
 497 </ul>
 498
 499
 500
 501
 502
 503
 504 <h3>Return value:</h3>
 505 Translated string
 506
 507
 508
 509 </dd>
 510
 511
 512
 513
 514 <dt><a name="translatef"></a><strong>translatef</strong>&nbsp;(key, ...)</dt>
 515 <dd>
 516
 517
 518 Return the translated value for a specific translation key and use it as sprintf pattern.
 519
 520
 521
 522 <h3>Parameters</h3>
 523 <ul>
 524
 525         <li>
 526           key: Default translation text
 527         </li>
 528
 529         <li>
 530           ...: Format parameters
 531         </li>
 532
 533 </ul>
 534
 535
 536
 537
 538
 539
 540 <h3>Return value:</h3>
 541 Translated and formatted string
 542
 543
 544
 545 </dd>
 546
 547
 548 </dl>
 549
 550
 551
 552
 553
 554 </div> <!-- id="content" -->
 555
 556 </div> <!-- id="main" -->
 557
 558 <div id="about">
 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" -->
 561
 562 </div> <!-- id="container" -->
 563 </body>
 564 </html>