Differences

This shows you the differences between two versions of the page.

--- doku:wissenschaftliches_schreiben_mit_git_und_latex [2015/09/27 10:02] – [Erste Schritte] TODO: .gitignore schon beim Anlegen erstellen zu kompliziert? daniel
+++ doku:wissenschaftliches_schreiben_mit_git_und_latex [2020/05/25 22:03] (current) – [Siehe auch] SLUB-Artikel zum Wiss.schreiben verlinkt Norman
@@ Line 3: / Line 3: @@
 **Diese Anleitung ist noch unvollständig und wird weiter ausgebaut.**
-[[https://de.wikipedia.org/wiki/LaTeX|LaTeX]] ist als Textsatzprogramm zum Erstellen wissenschaftlicher Arbeiten, Artikel und Bücher im akademischen Umfeld weit verbreitet. Vorteile sind einfacher Mathematiksatz, Erweiterbarkeit und Anpassbarkeit durch Pakete und eigene Makros, sowie die unübertroffene Satzqualität. Außerdem erlaubt das Textformat Automatischisierung mit einfachen Skripten.
+[[https://de.wikipedia.org/wiki/LaTeX|LaTeX]] ist als Textsatzprogramm zum Erstellen wissenschaftlicher Arbeiten, Artikel und Bücher im akademischen Umfeld weit verbreitet. Vorteile sind einfacher Mathematiksatz, Erweiterbarkeit und Anpassbarkeit durch Pakete und eigene Makros, sowie die unübertroffene Satzqualität. Außerdem erlaubt das Textformat Automatisierung mit einfachen Skripten.
-In diesem Tutorial soll es um einen anderen Vorteil gehen, den LaTeX für das akademische Schreiben hat: Das Textformat erlaubt die Verwendung eines Versionskontrollsystems. Die Zielgruppe dieser Anleitung sind alle, die LaTeX schon verwenden (oder gerade erlernen) und keine Angst vor der Shell haben (und am besten ein Unix-System verwenden).
+LaTeX-Kurs von Daniel und Tom an der HTW Dresden
+  * {{ :doku:latex:htw-kurs:lecture-00-intro.pdf | Intro}}
+  * {{ :doku:latex:htw-kurs:lecture-01-basics-1.pdf | Basics 1}}
+  * {{ :doku:latex:htw-kurs:lecture-02-basics-2.pdf | Basics 2}}
+  * {{ :doku:latex:htw-kurs:lecture-03-math.pdf | Mathematik }}
+  * {{ :doku:latex:htw-kurs:lecture-04-citation.pdf | Literatur zitieren}}
+  * {{ :doku:latex:htw-kurs:lecture-05-macros.pdf | Makros, Umgebungen und Debugging}}
+  * {{ :doku:latex:htw-kurs:lecture-06-tikz.pdf | Grafiken mit TikZ}}
+  * {{ :doku:latex:htw-kurs:lecture-07-beamer.pdf | Präsentationen mit Beamer}}
+  * Quellcode und Übungen: https://gitea.c3d2.de/dbo/latex-course
-===== Eine Kurze Einführung in Verteilte Versionskontrolle und git =====
+Weiterführende Links:
-s.a. [[http://c3d2.de/news/ta-gitbasics.html | Themenabend Git Basics beim c3d2]]
+  * [[doku:latex:latex_links_infos|LaTeX - Links und Infos]]
+In diesem Tutorial soll es nun um einen anderen Vorteil gehen, den LaTeX für das akademische Schreiben hat: Das Textformat erlaubt die Verwendung eines Versionskontrollsystems. Die Zielgruppe dieser Anleitung sind alle, die LaTeX schon verwenden (oder gerade erlernen) und keine Angst vor der Shell haben (und am besten ein Unix-System verwenden).
+===== Eine Kurze Einführung in Verteilte Versions- & Variantenverwaltung und git =====
 Die Idee von Versionskontrollsystem ist, dass man zu einem Dokument (oder einem Verzeichnisbaum) auch auf alle vorigen Versionen zugriff hat und Werkzeuge hat um Änderungen zu verwalten (z. B. abgleichen mit den Änderungen die jemand anderes an den Dateien vorgenommen hat, paralleles Bearbeiten verschiedener Versionen). Außerdem machen Versionskontrollsysteme es leicht die gesamten Daten auf mehrere Computer zu verteilen und synchron zu halten. Ein Verzeichnisbaum zusammen mit seiner Bearbeitungsgeschichte nennt man //Repository// (kurz Repo).
-git gehört zu der (modernen) Klasse der Verteilten Versionskontrollsysteme, das heißt, dass jede Kopie der Daten technisch gleichberechtigt ist (es ist lediglich eine Frage der Konvention, welche Version die "offzielle" ist). Es können also mehrere Nutzer //gleichzeitig// an den Dokumenten arbeiten, und wenn sie das abgeschlossen haben, können sie git verwenden um die Versionen zu einer zusammenzuführen (//mergen//) die die Änderungen beider enthält. Falls beide die gleiche Stelle bearbeitet haben sollten, dann gibt es einen //Konflikt//, der manuell aufgelöst werden muss.
+Die Variantenverwaltung ergänzt dieses Konzept der linear aufeinander folgenden Versionen durch Branches (auf deutsch etwa: Äste oder Zweige). Dies wird aber erst später im Abschnitt über Branches behandelt.
+git gehört zu der (modernen) Klasse der Verteilten Versionskontrollsysteme, das heißt, dass jede Kopie der Daten technisch gleichberechtigt ist (es ist lediglich eine Frage der Konvention, welche Version die "offizielle" ist). Es können also mehrere Nutzer //gleichzeitig// an den Dokumenten arbeiten, und wenn sie das abgeschlossen haben, können sie git verwenden um die Versionen zu einer zusammenzuführen (//mergen//) die die Änderungen beider enthält. Falls beide die gleiche Stelle bearbeitet haben sollten, dann gibt es einen //Konflikt//, der manuell aufgelöst werden muss.
 Im nächsten Abschnitt wird allerdings zunächst gezeigt, warum git auch für einen einzeln Arbeitenden von Vorteil ist.
@@ Line 19: / Line 35: @@
 Weiterführende Links:
-   * TODO
+   * [[http://c3d2.de/news/ta-gitbasics.html | Themenabend Git Basics beim c3d2]]
 ===== Beispiel: git für Einen =====
@@ Line 29: / Line 46: @@
 Bob schreibt eine Hausarbeit. Da er in der Vergangenheit schon oft durch Missgeschicke Änderungen verloren hat oder nach fehlgeschlagenen Verbesserungen an einem Absatz diese nicht wieder loswerden konnte ohne die Verbesserungen an einem anderen Absatz mühsam manuell in seine Sicherheitskopie zu übertragen, möchte er nun git für die Versionsverwaltung einsetzen.
+==== Konfiguration ====
+Erstmal Konfiguriert Bob seine git Installation. Dies erfolgt am besten mit Kommando ''%%git config --global%%''. Durch das ''%%--global%%'' werden die Konfigurationsvariablen in der Datei ''~/.gitconfig'' als Bobs Voreinstellungen ablegt. Er setzt seinen Namen und seine E-Mail-Adresse, die beide in seinen Commits im Repository verzeichnet werden:
+   $ git config --global user.name "Bob Penguin"
+   $ git config --global user.email "bob@penguin.example"
 ==== Erste Schritte ====
@@ Line 76: / Line 99: @@
   $ git add arbeit.tex
-  $ git commit
+  $ git commit -m "Einleitung geschrieben"
-Nun öffnet sich ein Texteditor (in der Regel vi, das ist in der Umgebungsvariable ''$EDITOR'' festgelegt), dort tippt Bob nun eine //Commit Message//, die eine Zusammenfassung seiner Änderungen enthält:
+Alternativ könnte er auch nur ''git commit'' (ohne die ''-m'' -Option) eingeben und seine //Commit Message//, also eine kurz Beschreibung seiner Änderungen, in einem Texteditor eingeben, der dann automatisch geöffnet würde (in der Regel vi, das ist in der Umgebungsvariable ''$EDITOR'' festgelegt). Dort tippt Bob nun eine //Commit Message//, die eine Zusammenfassung seiner Änderungen enthält:
   Einleitung geschrieben
-Sobald er diese speichert und den Editor verlässt (vi '':wq'') ist die aktuelle Version der Arbeit gesichtert.
+Sobald er diese speichert und den Editor verlässt (im vi: Esc-Taste und dann '':wq'' eintippen) ist die aktuelle Version der Arbeit gesichtert.
 Um von den Änderungen auch eine Sicherheitskopie zu haben muss er nur in das Verzeichnis auf dem USB-Stick wechseln und
@@ Line 100: / Line 123: @@
 ==== Branches, Merges und ''git revert'' ====
-TODO
+Zunächst wird kurz erklärt was ein git Repsository eigentlich ist.
+Die Geschichte in einem git Repository ist ein azyklischer, gerichteter Graph von Revisionen (Zustände der Ordnerstruktur samt Inhalt). Jeder Knoten des Graphen stellt einen "Snapshot" des Zustandes dar, der mit Metadaten dekoriert ist (Autor, Commit-Nachricht, ...). Wir repräsentieren die Graphen wie folgt, hier ein Repo mit drei Commits (A, B, C):
+    A    B    C
+    o<---o<---o
+Aus dem Graphen und dem Inhalt des Commits wird die Commit-ID per kryptographischer Checksumme abgeleitet und
+identifiziert den Commit eindeutig (mit astronomisch kleiner Chance einer Kollision).
+Zusätzlich dazu enthält das Repository den ''working tree'' also die Ordner- und Dateistruktur mit den Dateiinhalten an denen gearbeitet wird und den Index (staging area), den man als vorläufigen Commit verstehen kann.
+Die Graphenstruktur erlaubt mehrere konkurrente Änderungen über einer Basisversion.
+          D    E
+          o<---o
+    A    /
+    o<---o<---o
+         B    C
+Branches funktionieren wie "Lesezeichen" im Commit-Graphen.
+          D    E <- bugfix
+          o<---o
+    A    /
+    o<---o<---o
+         B    C <- master <- HEAD
+Der Commit der aktuell der Bezugspunkt für die git-Operationen ist wird mit ''HEAD'' bezeichnet.
+Um einen Branch zu wechseln wird das Kommando ''git checkout'' verwendet:
+    $ git checkout bugfix
+Danach sieht der Graph wie folgt aus:
+          D    E <- bugfix <- HEAD
+          o<---o
+    A    /
+    o<---o<---o
+         B    C <- master
+Das Arbeitsverzeichnis und der Index werden auf den Zustand der im Commit verzeichnet ist gesetzt.
+Um am aktuellen Commit einen neuen Branch zu erzeugen verwendet man:
+   $ git branch neuer-branch
+Danach kann man ihn mit ''git checkout'' auschecken. Kurz geht das mit einer Operation:
+   $ git checkout -b neuer-branch
+Nach dieser Operation sieht der Graph wie folgt aus:
+                 <- neuer-branch <- HEAD
+          D    E <- bugfix
+          o<---o
+    A    /
+    o<---o<---o
+         B    C <- master
+Nun können wir unsere Dateien bearbeiten und neue Commits erzeugen. Diese werden dann im aktuellen Branch verzeichnet:
+                <- bugfix    <- neuer-branch <- HEAD
+          D    E      F     G
+          o<---o<-----o<----o
+    A    /
+    o<---o<---o
+         B    C <- master
+Nun haben wir mehrere Branches, nun ist das Ziel diese wieder zusammenzuführen, dies funktioniert mit ''git merge'':
+   $ git checkout bugfix
+   $ git merge neuer-branch
+Danach sieht unser Graph so aus:
+                             <- bugfix  <- HEAD
+                             <- neuer-branch
+          D    E      F     G
+          o<---o<-----o<----o
+    A    /
+    o<---o<---o
+         B    C <- master
+Diese Form des merges nennt man fast-forward (Vorspulen). Darüber hinaus gibt es "echte Merges",
+wenn wir nun ''bugfix'' in ''master'' mergen:
+   $ git checkout master
+   $ git merge bugfix
+Dann sieht der Graph wie folgt aus:
+                             <- bugfix
+                             <- neuer-branch
+          D    E      F     G
+          o<---o<-----o<----o<-
+    A    /                     \
+    o<---o<---o<---------------o
+         B    C                H <- master <- HEAD
+Dabei wurde der merge-Commit ''H'' angelegt, darin sind die Änderungen in ''master'' und ''bugfix'' Zusammengeführt. Dabei kann es zu Konflikten kommen, die manuell Aufgelöst werden müssen.
 ===== Kollaboration mit git =====
-TODO
+git kann seine Vorteile noch besser ausspielen, wenn man mit anderen kollaboriert:
+Jeder kann Unabhängig an seiner Version arbeiten und man kann die Änderungen dann
+automatisiert zusammenführen.
+Damit das geht braucht man ein git Repository. Da öffentlich github Repositories für wissenschaftliche
+Projekte nicht zu empfehlen sind, sollte man seinen eigenen Server mit [[http://gitolite.com/gitolite/index.html|gitolite3]] betreiben, oder von der Uni bereitgestellte Infrastruktur nutzen (an der TU Dresden
+kann man z. B. [[https://fusionforge.zih.tu-dresden.de/|Fusionforge]] verwenden).
+Man sollte einen SSH schlüssel erzeugen (... TODO ...) und den öffentlichen Schlüssel beim Server eintragen.
+Wenn man dort einen Account hat und ein Repo und die entsprechenden Berechtigungen eingerichtet hat,
+kann man es mit
+  $ git clone user@server/repo
+klonen, dabei läuft die Authentifizierung über das SSH-public-key-Verfahren.
+Danach kann man mit
+  $ git fetch
+oder
+  $ git pull
+Änderungen vom repository holen. Mit
+  $ git push
+kann man seine eigenen Änderungen verbreiten.
+Das erlaubt es gemeinsam mit anderen am Repository zu arbeiten und Änderungen auszutauschen.
 ===== Automatisch erstellter Inhalt und Makefiles =====
@@ Line 114: / Line 269: @@
    * bibtex/biber, makeglossaries
+===== Siehe auch =====
+  * [[https://blog.slub-dresden.de/beitrag////zitieren-und-gute-wissenschaftliche-praxis-slub-handreichung-zum-wissenschaftlichen-arbeiten-ersch/| Zitieren und gute wissenschaftliche Praxis - SLUB-Handreichung zum wissenschaftlichen Arbeiten erschienen]]
+  * [[https://wiki.zum.de/wiki/Verfassen_von_wissenschaftlichen_Arbeiten_mit_LibreOffice| Verfassen von wissenschaftlichen Arbeiten mit LibreOffice]] (ZUM-Wiki)
+  * [[doku:git|Versionsverwaltung mit git]]
 {{tag> Wissenschaftliches_Schreiben git LaTeX Anleitung}}