Transcription of image content

This step plugin allows you to create transcriptions of works. The transcriptions are recorded without word or line coordinates.

Overview

Name	Wert
Identifier	intranda_step_transcription
Repository	https://github.com/intranda/goobi-plugin-step-transcription
Licence	GPL 2.0 or newer
Last change	05.04.2025 15:31:38

Introduction

The transcription plugin allows the user to edit the txt OCR results of a Goobi process. An image and a rich text editor are displayed side by side where the text can be captured.

Installation

To use the plugin, these two files must be copied to the following locations:

/opt/digiverso/goobi/plugins/step/plugin-intranda-step-transcription-base.jar
/opt/digiverso/goobi/plugins/GUI/plugin-intranda-step-transcription-gui.jar

The configuration of the plugin takes place within its configuration file plugin_intranda_step_transcription.xml. This is expected under the following path:

/opt/digiverso/goobi/config/plugin_intranda_step_transcription.xml

Overview and functionality

To put the plugin into operation, it must be activated for one or more desired tasks in the workflow. This is done as shown in the following screenshot by selecting the plugin intranda_step_transcription from the list of installed plugins.

Assigning the plugin to a specific task

As soon as a user subsequently accepts a task that contains this plugin, he can enter it from within the task.

Plugin within the accepted task

After entering the plugin, the user can browse through the image files. A rich text editor is displayed on the right-hand side of each page, showing any existing transcription or OCR results. In this editor, the previous result can now be corrected or a completely new text can be transcribed.

Plugin within the accepted task

ATTENTION: Please note that this plugin only allows a simple transcription of page content. It is not possible to enter coordinates for paragraphs, lines or words.

Configuration

The plugin is configured in the file plugin_intranda_step_transcription.xml as shown here:

<config_plugin>
    <!--
        order of configuration is:
          1.) project name and step name matches
          2.) step name matches and project is *
          3.) project name matches and step name is *
          4.) project name and step name are *
	-->
    
    <config>
        <!-- which projects to use for (can be more then one, otherwise use *) -->
        <project>*</project>
        <step>*</step>
        
        <!-- which folder to use (master|main|jpeg|source|...) -->
		<imageFolder>master</imageFolder>
        
        <!-- use tiles in image view -->
        <useTiles>true</useTiles>
        
        <!-- display button to finish the task directly from within the entered plugin -->
        <allowTaskFinishButtons>true</allowTaskFinishButtons>
    </config>

</config_plugin>

General parameters

The <config> block can occur repeatedly for different projects or work steps in order to be able to perform different actions within different workflows. The other parameters within this configuration file have the following meanings:

Parameter	Explanation
project	This parameter defines which project the current block <config> should apply to. The name of the project is used here. This parameter can occur several times per <config> block.
step	This parameter controls which work steps the <config> block should apply to. The name of the work step is used here. This parameter can occur several times per <config> block.

Further parameters

In addition to these general parameters, the following parameters are available for further configuration:

Parameter	Explanation
imageFolder	Specify here from which directory the images are to be displayed. Possible values are e.g. master, media or individual folders like photos and scans.
allowTaskFinishButtons	This parameter can be used to enable buttons for completing the task to be displayed in the regular plugin interface so that the plugin does not have to be exited first.