Export a project as a document
You can export data from Arkindex in the following formats:
- PAGE XML.
Starting an export¶
Select the data to export¶
Export an entire project¶
If you want to export all the data inside a project in either PDF or PAGE XML format, you can find these actions in the Import/Export menu, from the project’s main page.
Export a folder element inside a project¶
If you only want to export a specific folder-type element from a project, you can find the export actions in the Import/Export menu from that element’s page.
Export selected elements¶
If you want to export a specific subset of elements, you can add these elements to your selection, then find the export actions in the Actions menu from the user selection.
Select an existing database export or start a new one¶
Clicking one of the export actions opens a modal.
When you export data into any format from Arkindex, the export is not done directly from the elements on Arkindex using the API, but from an database export, which is more efficient. If an existing completed database export of the project already exists, and the data inside the project has no changed since this export was generated, you can select this export to use.
Otherwise, you can select the Use the current state of the project option, which will start a new database export before generating your data in the expected format.
Warning
If your project contains a lot of objects (elements, transcriptions, entities etc) the creation of a new database export can take a long time.
Configure the export worker¶
In the same modal, if the worker that handles the selected export format has user-configurable parameters, you can parametrize the export. You can find these options under the Configuration titles and the Required Fields and Optional Fields dropdowns.
For example, you may be able to select the type of the elements from which transcriptions are extracted, or limit your export to objects created by a specific worker run.
Monitoring the export¶
When you click the Export button, an export process is started and you are redirected to this process’ status page. You can follow you export’s progress from this page, and find it again in the process list, which you can access by clicking on Process in the main navigation bar.
From the processes list, you can filter processes by the “Export” mode to see only export processes.
Downloading the exported data¶
Once your export process is completed, you can download the exported data by clicking the Download button under the Actions menu in the processes list, or by clicking on Download the export in the Actions menu of the process status page.
“