Bearbeiten von Teilbüchern¶

Neues Teilbuch¶

Um ein neues Teilbuch hinzuzufügen, sind folgende Schritte erforderlich:

Outline-Eintrag¶

In die Datei /_config/outline.yml muss ein Eintrag für das neue Teilbuch eingetragen werden.

Der Eintrag enspricht sowohl dem Unterverzeichnis von /books, in dem die Quelldateien des Teilbuchs gespeichert werden als auch dem Pfadsegment der zukünftigen URLs der resultierenden Seiten.

Hinweis

Der erste Eintrag der Liste ist das Hauptbuch und sollte aller Voraussicht nach nie durch eine neue Seite ersetzt werden.

Der neue Eintrag sollte an der Stelle in der Liste eingefügt oder angehängt werden, an der er auch in der Navigation zwischen den Teilbüchern erscheinen soll.

Eintrag in der Hauptnavigation¶

In der Datei /books/main/_config/navigation.yml muss am Ende ein neuer Eintrag in die Haupt-Navigationsebene hinzugefügt werden. Dieser soll dem Vorbild der anderen Teilbuch-Einträge enstprechen und insbesondere eine »virtuelle« Unterseite »Home« aufweisen, die allerdings nicht angezeigt wird.

Verzeichnisse¶

Zunächst müssen drei Verzeichnisse erstellt werden:

/books/<teilbuch>
/books/<teilbuch>/_config
/books/<teilbuch>/docs

wobei <teilbuch> dem Eintrag in der Datei outline.yml entspricht.

Zusätzlich sind die Dateien book-config.yml und navigation.yml im Verzeichnis /books/<teilbuch>/_config erforderlich, die nach dem Vorbild der bestehenden Dateien anderer Teilbücher (bzw. entsprechend der Beschreibungen auf der vorigen Seite) angelegt werden sollten.

Insbesondere sollte der Titel des Teilbuchs in book-config.yml dem Eintrag in der Hauptnavigation entsprechen.

Teilbuch löschen¶

Es ist unwahrscheinlich, aber letztlich nicht auszuschließen, dass einmal ein Teilbuch gelöscht werden muss. Um dies zu erreichen, muss

der Eintrag aus /_config/outline.yml entfernt und
die Hauptnavigaqtion in /books/main/_config/navigation.yml aktualisiert werden.

Zusätzlich sollte auch der gesamte Ordner /books/<teilbuch> gelöscht werden.

Teilbuch umsortieren¶

Zum Umsortieren eines Teilbuches genügt es, die Einträge in

/_config/outline.yml und
/books/main/_config/navigation.yml

an die gewünschte neue Position zu verschieben.

Teilbuch umbenennen¶

Das Umbenennen eines Teilbuchs kann zwei verschiedene Dinge bezeichnen: Veränderung des Titels oder Veränderung des Pfadsegments.

Umbenennen des Titels¶

Die Teilbücher haben Titel wie z.B. »Die GLAREAN-Plattform«, die sowohl in der Titelzeile als auch in der Navigationsleiste erscheinen. Diese Titel sind (leider) redundant definiert und müssen an zwei Stellen umbenannt werden:

in der Datei _config/book-config.yml des jeweiligen Teilbuchs in der Variablen book_title
in der Hauptnavigation in /books/main/_config/navigation.yml

Umbenennen des Pfadsegments¶

Die Umbenennung des Pfadsegments eines Teilbuchs ist eine grundlegende Veränderung, deren wesentlichen Nebenwirkungen sorgfältig bedacht und überprüft werden müssen.

Achtung

Das Pfadsegment des Hauptbuches kann aus strukturellen Gründen nicht verändert werden, bzw. eine Veränderung hat keine äußerlich sichtbare Wirkung.

Folgende Schritte sind zur Änderung eines Pfadsegments erforderlich:

Umbenennen des Eintrags in der Übersichtsdatei _config/outline.yml
Umbenennen des Verzeichnisses innerhalb /books
Aktualisierung aller Links in dieses Buch hinein!
(Theoretisch auch die Aktualisierung von Links, die von außen in dieses Buch hineinverweisen.)

Letztes Update: 9. März 2020