Skip to content

Local plugins for ArchivesSpace at the University of Denver Libraries

Notifications You must be signed in to change notification settings

duspeccoll/plugins_local

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Local

We use local plugins to customize the look and feel of the University of Denver ArchivesSpace staff interface, and to provide validations for data properties above and beyond what ArchivesSpace provides by default.

In each section of the code, changes made by the plugins are commented with descriptions of what each change sets out to do.

How to install

Add to /plugins, change to local instead of plugins_local

Changelog

  • 2020-12-06 - remove subjects and assessments view, no longer working or needed for 2.8.1 with repository customizations, cleanup directories
  • 2020-09-01 - add level 1.5 customization for enums 1 locale

Backend customizations

The backend customizations override the default MARC export for Resources, to make local customizations to leader and control fields; to provide 33X data fields for RDA content, media, and carrier types; and to include data properties of import to the local catalog, such as OCLC numbers in the 035 data field, and links to the Archives @ DU Catalog and to our digital repository where appropriate.

Frontend customizations

  • Labels for user-defined and other fields used locally, such as Kaltura IDs for digital object components
  • Staff interface look and feel customizations, such as the DU logo
  • Changes to the toolbar for integration with other plugins
  • Extending the resource tree in order to display archival object component IDs in the third column, for ease of navigation when processing

Schema extensions

  • archival_object_ext.rb makes the component ID required at the Archival Object level
  • digital_object_component_ext.rb validates the optional Component ID field against the Kaltura Entry ID specifications: /[0-9]_[0-9a-z]{8}/
  • resource_ext.rb validates the call number against DU collection identifier guidelines: /[BDMPTU]\d{3}/

Directory Structure Example

To do customizations in 2.7.0 and beyond, a local plugins directory looks like this: .

├── README.md

├── backend

│   ├── README.md

│   ├── controllers

│   │   └── README.md

│   ├── lib

│   │   ├── README.md

│   │   ├── denver_marc_serializer.rb

│   │   ├── denver_patches.rb

│   │   └── du_marc_exporter.rb

│   ├── model

│   │   ├── mixins

│   │   │   └── README.md

│   │   └── reports

│   │   └── README.md

│   └── plugin_init.rb

├── frontend

│   ├── assets

│   │   ├── images

│   │   │   └── UniversityOfDenver-Signature.png

│   │   └── subject_linker

│   │   ├── subject_linker.css

│   │   └── subject_linker.js

│   ├── locales

│   │   ├── en.yml

│   │   └── enums

│   │   └── en.yml

│   └── views

│   ├── archival_objects

│   │   └── _toolbar.html.erb

│   ├── assessments

│   │   └── index.html.erb

│   ├── collection_management

│   │   ├── _show.html.erb

│   │   └── _template.html.erb

│   ├── layout_head.html.erb

│   ├── shared

│   │   └── _component_toolbar.html.erb

│   ├── site

│   │   └── _branding.html.erb

│   └── subjects

│   └── index.html.erb

├── indexer

│   └── README.md

├── public

│   ├── README.md

│   ├── locales

│   │   └── README.md

│   └── views

│   └── README.md

└── schemas

├── README.md

├── archival_object_ext.rb

├── digital_object_component_ext.rb

└── resource_ext.rb

Related work

Customizations to the Archives @ DU Catalog, our implementation of the ArchivesSpace public user interface, are found here.

About

Local plugins for ArchivesSpace at the University of Denver Libraries

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •