Git Product home page Git Product logo

europeana-blacklight's Introduction

Europeana::Blacklight

Build Status Security Maintainability Test Coverage

Ruby gem providing an adapter to use the Europeana REST API as a data source for Blacklight.

Usage

See the Quick Start Guide.

Features

Supported Blacklight features

  • Search
  • View record
  • Pagination of search results
  • Field facets
  • Query facets
  • Facet limits
  • Fielded search
  • Bookmarks
  • Range queries

Unsupported Blacklight features

  • Result sorting :(
  • "Did you mean" spellcheck
  • MLT Solr-style (but see custom features)

Custom features

  • Nested EDM field names
  • MLT by record ID in :mlt URL parameter
  • Query facets with arbitrary API parameters

Query facets

In the configuration for query facet fields, the :fq option is a Hash, to permit specification of multiple parameters to be passed to the API:

configure_blacklight do |config|
  config.add_facet_field 'Cities (reusable content)', query: {
    paris: { label: 'Paris', fq: { qf: 'paris', reusability: 'open' } },
    berlin: { label: 'Berlin', fq: { qf: 'berlin', reusability: 'open' } }
  }
end

Warning: query facets are achieved by sending additional queries to the API. If you configure 2 query facets each with 10 facet values, this will result in an additional 20 queries being sent to the API.

License

Licensed under the EUPL v1.2.

For full details, see LICENSE.md.

europeana-blacklight's People

Contributors

lbiedinger avatar rwd avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

bhanditz telezoic

europeana-blacklight's Issues

API dependency?

Hi! Following the rules as written in the quickstart, I've gotten the error of "uninitialized constant Europeana::API" on initial load of the Rails server. Is there another dependency required in order to get this running, such as setting an API secret key credential within the application or a system install of the europeana-api Ruby client?

Thanks much!

Ashley

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.