Release notes for v3.1.0-RC1
This release contains bug fixes, small feature enhancements, and backend improvements, with an emphasis on accessibility improvements to the public user interface.
Configurations and Migrations
This release includes several modifications to the configuration defaults file:
# Expose external ids in the frontend
AppConfig[:show_external_ids] = false
# Whether to display archival record identifiers in the frontend largetree container
AppConfig[:display_identifiers_in_largetree_container] = false
# Whether to display archival record identifiers in the PUI collection organization tree
AppConfig[:pui_display_identifiers_in_resource_tree] = false
This release includes 9 new database migrations. The schema number for this release is 157.
API Deprecations
As previously noted, the following API endpoints remain deprecated, and will be removed from the core code of ArchivesSpace on or after 2022-04-16:
- Endpoint.get('/repositories/:repo_id/archival_contexts/softwares/:id.xml')
- Endpoint.get('/repositories/:repo_id/archival_contexts/softwares/:id.:fmt/metadata')
Additionally, as previously noted, the following API endpoints remain deprecated, and will be removed from the core code of ArchivesSpace on or after 2021-10-30:
- Endpoint.get_or_post('/search/subjects')
- Endpoint.get('/repositories/:repo_id/resources/:id/tree')
- Endpoint.get('/repositories/:repo_id/digital_objects/:id/tree')
- Endpoint.get('/repositories/:repo_id/classifications/:id/tree')
For more information see the ArchivesSpace API documentation.
Other considerations (plugins etc.):
Due to some needed accessibility improvements for the public interface, some relatively minor styling changes have been made to views in some places. This may impact plugins used for styling these areas. Check plugins used to theme the public interface to determine if you need to make any changes locally to preserve your desired styling.
Community Contributions
Our thanks go out to these members of the community for their code contributions:
Alex Duryee:
- ANW-1383 - xlink attributes for imported DOs are swapped
- ANW-1383 - xlink attributes for imported DOs are swapped
Andrew Morrison:
- Ensure object being viewed is an archival object
- Ensure object being viewed is an archival object
Brian Zelip:
- ANW-919 Add sticky table header to RDE form
- Add aria attrs to prev/next buttons in bootstrap datepicker
- ANW-1349 Remove Lodash dependency
- ANW-919 Add sticky table header to RDE form
Dave Mayo:
- Fixes ANW-1376 and handles incorrectly NSed @target permissively
- Fixes ANW-1376 and handles incorrectly NSed @target permissively
James Bullen:
- Add plugin sections hook to top_container
- Added form_plugins_for to top container form
- Add render plugin partials to top container
- Use a more distinguished section id for resource notes
- Give search embedded sections unique and descriptive section_ids and corresponding sidebar anchors
- Add a way to hide irrelevant permissions from users
- Add plugin sections hook to top_container
Manny Rodriguez:
- ANW-97: Inactive users
- ANW-158: Bugfix for menus going off screen to the left on very small screens
- ANW-501: Link Classifications to Digital Objects
- ANW-511: move publish flag to be right after accession date in accession
- ANW-667 Show published accessions related to accessions on the public interface
- ANW-733: bugfix for query params not showing in pagination for search results
- ANW-855: remove "rapid data entry" button on classification and classification
- ANW-979: Abort transfer of records to another repository if record has shared top container
- ANW-1011, ANW-980: Escape tags in request and citation
- ANW-1013: Update error message for regex mismatch to be more user friendly
- ANW-1029: CSS fixes for small mobile devices
- ANW-1082: Data in
field in mixed content being moved in OAI Dublin Core, dcterms, and MODS responses
- ANW-1096: display deaccessions in public interface for resources
- ANW-1149: updating help links for preferences pages
- ANW-1164: Context-sensitive help link for load via spreadsheet
- ANW-1176: Add translation when there is no container type in the public interface
- ANW-1358: Updating alt text for main logo; adding accessibility test
- ANW-1373: accessibility: set role as none for lists in transfer and merge dropd
- ANW-97: Inactive users
Mark Triggs:
- Add plugin hooks for "Basic Information"
- Add the ability for plugins to define their own facets and the I18n translations for them
- Add support for plugins defining dependencies
- Add a new hook to run once all plugins have been loaded
- Add support for post-processing the result of resolving records
- Trigger on form load to give plugin JS a chance to fire
- Pass the gemfile & line number through
- Add Archival Object facets
- Move Sequence generation outside of the current transaction
- Handle relative paths for
AppConfig[:plugins_directory]
- Add plugin hooks for "Basic Information"
Nick Butler:
- ANW-1196: optional display of identifiers in record trees
- Refer to archival object's id and identifier instead of root record's
- ANW-1310: minor enhancements to the find and replace job
- ANW-1196: optional display of identifiers in record trees
Payten Giles:
- Introduce AbstractPluginSection (and examples) to allow arbitrary content to be appended to record's form and readonly views
- Introduce Plugins.add_resolve_field to allow a plugin to easily add a resolve[] entry to the ApplicationController.find_opts
- Introduce Plugin.register_edit_role_for_type to allow a plugin to hook into SearchHelper.can_edit_search_result?
- Add hook to allow plugin to append to date template
- Fix both form_plugins_for and show_plugins_for outputting content and causing duplicate data on the assessment readonly view
- Extend Plugins::PluginReadonlySearch to allow override of the erb template used
- Add plugin hook for sub_container readonly/form templates
- Allow extra_params to optionally be passed to AjaxTree.prototype.add_new_after to allow extra params on the ajax call to populate the new form for a tree node
- Add plugin hook for NotesHandler.note_types_for
- Refactor JobsController so can override download file format/extension via plugins
- Add some CSS classes to the search listing filter so can style facets
- Move tooltip generation logic into a method
- Add plugin sections hook to repository
- Extend PluginReadonlySearch to support a new add only_show_if_results so section may only be rendered if there are results
- Introduce AbstractPluginSection (and examples) to allow arbitrary content to be appended to record's form and readonly views
Sam Hatfield:
- Fix request_mailer staff email
- Fix request_mailer staff email
Sean Anderson:
- Fetch the note enum type from the schema
- Fetch the note enum type from the schema
Total community contributions accepted: 60
JIRA Tickets and Pull Requests Completed
- PR: 2220 - ANW-1196: ANW-1196: optional display of identifiers in record trees
- PR: 2231 - ANW-211: ANW-211 PUI record badge should only show archival objects
- PR: 2238 - ANW-667: ANW-667: Display related accessions on accession show page in PUI
- PR: 2243 - ANW-1029: ANW-1029: CSS fixes for small mobile devices (up to 480 px width)
- PR: 2244 - ANW-194: ANW-194 ANW-206 synchronize RDE templates and multiselect
- PR: 2245 - ANW-820: ANW-820 MARCXML export 1xx, 6xx, 7xx punctuation updates
- PR: 2247 - ANW-147: ANW-147 Merging extent controlled values loses related items
- PR: 2253: Issue #1584 Update EAD export for telephones subrecord
- PR: 2256 - ANW-980: ANW-1011, ANW-980: Updated fix to resolve ANW-980 and escape tags in request and citation
- PR: 2258 - ANW-1289: ANW-1289 Updates to manage repositories form
- PR: 2260: Issue 2094 Don't provide clickable context links in embedded search
- PR: 2261: Issue 1334 Match label to search/filter box id
- PR: 2265 - ANW-695: ANW-695 top container csv links
- PR: 2266: Hm plugin enhancements from #1896
- PR: 2267: Add docker dev files
- PR: 2268: Ensure @marc1 always has an inclusive date
- PR: 2270: Post-3.0 updates to LCNAF plugin tests
- PR: 2271 - ANW-1119: ANW-1119 Redirect to top containers index page post merge
- PR: 2272: Updates for isolating dev / test env build files
- PR: 2273: Enable sorting of paginated results
- PR: 2274 - ANW-1013: ANW-1013: Update error message for regex mismatch to be more user friendly
- PR: 2276 - ANW-1191: ANW-1191 Identify corporate entity agents that are repo agents, etc.
- PR: 2278 - ANW-891: ANW-891: Add more fields and sort to the users table
- PR: 2280 - ANW-1282: ANW-1282 add metadata rights declaration subrecord
- PR: 2281: force plugin load paths to the back
- PR: 2282: allow a title field if the agent is a subject or creator
- PR: 2283 - ANW-1191: ANW-1191 Returns contact notes to repository records
- PR: 2284 - Anw 442: Anw 442 representative contact
- PR: 2285: pend two tests that fail frequently
- PR: 2289 - ANW-501: ANW-501: Link Classifications to Digital Objects
- PR: 2290 - ANW-915: ANW-915 Add language and script of description to accession records
- PR: 2292: optimize deletion of notes attached to subrecords
- PR: 2293 - ANW-511: ANW-511: moving publish form controls in accession edit/new form towards top o
- PR: 2294 - ANW-855: ANW-855: remove "rapid data entry" button on classification and classification
- PR: 2295 - ANW-1096: ANW-1096: display deaccessions in public interface for resources
- PR: 2296: push frontend locales to the front of the public I18n stack
- PR: 2297: there can only be one 149
- PR: 2298: Refer to archival object's id and identifier instead of root record's
- PR: 2300: Updates to pass tests with external Solr (v8)
- PR: 2301: Ensure object being viewed is an archival object
- PR: 2302 - ANW-908: ANW-908: Add langmaterials to accessions
- PR: 2303: Renumber duplicate 151 migration
- PR: 2305 - ANW-1164: ANW-1164: Context-sensitive help link for load via spreadsheet
- PR: 2306 - ANW-1149: ANW-1149: updating help links for preferences pages
- PR: 2308 - ANW-1282: ANW-1282: metadata rights declaration revisions2
- PR: 2310 - ANW-158: ANW-158: Bugfix for menus going off screen to the left on very small screens
- PR: 2311 - ANW-1029: ANW-1029: Extending PUI interface fixes to tablet sized screens
- PR: 2312 - ANW-1082: ANW-1082: Data in
field in mixed content being moved in OAI Dublin Core, dcterms, and MODS responses
- PR: 2313: Solr cfg upd 8
- PR: 2314 - ANW-1317: ANW-1317 Ensure rights statements linked agents work in Derby
- PR: 2315 - ANW-1332: ANW-1332 Adjust color contrast for non-text elements
- PR: 2316 - ANW-1330: ANW-1330 Darken active breadcrumb text in SUI
- PR: 2317 - ANW-1321: ANW-1321 Ensure color contrast in PUI footer on hover/focus
- PR: 2318 - ANW-97: ANW-97: Inactive users
- PR: 2319 - ANW-1311: ANW-1311 Darken placeholder text on PUI
- PR: 2321 - ANW-1315: ANW-1315 Don't duplicate ids in PUI
- PR: 2322 - ANW-1331: ANW-1331: visible labels missing in pui
- PR: 2323 - ANW-1313: ANW-1313 Provide more descriptive labels in PUI record sidebar, search
- PR: 2325 - ANW-1310: ANW-1310: minor enhancements to the find and replace job
- PR: 2326 - ANW-667: ANW-667 Fixes to use index for display
- PR: 2327 - ANW-1328: ANW-1328 Staff interface tree labels, contrast, headings
- PR: 2331: Handle relative paths for
AppConfig[:plugins_directory]
- PR: 2332: Enforce other level value field when level is otherlevel
- PR: 2333 - ANW-919: ANW-919 Add sticky table header to RDE form
- PR: 2334 - ANW-951: ANW-951 Allow users to have same name
- PR: 2335 - ANW-1176: ANW-1176: adding missing translation in PUI
- PR: 2340 - ANW-1323: ANW-1316, ANW-1323 Provide keyboard-only resizing of PUI sidebar
- PR: 2343 - ANW-1348: ANW-1348 resolved
- PR: 2344 - ANW-1358: ANW-1358: Updating alt text for main logo; adding accessibility test
- PR: 2345 - ANW-733: ANW-733: bugfix for query params not showing in pagination for search results
- PR: 2346 - ANW-1326: ANW-1326 work in progress: resource toolbar roles and aria attributes
- PR: 2347 - ANW-1349: ANW-1349 Remove Lodash dependency
- PR: 2349 - ANW-97: ANW-97: Separate UI elements on the manage_users and manage_user_access pages
- PR: 2351 - ANW-1347: ANW-1347 Fix setting language preferences in staff interface
- PR: 2352 - ANW-1361: ANW-1361 Fix PUI subjects show page, PUI factories updates
- PR: 2353 - ANW-1376: Fixes ANW-1376 and handles incorrectly NSed @target permissively
- PR: 2354 - ANW-511: ANW-511: move publish flag to be right after accession date in accession show
- PR: 2355 - ANW-1149: ANW-1149: Updating tooltip for help icon on preferences page
- PR: 2356 - ANW-1325: ANW-1325: Staff header accessibility improvements
- PR: 2358: Fix request_mailer staff email
- PR: 2360: Revert two regressions
- PR: 2362 - ANW-1373: ANW-1373: accessibility: set role as none for lists in transfer and merge dropd
- PR: 2363: attempt to resolve random CI failures in accessibility tests
- PR: 2364 - ANW-979: ANW-979: Abort transfer of records to another repository if record has shared top container
- PR: 2366 - ANW-1381: ANW-1381 resolve agent sub records pointing to deleted subjects
- PR: 2368 - ANW-1322: ANW-1322 PUI heading levels and accessibility tests
- PR: 2370 - ANW-1383: ANW-1383 - xlink attributes for imported DOs are swapped
- PR: 2372 - ANW-1338: ANW-1338 Ensure PUI DO captions will wrap regardless of device size
- PR: 2373 - ANW-501: ANW-501: Adding classification subrecord to digital object show page
- PR: 2375: Run index round before frontend accessibility tests
- PR: 2377: ANW-979
- PR: 2378 - ANW-442: ANW-442: show preferred contact badge in agent view mode
- PR: 2380 - ANW-1390: ANW-1390 Don't error when light mode users edit corp/software/fam records
- PR: 2382 - ANW-1366: ANW-1366 remove global xpath searches from agent auth import map
- PR: 2383: prevent enabling custom reports for now
- PR: 2384: ANW-1282-fix-translation-errors-for-collapsed-license-view
- PR: 2385 - ANW-861: ANW-861 reverts
Total Pull Requests accepted: 97