-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathi18n-module.html
386 lines (349 loc) · 14.4 KB
/
i18n-module.html
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!DOCTYPE html>
<html lang="en">
<head>
<base href=".">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>I18n module</title>
<link rel="stylesheet" href="assets/css/dark-frontend.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/light-frontend.css" type="text/css" title="light">
<link rel="stylesheet" href="assets/css/bootstrap-toc.min.css" type="text/css">
<link rel="stylesheet" href="assets/css/jquery.mCustomScrollbar.min.css">
<link rel="stylesheet" href="assets/js/search/enable_search.css" type="text/css">
<link rel="stylesheet" href="assets/css/notes.css" type="text/css">
<link rel="stylesheet" href="assets/css/prism-tomorrow.css" type="text/css" title="dark">
<link rel="alternate stylesheet" href="assets/css/prism.css" type="text/css" title="light">
<script src="assets/js/mustache.min.js"></script>
<script src="assets/js/jquery.js"></script>
<script src="assets/js/bootstrap.js"></script>
<script src="assets/js/scrollspy.js"></script>
<script src="assets/js/typeahead.jquery.min.js"></script>
<script src="assets/js/search.js"></script>
<script src="assets/js/compare-versions.js"></script>
<script src="assets/js/jquery.mCustomScrollbar.concat.min.js"></script>
<script src="assets/js/bootstrap-toc.min.js"></script>
<script src="assets/js/jquery.touchSwipe.min.js"></script>
<script src="assets/js/anchor.min.js"></script>
<script src="assets/js/tag_filtering.js"></script>
<script src="assets/js/language_switching.js"></script>
<script src="assets/js/styleswitcher.js"></script>
<script src="assets/js/lines_around_headings.js"></script>
<script src="assets/js/prism-core.js"></script>
<script src="assets/js/prism-autoloader.js"></script>
<script src="assets/js/prism_autoloader_path_override.js"></script>
<script src="assets/js/prism-keep-markup.js"></script>
<script src="assets/js/trie.js"></script>
<link rel="icon" type="image/png" href="assets/images/favicon.png">
<link rel="shortcut icon" href="assets/images/favicon.png">
</head>
<body class="no-script
">
<script>
$('body').removeClass('no-script');
</script>
<nav class="navbar navbar-fixed-top navbar-default" id="topnav">
<div class="container-fluid">
<div class="navbar-right">
<a id="toc-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-wrapper" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span title="light mode switch" class="glyphicon glyphicon-sunglasses pull-right" id="lightmode-icon"></span>
<form class="navbar-form pull-right" id="navbar-search-form">
<div class="form-group has-feedback">
<input type="text" class="form-control input-sm" name="search" id="sidenav-lookup-field" placeholder="search" disabled>
<span class="glyphicon glyphicon-search form-control-feedback" id="search-mgn-glass"></span>
</div>
</form>
</div>
<div class="navbar-header">
<a id="sidenav-toggle">
<span class="glyphicon glyphicon-menu-right"></span>
<span class="glyphicon glyphicon-menu-left"></span>
</a>
<a id="home-link" href="index.html" class="hotdoc-navbar-brand">
<img src="assets/images/meson_logo.png" alt="Home">
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-wrapper">
<ul class="nav navbar-nav" id="menu">
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Modules <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="modules-menu">
<li>
<a href="CMake-module.html">CMake</a>
</li>
<li>
<a href="Cuda-module.html">CUDA</a>
</li>
<li>
<a href="Dlang-module.html">Dlang</a>
</li>
<li>
<a href="External-Project-module.html">External Project</a>
</li>
<li>
<a href="Fs-module.html">Filesystem</a>
</li>
<li>
<a href="Gnome-module.html">GNOME</a>
</li>
<li>
<a href="Hotdoc-module.html">Hotdoc</a>
</li>
<li>
<a href="i18n-module.html">i18n</a>
</li>
<li>
<a href="Icestorm-module.html">Icestorm</a>
</li>
<li>
<a href="Java-module.html">Java</a>
</li>
<li>
<a href="Keyval-module.html">Keyval</a>
</li>
<li>
<a href="Pkgconfig-module.html">Pkgconfig</a>
</li>
<li>
<a href="Python-3-module.html">Python 3</a>
</li>
<li>
<a href="Python-module.html">Python</a>
</li>
<li>
<a href="Qt4-module.html">Qt4</a>
</li>
<li>
<a href="Qt5-module.html">Qt5</a>
</li>
<li>
<a href="Qt6-module.html">Qt6</a>
</li>
<li>
<a href="Rust-module.html">Rust</a>
</li>
<li>
<a href="Simd-module.html">Simd</a>
</li>
<li>
<a href="SourceSet-module.html">SourceSet</a>
</li>
<li>
<a href="Wayland-module.html">Wayland</a>
</li>
<li>
<a href="Windows-module.html">Windows</a>
</li>
</ul>
</li>
<li class="dropdown">
<a class="dropdown-toggle" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
Quick References <span class="caret"></span>
</a>
<ul class="dropdown-menu" id="quick-refs-menu">
<li>
<a href="Reference-manual.html">Functions</a>
</li>
<li>
<a href="Build-options.html">Options</a>
</li>
<li>
<a href="Configuration.html">Configuration</a>
</li>
<li>
<a href="Dependencies.html">Dependencies</a>
</li>
<li>
<a href="Unit-tests.html">Tests</a>
</li>
<li>
<a href="Syntax.html">Syntax</a>
</li>
</ul>
</li>
</ul>
<div class="hidden-xs hidden-sm navbar-text navbar-center">
<p><b>The Meson Build System</b></p>
</div>
</div>
</div>
</nav>
<main>
<div data-extension="core" data-hotdoc-in-toplevel="True" data-hotdoc-project="Meson-documentation" data-hotdoc-ref="i18n-module.html" class="page_container" id="page-wrapper">
<script src="assets/js/utils.js"></script>
<div class="panel panel-collapse oc-collapsed" id="sidenav" data-hotdoc-role="navigation">
<script src="assets/js/full-width.js"></script>
<div id="sitenav-wrapper">
<iframe src="hotdoc-sitemap.html" id="sitenav-frame"></iframe>
</div>
</div>
<div id="body">
<div id="main">
<div id="page-description" data-hotdoc-role="main">
<h1 id="i18n-module">I18n module</h1>
<p>This module provides internationalisation and localisation functionality.</p>
<h2 id="usage">Usage</h2>
<p>To use this module, just do: <strong><code>i18n = import('i18n')</code></strong>. The
following functions will then be available as methods on the object
with the name <code>i18n</code>. You can, of course, replace the name <code>i18n</code> with
anything else.</p>
<h3 id="i18ngettext">i18n.gettext()</h3>
<p>Sets up gettext localisation so that translations are built and placed
into their proper locations during install. Takes one positional
argument which is the name of the gettext module.</p>
<ul>
<li>
<code>args</code>: list of extra arguments to pass to <code>xgettext</code> when
generating the pot file</li>
<li>
<code>data_dirs</code>: (<em>Added 0.36.0</em>) list of directories to be set for
<code>GETTEXTDATADIRS</code> env var (Requires gettext 0.19.8+), used for local
its files</li>
<li>
<code>languages</code>: list of languages that are to be generated. As of
0.37.0 this is optional and the
<a href="https://www.gnu.org/software/gettext/manual/html_node/po_002fLINGUAS.html">LINGUAS</a>
file is read.</li>
<li>
<code>preset</code>: (<em>Added 0.37.0</em>) name of a preset list of arguments,
current option is <code>'glib'</code>, see
<a href="https://github.com/mesonbuild/meson/blob/master/mesonbuild/modules/i18n.py">source</a>
for their value</li>
<li>
<code>install</code>: (<em>Added 0.43.0</em>) if false, do not install the built translations.</li>
<li>
<code>install_dir</code>: (<em>Added 0.50.0</em>) override default install location, default is <code>localedir</code>
</li>
</ul>
<p>This function also defines targets for maintainers to use:
<strong>Note</strong>: These output to the source directory</p>
<ul>
<li>
<code><project_id>-pot</code>: runs <code>xgettext</code> to regenerate the pot file</li>
<li>
<code><project_id>-update-po</code>: regenerates the <code>.po</code> files from current <code>.pot</code> file</li>
<li>
<code><project_id>-gmo</code>: builds the translations without installing</li>
</ul>
<p>(<em>since 0.60.0</em>) Returns a list containing:</p>
<ul>
<li>a list of built <code>.mo</code> files</li>
<li>the maintainer <code>-pot</code> target</li>
<li>the maintainer <code>-update-po</code> target</li>
</ul>
<h3 id="i18nmerge_file">i18n.merge_file()</h3>
<p>This merges translations into a text file using <code>msgfmt</code>. See
<a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a>
for normal keywords. In addition it accepts these keywords:</p>
<ul>
<li>
<code>output</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>install_dir</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>install_tag</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>data_dirs</code>: (<em>Added 0.41.0</em>) list of directories for its files (See
also <code>i18n.gettext()</code>)</li>
<li>
<code>po_dir</code>: directory containing translations, relative to current directory</li>
<li>
<code>type</code>: type of file, valid options are <code>'xml'</code> (default) and <code>'desktop'</code>
</li>
<li>
<code>args</code>: (<em>Added 0.51.0</em>) list of extra arguments to pass to <code>msgfmt</code>
</li>
</ul>
<p><em>Added 0.37.0</em></p>
<h3 id="i18nitstool_join">i18n.itstool_join()</h3>
<p>This joins translations into a XML file using <code>itstool</code>. See
<a href="Reference-manual_functions.html#custom_target"><ins><code>custom_target()</code></ins></a>
for normal keywords. In addition it accepts these keywords:</p>
<ul>
<li>
<code>output</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>install_dir</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>install_tag</code>: same as <code>custom_target</code> but only accepts one item</li>
<li>
<code>its_files</code>: filenames of ITS files that should be used explicitly
(XML translation rules are autodetected otherwise).</li>
<li>
<code>mo_targets</code> <em>required</em>: mo file generation targets as returned by <code>i18n.gettext()</code>.</li>
</ul>
<p><em>Added 0.62.0</em></p>
<h3 id="i18nxgettext">i18n.xgettext()</h3>
<pre><code class="language-meson">i18n.xgettext(name, sources..., args: [...], recursive: false)
</code></pre>
<p>Invokes the <code>xgettext</code> program on given sources, to generate a <code>.pot</code> file.
This function is to be used when the <code>gettext</code> function workflow it not suitable
for your project. For example, it can be used to produce separate <code>.pot</code> files
for each executable.</p>
<p>Positional arguments are the following:</p>
<ul>
<li>name <code>str</code>: the name of the resulting pot file.</li>
<li>sources <code>list[str|File|build_tgt|custom_tgt]</code>:
source files or targets. May be a list of <code>string</code>, <code>File</code>, <a href="Reference-manual_returned_build_tgt.html"><ins><code>build_tgt</code></ins></a>,
or <a href="Reference-manual_returned_custom_tgt.html"><ins><code>custom_tgt</code></ins></a> returned from other calls to this function.</li>
</ul>
<p>Keyword arguments are the following:</p>
<ul>
<li>recursive <code>bool</code>:
if <code>true</code>, will merge the resulting pot file with extracted pot files
related to dependencies of the given source targets. For instance,
if you build an executable, then you may want to merge the executable
translations with the translations from the dependent libraries.</li>
<li>install <code>bool</code>: if <code>true</code>, will add the resulting pot file to install targets.</li>
<li>install_tag <code>str</code>: install tag to use for the install target.</li>
<li>install_dir <code>str</code>: directory where to install the resulting pot file.</li>
</ul>
<p>The <code>i18n.xgettext()</code> function returns a <a href="Reference-manual_returned_custom_tgt.html"><ins><code>custom_tgt</code></ins></a>.</p>
<p>Usually, you want to pass one build target as sources, and the list of header files
for that target. If the number of source files would result in a command line that
is too long, the list of source files is written to a file at config time, to be
used as input for the <code>xgettext</code> program.</p>
<p>The <code>recursive: true</code> argument is to be given to targets that will actually read
the resulting <code>.mo</code> file. Each time you call the <code>i18n.xgettext()</code> function,
it maps the source targets to the resulting pot file. When <code>recursive: true</code> is
given, all generated pot files from dependencies of the source targets are
included to generate the final pot file. Therefore, adding a dependency to
source target will automatically add the translations of that dependency to the
needed translations for that source target.</p>
<p><em>Added 1.8.0</em></p>
</div>
</div>
<div id="search_results">
<p>The results of the search are</p>
</div>
<div id="footer">
<hr>
<div class="license-description">
Website licensing information are available on the <a href="legal.html">Legal</a> page.
</div>
</div>
</div>
<div id="toc-column">
<div class="edit-button">
<a href="https://github.com/mesonbuild/meson/edit/master/docs/markdown/i18n-module.md" data-hotdoc-role="edit-button">Edit on GitHub</a>
</div>
<div id="toc-wrapper">
<nav id="toc"></nav>
</div>
</div>
</div>
</main>
<script src="assets/js/navbar_offset_scroller.js"></script>
</body>
</html>