Wikibooks Automatische Vorlagen/ Verwendung

Dieser Teil gehört zum Buch „Wikibooks Automatische Vorlagen“.

Zielgruppe: Alle Buch-Autoren, die die Vorteile der automatischen Vorlagen nutzen wollen.

Lernziel: Die praktische Anwendung mit Speicherung der Buchteile und der Kapitel an einer einzigen Stelle.

Kurzinhalt: In diesem Teil des Buches wird die praktische Nutzung der Vorlagen beschrieben.

Allgemeine Hinweise

Die folgenden Hinweise sind für die Funktionsfähigkeit der automatischen Vorlagen unbedingt zu beachten.

Einfache Verwendung

Die automatischen Vorlagen sind äußerst nützlich bei Büchern mit mehreren Kapiteln. Das gilt erst recht dann, wenn das Buch mehrere Teile enthält (wie Lehrbücher für Sprachen oder Programmiersprachen) und jeder Teil selbst aus mehreren Kapiteln besteht oder noch in Bereiche gegliedert ist.

Die Vorlagen werden wie folgt eingebunden:

{{AutoInhalt}}	kommt einmalig auf die Hauptseite des Buches (Startseite oder separates Inhaltsverzeichnis).
{{AutoNavigation}}	gehört unbedingt in jedes einzelne Kapitel.
{{AutoGesamt}}	gehört auf alle Seiten, die ein Buch oder einen Teil als Ganzes darstellen sollen.

Das genügt – mehr Angaben sind nicht erforderlich. Vorschläge für weitere Inhalte stehen bei den Kopiervorlagen.

Voraussetzungen

Damit die Vorlagen wie gewünscht arbeiten, muss das Buch so konstruiert sein:

• Als Trennzeichen zwischen dem Namen des Buches und den Kapitelnamen muss der Schrägstrich verwendet werden. Der Name des Buches selbst darf keinen Schrägstrich enthalten.
• Die Namen der Kapitel werden in zwei bis vier Ebenen zusammengesetzt, wie auf der aktuellen Seite durch Wikibooks Automatische Vorlagen/ Verwendung:
  1. der Name des Buches selbst, hier: Wikibooks Automatische Vorlagen
  2. der Name des einzelnen Teils, hier: Verwendung
  3. der Name eines Bereichs – das wird in diesem Teil nicht verwendet, aber im Teil Dokumentation
  4. der Name des Kapitels, hier:
• Bei Bedarf kann von dieser Regel abgewichen werden.
  • Man kann sich auf zwei Ebenen (Buch und Kapitel) beschränken.
  • Ein einzelner Teil kann auch aus einem einzigen Kapitel bestehen wie in diesem „Buch“ die Einführung.
  • Ein einzelner Teil kann Kapitel oder Bereiche enthalten.
• Ein Anhang ist wie ein Teil zu behandeln und enthält ebenfalls mehrere Kapitel (oder auch ein einziges).

Bezeichnungen

Für die Gliederung werden folgende Begriffe verwendet:

• Ein Buch ohne Teile enthält zwei Ebenen; eine Seite hat einen Namen der Art „Buch/ Kapitel“.
  Beispiel: DVD-RAM/ Kapitel1
• Ein Buch mit Teilen enthält drei oder vier Ebenen; eine Seite hat zunächst einen Namen der Art „Buch/ Teil/ Kapitel“.
  Beispiel: Wikibooks Automatische Vorlagen/ Verwendung/ Buch ohne Teile
• Bei einem Teil mit Bereichen wird ein Teil weiter gegliedert; eine Seite hat dann einen Namen der Art „Buch/ Teil/ Bereich/ Kapitel“.
  Beispiel: Wikibooks Automatische Vorlagen/ Dokumentation/ AutoInhalt/ Vorbereitung

Für eine weitere Untergliederung sind die automatischen Vorlagen nicht geeignet.

Daten-Seiten

Die Gliederung des Buches wird in speziellen Seiten gespeichert, die mit der Wiki-Syntax zur Vorlagen-Programmierung arbeiten und als bucheigene Vorlagen gespeichert werden.

• In einer Seite Buch/ Vorlage:Daten stehen die Teile oder Kapitel des Buches selbst sowie ein paar allgemeine Festlegungen.
  Buchdaten ist die Abkürzung dafür in diesem „Buch“.
• In den Seiten Buch/ Vorlage:Daten Teil stehen die Kapitel und Bereiche zu jeweils einem Teil des Buches.
  Teildaten ist die Abkürzung dafür in diesem „Buch“.

Die automatischen Vorlagen sorgen dafür, dass diese Datenseiten richtig analysiert und umgesetzt werden. Außerdem helfen Preload-Vorlagen beim richtigen Aufbau der Datenseiten.

Zum besseren Verständnis der Erläuterungen bietet es sich an, diese Beschreibung und den Quelltext einer Datenseite in zwei Fenstern des Browsers zu öffnen und nebeneinander zu lesen.

Die Grundstruktur

Jede Datenseite enthält die folgenden Zeilen:

<includeonly>{{#switch: {{{1}}}
| max = 4
}}</includeonly><noinclude>{{AutoVorlagen Dokumentation}}</noinclude>

includeonly

Durch <includeonly>...</includeonly> wird der eigentliche Inhalt eingerahmt. Das vereinfacht die Verarbeitung durch die Wiki-Software.

noinclude

Die letzte Zeile <noinclude>{{...}}</noinclude> verweist auf eine einheitliche Dokumentation all dieser Vorlagen und Datenseiten und sorgt für die richtige Kategorie der bucheigenen Vorlagen.

switch

