Zum Inhalt springen
Topos Uranos
Deutsch

Weitere Dokumente und Teamarbeit: Zusammenfassung und Herausforderungen

Zusammenfassung

Diese Lektion schließt die siebte Einheit ab, die weiteren Dokumenten und der Teamarbeit gewidmet ist, und mit ihr den Kurs. Sie rekonstruiert die Kette von Prinzipien und Mechanismen, die vom Beamer-Frame bis zum getaggten PDF reicht, und zeigt an jedem Glied, welches Prinzip verwendet wird und in welcher Lektion es eingeführt wird; sie ordnet das Erreichte in den Plan des Kurses ein und zeigt, was nach ihm bleibt; sie wiederholt in ihrem Ausgangstest die Fertigkeiten des Eingangstests; und sie endet mit sechs Herausforderungen, schwieriger als die Aufgaben der Lektionen, die mehrere Einheiten verbinden: einen kurzen Artikel setzen, der den ganzen Kurs zusammenführt, ihn in eine Präsentation verwandeln, seine Abbildung auf ein Poster bringen, eine konfliktfreie Zusammenführung diagnostizieren, die einen Verweis verändert, ihn für arXiv und für eine Zeitschrift vorbereiten, die mit pdfLaTeX übersetzt, und eine Präambel schreiben, die zugleich einem Artikel, einer Präsentation und einem KOMA-Script-Bericht dient.

Lernziele

  1. Die Reihenfolge der Mechanismen der Einheit rekonstruieren und das Prinzip benennen, auf dem jeder beruht.
  2. Erklären, warum derselbe Inhalt Gattung, Autor und Ziel wechselt, ohne neu geschrieben zu werden, und welche Entscheidungen bei jedem Wechsel dennoch zu treffen sind.
  3. Vorhersagen, was ein Frame mit Overlays, eine Klassenoption, eine Ausschlussdatei, eine Zusammenführung in Git und eine Metadatenangabe erzeugen, und den Quelltext so korrigieren, dass er das Gewollte erzeugt.
  4. Einen kurzen wissenschaftlichen Artikel setzen, der die Mittel des ganzen Kurses vereint, und ihn an eine Präsentation, an ein Poster und an die Anforderungen eines Veröffentlichungsziels anpassen.
  5. Das im Kurs Gelernte gegenüber den Schreibkursen der einzelnen Fächer einordnen, die auf ihm aufbauen.

Was die Einheit erreicht hat

Die Einheit hatte sich vorgenommen, dass die in den sechs vorigen Einheiten aufgebaute wissenschaftliche Arbeit die Gattung wechselt, von mehreren geschrieben wird und ihr Ziel erreicht, ohne neu gemacht zu werden. Das Ziel wurde erreicht, gestützt auf das, was die Einführung als bekannt vorausgesetzt hat: das logische Markup, das sagt, was jedes Ding ist, und seine Form der Klasse überlässt; die eigene Präambel, die einmal entscheidet, was im ganzen Dokument gilt; die relativen Maße der Abbildungen; und die Literaturdatenbank, die jeder Gattung dient, die zitiert. Damit lässt sich der zurückgelegte Weg als eine einzige Kette in vier Abschnitten lesen.

Präsentationen mit Beamer

Die Lektion über Präsentationen mit Beamer hat gezeigt, dass eine Präsentation ein Dokument wie die anderen ist, mit eigener Klasse: Das Seitenverhältnis wird mit aspectratio gewählt, die Sprache wird als Klassenoption angegeben, damit sie auch die Bezeichnungen der Sätze erreicht, und die Abschnitte, zwischen die Frames geschrieben, speisen das Inhaltsverzeichnis mit demselben Mechanismus der Durchläufe wie die Verweise. Sie hat festgestellt, dass jedes Overlay eines Frames eine Seite des PDF ist, sodass sich \pause und die Angaben in spitzen Klammern zählen lassen, und dass die Option handout jeden Frame nur einmal setzt; sie hat Themen, Spalten, Blöcke und Sätze vorgestellt; sie hat das Kurzzitat von biblatex und einen Literatur-Frame auf die Folie gebracht; sie hat erklärt, warum sich Notizen nach jedem Overlay wiederholen; und sie hat darauf hingewiesen, dass Beamer mit der serifenlosen Familie setzt, sodass \setmainfont die Folien nicht ändert.

Poster, Briefe und Lebenslauf

