Anleitung¶

Um den Aufbau sowie die Klassifikation dieser Seiten besser zu verstehen als auch die Funktionalität kennenzulernen, wird im nachfolgenden eine kurze Anleitung des wesentlichen Funktionen des Projektes vorgestellt.

Browser¶

Für eine bestmögliche Anzeige der auf den Seiten eingebetteten PDF-Dateien empfiehlt sich die Verwendung des Browsers Mozilla Firefox.

Schriftarten¶

Zur besseren Lesbarkeit verwendet diese Seite folgende Schriftarten:

• Inter¹ und JetBrains Mono² auf den HTML-Seiten
• Atkinson Hyperlegible Next/Mono³ in den Schemata und PDFs

Auch wenn die Darstellung der Web-Version sowie aller PDFs durch eingebettete Schriftarten ohne lokale Installation dieser Schriftart funktionieren sollte, kann es sein, dass die Darstellung der SVG-Dateien ohne eine lokale Installation dieser Schriftart abweicht. In diesem Fall sollten die Schriftarten über die in den Fußnoten unten angegebenen Download-Links lokal installiert werden.

Wiederverwendung und Modifikation der Schemata¶

Um auf der Grundlage dieser OpenAccess-Idee sowie der CreativeCommons-Lizenz eine möglichst hohe Wiederverwendbarkeit und Modifizierbarkeit der Schemata zu gewährleisten, bieten die nachfolgenden Seiten alle Materialien in folgender Form an:

• Darstellung der Einzel-Schemata: Alle Schemata werden auf den entsprechenden Unterseiten in folgenden Formaten dargestellt:
  • PDF-Datei
  • SVG-Datei
• Download der Einzel-Schemata: Alle Schemata können auf den entsprechenden Unterseiten jeweils in folgenden Formaten heruntergeladen werden:
  • PDF-Datei
  • SVG-Datei
  • drawio-Quelldatei (draw.io)
• Download eines zusätzlichen PDF-Gesamtdokuments mit den Inhalten bzw. dem Text der Projektseiten sowie allen auf diesen Seiten verwendeten Schemata. Dieses Format führt die Idee der alten PDF-Gesamtübersicht mit allen Einzel-Schemata fort, um ein für Druck und Lektüre eher konventionelles Format zur Verfügung zu stellen. Allerdings stellt dieses PDF-Format nur ein abgeleitetes Format dar. Führend ist immer die jeweils aktuelle Online-Version (bzw. das jeweils aktuelle Download-Paket der Online-Version):
  • (abgeleitet) PDF-Gesamtdokument
  • (abgeleitet) Typst-Quelldateipaket des PDF-Gesamtdokuments (Typst)
• Download des gesamten Projekts: Alle Projektseiten können als Offline-Gesamtpaket heruntergeladen und nach dem Entpacken mittels Öffnen der index.html-Datei durch einen Webbrowser geöffnet werden. Dieses Gesamtpaket enthält die folgenden Teile:
  • Struktur der Online-Version
  • HTML-Seiten, wie sie in der Online-Version zu sehen sind.
  • Alle Einzel-Schema-Dateien (pdf, svg, drawio)

Versionierung¶

• Grundsätzlich sind Änderungen an jeglichen Projekt-Seiten an der Änderung der Projekt-Version und dem Projekt-Stand/-Datum (auf dieser Startseite oben sowie auf jeder Seite im Footer unten) erkennbar.
• Bei Änderungen an einer konkreten einzelnen Seite ändern sich Seiten-Version und Seiten-Stand/-Datum. Nicht alle Seiten-Verionen/-Stände sind auf der gleichen Version/Stand wie die Projekt-Version/-Stand. Die Projekt-Version gibt immer die höchste Seiten-Version an, die irgendeine Seite besitzt.
• Die Versionierung (von Projekt- und Seiten-Versionen) erfolgt als semantic versioning, d.h. die Version liegt als dreiteilige, durch jeweils einen Punkt separierte Zahlenfolge vor: Major.Minor.Patch (z.B. 1.4.3) Jede Änderung (Text und/oder Schemata) schlägt sich neben dem Datum auch in dieser Versionierung nieder, um Änderungen und deren Art transparent zu machen:
  • Major: Die erste Zahl der Dokumentenversion gibt die Hauptversion an:
    • Eine Major-Version 0 (in Version 0.x.x) weist auf eine in Entwicklung befindliche Seite hin.
    • Eine Major-Version > 0 (z.B. 1.x.x oder 4.x.x) bezeichnet eine fertige, aber ggf. ständig weiterentwickelte Seite.
    • Jeder Sprung von einer Major-Version zur nächsten zeigt eine grundlegende Änderung an (z.B. konzeptionelle Neuausrichtung).
  • Minor: Eine Änderung der mittleren Zahl (z.B. 3 zu 4 bei 1.3.4 zu 1.4.4) bezeichnet eine signifikante inhaltliche Änderung bzw. Weiterentwicklung innerhalb einer Hauptversion (z.B. Ergänzungen, die keine größere Konzeptionsänderung bedeuten).
  • Patch: Eine Änderung der letzten Zahl (z.B. 2 zu 3 bei 1.3.2 zu 1.3.3) bezeichnet eine lediglich unbedeutende Änderung (z.B. Korrektur von Tippfehlern).

Changelog¶

Damit durch alle Leser:innen dieser Seite Änderungen an dieser Seite gut nachvollzogen werden können, werden alle Änderung in einem bestimmten Versionssprung jeweils im Changelog dokumentiert. Alle Changelog-Einträge zwischen der Version bzw. dem Stand des letzten Besuches (exklusive), die man sich bei jedem [abc] Besuch merken sollte, und der aktuellen Version bzw. dem aktuellen Stand (inklusive) stellen die Änderungen seit dem letzten Besuch dar.

Tags (Schlagwörter) und Suche¶

Die für eine Seite vergebenen Tags finden sich am Ende der jeweiligen Seite:

In der Suche (in der Hauptleiste oder über Strg + K) lassen sich alle Seiten bzw. die nach Eingabe eines Suchbegriffs gefundenen Seiten nach diesen Tags filtern:

Glossar und Tooltips¶

• Jeder zentrale Begriff ist automatisiert auf allen Seiten mit einem Tooltip versehen und zur Erkennbarkeit gepunktet unterstrichen. Beim Hovern mit der Maus über den Begriff erscheint der Tooltip.
• Während die Tooltips Kurzinformationen zum jeweiligen Begriff enthalten, finden sich im Glossar ausführlichere Erläuterungen zu diesen Begriffen.