-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
366 lines (213 loc) · 9.99 KB
/
documentation.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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>CL-GETTEXT - A Common Lisp binding to GNU Gettext.</title>
<style type="text/css">
pre { padding:5px; background-color:#e0e0e0 }
h3, h4 { text-decoration: underline; }
a { text-decoration: none; padding: 1px 2px 1px 2px; }
a:visited { text-decoration: none; padding: 1px 2px 1px 2px; }
a:hover { text-decoration: none; padding: 1px 1px 1px 1px; border: 1px solid #000000; }
a:focus { text-decoration: none; padding: 1px 2px 1px 2px; border: none; }
a.none { text-decoration: none; padding: 0; }
a.none:visited { text-decoration: none; padding: 0; }
a.none:hover { text-decoration: none; border: none; padding: 0; }
a.none:focus { text-decoration: none; border: none; padding: 0; }
a.noborder { text-decoration: none; padding: 0; }
a.noborder:visited { text-decoration: none; padding: 0; }
a.noborder:hover { text-decoration: none; border: none; padding: 0; }
a.noborder:focus { text-decoration: none; border: none; padding: 0; }
pre.none { padding:5px; background-color:#ffffff }
</style>
</head>
<body bgcolor=white>
<h2> CL-GETTEXT - A Common Lisp binding to GNU Gettext.</h2>
<blockquote>
<br> <br><h3><a name=abstract class=none>Abstract</a></h3>
The code is licenced under the LLGPL
<p>
<font color=red>Download shortcut:</font> <a href="http://github.com/krzysz00/cl-gettext">http://github.com/krzysz00/cl-gettext</a>.
</blockquote>
<br> <br><h3><a class=none name="contents">Contents</a></h3>
<ol>
<li><a href="#download">Download</a>
<li><a href="#dictionary">The CL-GETTEXT dictionary</a>
<ol>
<li><a href="#bind-textdomain-codeset"><code>bind-textdomain-codeset</code></a>
<li><a href="#bindtextdomain"><code>bindtextdomain</code></a>
<li><a href="#gettext"><code>gettext</code></a>
<li><a href="#init-gettext"><code>init-gettext</code></a>
<li><a href="#lc-address"><code>lc-address</code></a>
<li><a href="#lc-all"><code>lc-all</code></a>
<li><a href="#lc-collate"><code>lc-collate</code></a>
<li><a href="#lc-ctype"><code>lc-ctype</code></a>
<li><a href="#lc-identification"><code>lc-identification</code></a>
<li><a href="#lc-measurement"><code>lc-measurement</code></a>
<li><a href="#lc-messages"><code>lc-messages</code></a>
<li><a href="#lc-monetary"><code>lc-monetary</code></a>
<li><a href="#lc-name"><code>lc-name</code></a>
<li><a href="#lc-numeric"><code>lc-numeric</code></a>
<li><a href="#lc-paper"><code>lc-paper</code></a>
<li><a href="#lc-telephone"><code>lc-telephone</code></a>
<li><a href="#lc-time"><code>lc-time</code></a>
<li><a href="#localeconv"><code>localeconv</code></a>
<li><a href="#ngettext"><code>ngettext</code></a>
<li><a href="#setlocale"><code>setlocale</code></a>
<li><a href="#textdomain"><code>textdomain</code></a>
<li><a href="#_"><code>_</code></a>
<li><a href="#_noop"><code>_noop</code></a>
</ol>
<li><a href="#ack">Acknowledgements</a>
</ol>
<br> <br><h3><a class=none name="download">Download</a></h3>
CL-GETTEXT together with this documentation can be downloaded from <a
href="http://github.com/krzysz00/cl-gettext">http://github.com/krzysz00/cl-gettext</a>. The
current version is 0.1.
<br> <br><h3><a class=none name="dictionary">The CL-GETTEXT dictionary</a></h3>
<!-- Entry for BIND-TEXTDOMAIN-CODESET -->
<p><br>[Function]<br><a class=none name='bind-textdomain-codeset'><b>bind-textdomain-codeset</b> <i>__domainname __codeset</i> => <i>result</i></a>
<blockquote><br>
Set the encoding for the strings stored in `__domain'. You normally don't need to call this, as the locale contains this information a;ready.
</blockquote>
<!-- End of entry for BIND-TEXTDOMAIN-CODESET -->
<!-- Entry for BINDTEXTDOMAIN -->
<p><br>[Function]<br><a class=none name='bindtextdomain'><b>bindtextdomain</b> <i>__domainname __dirname</i> => <i>result</i></a>
<blockquote><br>
Specify what directory the `textdomain' resides under. On Linux systems, this is usually "/usr/share/locale".
</blockquote>
<!-- End of entry for BINDTEXTDOMAIN -->
<!-- Entry for GETTEXT -->
<p><br>[Function]<br><a class=none name='gettext'><b>gettext</b> <i>__msgid</i> => <i>result</i></a>
<blockquote><br>
Get the translation (if any) of `__msgid', which is a string
</blockquote>
<!-- End of entry for GETTEXT -->
<!-- Entry for INIT-GETTEXT -->
<p><br>[Function]<br><a class=none name='init-gettext'><b>init-gettext</b> <i>textdomain directory <tt>&optional</tt> locales</i> => <i>result</i></a>
<blockquote><br>
Wrapper for the series of calls needed to initialize gettext. `textdomain' holds the $foo part of $foo.mo . `directory' is where the .mo files will be stores. `locales' is a list of locale categories to initialize with `setlocale' if `lc-all' doesn't work for you.
</blockquote>
<!-- End of entry for INIT-GETTEXT -->
<!-- Entry for LC-ADDRESS -->
<p><br>[Constant]<br><a class=none name='lc-address'><b>lc-address</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-ADDRESS -->
<!-- Entry for LC-ALL -->
<p><br>[Constant]<br><a class=none name='lc-all'><b>lc-all</b></a>
<blockquote><br>
A locale category. This category is the one which is most often used (and the default when initializing `cl-gettext')
</blockquote>
<!-- End of entry for LC-ALL -->
<!-- Entry for LC-COLLATE -->
<p><br>[Constant]<br><a class=none name='lc-collate'><b>lc-collate</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-COLLATE -->
<!-- Entry for LC-CTYPE -->
<p><br>[Constant]<br><a class=none name='lc-ctype'><b>lc-ctype</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-CTYPE -->
<!-- Entry for LC-IDENTIFICATION -->
<p><br>[Constant]<br><a class=none name='lc-identification'><b>lc-identification</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-IDENTIFICATION -->
<!-- Entry for LC-MEASUREMENT -->
<p><br>[Constant]<br><a class=none name='lc-measurement'><b>lc-measurement</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-MEASUREMENT -->
<!-- Entry for LC-MESSAGES -->
<p><br>[Constant]<br><a class=none name='lc-messages'><b>lc-messages</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-MESSAGES -->
<!-- Entry for LC-MONETARY -->
<p><br>[Constant]<br><a class=none name='lc-monetary'><b>lc-monetary</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-MONETARY -->
<!-- Entry for LC-NAME -->
<p><br>[Constant]<br><a class=none name='lc-name'><b>lc-name</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-NAME -->
<!-- Entry for LC-NUMERIC -->
<p><br>[Constant]<br><a class=none name='lc-numeric'><b>lc-numeric</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-NUMERIC -->
<!-- Entry for LC-PAPER -->
<p><br>[Constant]<br><a class=none name='lc-paper'><b>lc-paper</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-PAPER -->
<!-- Entry for LC-TELEPHONE -->
<p><br>[Constant]<br><a class=none name='lc-telephone'><b>lc-telephone</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-TELEPHONE -->
<!-- Entry for LC-TIME -->
<p><br>[Constant]<br><a class=none name='lc-time'><b>lc-time</b></a>
<blockquote><br>
A locale category.
</blockquote>
<!-- End of entry for LC-TIME -->
<!-- Entry for LOCALECONV -->
<p><br>[Function]<br><a class=none name='localeconv'><b>localeconv</b> <i></i> => <i>result</i></a>
<blockquote><br>
Returns an `lconv' structure with the information applicable for the current locale.
</blockquote>
<!-- End of entry for LOCALECONV -->
<!-- Entry for NGETTEXT -->
<p><br>[Function]<br><a class=none name='ngettext'><b>ngettext</b> <i>__msgid1 __msgid2 __n</i> => <i>result</i></a>
<blockquote><br>
The plural version of `gettext' The first string should be the return value for n == 1, and the second string the value for n != 1. The third argument is n. Use this instead of an `if' because other languages have more or less than two branches for plurals, and this function allows translators to specify the plurals for their language.
</blockquote>
<!-- End of entry for NGETTEXT -->
<!-- Entry for SETLOCALE -->
<p><br>[Function]<br><a class=none name='setlocale'><b>setlocale</b> <i>__category __locale</i> => <i>result</i></a>
<blockquote><br>
Set a locale category to the locale given in `__locale'. If __locale is "", the current system setting will be used.
</blockquote>
<!-- End of entry for SETLOCALE -->
<!-- Entry for TEXTDOMAIN -->
<p><br>[Function]<br><a class=none name='textdomain'><b>textdomain</b> <i>__domainname</i> => <i>result</i></a>
<blockquote><br>
Set the textdomain for the application. The textdomain is the name (before the dot) of your project's .mo files
</blockquote>
<!-- End of entry for TEXTDOMAIN -->
<!-- Entry for _ -->
<p><br>[Macro]<br><a class=none name='_'><b>_</b> <i>string</i> => <i>result</i></a>
<blockquote><br>
Shorthand for `(gettext string)'
</blockquote>
<!-- End of entry for _ -->
<!-- Entry for _NOOP -->
<p><br>[Macro]<br><a class=none name='_noop'><b>_noop</b> <i>string</i> => <i>result</i></a>
<blockquote><br>
A noop macro to mark translatable strings in places where the call to `gettext' would be evaluated too early. See the C documentation for details on this.
</blockquote>
<!-- End of entry for _NOOP -->
<br> <br><h3><a class=none name="ack">Acknowledgements</a></h3>
<p>
This documentation was prepared with <a href="http://weitz.de/documentation-template/">DOCUMENTATION-TEMPLATE</a>.
</p>
<p>
<p><a href="http://github.com/krzysz00/cl-gettext">BACK TO REPOSITORY</a>
</body>
</html>