Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update hOCR docs #45

Merged
merged 8 commits into from
Jul 31, 2024
Merged

Update hOCR docs #45

merged 8 commits into from
Jul 31, 2024

Conversation

joecorall
Copy link
Member

@joecorall joecorall commented May 9, 2024

What does this Pull Request do?

The hOCR derivative docs conflict with expectations implied in the islandora_hocr module. Namely - the hOCR derivative XML needs to be a standalone media entity tagged with the hOCR media use term created by DGI's islandora_hocr module, not an additional file field added to an existing media entity like these docs specify.

What's new?

How should this be tested?

Documentation Status

  • Does this change existing behaviour that's currently documented?
  • Does this change require new pages or sections of documentation?
  • Who does this need to be documented for?
  • Associated documentation pull request(s): ___ or documentation issue ___

Additional Notes:

Interested parties

Tag (@ mention) interested parties or, if unsure, @Islandora/committers

@joecorall joecorall marked this pull request as ready for review June 20, 2024 19:38
@joecorall joecorall requested a review from a team June 20, 2024 19:38
README.md Outdated
3. Add
```
<searchComponent
class="solrocr.OcrHighlightComponent"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not necessary if you set a variable in your docker-compose.yml:

In build/docker-compose/docker-compose.drupal.yml in the environment section, add

SOLR_HOCR_PLUGIN_PATH: ${SOLR_HOCR_PLUGIN_PATH}

Then when make solr-cores runs, the necessary config settings for hOCR will be generated by islandora_hocr.

see it in this branch:
https://github.com/Islandora-Devops/isle-dc/blob/solr-hocr/build/docker-compose/docker-compose.drupal.yml

Copy link
Member Author

@joecorall joecorall Jun 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see SOLR_HOCR_PLUGIN_PATH defined anywhere in the Solr OCR Highlighting plugins' install docs. IIUC if the plugin is placed in a common solr lib directory it will automatically get loaded.

That being said, I have not tested a solr instance without this setting - I added it per their install instructions. I'll see if this is maybe not needed with the plugin getting loaded.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's read by islandora_hocr, if it sees that environment variable, it will add all of the configs needed to load the ocr highlighting library when you download the Solr configs from Drupal.

Copy link
Member Author

@joecorall joecorall Jul 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alxp - I updated the docs to reflect this. Once Islandora-Devops/isle-buildkit#345 merges I think we can merge this PR

@joecorall joecorall requested a review from alxp July 30, 2024 13:33
Copy link
Member

@nigelgbanks nigelgbanks left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-Looks good, just gonna test locally- whoops wrong window.

Copy link
Contributor

@alxp alxp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for doing this.

@alxp alxp merged commit ce24afa into 2.x Jul 31, 2024
@alxp alxp deleted the update-hocr-docs branch July 31, 2024 00:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants