-
Notifications
You must be signed in to change notification settings - Fork 9
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
Update hOCR docs #45
Conversation
README.md
Outdated
3. Add | ||
``` | ||
<searchComponent | ||
class="solrocr.OcrHighlightComponent" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this 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.
There was a problem hiding this 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.
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'sislandora_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
Additional Notes:
Interested parties
Tag (@ mention) interested parties or, if unsure, @Islandora/committers