Die switch-Anweisung ist der wichtigste Bestandteil; sie stellt die jeweils benötigte Information bereit. Die Anweisung selbst beginnt mit den geschweiften Klammern {{# und dem Rest der ersten Zeile und endet mit den geschweiften Klammern }} am Anfang der letzten Zeile.

Einzelangaben

Dazwischen stehen in jeweils einer Zeile die einzelnen Angaben: Die Zeile beginnt immer mit dem Pipe-Zeichen |. Dann folgen der Name der Angabe, das Gleichheitszeichen und der konkrete Wert. Beim Namen sind Groß- und Kleinbuchstaben zu beachten. Leerzeichen dazwischen können stehen oder entfallen.

Maximum

Die Angabe max teilt den Vorlagen die Anzahl der Einträge mit: Kapitel oder Teile eines Buches, Kapitel oder Bereiche eines Teils. Diese Information darf niemals fehlen.

Weitere Angaben hängen von der Gliederung des Buches ab und werden in den folgenden Kapiteln erläutert.

Siehe auch

• Arbeiten mit Vorlagen
  • Hilfe:Vorlagen und die Unterseiten
• Programmieren von Vorlagen in der Wikipedia
  • Hilfe:Vorlagen
  • Hilfe:Vorlagenprogrammierung
• spezielle Funktionen der Wiki-Software, u.a. die switch-Anweisung
  • ParserFunctions

---

Buch ohne Teile

Dieses Kapitel beschreibt, wie ein (neues) Buch mit zwei Ebenen – Buch, Kapitel, keine Gliederung in Teile – aufgebaut werden muss, damit die Vorteile der automatischen Vorlagen wirken können.

Als Beispiel kann das Buch DVD-RAM dienen, bei dem Inhaltsverzeichnis, Datenseite und Gesamtseite die automatischen Vorlagen demonstrieren.

Schritt für Schritt

Beim Anfang eines neuen Buches ist wie folgt vorzugehen:

1. Beachte die allgemeinen Hinweise im vorigen Kapitel, vor allem die Voraussetzungen.
2. Trage auf der Seite, die das Inhaltsverzeichnis anzeigen soll, den Quelltext ein, der am Anfang des Abschnitts Die Anzeige des Inhalts steht. Speichere diese Änderung.
3. Klicke auf den vorbereiteten Link zur Seite Buchdaten und trage dort die gewünschten Kapitel des Buches sowie ein paar allgemeine Angaben ein.
4. Speichere diese Seite und lade erneut die Seite mit dem Inhaltsverzeichnis.

Danach kann (mit Klicks auf die einzelnen Kapitel) das Schreiben des Buches beginnen.

Die Anzeige des Inhalts

Die Seite mit dem Inhaltsverzeichnis enthält in erster Linie den folgenden Inhalt:

{{AutoInhalt}}

Zur automatischen Erstellung des Inhaltsverzeichnisses sind keine weiteren Angaben erforderlich. Dies hat die folgenden Auswirkungen.

{{AutoInhalt}}

Diese Vorlage holt sich aus der Seite Buchdaten die Liste der Kapitel und erzeugt daraus selbständig das Inhaltsverzeichnis.

Die Autoren sind frei darin, wie andere Teile der Startseite eingefügt werden:

• [[Vorlage:Regal]] oder [[Vorlage:Infoleiste]]
• [[Kategorie:Buch]]
• einleitender Text wie in diesem „Buch“
• Hinweise auf PDF-Version, Wikipedia oder andere Wikibooks

Automatisch stehen unter dem Inhaltsverzeichnis folgende Links:

• Gesamtes Buch auf eine Seite, die alle Kapitel des Buchs am Stück anzeigt
• Buchdaten auf die Datenseite
• LaTeX-/PDF-Export auf eine spezielle Seite, die vor allem dem Export mit wb2pdf dient

Die Datenseite

Bei einem Buch ohne Teile gibt es nur eine Datenseite, nämlich die Buchdaten.

Allgemeine Angaben

Die folgenden Angaben stehen am Anfang der Buchdaten.

| inhalt = {{#titleparts:{{subst:PAGENAME}}|1|1}}
| Bildgröße = 240px
| regal = Anleitungen
| reihe =
| DruckTOC = rechts
| navi2zeilig = ja
| teile = ja

Sie haben folgende Bedeutungen:

inhalt (Pflicht)

Hierher gehört die Seite, auf der das Inhaltsverzeichnis steht; die Schreibweise ist unwichtig. Diese Seite wird wegen der Links in der automatischen Navigation benötigt.

teile (Option)

Dies bestimmt die Tiefe der Gliederung.

• Mit der vorgegebenen Zeile wird angegeben, dass das Buch in drei oder vier Ebenen gegliedert wird.
• Bei einem Buch ohne Teile, also mit zwei Ebenen – Buch, Kapitel – ist diese Zeile zu löschen.

regal, reihe, Bildgröße (Option)

• Wenn in der automatischen Navigation auf jeder Seite das Regal angegeben werden soll, wird es hier eingetragen.
• Wenn das Buch Teil einer Reihe ist, ist in der Navigation ebenfalls ein Hinweis möglich.
• Wenn der Anfang eines Teils mit einem Bild versehen wird, holen sich die Vorlagen von hier die gewünschte Größe.

DruckTOC (Option)

Dies sollte das Inhaltsverzeichnis auf den Gesamtseiten regeln, hat aber zurzeit keine Bedeutung. Die Zeile kann also wahlweise belassen oder gestrichen werden.

navi2zeilig (Option)

Wenn ein Teil in Bereiche untergliedert wird, benötigt die Navigation zwischen den Kapiteln unter Umständen zuviel Platz. Dann wird mit dieser Option eine zweizeilige Navigation erreicht. Bitte vergleiche die Navigation in diesem Kapitel mit derjenigen im Teil „Dokumentation“.

Die einzelnen Kapitel

Mit den folgenden Werten werden die Kapitel in den Buchdaten eingetragen.

| E   = ja
| Z   = Probleme und Lösungen
| max = 5
| 1   = Buch ohne Teile
| 1i  = {{Status2|10}} Das Buch ist direkt in Kapitel gegliedert.
| 2   = Buch mit Teilen
| 2i  = Mehrere Kapitel werden in Teile zusammengefasst.
| 3   = Teil ohne Bereiche

Einleitung (Option)

Mit E = wird ein einleitendes Kapitel vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Einleitung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

Zusammenfassung (Option)

Mit Z = wird ein abschließendes Kapitel des Buchs vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Zusammenfassung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

max (Pflicht)

Dies gibt die Anzahl der vorgesehenen Kapitel an und wird für Prüfungen sowie für die automatische Navigation benötigt.

Die einzelnen Kapitel

Für jedes Kapitel sind die folgenden Angaben vorgesehen.

• Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Kapitels.
• Inhalt (Option): Der zusätzliche Wert, der beim Buchstaben i steht, wird im Inhaltsverzeichnis als Erläuterung beim Kapitel angezeigt.

Für das Buch sind maximal 20 Kapitel möglich. Sofern das nicht genügt, ist das Buch weiter in Teile und Bereiche zu untergliedern.

Nachträgliche Änderungen

Dafür ist auf den Link zu den Buchdaten zu klicken (vorzugsweise mit Rechtsklick in einem neuen Tab des Browsers). Nach dem Speichern muss das Inhaltsverzeichnis neu geladen werden.

• Zusätzliche Informationen (Inhaltsangaben u. ä.) können jederzeit problemlos geändert werden und werden sofort wirksam.
• Die Reihenfolge der Teile und Kapitel kann ebenso geändert werden. Es muss nur ganz genau auf die Nummern in den Datenseiten geachtet werden.
• Wenn das Buch anders gegliedert werden soll oder Teile und Kapitel umbenannt werden sollen, müssen Seiten umbenannt (also verschoben) werden.

All das wird im Kapitel Nachträgliche Änderungen genauer beschrieben.

---

Buch mit Teilen

In diesem Kapitel wird erläutert, wie ein (neues) Buch aufgebaut wird, damit die Vorteile der automatischen Vorlagen wirken können.

Als Beispiel dient dieses „Buch“.

Schritt für Schritt

Beim Anfang eines neuen Buches, das in Teile gegliedert werden soll, ist wie folgt vorzugehen:

1. Beachte die allgemeinen Hinweise im einleitenden Kapitel, vor allem die Voraussetzungen.
2. Trage auf der Seite, die das Inhaltsverzeichnis anzeigen soll, den Quelltext ein, der am Anfang des Abschnitts Die Anzeige des Inhalts steht; dort sind auch weitere mögliche Inhalte erwähnt. Speichere diese Seite.
3. Klicke auf den vorbereiteten Link zur Seite Buchdaten und trage dort die gewünschten Teile des Buches sowie ein paar allgemeine Angaben ein.
4. Speichere diese Seite und lade erneut die Seite mit dem Inhaltsverzeichnis.
5. Klicke nun nacheinander in jedem Teil auf die Links zu den Teildaten, wie in den beiden nächsten Kapiteln beschrieben, und trage dort die gewünschten Kapitel sowie ergänzende Angaben ein.
6. Speichere alle diese Seiten und lade abschließend die Seite mit dem Inhaltsverzeichnis neu.

Danach kann (mit Klicks auf die einzelnen Kapitel) das Schreiben des Buches beginnen.

Die Anzeige des Inhalts

Die Seite mit dem Inhaltsverzeichnis enthält in erster Linie den folgenden Inhalt:

{{TOCright}} {{AutoInhalt}}

Zur automatischen Erstellung des Inhaltsverzeichnisses sind keine weiteren Angaben erforderlich. Dies hat die folgenden Auswirkungen.

{{TOCright}}

Damit werden die Namen der Teile und Bereiche als Wiki-eigenes Inhaltsverzeichnis in einem Kasten rechts oben angezeigt.
Alternativ sind – je nach Wunsch – auch __TOC__ (am Anfang des Textes) oder __NOTOC__ (Verzicht auf das Wiki-Inhaltsverzeichnis) möglich.

{{AutoInhalt}}

Diese Vorlage holt sich aus der Seite Buchdaten die Liste der Teile und aus den Teildaten die Listen der Kapitel und erzeugt daraus selbständig das Inhaltsverzeichnis.

Die Autoren sind frei darin, wie andere Teile der Startseite eingefügt werden:

• [[Vorlage:Regal]] oder [[Vorlage:Infoleiste]]
• [[Kategorie:Buch]]
• einleitender Text wie in diesem „Buch“
• Hinweise auf PDF-Version, Wikipedia oder andere Wikibooks

Automatisch stehen unter dem Inhaltsverzeichnis folgende Links:

• Gesamtes Buch auf eine Seite, die alle Kapitel des Buchs am Stück anzeigt
• Buchdaten auf die Datenseite
• LaTeX-/PDF-Export auf eine spezielle Seite, die vor allem dem Export mit wb2pdf dient

Die Datenseiten

Ein Buch mit Teilen enthält mehrere Datenseiten:

• Die Buchdaten enthalten die Liste der Teile und die allgemeinen Angaben zum Buch.
• Die Teildaten enthalten die Listen von Kapiteln und ggf. Bereichen und zusätzliche Informationen zu den Teilen.

Zunächst müssen die Buchdaten erstellt werden. Als Beispiel dient natürlich dieses „Buch“, also die Seite Wikibooks Automatische Vorlagen/ Vorlage:Daten.

Allgemeine Angaben

Die folgenden Angaben stehen am Anfang der Buchdaten.

| inhalt = {{#titleparts:{{subst:PAGENAME}}|1|1}}
| Bildgröße = 240px
| regal = Anleitungen
| reihe =
| DruckTOC = rechts
| navi2zeilig = ja
| teile = ja

Sie haben folgende Bedeutungen:

inhalt (Pflicht)

Hierher gehört die Seite, auf der das Inhaltsverzeichnis steht; die Schreibweise ist unwichtig. Diese Seite wird wegen der Links in der automatischen Navigation benötigt.

regal, reihe, Bildgröße (Option)

• Wenn in der automatischen Navigation auf jeder Seite das Regal angegeben werden soll, wird es hier eingetragen.
• Wenn das Buch Teil einer Reihe ist, ist in der Navigation ebenfalls ein Hinweis möglich.
• Wenn der Anfang eines Teils mit einem Bild versehen wird, holen sich die Vorlagen von hier die gewünschte Größe.

DruckTOC (Option)

Dies sollte das Inhaltsverzeichnis auf den Gesamtseiten regeln, hat aber zurzeit keine Bedeutung. Die Zeile kann also wahlweise belassen oder gestrichen werden.

navi2zeilig (Option)

Wenn ein Teil in Bereiche untergliedert wird, benötigt die Navigation zwischen den Kapiteln unter Umständen zuviel Platz. Dann wird mit dieser Option eine zweizeilige Navigation erreicht. Bitte vergleiche die Navigation in diesem Kapitel mit derjenigen im Teil „Dokumentation“.

Die einzelnen Teile

Mit den folgenden Werten werden die Teile in den Buchdaten eingetragen.

| max = 4
| 1 = Einführung
| 2 = Verwendung
| 3 = Dokumentation
| 4 = Anhang

Einleitung und Zusammenfassung für das gesamte Buch sind nicht vorgesehen. Solche Kapitel passen bei Bedarf in den ersten und letzten Teil des Buches.

teile (Pflicht)

Mit teile = ja wird festgelegt, dass das Buch in drei oder vier Ebenen untergliedert wird, also mehrere Kapitel in Teile zusammengefasst werden.

max (Pflicht)

Dies gibt die Anzahl der vorgesehenen Teile an und wird für Prüfungen sowie für die automatische Navigation benötigt.

Die einzelnen Teile

Für jeden Teil ist die folgende Angabe vorgesehen.

• Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Teils.

Für das Buch sind maximal 20 Teile möglich.

Weitere Informationen über die allgemeinen Angaben und die Inhalte eines Teils folgen in den beiden nächsten Kapiteln Teil ohne Bereiche und Teil mit Bereichen.

Nachträgliche Änderungen

Dafür ist auf den Link zu den Buchdaten zu klicken (vorzugsweise mit Rechtsklick in einem neuen Tab des Browsers). Nach dem Speichern muss das Inhaltsverzeichnis neu geladen werden.

• Zusätzliche Informationen (Inhaltsangaben u. ä.) können jederzeit problemlos geändert werden und werden sofort wirksam.
• Die Reihenfolge der Teile und Kapitel kann ebenso geändert werden. Es muss nur ganz genau auf die Nummern in den Datenseiten geachtet werden.
• Wenn das Buch anders gegliedert werden soll oder Teile und Kapitel umbenannt werden sollen, müssen Seiten umbenannt (also verschoben) werden.

All das wird im Kapitel Nachträgliche Änderungen genauer beschrieben.

---

Teil ohne Bereiche

In diesem Kapitel wird erläutert, wie die Datenseite für einen Teil eines Buches aufgebaut wird, wenn der Teil nur in Kapitel gegliedert ist, aber nicht in Bereiche unterteilt wird.

Schritt für Schritt

1. Klicke im Inhaltsverzeichnis auf den vorbereiteten Link zur Seite Teildaten und trage dort die gewünschten Kapitel des Teils sowie ein paar allgemeine Angaben ein.
2. Speichere die Seite und lade das Inhaltsverzeichnis neu.

Danach kann (mit Klicks auf die einzelnen Kapitel) das Schreiben des Teils beginnen.

Die Datenseite

Zu jedem Teil gehört eine eigene Seite Teildaten. Als Beispiel dient vor allem der Teil Verwendung, also die Seite Wikibooks Automatische Vorlagen/ Vorlage:Daten Verwendung.

Allgemeine Angaben

Die folgenden Angaben stehen am Anfang der Teildaten.

| Bild = Otaria_flavescens_-Patagonia-8.jpg
| Zielgruppe = Alle Buch-Autoren, die die Vorteile der automatischen Vorlagen nutzen wollen.
| Lernziel = Die praktische Anwendung mit Speicherung der Buchteile und der Kapitel an einer einzigen Stelle.
| Kurzinhalt = In diesem Teil des Buches wird die praktische Nutzung der Vorlagen beschrieben:
zunächst die inhaltliche Gliederung eines Buches, dann die automatische Verwendung dieser Gliederung.
| margin = 2em 10em 2em 0

Alle diese Angaben sind optional. Sie haben folgende Bedeutungen:

Bild

Ein solches Bild kann im Inhaltsverzeichnis angezeigt werden, um die Inhalte des Teils zu illustrieren.

Zielgruppe

Dieser Text soll darauf hinweisen, wer diesen Teil vor allem lesen sollte.

Lernziel

Dieser Text kann angeben, welche Kenntnisse der Leser nach der Lektüre des Teils haben sollte.

Kurzinhalt

Dieser Text ist eine kurze Beschreibung des Teils.
Hinweis: Wenn es mehrere Absätze sein sollen, können sie mit Sternchen oder Rauten gegliedert werden, oder als Absatzumbruch ist </p><p> einzufügen, d. h. Ende des vorigen und Anfang des nächsten Absatzes.

margin

In seltenen Situationen können sich der Kasten für einen Teil und anderer Inhalt der Seite überschneiden. Dann kann (wie bei der Einführung) der Teil einen größeren rechten Rand (10em im Beispiel) erhalten.

Die einzelnen Kapitel

Mit den folgenden Werten werden die Kapitel in den Teildaten eingetragen.

| E   = ja
| Z   = Probleme und Lösungen
| max = 5
| 1   = Buch ohne Teile
| 1i  = {{Status2|10}} Das Buch ist direkt in Kapitel gegliedert.
| 2   = Buch mit Teilen
| 2i  = Mehrere Kapitel werden in Teile zusammengefasst.
| 3   = Teil ohne Bereiche

Einleitung (Option)

Mit E = wird ein einleitendes Kapitel vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Einleitung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

Zusammenfassung (Option)

Mit Z = wird ein abschließendes Kapitel des Teils vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Zusammenfassung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

max (Pflicht)

Dies gibt die Anzahl der vorgesehenen Kapitel an und wird für Prüfungen sowie für die automatische Navigation benötigt.

Die einzelnen Kapitel

Für jedes Kapitel sind die folgenden Angaben vorgesehen.

• Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Kapitels.
• Inhalt (Option): Der zusätzliche Wert, der beim Buchstaben i steht, wird im Inhaltsverzeichnis als Erläuterung beim Kapitel angezeigt.

Für einen Teil sind maximal 20 Kapitel möglich. Sofern das nicht genügt, ist das Buch weiter in Teile und Bereiche zu untergliedern.

Nachträgliche Änderungen

Dafür ist auf den Link zu den Teildaten zu klicken (vorzugsweise mit Rechtsklick in einem neuen Tab des Browsers). Nach dem Speichern muss das Inhaltsverzeichnis neu geladen werden.

• Zusätzliche Informationen (Inhaltsangaben u. ä.) können jederzeit problemlos geändert werden und werden sofort wirksam.
• Die Reihenfolge der Teile und Kapitel kann ebenso geändert werden. Es muss nur ganz genau auf die Nummern in den Datenseiten geachtet werden.
• Wenn das Buch anders gegliedert werden soll oder Teile und Kapitel umbenannt werden sollen, müssen Seiten umbenannt (also verschoben) werden.

All das wird im Kapitel Nachträgliche Änderungen genauer beschrieben.

---

Teil mit Bereichen

In diesem Kapitel wird erläutert, wie die Datenseite eines Teils aufgebaut wird, dessen Kapitel in Bereiche zusammengefasst werden.

Schritt für Schritt

Ein Teil eines Buches mit den dazugehörigen Kapiteln wird wie folgt erstellt:

1. Klicke im Inhaltsverzeichnis auf den vorbereiteten Link zur Seite Teildaten
   1. Trage dort die allgemeinen Angaben ein.
   2. Notiere außerdem die Namen der gewünschten Bereiche.
2. Trage zu jedem Bereich die gewünschten Kapitel ein.
3. Speichere die Seite und lade das Inhaltsverzeichnis neu.

Danach kann (mit Klicks auf die einzelnen Kapitel) das Schreiben des Teils beginnen.

Hinweis: Ein Teil besteht entweder aus Kapiteln oder aus Bereichen. Lediglich Einleitung und Zusammenfassung gehören als besondere Kapitel zum Teil.

Die Datenseite

Zu jedem Teil gehört eine eigene Seite Teildaten. Als Beispiel dient vor allem der Teil Dokumentation, also die Seite Wikibooks Automatische Vorlagen/ Vorlage:Daten Dokumentation.

Allgemeine Angaben

Die folgenden Angaben stehen am Anfang der Teildaten.

| Bild = Otaria_flavescens_-Patagonia-8.jpg
| Zielgruppe = Alle Buch-Autoren, die die Vorteile der automatischen Vorlagen nutzen wollen.
| Lernziel = Die praktische Anwendung mit Speicherung der Buchteile und der Kapitel an einer einzigen Stelle.
| Kurzinhalt = In diesem Teil des Buches wird die praktische Nutzung der Vorlagen beschrieben:
zunächst die inhaltliche Gliederung eines Buches, dann die automatische Verwendung dieser Gliederung.
| margin = 2em 10em 2em 0

Alle diese Angaben sind optional. Sie haben folgende Bedeutungen:

Bild

Ein solches Bild kann im Inhaltsverzeichnis angezeigt werden, um die Inhalte des Teils zu illustrieren.

Zielgruppe

Dieser Text soll darauf hinweisen, wer diesen Teil vor allem lesen sollte.

Lernziel

Dieser Text kann angeben, welche Kenntnisse der Leser nach der Lektüre des Teils haben sollte.

Kurzinhalt

Dieser Text ist eine kurze Beschreibung des Teils.
Hinweis: Wenn es mehrere Absätze sein sollen, können sie mit Sternchen oder Rauten gegliedert werden, oder als Absatzumbruch ist </p><p> einzufügen, d. h. Ende des vorigen und Anfang des nächsten Absatzes.

margin

In seltenen Situationen können sich der Kasten für einen Teil und anderer Inhalt der Seite überschneiden. Dann kann (wie bei der Einführung) der Teil einen größeren rechten Rand (10em im Beispiel) erhalten.

Einleitung und Zusammenfassung

Diese besonderen Kapitel gehören wie allgemeine Angaben zum Teil.

| E   = Allgemeine Hinweise
| Z   = Ergänzende Vorlagen

Einleitung (Option)

Mit E = wird ein einleitendes Kapitel vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Einleitung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

Zusammenfassung (Option)

Mit Z = wird ein abschließendes Kapitel vorgesehen.

• Wenn die Zeile oder der Wert nicht vorhanden ist, ist ein solches Kapitel nicht vorhanden.
• Mit dem Wert ja bekommt das Kapitel den Titel Zusammenfassung.
• Mit anderen Werten wird ein bestimmter Name des Kapitels angegeben.

Die einzelnen Bereiche

Mit den folgenden Werten werden die Bereiche in den Teildaten eingetragen.

| max  = 4
| 1    = AutoInhalt
| 1i   = In diesem Teil des Buches werden alle Vorlagen detailliert beschrieben, die zum Aufbau des Inhaltsverzeichnisses gehören.
| 1max = 3
| 2    = AutoNavigation
| 2i   = In diesem Teil des Buches werden alle Vorlagen detailliert beschrieben, die zur Navigation zwischen Kapiteln und Inhalt gehören.
| 2max = 4
| 3    = AutoGesamt
| 3i   = In diesem Teil des Buches werden alle Vorlagen detailliert beschrieben, die zur Zusammenfassung aller Kapitel eines Teils gehören.
| 3max = 3

max (Pflicht)

Dies gibt die Anzahl der vorgesehenen Bereiche an und wird für Prüfungen sowie für die automatische Navigation benötigt.

Die einzelnen Bereiche

Für jeden Bereich sind die folgenden Angaben vorgesehen.

• Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Bereichs.
• Inhalt (Option): Der zusätzliche Wert, der beim Buchstaben i steht, wird im Inhaltsverzeichnis als Kurzinhalt beim Bereich angezeigt.
• max (Pflicht): Für jeden Bereich wird durch 1max, 2max usw. die Anzahl der vorgesehenen Kapitel angegeben.

Für einen Teil sind maximal 20 Bereiche möglich. Sofern das nicht genügt, ist die Gliederung des Buchs in Teile und Bereiche wesentlich zu ändern.

Die einzelnen Kapitel

Mit den folgenden Werten werden die Kapitel eines Bereichs in den Teildaten eingetragen.

| 2max = 4
| 2/1  = Vorbereitung
| 2/1i = Vorlagen zur AutoNavigation (direkter Aufruf)
| 2/2  = Anzeige
| 2/2i = Vorlagen, die die eigentliche Anzeige auslösen
| 2/3  = Zusatzvorlagen
| 2/4  = Eigene Navigation
| 2/4i = Hinweise für eine Alternative zur [[Vorlage:Navigation Regal Reihe Buch]]

Die Zahl 2 am Anfang einer jeden Zeile bedeutet, dass es sich um den 2. Bereich des Teils handelt. 2/1 steht für das erste Kapitel dieses Bereichs, 2/2 für das zweite Kapitel usw.

2max (Pflicht)

Dies gibt die Anzahl der vorgesehenen Kapitel an.

Die einzelnen Kapitel

Für jedes Kapitel 2/1, 2/2, 2/3 usw. sind die folgenden Angaben vorgesehen.

• Name (Pflicht): Der Wert für die Nummer bezeichnet den Namen des Kapitels.
• Inhalt (Option): Der zusätzliche Wert, der beim Buchstaben i steht, wird im Inhaltsverzeichnis als Erläuterung beim Kapitel angezeigt.

Für die anderen Bereiche des Teils sind folgende Angaben vorzusehen:

• Für den 1. Bereich gelten: 1max - 1/1, 1/1i - 1/2, 1/2i - 1/3, 1/3i usw.
• Für den 3. Bereich gelten: 3max - 3/1, 3/1i - 3/2, 3/2i - 3/3, 3/3i usw.

Für einen Bereich sind maximal 20 Kapitel möglich. Sofern das nicht genügt, ist die Gliederung des Buchs in Teile und Bereiche wesentlich zu ändern.

Nachträgliche Änderungen

Dafür ist auf den Link zu den Teildaten zu klicken (vorzugsweise mit Rechtsklick in einem neuen Tab des Browsers). Nach dem Speichern muss das Inhaltsverzeichnis neu geladen werden.

• Zusätzliche Informationen (Inhaltsangaben u. ä.) können jederzeit problemlos geändert werden und werden sofort wirksam.
• Die Reihenfolge der Teile, Bereiche und Kapitel kann ebenso geändert werden. Es muss nur ganz genau auf die Nummern in den Datenseiten geachtet werden.
• Wenn das Buch anders gegliedert werden soll oder Teile, Bereiche und Kapitel umbenannt werden sollen, müssen Seiten umbenannt (also verschoben) werden.

All das wird im Kapitel Nachträgliche Änderungen genauer beschrieben.

---

Nachträgliche Änderungen

Die Gliederung eines Buches kann ziemlich einfach geändert werden. Es müssen nur die beteiligten Datenseiten Buchdaten und ggf. Teildaten geändert sowie die betroffenen Kapitel verschoben werden. Alles andere wird automatisch angepasst, sobald eine Seite (z. B. das Inhaltsverzeichnis) aktualisiert, also neu geladen wird.

Reihenfolge

Die folgenden Schritte müssen nicht unbedingt in dieser Reihenfolge erfolgen, aber so ist es sinnvoll.

1. Zeige zuerst das aktuelle Inhaltsverzeichnis an.
2. Öffne es ein zweites Mal in einem neuen Tab. (Ein neuer Tab ist äußerst nützlich, damit die Links auf alle Kapitel gleichzeitig unter dem alten und unter dem neuen Namen angezeigt werden.)
3. Öffne von dort aus die Datenseite, die geändert werden soll, und nimm die gewünschten Änderungen vor.
4. Speichere die Datenseite und aktualisiere das Inhaltsverzeichnis im zweiten Tab.
5. Hole aus dem alten Inhaltsverzeichnis nacheinander alle Kapitel, die von einer Namensänderung betroffen sind, und verschiebe sie.
6. Abschließend ist das neue Inhaltsverzeichnis nochmals zu aktualisieren. Bei „roten Links“ für verschobene Kapitel ist irgendein Fehler aufgetreten; die Einträge zu diesen Kapiteln müssen kontrolliert werden.
7. Die betroffenen Kapitel sind erneut zu prüfen. Wenn die Weiterleitung funktioniert, kann ein Kapitel unter dem alten Namen mit einem SLA (Schnelllöschungsantrag) versehen werden.

Einfache Änderungen

Allgemeine Angaben

Solche Informationen können sowohl bei den Buchdaten als auch bei den Teildaten problemlos geändert werden. Nach dem Speichern und Neuladen werden sie sofort gültig.

Reihenfolge ändern

Bei einer solchen Änderung (Teile innerhalb eines Buchs, Bereiche innerhalb eines Teils, Kapitel innerhalb von Buch, Teil oder Bereich) sind einfach die Nummern in der betreffenden Datenseite zu ändern. Wegen der besseren Übersicht sollten die Einträge der gewünschten Reihenfolge entsprechen (auch wenn das nicht notwendig ist). Ein Verschieben der Kapitel als Wikibooks-Seiten entfällt bei dieser Art der Änderung.

Kapitel umbenennen

Bei einer solchen Änderung ist in der betreffenden Datenseite der betreffende Name zu ändern. Anschließend ist das Kapitel zu verschieben – fertig.

Teil oder Bereich umbenennen

Wenn ein Teil umbenannt werden soll, ist in den Buchdaten der neue Name einzutragen. Anschließend sind alle dazugehörigen Seiten – vor allem die Kapitel, aber auch ggf. die Bereiche – zu verschieben.

Wenn ein Bereich umbenannt werden soll, ist in den Teildaten der neue Name einzutragen. Anschließend sind alle dazugehörigen Kapitel zu verschieben.

Buchstruktur ändern

Mit oder ohne Teile

Wenn erstmals Teile vorgesehen werden oder auf die Gliederung in Teile verzichtet wird, ist besondere Vorsicht zu beachten. Gleiches gilt, wenn ein Teil erstmals in Bereiche gegliedert wird oder auf die Gliederung in Bereiche verzichtet wird.

Erstmals Teile verwenden

In diesem Fall sind folgende Änderungen notwendig und sinnvoll:

1. In den Buchdaten ist der Wert teile=ja einzutragen.
2. In den Buchdaten sind die Namen der Teile einzutragen und zu speichern.
3. Das neue Inhaltsverzeichnis wird neu geladen; dann werden die Teildaten eingerichtet wie bei einem neuen Buch mit Teilen.
4. Die bisherigen Kapitel werden verschoben. Statt der Namen mit zwei Bestandteilen wird der Name des Teils zusätzlich eingetragen; ein Kapitel kann dabei auch einen neuen Namen erhalten.

Wenn in einem Teil erstmals Bereiche verwendet werden sollen, sind nur die betreffenden Teildaten zu ändern, wie es für einen Teil mit Bereichen beschrieben wurde. Außerdem sind die bisherigen Kapitel zu verschieben, wobei der Name des Bereichs eingeschoben wird.

Auf Teile verzichten

In diesem Fall sind folgende Änderungen notwendig und sinnvoll:

1. In den Buchdaten ist die Zeile teile=ja zu entfernen.
2. In den Buchdaten sind die Namen der Kapitel einzutragen und zu speichern.
3. Die bisherigen Kapitel werden verschoben. Statt der Namen mit drei Bestandteilen wird der Name des Teils entfernt; ein Kapitel kann dabei auch einen neuen Namen erhalten.
4. Die nicht mehr benötigten Teildaten und ggf. überflüssige Kapitel werden mit einem SLA versehen.

Wenn in einem Teil auf Bereiche verzichtet wird, sind nur die betreffenden Teildaten so zu ändern, wie es für einen Teil ohne Bereiche beschrieben wurde. Außerdem sind die bisherigen Kapitel zu verschieben, wobei der Name des Bereichs entfernt wird.

Weitere Teile, Bereiche, Kapitel

Bei solchen Änderungen wird auf der betreffenden Datenseite einfach ein weiterer Eintrag eingefügt. Zu beachten ist, dass die Nummern aller vorhandenen Einträge angepasst werden; vor allem muss auch das Maximum geändert werden.

Teil, Bereich, Kapitel löschen

Bei solchen Änderungen wird auf der betreffenden Datenseite einfach ein Eintrag entfernt. Zu beachten ist, dass die Nummern aller anderen Einträge angepasst werden; vor allem muss auch das Maximum geändert werden. Anschließend können alle dazu vorhandenen Seiten (Kapitel und ggf. Datenseite) mit einem SLA versehen werden.

Bereich oder Kapitel umgliedern

Wenn ein Kapitel künftig zu einem anderen Teil oder Bereich gehören soll oder ein Bereich in einen anderen Teil verschoben werden soll, handelt es sich um eine Zusammenfassung der beiden vorigen Maßnahmen:

1. In den Teildaten der bisherigen Zuordnung ist der Eintrag zu entfernen; das Maximum muss angepasst werden.
2. In den Teildaten der künftigen Zuordnung ist der Eintrag hinzuzufügen; das Maximum muss angepasst werden.
3. Alle betroffenen Kapitel sind zu verschieben.

---

LaTeX-Export

Mit wb2pdf wird aus einem Wiki-Buch eine LaTeX-Quelldatei und daraus eine PDF-Version erstellt. Dieses Programm kann die Inhalte der Buchdaten und Teildaten nicht direkt erkennen. Mit dem Vorgehen, das hier beschrieben wird, erhält die Exportseite „Buch/ LaTeX“ die benötigten Inhalte.

Schritt für Schritt

Die Grundlage für den Export nach LaTeX wird so geschaffen:

1. Mit der Vorlage AutoInhalt werden die Datenseiten analysiert und wie ein Verzeichnis aller Kapitel angezeigt.
2. Mit einem Arbeitsschritt „Suchen und Ersetzen“ wird die korrekte Wiki-Syntax hergestellt.
3. Das Ergebnis wird in der Seite „Buch/ LaTeX“ gespeichert.
4. In manchen Fällen sind noch ein paar Änderungen sinnvoll.

Vorlagen expandieren

Gehe auf die Seite Spezial:Vorlagen expandieren und trage dort ein:

• Kontexttitel für {{PAGENAME}} etc. den vollständigen Seitennamen „Buch/ LaTeX“
• Eingabefeld:

  {{AutoInhalt|latex=on}}

Es ist sinnvoll, Kommentare entfernen zu lassen; die anderen Optionen bleiben deaktiviert.

Nach Ausführen erscheint im Rahmen Ergebnis die Liste der Teile und Kapitel als (noch nicht fertiger) Wiki-Quelltext.

Wiki-Syntax anpassen

Gehe in das Ergebnis-Feld, markiere den gesamten Inhalt und kopiere ihn in den Zwischenspeicher.

Gehe dann zu einem beliebigen Editor, der nur Text bearbeiten kann, und füge den Inhalt aus dem Zwischenspeicher in ein neues Dokument ein. Rufe dann die Funktion Suchen und Ersetzen auf:

1. Suchtext &#123; ersetzen durch { – geschweifte Klammer auf, unter Windows AltGr+7 – Alle ersetzen
2. Suchtext &#125; ersetzen durch } – geschweifte Klammer zu, unter Windows AltGr+0 – Alle ersetzen

Markiere den gesamten Inhalt und kopiere ihn in den Zwischenspeicher.

Exportseite speichern

Gehe auf den vorbereiteten Link LaTeX-/PDF-Export unterhalb des automatisch erzeugten Inhaltsverzeichnisses. Öffne diese Seite zum Bearbeiten und füge den Inhalt aus dem Zwischenspeicher ein.

Speichere die Seite. Das Speichern dauert etwas länger (bei großen Büchern ziemlich lange), weil jetzt alle Kapitel angezeigt werden müssen.

Nachbesserungen

Zu viele Vorlagen

Es kommt vor, dass das Buch zu komplex ist. Das zeigt die Wiki-Syntax mit der folgenden Fehlermeldung:

Warnung: Die Größe eingebundener Vorlagen ist zu groß, einige Vorlagen können nicht eingebunden werden.

In diesem Fall ist es nützlich, an den Anfang der Exportseite einen Hinweis zu setzen:

<noinclude>{{PDF-Version Warnung}} __NOTOC__</noinclude>

Allgemeine Hinweise

Es ist Geschmackssache, ob die allgemeinen Hinweise zu einem Teil oder Bereich nach LaTeX konvertiert und dort am Anfang eines Teils – nach \part{} – angezeigt werden sollen. Sie können die entsprechenden Zeilen bei Bedarf löschen.

Änderung eines Kapitels

Wenn in einem Kapitel etwas geändert wird, ist in der Exportseite nichts zu ändern. Sobald sie neu geladen wird, wird die Änderung angezeigt.

Änderung der Gliederung

Wenn ein Kapitel hinzugefügt wird, kann es einfach an die entsprechende Stelle gesetzt werden:

= Kapitelname =
{{:Buch/ Teil/ Bereich/ Kapitel}}

Gleiches gilt, wenn ein Kapitel erstmals Inhalt hat. Dann ist der Fehlerhinweis (eine kleine Wiki-Tabelle) durch den Verweis auf das Kapitel zu ersetzen.

Bei mehr oder größeren Änderungen ist es einfacher, die Exportseite vollständig neu zu erstellen, also die obigen Schritte zu wiederholen.

---

Probleme und Lösungen

In diesem Kapitel gibt es ein paar Hinweise für Probleme.

Maximale Größe überschritten

Es kommt vor, dass eine Gesamtseite (gesamtes Buch oder gesamter Teil) nicht angezeigt werden kann.

Symptom

Auf der Seite wird allenfalls die Kopfzeile angezeigt. Anstelle des Inhalts steht etwas wie {{AutoGesamt}} in der Form eines Links, außerdem noch der Hinweis auf die Kategorie:Seiten, in denen die maximale Größe eingebundener Vorlagen überschritten ist.

Maßnahmen

Kapitel können gestrichen oder gekürzt werden. Hilfreich ist es vor allem, wenn innerhalb eines Kapitels weniger komplexe Vorlagen verwendet werden.

Wenn diese Maßnahmen nicht helfen, sollte sinnvollerweise darauf hingewiesen werden. Ändern Sie den Aufbau auf der Seite durch einen Zusatz:

{{AutoGesamt | komplex}}

Mit diesem Hinweis wird auf den (vergeblichen) Versuch verzichtet, die Seite aufzubauen.

Anzeige von Wiki-Quelltext

Es kommt vor, dass etwas von der Wiki-Syntax als Teil einer Seite angezeigt wird. Das passiert vor allem dann, wenn ein Vorlagen-Programmierer nicht aufpasst. In seltenen Fällen tritt es auch bei falschen Einträgen in einer Datenseite auf.

Symptom

Im Inhaltsverzeichnis, einem Kapitel oder einer Gesamtseite wird der Anfang eines Wiki-Befehls angezeigt, beispielsweise:

{{#if: {{{1}}}

Maßnahme

Irgendwo fehlen die schließenden Klammern }}, hier zur if-Anweisung. Kontrollieren Sie die Datenseiten (vor allem die zuletzt geänderte); vielleicht fehlen die Klammern am Anfang der letzten Zeile vor dem <includeonly.

Symptom

Es werden restliche Teile von Wiki-Syntax angezeigt, beispielsweise so:

|3=Name eines Kapitels }}

Maßnahme

Irgendwo vor dieser Zeile gibt es überzählige schließende Klammern }}, sodass die Angabe nicht mehr als Kapitelname erkannt werden kann.

Rote Links nach Verschieben

Nach einer Änderung der Gliederung passen Inhaltsverzeichnis und angezeigte Kapitel nicht mehr zusammen.

Symptom

Im Inhaltsverzeichnis bleibt ein Kapitel rot, obwohl es vorhanden sein müsste.

Maßnahmen

1. Das Inhaltsverzeichnis muss aktualisiert werden.
2. Wenn der Klick auf den roten Link die richtige Seite liefert, ist alles in Ordnung. Vermutlich greift ein Zwischenspeicher (Internet-Server, Provider, Browser) noch auf den früheren Stand zurück; dann hilft nur Abwarten.
3. Kontrolliere die Verschiebungen; es gab wohl einen Schreibfehler, oder der Name von Teil oder Bereich passt nicht.

Kein Link im Inhalt oder in der Navigation

Im Inhaltsverzeichnis oder in der Navigation eines Kapitels steht ein seltsamer Vermerk anstelle eines Links auf ein anderes Kapitel.

Symptom

In schwarzer Schrift erscheint etwas, was (in Wiki-Syntax) wie ein Link auf ein Kapitel aussieht, aber nur als Text angezeigt wird:

[[Buchname/ Teilname/ |]]

Normalerweise erwartet man in blau oder rot einen Link auf ein anderes Kapitel.

Maßnahmen

1. Auf der Datenseite ist ein Name für Teil, Bereich oder Kapitel nicht sauber eingetragen worden. Korrigiere den Namen, der an dieser Stelle erwartet wird.
2. Auf der Datenseite fehlt ein Eintrag – zu einer Nummer ist nichts notiert. Korrigiere alle Nummern und das Maximum.
3. Einer der Namen enthält fälschlicherweise den Schrägstrich. Der muss entfernt und durch eine passende Schreibweise ersetzt werden. (Es darf nicht vergessen werden, die betreffenden Kapitel zu verschieben.)

---

• Autorenliste, sofern möglich