Skip to content
chris s edited this page Nov 20, 2018 · 2 revisions

Setting up a new project

Configuration

To set up a new project, use one of the example project configuration files in project/ as a template, make the appropriate edits and save it as projects/<slug>.yaml.

The details of the YAML language aren't covered here, but a simple explanation of the various keys used in dugnad's project configuration files can be found here.

Project name and description

Try to keep everything simple and friendly, especially if this is a project meant for citizen scientists.

Form fields

Again, try to keep this friendly. For transcription projects this should probably just be a list of the terms the citizen scientists can be expected to find on the labels. For other projects, avoid long lists of terms.

Images

Provide URLs for all images to be transcribed. If information pertaining to the images has already been published somewhere, try to attach unique and stable identifiers as well. As long as the images are publicly available on the web, deep zoom versions will be created automatically.

PDF

...

Clone this wiki locally