ARC-184 - migrate PDF building by respinos · Pull Request #107 · mlibrary/boxwalker

respinos · 2026-09-11T17:01:29Z

Tips for running the rake tass

clear out existing artifacts with find data/pdf -type f | xargs rm
run the generator with the following to see the details

RAILS_ENV=development FINDING_AID_DATA=$PWD/data EADID=umich-wcl-M-54ger bin/rails arclight:generate_pdf --trace

this adds some fields to the solr document, but those should be ignored if not present

Summary

Adds/updates Arclight fragment rendering and utility styling for component details/print views in:

_component_details.html.erb
_components.html.erb
_utility_styles.html.erb
fragment.html.erb

Adds a print stylesheet and asset manifest/config adjustments for the new UI output:

print.scss
manifest.js
assets.rb

Updates catalog/solr/EAD config plumbing for the new component/package behavior:

catalog_controller.rb
catalog.rb
solr_document.rb
ead2_config.rb
generate.rake

rshiggin · 2026-09-14T18:06:28Z

I'm working on testing this PR. First pass wasn't successful. Trying again with zeroed out data dir.

ssciolla

I started going through this, but am not finished yet. Comments are mostly cleanup. Feel a little iffy on the platform-checking stuff -- maybe we just don't support generate when it's not on Linux/in a container?

rshiggin

My testing was successful, once I'd zeroed out and recreated the XML and PDF derivatives.

respinos · 2026-09-14T18:45:43Z

I started going through this, but am not finished yet. Comments are mostly cleanup. Feel a little iffy on the platform-checking stuff -- maybe we just don't support generate when it's not on Linux/in a container?

It's iffy in the long tradition of platform #ifdef ¯_(ツ)_/¯ This is fine and wkhtmltopdf should not be the long term solution.

ssciolla · 2026-09-15T15:48:51Z


-      doc.css("#summary dl").first << fragment.css("dl#ead_author_block dt,dl#ead_author_block dd")
-      if (contents_el = doc.css("div.al-contents").first)
+      doc.css("html").first["class"] = ""


Was there a class that needed to be removed?

OTOB there are no-js classes until javascript loads. Do the updated styles use this for anything? Undocumented, and early PDFs were turning out blank.

ssciolla

Sorry, more irksome comments. Going to run it now and then likely approve.

ssciolla · 2026-09-15T16:41:26Z

+        <% if component.collection_has_requestable_components? %>
+          <% if component.is_checkbox_requestable? %>
+            <div class="checkbox request-checkbox">
+              <label class="btn btn-outline-secondary btn-outline-request contents-action">
+                <input type="checkbox" name="Request" value="<%= component.id %>">
+                <input type="hidden" name="Request" value="<%= component.id %>">
+                <input type="hidden" name="ItemSubTitle_<%= component.id %>" value="<%= component.aeon_item_sub_title_value %>">
+                <input type="hidden" name="ItemVolume_<%= component.id %>" value="<%= component.aeon_item_volume_value %>">
+                <input type="hidden" name="ItemCitation_<%= component.id %>" value="<%= component.aeon_item_citation_value %>">
+                <% if component.aeon_item_sub_title_value.present? %>
+                  <span class="request-checkbox-label" aria-hidden="true"><%= component.aeon_item_sub_title_value %></span>
+                <% end %>
+                <span class="visually-hidden">Request "<%= component.aeon_item_sub_title_visually_hidden %>"</span>
+              </label>
+            </div>
+          <% else %>
+            <%# <span style="padding: 0.375rem 1rem;"><i class="text-blended fas fa-circle"></i></span> %>
+          <% end %>
+        <% end %>


If fragment stuff is only ever used by the HTML and PDF derivatives, then do we need the Aeon stuff in there?

And can we remove the else if it's commented out?

That's a great question, and IMHO beyond the scope of this PR. But I am team "time we spend on this wkhtmltopdf code is better spent figuring out what can replace it."

ssciolla · 2026-09-15T16:46:49Z

+  # desc 'Generate packages for indexed finding aids via background jobs'
+  # task generate_enqueue: :environment do
+  #   args = {}
+  #   if ENV['REPOSITORY_ID']
+  #     repository_config = Arclight::Repository.find_by(slug: ENV['REPOSITORY_ID'])
+  #     args[:repository_ssm] = repository_config.name
+  #   elsif ENV['EADID']
+  #     args[:eadid] = ENV['EADID']
+  #   end
+  #   args[:format] = ENV['FORMAT'] || 'html'
+  #   Package::Queue.new.setup(**args)
+  # end


Suggested change

# desc 'Generate packages for indexed finding aids via background jobs'

# task generate_enqueue: :environment do

# args = {}

# if ENV['REPOSITORY_ID']

# repository_config = Arclight::Repository.find_by(slug: ENV['REPOSITORY_ID'])

