Export Document
transkribus_doc_exportExport documents from Transkribus in formats like PDF, DOCX, TEI, and ALTO XML, with control over pages, images, and text layers.
Instructions
Export a document in the specified format.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| collId | Yes | Collection ID | |
| id | Yes | Document ID | |
| pages | No | Page range to export (e.g. "1-5") | |
| format | No | Export format | |
| doWriteMets | No | Write METS file | |
| doWriteImages | No | Write image files | |
| doExportPageXml | No | Export PAGE XML | |
| doExportAltoXml | No | Export ALTO XML | |
| splitIntoWordsInAltoXml | No | Split into words in ALTO XML | |
| doWritePdf | No | Write PDF | |
| doWriteTei | No | Write TEI | |
| doWriteDocx | No | Write DOCX | |
| doWriteTagsXlsx | No | Write tags XLSX | |
| doWriteTablesXlsx | No | Write tables XLSX | |
| doPdfImagesOnly | No | PDF with images only | |
| doPdfImagesPlusText | No | PDF with images plus text | |
| doPdfWithTextPages | No | PDF with text pages | |
| doPdfWithTags | No | PDF with tags | |
| doTeiWithNoZones | No | TEI without zones | |
| doTeiWithZones | No | TEI with zones | |
| doSingleClassColorTei | No | Single class color TEI | |
| doBlackening | No | Apply blackening | |
| doCreateTitle | No | Create title page | |
| doWordBased | No | Word-based export | |
| doDocxExpandAbbrevs | No | Expand abbreviations in DOCX | |
| doDocxSubstituteAbbrevs | No | Substitute abbreviations in DOCX | |
| doTeiWithZonePerRegion | No | TEI with zone per region | |
| doTeiWithZonePerLine | No | TEI with zone per line | |
| doTeiWithZonePerWord | No | TEI with zone per word | |
| doTeiWithLineTags | No | TEI with line tags | |
| doTeiWithLineBreaks | No | TEI with line breaks | |
| doDocxWithTags | No | DOCX with tags | |
| doDocxPreserveLineBreaks | No | Preserve line breaks in DOCX | |
| doDocxForcePageBreaks | No | Force page breaks in DOCX | |
| doDocxMarkUnclear | No | Mark unclear text in DOCX | |
| doDocxKeepAbbrevs | No | Keep abbreviations in DOCX | |
| useVersionStatus | No | Version status to use | Latest |