Summary

Review the css files in iiif_print and remove the unnecessary/un-usued files.

Acceptance Criteria

• Review the following scss files:
  • ./app/assets/stylesheets/iiif_print/_issue_search.scss
  • ./app/assets/stylesheets/iiif_print/_issues_calendar.scss
  • ./app/assets/stylesheets/iiif_print/_search_results.scss
  • ./app/assets/stylesheets/iiif_print/_newspapers_search.scss
  • ./app/assets/stylesheets/iiif_print/_iiif_print.scss
  • ./lib/generators/iiif_print/templates/iiif_print.scss
• Remove any classes/ids not being used

Summary

File now exists, but needs to be made functional. Specifically for IIIF manifest 2 and 3

ref: https://github.com/scientist-softserv/iiif_print/blob/main/lib/generators/iiif_print/templates/manifest_builder_service_decorator.rb

Indiana is open to upgrading their manifest.

Heads Up: Indiana has a configuration to pull in the metadata into the manifest. This will need some work, and we also may need to consider how it will work with AllinsonFlex.

The end goal is for the UV to display the way that LV has it.

Acceptance Criteria

• When looking at the works show page, works with metadata should display their metadata in the Universal Viewer right side panel

Screenshots or Video

Testing Instructions

https://demo.hyku-iiif.notch8.cloud/

• Create a work with some metadata properties
• Navigate to its show page
• Open the right side panel and confirm the metadata shows up

Notes

• AllinsonFlex handling will need to be apart of a different ticket #298
• Essi uses this implementation where it seems there is select metadata to be displayed
• Essi's implementation does not support facetable links fro the UV metadata panel
• Essi uses IIIF Presentation Manifest V2 which is the Hyrax 2x default, while UTK (on Hyrax 3x) uses IIIF Presentation Manifest V3

Summary

The order of the works that are displayed in the items partial in the work show page does not always match the way the UV's display order.

Acceptance Criteria

• Both UV and items partial show the same order

Screenshots or Video

Testing Instructions

• A dev should set the sort_iiif_manifest_canvases_by to :date_created in the configuration
• Deploy the branch
• The tester should import this CSV via Bulkrax sw.csv
• Confirm that the items at the bottom of the show page displays in the same order as the UV

Summary

• figure out use of or remove ensure_title
• instead of keying off Newspaper issue class, check if class includes a SplitPdf concern. create such a concern

Acceptance Criteria

• [ ]

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

Acceptance Criteria

• The application that IIIF Print is installed on should have the Hyrax 3+ implementation of universal viewer

Screenshots or Video

Testing Instructions

• navigate to a work show page that has an image
• confirm Universal Viewer loads

Notes

Confused how to fill this out? Check out the playbook

Summary

exclude_models should be configurable.

Acceptance Criteria

• A developer should be able to exclude certain models from search within the application

Screenshots or Video

https://drive.google.com/file/d/1b9gK-eA5wih1GDiT4PCwFRKEGWo_PC4_/view?usp=share_link

Testing Instructions

• Add 'Image' to the excluded work from the config
  • eg. config.models_to_be_excluded_from_search = [] in config\initializers\iiif_pring.rb within your Hyku application
• Search for the Image
• Confirm it does not show up

Notes

Confused how to fill this out? Check out the playbook

Put into gemfile, bundle and run generator

Summary

We currently don't have a way to select what type of derivatives to make.

ie: "for this work type, only make tiffs and not pdfs" or "don't OCR"...

There is currently no way to turn this on and off for a given class.

Acceptance Criteria

• a user should be able to select what types of derivatives a work type should create

Testing Instructions

• if a user turns a type of derivative off, the create derivatives job should not make that type of derivative for that particular work type
• Perhaps all derivative types should get created by default?
• Example scenarios to test:

As developer

I want to create all derivatives available from IIIF Print for my Image work type:

# Image model
class Image < ActiveFedora::Base
  include IiifPrint.model_configuration
end

I want to create just TIFF derivatives:

class Image < ActiveFedora::Base
  include IiifPrint.model_configuration(
    derivative_service_plugins: [
      IiifPrint::TIFFDerivativeService
    ]
  )
end

I want to create all JP2, PDF, and text derivatives but not TIFF:

