1SERVICES.XML(5) services.xml Manual SERVICES.XML(5)
2
6 services.xml - libtranslate generic service definitions
7
9 The services.xml file contains translation service definitions for the
10 libtranslate generic module.
11 The generic module provides an abstract framework for supporting
14 web-based translation services.
15 When the generic module is initialized, it reads service definitions
18 from the services.xml files located in /usr/share/libtranslate and
19 ~/.libtranslate, creates the services defined in these files, and makes
20 them available to libtranslate.
21 The services.xml file must be encoded in UTF-8, and conform to the ser‐
24 vices.xml Document Type Definition, located in /usr/share/libtrans‐
25 late/services.dtd.
26
29 services
30 Description
31 The services element is the root of the document, and may con‐
32 tains service definitions and language mappings.
33 Children
36 These elements may occur zero or more times in services: cus‐
37 tom-language, service.
38 custom-language
41 Description
42 The custom-language element maps a RFC 3066 language tag to a
43 language name.
44 Note
47 Some RFC 3066 tag to name mappings are built into libtranslate
49 and do not need to be added (see the Built-In RFC 3066 Tag to
50 Name Mappings appendix in the libtranslate Reference Manual).
51 Attributes
55 tag (required)
59 The RFC 3066 language tag.
60 name (required)
63 The language human-readable name.
64 Parents
67 This element contains custom-language: services.
68 service
71 Description
72 The service element defines a translation service.
73 Attributes
76 name (required)
80 The service symbolic name, encoded in ASCII.
81 nick (implied, default: name)
84 The service human-readable name.
85 max-chunk-len (optional, default: 1000)
88 The maximum length of an input chunk, in characters (0
89 means unlimited).
90 Parents
93 This element contains service: services.
94 Children
97 This element may occur zero or more times in service: group.
98 group
101 Description
102 The group element defines a translation group (a group repre‐
103 sents a set of languages and translation methods).
104 Parents
107 This element contains group: service.
108 Children
111 These elements may occur zero or more times in group: language,
112 http-header.
113 These elements may occur zero or one time in group: text-trans‐
115 lation, web-page-translation.
116 language
119 Description
120 The language element adds a language to the list of languages
121 supported by a group.
122 Attributes
125 tag (required)
129 The RFC 3066 language tag.
130 service-tag (implied, default: tag)
133 The language service-specific tag. This tag is not
134 exposed to libtranslate, but is available as from and to
135 variables (see Variable Substitution).
136 to (optional, default: none)
139 A comma-separated list of RFC 3066 language tags this
140 language can be translated into. The special list element
141 * means "every language of this group but this one".
142 Parents
145 This element contains language: group.
146 http-header
149 Description
150 The http-header element adds a HTTP header to the list of head‐
151 ers that are set when a HTTP request is issued.
152 If the http-header element occurs inside a group element, the
154 header is added for text and web page translations.
155 If it occurs inside a text-translation or web-page-translation
157 element, the header is only added for a text or web page trans‐
158 lation, respectively.
159 Attributes
162 name (required)
166 The HTTP header name.
167 value (required)
170 The HTTP header value.
171 Parents
174 These elements contain http-header: group, text-translation,
175 web-page-translation.
176 text-translation
179 Description
180 The presence of the text-translation element specifies that the
181 group can translate text.
182 Attributes
185 url (required)
189 The URL to use for translating text. Variable substitu‐
190 tion is performed on the URL (see Variable Substitution).
191 post (optional, default: none)
194 If this attribute is present, a HTTP POST request is
195 issued (using the attribute value as post data). Other‐
196 wise, a HTTP GET request is issued. Variable substitution
197 is performed on the post data (see Variable Substitu‐
198 tion).
199 Parents
202 This element contains text-translation: group.
203 Children
206 These element may occur zero or more times in text-translation:
207 http-header, pre-marker, error-marker.
208 This element may occur zero or one time in text-translation:
210 post-marker.
211 pre-marker
214 Description
215 The pre-marker element is used to extract the translated text
216 from the response to a text translation request.
217 For each pre-marker element, the parser locates text in the
219 server response. If text is found, the parser moves to the char‐
220 acter following text. If it is not found, the translation fails.
221 The translated text starts at the character following the last
222 pre-marker match. If no pre-marker element is specified, the
223 translated text starts at the first character of the server
224 response.
225 Attributes
228 text (required)
232 The text to match.
233 Parents
236 This element contains pre-marker: text-translation.
237 post-marker
240 Description
241 The post-marker element is used to extract the translated text
242 from the response to a text translation request.
243 If text can be located in the server response, the translated
245 text ends at the character preceding text. Otherwise, the trans‐
246 lation fails. If no post-marker element is specified, the trans‐
247 lated text ends at the last character of the server response.
248 Attributes
251 text (required)
255 The text to match.
256 Parents
259 This element contains post-marker: text-translation.
260 error-marker
263 Description
264 The error-marker element is used to check if a text translation
265 error has occurred.
266 If one or more error-marker elements are specified and the text
268 of any of them can be located anywhere in the server response,
269 the translation fails.
270 Attributes
273 text (required)
277 The text to match.
278 Parents
281 This element contains error-marker: text-translation.
282 web-page-translation
285 Description
286 The presence of the web-page-translation element specifies that
287 the group can translate a web page.
288 If no http-header element is specified and if post is not speci‐
290 fied, the generic module does not need to connect to the server.
291 In this case, url is returned as the URL of the translated web
292 page. Otherwise, the generic module connects to the server,
293 issues a HTTP GET or POST request, saves the response to a local
294 file, and returns a file:// URL pointing to that file.
295 Attributes
298 url (required)
302 The URL to use for translating a web page. Variable sub‐
303 stitution is performed on the URL (see Variable Substitu‐
304 tion).
305 post (optional, default: none)
308 If this attribute is present, a HTTP POST request is
309 issued (using the attribute value as post data). Other‐
310 wise, a HTTP GET request is issued (or no request at all,
311 see above). Variable substitution is performed on the
312 post data (see Variable Substitution).
313 Parents
316 This element contains web-page-translation: group.
317 Children
320 This element may occur zero or more times in web-page-transla‐
321 tion: http-header.
322
325 Variable substitution is performed at translation time on the url and
326 post attributes of the text-translation and web-page-translation ele‐
327 ments.
328 A variable has the syntax ${varname[:modifiers]}.
331 varname may be any of the following variables:
334 text (text-translation only)
337 The text to translate.
338 url (web-page-translation only)
341 The URL of the web page to translate.
342 from The source language service tag.
345 to The destination language service tag.
348 time The number of seconds since 0 hours, 0 minutes, 0 seconds, Janu‐
351 ary 1, 1970, Coordinated Universal Time.
352 modifiers is a comma-separated list of modifiers. Each modifier is
355 applied (in the specified order) on the contents of the variable. A
356 modifier has the syntax name[=value].
357 name may be any of the following modifiers:
360 escape Escapes the unsafe characters in the variable using URI percent
363 notation.
364 charset
367 Converts the variable from UTF-8 (the libtranslate character
368 set) to the character set value.
369
372 /usr/share/libtranslate/services.xml
373 The system-wide service definitions.
375 ~/.libtranslate/services.xml
378 The user service definitions.
380 /usr/share/libtranslate/services.dtd
383 The services.xml Document Type Definition.
385
388 The libtranslate Reference Manual
389
392 Jean-Yves Lefort.
393libtranslate 0.99 January 15, 2005 SERVICES.XML(5)