summaryrefslogtreecommitdiffhomepage
path: root/modules/luci-base/luasrc/i18n.luadoc
blob: df6e38e5de38ca8b25afe5c6cff3d13e75b7c14a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
---[[
LuCI translation library.
]]
module "luci.i18n"

---[[
Clear the translation table.

@class function
@name clear
]]

---[[
Load a translation and copy its data into the translation table.

@class function
@name load
@param file	Language file
@param lang	Two-letter language code
@param force	Force reload even if already loaded (optional)
@return		Success status
]]

---[[
Load a translation file using the default translation language.

Alternatively load the translation of the fallback language.

@class function
@name loadc
@param file	Language file
@param force	Force reload even if already loaded (optional)
]]

---[[
Set the context default translation language.

@class function
@name setlanguage
@param lang	An IETF/BCP 47 language tag or ISO3166 country code, e.g. "en-US" or "de"
@return		The effective loaded language, e.g. "en" for "en-US" - or nil on failure
]]

---[[
Return the translated value for a specific translation key.

@class function
@name translate
@param key	Default translation text
@return		Translated string
]]

---[[
Return the translated value for a specific translation key and use it as sprintf pattern.

@class function
@name translatef
@param key		Default translation text
@param ...		Format parameters
@return			Translated and formatted string
]]

---[[
Return the translated value for a specific translation key
and ensure that the returned value is a Lua string value.

This is the same as calling <code>tostring(translate(...))</code>

@class function
@name string
@param key		Default translation text
@return			Translated string
]]

---[[
Return the translated value for a specific translation key and use it as sprintf pattern.

Ensure that the returned value is a Lua string value.

This is the same as calling <code>tostring(translatef(...))</code>

@class function
@name stringf
@param key		Default translation text
@param ...		Format parameters
@return			Translated and formatted string
]]

---[[
Return all currently loaded translation strings as a key-value table. The key is the
hexadecimal representation of the translation key while the value is the translated
text content.

@class function
@name dump
@return			Key-value translation string table.
]]