2020-01-11 Weingarten

TUSTEP-Workshop 2020

TUSCRIPT, Git & GitHub

XML2RTF

online https://digicademy.github.io/2020_Weingarten

Thomas Kollatz, Akademie Mainz | Digitale Akademie Mainz

Aufbau

• TUSCRIPT, Git & GitHub
• XML2RTF

01

TUSCRIPT, Git & GitHub

Aufbau

#*vemo

Das Makro *VEMO vergleicht edierte Daten mit den Originaldaten. Es erwartet, dass die Daten in der zur Spezifikation DATEI angegebenen Datei mit dem Editor oder mit dem Kommando #HOLE aus einer anderen Datei "geholt" wurden. Die geholten Daten können entweder eine gesamte Datei oder nur ein Segment einer Datei umfassen. Das Makro vergleicht die Daten in der angegebenen Datei mit den entsprechenden Daten in der Datei, aus der sie geholt wurden.

#in,vemo

Git

Software zur Versionsverwaltung

Global Information Tracker

Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.

Getting started with Git and GitHub: the complete beginner's guide

GitHub

Webinterface

GitHub is a global company that provides hosting for software development version control using Git. […] It offers all of the distributed version control and source code management (SCM) functionality of Git as well as adding its own features. It provides access control and several collaboration features such as bug tracking, feature requests, task management, and wikis for every project.

GitHub From Wikipedia, the free encyclopedia

TUSTEP Beispielprojekt

• Das Skript gt_lt transformiert XML-Codes (Tags, entities) in die entsprechende Character Data Zeichendaten:
  <tag> (XML) wird <tag> (CDATA)
• Das Skript gt_lt wird als Segment der Datei sample.ini in einem beliebigen Skripteditor in ISO-8859-1 geschrieben: #=: gt_lt

• copy, transform, and paste

• Git zeigt die Versionsgeschichte binärer Dateien nicht an, also kein git diff für TUSTEP-Dateien im TUSTEP-Datei-Format.
• Da sample.ini keine TUSTEP-Datei ist und als INI-Datei eines TUSTEP-Projekts dienen soll, muss der Name dieser Datei mit der TUSTEP-Systemvariablen TUSTEP_INI vorgegeben werden.

Systemvariable TUSTEP_INI

Die INI-Datei ist eine TUSTEP-Datei mit dem vorgegebenen Namen TUSTEP.INI. Soll als INI-Datei eine ASCII-Datei oder eine Datei mit einem anderen Namen verwendet werden, so muss der Name dieser Datei mit der System-Variablen TUSTEP_INI vorgegeben werden; andernfalls sollte diese System-Variable nicht definiert werden. Falls die INI-Datei eine ASCII-Datei ist, kann sie in ASCII oder ISO-8859-1 codiert sein.

Handbuch, 75

Git Aktionen

man git

Repositorium auf GitHub

• anlegen eines Repositoriums auf Github.
• Beispielrepositorium:

  https://github.com/KollatzThomas/tustep_sample

• vorbereiten eines existierenden Repositioriums für die Versionierung mit git init:

• git init
  git add .
  git commit -m "first commit"

Push an existing Repository

                    git remote add origin https://github.com/<yourname>/<yourgitrep>.git
git push -u origin master
                

Clone

cd ~/Downloads/
mkdir github
cd github
git clone https://github.com/KollatzThomas/tustep_sample

Potential und Anwendungsszenarien

Kollaborative TUSTEP Musterskripte auf GitHub vorhalten,

Komplexere TUSTEP-Projekte versionieren.

Literatur

• Repositorium tustep_sample
• GIT-Downloads, Win
• github-cheat-sheet
• Anna Neovesky, Jörg Hambuch (Digitale Akademie), GIT Erste Schritte mit dem Versionskontrollsystem, Mainz International Summer School 2019 – Digitale Methodik in den Geistes- und Kulturwissenschaften
• Moritz Stückler, Was ist eigentlich Github?, t3n 2016
• HoangVM, medium.com 2019-03-19 Why you should not push binary files to git? And what to do if you do ?

02

XML2RTF

Aufbau

Präsentationen zu #*export

