Changes between Version 15 and Version 16 of mpdl2.0-design


Ignore:
Timestamp:
Oct 13, 2011, 12:07:59 PM (13 years ago)
Author:
jwillenborg
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • mpdl2.0-design

    v15 v16  
    99
    1010== XML technology ==
     11
     12See the development state [http://mpdl-test.mpiwg-berlin.mpg.de:8080/mpiwg-mpdl-xml-web/ here] (test server which is sometimes down).
    1113
    1214The XML technology web archive ""mpiwg-mpdl-xml-web.war"" consists of:
    … …  
    2426Following HTTP servlets are available:
    2527
    26 See the development state [http://mpdl-test.mpiwg-berlin.mpg.de:8080/mpiwg-mpdl-xml-web/ here] (test server which is sometimes down)
    27 
    2828=== XSL transformation ===
    2929
    3030* Url: /mpiwg-mpdl-xml-web/transform/Transform
    31   * Request parameters:
    32     * srcUrl
    33       * source URL of XML document
    34     * xslUrl
    35       * URL of XSL document
     31  * Request parameters
     32    * srcUrl (required)
     33      * url of the Xml source document
     34    * xslUrl (required)
     35      * url of the Xsl document which does the transformation of the Xml document
    3636    * parameters (optional)
    37       * list of parameters, e.g. "yourParam1=val1 yourParam2=val2"
     37      * parameters separated with blanks (e.g. "yourParam1=yourValue1 yourParam2=yourValue2")
     38      * default: no parameters
    3839    * outputProperties (optional)
    39       * list of output properties, e.g. "method=xhtml indent=no"
    40   * Response output:
    41     * transformed document (HTML, XML, etc.)
     40      * output properties separated with blanks (e.g. "encoding=utf-8 indent=yes")
     41        * "method=xhtml"
     42        * "indent=yes"
     43        * "media-type=text/html"
     44        * "encoding=utf-8"
     45        * default: "method=xml indent=yes media-type=text/xml encoding=utf-8"
     46  * Response output
     47    * transformed Xml document
    4248
    4349* Url: /mpiwg-mpdl-xml-web/transform/GetFragment
    … …  
    5460      * second milestone position, e.g. 2
    5561  * Response output:
    56     * XML fragment
     62    * XML fragment between the two milestone elements
    5763
    5864=== PDF rendering ===
    … …  
    6571      * URL of XSL document
    6672    * parameters (optional)
    67       * list of parameters, e.g. "yourParam1=val1 yourParam2=val2"
     73      * list of parameters, e.g. "yourParam1=yourValue2 yourParam2=yourValue2"
    6874  * Response output:
    6975    * rendered document (PDF)
    … …  
    9096
    9197== Language technology ==
     98
     99See the development state [http://mpdl-test.mpiwg-berlin.mpg.de:8080/mpiwg-mpdl-lt-web/ here] (test server which is sometimes down).
    92100
    93101The language technology web archive ""mpiwg-mpdl-lt-web.war"" consists of:
    … …  
    106114Following HTTP servlets are available:
    107115
    108 See the development state [http://mpdl-test.mpiwg-berlin.mpg.de:8080/mpiwg-mpdl-lt-web/ here] (test server which is sometimes down)
    109 
    110116=== Morphology ===
    111117
    … …  
    125131      * elements which should not be analyzed and enriched (e.g. "lb")
    126132    * outputFormat (optional; default: "xml")
    127       * "xml", "wordList"
     133      * "xml", "string"
    128134  * Response output:
    129135    * xml
    … …  
    136142* Url: /mpiwg-mpdl-lt-web/lt/GetLemmas
    137143  * Request parameters:
    138     * forms
    139       * one word form (string)
    140       * list of word forms (XML)
    141     * language
     144    * query (required)
     145      * one form or lemma (e.g. "revolution") or
     146      * blank separated list of forms or lemmas (e.g. "revolution equality brotherliness")
     147    * inputType (optional)
     148      * "form"
     149      * "lemma"
     150      * default: "form"
     151    * language (optional)
    142152      * ISO 639-3 specifier
    143     * normalization (optional; default: without normalization)
    144       * "reg", "norm", "reg norm"
    145   * Response output:
    146     * lemmas
    147       * one lemma
    148       * list of lemmas (XML)
     153      * default: "eng"
     154    * outputType (optional)
     155      * "compact"
     156      * "full"
     157      * default: "compact"
     158    * outputFormat (optional)
     159      * "html"
     160      * "xml"
     161      * "string" (lemma names separated by a blank)
     162      * default: "xml"
     163    * normalization (optional)
     164      * "none"
     165      * "norm"
     166      * default: "norm"
     167  * Response output:
     168    * dependent of outputFormat and outputType: lemma entries in Xml or Html or string format
    149169
    150170* Url: /mpiwg-mpdl-lt-web/lt/GetForms
    151171  * Request parameters:
    152     * lemmas
    153       * one lemma (string)
    154       * list of lemmas (XML)
    155     * language
     172    * query (required)
     173      * one lemma (e.g. "revolution") or
     174      * blank separated list of forms (e.g. "revolution equality brotherliness")
     175    * language (optional)
    156176      * ISO 639-3 specifier
    157     * normalization (optional; default: without normalization)
    158       * "reg", "norm", "reg norm"
    159   * Response output:
    160     * forms
    161       * list forms (XML)
     177      * default: "eng"
     178    * outputType (optional)
     179      * "compact"
     180      * "full"
     181      * default: "compact"
     182    * outputFormat (optional)
     183      * "html"
     184      * "xml"
     185      * "string" (lemma names separated by a blank)
     186      * default: "xml"
     187    * normalization (optional)
     188      * "none"
     189      * "norm"
     190      * default: "norm"
     191  * Response output:
     192    * dependent of outputFormat and outputType: form entries in Xml or Html or string format
    162193
    163194=== Dictionary ===
    164195
    165196* Url: /mpiwg-mpdl-lt-web/lt/GetDictionaryEntries
    166   * Request parameters:
    167     * query (forms or lemmas or range; optional; default: "a*")
    168       * one form or lemma (e.g. "revolution")
    169       * list of forms or lemmas (e.g. "revolution equality brotherliness")
     197  * Request parameters
     198    * query (required)
     199      * one form or lemma (e.g. "revolution") or
     200      * blank separated list of forms or lemmas (e.g. "revolution equality brotherliness")
    170201      * range
    171202        * entries beginning with, e.g. "a*"
    172203        * entries from position x to y: e.g. "200-300"
    173     * inputType (optional; default: "form")
    174       * "form", "lemma"
    175     * language (optional, default: eng)
     204    * inputType (optional)
     205      * "form"
     206      * "lemma"
     207      * default: "form"
     208    * language (optional)
    176209      * ISO 639-3 specifier
    177     * dictionary (optional; default: all dictionaries for the language)
     210      * default: "eng"
     211    * dictionary (optional)
    178212      * dictionary name, e.g. "webster"
    179     * outputType (optional, default: compact)
    180       * "full", "compact"
    181     * outputFormat (optional, default: xml)
    182       * "xml", "html"
    183     * normalization (optional; default: "norm")
    184       * "none", "reg", "norm", "reg norm"
    185   * Response output:
    186     * dictionary entries
    187       * dictionary entries (in XML/HTML format)
    188         * if result is big then it is devided into result pages
    189         * with external links
     213      * default: "all" (all dictionaries for the specified language)
     214    * outputType (optional)
     215      * "compact"
     216      * "full"
     217      * default: "compact"
     218    * outputFormat (optional)
     219      * "html"
     220      * "xml"
     221      * default: "xml"
     222    * normalization (optional)
     223      * "none"
     224      * "norm"
     225      * default: "norm"
     226  * Response output
     227    * dependent of outputFormat and outputType: morphology, dictionary and Wikipedia entries in Xml or Html format
    190228
    191229=== Text functions ===