This collection supports the population of an API storing data extracted from XML, CSV, YML, and other file types.

Collections are added as sub repositories. They may contain data in the following formats: TEI P5, VRA, Dublin Core, CSV, and YML. The following output formats are supported: HTML, Solr XML, Elasticsearch (ES) JSON.

The files are parsed and formatted into documents appropriate for Solr, Elasticsearch, and HTML snippets, and then these resulting documents are posted to the appropriate locations. There are also several management scripts for creating indexes, managing the schemas, and deleting indexes.

• Start a new collection
  • Create collection and add files
  • Configuration
  • Add index and schema
• Customize collection
  • TEI to Elasticsearch
  • HTML customization
  • Solr customization
  • Collection Tests
• Manage collection
  • Post to index
  • Clear index
  • Remove / destroy index
• Developers
  • Installation
  • Saxon setup
  • Class organization
  • Schema
  • File Structure
  • Tests
• More
  • Cather letters documentation
  • Troubleshooting
  • XSLT to Ruby reference

If this is a brand new collection, please refer to [[TODO]] these docs on how to set up a collection.

To run a basic development environment, give the following a try, subbing in your collection name.

ruby scripts/ruby/post.rb <collection>

Check out all the options by running the "help" flag:

ruby scripts/ruby/post.rb -h