Mercurial > hg > mpdl-group

comparison software/mpdl-services-new/mpiwg-mpdl-cms-web/WebContent/lt-services.html @ 25:e9fe3186670c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
letzter Stand eingecheckt
author Josef Willenborg <jwillenborg@mpiwg-berlin.mpg.de>
date Tue, 21 May 2013 10:19:32 +0200
parents
children
comparison
equal deleted inserted replaced
23:e845310098ba 25:e9fe3186670c
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5 <title>Max Planck Institute for the History of Science - Language technology services</title>
6 </head>
7 <body>
8 <table align="right">
9 <tr>
10 <td>
11 [<i>This software is dedicated to <a href="http://mpdl-proto.mpiwg-berlin.mpg.de/mpdl/info.xql?info=malcolm">Dr. Malcolm Hyman</a></i>]
12 <img src="/mpiwg-mpdl-cms-web/images/info.png" width="15" height="15" border="0" alt="Info"/><br/>
13 [<i>It is based on <a href="http://archimedes.fas.harvard.edu/">Donatus and Pollux</a></i>]
14 <img src="/mpiwg-mpdl-cms-web/images/info.png" width="15" height="15" border="0" alt="Info"/>
15 </td>
16 </tr>
17 </table>
18 <h2>Max Planck Institute for the History of Science - Language technology services</h2>
19
20 <ul>
21 <li><b>Url: /mpiwg-mpdl-cms-web/lt/GetDictionaryEntries</b>
22 <ul>
23 <li>Request parameters
24 <ul>
25 <li>query (required)
26 <ul>
27 <li>by one form or lemma (e.g. "revolution")</li>
28 <li>by a list of forms or lemmas (e.g. "revolution equality brotherliness")</li>
29 <li>by a prefix range: entries starting with a prefix (e.g. "a*")</li>
30 </ul>
31 </li>
32 <li>queryDisplay (optional)
33 <ul>
34 <li>display of the query</li>
35 <li>default: content of parameter "query"</li>
36 </ul>
37 </li>
38 <li>inputType (optional)
39 <ul>
40 <li>"form"</li>
41 <li>"lemma"</li>
42 <li>default: "form"</li>
43 </ul>
44 </li>
45 <li>language (optional)
46 <ul>
47 <li>ISO 639-3 specifier</li>
48 <li>default: "eng"</li>
49 </ul>
50 </li>
51 <li>dictionary (optional)
52 <ul>
53 <li>dictionary name, e.g. "webster"</li>
54 <li>default: "all" (all dictionaries for the specified language)</li>
55 </ul>
56 </li>
57 <li>outputType (optional)
58 <ul>
59 <li>this parameter can occur many times (e.g. "outputType=morphCompact&amp;outputType=dictCompact")
60 <ul>
61 <li>"morphCompact"</li>
62 <li>"dictCompact"</li>
63 <li>"wikiCompact"</li>
64 <li>"allCompact" (all output types compact)</li>
65 <li>"morphFull"</li>
66 <li>"dictFull"</li>
67 <li>"wikiFull"</li>
68 <li>"allFull" (all output types full)</li>
69 </ul>
70 </li>
71 <li>default: "allCompact"</li>
72 </ul>
73 </li>
74 <li>outputFormat (optional)
75 <ul>
76 <li>"html"</li>
77 <li>"xml"</li>
78 <li>default: "xml"</li>
79 </ul>
80 </li>
81 <li>normalization (optional)
82 <ul>
83 <li>"none"</li>
84 <li>"norm"</li>
85 <li>default: "norm"</li>
86 </ul>
87 </li>
88 <li>resultPageNumber (optional)
89 <ul>
90 <li>works only for range queries</li>
91 <li>page number of the result (e.g. "2": result entries from position 51 to 100)</li>
92 <li>default: "1"</li>
93 </ul>
94 </li>
95 <li>resultPageSize (optional)
96 <ul>
97 <li>works only for range queries</li>
98 <li>page size of the result (e.g. "100": each result page has a size of 100)</li>
99 <li>default: "50"</li>
100 </ul>
101 </li>
102 </ul>
103 </li>
104 <li>Response output
105 <ul>
106 <li>dependent of outputFormat, outputType and resultPage: morphology, dictionary and Wikipedia entries in Xml or Html format</li>
107 <li>Example: <a href="lt/GetDictionaryEntries?query=a*&language=lat&outputFormat=html">query=a*&amp;language=lat&amp;outputFormat=html</a></li>
108 <li>Example: <a href="lt/GetDictionaryEntries?query=a*&dictionary=ls">query=a*&amp;dictionary=ls</a></li>
109 <li>Example: <a href="lt/GetDictionaryEntries?query=revolution&language=eng">query=revolution&amp;language=lat</a></li>
110 <li>Example: <a href="lt/GetDictionaryEntries?query=multa&language=lat&outputFormat=html&outputType=allCompact">query=multa&amp;language=lat&amp;outputFormat=html&amp;outputType=allCompact</a></li>
111 </ul>
112 </li>
113 </ul>
114 </li>
115
116 <li><b>Url: /mpiwg-mpdl-cms-web/lt/GetLemmas</b>
117 <ul>
118 <li>Request parameters
119 <ul>
120 <li>query (required)
121 <ul>
122 <li>one form or lemma (e.g. "revolution") or</li>
123 <li>blank separated list of forms or lemmas (e.g. "revolution equality brotherliness")</li>
124 </ul>
125 </li>
126 <li>inputType (optional)
127 <ul>
128 <li>"form"</li>
129 <li>"lemma"</li>
130 <li>default: "form"</li>
131 </ul>
132 </li>
133 <li>language (optional)
134 <ul>
135 <li>ISO 639-3 specifier</li>
136 <li>default: "eng"</li>
137 </ul>
138 </li>
139 <li>outputType (optional)
140 <ul>
141 <li>"compact"</li>
142 <li>"full"</li>
143 <li>default: "compact"</li>
144 </ul>
145 </li>
146 <li>outputFormat (optional)
147 <ul>
148 <li>"html"</li>
149 <li>"xml"</li>
150 <li>"string" (lemma names separated by a blank)</li>
151 <li>default: "xml"</li>
152 </ul>
153 </li>
154 <li>normalization (optional)
155 <ul>
156 <li>"none"</li>
157 <li>"norm"</li>
158 <li>default: "norm"</li>
159 </ul>
160 </li>
161 </ul>
162 </li>
163 <li>Response output
164 <ul>
165 <li>dependent of outputFormat and outputType: lemma entries in Xml or Html or string format</li>
166 <li>Example: <a href="lt/GetLemmas?query=multa&language=lat&outputFormat=html">query=multa&amp;language=lat&amp;outputFormat=html</a></li>
167 </ul>
168 </li>
169 </ul>
170 </li>
171
172 <li><b>Url: /mpiwg-mpdl-cms-web/lt/GetForms</b>
173 <ul>
174 <li>Request parameters
175 <ul>
176 <li>query (required)
177 <ul>
178 <li>one lemma (e.g. "revolution") or</li>
179 <li>blank separated list of forms (e.g. "revolution equality brotherliness")</li>
180 </ul>
181 </li>
182 <li>language (optional)
183 <ul>
184 <li>ISO 639-3 specifier</li>
185 <li>default: "eng"</li>
186 </ul>
187 </li>
188 <li>outputType (optional)
189 <ul>
190 <li>"compact"</li>
191 <li>"full"</li>
192 <li>default: "compact"</li>
193 </ul>
194 </li>
195 <li>outputFormat (optional)
196 <ul>
197 <li>"html"</li>
198 <li>"xml"</li>
199 <li>"string" (lemma names separated by a blank)</li>
200 <li>default: "xml"</li>
201 </ul>
202 </li>
203 <li>normalization (optional)
204 <ul>
205 <li>"none"</li>
206 <li>"norm"</li>
207 <li>default: "norm"</li>
208 </ul>
209 </li>
210 </ul>
211 </li>
212 <li>Response output
213 <ul>
214 <li>dependent of outputFormat and outputType: form entries in Xml or Html or string format</li>
215 <li>Example: <a href="lt/GetForms?query=edo sum&language=lat&outputFormat=string">query=edo sum&amp;language=lat&amp;outputFormat=string</a></li>
216 </ul>
217 </li>
218 </ul>
219 </li>
220
221 <li><b>Url: /mpiwg-mpdl-cms-web/text/Tokenize</b>
222 <ul>
223 <li>Request parameters
224 <ul>
225 <li>inputString or srcUrl (required)
226 <ul>
227 <li>inputString
228 <ul>
229 <li>string which should be tokenized
230 <ul>
231 <li>unstructured text</li>
232 <li>XML fragment/document</li>
233 </ul>
234 </li>
235 </ul>
236 </li>
237 <li>srcUrl
238 <ul>
239 <li>source URL
240 <ul>
241 <li>unstructured text</li>
242 <li>XML fragment/document</li>
243 </ul>
244 </li>
245 </ul>
246 </li>
247 </ul>
248 </li>
249 <li>language (optional)
250 <ul>
251 <li>ISO 639-3 specifier</li>
252 <li>if input is XML and an element contains the attribute "xml:lang" this value is used for this element</li>
253 <li>default: "eng"</li>
254 </ul>
255 </li>
256 <li>normalization (optional)
257 <ul>
258 <li>"none" (no normalization)</li>
259 <li>"reg" (regularized)</li>
260 <li>"norm" (regularized + normalized)</li>
261 <li>default: "norm"</li>
262 </ul>
263 </li>
264 <li>normalizationType (optional)
265 <ul>
266 <li>"dictionary"</li>
267 <li>"display"</li>
268 <li>default: "dictionary"</li>
269 </ul>
270 </li>
271 <li>elements (optional)
272 <ul>
273 <li>list of xml element names which should be tokenized (e.g. "s head")</li>
274 <li>default: empty list (which means: all elements are tokenized)</li>
275 </ul>
276 </li>
277 <li>stopElements (optional)
278 <ul>
279 <li>list of xml element names which are stop elements(e.g. "var emph"): stop elements: its tokens should not get word tags (when output format is "xml") or its tokens should be removed (if output format is "string")</li>
280 <li>default: empty list</li>
281 </ul>
282 </li>
283 <li>highlightTerms (optional)
284 <ul>
285 <li>list of word forms which should be highlighted. Each matched word form is surrounded by &lt;hi&gt;&lt;/hi&gt;. The matching function is dependent of the normalization. E.g. if normalization = "norm" then the normalized word form is fetched and highlighted.</li>
286 <li>default: empty list</li>
287 </ul>
288 </li>
289 <li>outputFormat (optional)
290 <ul>
291 <li>"xml"</li>
292 <li>"string"</li>
293 <li>default: "xml"</li>
294 </ul>
295 </li>
296 <li>outputOptions (optional)
297 <ul>
298 <li>output options separated by blanks (e.g. "withForms withLemmas")
299 <ul>
300 <li>"withForms"</li>
301 <li>"withLemmas"</li>
302 <li>default: empty list</li>
303 </ul>
304 </li>
305 </ul>
306 </li>
307 </ul>
308 </li>
309 <li>Response output
310 <ul>
311 <li>outputFormat=xml
312 <ul>
313 <li>tokenized inputString or document (enriched by element &lt;w&gt;)
314 <ul>
315 <li>Example: &lt;s&gt;&lt;w lang="deu" form="dies" formRegularized="dies" formNormalized="dies" forms="dies, dieser, dieses, diesen" lemmas="dieser"&gt;Dies&lt;/w&gt; &lt;w
316 lang="deu" form="ist" formRegularized="ist" formNormalized="ist" forms="bin, bist, ist, seid, sind, sein, war, warst, wart" lemmas="sein"&gt;ist&lt;/w&gt; &lt;w
317 lang="deu" form="ein" formRegularized="ein" formNormalized="ein" forms="ein, eines, einer" lemmas="ein"&gt;ein&lt;/w&gt; &lt;w lang="deu" form="satz"
318 formRegularized="satz" formNormalized="satz" forms="satz, sätze, satzes" lemmas="satz"&gt;Satz&lt;/w&gt;&lt;/s&gt;
319 </li>
320 </ul>
321 </li>
322 </ul>
323 <li>outputFormat=string
324 <ul>
325 <li>word tokens of inputString or document (separated by Blank)</li>
326 </ul>
327 <li>Example: <a href="text/Tokenize?inputString=edo sum philoſophi&language=lat&outputFormat=xml">inputString=edo sum philoſophi&amp;language=lat&amp;outputFormat=xml</a></li>
328 <li>Example: <a href="text/Tokenize?language=lat&srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13">language=lat&amp;srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13</a></li>
329 <li>Example: <a href="text/Tokenize?language=lat&highlightTerms=eorumque&srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13">language=lat&amp;highlightTerms=eorumque&amp;srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13</a></li>
330 <li>Example: <a href="text/Tokenize?language=lat&outputOptions=withForms withLemmas&srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13">language=lat&amp;outputOptions=withForms withLemmas&amp;srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13</a></li>
331 <li>Example: <a href="text/Tokenize?language=lat&outputFormat=string&normalization=orig&srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13">language=lat&amp;outputFormat=string&amp;normalization=orig&amp;srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13</a></li>
332 <li>Example: <a href="text/Tokenize?language=lat&outputFormat=string&outputOptions=withLemmas&srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13">language=lat&amp;outputFormat=string&amp;outputOptions=withLemmas&amp;srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/page-query-result.xql?document=/echo/la/Benedetti_1585.xml%26mode=pureXml%26pn=13</a></li>
333 </ul>
334 </li>
335 </ul>
336 </li>
337
338 <li><b>Url: /mpiwg-mpdl-cms-web/text/Normalize</b>
339 <ul>
340 <li>Request parameters
341 <ul>
342 <li>inputString (required)
343 <ul>
344 <li>string which should be normalized</li>
345 </ul>
346 </li>
347 <li>language (optional)
348 <ul>
349 <li>ISO 639-3 specifier</li>
350 <li>default: "eng"</li>
351 </ul>
352 </li>
353 <li>type (optional)
354 <ul>
355 <li>"dictionary"</li>
356 <li>"display"</li>
357 <li>default: "display"</li>
358 </ul>
359 </li>
360 </ul>
361 </li>
362 <li>Response output
363 <ul>
364 <li>normalized string</li>
365 <li>Example: <a href="text/Normalize?inputString=philoſophi&language=lat">inputString=philoſophi&amp;language=lat</a></li>
366 </ul>
367 </li>
368 </ul>
369 </li>
370
371 <li><b>Url: /mpiwg-mpdl-cms-web/text/Transcode</b>
372 <ul>
373 <li>Request parameters
374 <ul>
375 <li>inputString (required)
376 <ul>
377 <li>string which should be transcoded</li>
378 </ul>
379 </li>
380 <li>srcEncoding (required)
381 <ul>
382 <li>"betacode"</li>
383 <li>"buckwalter"</li>
384 <li>"unicode"</li>
385 </ul>
386 </li>
387 <li>destEncoding (optional)
388 <ul>
389 <li>"betacode"</li>
390 <li>"buckwalter"</li>
391 <li>"unicode"</li>
392 <li>default: "unicode"</li>
393 </ul>
394 </li>
395 </ul>
396 </li>
397 <li>Response output
398 <ul>
399 <li>transcoded string</li>
400 <li>Example: <a href="text/Transcode?inputString=kai/&srcEncoding=betacode&destEncoding=unicode">inputString=kai/&amp;srcEncoding=betacode&amp;destEncoding=unicode</a></li>
401 </ul>
402 </li>
403 </ul>
404 </li>
405 </ul>
406
407
408 </body></html>