Changes between Initial Version and Version 1 of Taskforces/FCS/FCS-Specification-Draft


Ignore:
Timestamp:
10/15/15 07:57:27 (9 years ago)
Author:
Oliver Schonefeld
Comment:

add initial FCS 2.0 spec stub

Legend:

Unmodified
Added
Removed
Modified

  • Taskforces/FCS/FCS-Specification-Draft

    v1 v1  
     1{{{
     2#!div class="system-message"
     3'''NOTE''': This page is work-in-progress.
     4}}}
     5[[PageOutline(1-6)]]
     6= CLARIN Federated Content Search (CLARIN-FCS) - Core 2.0
     7= Introduction
     8
     9== Terminology
     10== Glossary
     11== Normative References
     12== Non-Normative References
     13== Typographic and XML Namespace conventions
     14{{{
     15#!div style="border: 1px solid #000000; font-size: 75%"
     16All sub-sections to be updated as required.
     17}}}
     18= CLARIN-FCS Interface Specification
     19== "Discovery Phase"
     20=== Capabilities
     21{{{
     22#!div style="border: 1px solid #000000; font-size: 75%"
     23Add and describe advanced capability.
     24}}}
     25=== Endpoint Description
     26{{{
     27#!div style="border: 1px solid #000000; font-size: 75%"
     28Add stuff required for advanced capability.
     29}}}
     30== "Search Phase"
     31=== "FCS-QL"
     32{{{
     33#!div style="border: 1px solid #000000; font-size: 75%"
     34New Section. \\
     35More subsections for this section?
     36}}}
     37=== Result Format
     38==== Resource and !ResourceFragment
     39==== Data View
     40===== Generic Hits (HITS)
     41===== Advanced (ADV)
     42{{{
     43#!div style="border: 1px solid #000000; font-size: 75%"
     44New section.
     45}}}
     46=== "Versioning and Extensions"
     47==== "Backwards compatibility statements"
     48{{{
     49#!div style="border: 1px solid #000000; font-size: 75%"
     50Say something about backwards compatibility with "basic-search"
     51}}}
     52==== Endpoint Custom Extensions
     53{{{
     54#!div style="border: 1px solid #000000; font-size: 75%"
     55Talk about extensions in general; this section needs to stay in normative part due to the namespace stuff
     56}}}
     57= CLARIN-FCS to SRU/CQL binding
     58== SRU/CQL
     59{{{
     60#!div style="border: 1px solid #000000; font-size: 75%"
     61SRU 2.0 requirement
     62}}}
     63== Operation ''explain''
     64{{{
     65#!div style="border: 1px solid #000000; font-size: 75%"
     66Basically stays the same, but adjust for advanced stuff.
     67}}}
     68== Operation ''scan''
     69{{{
     70#!div style="border: 1px solid #000000; font-size: 75%"
     71Basically stays the same, but adjust for advanced stuff (if required).
     72}}}
     73== Operation ''searchRetrieve''
     74{{{
     75#!div style="border: 1px solid #000000; font-size: 75%"
     76Align with newly introduced section "Search Phase" \\
     77Define String for SRU query-lanaguge paramater ("fcs"? "clarin-fcs"?)
     78}}}
     79= Normative Appendix
     80== List of extra request parameters
     81{{{
     82#!div style="border: 1px solid #000000; font-size: 75%"
     83Revisit and update as required; don't forget to add the new request parameter ("allow rewriting" => allow endpoint to trade precision in favor of recall).
     84}}}
     85== List of diagnostics
     86{{{
     87#!div style="border: 1px solid #000000; font-size: 75%"
     88Revisit and update as required; don't forget to add the 4 new diagnostics.
     89}}}
     90= Non-normative Appendix
     91== Syntax variant for Handle system Persistent Identifier URIs
     92== Referring to an Endpoint from a CMDI record
     93== Endpoint custom extensions
     94== Endpoint highlight hints for repositories
     95{{{
     96#!div style="border: 1px solid #000000; font-size: 75%"
     97All sections to be updated as required / maybe check if something should be deleted.
     98}}}