README

简介

此模块是 Islandora 项目的一部分，扩展了 Islandora IIIF 组件模块，以支持 IIIF 搜索结果注释。这为在图像查看器（如 Mirador）中通过 Islandora Mirador 模块对页面上的搜索结果进行高亮显示提供了后端支持。

使用 composer require born-digital/islandora_iiif_hocr 包含

尽管没有明确表达为硬性要求，但此模块假定使用 https://github.com/discoverygarden/islandora_hocr，包括安装和配置 solr-ocrhighlighting Solr 插件。

模块提供了一个视图样式插件，用于将搜索 API Solr 响应的结果格式化为 IIIF 注释格式。因此，设置它需要创建一个搜索视图。一个示例搜索视图位于此模块的 config/optional 文件夹中。

重要部分如下

创建一个媒体视图，并将格式化为 'IIIF 搜索结果注释'。
在样式插件设置中，选择在要附加到该搜索的 IIIF 清单中配置的媒体使用术语。通常为 '服务文件' 或 '原始文件'。
添加对 hOCR 的搜索过滤器，'全文 hOCR 搜索 (和)' 字段。在此过滤器的设置中，将过滤器标识符字段设置为 "search_hocr"。
设置排序标准，可以是相关性或按页面顺序显示结果的 field_weight。
设置带有 '%node' 组件的路径作为搜索端点。例如，paged-content-search/%node。注意此路径，因为它需要在 IIIF 清单视图设置中再次使用。
添加一个上下文过滤器为 '内容数据源：成员的'。这限制了搜索到正在进行的搜索的书籍。
在查询设置下，将 '查询标签字段' 设置为 'enable_hocr'。这很重要，因为它告诉此模块向搜索查询添加特定于 hOCR 的参数。
添加另一个用于单项搜索的显示，并取消上下文过滤器，以便仅搜索单个节点。

保存视图后，可以通过直接访问带有搜索参数的路径端点进行测试，例如，paged-content-search/%[some-book-nid]]?search_query_param="我的搜索"。

要使 Mirador 能够进行搜索，请返回 IIIF 清单的视图设置，并编辑 IIIF 清单样式插件设置。

现在有一个用于设置 Mirador（或支持 IIIF 搜索的另一个查看器）应使用的搜索端点的字段。¹ 输入您设置的路径，包括 %node，并保存。

有关 IIIF（国际图像互操作性框架）的更多文档可在 Islandora 8 文档站点上找到。

遇到问题？解决问题？加入 Islandora 通信渠道，发布问题和分享解决方案

Islandora 邮件列表（Google Group）
如果您想贡献代码或有问题，请通过参加我们每周的技术电话会议来参与，会议通过 Zoom 进行，每周三 下午1:00美国东部时间 举行，链接地址为 1:00pm Eastern Time US。任何人都可以参加并提问！Zoom 链接可以在会议纪要中找到，链接地址为这里。

如果您想向项目贡献代码，您需要签署 Islandora Foundation 的贡献者许可协议或企业贡献者许可协议。更多关于贡献者许可协议的信息，请参阅 islandora-community wiki 上的贡献者许可协议页面。