Die Lektion über Poster, Briefe und Lebenslauf hat aus der Leseentfernung den Mindestschriftgrad eines Posters abgeleitet, s≥7⋅d30s \geq 7 \cdot \frac{d}{30}, und aus den Proportionen der A-Reihe ein maßstäbliches Muster, das man auf einem gewöhnlichen Blatt erprobt; sie hat das Poster als Raster von Blöcken mit der Bibliothek poster von tcolorbox gesetzt, deren Grundschriftgrad mit einer einzigen Option festgelegt wird; sie hat den Brief als eine Menge von Daten behandelt, mit letter und mit den Variablen von scrlttr2; sie hat moderncv vorgestellt, mit seiner Farbe vor seinem Stil und, bei babel auf Spanisch, der Option es-lcroman; und sie hat einen akademischen Lebenslauf gesetzt, dessen Publikationslisten, nach Schlagwörtern gefiltert, aus derselben Datenbank stammen wie die Artikel. Sie endete damit, jeder Gattung die Klasse zuzuordnen, die ihr eigenes Merkmal nicht weglassen kann.

Im Team schreiben

Die Lektion Im Team schreiben hat die Zusammenarbeit in Overleaf vorgestellt, mit Kommentaren, Änderungsverfolgung und Verlauf, und die Versionsverwaltung mit Git. Daraus, dass Git die Dateien Zeile für Zeile vergleicht und zusammenführt, hat sie die Konvention abgeleitet, einen Satz pro Zeile zu schreiben, die das PDF nicht ändert und bewirkt, dass sich zwei Korrekturen in nicht benachbarten Sätzen von selbst vereinen; sie hat mit einer .gitignore die Dateien ausgeschlossen, die das Übersetzen neu erzeugt, und dabei das PDF des Dokuments genannt statt aller PDF, die Abbildungen sein können; sie hat gelehrt, einen Konflikt aufzulösen und die Auflösung durch Übersetzen zu prüfen, weil eine Zusammenführung ohne Konflikt einen Verweis zerstören kann; sie hat die Änderungen im PDF mit latexdiff gezeigt; und sie hat die Konventionen des Teams zusammengestellt: eine gemeinsame Präambel, eine gemeinsame Datenbank, eine Datei pro Kapitel und Labels mit Präfix.

Vorlagen und Veröffentlichung

Die Lektion über Vorlagen und Veröffentlichung hat das Dokument an sein Ziel gebracht. Sie hat einen Artikel an die Klasse einer Zeitschrift angepasst, indem sie entfernte, was die Klasse entscheidet, und die sinntragenden Befehle behielt, und sie hat auf die Zusammenstöße hingewiesen, etwa den von natbib, das elsarticle lädt, mit biblatex; sie hat einen Einreichungsordner vorbereitet, der für sich allein übersetzt; sie hat erklärt, dass arXiv den Quelltext übersetzt und kein LuaLaTeX anbietet, sodass das Dokument des Kurses mit XeLaTeX eingereicht oder an pdfLaTeX angepasst wird; sie hat ein PDF/A mit \DocumentMetadata erzeugt, vor der Klasse geschrieben und mit der PDF-Version, die die Norm zulässt; und sie hat das PDF getaggt, mit tagging=on, dem Alternativtext der Abbildungen und der Sprache, damit es auch lesen kann, wer nicht sieht.

Die folgende Abbildung fasst die vier Abschnitte zu einer einzigen Kette zusammen. Jeder Knoten der Spalte ist ein Mechanismus oder eine Regel, nummeriert nach der Reihenfolge, in der sie aufeinander aufbauen, und durch einen Bogen mit den früheren Gliedern verbunden, die er verwendet; ringsum schweben die Stützen, also die Prinzipien, auf die die Kette immer wieder zurückgreift, jede mit einer durchgezogenen Linie mit den Gliedern verbunden, die sich auf sie stützen, und mit einer gestrichelten mit dem Glied, in dem sie eingeführt wird, außer denen, die in früheren Einheiten eingeführt wurden und als Ringe gezeichnet sind. Ein Klick auf eine Stütze hebt alle Glieder hervor, die sie verwenden, und jedes Glied verweist auf die Lektion, in der es behandelt wird.

