Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/harvard-library/archivesspace-checker

A small website for checking EADs against local standards via schematron
https://github.com/harvard-library/archivesspace-checker

Last synced: 22 days ago
JSON representation

A small website for checking EADs against local standards via schematron

Host: GitHub
URL: https://github.com/harvard-library/archivesspace-checker
Owner: harvard-library
License: apache-2.0
Archived: true
Created: 2015-08-11T19:41:25.000Z (almost 9 years ago)
Default Branch: main
Last Pushed: 2022-09-27T04:52:21.000Z (almost 2 years ago)
Last Synced: 2024-02-25T20:43:40.637Z (4 months ago)
Language: Ruby
Size: 1.5 MB
Stars: 2
Watchers: 9
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Lists

awesome-archivesspace - EADChecker

README

# Archivesspace Checker

## This project's current version is located at https://github.com/harvard-lts/archivesspace-checker/

This is a small website intended to allow Harvard Archivists to check their EAD files prior to ingest by Archivesspace.

## System Requirements

* JRuby 9000
* Bundler

## Installation Instructions

```sh
git clone [email protected]:harvard-library/archivesspace-checker.git
cd archivesspace-checker
bundle
bundle exec rake assets:precompile
bundle exec rackup
```

Then direct your browser to localhost:9292, upload some EADs, and enjoy!

## Configuration

Configuration settings can be included by putting a YAML file at `config/config.yml`

Right now, the only setting checked for is `schematron`, which is the location that
the schematron file being used is located at.

### Large Finding Aids

You may find that the app fails to work over especially large finding aids with the default JVM memory settings.
It's possible to increase the amount of heap memory available to the JVM (and tune other JVM settings) by passing options
via the environment variable `JRUBY_OPTS`. Options for the JVM are prefixed by `-J`; for example, to set the maximum memory size to 1gb:

``` shell
JRUBY_OPTS=-J-Xmx1G
```

## Schematron notes

When writing Schematron, a common source of errors is assuming that Schematron understands default xmlns namespaces. It very much does not. If you set something up as a default namespace, and reference elements without a prefix in Schematron tests, they will be ignored. Always either provide an explicit prefix, or else use the wildcard prefix (e.g. `/ead:ead` or `/*:ead` instead of `/ead`).

## Developer Documentation
Documentation generated via YARD is available [here](http://harvard-library.github.io/archivesspace-checker).

## Contributors
* [Dave Mayo](https://github.com/pobocks)

## License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this software except in compliance with the License.
You may obtain a copy of the License at

[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License."