Formalitäten für Bücher und Lehrmaterial
Diese Seite fasst alle Formalitäten für bearbeitetes Material zusammen. Diese Vorgaben müssen zwingend für jedes bearbeitete Material eingehalten werden.
Für Lehrmaterialien wie Foliensätze oder Übungen sind einige Absätze, wie z.B. der Absatz zum Titelblatt, nicht relevant.
Konfiguration
Eine Konfiguration ist eine Datei, welche wichtige Kopfdaten über bearbeitetes Material enthält. Anhand derer kann man später nachvollziehen, wer das Material bearbeitet hat, woher die Quellen kommen und wann die letzte Bearbeitung geschehen ist. Diese Kopfdaten werden auch automatisch in die generierten Ausgabedateien überführt.
Jedes bearbeitete Buch, jede Vorlesung und jegliches anderes Material sollte eine eigene Konfiguration besitzen. Material ist damit die obere Einheit einer Veranstaltung. Ein Seminar mit vielen verschiedenen zu bearbeitenden Veröffentlichungen bildet damit eine Einheit (ein Material) und nicht jede Veröffentlichung einzeln. Ein Buch besitzt auch genau eine Konfiguration.
Die Konfigurationsdatei muss im Hauptverzeichnis des Materials liegen, z.B. das Verzeichnis, in dem die Verzeichnisse "k01", "k02" und so weiter zu finden sind.
Informationen zur barrierefreien Version
Es liegt in der Natur der Sache, dass nicht alles genau so übertragen werden kann, wie es in der Originalquelle vorhanden ist. An anderen Stellen ist es auch sinnvoll, dass eine bewusst andere Darstellung gewählt wird, um das Lesen mit einem Bildschirmleser zu erleichtern. Solche Veränderungen sollten stehts dokumentiert werden.
Die Hinweise zur übertragenen Version müssen vom Bearbeiter in einer Datei namens "info.md" angelegt werden. Es gibt keine Vorgaben zum Aussehen dieser Datei, doch sollten in dieser strukturiert erklärt werden, welche Änderungen vorgenommen wurden und aus welchem Grund.
Im Inhaltsverzeichnis wird die Datei automatisch vor Kapiteln des bearbeiteten Materials eingefügt.
Titelblatt
Die ersten Seiten eines Buches (und ähnlicher Materialien) sollten gesondert übertragen werden. Dabei gehört zum Titel natürlich die erste Seite, die typischerweise neben dem Titel auch den Autor und Herausgeber enthält. Zusätzlich kann auch die Rückseite der Titelseite und in seltenen Fällen auch die darauf folgende Seite mit zum Titelblatt gehören. Alle Informationen, die eine Ausgabe klassifizieren, gehören mit zum Titelblatt. Ausgenommen sind Informationen wie Vorbemerkungen, Inhaltsverzeichnis o.ä.
Die Titelseite muss in eine Datei "titel.md" oder lokalisiert für die jeweilige Sprache (title.md oder coverture.md) übertragen werden. Das Hauptaugenmerk liegt hierbei auf der Vollständigkeit der Informationen und nicht auf deren Formatierung.
Das Titelblatt wird beim Generieren des Inhaltsverzeichnisses automatisch eingebunden.
Inhaltsverzeichnis
Der Konverter generiert das Inhaltsverzeichnis automatisch. Trotzdem gibt es einige Festlegungen zu beachten.
- Die Nummerierung wird vom Konverter vorgenommen. Wird dies anders gewünscht, muss zwingend die Nummerierung bei der Konvertierung (in der Konfiguration) abgeschaltet werden.
- Bei Foliensätzen muss ggf. der Titel leicht angepasst werden. Verwendet ein Dozent beispielsweise in jedem Titel den Namen der Lehrveranstaltung und erst im Anschluss den Titel des aktuellen Foliensatzes, so ist der Titel der Lehrveranstaltung auszulassen, um eine vernünftige Navigation im Inhaltsverzeichnis zu ermöglichen.
- Bei der Übertragung von Büchern ist darauf zu achten, dass das Inhaltsverzeichnis komplett ist. Kapitel, welche nicht bearbeitet wurden, müssen daher trotzdem angelegt werden, deren Überschriften übernommen und mit einem kurzen Text versehen werden, der darauf hinweist, dass das Kapitel unbearbeitet ist. Beispielsweise "Methoden der Bienenzucht [nicht übertragen]".
