An ArchivesSpace plugin that customizes PDF downloads in the public user
interface, accessed via the Print button on collection pages.
The design was based on PDF finding aids developed for TXST's previous system. There are examples here.
Developed by Hudson Molonglo for Texas State University.
© 2022 Hudson Molonglo Pty Ltd.
This plugin was developed against ArchivesSpace v3.0.1. Although it has not been tested against other versions, it will probably work as expected on all 2.x and 3.x versions.
This plugin has no special installation requirements. It has no database migrations and no external gems.
- Download the latest release.
- Unpack it into
/path/to/your/archivesspace/plugins/ - Add the plugin to your
config.rblike this:AppConfig[:plugins] << 'as_txst_pdfs' - Restart ArchivesSpace
To confirm installation has been successful, navigate to a collection page in
the public user interface and click on the Print button at top right. The
generated PDF should look like the examples provided.
There is no further configuration required.
Note that there are three fields in a collection's repository record that are used when generating the PDF:
- Repository Name
- Parent Institution Name
- Branding Image URL (ref to a banner image for the title page)
Editing repository records does not result in a reindex of the records in the repository. So if you change any of these values you will likely need to kick off a manual reindex of the affected repository to see the changes reflected in the PDFs.
This plugin overrides some of the ERB templates in public/app/views/pdf.
It also overrides methods in two public/app/models classes.
You can further customize this plugin's behavior by inspecting the files in public and modifying them.
When upgrading ArchivesSpace, it is good practice to check the overridden files in ArchivesSpace core to see if there are changes relevant to this plugin and port them if necessary.
... Enjoy!!