docs

Back to documentation page for entire system

Datura

Datura Collection Management Scripts

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

The Process

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

The files are parsed and formatted into documents appropriate for Solr, IIIF, 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.

Documentation

Basics

• Start a new collection
  • Create collection and add files
  • Configuration
  • Add index and schema
• Customize collection
  • TEI to Elasticsearch
  • CSV to Solr
  • IIIF Manifest Customization
  • HTML customization
  • Solr customization
  • Collection Tests
• Manage collection
  • Post to index
  • Clear index
  • Whitelisting
  • Remove / destroy index
• Developers
  • Installation
  • Saxon setup
  • Ruby / Gems
  • Class organization
  • Tests
  • Add new formats to Datura
• More
  • Troubleshooting
  • XSLT to Ruby reference

The Basics

If this is a brand new collection, please refer to Create collection and add files

View all available commands:

about

To post to elasticsearch with a basic development environment, give the following a try:

post

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

post -h