wiki:Taskforces/FCS/FCS-Specification-Draft

Version 2 (modified by Oliver Schonefeld, 9 years ago) (diff)

--

NOTE: This page is work-in-progress. Final draft is scheduled to be delivered by 2015-10-31.

CLARIN Federated Content Search (CLARIN-FCS) - Core 2.0

Introduction

Terminology

Glossary

Normative References

Non-Normative References

Typographic and XML Namespace conventions

All sub-sections to be updated as required.

CLARIN-FCS Interface Specification

"Discovery Phase"

Capabilities

Add and describe advanced capability.

Endpoint Description

Add stuff required for advanced capability.

"Search Phase"

"FCS-QL"

New Section.
More subsections for this section?

Result Format

Resource and ResourceFragment

Data View

Generic Hits (HITS)
Advanced (ADV)

New section.

"Versioning and Extensions"

"Backwards compatibility statements"

Say something about backwards compatibility with "basic-search"

Endpoint Custom Extensions

Talk about extensions in general; this section needs to stay in normative part due to the namespace stuff

CLARIN-FCS to SRU/CQL binding

SRU/CQL

SRU 2.0 requirement

Operation explain

Basically stays the same, but adjust for advanced stuff.

Operation scan

Basically stays the same, but adjust for advanced stuff (if required).

Operation searchRetrieve

Align with newly introduced section "Search Phase"
Define String for SRU query-lanaguge paramater ("fcs"? "clarin-fcs"?)

Normative Appendix

List of extra request parameters

Revisit and update as required; don't forget to add the new request parameter ("allow rewriting" => allow endpoint to trade precision in favor of recall).

List of diagnostics

Revisit and update as required; don't forget to add the 4 new diagnostics.

Non-normative Appendix

Syntax variant for Handle system Persistent Identifier URIs

Referring to an Endpoint from a CMDI record

Endpoint custom extensions

Endpoint highlight hints for repositories

All sections to be updated as required / maybe check if something should be deleted.

Attachments (1)

Download all attachments as: .zip