PHPackages born-digital/islandora\_iiif\_hocr - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. born-digital/islandora\_iiif\_hocr ActiveDrupal-module born-digital/islandora\_iiif\_hocr ================================== Islandora support for hOCR markup in IIIF manifests 2.0.7(1y ago)019.0k—0%1[1 PRs](https://github.com/Born-Digital-US/islandora_iiif_hocr/pulls)1GPL-2.0-or-laterPHP Since Mar 1Pushed 1y ago1 watchersCompare [ Source](https://github.com/Born-Digital-US/islandora_iiif_hocr)[ Packagist](https://packagist.org/packages/born-digital/islandora_iiif_hocr)[ Docs](https://github.com/Born-Digital-US/islandora_iiif_hocr)[ RSS](/packages/born-digital-islandora-iiif-hocr/feed)WikiDiscussions 2.x Synced 1mo ago READMEChangelog (2)Dependencies (2)Versions (10)Used By (1) Islandora IIIF hOCR =================== [](#islandora-iiif-hocr) Introduction ------------ [](#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](https://github.com/ProjectMirador/mirador)via the [Islandora Mirador](https://github.com/islandora/islandora_mirador) module. Installation ------------ [](#installation) Include with `composer require born-digital/islandora_iiif_hocr` ### Configuring Search Highlighting annotations [](#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](https://github.com/discoverygarden/islandora_hocr), including the installation and configuration of the [solr-ocrhighlighting](https://github.com/dbmdz/solr-ocrhighlighting) Solr plugin. ### Usage [](#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](#user-content-fn-1-e640b2032934d6a9d59f178b09206c8a) Put in the path you set above, including %node, and save.\* Documentation ------------- [](#documentation) Further documentation for IIIF (International Image Interoperability Framework) is available on the [Islandora 8 documentation site](https://islandora.github.io/documentation/user-documentation/iiif/). Troubleshooting/Issues ---------------------- [](#troubleshootingissues) Having problems? Solved a problem? Join the Islandora [communication channels](https://www.islandora.ca/community#channels-of-communication) to post questions and share solutions: - [Islandora Mailing List (Google Group)](https://groups.google.com/g/islandora) - If you would like to contribute or have questions, please get involved by attending our weekly [Tech Call](https://github.com/Islandora/islandora-community/wiki/Weekly-Open-Tech-Call), held virtually via Zoom **every Wednesday** at [**1:00pm Eastern Time US**](https://dateful.com/convert/est-edt-eastern-time?t=13). Anyone is welcome to join and ask questions! The Zoom link can be found in the meeting minutes [here](https://github.com/Islandora/islandora-community/wiki/Weekly-Open-Tech-Call). If you would like to contribute code to the project, you need to be covered by an Islandora Foundation [Contributor License Agreement](https://github.com/Islandora/islandora-community/wiki/Onboarding-Checklist#contributor-license-agreements) or [Corporate Contributor License Agreement](https://github.com/Islandora/islandora-community/wiki/Onboarding-Checklist#contributor-license-agreements). Please see the [Contributor License Agreements](https://github.com/Islandora/islandora-community/wiki/Contributor-License-Agreements) page on the islandora-community wiki for more information. License ------- [](#license) [GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt) Footnotes --------- 1. Pending the merge of [↩](#user-content-fnref-1-e640b2032934d6a9d59f178b09206c8a) ### Health Score 35 — LowBetter than 80% of packages Maintenance39 Infrequent updates — may be unmaintained Popularity28 Limited adoption so far Community16 Small or concentrated contributor base Maturity47 Maturing project, gaining track record Bus Factor1 Top contributor holds 81.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~32 days Total 10 Last Release 518d ago Major Versions 1.0.0 → 2.0.02024-04-08 ### Community Maintainers ![](https://www.gravatar.com/avatar/507888823c4f3dc3538e2b734f9e1e2d29d37087ac3044c25b000dbbff725d58?d=identicon)[noahwsmith](/maintainers/noahwsmith) --- Top Contributors [![alxp](https://avatars.githubusercontent.com/u/82412?v=4)](https://github.com/alxp "alxp (31 commits)")[![dannylamb](https://avatars.githubusercontent.com/u/20773151?v=4)](https://github.com/dannylamb "dannylamb (3 commits)")[![noahwsmith](https://avatars.githubusercontent.com/u/39922?v=4)](https://github.com/noahwsmith "noahwsmith (2 commits)")[![patdunlavey](https://avatars.githubusercontent.com/u/241240?v=4)](https://github.com/patdunlavey "patdunlavey (2 commits)") --- Tags drupalIslandoraiiif ### Embed Badge ![Health badge](/badges/born-digital-islandora-iiif-hocr/health.svg) ``` [![Health](https://phpackages.com/badges/born-digital-islandora-iiif-hocr/health.svg)](https://phpackages.com/packages/born-digital-islandora-iiif-hocr) ``` ### Alternatives [composer/installers A multi-framework Composer library installer 1.4k136.0M6.0k](/packages/composer-installers)[drupal/drupal-extension Drupal extension for Behat 22215.1M147](/packages/drupal-drupal-extension)[drupal/core-composer-scaffold A flexible Composer project scaffold builder. 5341.9M446](/packages/drupal-core-composer-scaffold)[palantirnet/drupal-rector Instant fixes for your Drupal code by using Rector. 1544.2M20](/packages/palantirnet-drupal-rector)[drupal/drupal-driver A collection of reusable Drupal drivers 6715.8M18](/packages/drupal-drupal-driver)[drupal/core-project-message Adds a message after Composer installation. 2122.6M172](/packages/drupal-core-project-message) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)