modules/luci-base/luasrc/i18n.luadoc

   1 ---[[
   2 LuCI translation library.
   3 ]]
   4 module "luci.i18n"
   5
   6 ---[[
   7 Clear the translation table.
   8
   9
  10 @class function
  11 @name clear
  12 ]]
  13
  14 ---[[
  15 Load a translation and copy its data into the translation table.
  16
  17 @class function
  18 @name load
  19 @param file     Language file
  20 @param lang     Two-letter language code
  21 @param force    Force reload even if already loaded (optional)
  22 @return         Success status
  23 ]]
  24
  25 ---[[
  26 Load a translation file using the default translation language.
  27
  28 Alternatively load the translation of the fallback language.
  29 @class function
  30 @name loadc
  31 @param file     Language file
  32 @param force    Force reload even if already loaded (optional)
  33 ]]
  34
  35 ---[[
  36 Set the context default translation language.
  37
  38 @class function
  39 @name setlanguage
  40 @param lang     An IETF/BCP 47 language tag or ISO3166 country code, e.g. "en-US" or "de"
  41 @return         The effective loaded language, e.g. "en" for "en-US" - or nil on failure
  42 ]]
  43
  44 ---[[
  45 Return the translated value for a specific translation key.
  46
  47 @class function
  48 @name translate
  49 @param key      Default translation text
  50 @return         Translated string
  51 ]]
  52
  53 ---[[
  54 Return the translated value for a specific translation key and use it as sprintf pattern.
  55
  56 @class function
  57 @name translatef
  58 @param key              Default translation text
  59 @param ...              Format parameters
  60 @return                 Translated and formatted string
  61 ]]
  62
  63 ---[[
  64 Return the translated value for a specific translation key
  65
  66 and ensure that the returned value is a Lua string value.
  67 This is the same as calling <code>tostring(translate(...))</code>
  68 @class function
  69 @name string
  70 @param key              Default translation text
  71 @return                 Translated string
  72 ]]
  73
  74 ---[[
  75 Return the translated value for a specific translation key and use it as sprintf pattern.
  76
  77 Ensure that the returned value is a Lua string value.
  78 This is the same as calling <code>tostring(translatef(...))</code>
  79 @class function
  80 @name stringf
  81 @param key              Default translation text
  82 @param ...              Format parameters
  83 @return                 Translated and formatted string
  84 ]]
  85