Eben English ebenenglish

bpl-mapportal development guide

The goal of this project is to update the major dependencies for an existing Rails application currently in production.

This application is a digital library interface that provides access to historical maps from the Norman B. Leventhal Map & Education Center at the Boston Public Library. The application allows users to search the collection, view image content, download high-resolution files, sign up for an account, and create lists of favorite items, as well as other features.

URL: https://collections.leventhalmap.org/

Code: https://github.com/boston-library/bpl-mapportal/tree/develop/src/portal (private repo)

Overview

For each of these JSON word-coordinate file formats of the same OCR word-coordinate data, representing a single newspaper page:

Open-ONI (58.9 kB)
IIIF Annotation List (826.4 kB)

I ran a test in the Rails console, benchmarking the time needed to:

load the source file into memory
parse as JSON
find nodes matching a search term ("October")

Newspaper Models Acceptance Testing

(For the sake of brevity, not all classes and metadata fields appear in the console examples.)

Classes ✅

There should be 6 classes:

NewspaperTitle (PCDM Object)
NewspaperContainer (PCDM Object)
NewspaperIssue (PCDM Object)
NewspaperPage (PCDM FileSet)


	# create a static OAI XML file with all records
	# @param sets [Array] collection ids, e.g. ['c1ee8010-fb87-40d6-ac23-be547344c4f2', '2000d071-a976-4536-b173-8772a11c3588', ...]
	# @param units_to_ignore [Array] ids of objects to ignore
	# @param file_path [String] location where static XML file should be written
	# @param credentials [Hash] Preservica REST API credentials: {un: 'foo', pw: 'bar'}
	def generate_static_oai_xml(sets, units_to_ignore, file_path, credentials)
	@oai_doc = initialize_oai_xml
	@units_to_ignore = units_to_ignore
	@preservica_rest_api_base = 'https://us.preservica.com/api/entity'

	.range_limit {

	.form-control {

	&.range_begin,
	&.range_end {
	width: 60px;
	}
	}
	}