Das Paper auf GitHub ablegen

Init, Hilfsdateien ignorieren, privates Repo, Gewohnheiten, die Merges mit Koautoren beherrschbar halten.

Das Paper auf GitHub ablegen

Ein LaTeX-Manuskript ist reiner Text und passt deshalb ideal zu Git. Jeder Entwurf wird zu einem Commit, zu dem Sie zurückkehren können, jede Änderung ist als zeilenweiser Diff sichtbar, und GitHub liefert Ihnen eine externe Kopie sowie einen Weg für Koautoren, den aktuellen Stand abzuholen. Nichts davon setzt fortgeschrittene Git-Kenntnisse voraus. Ein Paper braucht vielleicht fünf Befehle, konsequent angewendet.

Die Ersteinrichtung

Terminalfenster
git init
# add a .gitignore for *.aux *.log *.out *.toc *.synctex.gz
git add main.tex refs.bib figures/
git commit -m "Initial manuscript"
gh repo create my-paper --private --source=. --push

Führen Sie das einmal im Projektordner aus. Der Schritt mit der .gitignore ist wichtiger, als er aussieht. Jede Kompilierung erzeugt die Dateien .aux, .log, .out, .toc und .synctex.gz neu. Committen Sie sie, begraben sie Ihre eigentlichen Änderungen unter Maschinenrauschen und verursachen sinnlose Merge-Konflikte zwischen Koautoren. Verfolgen Sie nur, was Sie selbst schreiben: die .tex-Quellen, die .bib-Datenbank, Abbildungen und alle Klassen- oder Stildateien, die Ihnen die Veranstaltung vorgegeben hat. Auch das PDF ist ein Build-Produkt. Die meisten Teams lassen es weg und bauen es lokal neu, auch wenn das Anhängen an einen getaggten Release ein sinnvoller Weg ist, eine eingereichte Fassung festzuhalten. Halten Sie das Repository privat, bis die Arbeit öffentlich ist. Ein unveröffentlichtes Manuskript gehört nicht in einen Index.

Gewohnheiten, die Koautoren bei Laune halten

Machen Sie jeden Commit zu einer logischen Änderung, etwa „Einleitung von Abschnitt 3 überarbeitet“ oder „Ablationstabelle hinzugefügt“. Dann liest sich der Verlauf wie die Geschichte des Papers, und eine schlechte Änderung lässt sich ohne Kollateralschäden zurücknehmen. Holen Sie vor einer Schreibsitzung den aktuellen Stand per Pull und pushen Sie, wenn Sie aufhören. Merge-Konflikte wachsen mit der Zeit, die Branches getrennt verbringen. Erzwingen Sie niemals einen Push auf einen gemeinsamen Branch, nachdem Koautoren ihn gepullt haben: Das schreibt ihnen die Historie unter den Füßen um. Halten Sie große Binärdateien (Datensätze, Videos) aus dem Repository des Papers heraus. Verlinken Sie ein Archiv oder nutzen Sie ein eigenes Daten-Repository. Git speichert jede Version jeder Binärdatei für immer.

Eine Gewohnheit speziell für LaTeX: Ein Satz pro Quelltextzeile macht Diffs deutlich lesbarer, denn eine Änderung von einem Wort erscheint als Änderung einer Zeile statt als umbrochener Absatz.

Wie Oleafly dazu passt

Jedes Oleafly-Projekt ist ein gewöhnlicher Ordner auf der Festplatte, deshalb funktionieren diese Befehle unverändert. Oleafly hält geeignete erfolgreiche Builds mit geändertem Quelltext in Gespeicherte Checkpoints fest, getrennt von Git. Committen Sie bewusst in der Versionsverwaltung und pushen oder pullen Sie dann mit Ihren Mitarbeitenden. Siehe Git-Verlauf. Zusammenarbeitsmuster, die darauf aufbauen, darunter Patch-Austausch und Kapitelzuständigkeit, finden Sie unter Koautoren ohne Live-Cursor.

Zurück zu Das lokale Studio