Mercurial > hg > mpdl-group

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>Max Planck Institute for the History of Science - CMS Services</title>
  </head>
<body>
<h2>Max Planck Institute for the History of Science - CMS Services</h2>

<ul>
  <li><b>Url: /mpiwg-mpdl-cms-web/doc/GetDocument</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>id (required)
            <ul>
              <li>identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Link to document job</li>
          <li>Example: <a href="doc/GetDocument?id=/tei/de/dt-ptolemaeus-tei-merge2.xml">Get test document</a></li>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/doc/DocumentOperation</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>srcUrl (optional)
            <ul>
              <li>url of the source document (if operation is create)</li>
            </ul>
          </li>
          <li>docId (required)
            <ul>
              <li>document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
            </ul>
          </li>
          <li>elementNames (optional)
            <ul>
              <li>list of xml element names which should be indexed</li>
              <li>default: "s head caption variables description"</li>
            </ul>
          </li>
          <li>operation (required)
            <ul>
              <li>create (if docId already exists then it is updated)</li>
              <li>delete</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>html</li>
              <li>string</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Link to document job</li>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/GetPage</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (required)
            <ul>
              <li>document identifier of the document (e.g. "/tei/de/dt-ptolemaeus-tei-merge2.xml")</li>
            </ul>
          </li>
          <li>page (optional)
            <ul>
              <li>page number in document</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>normalization (optional)
            <ul>
              <li>orig (original)</li>
              <li>reg (regularized)</li>
              <li>norm (regularized and normalized)</li>
              <li>default: norm</li>
            </ul>
          </li>
          <li>highlightQuery (optional)
            <ul>
              <li>Lucene query string for which words should be highlighted</li>
              <li>default: empty</li>
            </ul>
          </li>
          <li>highlightQueryType (optional)
            <ul>
              <li>form (form)</li>
              <li>morph (morphological)</li>
              <li>default: form</li>
            </ul>
          </li>
          <li>highlightElem (optional)
            <ul>
              <li>element name which should be highlighted</li>
              <li>default: empty</li>
            </ul>
          </li>
          <li>highlightElemPos (optional)
            <ul>
              <li>element position which should be highlighted</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>mode (optional)
            <ul>
              <li>untokenized</li>
              <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>
              <li>default: untokenized</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>html</li>
              <li>xml (pure xml)</li>
              <li>xmlDisplay (xml like display through html)</li>
              <li>default: html</li>
            </ul>
          </li>
          <li>cssUrl (optional)
            <ul>
              <li>url of css file</li>
              <li>default: <a href="css/page.css">/mpiwg-mpdl-cms-web/css/page.css</a></li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Document page</li>
          <li>Example: <a href="query/GetPage?docId=/echo/la/Benedetti_1585_163127KK.xml&page=13">Page 13 in Benedetti document</a></li>
          <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>
          <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>
          <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>
          <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>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/QueryDocuments</b>
    <ul><li><a href="query/index.html">Web query interface</a></li></ul>
    <ul>
      <li>Request parameters
        <ul>
          <li>query (required)
            <ul>
              <li><a href="http://lucene.apache.org/core/3_6_0/queryparsersyntax.html">Lucene query</a> (e.g. +author:ben* +tokenMorph:quantitas +tokenMorph:sum)
              <ul>
                <li>supported fields
                  <ul>
                  <li>docId</li>
                  <li>identifier</li>
                  <li>author</li>
                  <li>title</li>
                  <li>language</li>
                  <li>publisher (place)</li>
                  <li>date (year)</li>
                  <li>subject</li>
                  <li>rights</li>
                  <li>license</li>
                  <li>accessRights</li>
                  <li>tokenOrig</li>
                  <li>tokenReg</li>
                  <li>tokenNorm</li>
                  <li>tokenMorph</li>
                  <li>default: tokenOrig</li>
                </ul>
              </li>
              </ul>
            </li>
            </ul>
          </li>
          <li>sortBy (optional)
            <ul>
              <li>fieldNames separated by blank
              <ul>
                <li>supported fields
                  <ul>
                  <li>author</li>
                  <li>title</li>
                  <li>language</li>
                  <li>publisher (place)</li>
                  <li>docId</li>
                  <li>date (year)</li>
                  <li>lastModified</li>
                  <li>schemaName</li>
                </ul>
              </li>
              <li>default: result is sorted by score (the most relevant result first)</li>
              </ul>
            </li>
            </ul>
          </li>
          <li>language (optional)
            <ul>
              <li>ISO 639-3 specifier</li>
              <li>default: automatically derived from query</li>
            </ul>
          </li>
          <li>translate (optional)
            <ul>
              <li>expansion of the query: translation of the query terms to other languages</li>
              <li>true</li>
              <li>false</li>
              <li>default: false</li>
            </ul>
          </li>
          <li>page (optional)
            <ul>
              <li>result page number</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>pageSize (optional)
            <ul>
              <li>result page size</li>
              <li>default: 10</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>html</li>
              <li>default: html</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Documents matching the query</li>
          <li>Example: <a href="query/QueryDocuments?query=tokenOrig:tempore">all documents which contains "tempore" in original content</a></li>
          <li>Example: <a href="query/QueryDocuments?query=tokenOrig:relatiuũ">all documents which contains "relatiuũ" in original content</a></li>
          <li>Example: <a href="query/QueryDocuments?query=tokenReg:relatiuum">all documents which contains "relatiuum" in regularized content</a></li>
          <li>Example: <a href="query/QueryDocuments?query=tokenNorm:relativum">all documents which contains "relativum" in normalized content</a></li>
          <li>Example: <a href="query/QueryDocuments?query=tokenOrig:Sabaudiæ&language=lat">all latin documents which contains "sabaudiæ" in content</a></li>
          <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>
          <li>Example: <a href="query/QueryDocuments?query=tokenOrig:buch&translate=true">all documents which contains translated "buch" in content</a></li>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/QueryDocument</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (required)
            <ul>
              <li>document identifier (e.g. "/echo/la/Benedetti_1585.xml"</li>
            </ul>
          </li>
          <li>query (required)
            <ul>
              <li><a href="http://lucene.apache.org/core/3_6_0/queryparsersyntax.html">Lucene query</a> (e.g. +tokenMorph:quantitas +tokenMorph:sum)
              <ul>
                <li>supported fields
                  <ul>
                  <li>language</li>
                  <li>pageNumber</li>
                  <li>lineNumber</li>
                  <li>elementName</li>
                  <li>elementDocPosition (position in document, e.g. the 7th element in document)</li>
                  <li>elementAbsolutePosition (position in all elements with this name, e.g. the 5th sentence in document)</li>
                  <li>elementPagePosition (position of this element within a page, e.g. the 8th sentence on page 5)</li>
                  <li>elementPosition (position of this element in parent element, e.g. the 3rd sentence element in a paragraph)</li>
                  <li>xmlId</li>
                  <li>xpath</li>
                  <li>tokenOrig</li>
                  <li>tokenReg</li>
                  <li>tokenNorm</li>
                  <li>tokenMorph</li>
                  <li>default: tokenOrig</li>
                </ul>
              </li>
              </ul>
            </li>
            </ul>
          </li>
          <li>page (optional)
            <ul>
              <li>result page number</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>pageSize (optional)
            <ul>
              <li>result page size</li>
              <li>default: 10</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>html</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>nodes/elements in document which matches the query, sorted by position in document, word tokens are extracted and hits are highlighted</li>
          <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>
          <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>
          <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>
          <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>
          <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>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/XQueryDocument</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (required)
            <ul>
              <li>document identifier (e.g. "/echo/la/Benedetti_1585.xml"</li>
            </ul>
          </li>
          <li>query (required)
            <ul>
              <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>
            </ul>
          </li>
          <li>page (optional)
            <ul>
              <li>result page number</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>pageSize (optional)
            <ul>
              <li>result page size</li>
              <li>default: 10</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>html</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <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>
          <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>
          <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>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /wspCmsWebApp/query/MoreLikeThis</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (required)
            <ul>
              <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
            </ul>
          </li>
          <li>page (optional)
            <ul>
              <li>result page number</li>
              <li>default: 1</li>
            </ul>
          </li>
          <li>pageSize (optional)
            <ul>
              <li>result page size</li>
              <li>default: 10</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>html</li>
              <li>json</li>
              <li>default: html</li>
            </ul>
          </li>
          <li>addInf (optional)
            <ul>
              <li>result with additional information such as person names etc.</li>
              <li>true</li>
              <li>false</li>
              <li>default: false</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Similar documents</li>
          <li>Example: <a href="query/MoreLikeThis?docId=/echo/la/Benedetti_1585_163127KK.xml">similar documents of "/echo/la/Benedetti_1585_163127KK.xml"</a></li>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/GetToken</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (optional)
            <ul>
              <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
            </ul>
          </li>
          <li>attribute (optional)
            <ul>
              <li>identifier</li>
              <li>author</li>
              <li>title</li>
              <li>language</li>
              <li>date</li>
              <li>rights</li>
              <li>license</li>
              <li>accessRights</li>
              <li>tokenOrig</li>
              <li>tokenReg</li>
              <li>tokenNorm</li>
              <li>tokenMorph</li>
              <li>default: tokenOrig</li>
            </ul>
          </li>
          <li>query (optional)
            <ul>
              <li>beginning characters of token (e.g. "a")</li>
              <li>default: empty (beginning alphabetically at first position in all tokens)</li>
            </ul>
          </li>
          <li>count (optional)
            <ul>
              <li>count of tokens</li>
              <li>default: 100</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Tokens of the attribute</li>
          <li>Example: <a href="query/GetToken?attribute=docId">all token in docId field (starting from beginning)</a></li>
          <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>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/query/GetDocInfo</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>docId (required)
            <ul>
              <li>document identifier (e.g. "/echo/la/Benedetti_1585_163127KK.xml"</li>
            </ul>
          </li>
          <li>field (optional)
            <ul>
              <li>author</li>
              <li>title</li>
              <li>language</li>
              <li>date</li>
              <li>rights</li>
              <li>license</li>
              <li>accessRights</li>
              <li>countPages</li>
              <li>lastModified</li>
              <li>schema</li>
              <li>echoId</li>
              <li>toc (table of contents)</li>
              <li>figures</li>
              <li>notes</li>
              <li>notesHandwritten</li>
              <li>pages</li>
              <li>places</li>
              <li>default: null (all fields except automatic generated lists such as toc, figures, etc.)</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>Metadata information of the document (document fields)</li>
          <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>
        </ul>
      </li>
    </ul>
  </li>

  <li><b>Url: /mpiwg-mpdl-cms-web/doc/GetDocumentJobs</b>
    <ul>
      <li>Request parameters
        <ul>
          <li>id (optional)
            <ul>
              <li>id of the document job</li>
            </ul>
          </li>
          <li>outputFormat (optional)
            <ul>
              <li>xml</li>
              <li>default: xml</li>
            </ul>
          </li>
        </ul>
      </li>
      <li>Response output
        <ul>
          <li>all document jobs (when parameter id is not set) or document job with the specified id</li>
          <li>Example: <a href="doc/GetDocumentJobs">get all document jobs</a></li>
        </ul>
      </li>
    </ul>
  </li>

</ul>

</body></html>
author	Josef Willenborg <jwillenborg@mpiwg-berlin.mpg.de>
date	Tue, 21 May 2013 10:19:32 +0200
parents
children