# args[:repository_ssm] = repository_config.name

# elsif ENV['EADID']

# args[:eadid] = ENV['EADID']

# end

# args[:format] = ENV['FORMAT'] || 'html'

# Package::Queue.new.setup(**args)

# end

I left this here in case this functionality would be useful in the future. ¯_(ツ)_/¯

Hm, okay, your call. By now you know I'm on team "no commented code."

ssciolla · 2026-09-15T16:48:09Z

+    raise "Please specify your EAD ID, ex. EADID=<id>" unless ENV["EADID"]
+
+    identifier = ENV["EADID"]


Not very important, but you could just use a positional argument over an environment variable here and below.

These were inherited from the original rake tasks; we're still doing this with index_dir, etc. aren't we?

Yes, we are, but we probably won't use index_dir that much from now on, since we also want to create HTML and PDF. This is probably a matter of preference, but I find the positional argument a bit more explicit. Like the difference between passing a value into a function versus depending on a variable in global scope.

ssciolla · 2026-09-15T16:51:10Z

 to_field "has_online_content_ssim", extract_xpath(".//dao") do |_record, accumulator|
  accumulator.replace([ accumulator.any? ])
 end


I see below you added another to_field definition for has_online_content_ssim. Do we need both? Is this important for the PR? (not sure)

Nope. Removed, and simplified the total_digital_object_count_isim to match what has_online_content_ssim is currently doing.

ssciolla · 2026-09-15T16:51:59Z

-    expect(doc.xpath('//div[@id="summary"]//dl/dd[contains(., "Finding Aid written by E. A. Document")]').first).to be_truthy
+    # expect(doc.xpath('//div[@id="summary"]//dl/dd[contains(., "Finding Aid written by E. A. Document")]').first).to be_truthy
+    # expect(doc.css(".access-preview-snippet #toc").first).to be_truthy


Can we restore this assertion somehow?

ssciolla

Looks good! I can't say I thoroughly vetted all the styles, and I don't fully understand some parts of the code, but the output seems much better than what we had before.

smiskiway · 2026-09-15T21:03:07Z

Noticed the generated PDF has a duplicated title on each item, plus a checkbox at the beginning. I don't think we need the checkbox in the PDF — something related to the new print.scss?

respinos added 9 commits September 14, 2026 11:09

porting umich-arclight html/pdf generating

747db75

use the docker container for running wkhtmltopdf on macos

89d2bc8

fix references to how component fields work now

35103d7

add total_digital_object_count_isim

f447594

print styles

ba5c9ea

adapting styles and loading the sidebar turbo-frame

2cfc64e

handle what if turbo-frame is absent

982114c

acknowledging test should be rexamined based on new arclight models

8d21660

fix links on contents

8820464

respinos force-pushed the ARC-184 branch from 3cc18c2 to 8820464 Compare September 14, 2026 15:10

respinos marked this pull request as ready for review September 14, 2026 15:13

respinos requested review from rshiggin, smiskiway and ssciolla September 14, 2026 15:15

ssciolla reviewed Sep 14, 2026

View reviewed changes

Comment thread app/views/arclight/fragments/fragment.html.erb Outdated

Comment thread app/services/package/generator.rb Outdated

Comment thread app/services/package/generator.rb Outdated

Comment thread app/services/package/generator.rb Outdated

rshiggin approved these changes Sep 14, 2026

View reviewed changes

remove dead code

820c7e6

smiskiway reviewed Sep 14, 2026

View reviewed changes

Comment thread app/views/arclight/fragments/_components.html.erb Outdated

update aeon references

1a27755

ssciolla reviewed Sep 15, 2026

View reviewed changes

addressing reviews

c23dfc2

ssciolla approved these changes Sep 15, 2026

View reviewed changes

smiskiway reviewed Sep 15, 2026

View reviewed changes

Comment thread app/controllers/concerns/um_arclight/catalog.rb Outdated

modernize javascript import

779c761

respinos merged commit 54a6553 into main Sep 15, 2026
6 checks passed

smiskiway reviewed Sep 15, 2026

View reviewed changes

		raise "Please specify your EAD ID, ex. EADID=<id>" unless ENV["EADID"]

		identifier = ENV["EADID"]

Conversation

respinos commented Sep 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tips for running the rake tass

Summary

Uh oh!

rshiggin commented Sep 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ssciolla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rshiggin left a comment

Choose a reason for hiding this comment

Uh oh!

respinos commented Sep 14, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ssciolla left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ssciolla Sep 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ssciolla left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

respinos commented Sep 11, 2026 •

edited

Loading

rshiggin commented Sep 14, 2026 •

edited

Loading

ssciolla Sep 15, 2026 •

edited

Loading

ssciolla left a comment •

edited

Loading