doc/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.protocol.html">luci.http.protocol</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.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.jsonc.html">luci.jsonc</a>
  69         </li>
  70
  71         <li>
  72                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/nixio.html">nixio</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/nixio.File.html">nixio.File</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/nixio.README.html">nixio.README</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 149         </li>
 150
 151 </ul>
 152
 153
 154
 155 <!-- File list -->
 156
 157
 158
 159
 160
 161
 162
 163 </div><!-- id="navigation" -->
 164
 165 <div id="content">
 166
 167 <h1>Class <code>luci.i18n</code></h1>
 168
 169 <p></p>
 170
 171
 172
 173
 174
 175
 176
 177 <h2>Functions</h2>
 178 <table class="function_list">
 179
 180         <tr>
 181         <td class="name" nowrap><a href="#clear">clear</a>&nbsp;()</td>
 182         <td class="summary">
 183
 184 Clear the translation table.</td>
 185         </tr>
 186
 187         <tr>
 188         <td class="name" nowrap><a href="#load">load</a>&nbsp;(file, lang, force)</td>
 189         <td class="summary">
 190
 191 Load a translation and copy its data into the translation table.</td>
 192         </tr>
 193
 194         <tr>
 195         <td class="name" nowrap><a href="#loadc">loadc</a>&nbsp;(file, force)</td>
 196         <td class="summary">
 197
 198 Load a translation file using the default translation language.</td>
 199         </tr>
 200
 201         <tr>
 202         <td class="name" nowrap><a href="#setlanguage">setlanguage</a>&nbsp;(lang)</td>
 203         <td class="summary">
 204
 205 Set the context default translation language.</td>
 206         </tr>
 207
 208         <tr>
 209         <td class="name" nowrap><a href="#string">string</a>&nbsp;(key)</td>
 210         <td class="summary">
 211
 212 Return the translated value for a specific translation key
 213
 214 and ensure that the returned value is a Lua string value.</td>
 215         </tr>
 216
 217         <tr>
 218         <td class="name" nowrap><a href="#stringf">stringf</a>&nbsp;(key, ...)</td>
 219         <td class="summary">
 220
 221 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 222         </tr>
 223
 224         <tr>
 225         <td class="name" nowrap><a href="#translate">translate</a>&nbsp;(key)</td>
 226         <td class="summary">
 227
 228 Return the translated value for a specific translation key.</td>
 229         </tr>
 230
 231         <tr>
 232         <td class="name" nowrap><a href="#translatef">translatef</a>&nbsp;(key, ...)</td>
 233         <td class="summary">
 234
 235 Return the translated value for a specific translation key and use it as sprintf pattern.</td>
 236         </tr>
 237
 238 </table>
 239
 240
 241
 242
 243
 244
 245 <br/>
 246 <br/>
 247
 248
 249 <h2><a name="functions"></a>Functions</h2>
 250 <dl class="function">
 251
 252
 253
 254 <dt><a name="clear"></a><strong>clear</strong>&nbsp;()</dt>
 255 <dd>
 256
 257
 258 Clear the translation table.
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270 </dd>
 271
 272
 273
 274
 275 <dt><a name="load"></a><strong>load</strong>&nbsp;(file, lang, force)</dt>
 276 <dd>
 277
 278
 279 Load a translation and copy its data into the translation table.
 280
 281
 282
 283 <h3>Parameters</h3>
 284 <ul>
 285
 286         <li>
 287           file: Language file
 288         </li>
 289
 290         <li>
 291           lang: Two-letter language code
 292         </li>
 293
 294         <li>
 295           force: Force reload even if already loaded (optional)
 296         </li>
 297
 298 </ul>
 299
 300
 301
 302
 303
 304
 305 <h3>Return value:</h3>
 306 Success status
 307
 308
 309
 310 </dd>
 311
 312
 313
 314
 315 <dt><a name="loadc"></a><strong>loadc</strong>&nbsp;(file, force)</dt>
 316 <dd>
 317
 318
 319 Load a translation file using the default translation language.
 320
 321 Alternatively load the translation of the fallback language.
 322
 323
 324 <h3>Parameters</h3>
 325 <ul>
 326
 327         <li>
 328           file: Language file
 329         </li>
 330
 331         <li>
 332           force: Force reload even if already loaded (optional)
 333         </li>
 334
 335 </ul>
 336
 337
 338
 339
 340
 341
 342
 343
 344 </dd>
 345
 346
 347
 348
 349 <dt><a name="setlanguage"></a><strong>setlanguage</strong>&nbsp;(lang)</dt>
 350 <dd>
 351
 352
 353 Set the context default translation language.
 354
 355
 356
 357 <h3>Parameters</h3>
 358 <ul>
 359
 360         <li>
 361           lang: Two-letter language code
 362         </li>
 363
 364 </ul>
 365
 366
 367
 368
 369
 370
 371
 372
 373 </dd>
 374
 375
 376
 377
 378 <dt><a name="string"></a><strong>string</strong>&nbsp;(key)</dt>
 379 <dd>
 380
 381
 382 Return the translated value for a specific translation key
 383
 384 and ensure that the returned value is a Lua string value.
 385 This is the same as calling <code>tostring(translate(...))</code>
 386
 387
 388 <h3>Parameters</h3>
 389 <ul>
 390
 391         <li>
 392           key: Default translation text
 393         </li>
 394
 395 </ul>
 396
 397
 398
 399
 400
 401
 402 <h3>Return value:</h3>
 403 Translated string
 404
 405
 406
 407 </dd>
 408
 409
 410
 411
 412 <dt><a name="stringf"></a><strong>stringf</strong>&nbsp;(key, ...)</dt>
 413 <dd>
 414
 415
 416 Return the translated value for a specific translation key and use it as sprintf pattern.
 417
 418 Ensure that the returned value is a Lua string value.
 419 This is the same as calling <code>tostring(translatef(...))</code>
 420
 421
 422 <h3>Parameters</h3>
 423 <ul>
 424
 425         <li>
 426           key: Default translation text
 427         </li>
 428
 429         <li>
 430           ...: Format parameters
 431         </li>
 432
 433 </ul>
 434
 435
 436
 437
 438
 439
 440 <h3>Return value:</h3>
 441 Translated and formatted string
 442
 443
 444
 445 </dd>
 446
 447
 448
 449
 450 <dt><a name="translate"></a><strong>translate</strong>&nbsp;(key)</dt>
 451 <dd>
 452
 453
 454 Return the translated value for a specific translation key.
 455
 456
 457
 458 <h3>Parameters</h3>
 459 <ul>
 460
 461         <li>
 462           key: Default translation text
 463         </li>
 464
 465 </ul>
 466
 467
 468
 469
 470
 471
 472 <h3>Return value:</h3>
 473 Translated string
 474
 475
 476
 477 </dd>
 478
 479
 480
 481
 482 <dt><a name="translatef"></a><strong>translatef</strong>&nbsp;(key, ...)</dt>
 483 <dd>
 484
 485
 486 Return the translated value for a specific translation key and use it as sprintf pattern.
 487
 488
 489
 490 <h3>Parameters</h3>
 491 <ul>
 492
 493         <li>
 494           key: Default translation text
 495         </li>
 496
 497         <li>
 498           ...: Format parameters
 499         </li>
 500
 501 </ul>
 502
 503
 504
 505
 506
 507
 508 <h3>Return value:</h3>
 509 Translated and formatted string
 510
 511
 512
 513 </dd>
 514
 515
 516 </dl>
 517
 518
 519
 520
 521
 522 </div> <!-- id="content" -->
 523
 524 </div> <!-- id="main" -->
 525
 526 <div id="about">
 527         <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>
 528 </div> <!-- id="about" -->
 529
 530 </div> <!-- id="container" -->
 531 </body>
 532 </html>