Stützen der Kette

  • AWas es ist, nicht wie es aussieht. Das Markup sagt, was jedes Element ist, und die Klasse mit ihren Optionen entscheidet über seine Form; deshalb wechselt der Inhalt die Gattung, wenn die Klasse wechselt. Eingeführt in der zweiten und dritten Einheit. In dieser Einheit ohne Beweis angenommen.
  • BEinmal entscheiden. Was an einer einzigen Stelle entschieden wird (eine Option, ein eigener Befehl, eine gemeinsame Präambel), ändert sich im ganzen Dokument, wenn man es dort ändert; was von Hand kopiert wird, hört auf übereinzustimmen. Eingeführt in den früheren Einheiten. In dieser Einheit ohne Beweis angenommen.
  • CDurchläufe. Das Programm schreibt in die Hilfsdateien, was es in einem Durchlauf berechnet, und verwendet es im nächsten; diese Dateien werden bei jedem Übersetzen neu erzeugt. Eingeführt in der ersten Einheit und präzisiert in der dritten. In dieser Einheit ohne Beweis angenommen.
  • DRelative Maße. Ein Maß, das relativ zum Text angegeben ist, wie \linewidth oder die Größen \large und \Huge, passt sich der Stelle an, an der es verwendet wird. Eingeführt in der zweiten und fünften Einheit. In dieser Einheit ohne Beweis angenommen.
  • EEine Datenbank, viele Verwendungen. Die Quellen werden einmal in der Literaturdatenbank beschrieben, und jede Gattung zitiert oder listet sie mit dem Stil und den Filtern, die ihr entsprechen. Eingeführt in der sechsten Einheit. In dieser Einheit ohne Beweis angenommen.
  • FWas gültig ist, warnt nicht. Das Programm und seine Hilfsprogramme warnen nur vor dem, was sie nicht verarbeiten können; ein gültiger Quelltext, der nicht sagt, was der Autor wollte, wird ohne Warnung übersetzt, und der Fehler zeigt sich erst im Ergebnis. Eingeführt in der fünften und sechsten Einheit. In dieser Einheit ohne Beweis angenommen.
  • GDie Entfernung entscheidet. Der Winkel, den ein Buchstabe einnimmt, nimmt im Verhältnis zur Entfernung ab; der Mindestschriftgrad wächst mit ihr. Begründet in: 6. Der Schriftgrad aus der Entfernung.
  • HGit vergleicht Zeilen. Git vergleicht und führt die Dateien Zeile für Zeile zusammen: Es vereint nur die Änderungen in nicht benachbarten Zeilen und meldet einen Konflikt, wenn zwei Änderungen dieselbe Zeile oder benachbarte Zeilen berühren. Begründet in: 11. Unterschiede und Zusammenführungen nach Zeilen.

  1. Abschnitt 1 Präsentationen mit Beamer

    • Frames mit Titel, Blöcken, Spalten und Sätzen setzen.
    • Die Seiten vorhersagen, die Overlays, Handout und Notizen erzeugen.
    • Auf der Folie mit derselben Datenbank zitieren.
    • Die Schrift einer Präsentation wählen und dabei wissen, welche Familie Beamer verwendet.

    1. Frame und Overlay als Seite. Jeder Frame erzeugt eine Seite pro Overlay: \pause und Angaben wie <3-> oder \only<2> legen fest, wie viele; handout setzt eine pro Frame, und eine Notiz wiederholt sich nach jedem Overlay.

      Stützt sich auf: A (Was es ist, nicht wie es aussieht). Bewiesen in: Präsentationen mit Beamer.

    2. Abschnitte und Inhaltsverzeichnis. \section steht zwischen den Frames, erzeugt keine Seite und speist \tableofcontents, das beim zweiten Übersetzen vollständig wird.

      Verwendet: 1. Frame und Overlay als Seite. Stützt sich auf: C (Durchläufe). Bewiesen in: Präsentationen mit Beamer.

    3. Die Sprache in der Klasse. ngerman als Klassenoption erreicht babel und den Übersetzer von Beamer; nur babel übergeben, heißen die Sätze ohne Warnung englisch.

      Verwendet: 1. Frame und Overlay als Seite. Stützt sich auf: B (Einmal entscheiden), F (Was gültig ist, warnt nicht). Bewiesen in: Präsentationen mit Beamer.

    4. Das Kurzzitat. Auf der Folie zitiert man mit der Kurzform von biblatex aus derselben Datenbank, und die vollständige Angabe steht in einem letzten Frame.

      Verwendet: 1. Frame und Overlay als Seite. Stützt sich auf: E (Eine Datenbank, viele Verwendungen). Bewiesen in: Präsentationen mit Beamer.

    5. Die serifenlose Familie. Beamer setzt mit der serifenlosen Familie: \setmainfont ändert die Folien nicht; man ändert die serifenlose Familie oder wählt das Schriftthema mit Serifen, und professionalfonts lässt die Mathematik unberührt.

      Verwendet: 1. Frame und Overlay als Seite. Stützt sich auf: A (Was es ist, nicht wie es aussieht), F (Was gültig ist, warnt nicht). Bewiesen in: Präsentationen mit Beamer.

  2. Abschnitt 2 Poster, Briefe und Lebenslauf

    • Den Schriftgrad eines Posters aus der Entfernung berechnen und an einem Muster erproben.
    • Ein Poster als Raster von Blöcken setzen.
    • Briefe mit letter und scrlttr2 schreiben.
    • Einen beruflichen und einen akademischen Lebenslauf aus der Datenbank setzen.

    1. Der Schriftgrad aus der Entfernung. Auf 30 cm liegt das bequeme Minimum bei etwa 7 Punkt; in einer Entfernung dd, in Zentimetern, muss der Schriftgrad ss die Bedingung s≥7⋅d30s \geq 7 \cdot \frac{d}{30} erfüllen.

      Bewiesen in: Poster, Briefe und Lebenslauf.

    2. Das maßstäbliche Muster. Die Formate der A-Reihe haben dieselbe Gestalt, und jede Seite wird bei jedem Schritt durch 2\sqrt{2} geteilt: Ein auf A4 verkleinertes A0 liest man aus einem Viertel der vorgesehenen Entfernung.

      Verwendet: 6. Der Schriftgrad aus der Entfernung. Stützt sich auf: G (Die Entfernung entscheidet). Bewiesen in: Poster, Briefe und Lebenslauf.

    3. Ein Raster von Blöcken. tcbposter teilt die Seite in Spalten und Zeilen, jede \posterbox nimmt darin einen Platz ein, und fontsize legt den Grundschriftgrad fest, von dem alle relativen Größen abhängen.

      Verwendet: 6. Der Schriftgrad aus der Entfernung. Stützt sich auf: B (Einmal entscheiden), D (Relative Maße), G (Die Entfernung entscheidet). Bewiesen in: Poster, Briefe und Lebenslauf.

    4. Der Brief als Daten. letter und scrlttr2 erhalten Absender, Empfänger, Datum und Unterschrift als Daten; scrlttr2 speichert sie in Variablen, etwa place, und entscheidet ihre Stelle über seine Optionen.

      Stützt sich auf: A (Was es ist, nicht wie es aussieht). Bewiesen in: Poster, Briefe und Lebenslauf.

    5. Der Lebenslauf aus der Datenbank. moderncv verlangt die Farbe vor dem Stil und, bei babel auf Spanisch, es-lcroman; der akademische Lebenslauf listet die Publikationen mit \nocite{*} und Schlagwortfiltern, die ihre Bedingungen verknüpfen.

      Verwendet: 9. Der Brief als Daten, 4. Das Kurzzitat. Stützt sich auf: E (Eine Datenbank, viele Verwendungen), F (Was gültig ist, warnt nicht). Bewiesen in: Poster, Briefe und Lebenslauf.

  3. Abschnitt 3 Im Team schreiben

    • Ein Projekt in Overleaf oder in einem Git-Repositorium teilen.
    • So schreiben, dass fremde Änderungen nicht kollidieren.
    • Ausschließen, was erzeugt wird, ohne zu verlieren, was nicht erzeugt wird.
    • Einen Konflikt auflösen, ihn durch Übersetzen prüfen und die Änderungen zeigen.

    1. Unterschiede und Zusammenführungen nach Zeilen. Git verzeichnet die Änderungen jedes Commits als entfernte und hinzugefügte Zeilen und führt zwei Branches ohne Eingriff zusammen, wenn ihre Änderungen getrennte Zeilen berühren.

      Bewiesen in: Im Team schreiben.

    2. Ein Satz pro Zeile. Ein einfacher Zeilenumbruch ist ein Leerzeichen, sodass ein Satz pro Zeile das PDF nicht ändert; der Unterschied zeigt den Satz, der sich geändert hat, und zwei Korrekturen in nicht benachbarten Sätzen vereinen sich von selbst.

      Verwendet: 11. Unterschiede und Zusammenführungen nach Zeilen. Stützt sich auf: H (Git vergleicht Zeilen). Bewiesen in: Im Team schreiben.

    3. Was erzeugt wird, wird nicht gespeichert. Die .gitignore schließt die Hilfsdateien und das PDF des Dokuments mit seinem Namen aus; *.pdf schlösse ohne Warnung auch die Abbildungen im PDF-Format aus, und das Dokument ließe sich auf einem anderen Rechner nicht übersetzen.

      Verwendet: 11. Unterschiede und Zusammenführungen nach Zeilen. Stützt sich auf: C (Durchläufe), F (Was gültig ist, warnt nicht). Bewiesen in: Im Team schreiben.

    4. Auflösen und übersetzen. Ein Konflikt hinterlässt Markierungen in der Datei, die von Hand aufgelöst werden; eine Zusammenführung ohne Konflikt kann einen Verweis zerstören, und deshalb wird jede Zusammenführung durch Übersetzen geprüft.

      Verwendet: 12. Ein Satz pro Zeile, 13. Was erzeugt wird, wird nicht gespeichert. Stützt sich auf: H (Git vergleicht Zeilen), F (Was gültig ist, warnt nicht). Bewiesen in: Im Team schreiben.

    5. Die Änderungen im PDF. latexdiff vergleicht zwei Fassungen des Quelltexts und schreibt eine dritte, die übersetzt zeigt, was entfernt und was hinzugefügt wurde; die Konventionen des Teams (gemeinsame Präambel und Datenbank, Labels mit Präfix) verhindern, dass sich der Vergleich mit Formunterschieden füllt.

      Verwendet: 14. Auflösen und übersetzen. Stützt sich auf: B (Einmal entscheiden). Bewiesen in: Im Team schreiben.

  4. Abschnitt 4 Vorlagen und Veröffentlichung

    • Einen Artikel an die Klasse einer Zeitschrift anpassen.
    • Einen Einreichungsordner vorbereiten, der allein übersetzt.
    • Das Programm und die Bibliografie wählen, die das Ziel zulässt.
    • Ein archivfähiges und getaggtes PDF erzeugen.

    1. An die Vorlage anpassen. Man entfernt, was die Klasse der Zeitschrift entscheidet (Seite, Schrift, Überschriften), und behält die sinntragenden Befehle; Pakete, die die Klasse schon lädt, wie natbib in elsarticle, können mit den eigenen zusammenstoßen.

      Verwendet: 3. Die Sprache in der Klasse. Stützt sich auf: A (Was es ist, nicht wie es aussieht), B (Einmal entscheiden). Bewiesen in: Vorlagen und Veröffentlichung.

    2. Ein Quelltext, der allein übersetzt. Der Einreichungsordner enthält alles, was das Dokument liest, und nichts weiter: Quelltexte, Abbildungen, die Datenbank oder die .bbl, und keine Hilfsdatei.

      Verwendet: 16. An die Vorlage anpassen, 13. Was erzeugt wird, wird nicht gespeichert. Stützt sich auf: C (Durchläufe). Bewiesen in: Vorlagen und Veröffentlichung.

    3. Das Ziel entscheidet über das Programm. arXiv übersetzt den Quelltext mit LaTeX, pdfLaTeX oder XeLaTeX, nicht mit LuaLaTeX: Das Dokument des Kurses wird mit XeLaTeX eingereicht oder an pdfLaTeX angepasst und vorher mit diesem Programm übersetzt; eine eingereichte .bbl muss zur biblatex-Version von arXiv passen.

      Verwendet: 17. Ein Quelltext, der allein übersetzt, 4. Das Kurzzitat. Stützt sich auf: E (Eine Datenbank, viele Verwendungen), F (Was gültig ist, warnt nicht). Bewiesen in: Vorlagen und Veröffentlichung.

    4. PDF/A und seine Version. \DocumentMetadata steht vor \documentclass; zu pdfstandard=a-2b kommt pdfversion=1.7, weil Version 2.0 für diesen Teil der Norm nicht zulässig ist.

      Verwendet: 17. Ein Quelltext, der allein übersetzt. Stützt sich auf: F (Was gültig ist, warnt nicht). Bewiesen in: Vorlagen und Veröffentlichung.

    5. Tags, Alternativtext und Sprache. tagging=on leitet die Struktur des PDF aus dem sinntragenden Markup ab; alt gibt jeder Abbildung, was hören wird, wer sie nicht sieht, und lang gibt die Sprache an.

      Verwendet: 19. PDF/A und seine Version. Stützt sich auf: A (Was es ist, nicht wie es aussieht). Bewiesen in: Vorlagen und Veröffentlichung.

Das Ende des Kurses. Die Kette endet dort, wo das Dokument die Hände seines Autors verlässt: mit anderen geschrieben, in mehreren Gattungen vorgestellt und in der Form abgegeben, die sein Ziel verlangt. Mit ihr endet der Kurs.