Tutorial transcription editor (en): Unterschied zwischen den Versionen

Aus Kallimachos
Wechseln zu:Navigation, Suche
(Opus)
(Work with the editor)
 
(33 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 
<div class="notab">
 
<div class="notab">
==Einsatzgebiet des Transkriptionseditors==
+
== Scope of the ''transcription editor''==
  
[[File:TransEditor.png | thumbnail | Die Benutzeroberfläche des Transkriptionseditors| link=| alt= Benutzeroberfläche des Transkriptionseditors]]
+
[[File:TransEditor.png | thumbnail | User interface of transcription editor| link=| alt= Benutzeroberfläche des Transkriptionseditors]]
  
Egal, ob ein Text von Grund auf neu transkribiert werden oder ein per OCR erzeugter Text von Fehlern bereinigt werden muss: Gerade historische Texte stellen besondere Ansprüche an die Arbeit menschlicher Transkriptoren und Korrektoren. Diese sind vor allem in den in historischen Handschriften und Drucktexten verbreiteten Sonder- und Abkürzungszeichen begründet, die auf herkömmlichen Computertastaturen fehlen.  
+
Whether or not a text needs to be transcribed or a recognized text needs to be corrected, especially historic literature is very demanding on human transcriptors and proofreaders. These texts are particularly based on special characters and abbreviations that doesn't exist on regular computer keyboards.Unicode-equivalents and the applicable digital print types need to be defined in advance and manually transfered into the transcribing text. Errors and irregularities are inevitable if they are not prevented by means of a wise working environment and well-defined workflow. Furthermore, the staff hierarchy of many projects of transcribition requires a user management that allows for a "correcting of the correcture" by qualified staff. The development of [[Narragonien:Main|Narragonien digital]] serves these requirements by means of an intuitive and operating system-independend web-based user interface.
  
Whether or not a text has to be transcribed or a recognized text to be corrected, especially historic literature is very demanding on human transcriptors and proofreaders. These are particularly based on special characters and abbreviations that doesn't exist on regular computer keyboards.
+
The transcription editor enables the creation of exact character matching transcriptions in a controlled environment including the verification of correct encoding, full control about data (scans and electronic texts), as well as the consequent usage of MUFI-Fonts for special character encoding. A hierachical system of user privileges allow for the inclusion of student assistants and seminar participants.
 
+
<br clear=all>
Hier müssen die benötigten Unicode-Entsprechungen und die geeigneten digitalen Schrifttypen im Vorfeld bestimmt und händisch in den Transkriptionstext übertragen werden. Fehler und Unregelmäßigkeiten sind hier vorprogrammiert, wenn diese nicht durch eine sinnvoll aufgebaute Arbeitsumgebung und einen gut definierten Arbeitsablauf verhindert werden.
 
 
 
Unicode-equivalents and the applicable digital print types have to be defined in advance and manually transfered into the transcripting text. Errors and irregularities are inevitable if they are not prevented by means of a wise working environment and well-defined workflow.
 
 
 
Darüber hinaus erfordern die personellen Hierarchien vieler Transkriptionsprojekte eine Benutzerverwaltung, die z.B. eine „Korrektur der Korrektur“ durch geschultes Fachpersonal erlaubt. Der für das Kallimachos-Teilprojekt [[Narragonien:Main|Narragonien digital]] entwickelte Transkriptionseditor bedient diese Anforderungen in einer intuitiv verwendbaren und betriebssystem-unabhängigen Weboberfläche.
 
 
 
Furthermore, the staff hierarchy of many projects of transcribition requires a user management that allows, e.g. "correcting the correcture" by qualified staff. The development of [[Narragonien:Main|Narragonien digital]] serves the requirements by means of an intuitive and operating system-independend web-based user interface.
 
 
 
Der Transkriptionseditor ermöglicht die Erstellung von zeichengetreuen Transkriptionen in einer kontrollierten Umgebung, inklusive der Gewährleistung des korrekten Encodings, voller Kontrolle über die Daten (Scans und Texte) und die konsequente Anwendung von MUFI-Fonts zur Sonderzeichencodierung.
 
 
 
The transcription editor enables the creation of exact character matching transcriptions in a controlled environment including the verification of correct encoding, full check about data (scans and electronic texts), as well as the consequently usage of MUFI-Fonts for special character encoding.
 
 
 
Ein hierarchisches Benutzerrechtesystem ermöglicht die Miteinbeziehung von studentischen Mitarbeitern und Seminarteilnehmern.
 
  
A hierachical system of user privileges allows the inclusion of student assistants and seminar participants.
 
<br clear=all>
 
===Technische Informationen===
 
*Webanwendung
 
*Technologie: [http://www.oracle.com/technetwork/java/javaee/overview/index.html Java EE] mit [http://www.oracle.com/technetwork/middleware/glassfish/overview/index.html GlassFish-Server]
 
*Oberfläche basierend auf [http://ckeditor.com/ CKEditor]
 
*[http://folk.uib.no/hnooh/mufi/ MUFI]-Unicodes und -Fonts für Transkriptionen
 
*Benutzerkontensteuerung mit Rechteverwaltung
 
 
=== Technical data ===
 
=== Technical data ===
* Web appliacation
+
* Web application
* Technology[http://www.oracle.com/technetwork/java/javaee/overview/index.html Java EE] mit [http://www.oracle.com/technetwork/middleware/glassfish/overview/index.html GlassFish-Server]
+
* Technology: [http://www.oracle.com/technetwork/java/javaee/overview/index.html Java EE] with [http://www.oracle.com/technetwork/middleware/glassfish/overview/index.html GlassFish-Server]
* [http://ckeditor.com/ CKEditor] based surface
+
* [http://ckeditor.com/ CKEditor] based user interface
* b[http://folk.uib.no/hnooh/mufi/ MUFI]-unicodes and -fonts for transcriptions
+
* [http://folk.uib.no/hnooh/mufi/ MUFI]-based unicodes and fonts for transcriptions
* User account control with permission management
+
* User account control with rights management system
 
 
==Zugriff auf den Editor==
 
== Accessing the editor ==
 
 
 
Nach der Anpassung und Freischaltung für das jeweilige Projekt steht der Transkriptionseditor als eigene Webanwendung zur Verfügung. Zur Arbeit mit dem Editor benötigen Sie einen per Passwort geschützten Account.
 
 
 
After adaption and activation für the respective project, the transcription editor is available. In order to work with the editor, you need a password-protected account.
 
 
 
Ihrem Account können verschiedene Sicherheitsrollen zugewiesen werden:
 
*'''Gäste''' können zugewiesene Seiten im Editor betrachten, aber nicht bearbeiten (derzeit nicht aktiv)
 
*'''Mitarbeiter''' können Werke und einzelne Textseiten im Editor ansehen und bearbeiten, die Ihnen von Koordinatoren zugewiesen wurden.
 
  
You account can be allocated different security roles:
+
== Access to the editor ==
  
* '''Guests''' can watch allocated pages in the editor, but they may not edit them (currently not available)
+
After adaption and activation for the respective projects, the transcription editor is available as a seperate web application. In order to work with the editor, you need a password-protected account.
* '''Employees''' may watch opus as well as single text pages and edit when allocated by the coordinator.
 
  
*'''Koordinatoren''' können beliebig Texte bearbeiten, sowie Werke und einzelne Textseiten ausgewählten Mitarbeitern zur Bearbeitung zuweisen. Anschließend können Sie deren Fortschritte kontrollieren und die finale Version für die Transkription auswählen. Sie können außerdem neue Mitarbeiter und Koordinatoren hinzufügen.
+
Different security roles can be allocated to your user account:
  
*'''Coordinators''' may edit any text just as any number of text as well as assigning opus and single textpages for editing to selective employees.
+
* '''Gäste/guests''' can watch allocated pages in the editor, but they may not edit them (currently not available).
  
*'''Administratoren''' haben die gleichen Rechte wie Mitarbeiter und haben zusätzlich Zugriff auf weitere Systemeinstellungen des Editors und der gesamten Webumgebung.
+
* '''Mitarbeiter/collaborators''' may watch an opus as well as single text pages and may edit them when allocated by a coordinator.
  
*'''Administrators''' have the same privileges like employees. Additionally, the have privileges to access further system settings of the editor and the whole web environment.
+
*'''Koordinatoren/coordinators''' may edit any text and my also allocate pages for editing to selective collaborators. Subsequently, they may check their progress and choose the final version for transcription. Furthermore, they may add new collaborators and coordiantors.
  
== Nutzerwaltung ==
+
*'''Administratoren/administrators''' have the same privileges as coordinators. Additionally, the have privileges to access extended system settings of the editor and the whole web environment.
  
 
== User administration==
 
== User administration==
Die Benutzer- und Rechteverwaltung ist nur für '''Administratoren''' und '''Koordinatoren''' zugänglich. Per Klick auf ''Administration'' -> ''Benutzerverwaltung'' öffnet sich die Ansicht aller eingetragenen Nutzer.
 
 
Access to user and privileges management is only accessible for administrators and coordinators. By clicking on ''Administration/administration -> Benutzerverwaltung/user management'' an overview about all registered users ist opened.
 
  
Jeder Eintrag kann durch Klicken auf ''Bearbeiten/edit'' bearbeitet werden oder durch Klicken auf ''Entfernen'' wieder aus der der Datenbank gelöscht werden. Neue Nutzer können über den Button ''Hinzufügen'' eingetragen werden.
+
Access to user and privileges management is only accessible to administrators and coordinators. By clicking on ''Administration/administration -> Benutzerverwaltung/user management'' an overview about all registered users ist opened.
  
Every entry may be edited by clicking on ''Bearbeiten/edit'' or deleted out of the database by clicking on ''Entfernen/remove''. New users can be added by clicking on ''Hinzufügen/add''.
+
Every entry may be edited by clicking on ''Bearbeiten/edit'' or deleted by clicking on ''Entfernen/remove''. New users can be added by clicking on ''Hinzufügen/add''.
  
==Dokumentenverwaltung==
 
 
== Document management==
 
== Document management==
  
Auch die Dokumentenverwaltung ist nur für '''Administratoren''' und '''Koordinatoren''' zugänglich. Das Hinzufügen neuer Werke ist darüber hinaus nur für '''Administratoren''' möglich und erfordert schreibenden Zugriff auf das Datenverzeichnis auf dem Server.
+
The document administration is also only accessible to '''Administratoren/administrators''' and '''Koordinatoren/coordinators'''. Furthermore, adding a new opus is also only available to '''Administratoren/administrators''' and requires writing permissions to the server directory.
 
 
The document administration is also only accessible to '''Administratoren/administrators''' and '''Koordinatoren/Coordinators'''. Furthermore, adding new opus is also only available to '''Administratoren/administrators''' and requires writing permissions to the servers directory.
 
 
 
Mithilfe der Dokumentenverwaltung können Nutzer mit der entsprechenden Befugnis die zu transkribierenden (bzw. zu korrigierenden) Werke und ihre Metadaten bearbeiten. Hierbei können den Werken auch passende Drucktypen-Inventare zugewiesen werden. So können die für die Arbeit mit Editor zur Verfügung stehenden Sonderzeichen individuell an jedes Werk angepasst werden.
 
 
 
By means of document management, user may edit the works and their corresponding meta data, if the are permitted to.
 
 
 
Durch Klicken auf ''Hinzufügen'' öffnet sich die Eingabemaske zum Anlegen eines neuen Werks. Die mit Sternchen gekennzeichneten Metadatenfelder müssen zum Speichern des Datensatzes befüllt werden, alle anderen Felder sind optional. Falls Drucktypen und Aufbewahrungsorte schon beim Anlegen mit dem Werk verknüpft werden sollen, müssen diese zuvor unter den Reitern ''Drucktypen'' bzw. ''Aufbewahrungsorte'' angelegt worden sein.
 
  
By clicking on ''Hinzufügen/add'', an input mask to create a new opus appears. Metadata fields that are marked by a joker-sign ( * ) are to be filled-up in order to save the entity. Other fields are optionally. If print types and depositories are to be linked during the creation of an opus, they have to be created in advance in tabs ''Drucktypen/print types'' or ''Aufbewahrungsorte'', respectively.
+
By means of document management, users with corresponding permissions may edit the opus and their corresponding metadata.
  
===Werke===
+
By clicking on ''Hinzufügen/add'', the input mask for creating a new opus is opened. Metadata fields that are marked with an asterisk  (*) are mandatory, other fields are optional. If new print types and physical depositories of the original texts must be linked during the creation of an opus, they have to be created in advance in the tabs ''Drucktypen/print types'' and ''Aufbewahrungsorte/depository'', respectively.
=== Opus ===
 
  
[[File:TransEditorSpaltenauswahl.png | thumbnail | Auswahl der angezeigten Tabellenspalten| link=| alt=Auswahl der angezeigten Tabellenspalten]]
+
=== Werk/opus ===
* '''Tabellenansicht''': Unter diesem Menüpunkt finden Sie eine tabellarische Übersicht aller Werke. Die angezeigten Spalten können Sie per Klick auf die Schaltfläche ''Spalten'' selbst konfigurieren: Wenn Sie ein wichtiges Metadatum in der Ansicht vermissen, können Sie dieses hier einblenden.
 
  
[[File:TransEditorSpaltenauswahl.png | thumbnail | Auswahl der angezeigten Tabellenspalten| link=| alt=Auswahl der angezeigten Tabellenspalten]]
+
[[File:TransEditorSpaltenauswahl.png | thumbnail | Selection of displayed spread sheet columns| link=| alt=Auswahl der angezeigten Tabellenspalten]]
  
* '''Tabular overview''': In this menu item you see a tabular overview of all opus. By clicking on the ''Spalten/columns'' botton, you may configure the shown columns by yourself. You may display important metadata, if you miss any.
+
* '''Tabular overview''': In this menu item, you see a tabular overview of all opus. By clicking on the ''Spalten/columns'' button, you may configure the shown columns by yourself. You may display important metadata, if you miss any.
  
 
<br clear=all>
 
<br clear=all>
[[File:TransEditorMetadaten.png | thumbnail | Bearbeiten der Metadaten eines Werks | link=| alt=Bearbeiten der Metadaten eines Werksn|600px]]
+
[[File:TransEditorMetadaten.png | thumbnail | Editing the metadata of an opus| link=| alt=Bearbeiten der Metadaten eines Werksn|600px]]
* '''Metadaten bearbeiten''': Ansonsten können Sie die vollständigen Metadaten eines Werks über die Schaltfläche ''Bearbeiten'' ansehen und nach Bedarf verändern. Hierbei können Sie auch die für die Transkriptionsarbeit benötigten Typeninventare (s.u.) auswählen.
+
* ''' Edit metadata''': Otherwise you can see the complete metadata of an opus by clicking on ''Bearbeiten/edit''. Herein, you can also choose the '''type inventory''' needed for transcription (see below).
* ''' Edit metadata''': Otherwise you can see the complete metadata of a work by clicking on ''Bearbeiten/edit''. Now you can also choose the '''type inventory''' needed for transcribing (see below).
 
<!--Die zur Verfügung stehenden Metadatenfelder können im Vorfeld individuell an das Projekt angepasst werden. -->
 
 
<br clear=all>
 
<br clear=all>
 
<!--The available metadata can be adapted to the project in advance.-->
 
<!--The available metadata can be adapted to the project in advance.-->
 
<br clear=all>
 
<br clear=all>
[[File:TransEditorZuweisung.png | thumbnail | Zuweisen von Bearbeitern zu einzelnen Scanseiten | link=| alt=Zuweisen von Bearbeitern zu einzelnen Scanseite]]
+
[[File:TransEditorZuweisung.png | thumbnail | Allocating editors for single scan pages| link=| alt=Zuweisen von Bearbeitern zu einzelnen Scanseite]]
*'''Scans zuweisen''': Wenn sie über die Befugnisse eines Koordinators verfügen, können Sie rechts neben der ''Bearbeiten''-Schaltfläche die Scanliste aufrufen. Hier können Sie den einzelnen Projektmitarbeitern  Scans zur Bearbeitung zuweisen. Dazu markieren Sie die entsprechenden Scans und klicken auf die Schaltfläche ''Mitarbeiter zuweisen''. Eine Liste der Projektmitarbeiter öffnet sich. Wählen Sie den gewünschten Mitarbeiter aus und bestätigen Sie Ihre Auswahl mit ''Zuweisung''. Bereits erstellte Zuweisungen können sie per Klick auf ''Zuweisung entfernen'' wieder lösen. Anschließend sichern Sie ihre Änderungen per Klick auf ''Speichern''.
 
  
*'''Assign scans''': If you have the permissions of a coordinator, you can call up the scan list by clicking on the button right next to the ''Bearbeiten/edit'' button. For that purpose, select the corresponding scans and click on ''Mitarbeiter zuweisen/assign to collaborator''. Now a listing of project collaborator opens. Choose the collaborator and confirm your choice by clicking on ''Zuweisung/assign''. Assignments that are already selected, can be removed by clicking on ''Zuweisung entfernen/remove assignment''. Subsequently, you can save the changes by clicking on ''Speichern/save''.
+
*'''Assign scans''': If you have the permissions of a '''coordinator''', you can call up the scan list by clicking on the button right next to the ''Bearbeiten/edit'' button. Select the corresponding scans and click on ''Mitarbeiter zuweisen/assign to collaborator''. A list of project collaborator is opened. Choose the collaborator and confirm your choice by clicking on ''Zuweisung/assign''. Assignments that are already selected, can be removed by clicking on ''Zuweisung entfernen/remove assignment''. Subsequently, you can save the changes by clicking on ''Speichern/save''.
  
 
<br clear=all>
 
<br clear=all>
<!--Zuweisung pro Person irgendwo einsehbar?-->
 
  
===Drucktypen===  
+
===Print types===
[[File:TransEditorDrucktypenauswahl.png | thumbnail | Auswahl der Drucktypen | link=| alt=Auswahl der Drucktypen]]
+
 
Diese Ansicht zeigt einer Übersicht aller Drucktypen, die sich aktuell im System befinden.
+
[[File:TransEditorDrucktypenauswahl.png | thumbnail | Selection of print types| link=| alt=Selection of print types]]
 +
 
 +
This view shows an overview about all print types available in the editor.
 +
 
 +
By clicking on the ''Hinzufügen/add'' button, an input mask is opened in order to create a new print type.
 +
Metadata fields marked with an asterisk (*) are mandatory. Glyphs can be added either when a print type is created or afterwards.
  
Per Klick auf den Button ''Hinzufügen'' öffnet sich die Eingabemaske zum Anlegen einer neuen Drucktype. Die mit Sternchen gekennzeichneten Metadatenfelder müssen zum Speichern des Datensatzes befüllt werden, alle anderen Felder sind optional. Glyphen können sowohl beim Anlegen einer Drucktype als auch im Nachhinein einer Drucktype hinzugefügt werden.
 
 
<br clear=all>
 
<br clear=all>
'''Glyphensatz:'''
 
Das Anlegen und verknüpfen eines Glyphensatzes mit einer Drucktype erfolgt in 2 Schritten:
 
#Zunächst muss eine CSV-Datei erstellt werden, die alle zu verknüpfenden Glyphen als Unicode enthält. Bei Symbolen, die aus zwei Unicodes bestehen, müssen die beiden Unicodes in einer Zeile durch Tabulator getrennt voneinander angegeben werde.
 
#Die CSV-Datei kann nun in der Eingabemaske zum Erstellen eines neuen Drucktype im Abschnitt ''Glyphensatz'' ausgewählt und hochgeladen werden.
 
  
 +
'''Glyph set: '''
 +
Creating and linking of a glyph set is a 2-step task:
 +
 +
#First, a Unicode-formatted csv-file containing all glyphs to be linked needs to be created. For symbols that consist of two Unicodes entities (e.g. letters with diacritics), both Unicodes have to be written in the same line sepearated by a tabulator.
 +
#In the input mask, the csv-file now may be chosen to create a new print type in section "Glyphensatz/glyph set'' and then uploaded.
 +
 +
 +
'''Edit an existing print type:'''
 +
By clicking the ''Bearbeiten/edit''-button, the input mask for editing the chosen print type is opened. The displayed fields and functions are the same as in the input mask when creating a newc print type.
  
'''Bearbeiten einer vorhandene Drucktype:'''
+
'''Remove an existing print type:'''
Durch Klicken auf den Button ''Bearbeiten'' öffnet sich die Eingabemaske zum Bearbeiten der gewählten Drucktype. Die hier angezeigten Felder und Funktionen gleichen denen der Eingabemaske beim Erstellen der Drucktype.
+
By clicking on the split-button menu ''Entfernen/remove'', the confirmation dialogue to remove the chosen print type is opened.
  
'''Entfernen einer vorhandenen Drucktype''':
+
'''Display and edit a list of glyphs:'''
Durch Klicken auf das Split-Button-Menü ''Entfernen'' öffnet sich der Bestätigungsdialog zum Entfernen der gewählten Drucktype.
+
By clicking the split-button menu ''Glyphenliste/List of glyphs'', the dialogue to display the assigned glyphs is opened.
  
'''Anzeigen und Bearbeiten der Glyphenliste:'''
+
'''Edit the glyphs:'''
Durch Klicken auf das Split-Button-Menü ''Glyphenliste'' öffnet sich der Dialog zur Anzeige der Glyphen, die der Type zugewiesen sind.
+
The unicodes of the glyphs may be edited individually by clicking on the respective unicode.
  
'''Bearbeiten der Glyphen:'''
+
'''Mark as special sign:'''
Die Unicodes der Glyphen können, getrennt voneinander, durch ein Klicken auf den betreffenden Unicode bearbeitet werden.
+
The checkbox in the column ''Sonderzeichen/special signs'' shows if the glyphs in table may or my be not displayed for the opus in question.
  
'''Als Sonderzeichen markieren:'''
+
'''Remove glyphe'''
Die Checkbox in der Spalte „Sonderzeichen“ gibt an, ob die Glyphe in der Sonderzeichen-Tabelle eines Werks, dem die Type zugewiesen ist, angezeigt werden soll oder nicht.
+
The recycle bin icon in the last column allows the deletion of the corresponding glyphe.
  
'''Glyphe entfernen:'''
+
<!--Glyphe Hinzufügen '''??????????????'''
Der Abfalleimer in der letzten Spalte ermöglicht das Löschen der jeweiligen Glyphe.
 
<!--Glyphe Hinzufügen
 
 
???
 
???
 
-->
 
-->
 
<!--
 
<!--
===Aufbewahrungsorte===  
+
=== Storage location===
 
-->
 
-->
  
==Arbeit mit dem Editor==
+
== Work with the editor==
<!--===Synoptische Ansicht===-->
+
<!--===Synoptic view===-->
===Glyphenauswahl===
+
===Selection of glyphs===
Für die Auswahl der benötigten Spezialglyphen stehen derzeit zwei Schaltflächen mit unterschiedlichem Layout zur Verfügung – die eine als vertikale Auswahl am Rand, die andere als tastaturähnliche Überblendung. Sie können selbst entscheiden, mit welcher Schaltfläche Sie komfortabler arbeiten können; die Funktionsweise ist in beiden Fällen gleich: Durch einen Klick auf die entsprechende Glyphe wird diese an der aktuellen Position des Cursors in den Text eingefügt. Die hierbei zur Verfügung stehenden Glyphen können zuvor in den Metadaten des Werks angepasst werden.  
+
 
 +
To select the required special glyphs, there are currently two panels with a different layout available: One on the left for vertical selection, the other as a keyboard-like cross-fading panel. You may decide for your own which of these panels ist more comfortable for you. The functions are the same for both: By clicking on the relevant glyph, the glyph will be inserted at the current position of the cursor. The available glyph sets may be adjusted beforehand in the metadata of the opus .
 +
 
 
<!--
 
<!--
 
===Copy-Paste===
 
===Copy-Paste===
===Suchen und Ersetzen===
+
===Search and replace ===
 
-->
 
-->
===Vom Entwurf zum Release===
+
===From draft to release===
Die Arbeit mit dem Editor ist für die Zusammenarbeit von Mitarbeitern (z.B. studentischen Hilfskräften) und Koordinatoren als Kontrollinstanz ausgelegt: Mitarbeiter können die Ihnen zugewiesenen Transkriptionen im Editor bearbeiten, als Entwurf zwischenspeichern oder diesen abschließend als Release-Kandidaten an die zuständigen Koordinatoren weiterleiten. Diese können den Vorschlag annehmen oder zur erneuten Bearbeitung zurückschicken.
+
The workflow of the transcription editor optimized for collaboration of '''collaborants''', e.g. student assistants, and '''coordinators''' as supervision authority.
 +
'''Collaborants''' can edit their assinged transcriptions, save them as a draft or transmit the concluding release candidate to the appropriate coordinator. Coordinators may accept the proposal or send it back for revision.
 +
 
 
  [[File:WorkflowTranskriptionseditor.jpg|center|600px|link=]]
 
  [[File:WorkflowTranskriptionseditor.jpg|center|600px|link=]]
Per Klick auf ''Speichern'' oder ''Entwurf'' können sie Ihre Bearbeitungen speichern.  Wenn Sie glauben, den Text korrekt transkribiert oder alle Fehler gefunden zu haben, können Sie ihre Bearbeitung als Release-Kandidat festlegen. Der Status der Transkription ändert sich in diesem Fall zu ''Release-Kandidat''. Wenn Sie Mitarbeiter sind, wird der Scan für die weitere Bearbeitung gesperrt, bis ein Koordinator die Arbeit begutachtet hat.
 
  
Als Koordinator können Sie sich entscheiden, den Release-Kandidat wieder abzulehnen. In diesem Fall wird der Text als ''Abgelehnt'' gekennzeichnet und erneut zur Bearbeitung vorgelegt. Wählen sie die Option ''Abbrechen'', wird der Text dagegen nicht erneut vorgelegt. Wenn Sie mit der Bearbeitung des Textes zufrieden sind, können Sie den Release-Kandidaten als korrekte Version ''bestätigen''.
 
  
Egal, ob Sie den Text abgelehnt, abgebrochen, oder bestätigt haben: Als Koordinator können Sie den Text jederzeit erneut als Entwurf einstufen. Darüber hinaus besitzen Koordinatoren alle Bearbeitungsrechte, die auch Mitarbeiter besitzen, und können Korrekturen jederzeit auch in Eigenregie vornehmen.
+
'''Translation:'''
 +
{|
 +
|Bearbeiten || = edit
 +
|-
 +
| Entwurf || = draft
 +
|-
 +
|Release-Kandidat  || = release candidate
 +
|-
 +
|Kontrolle (Koordinator) || = check (coordinator)
 +
|-
 +
|Bestätigen || = confirm
 +
|-
 +
|Abbrechen der Bearbeitung || = cancel editing
 +
|-
 +
|Ablehnen || = decline
 +
|}
 +
 
 +
 
 +
By clicking on ''Speichern/save'' or ''Entwurf/draft'', you can save you work. If you think that you have transcribed the text correctly and found all faults, you can define your progress as a ''release candidate''. In this case, the status changes to "release candidate". If you are a '''collaborant''', the scan is then locked for further editing until a coordinator has examined your work.
 +
 
 +
As a '''coordinator''', you cab decide to decline the release candidate. In this case, the text is marked as ''Abgelehnt/declined'' and submitted for re-editing to the chosen collaborant. If you choose ''Abbrechen/abort'', the text is marked as ''Abgelehnt/declined'' and is not submitted again. If you are satisfied with the work, you may ''bestätigen/confirm'' the release-candidate as the correct version.
 +
 
 +
Note that wether or not you declined, aborted or confimed a text, as a '''coordinator''', you can "re-evaluate" it as draft at any time.
 +
Furthermore, coordinators have all permisstion to edit texts just like collaborants as well and can correct themselves at anytime.
 +
 
 
</div>
 
</div>
 
{{Sprachauswahl|Tutorial transcription editor (en)|Tutorial Transkriptionseditor}}
 
{{Sprachauswahl|Tutorial transcription editor (en)|Tutorial Transkriptionseditor}}

Aktuelle Version vom 5. September 2017, 09:37 Uhr

Scope of the transcription editor

 Benutzeroberfläche des Transkriptionseditors
User interface of transcription editor

Whether or not a text needs to be transcribed or a recognized text needs to be corrected, especially historic literature is very demanding on human transcriptors and proofreaders. These texts are particularly based on special characters and abbreviations that doesn't exist on regular computer keyboards.Unicode-equivalents and the applicable digital print types need to be defined in advance and manually transfered into the transcribing text. Errors and irregularities are inevitable if they are not prevented by means of a wise working environment and well-defined workflow. Furthermore, the staff hierarchy of many projects of transcribition requires a user management that allows for a "correcting of the correcture" by qualified staff. The development of Narragonien digital serves these requirements by means of an intuitive and operating system-independend web-based user interface.

The transcription editor enables the creation of exact character matching transcriptions in a controlled environment including the verification of correct encoding, full control about data (scans and electronic texts), as well as the consequent usage of MUFI-Fonts for special character encoding. A hierachical system of user privileges allow for the inclusion of student assistants and seminar participants.

Technical data

  • Web application
  • Technology: Java EE with GlassFish-Server
  • CKEditor based user interface
  • MUFI-based unicodes and fonts for transcriptions
  • User account control with rights management system

Access to the editor

After adaption and activation for the respective projects, the transcription editor is available as a seperate web application. In order to work with the editor, you need a password-protected account.

Different security roles can be allocated to your user account:

  • Gäste/guests can watch allocated pages in the editor, but they may not edit them (currently not available).
  • Mitarbeiter/collaborators may watch an opus as well as single text pages and may edit them when allocated by a coordinator.
  • Koordinatoren/coordinators may edit any text and my also allocate pages for editing to selective collaborators. Subsequently, they may check their progress and choose the final version for transcription. Furthermore, they may add new collaborators and coordiantors.
  • Administratoren/administrators have the same privileges as coordinators. Additionally, the have privileges to access extended system settings of the editor and the whole web environment.

User administration

Access to user and privileges management is only accessible to administrators and coordinators. By clicking on Administration/administration -> Benutzerverwaltung/user management an overview about all registered users ist opened.

Every entry may be edited by clicking on Bearbeiten/edit or deleted by clicking on Entfernen/remove. New users can be added by clicking on Hinzufügen/add.

Document management

The document administration is also only accessible to Administratoren/administrators and Koordinatoren/coordinators. Furthermore, adding a new opus is also only available to Administratoren/administrators and requires writing permissions to the server directory.

By means of document management, users with corresponding permissions may edit the opus and their corresponding metadata.

By clicking on Hinzufügen/add, the input mask for creating a new opus is opened. Metadata fields that are marked with an asterisk (*) are mandatory, other fields are optional. If new print types and physical depositories of the original texts must be linked during the creation of an opus, they have to be created in advance in the tabs Drucktypen/print types and Aufbewahrungsorte/depository, respectively.

Werk/opus

Auswahl der angezeigten Tabellenspalten
Selection of displayed spread sheet columns
  • Tabular overview: In this menu item, you see a tabular overview of all opus. By clicking on the Spalten/columns button, you may configure the shown columns by yourself. You may display important metadata, if you miss any.


Bearbeiten der Metadaten eines Werksn
Editing the metadata of an opus
  • Edit metadata: Otherwise you can see the complete metadata of an opus by clicking on Bearbeiten/edit. Herein, you can also choose the type inventory needed for transcription (see below).



Zuweisen von Bearbeitern zu einzelnen Scanseite
Allocating editors for single scan pages
  • Assign scans: If you have the permissions of a coordinator, you can call up the scan list by clicking on the button right next to the Bearbeiten/edit button. Select the corresponding scans and click on Mitarbeiter zuweisen/assign to collaborator. A list of project collaborator is opened. Choose the collaborator and confirm your choice by clicking on Zuweisung/assign. Assignments that are already selected, can be removed by clicking on Zuweisung entfernen/remove assignment. Subsequently, you can save the changes by clicking on Speichern/save.


Print types

Selection of print types
Selection of print types

This view shows an overview about all print types available in the editor.

By clicking on the Hinzufügen/add button, an input mask is opened in order to create a new print type. Metadata fields marked with an asterisk (*) are mandatory. Glyphs can be added either when a print type is created or afterwards.


Glyph set: Creating and linking of a glyph set is a 2-step task:

  1. First, a Unicode-formatted csv-file containing all glyphs to be linked needs to be created. For symbols that consist of two Unicodes entities (e.g. letters with diacritics), both Unicodes have to be written in the same line sepearated by a tabulator.
  2. In the input mask, the csv-file now may be chosen to create a new print type in section "Glyphensatz/glyph set and then uploaded.


Edit an existing print type: By clicking the Bearbeiten/edit-button, the input mask for editing the chosen print type is opened. The displayed fields and functions are the same as in the input mask when creating a newc print type.

Remove an existing print type: By clicking on the split-button menu Entfernen/remove, the confirmation dialogue to remove the chosen print type is opened.

Display and edit a list of glyphs: By clicking the split-button menu Glyphenliste/List of glyphs, the dialogue to display the assigned glyphs is opened.

Edit the glyphs: The unicodes of the glyphs may be edited individually by clicking on the respective unicode.

Mark as special sign: The checkbox in the column Sonderzeichen/special signs shows if the glyphs in table may or my be not displayed for the opus in question.

Remove glyphe The recycle bin icon in the last column allows the deletion of the corresponding glyphe.


Work with the editor

Selection of glyphs

To select the required special glyphs, there are currently two panels with a different layout available: One on the left for vertical selection, the other as a keyboard-like cross-fading panel. You may decide for your own which of these panels ist more comfortable for you. The functions are the same for both: By clicking on the relevant glyph, the glyph will be inserted at the current position of the cursor. The available glyph sets may be adjusted beforehand in the metadata of the opus .

From draft to release

The workflow of the transcription editor optimized for collaboration of collaborants, e.g. student assistants, and coordinators as supervision authority. Collaborants can edit their assinged transcriptions, save them as a draft or transmit the concluding release candidate to the appropriate coordinator. Coordinators may accept the proposal or send it back for revision.

WorkflowTranskriptionseditor.jpg


Translation:

Bearbeiten = edit
Entwurf = draft
Release-Kandidat = release candidate
Kontrolle (Koordinator) = check (coordinator)
Bestätigen = confirm
Abbrechen der Bearbeitung = cancel editing
Ablehnen = decline


By clicking on Speichern/save or Entwurf/draft, you can save you work. If you think that you have transcribed the text correctly and found all faults, you can define your progress as a release candidate. In this case, the status changes to "release candidate". If you are a collaborant, the scan is then locked for further editing until a coordinator has examined your work.

As a coordinator, you cab decide to decline the release candidate. In this case, the text is marked as Abgelehnt/declined and submitted for re-editing to the chosen collaborant. If you choose Abbrechen/abort, the text is marked as Abgelehnt/declined and is not submitted again. If you are satisfied with the work, you may bestätigen/confirm the release-candidate as the correct version.

Note that wether or not you declined, aborted or confimed a text, as a coordinator, you can "re-evaluate" it as draft at any time. Furthermore, coordinators have all permisstion to edit texts just like collaborants as well and can correct themselves at anytime.