Project configuration

title

project title, keep it short and sweet

hidden

set this to true to hide the project from the overview page

type

project type, only document is supported in the current version

image (url)

preview image for the project, will show up on the overview page

description

a description of the project

georeference

set this to true if this project requires georeferencing / map support

source

a dictionary, defines the source document/database for this project

dzi

absolute or relative url of the dzi directory

pages

the number of pages in the source document

shift

if there are filler pages in the source document, use this to set the offset for the first page

index

array of pages that should be selectable from the top menu

markings

set this to true if the user should be able to draw and mark areas of the source document

forms

this is where the project's available terms are defined. forms is a dictionary of named groupings of terms, each of which is an array defining the terms. each term is again a dictionary, consisting of a term name (name) and the input type (type), and optionally any help text related to the term (help). supported types are as follows:

text

a text box

textfield

suitable for multi-line user input

hidden

will not show up in the interface. used for georeferencing or to store the current page the user was looking at when submitting a transcription

checkbox

used for boolean data

annotation

adds all required inputs for allowing the user to draw and mark the source document

order

the order in which the groupings of terms are presented in the ui