diff software/mpdl-services/mpiwg-mpdl-xml-web/WebContent/index.html @ 19:4a3641ae14d2

Erstellung
author Josef Willenborg <jwillenborg@mpiwg-berlin.mpg.de>
date Wed, 09 Nov 2011 15:32:05 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/software/mpdl-services/mpiwg-mpdl-xml-web/WebContent/index.html	Wed Nov 09 15:32:05 2011 +0100
@@ -0,0 +1,130 @@
+<!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 - Mpdl: XML Services</title>
+</head>
+<body>
+<h2>Max Planck Institute for the History of Science - Mpdl: XML Services</h2>
+<p>Available Services</p>
+
+<ul>
+  <li><b>Url: /mpiwg-mpdl-xml-web/transform/Transform</b>
+    <ul>
+      <li>Request parameters
+        <ul>
+          <li>srcUrl (required)
+            <ul>
+              <li>url of the Xml source document</li>
+            </ul>
+          </li>
+          <li>xslUrl (required)
+            <ul>
+              <li>url of the Xsl document which does the transformation of the Xml document</li>
+            </ul>
+          </li>
+          <li>parameters (optional)
+            <ul>
+              <li>parameters separated with blanks (e.g. "yourParam1=yourValue1 yourParam2=yourValue2")</li>
+              <li>default: no parameters</li>
+            </ul>
+          </li>
+          <li>outputProperties (optional)
+            <ul>
+              <li>output properties separated with blanks (e.g. "encoding=utf-8 indent=yes")
+                <ul>
+                  <li>"method=xhtml"</li>
+                  <li>"indent=yes"</li>
+                  <li>"media-type=text/html"</li>
+                  <li>"encoding=utf-8"</li>
+                  <li>default: "method=xml indent=yes media-type=text/xml encoding=utf-8"</li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+      <li>Response output
+        <ul>
+          <li>transformed Xml document</li>
+          <li>Example: <a href="transform/Transform?srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/getDoc?doc=/tei/en/Test_1789.xml&xslUrl=http://mpdl-test.mpiwg-berlin.mpg.de:8080/mpiwg-mpdl-xml-web/xsl/generateId.xsl">Generate ids incrementally for sentences in example document</a></li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+
+  <li><b>Url: /mpiwg-mpdl-xml-web/transform/GetFragment</b>
+    <ul>
+      <li>Request parameters
+        <ul>
+          <li>docId (required)
+            <ul>
+              <li>document identifier of the Xml source document (e.g. "/tei/la/Test_1789.xml")</li>
+            </ul>
+          </li>
+          <li>ms1Name (required)
+            <ul>
+              <li>starting milestone element name (e.g. "pb")</li>
+            </ul>
+          </li>
+          <li>ms1Pos (required)
+            <ul>
+              <li>starting milestone position (e.g. "13")</li>
+            </ul>
+          </li>
+          <li>ms2Name (required)
+            <ul>
+              <li>ending milestone element name (e.g. "pb")</li>
+            </ul>
+          </li>
+          <li>ms2Pos (required)
+            <ul>
+              <li>ending milestone position (e.g. "14")</li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+      <li>Response output
+        <ul>
+          <li>fragment between the two milestones in the Xml document</li>
+          <li>Example: <a href="transform/GetFragment?docId=/tei/en/Test_1789.xml&ms1Name=pb&ms1Pos=2&ms2Name=pb&ms2Pos=3">get the fragment between the second and the third page break</a></li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+
+  <li><b>Url: /mpiwg-mpdl-xml-web/xquery/XQuery</b>
+    <ul>
+      <li>Request parameters
+        <ul>
+          <li>inputString or srcUrl (required)
+            <ul>
+              <li>inputString
+                <ul>
+                  <li>XML string</li>
+                </ul>
+              </li>
+              <li>srcUrl
+                <ul>
+                  <li>source URL of XML document</li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>xquery (required)
+            <ul>
+              <li>XQuery (or XPath) source code which should be executed</li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+      <li>Response output
+        <ul>
+          <li>XML result of the XQuery</li>
+          <li>Example: <a href="xquery/XQuery?srcUrl=http://mpdl-system.mpiwg-berlin.mpg.de/mpdl/getDoc?doc=/archimedes/la/achil_propo_087_la_1545.xml&xquery=//s">XPath: all sentences of example document</a></li>
+        </ul>
+      </li>
+    </ul>
+  </li>
+</ul>   
+ 
+</body></html>
\ No newline at end of file