class Image < ActiveFedora::Base
  include IiifPrint.model_configuration(
    derivative_service_plugins: [
      IiifPrint::JP2DerivativeService,
      IiifPrint::PDFDerivativeService,
      IiifPrint::TextExtractionDerivativeService
    ]
  )
end

• once adjusted, deploy the application to staging and create a new Image
• go to the show page and down below in the items partial, see that the download options match expectations

Summary

This appears to be broken. This ticket is to figure out why. Did we miss porting over necessary code from LV? (#iiif_search is missing in iiif_print)

Is full or all text getting indexed? etc...

Acceptance Criteria

• From any work's UV, when a user searches for text of a PDF/image and there's a match, it should be highlighted in the UV
• From the Parent UV, when a user searches for OCR it's child's PDF/image and there's a match, it should be highlighted in the UV

Highlighted in UV means that the word will be highlighted in the image it matches with. Additionally, a blue box will be highlighted in the left pane, of the matched work. Examples from LV:

Screenshots or Video

Testing Instructions

1. Create a work. Upload an image that has text. OCR should run. Confirm that json coordinates are created as its derivatives. Confirm that a user can search for the text in the UV, and find a match.
2. Create a work. Attach a child. Confirm that a user can visit the parent's UV, search for the child's metadata and find a match.

Notes

The commits in Louisville that worked towards this are:

• scientist-softserv/louisville-hyku@128a9ef — i149 - fix timing issue that cause child ocr search bug Shana Moore, (2022-09-21)
• scientist-softserv/louisville-hyku@50489ac — 90-ocr-highlighting Alisha Evans, (2022-05-12)
• scientist-softserv/louisville-hyku@211e888 — i19 - pull in uv configs from nnp to enable ocr search Shana, (2022-01-26)

maybe helpful refs:

1. https://gitlab.com/notch8/louisville-hyku/-/merge_requests?scope=all&state=merged&search=ocr

If things aren't working, try...

ActiveFedora::Base.reindex_everything

Summary

Acceptance Criteria

• [ ]

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

ref LV: https://github.com/scientist-softserv/louisville-hyku/blob/main/app/services/newspaper_works/data/work_files_decorator.rb

compare to iiif_print: https://github.com/scientist-softserv/iiif_print/search?q=commit_assigned

redefine method in iiif_print to match LV

Summary

Verify the readme instructions for testing is comprehensible.

Acceptance Criteria

• A dev should be able to follow the documentation on testing, and be able to get the specs running.

Screenshots or Video

Testing Instructions

Notes

https://github.com/scientist-softserv/iiif_print#developing-testing-and-contributing

Ask for pairing when needed.

ref UTK's pipeline setup: https://github.com/scientist-softserv/utk-hyku/blob/main/.github/workflows/build-test-lint.yaml

WIP branches:

ACTIONS REPO:

iiif-v6: scientist-softserv/actions#26
iiif-v3plus5: scientist-softserv/actions#27

IIIFPRINT REPO:

v6: scientist-softserv/actions#26
v3plus5: #56

ERROR:

Run actions/checkout@v3
Error: Input required and not supplied: token

IIIF Print bulkrax imports do not work with remote PDF files. They create the parent work and fileset only.

The following file should be imported into a parent GenericWork AND ALSO create a child Image TIFF work.

i97-sample-remote-fileset.csv

Note: a CSV with the remote url in the GenericWork row will NOT work. This would require changes to bulkrax.

Summary

The MetadataBuilderService should also handle IIIF version 3 manifests as well.

Acceptance Criteria

• Metadata is shown for items on a version 3 manifest

Screenshots or Video

Testing Instructions (test w BL)

• Navigate to a work has an image that you can see in the Universal Viewer
• Open the right side panel and confirm there is metadata
• in the URL append /manifest.json (delete any locale stuff)
• confirm in the context that is is a presentation/3/context.json

Summary

spin off ticket from i37

The parent UV does not render when it doesn't have filesets. It should still render if it has children.

Acceptance Criteria

• If a parent work has no files && has children (with filesets), it should still render in the parent's UV.

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

Is full or all text getting indexed? etc...

Acceptance Criteria

• When a user performs a catalog search for OCR, the parent should return. ref: https://gitlab.com/notch8/louisville-hyku/-/merge_requests/137#a79adb1024bf4a71a325bf3ac94b212477013dae

Screenshots or Video

Testing Instructions

Deploy i87-ocr-search to hyku-iiif (hyku branch) ✅ visit: demo.hyku-iiif.notch8.cloud/

1. Create a work. Upload an image that has text. OCR should run. Confirm that json coordinates are created as its derivatives. Confirm that a user can search for the text in the UV, and find a match.
2. Create a work. Attach a child. Confirm that a user can visit the parent's UV, search for the child's metadata and find a match.
3. A user should able be able to catalog search the child metadata and have its parent return
4. A user should be able to catalog search the child's ocr term and have its parent return

Notes

The commits in Louisville that worked towards this are:

• scientist-softserv/louisville-hyku@128a9ef — i149 - fix timing issue that cause child ocr search bug Shana Moore, (2022-09-21)
• scientist-softserv/louisville-hyku@50489ac — 90-ocr-highlighting Alisha Evans, (2022-05-12)
• scientist-softserv/louisville-hyku@211e888 — i19 - pull in uv configs from nnp to enable ocr search Shana, (2022-01-26)

maybe helpful refs:

1. https://gitlab.com/notch8/louisville-hyku/-/merge_requests?scope=all&state=merged&search=ocr

If things aren't working, try...

ActiveFedora::Base.reindex_everything

ref #62

Summary

ref LV: https://github.com/scientist-softserv/louisville-hyku/blob/42a0fc837fd9ef4832a9741731672200e0097305/app/presenters/hyrax/iiif_manifest_presenter.rb

ref HYKU: https://github.com/samvera/hyku/blob/main/app/presenters/hyrax/iiif_manifest_presenter_decorator.rb

Compare the differences between these two files and decide which one we should take.

We also may also need to take account the difference between Hyrax and Hyku. Site.account is hyku specific since Hyrax doesn't have concept of tenants.

Acceptance Criteria

• [ ]

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

verify that running the generators gets you all the needed adjustments for iiif search found in lousiville app/controller/catalog_controller.rb

Acceptance Criteria

• [ ]

Screenshots or Video

Testing Instructions

Notes

Implementation suggestion:

run the generator from iiif print main on a clean hyku and then compare the CatalogController of each spot and take note of the diff.

ManifestBuilderServiceBehavior needs to have some rspec tests.

https://github.com/scientist-softserv/louisville-hyku/blob/main/lib/tasks/set_parent_thumbnail.rake

ref #43 #77

create spec model and configuration for the specs we run. clean up spec helper.

• https://github.com/scientist-softserv/louisville-hyku/blob/42a0fc837fd9ef4832a9741731672200e0097305/app/presenters/hyku/work_show_presenter.rb#L65-L73 <- methods are defined in LV but aren't being used 🤔

Attempt to answer why these methods exist. Is it necessary to keep or transfer over to iiif_print?

• is it related to this?

Next Steps

Close this ticket if these methods are not required, or after creating a new ticket that'll implements them in iiif_print.

ref: https://github.com/scientist-softserv/louisville-hyku/blob/42a0fc837fd9ef4832a9741731672200e0097305/app/presenters/hyrax/work_show_presenter_decorator.rb

Compare to hyrax/hyku's version to spot the differences.

parent/child relationships should display properly.

This view file uses this method which will probably need to be moved over as well

Summary

Use a Gem to identify which translations are not being used. We will want to remove them and re run the generator to translate. You should only have to focus on removing the english translations.

I suspect the translator generator will be based of of the english locale file, meaning that if translations get removed there it will automatically remove them from other languages.

Acceptance Criteria

• all unnecessary translations will no longer exist in the project
• re run translations to update non-english locale files

Testing Instructions

This issue may not be testable from a QA perspective, besides ensuring that nothing is broken after its done. For example, there should be no missing translation errors anywhere.

Notes

a GOOGLE_API_KEY is needed to run the translator. You can find this in 1password, however, I believe it may need to get updated.

The last time it was used, we received a message that we reached the maximum usage threshold. See Kirk/BL.

Summary

Currently, only NewspaperPage can use NewspaperPageDerivativeService.

We would like to generalize this and be able to choose which class can use the service. The class should be configurable.

Acceptance Criteria

• Make NewspaperPageDerivativeService configurable.

Testing Instructions

When a PDF doesn't have the appropriate information, the PagesIntoImagesService cannot break it into TIFFs.

The service defines invalid_pdf? which specifies all of the information which is needed by the service. This method could be put into use somewhere in ChildWorksFromPdfJob to prevent the job from indefinitely retrying due to the error, and possibly reporting the error as well.

Summary

It's far to easy to accidentally submit PRs against the Newspaper Gem. We need to break the fork so that by default, PRs get submitted to IiifPrint repo.

Acceptance Criteria

• PRs get merged into IiifPrint repo by default.

Screenshots or Video

Testing Instructions

Notes

community/community#11729 (comment)

Summary

The MetadataBuilderService should also handle metadata properties that were generated from AllinsonFlex in both version 2 and version 3 manifests.

Acceptance Criteria

• Metadata is shown for items on an application with AllinsonFlex installed.

Screenshots or Video

Testing Instructions (UTK staging)

In an application installed with AllinsonFlex

• Navigate to a work with an image that shows in the Universal Viewer
• Check that the metadata is showing in the right panel
  • Add a few more metadata to other properties to double check it works

THIS SHOULD BE TESTED LOCALLY

This ticket is meant to be done towards the end of the iiif_print epic

We want to confirm that the generator does everything it needs to, when installing iiif_print onto a hyrax/hyku project.

• Test generator by installing iiifprint on hyku main
• We ultimately will be merging iiif_print into hyku so this ticket can be treated as a 2 for 1. (as in tested generator locally and confirm all is good, but also make a PR out of it).

NOTES:

#121 Generator Refactor

Screenshots / Video

Tested on https://demo.hyku-iiif.notch8.cloud

Sample Files:

Expected Behavior

User should be able to perform all that's listed in the features list's user story tab

Testing Instructions

A user should perform all that is defined in the user story tab of the Features List

Summary

Replace iiif_print's Indexes_relationship with louisville's implementation.

ref set_child_flag.rb

Acceptance Criteria

• IndexesRelationships is replaced by more flexible relationship indexing

Testing Instructions

• after importing a csv w parent/children, check the is_child property on the children via the rails console. It should exist and it should be set to true.

Treat this checklist as a spike. Do the investigation pieces and then move anything with substantial work it its own ticket.

Notes

ref #6

Acceptance

New tickets are made for any substantive work and the trivial stuff is done.

Checklist

• do we need to bring over config/initializers/iiif_manifest.rb from Louisville?
  • looks like an override just to make sure all manifests have a viewingHint of paged, I don't think we want this
• hydra derivative image decorator override should be pushed to image processors
  • this override has already been made
• port lib/rdf/custom_is_child_term.rb from Louisville
  • #10
• set_child_works.rake from lousiville
  • #10
• do we need the modifications from def manifest and def iiif_manifest_presenter found in app/controllables/concerns/hyrax/works_controller_behavior.rb?
  • #manifest was changed because of this and it looks like #iiif_manifest_presenter is passing in curation_concern_from_search_results which is being deprecated
• Louisville has a app/helpers/newspaper_works_helper.rb did a iiif_print version get created by the generator?
  • yes
• get all_decendant-file_sets and ancestor_ids from app/indexers/app_index.rb and put it in iiif_print indexer mixin
  • #10
• get app/indexers/hyrax/file_set_indexer and put it in a iiif_print mixin
  • #10
• port app/models/concerns/set_child_flag to iiif_print, include in work types
  • #10
• #26
  • doesn't look like it
• #27
  • seems like it would be useful, not sure where else to put it if not in the helper
• #28
  • i think the more the gem can handle the better
• #29
  • Alisha said these came from hyrax 3
• #30
• #31
• #32
• #33
• #34
• #35
• #36
• #37
• #38

Summary

Confirm that Full Text Search is working. Record findings. Close this ticket if:

1. it's working
2. it's not working but implementation tickets have been created

Acceptance Criteria

• When a user searches for text of a PDF/image and there's a match, it should be highlighted in the UV
• When a user searches for child metadata and there's a match, it should be highlighted in the UV

Screenshots or Video

Testing Instructions

1. Create a work. Upload an image that has text. OCR should run. Confirm that json coordinates are created as its derivatives. Confirm that a user can search for the text in the UV, and find a match.
2. Create a work. Attach a child. Confirm that a user can visit the parent's UV, search for the child's metadata and find a match.

Notes

Confused how to fill this out? Check out the playbook

Summary

ref: #66

Acceptance Criteria

• IiifPrint's wiki should reflect the Features List decision spreadsheet

Screenshots or Video

Testing Instructions

Notes

Summary

Acceptance Criteria

• Determine if the generator made changes to app/views/hyrax/file_sets
• IF SO...
• IF NOT...

DONE looks like...

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

This ticket got created in response to Kirk's PR: #80 (review)

He brought over a decorator from LV which included an override for #total_pages.

Research why this method was overridden and decide whether or not we want to implement the same for iiif_print

Acceptance Criteria

• Close this ticket if, after research, we decide this is not needed or we create a new implementation ticket

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

IIIF Print bulkrax imports do not work when the parent work and fileset information in the csv are in separate rows. The iiif print actor does not trigger when the parent work is created because there are no attached files. We need to identify how to trigger it as the file sets are created without affecting the functionality of normal processing of the parent and files together.

The following file should be imported into a parent GenericWork AND ALSO create a series of child Image TIFF works.

i98-sample.zip

Note: This should also work for remote PDF urls in a separate row once Make IIIF Print split remote PDF URLs in Bulkrax is working.

Write up what this gem should do, its features, and what's configurable.

Summary

Make a helpful readme for this gem. Considering using referencing this template for inspiration.

Please also include a section for configurations and Hyrax.

Acceptance Criteria

A dev should be able to apply this gem to their hyku/hyrax projects with little to no questions.

Testing Instructions

Recruit an unfamiliar dev to install this gem in hyku proper.

Summary

Clean up specs.

There's a lot of unused and failing specs due to us taking some but not all pieces of code from the newspaper gem.

Additionally, partially due to the mess, please also review the spec coverage for the new features.

Acceptance Criteria

• Goal is 80% coverage per samvera labs' standards (fact check this)

Screenshots or Video

Testing Instructions

Notes

We are unable to deploy to hyku-iiif, so #83 is blocked from testing

https://github.com/samvera/hyku/actions/runs/4078008949/jobs/7028968231

 Error: UPGRADE FAILED: release hyku-*** failed, and has been rolled back due to atomic being set: client rate limiter Wait returned an error: context deadline exceeded

Summary

Verify that there are specs before closing out the iiif_print tickets for SoftServe QA. These tickets are not quite QA-able and their behaviors will be covered by a test plan.

Acceptance Criteria

Does each PR have a good spec? ref: https://github.com/orgs/scientist-softserv/projects/43/views/1?filterQuery=label%3Aiiif_print+status%3A%22SoftServ+QA%22

If so

• move ticket to done

if not

• add specs and leave a comment noting the ticket number that got updated.

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

CreateIssuePageJob should be more generic.

class method that should take an argument of what type of class it should split it into. ie #split_pdf_into("Book")

Currently the newspaper gem doesn't give you a choice. All created children are type NewspaperPage.

ref: https://github.com/samvera-labs/newspaper_works/blob/bbe8736b0cf622d9c2577faf7a6f0a4e8dd1452c/lib/newspaper_works/ingest/newspaper_issue_ingest.rb#L41

Acceptance Criteria

• CreateIssuePageJob is more generic
• #split_pdf_into takes an argument of a work type

Summary

Ask Diem to share template for test plan
Ask Rob to review test plan

Acceptance Criteria

• [ ]

Screenshots or Video

Testing Instructions

Notes

Confused how to fill this out? Check out the playbook

Summary

ref: #11 and #83

We spun off this ticket to unblock the rest of the iiif_print work. Specs are marked with # TODO

Acceptance Criteria

Complete following specs:

• spec/lib/iiif_print/jobs/child_works_from_pdf_job_spec.rb
• spec/lib/iiif_print/jobs/create_relationship_job_spec.rb
• spec/lib/iiif_print/split_pdfs/pages_into_images_service_spec.rb
• Consider merging spec/support/iiif_print_models.rb with misc_shared.rb for more functional test fixtures, and adjust other specs using the models.