wiki:FCS-Specification-ScrapBook

Version 3 (modified by oschonef, 10 years ago) (diff)

--

FCS Specification Scrapbook

Issues with current document

  1. Uncomprehensible and not well structures :(
  2. Resource enumeration (aka scan on fcs.resource) rather complex and unintuitive
  3. Basic KWIC records has no provision for multiple "highlight" hits
  4. Clear recommendation for using Resource and ResouceFragment

General ideas / design goals towards better specification

  1. Define FCS conformance level independent of what SRU/CQL do. Don't call them "level", but maybe something like profile to avoid confusion.
    1. Do a basic profile first
    2. Do an advanced/extend profile later in a separate specification or specification amendment (which must be, of course, compatible to basic profile)
    3. Add provisions to, e.g. explain output, to allow endpoints to indicate the profile, they support
  2. Better structure of document (and don't include aggregation stuff; that's a different specification; implementors of endpoints should not need to worry about aggregator implementation)
  3. Keep XML sanity always in mind (so there are no namespace issues as in CMDI)
  4. Honor and use extension hooks provided by SRU/CQL

Proposal for new specification

The following is a proposal for a revisited federated content search specification. When done, cut and paste to the appropriate section of the Wiki and publish on the CLARIN web page.

CLARIN Federated Content Search (CLARIN-FCS)

  1. FCS Specification Scrapbook
    1. Issues with current document
    2. General ideas / design goals towards better specification
    3. Proposal for new specification
  2. CLARIN Federated Content Search (CLARIN-FCS)
    1. Introduction
      1. Glossary
      2. Profiles
    2. SRU/CQL
      1. Explain
      2. Scan
      3. SearchRetrieve

Introduction

The key words MUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, MAY, and OPTIONAL in this document are to be interpreted as described in ​RFC 2119.

This documents describes ...

Glossary

Aggregator
write def
CLARIN-FCS, FCS
CLARIN federated content search
Endpoint
write def
Search Engine
write def
SRU
Search and Retrieve via URL, is a protocol for Internet search queries
CQL
Contextual Query Language, previously known as Common Query Language, is a formal language for representing queries to information retrieval systems such as search engines, bibliographic catalogs and museum collection information
Data View
write def
PID
persistent identifier, write more

Profiles

Yada yada yada ...

SRU/CQL

Yada yada yada ...

Explain

Yada yada yada ...

Scan

Yada yada yada ...

SearchRetrieve

Yada yada yada ...