• Hans-Werner Bartz, Thomas Kollatz, REQUEST | #*export: Webservices nutzen mit TUSTEP – XML2RTF , Trier 2019
• Thomas Kollatz, REQUEST and ACCESS Webservices abfragen und Daten anreichern, Potsdam 2018
• Marjam Trautmann, Thomas Kollatz, Der Sturm und die europäische Avantgarde: Eine digitale Edition mit X-Technologien und TUSTEP, Darmstadt 2017
• Thomas Kollatz, Von TEI XML zu MS Word, Darmstadt 2017
• … zahlreiche mit [#*import-]#*export, d.h. über Definitionen (strukturiert und kontrolliert) gestaltete RTF-Dateien (Artikel, Berichte, …)

#*export in Webumgebung

• RTF ist nicht geeignet als programmunabhängiges und systemübergreifendes Austausch- und Archivformat.
• Zu diesem Zweck sind Formate wie JSON-LD und Auszeichnungssprachen wie TEI XML weit besser geeignet.
• Das Rich Text Format empfiehlt sich jedoch dann, wenn Forschungsdaten direkt in gängige Textverarbeitungsprogramme zu integrieren sind.
• Das TUSTEP Modul #*export setzt wohlgeformtes XML voraus, es spricht also nichts dagegen als Grundlage für einen RTF-Export auf das weitverbreitete TEI-XML zurückzugreifen.

TEI und DOCX/RTF

Subject: Aw: AW: transform tei to docx in oxygen

Dear all,

maybe the TUSTEP tool would work work here, too? It allows, e.g., the transformation of a RTF into XML and other formats. The tool needs a bit of training, I must admit.

Best, Christian

Christian M. Prager, transform tei to docx, 2019-05-17

Beispiel

epidat Forschungsplattform jüdische Grabsteinepigraphik

Workflow

epidat.sty

<dstyle hyphenation=off size=12 pagination=none/>
<alias alias=ptr tag=dummy/>
<pstyle name=h1 size=14 style=b align=center/>
<pstyle name=h2 size=14 />
<pstyle name=hdr-p size=12 bgc=ff6347 fgc=white style=b/>
<pstyle name=ftr-p size=12 bgc=ff6347 fgc=white style=b/>
<alias alias=transcription tag=p/>
<alias alias=edition tag=p/>
<alias alias=td tag=tc/>
<alias alias=TEI tag=document/>
<alias alias="teiHeader" tag=ignore/>
<alias alias="facsimile" tag=ignore/>
<alias alias="text" tag="dummy"/>
<alias alias="body" tag="dummy"/>
<alias alias="lb" tag=br ignore=n/>
<alias alias="ab" tag=dummy/>
<alias alias="bibl" tag=ignore/>
<alias alias="ref" tag=ignore/>
<alias alias="div" tag=dummy ignore=type'subtype/>
<alias alias="head" tag=ignore/>
<cstyle name=heb start="#h+" end="#h-" size=10/>
<alias alias="label" tag=b/>
<alias alias=supplied tag=dummy/>

Content-Type: application/RTF

Die Verwendung der System-Variablen TUSTEP_CGI ist nur sinnvoll, wenn TUSTEP über WWW durch einen WWW-Server im Batch-Modus aufgerufen wird. Mit ihr wird der Name des Segments in der INI-Datei festgelegt, dessen Inhalt als CGI-Makro ausgeführt werden soll. Hinter dem Segmentnamen muss zusätzlich der Code angegeben werden, in dem die vom CGI-Makro erzeugte Standard-Ausgabe codiert werden soll. Als Codes sind ISO-8859-1 und UTF-8 vorgesehen. Segmentname und Code-Angabe müssen durch einen Schrägstrich getrennt werden.
In Sonderfällen können hinter der Code-Angabe zwei Schrägstriche folgen. In diesem Fall wird die unbedingt notwendige Content-type-Information nicht automatisch von TUSTEP ausgegeben, sondern muss vom CGI-Makro ausgegeben werden.

Handbuch, 75

RTF-Download

ERROR/STOP OPEN ("epidat.sty",READ,-std-)
EXECUTE/QUIET #*export,{tf},{rtf},de=epidat.sty,lo=+
ERROR/STOP DELETE (tf)
length=BYTES (rtf)
MODE DATA
Content-Type: application/rtf; Charset=UTF-8
Content-Disposition: attachment; filename="{rtf}"
Content-Length: {length}

$$ INCLUDE/BINARY/FILE $rtf
$$ ERROR/STOP DELETE (rtf)

INCLUDE/BINARY/FILE $rtf Die in der angegebenen Datei enthaltenen Daten werden binär, d.h. unverändert in die Standard-Ausgabe eingefügt. [Diese Anweisung ist nur in einem CGI-Makro erlaubt.]

Handbuch, 448

Fazit

#*export kann in jeden XML-Workflow integriert werden.

#*export setzt wohlgeformtes XML voraus und zwar sowohl bei der Quelldatei, als auch bei der Definitionsdatei, die Definitionen der Tags enthält.

#*export ermöglicht es kontrolliert eine Textdatei auf Grundlage strukturierter Daten zu erstellen.

Desiderat

#*export als Webservice

#*export öffnen für XML-Dateien als Quell-Datei und Definitionen-Datei