Download the PHP package born-digital/islandora_iiif_hocr without Composer
On this page you can find all versions of the php package born-digital/islandora_iiif_hocr. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download born-digital/islandora_iiif_hocr
More information about born-digital/islandora_iiif_hocr
Files in born-digital/islandora_iiif_hocr
Package islandora_iiif_hocr
Short Description Islandora support for hOCR markup in IIIF manifests
License GPL-2.0-or-later
Homepage https://github.com/Born-Digital-US/islandora_iiif_hocr
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package islandora_iiif_hocr
Islandora IIIF hOCR
Introduction
This module is part of the Islandora project and extends the Islandora IIIF component module to support IIIF search results annotations. This provides the back-end support for on-page highlighting of search results within image viewers such as Mirador via the Islandora Mirador module.
Installation
Include with composer require born-digital/islandora_iiif_hocr
Configuring Search Highlighting annotations
Although it is not expressed as a hard requirement, this module assumes tue use of https://github.com/discoverygarden/islandora_hocr, including the installation and configuration of the solr-ocrhighlighting Solr plugin.
Usage
The module provides a Views style plugin to format the results of a Search API Solr response in IIIF annotation format. Thus setting it up requires a search view be created. A sample search view is located in the config/optional folder of this module.
The important parts are:
- Create a Media view and set the formatter to 'IIIF Search Result Annotations'.
- In the style plugin settings, choose the Media Use term that is configured in the IIIF Manifest that this search will be attached to. Usually 'Service File' or 'Original File'.
- Add a search filter for the hOCR, 'Fulltext hOCR search (and )' field. In this filter's settings, thSet the Filter Identifier field to "search_hocr".
- Set a sort criteria, eitehr Relevance or, to make results appear in page order,, field_weight.
- Set a path with a'%node' component to be the search endpoint. e.g., paged-content-search/%node. Note this path as it's needed back in the IIIF Manifest view settings.
- Add a Contextual Filter for 'Content datasource: Member of'. This restricts the search to the book that the search is being done on.
- Under query settings, set 'the Query Tag field to 'enable_hocr'. This is important as it tells this module to add hOCR-specific parameters to the search query.
- Add another display for Single Item search, and leave off the contextual filter, so only the single node is searched.
After saving the view, it can be tested by going directly to the path endpoint with a search parameter added, e.g., paged-content-search/%[some-book-nid]]?search_query_param="My search"
To make Mirador be able to do searches, go back to the views settings for the IIIF Manifest, and edit the IIIF Manifest style plugin settings.
There is now a field for setting the search endpoint that Mirador (or another viewer that supports IIIF Search) should use.[^1] Put in the path you set above, including %node, and save.*
[^1]: Pending the merge of https://github.com/Islandora/islandora/pull/983
Documentation
Further documentation for IIIF (International Image Interoperability Framework) is available on the Islandora 8 documentation site.
Troubleshooting/Issues
Having problems? Solved a problem? Join the Islandora communication channels to post questions and share solutions:
- If you would like to contribute or have questions, please get involved by attending our weekly Tech Call, held virtually via Zoom every Wednesday at 1:00pm Eastern Time US. Anyone is welcome to join and ask questions! The Zoom link can be found in the meeting minutes here.
If you would like to contribute code to the project, you need to be covered by an Islandora Foundation Contributor License Agreement or Corporate Contributor License Agreement. Please see the Contributor License Agreements page on the islandora-community wiki for more information.
