Changes between Version 33 and Version 34 of FCS-Specification-ScrapBook

Timestamp:

02/11/14 18:29:46 (10 years ago)

Author:

oschonef

Comment:

--

FCS-Specification-ScrapBook

@@ -406 +406 @@
 The following sections are non-normative.
 
-=== Referring to an Endpoint from a CMDI record
+=== Referring to an Endpoint from a CMDI record ===
 
 Centers are encouraged to provide links to their CLARIN-FCS Endpoints in the metadata records for their resources. Other services, like the VLO, can use this information for automatically configuring an Aggregator for searching resources at the Endpoint.
@@ -431 +431 @@
 
 
+=== Endpoint custom extensions ===
+
+The CLARIN-FCS protocol specification allows Endpoints to add custom data to their responses. This extension mechanism can for example be used to provide hints to 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. 
+
+*WIP*
+An Endpoint `MAY` add arbitrary XML fragments to a `<fcs:Resource>` element. Clients `SHOULD` ignore any custom extensions they do not understand. 
+
+ * Example:
+{{{#!xml
+<fcs:Resource xmlns:fcs="http://clarin.eu/fcs/1.0" pid="hdl:4711/0815">
+    <fcs:DataView type="application/x-clarin-fcs-hits+xml">
+      <hits:Result xmlns:hits="http://clarin.eu/fcs/1.0/hits">
+        The quick brown <hits:Hit>fox</hits:Hit> jumps over the lazy <hits:Hit>dog</hits:Hit>.
+      </hits:Result>
+    </fcs:DataView>
+    
+    <!--
+        NOTE: this is purly fictional and only serves to demonstrate how
+              to add custom extensions to the result representation
+              within CLARIN-FCS.
+
+        A hypothetical Endpoint extension for navigation in a result set:
+        it basically provdes a set of hrefs, that a GUI can convert into
+        navigation buttions.    
+    -->
+    <nav:navigation xmlns:nav="http://repos.example.org/navigation">
+        <nav:curr href="http://repos.example.org/resultset/4711/4611" />
+        <nav:prev href="http://repos.example.org/resultset/4711/4610" />
+        <nav:next href="http://repos.example.org/resultset/4711/4612" />
+    </nav:navigation>
+</fcs:Resource>
+}}}
+
 ----