Exporting project data

Madoc allows you to export your project data in a number of different formats. You can preview any of the formats by navigating to a IIIF resource in the Admin and clicking on the "JSON" tab. This will list the available formats for this specific resource.

If you want to export the entire project, you can do so by navigating to the project overview page and clicking on the "Export" tab. This will allow you to choose the formats you want to export.

The available formats are:

Canvas API

canvas-api-export

Export from the internal Madoc API

Supported types

canvas

/manifests/{manifest}/api/{canvas}.json

Example export

Simple canvas

Canvas model export

canvas-model-export

Export capture models from projects

Supported types

canvas

/manifests/{manifest}/models/{project_id}/{format}/{canvas}.json

Canvas Plaintext

canvas-plaintext

Export transcription as plaintext

Supported types

canvas

/manifests/{manifest}/plaintext/{canvas}.txt

Canvas annotation export

canvas-annotation-export

Export capture models as annotations

Supported types

canvas

/manifests/{manifest}/annotations/{project_id}/{format}/{canvas}.json

Example exports

W3C annotation

Open annotation

Manifest API

manifest-api-export

Export Manifest from API (without canvases)

Supported types

manifest

/manifests/{manifest}/api.json

Example export

Simple manifest

Project API Export

project-api-export

Export project metadata from the Madoc API

Supported types

project

Simple CSV Export

project-csv-simple-export

Exports simple capture models to CSV (no nested models)

Supported types

project

Example export

Simple CSV

CSV Exports

When you export a project using the CSV export, you will see a flat version of the data in the project. You can optionally choose a nested entity to export (allowing multiple per resource). Along with the data you also get identifiers for the manifest, canvas, capture model and a unique identifier for the row (doc_id).

model_id	doc_id	field_a	field_b	manifest	canvas
14977ce1-8293-4467-88d6-f8bb58a02a96	7be69729-c802-4c85-8310-11a3f920a666	field a entry 1	field b entry 1	272277	272283
14977ce1-8293-4467-88d6-f8bb58a02a96	7be69729-c802-4c85-8310-11a3f920a667	field a entry 2	field b entry 2	272277	272283
14977ce1-8293-4467-88d6-f8bb58a02a96	7be69729-c802-4c85-8310-11a3f920a668	field a entry 3	field b entry 3	272277	272283

Configuration 🚧Overview