https://github.com/alexduryee/timewalk

Automated date parsing plugin for ArchivesSpace
https://github.com/alexduryee/timewalk

Last synced: 22 days ago
JSON representation

Automated date parsing plugin for ArchivesSpace

• Host: GitHub
• URL: https://github.com/alexduryee/timewalk
• Owner: alexduryee
• Created: 2016-11-04T19:15:47.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T02:53:21.000Z (7 months ago)
• Last Synced: 2024-02-25T20:38:30.225Z (4 months ago)
• Language: Ruby
• Size: 673 KB
• Stars: 11
• Watchers: 5
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• awesome-archivesspace - Timewalk plug-in

README

        
# timewalk

An automated date parser for ArchivesSpace.

timewalk will automatically parse any values in ArchivesSpace's Date Expresssion field into ISO8601-compliant `Begin` and `End` values.  In addition, it will parse out date certainties and set the calendar/era values automatically.

## Version Compatibility

The latest version of timewalk is compatible with ArchivesSpace 3.0 and above, and *is not* compatible with ArchivesSpace 2.x.  A version compatible with ArchivesSpace 2.x is available [here](https://github.com/alexduryee/timewalk/releases/tag/v2.x)

## Expectations on Data Entry

timewalk will parse any single date, or date span, properly.  The following dates will parse correctly:

```

January 1900

[February 1860 - March 20, 1990]

ca. 1950 to 1960

```

Date lists will _not_ parse as expected, as the parser will break them into discrete dates.  The following examples will not parse:

```

1999, 2000

January 1900; December 2000

February 20 and April 19, 1950

```

These dates should be broken into distinct Date entries in ArchivesSpace regardless; in other words, timewalk behaves as expected, assuming good data practice.

## Installation

Create a `plugins/timewalk` directory in your ArchivesSpace directory, copy the repository into that directory, and add `timewalk` to your `AppConfig[:plugins]` list.

## Credits

Created by Alexander Duryee at The New York Public Library.

timewalk is built on [timetwister](https://github.com/alexduryee/timetwister), created by a cast of characters at the New York Public Library.