discoverygarden/iiif_content_search_api

v1.1.0 2024-03-07 16:10 UTC

This package is auto-updated.

Last update: 2024-05-08 15:22:32 UTC


README

Introduction

IIIF Content Search API V1 and V2 implementations. Integrates with the IIIF Presentation API module to provide search and highlighting functionality.

Requirements

This module requires the following modules/libraries:

Suggested (at least to reference) are:

Configuration

Configuration is presented performed via environment variables.

Variable Default Description
IIIF_CONTENT_SEARCH_INDEX_ID default_solr_index The index in which to search.
IIIF_CONTENT_SEARCH_HIGHLIGHTING_FIELD islandora_hocr_field The field of the index in which to attempt to perform highlighting.
IIIF_CONTENT_SEARCH_ANCESTOR_FIELD field_ancestors The field of the index to filter using the ID relative to which the given query is to be performed, for searching with structured content (such as paged content).
IIIF_CONTENT_SEARCH_DOC_ID_FIELD nid Field of the index to search for the item proper, should it contain any highlight response. (Only relevant when searching on a particular page/image)

Installation

Install as usual, see this for further information.

Troubleshooting/Issues

Having problems or solved a problem? Contact discoverygarden.

Maintainers/Sponsors

This project has been sponsored by:

Sponsor:

Development

If you would like to contribute to this module, please check out our helpful Documentation for Developers info, Developers section on Islandora.ca and contact discoverygarden.

License

GPLv3