[{"_1":2,"_181":-5,"_182":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_160":161},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_89":90,"_111":112,"_149":-5,"_150":11,"_151":21,"_152":11,"_153":-5,"_154":11,"_155":-5,"_156":157,"_158":113,"_159":-7},"canonicalUrl","https://hub.docker.com/r/ocrd/fileformat/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","ocrd","reponame","fileformat","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":73,"_74":75,"_80":11,"_81":82,"_86":33,"_87":88},"categories",[],"content_types",[44],"image","date_registered","2024-07-16T14:38:34.527591Z","description","OCR-D wrapper for ocr-fileformat⁠","is_private","last_updated","2025-05-20T12:38:53.911954Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",23222,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","[![CircleCI](https://circleci.com/gh/OCR-D/ocrd_fileformat.svg?style=svg)](https://circleci.com/gh/OCR-D/ocrd_fileformat)\n[![CircleCI CD](https://dl.circleci.com/insights-snapshot/gh/OCR-D/ocrd_fileformat/master/deploy/badge.svg)](https://app.circleci.com/insights/github/OCR-D/ocrd_fileformat/workflows/deploy/overview?branch=master)\n\n# ocrd-fileformat\n\n> OCR-D wrapper for [`ocr-fileformat`](https://github.com/UB-Mannheim/ocr-fileformat)\n\n\n## Prerequisities\n\n* GNU make\n* Python && pip\n* OpenJDK (required by submodule)\n* optional: Docker CE for building container images \n\n## Installation\n\nClone the repository and it's submodule recursive:\n\n git clone --recursive https://github.com/OCR-D/ocrd_fileformat.git\n\nStep into local clone, build and install `ocr-fileformat` and the `ocrd_fileformat` [OCR-D](https://ocr-d.de) wrapper:\n\n make -C ocrd_fileformat install\n\nAlternatively, for the Docker option, just get:\n\n docker pull ocrd/fileformat\n\n\n## Usage\n\nAfter successful installation type `ocrd-fileformat-transform --help` to get an idea\nwhich conversions are supported already:\n\n

ocrd-fileformat-transform -h

\nUsage: ocrd-fileformat-transform [OPTIONS]\n\n  Convert between OCR file formats\n\n  > Processor base class and helper functions. A processor is a tool\n  > that implements the uniform OCR-D command-line interface for run-\n  > time data processing. That is, it executes a single workflow step,\n  > or a combination of workflow steps, on the workspace (represented by\n  > local METS). It reads input files for all or requested physical\n  > pages of the input fileGrp(s), and writes output files for them into\n  > the output fileGrp(s). It may take  a number of optional or\n  > mandatory parameters. Process the :py:attr:`workspace`  from the\n  > given :py:attr:`input_file_grp` to the given\n  > :py:attr:`output_file_grp` for the given :py:attr:`page_id` under\n  > the given :py:attr:`parameter`.\n\n  > (This contains the main functionality and needs to be overridden by\n  > subclasses.)\n\nOptions:\n  -I, --input-file-grp USE        File group(s) used as input\n  -O, --output-file-grp USE       File group(s) used as output\n  -g, --page-id ID                Physical page ID(s) to process\n  --overwrite                     Remove existing output pages/images\n                                  (with --page-id, remove only those)\n  -p, --parameter JSON-PATH       Parameters, either verbatim JSON string\n                                  or JSON file path\n  -P, --param-override KEY VAL    Override a single JSON object key-value pair,\n                                  taking precedence over --parameter\n  -s, --server HOST PORT WORKERS  Run web server instead of one-shot processing\n                                  (shifts mets/working-dir/page-id options to\n                                   HTTP request arguments); pass network interface\n                                  to bind to, TCP port, number of worker processes\n  -m, --mets URL-PATH             URL or file path of METS to process\n  -w, --working-dir PATH          Working directory of local workspace\n  -l, --log-level [OFF|ERROR|WARN|INFO|DEBUG|TRACE]\n                                  Log level\n  -C, --show-resource RESNAME     Dump the content of processor resource RESNAME\n  -L, --list-resources            List names of processor resources\n  -J, --dump-json                 Dump tool description as JSON and exit\n  -h, --help                      This help message\n  -V, --version                   Show version\n\nParameters:\n   \"from-to\" [string - \"page alto\"]\n    Transformation scenario, see ocr-fileformat -L\n    Possible values: [\"abbyy hocr\", \"abbyy page\", \"alto2.0 alto3.0\",\n    \"alto2.0 alto3.1\", \"alto2.0 hocr\", \"alto2.1 alto3.0\", \"alto2.1\n    alto3.1\", \"alto2.1 hocr\", \"alto page\", \"alto text\", \"gcv hocr\", \"gcv\n    page\", \"hocr alto2.0\", \"hocr alto2.1\", \"hocr page\", \"hocr text\",\n    \"page alto\", \"page hocr\", \"page page2019\", \"page text\", \"tei hocr\"]\n   \"ext\" [string - \"\"]\n    Output extension. Set to empty string to derive extension from the\n    media type.\n   \"script-args\" [string - \"\"]\n    Arguments to Saxon (for XSLT transformations) or to transformation\n    script\n

\n\nWith the [OCR-D](https://ocr-d.de/en/spec/intro) [CLI](https://ocr-d.de/en/spec/cli) wrapper\nthe `ocr-fileformat` converter integrates fluently into existing OCR-D tool [workflows](https://ocr-d.de/en/workflows).\n\nGiven a previous step which produces PAGE-XML under the file group `OCR`,\na conversion into plain text under the file group `OCR-TXT` can be achieved with:\n\n

ocrd-fileformat-transform -I OCR -O OCR-TXT -P from-to \"page text\"

With bertsky/workflow-configuration

\nOCR-TXT: OCR\nOCR-TXT: TOOL = ocrd-fileformat-transform\nOCR-TXT: PARAMS = \"from-to\": \"page text\"\n

\n\nSince the conversion from PAGE-XML to ALTO-XML (V4.1) is such a common\nrequirement, it is the default value for the parameter `from-to`. Therefore,\nparameters can be omitted completely:\n\n

ocrd-fileformat-transform -I OCR -O OCR-ALTO

With bertsky/workflow-configuration

\nOCR-ALTO: OCR\nOCR-ALTO: TOOL = ocrd-fileformat-transform\n

\n\nHowever, typically the ALTO converter itself will require additional parameters\nto be able to cope with the kind of annotations present. For example, if you have\nno cropping in the workflow, and OCR text is only annotated on the line level,\nthen you will need to add:\n\n

ocrd-fileformat-transform -I OCR -O OCR-ALTO -P script-args \"--no-check-border --no-check-words --dummy-word\"

With bertsky/workflow-configuration

\nOCR-ALTO: OCR\nOCR-ALTO: TOOL = ocrd-fileformat-transform\nOCR-ALTO: PARAMS = \"script-args\": \"--no-check-border --no-check-words --dummy-word\"\n

\n\nTo run the program via Docker, just spin up a container analogously:\n\n docker run --rm -v $PWD:/data ocrd/fileformat ocrd-fileformat-transform -I OCR -O OCR-ALTO\n\n","has_starred","hub_user","kbai","immutable_tags_settings",{"_76":11,"_77":78},"enabled","rules",[79],".*","is_automated","permissions",{"_83":21,"_84":11,"_85":11},"read","write","admin","user","storage_size",7734901180,"orgData",{"_91":92,"_93":94,"_95":96,"_97":33,"_98":99,"_100":99,"_101":99,"_102":103,"_104":105,"_106":107,"_108":99,"_109":99,"_110":21},"id","8a3ad25cf3ec4f51a581d0798c88a85e","uuid","8a3ad25c-f3ec-4f51-a581-d0798c88a85e","type","organization","orgname","full_name","","location","company","profile_url","http://ocr-d.de","date_joined","2018-04-05T15:12:40.04219Z","gravatar_url","https://www.gravatar.com/avatar/5adbc7a3e901e82871d91421004b520b?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[113],{"_114":44,"_115":116,"_117":118,"_119":120,"_91":121,"_122":123,"_50":138,"_139":116,"_140":73,"_141":56,"_57":142,"_143":144,"_145":129,"_146":138,"_147":66,"_148":21},"content_type","creator",257751,"digest","sha256:172b625326515553db8665e0e9c01d9db86952ff976931b8e6116c145ca32761","full_size",1111973073,721087144,"images",[124],{"_125":126,"_117":118,"_127":99,"_128":129,"_130":131,"_132":133,"_134":99,"_135":-5,"_136":120,"_63":66,"_137":-5},"architecture","amd64","features","last_pulled","2026-10-14T19:39:31.885662657Z","last_pushed","2025-05-20T12:38:52.332334803Z","os","linux","os_features","os_version","size","variant","2025-05-20T12:38:52.857469Z","last_updater","last_updater_username","media_type","latest","repository",24632385,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":162,"_169":170,"_156":179,"_180":11},{"_40":163,"_42":164,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":165,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":73,"_74":166,"_80":11,"_81":168,"_86":33,"_87":88},[],[44],[56],{"_76":11,"_77":167},[79],{"_83":21,"_84":11,"_85":11},"tags",{"_171":64,"_172":-5,"_173":-5,"_174":175},"count","next","previous","results",[176],{"_114":44,"_115":116,"_117":118,"_119":120,"_91":121,"_122":177,"_50":138,"_139":116,"_140":73,"_141":56,"_57":142,"_143":144,"_145":129,"_146":138,"_147":66,"_148":21},[178],{"_125":126,"_117":118,"_127":99,"_128":129,"_130":131,"_132":133,"_134":99,"_135":-5,"_136":120,"_63":66,"_137":-5},[],"canDeleteTags","actionData","errors"]

ocrd/fileformat

Tags for ocrd/fileformat