Mercurial > hg > mpdl-group

comparison software/mpdl-services/mpiwg-mpdl-cms-web/WebContent/cms-services.html @ 23:e845310098ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
diverse Korrekturen
author Josef Willenborg <jwillenborg@mpiwg-berlin.mpg.de>
date Tue, 27 Nov 2012 12:35:19 +0100
parents
children
comparison
equal deleted inserted replaced
22:6a45a982c333 23:e845310098ba
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 - CMS Services</title>
6 </head>
7 <body>
8 <h2>Max Planck Institute for the History of Science - CMS Services</h2>
9
10 <ul>
11 <li><b>Url: /mpiwg-mpdl-cms-web/doc/GetDocument</b>
12 <ul>
13 <li>Request parameters
14 <ul>
15 <li>id (required)
16 <ul>
17 <li>identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
18 </ul>
19 </li>
20 </ul>
21 </li>
22 <li>Response output
23 <ul>
24 <li>Link to document job</li>
25 <li>Example: <a href="doc/GetDocument?id=/tei/de/dt-ptolemaeus-tei-merge2.xml">Get test document</a></li>
26 </ul>
27 </li>
28 </ul>
29 </li>
30
31 <li><b>Url: /mpiwg-mpdl-cms-web/doc/DocumentOperation</b>
32 <ul>
33 <li>Request parameters
34 <ul>
35 <li>srcUrl (optional)
36 <ul>
37 <li>url of the source document (if operation is create)</li>
38 </ul>
39 </li>
40 <li>docId (required)
41 <ul>
42 <li>document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
43 </ul>
44 </li>
45 <li>elementNames (optional)
46 <ul>
47 <li>list of xml element names which should be indexed</li>
48 <li>default: "s head caption variables description"</li>
49 </ul>
50 </li>
51 <li>operation (required)
52 <ul>
53 <li>create (if docId already exists then it is updated)</li>
54 <li>delete</li>
55 </ul>
56 </li>
57 <li>outputFormat (optional)
58 <ul>
59 <li>xml</li>
60 <li>html</li>
61 <li>string</li>
62 <li>default: xml</li>
63 </ul>
64 </li>
65 </ul>
66 </li>
67 <li>Response output
68 <ul>
69 <li>Link to document job</li>
70 <li>Example: <a href="doc/DocumentOperation?srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/getDoc?doc=/tei/de/dt-ptolemaeus-tei-merge2.xml&docId=/tei/de/dt-ptolemaeus-tei-merge2.xml&operation=create">Create test document</a></li>
71 </ul>
72 </li>
73 </ul>
74 </li>
75
76 <li><b>Url: /mpiwg-mpdl-cms-web/query/GetPage</b>
77 <ul>
78 <li>Request parameters
79 <ul>
80 <li>docId (required)
81 <ul>
82 <li>document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
83 </ul>
84 </li>
85 <li>page (optional)
86 <ul>
87 <li>page number in document</li>
88 <li>default: 1</li>
89 </ul>
90 </li>
91 <li>normalization (optional)
92 <ul>
93 <li>orig (original)</li>
94 <li>reg (regularized)</li>
95 <li>norm (regularized and normalized)</li>
96 <li>default: norm</li>
97 </ul>
98 </li>
99 <li>highlightQuery (optional)
100 <ul>
101 <li>Lucene query string for which words should be highlighted</li>
102 <li>default: empty</li>
103 </ul>
104 </li>
105 <li>highlightQueryType (optional)
106 <ul>
107 <li>form (form)</li>
108 <li>morph (morphological)</li>
109 <li>default: form</li>
110 </ul>
111 </li>
112 <li>highlightElem (optional)
113 <ul>
114 <li>element name which should be highlighted</li>
115 <li>default: empty</li>
116 </ul>
117 </li>
118 <li>highlightElemPos (optional)
119 <ul>
120 <li>element position which should be highlighted</li>
121 <li>default: 1</li>
122 </ul>
123 </li>
124 <li>mode (optional)
125 <ul>
126 <li>untokenized</li>
127 <li>tokenized (page result is enriched with word elements: e.g. &lt;w lang="deu" form="satz" formRegularized="satz" formNormalized="satz" forms="satz, sätze, satzes" lemmas="satz"&gt;Satz&lt;/w&gt;)</li>
128 <li>default: untokenized</li>
129 </ul>
130 </li>
131 <li>outputFormat (optional)
132 <ul>
133 <li>html</li>
134 <li>xml (pure xml)</li>
135 <li>xmlDisplay (xml like display through html)</li>
136 <li>default: html</li>
137 </ul>
138 </li>
139 <li>cssUrl (optional)
140 <ul>
141 <li>url of css file</li>
142 <li>default: <a href="css/page.css">/mpiwg-mpdl-cms-web/css/page.css</a></li>
143 </ul>
144 </li>
145 </ul>
146 </li>
147 <li>Response output
148 <ul>
149 <li>Document page</li>
150 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13">Page 13 in Benedetti document</a></li>
151 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13&mode=tokenized">Page 13 in Benedetti document, tokenized</a></li>
152 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13&highlightElem=s&highlightElemPos=1">Page 13 in Benedetti document, first sentence highlighted</a></li>
153 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13&outputFormat=xmlDisplay&highlightElem=s&highlightElemPos=1">Page 13 in Benedetti document, first sentence highlighted (XML output)</a></li>
154 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13&normalization=reg&highlightQuery=tokenReg:relatiuum">Page 13 in Benedetti document, regularized form "relatiuum" is highlighted</a></li>
155 <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13&highlightQueryType=norm&highlightQuery=tokenMorph:praeclarus&language=lat">Page 13 in Benedetti document, morphological forms of "praeclarus" are highlighted</a></li>
156 </ul>
157 </li>
158 </ul>
159 </li>
160
161 <li><b>Url: /mpiwg-mpdl-cms-web/query/QueryDocuments</b>
162 <ul><li><a href="query/index.html">Web query interface</a></li></ul>
163 <ul>
164 <li>Request parameters
165 <ul>
166 <li>query (required)
167 <ul>
168 <li><a href="http://lucene.apache.org/core/3_6_0/queryparsersyntax.html">Lucene query</a> (e.g. +author:ben* +tokenMorph:quantitas +tokenMorph:sum)
169 <ul>
170 <li>supported fields
171 <ul>
172 <li>docId</li>
173 <li>identifier</li>
174 <li>author</li>
175 <li>title</li>
176 <li>language</li>
177 <li>publisher (place)</li>
178 <li>date (year)</li>
179 <li>subject</li>
180 <li>rights</li>
181 <li>license</li>
182 <li>accessRights</li>
183 <li>tokenOrig</li>
184 <li>tokenReg</li>
185 <li>tokenNorm</li>
186 <li>tokenMorph</li>
187 <li>default: tokenOrig</li>
188 </ul>
189 </li>
190 </ul>
191 </li>
192 </ul>
193 </li>
194 <li>sortBy (optional)
195 <ul>
196 <li>fieldNames separated by blank
197 <ul>
198 <li>supported fields
199 <ul>
200 <li>author</li>
201 <li>title</li>
202 <li>language</li>
203 <li>publisher (place)</li>
204 <li>docId</li>
205 <li>date (year)</li>
206 <li>lastModified</li>
207 <li>schemaName</li>
208 </ul>
209 </li>
210 <li>default: result is sorted by score (the most relevant result first)</li>
211 </ul>
212 </li>
213 </ul>
214 </li>
215 <li>language (optional)
216 <ul>
217 <li>ISO 639-3 specifier</li>
218 <li>default: automatically derived from query</li>
219 </ul>
220 </li>
221 <li>translate (optional)
222 <ul>
223 <li>expansion of the query: translation of the query terms to other languages</li>
224 <li>true</li>
225 <li>false</li>
226 <li>default: false</li>
227 </ul>
228 </li>
229 <li>page (optional)
230 <ul>
231 <li>result page number</li>
232 <li>default: 1</li>
233 </ul>
234 </li>
235 <li>pageSize (optional)
236 <ul>
237 <li>result page size</li>
238 <li>default: 10</li>
239 </ul>
240 </li>
241 <li>outputFormat (optional)
242 <ul>
243 <li>xml</li>
244 <li>html</li>
245 <li>default: html</li>
246 </ul>
247 </li>
248 </ul>
249 </li>
250 <li>Response output
251 <ul>
252 <li>Documents matching the query</li>
253 <li>Example: <a href="query/QueryDocuments?query=tokenOrig:tempore">all documents which contains "tempore" in original content</a></li>
254 <li>Example: <a href="query/QueryDocuments?query=tokenOrig:relatiuũ">all documents which contains "relatiuũ" in original content</a></li>
255 <li>Example: <a href="query/QueryDocuments?query=tokenReg:relatiuum">all documents which contains "relatiuum" in regularized content</a></li>
256 <li>Example: <a href="query/QueryDocuments?query=tokenNorm:relativum">all documents which contains "relativum" in normalized content</a></li>
257 <li>Example: <a href="query/QueryDocuments?query=tokenOrig:Sabaudiæ&language=lat">all latin documents which contains "sabaudiæ" in content</a></li>
258 <li>Example: <a href="query/QueryDocuments?query=tokenMorph:sum&language=lat&page=2">all latin documents which morphological contains "sum" in content (result page 2)</a></li>
259 <li>Example: <a href="query/QueryDocuments?query=tokenOrig:buch&translate=true">all documents which contains translated "buch" in content</a></li>
260 </ul>
261 </li>
262 </ul>
263 </li>
264
265 <li><b>Url: /mpiwg-mpdl-cms-web/query/QueryDocument</b>
266 <ul>
267 <li>Request parameters
268 <ul>
269 <li>docId (required)
270 <ul>
271 <li>document identifier (e.g. "/echo/la/Benedetti_1585.xml"</li>
272 </ul>
273 </li>
274 <li>query (required)
275 <ul>
276 <li><a href="http://lucene.apache.org/core/3_6_0/queryparsersyntax.html">Lucene query</a> (e.g. +tokenMorph:quantitas +tokenMorph:sum)
277 <ul>
278 <li>supported fields
279 <ul>
280 <li>language</li>
281 <li>pageNumber</li>
282 <li>lineNumber</li>
283 <li>elementName</li>
284 <li>elementDocPosition (position in document, e.g. the 7th element in document)</li>
285 <li>elementAbsolutePosition (position in all elements with this name, e.g. the 5th sentence in document)</li>
286 <li>elementPagePosition (position of this element within a page, e.g. the 8th sentence on page 5)</li>
287 <li>elementPosition (position of this element in parent element, e.g. the 3rd sentence element in a paragraph)</li>
288 <li>xmlId</li>
289 <li>xpath</li>
290 <li>tokenOrig</li>
291 <li>tokenReg</li>
292 <li>tokenNorm</li>
293 <li>tokenMorph</li>
294 <li>default: tokenOrig</li>
295 </ul>
296 </li>
297 </ul>
298 </li>
299 </ul>
300 </li>
301 <li>page (optional)
302 <ul>
303 <li>result page number</li>
304 <li>default: 1</li>
305 </ul>
306 </li>
307 <li>pageSize (optional)
308 <ul>
309 <li>result page size</li>
310 <li>default: 10</li>
311 </ul>
312 </li>
313 <li>outputFormat (optional)
314 <ul>
315 <li>xml</li>
316 <li>html</li>
317 <li>default: xml</li>
318 </ul>
319 </li>
320 </ul>
321 </li>
322 <li>Response output
323 <ul>
324 <li>nodes/elements in document which matches the query, sorted by position in document, word tokens are extracted and hits are highlighted</li>
325 <li>Example: <a href="query/QueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=tokenOrig:tempore">in /echo/la/Benedetti_1585_163127KK.xml: all nodes which contains "tempore" in original content (XML output)</a></li>
326 <li>Example: <a href="query/QueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=tokenOrig:tempore&outputFormat=html">in /echo/la/Benedetti_1585_163127KK.xml: all nodes which contains "tempore" in original content (HTML output)</a></li>
327 <li>Example: <a href="query/QueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=tokenReg:relatiuum">in /echo/la/Benedetti_1585.xml: all nodes which contains "relatiuum" in regularized content (XML output)</a></li>
328 <li>Example: <a href="query/QueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=tokenMorph:praeclarus&outputFormat=html">in /echo/la/Benedetti_1585_163127KK.xml: all nodes which contains morphological "praeclarus" in content (HTML output)</a></li>
329 <li>Example: <a href="query/QueryDocument?docId=/tei/en/Test_1789.xml&query=tokenOrig:sentence&outputFormat=html">in /tei/en/Test_1789.xml: all nodes which contains "sentence" in original content (HTML output)</a></li>
330 <li>Example: <a href="query/QueryDocument?docId=/echo/zh/SongYingxing_1637.xml&query=xmlId:N400022&outputFormat=xml">in /echo/zh/SongYingxing_1637.xml: node with xmlId "N400022"</a></li>
331 </ul>
332 </li>
333 </ul>
334 </li>
335
336 <li><b>Url: /mpiwg-mpdl-cms-web/query/XQueryDocument</b>
337 <ul>
338 <li>Request parameters
339 <ul>
340 <li>docId (required)
341 <ul>
342 <li>document identifier (e.g. "/echo/la/Benedetti_1585.xml"</li>
343 </ul>
344 </li>
345 <li>query (required)
346 <ul>
347 <li><a href="http://www.saxonica.com/documentation/javadoc/net/sf/saxon/s9api/package-summary.html">Saxon's</a> <a href="http://www.w3.org/TR/xquery">XQuery</a>/<a href="http://www.w3.org/TR/xpath20">XPath</a></li>
348 </ul>
349 </li>
350 <li>page (optional)
351 <ul>
352 <li>result page number</li>
353 <li>default: 1</li>
354 </ul>
355 </li>
356 <li>pageSize (optional)
357 <ul>
358 <li>result page size</li>
359 <li>default: 10</li>
360 </ul>
361 </li>
362 <li>outputFormat (optional)
363 <ul>
364 <li>xml</li>
365 <li>html</li>
366 <li>default: xml</li>
367 </ul>
368 </li>
369 </ul>
370 </li>
371 <li>Response output
372 <ul>
373 <li>Example: <a href="query/XQueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=count(//*:s)">in /echo/la/Benedetti_1585_163127KK.xml: count all sentences (XML output)</a></li>
374 <li>Example: <a href="query/XQueryDocument?docId=/echo/la/Benedetti_1585_163127KK.xml&query=//*:s">in /echo/la/Benedetti_1585_163127KK.xml: all sentences (XML output)</a></li>
375 <li>Example: <a href="query/XQueryDocument?docId=/tei/en/Test_1789.xml&query=//*:note[@n = 1 or @n=2]&outputFormat=html">in /tei/en/Test_1789.xml: note with number 1 or 2 (HTML output)</a></li>
376 <li>Example: <a href="query/XQueryDocument?docId=/tei/en/Test_1789.xml&query=//*:note/@n">in /tei/en/Test_1789.xml: "n" attributes of all notes (XML output)</a></li>
377 </ul>
378 </li>
379 </ul>
380 </li>
381
382 <li><b>Url: /wspCmsWebApp/query/MoreLikeThis</b>
383 <ul>
384 <li>Request parameters
385 <ul>
386 <li>docId (required)
387 <ul>
388 <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
389 </ul>
390 </li>
391 <li>page (optional)
392 <ul>
393 <li>result page number</li>
394 <li>default: 1</li>
395 </ul>
396 </li>
397 <li>pageSize (optional)
398 <ul>
399 <li>result page size</li>
400 <li>default: 10</li>
401 </ul>
402 </li>
403 <li>outputFormat (optional)
404 <ul>
405 <li>xml</li>
406 <li>html</li>
407 <li>json</li>
408 <li>default: html</li>
409 </ul>
410 </li>
411 <li>addInf (optional)
412 <ul>
413 <li>result with additional information such as person names etc.</li>
414 <li>true</li>
415 <li>false</li>
416 <li>default: false</li>
417 </ul>
418 </li>
419 </ul>
420 </li>
421 <li>Response output
422 <ul>
423 <li>Similar documents</li>
424 <li>Example: <a href="query/MoreLikeThis?docId=/echo/la/Benedetti_1585_163127KK.xml">similar documents of "/echo/la/Benedetti_1585_163127KK.xml"</a></li>
425 </ul>
426 </li>
427 </ul>
428 </li>
429
430 <li><b>Url: /mpiwg-mpdl-cms-web/query/GetToken</b>
431 <ul>
432 <li>Request parameters
433 <ul>
434 <li>docId (optional)
435 <ul>
436 <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
437 </ul>
438 </li>
439 <li>attribute (optional)
440 <ul>
441 <li>identifier</li>
442 <li>author</li>
443 <li>title</li>
444 <li>language</li>
445 <li>date</li>
446 <li>rights</li>
447 <li>license</li>
448 <li>accessRights</li>
449 <li>tokenOrig</li>
450 <li>tokenReg</li>
451 <li>tokenNorm</li>
452 <li>tokenMorph</li>
453 <li>default: tokenOrig</li>
454 </ul>
455 </li>
456 <li>query (optional)
457 <ul>
458 <li>beginning characters of token (e.g. "a")</li>
459 <li>default: empty (beginning alphabetically at first position in all tokens)</li>
460 </ul>
461 </li>
462 <li>count (optional)
463 <ul>
464 <li>count of tokens</li>
465 <li>default: 100</li>
466 </ul>
467 </li>
468 <li>outputFormat (optional)
469 <ul>
470 <li>xml</li>
471 <li>default: xml</li>
472 </ul>
473 </li>
474 </ul>
475 </li>
476 <li>Response output
477 <ul>
478 <li>Tokens of the attribute</li>
479 <li>Example: <a href="query/GetToken?attribute=docId">all token in docId field (starting from beginning)</a></li>
480 <li>Example: <a href="query/GetToken?docId=/echo/la/Benedetti_1585_163127KK.xml&attribute=tokenMorph&query=a">in /echo/la/Benedetti_1585_163127KK.xml: all token beginning with "a" in morphological content (starting from "a")</a></li>
481 <li>Example: <a href="query/GetToken?attribute=tokenMorph&query=a">in all documents: all token beginning with "a" in morphological content (starting from "a")</a></li>
482 </ul>
483 </li>
484 </ul>
485 </li>
486
487 <li><b>Url: /mpiwg-mpdl-cms-web/query/GetDocInfo</b>
488 <ul>
489 <li>Request parameters
490 <ul>
491 <li>docId (required)
492 <ul>
493 <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
494 </ul>
495 </li>
496 <li>field (optional)
497 <ul>
498 <li>author</li>
499 <li>title</li>
500 <li>language</li>
501 <li>date</li>
502 <li>rights</li>
503 <li>license</li>
504 <li>accessRights</li>
505 <li>countPages</li>
506 <li>lastModified</li>
507 <li>schema</li>
508 <li>echoId</li>
509 <li>toc (table of contents)</li>
510 <li>figures</li>
511 <li>notes</li>
512 <li>notesHandwritten</li>
513 <li>pages</li>
514 <li>places</li>
515 <li>default: null (all fields except automatic generated lists such as toc, figures, etc.)</li>
516 </ul>
517 </li>
518 <li>outputFormat (optional)
519 <ul>
520 <li>xml</li>
521 <li>default: xml</li>
522 </ul>
523 </li>
524 </ul>
525 </li>
526 <li>Response output
527 <ul>
528 <li>Metadata information of the document (document fields)</li>
529 <li>Example: <a href="query/GetDocInfo?docId=/echo/la/Benedetti_1585_163127KK.xml">Meta info of document /echo/la/Benedetti_1585_163127KK.xml</a></li>
530 </ul>
531 </li>
532 </ul>
533 </li>
534
535 <li><b>Url: /mpiwg-mpdl-cms-web/doc/GetDocumentJobs</b>
536 <ul>
537 <li>Request parameters
538 <ul>
539 <li>id (optional)
540 <ul>
541 <li>id of the document job</li>
542 </ul>
543 </li>
544 <li>outputFormat (optional)
545 <ul>
546 <li>xml</li>
547 <li>default: xml</li>
548 </ul>
549 </li>
550 </ul>
551 </li>
552 <li>Response output
553 <ul>
554 <li>all document jobs (when parameter id is not set) or document job with the specified id</li>
555 <li>Example: <a href="doc/GetDocumentJobs">get all document jobs</a></li>
556 </ul>
557 </li>
558 </ul>
559 </li>
560
561 </ul>
562
563 </body></html>