Changes between Version 13 and Version 14 of Taskforces/FCS/FCS-Specification-Draft


Ignore:
Timestamp:
10/23/15 09:15:23 (9 years ago)
Author:
Oliver Schonefeld
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Taskforces/FCS/FCS-Specification-Draft

    v13 v14  
    383383}}}
    384384
    385 === "Versioning and Extensions"
    386 ==== "Backwards compatibility statements"
    387 {{{
    388 #!div style="border: 1px solid #000000; font-size: 75%"
    389 Say something about backwards compatibility with "basic-search". \\
    390 Clients should also be compatible with FCS 1.0 (= SRU 1.2) and use heuristic to determine, if an endpoint is still using FCS 1.0.
    391 }}}
     385=== Versioning and Extensions
     386==== Backwards Compatibility
     387{{{
     388#!div style="border: 1px solid #000000; font-size: 75%"
     389TODO: check and proof-read
     390}}}
     391Endpoints `SHOULD` also be compatible to CLARIN-FCS 1.0, thus support the SRU 1.2 protocol.
     392
     393Clients `MUST` be compatible to CLARIN-FCS 1.0, thus must implement SRU 1.2. If a Client uses CLARIN-FCS 1.0 to talk to an Endpoint, it `MUST NOT` use features beyond the Basic Search capability. Clients `MUST` implement a heuristic to automatically determine which CLARIN-FCS protocol version, i.e. which version of the SRU protocol, can be used talk an Endpoint.
     394
     395Pseudo algorithm for version detection heuristic:
     396 * Send ''explain'' request without `version` and `operation` parameter
     397 * Check SRU response for content of the element `<sru:explainResponse>/<sru:version>`
     398
    392399==== Endpoint Custom Extensions
    393400Endpoints can add custom extensions, i.e. custom data, to the Result Format. This extension mechanism can for example be used to provide hints for an (XSLT/XQuery) application that works directly on CLARIN-FCS, e.g. to allow it to generate back and forward links to navigate in a result set.